Upgrade to v4.0

[briri]

Researchers

• Updated the PDF coversheet to include all Contributors
• Fixed an issue that was causing the link to organizational guidance to repeat

Administrators

• Fixed an issue that was impacting API v0 and preventing the batch assignment of users to departments
• Fixed an issue that was preventing admins from performing a search on the Templates page Template Search issue #3217
• Removed case sensitivity from the validation rules for Org and Department names.
• Fixed issues with API v1
• Fixed an issue that was causing plans that were based off of templates with conditional questions to disappear when the user triggered the condition Conditional questions causing plans to disapear  #3163
• Your admin can now set a flag that makes the 'coversheet' checkbox on the Plan Downloads page to be checked by default Project plan's page - 'download' option to have project sheet tickbox ticked by default  #3063 In downloaded template pre-ticked answers do not download  #3104
• Fixed an issue that was causing plans to not appear in the publicly visible if 100% of their questions had not been answered Org visibility plan will appear in the public DMPs only if filled 100% #3086

Developers

This release includes a major upgrade of Rails (5.x to 6.1) and an upgrade from Ruby 2.6 to 2.7.6. Please review the following release notes as well as our upgrade guide and be aware that you will most likely need to adjust/modify any local customizations you may have made within your local fork of the code.

This release includes an upgrade from Ruby 2.6 to Ruby 2.7.6 and Rails 5.x to Rails 6.1!

You will need to do the following:

• Review the new default configuration options for Rails 6.1 and adjust as necessary for your implementation. The config settings can be found in config/initializers/new_framework_defaults_6_1.rb
• Set a DMPROADMAP_HOST environment variable. Rails 6+ introduces new middleware that helps mitigate DNS rebinding attacks. This includes a hostname whitelist. The value you assign to this environment variable will be added to the whitelist.
• Update the SUPPORTED_LOCALES CLIENT_LOCALES and DEFAULT_LOCALE in the config/initializers/translation.rb for your instance
• If you have any raw SQL queries were deprecated in Rails 5.2. You may need to convert these over. See this article

Updates:

• Updated Ruby from 2.6.3 to 2.7.6 Upgrade Ruby version #3139
• Updated Rails from 5.2 to 6.1 Rails 6  #3103 Rails 6 Tasks (to-do list) #3187
• Updated the TinyMCE editor to v5 and installed the 'oxide' skin Update tinyMCE to latest version #2942
• Switched from Turbolinks to Turbo
• Updated all JS and gem dependencies
• Fixed an issue that allowed researchers to add an ORCID for a contributor that included spaces resulting in URLs that looked like https://orcid.org// 0000-0000-0000-0000. Contributor form allows user to include whitespace at the beginning of ORCID #3212
• Made some minor modifications to improve query responsiveness on the Contributors, Guidances, Plans, Orgs, Users and Templates pages
• Replaced all occurrences of update_attributes with updates since update_attributes was deprecated
• Upgraded chart.js which is used on the Usage page to render the bar and pie charts
• Made changes to accommodate the new Zeitwerk autoloader (which has stricter convention-over-configuration rules):
  • Changed the name of the JSONLinkValidator class file to JsonLinkValidator
  • Updated models so that any JSON fields have their default values defined prior to serialization
  • Updated deprecated occurrences of record.errors[:model] << 'foo' to record.errors.add(:model, 'foo')
  • Updated JS babel configuration
  • Updated the config/environments/*.rb files to use the new DMPROADMAP_HOST environment variable to defined the Rails.application.routes.default_url_options and new config.hosts setting.
  • Added a new download_coversheet_tickbox_checked flag to the config/initializers/_dmproadmap.rb initializer that will default the Plans Download page to default that checkbox to be true
  • Removed the out-of-date eslint package from webpacker. We will investigate re-introducing a JS linter in a future release
  • Fix to the db/seeds.rb file that is used for new installations so that it uses the find_or_create_by instead of create! to prevent duplicates when the DB already exists.
  • Updated and fixed tests as needed

[pengyin-shan]

Looks good to me!

[benjaminfaure]

looking good so far !

It might be good to add a warning for people using query methods with raw SQL. It's been deprecated since Rails 5.2 and removed in Rails 6
You can see an example (and a solution) here : https://medium.com/@mitsun.chieh/activerecord-relation-with-raw-sql-argument-returns-a-warning-exception-raising-8999f1b9898a

DMP OPIDoR is impacted because we're using JSON fields with queries on the JSON data.
For example :
.pluck("data->>'keyword'")
.order("data->>'lastName', data->>'firstName'")

[briri]

thanks @benjaminfaure and @pengyin-shan

I added a note to the You will need to do the following section for Developers that mentions the raw SQL change