v4.1.4

• Fixes an issue where a failure from the uc3-citation gem was forcing the RelatedIdentifier model into an endless loop. #479.
• Updated JS and gem dependencies
• Added users.ui_token in preparation for v5 work. Added the api/v2/me endpoint to fetch the currently logged in user's info which will be used by future React pages. UI token is generated/regenerated when the user logs in and deleted when they log out.

v4.1.3

• patch bug when updating a research output that has no selected repos or standards

v4.1.2-node16.20

• locked @babel/preset-env JS dependency due to asset compilation issue which may be related to the node version running on our hosts. This does not probably impact other installations

v4.1.2

• Update modal search for repositories to allow researchers to define custom repositories that are not a part of the re3data registry #466
• Update modal search for metadata standards to allow researchers and template admins to define custom standards that are not a part of the rda registry
• Refactor custom repository creation for template administrators. Moved functionality into existing modal search window accessed via new 'My repository is not listed' button
• update to api/v2 json to use the correct URL when constructing the link back to the PDF
• Locked better-errors gem to 2.9.1 due to an issue that prevents Rails from starting up unless sassc is installed
• Updated gem and JS dependencies

v4.1.1

• Patch for scenarios where empty custom repositories were being included on form submission in the Preferences tab which was causing the Template.update to fail

v4.1.0

Overview

Note: This version includes a change to the research_outputs table! We have added a new research_outputs.research_output_type field that stores a string value. It is a replacement for the old research_outputs.output_type integer field.

You will need to run: bin/rails db:migrate && bin/rails v4:upgrade_4_1_0 which will:

• Migrate your existing data from the research_outputs.output_type (Integer) field to the new research_outputs.research_ouput_type (String) field.
• Add a new 'OTHER' license to the licenses table. This new license is meant for scenarios where a user's institution or repository provides restricted access to the data the description is 'Custom Data Use Agreements/Terms of Use'. The option will appear for the user by default within the existing License select box
• The enum that backs the Initial Access level of a research Output has changed from 'open (0)', 'embargoed (1)', 'restricted (2)' and 'closed (3)' to: 'unrestricted (0)', 'restricted (2)', 'other (3)'. The script migrates any research outputs that had an initial research_outputs.access level set to 'embargoed' (1) to 'other' (3). The enum was left intact to accommodate the migrations, it will be updated in the next release.

New Functionality

Template administrators now have the ability to enable/disable the 'Research Outputs' tab. If they disable the tab, a researcher will not see the research outputs tab when editing their plan. The new 'Preferences' tab is visible for admins when they edit their template. It also provides additional options to tailor the research outputs tab for their template.

Screenshot of the Preferences tab and the enable/disable checkbox Screenshot of the Output Types preferences. The admin can use the defaults or specify their own (including removing default options) and also provide a tooltip for researchers to help guide their selection process. Screenshot of the Repository preferences showing a scenario where the admin has selected some repositories from the re3data registry and also defined a custom repository. When the researcher adds a research output, these preferred repositories will be displayed by default (they still have the option to select from the full re3data repository list. The admin can also provide a tooltip for researchers to help guide their selection process. Screenshot of the Metadata Standard preferences showing a scenario where the admin indicates that a specific metadata standard is the preferred standard. When the researcher adds a research output, these preferred standards will be displayed by default (they still have the option to select from the full list. The admin can also provide a tooltip for researchers to help guide their selection process. Screenshot of the license preferences. The admin can use the defaults or specify their own (including removing default options) and also provide a tooltip for researchers to help guide their selection process.

Changes

Updated the Admin Template edit page with a new 'Preferences' tab. This new tab allows admins to specify whether or not the Research Outputs tab will be available to the researcher when filling out their plan. If enabled, the admin can specify preferred/recommended output types, licenses, metadata standards and repositories. They can also provide guidance to the research to help them with their selections of those items.

• Added the following columns to the templates table
  • enable_research_outputs
  • user_guidance_output_types
  • user_guidance_repositories
  • user_guidance_metadata_standards
  • user_guidance_licenses
  • customize_output_types
  • customize_repositories
  • customize_metadata_standards
  • customize_licenses
• Updated the Templates model (and RSpec factory and tests) to use new field
• Created the Template Preferences View
• Removed 'Embargoed' from the list of Research Output Type's initial access level and changed the names of the other options. (Left the enum intact on the model for now so that data can be migrated)
• Added a new 'OTHER' license type (does not appear in JSON output because it has no valid URI)
• Added column research_output_type to the research_outputs table
• Added v4:upgrade_4_1_0 rake task to migrate data from output_type and output_type_description to the new research_output_type field. The task also adds a default 'OTHER' license and migrates resource_output.access from embargoed to closed
• Updated the ResearchOutput model (and RSpec factory and tests) to use new field
• Replaced the old output_types enum on the ResearchOutput model with DEFAULT_OUTPUT_TYPES array
• Updated presenters (and RSpec tests) and controller to work with the new field
• Created table template_licenses
  • Created UI to save preferred Licenses for a Template
• Created table template_output_types
  • Created UI to save preferred Output Types for a Template
• Created table template_repositories
  • Customize modal search to populate this relation
• Created table template_metadata_standards
  • Customize modal search to populate this relation
• Modify repositories table to allow for the definition of customized repositories for a template.
  • UI to create customized repositories
  • UI to select customized, preferred and/or standard repositories for a research output.
• Updated Gem and JS dependencies

v4.0.10

• Patch issue with the OAuth2 authorization page referencing old web packer js #469
• Updated Capistrano to run assets:clobber prior to compilation

v4.0.9

• Fix issue with citation lookup when saving related identifiers on the new Follow-up page.

Note that there are some potentially breaking changes in v4.0.8. Please review the notes if you are not already on that version!

v4.0.8

This upgrade includes an upgrade to the TinyMCE WYSIWYG editor and a transition from Webpacker to Jsbundling and Cssbundling! See the DMPRoadmap v4.1.0 release notes for the full details.

Developer Notes

• This upgrade requires bin/rails v4:upgrade_4_0_8 to be run to seed the plans.feedback_start_at dates. Run this after bin/rails db:migrate
• The newer versions of Bundler annoyingly replace the available platforms that are defined. You may see an error when deploying to your server (or building a Docker image) that states that it does not support x86_64-linux to fix that you can run bundle lock --add-platform x86_64-linux after you've run bundle install. We have also provided a bin/rails update:all rake task that will upgrade your Gem and JS dependencies and add that platform to the bundle automatically.
• When running the application in development mode, you will need to run bin/dev which uses the new Procfile. This will each your SCSS and JS assets while you're working on your customizations.
• Depending on how your deploy to your servers, you may need to run rails assets:clobber before running rails assets:precompile. Capistrano for example uses a shared public/assets/ directory. This will ensure that Rails does not try to use an old Webpacker generated application.css and application.js files
• If you have placed custom CSS in a separate directory under app/assets/stylesheets/, you will need to add an _index.scss file to that directory and@use your sass files in that index. Here is a good video about SAS @use vs @import: https://www.youtube.com/watch?v=CR-a8upNjJ0
• If you use the color or other sass variables in your custom css files, you will need to add the following line to the top of your file: @use '../variables/colours' as *; (you may need to adjust the relative path to work with the location of your file)
• The location of the application.scss and application.js files have changed. If you were importing custom code into either of these, you will need to re-add your imports.
• The way that the JS and CSS files are imported into the app/views/layouts/application.html.erb have changed. If you have a custom app/views/branded/layouts/application.html.erb you will need to update it to the new tag.

Other changes proposed in this PR:

• Update to the Org admin Plans page that will now show the date that feedback was requested. #434
• Changed the language around the confusing checkbox/option text on the download plan page (for PDF download) and changed defaults so that only the section heading and question text are enabled by default. #435
• Fixed an issue causing the mouse pointer to change to a text icon when hovering over hyperlinks for Chrome and Firefox. It now correctly displays the hand pointer issue #445
• Patch issue #447 that was deleting all prior related identifiers when a user adds a new related identifier on the 'Follow up' tab.
• Patch Github Actions to lock Node at v16.6 to deal with a version compatability issue with openSSL
• Attempt to patch issue that was causing registry_orgs search by name to fail for Postgres distributions that is causing Rspec tests to fail for spec/services/api/v2/deserialization/*.rb. Perhaps someone out there with Postgres can debug, fix and submit a PR.
• Update Gem and JS dependencies

v4.0.7

• patched an issue that was preventing a user from creating/updating a research output when the byte_size was left blank (or when the output type does not have a byte_size)