v2.3.0

Features

• #3246 - Adds select all to embargo management panel

Accessibility

• #3248 - Wraps Site header in tag
• #3251 - Wraps sidebar in
• #3263 - Adds heading markup to admin dashboard
• #3264 - Adds aria-current=page attributes to static page links
• #3265 - Adds labels to search bars
• #3266 - Makes Dashboard graphs more accessible

Bug Fixes

• #3270 - Fixes file counts in Admin set / Collections Dashboard

Refactors

• #3259 - Avoids unnecessary calls in Generic work factories

v1.1.1

Bug Fixes

• Backports fixes for a variety of XSS vulnerabilities. (#3225, #3229, #3230, #3231)

v2.0.3

Bug Fixes

• Backports fixes for a variety of XSS vulnerabilities. (#3225, #3229, #3230, #3231)

v2.2.4

Accessibility

• Update HTML lang attribute when changing the language settings (#3235)
• Improve title tags for FileSet show pages, improving consistency and accessibility of titles (#3236)
• Reorder document layout on search result pages; makes results more readily discovered and navigable to screen reader users (#3237)
• Fix ordering of headlines on Dashboard landing page (#3247)
• Reworks terms.html.erb template to use an HTML formatted ordered list (#3258)
  • Adopters upgrading from a previous version should update their generated terms.html.erb to reflect this accessibility improvement.
• Wrap filter options in a fieldset element, using a legend for screen readers (#3249)

Bug Fixes

• Fix HTML sanitization issue in the dashboard user activity table (#3238)
• Fix JSON API for collections #show (#3257)

Dependencies

• Add support for hydra-works 1.x (#3253)

v2.2.3

Accessibility

• Improve accessibility of homepage thumbnails, moving them inside their title links (#3219)

v2.2.2

Bug Fixes

• Fix a variety of XSS vulnerabilities. (#3225, #3229, #3230, #3231)

v2.2.1

Bug Fixes

• Fix bug "Cannot add files to work using Firefox" (#3220)
  • Reopens Accessibility issue #1246.

Accessibility Fixes

• Add aria-hidden = true attribute to helper icons (#3182)
• Add aria-expanded and aria-controls to button dropdown combos (#3190)
• Update home page search All button for screen readers (#3193)
• Add label to dashboard manage proxies proxy user dropdown (#3194)

Translations

• Major review of the Portuguese (pt-BR) translation (#3212)

Dependencies

• Don't show trackable fields if Devise trackable isn't installed (#3218)
  • Adds support for devise 4.5.0+, with removal of user login tracking features; to retain these features lock to your current version of devise.

v2.2.0

Hyrax 2.1 was released on May 31st, 2018. Since then, there have been new features and bug fixes. This release contributes the following updates to Hyrax:

New Features

• Repository admins can configure the visibility of the registered user list, hidden by default (#3197)
• Repository admins can sort the "All Works" dashboard by date, status, and visibility (#3173)

User Interface

• Hides deposit agreement progress when disabled (#3141)
• Adds Display Name to Workflow Roles management page (#3140)
• Change "Update Attached File" button to "Save" on file_set edit view (#3145)
• Hides private work metadata from public view during approval/ review workflow (#3148)
• Disables Work "Save" button during multi-file uploads (#3150)
• Hides cancel upload button when file upload(s) are finished (#3156)
• Reduces size of Delete Button the file uploads page for better alignment (#3157)
• The "Review Submissions" dashboard displays Depositor name, not system ID (#3170)

Accessibility:

• Removes the aria-hidden flag that hides useful elements for screen readers (#3114)
• Make Single-Use Links more accessible (#3150)
• Enables zooming (#3158)
• File upload buttons are now keyboard clickable (#3186)
• Makes breadcrumbs accessible with appropriate labels (#3188)

Dependencies:

• Formal support for Ruby 2.3, 2.4, and 2.5 (#3109)
• Adds support for SolrWrapper v2.x (#3125)
• Consolidate dependency on ActiveFedora::Base.logger (#3142)

Bug fixes:

• Duplicate exported graphs from nested works (#3110)
• Removes a duplicate pagination view from Blacklight (#3115)
• Adds Hyrax namespace to collection_path route helper (#3118)
• Better handling of nil responses to CollectionPresenter#description (#3137)
• File counts in admin dashboard accuracy (#3154)
• Allows depositor to always see their own work, even during an approval process (#3161)

Refactors:

• Inverts dependencies for AdminStatsPresenter (#3140)
• Expanded support for "inactive" authority terms to Rights Statements (#3122)
• Updates the ImportUrlJob to use a GET instead of a HEAD request for cloud file ingest (#3130)
• Moves Hyrax::WorkRelation dependency closer in the stack (#3143)
• Removes instances of data: { turbolinks: false } (#3150)

Hyrax 2.1.0

The major features of this release include:

• Collection Extensions with collection types and control over collection nesting, sharing, discovery, branding, and membership in collections.
• UniversalViewer for images in works
• UI/UX improvements

Upgrade Notes

Migration Procedures from Hyrax 2.0.x to 2.1.0

The following steps describe the process for migrating to Hyrax 2.1.0 which includes the Collection Extensions work. The steps should be run in the order presented.

Update gem

Edit Gemfile or gemspec to update the version of hyrax.

gem 'hyrax', '2.1.0'

and run

bundle update hyrax

Database: Application DB changes are all covered by db:migrate

• NEW: table to hold collection types
• NEW: table to hold collection type participants
• NEW: table to hold collection branding information (e.g. info about banner and logo images)
• MODIFIED: table permissions_templates - rename admin_set_id to source_id

Run migrations to get database changes...

rails hyrax:install:migrations
rails db:migrate

You will also need to run migrate for tests to update your test database.

rails db:migrate RAILS_ENV=test

Default Collection Types

An existing app will have to run a generator to add the pre-defined collection types: user_collection and admin_set

rails hyrax:default_collection_types:create

NOTE: db:migrate must be run before running the generator for default collection types.

Collection Migration

Fedora/Solr Collection Model

CE adds one property to Collections model... collection_type_gid, which identifies the type (RDF::Vocab::SCHEMA.additionalType) of each collection. The gid is generated based on the collection type id (e.g. gid://internal/hyrax-collectiontype/:id).

Migration Process

The migration process performs two updates for every collection...

• store the User Collection gid as the collection type for all legacy collections
• add a Permission Template and set Accesses based on sharing information in the legacy collection

NOTE: Solr and Fedora services need to be running when this script is called.

rails hyrax:migrate:add_collection_type_and_permissions_to_collections

Instructions for setting up the UniversalViewer for images in works

UniversalViewer setup is in the Management Guide in section Image Server

Tinymce configuration changes

Some modifications were made to the tinymce editor configuration. If you are creating a new app, these configurations will be made for you as part of the hyrax installation process. If you are migrating an app, you will want to review your app's config/tinymce.yml file and compare it to the new one in Hyrax at hyrax/lib/generators/hyrax/templates/config/tinymce.yml.

Avoid flash messages being swallowed for XHR requests

Flash messages are being discarded by Blacklight for XHR requests. To avoid this, add the following line to your app at app/controllers/application_controller.rb.

skip_after_action :discard_flash_if_xhr

Avoid Performance Issues with solr-suggest

Recommended for all Hyrax apps.

It is strongly suggested that you turn off solr-suggest. Details on why and how to do this are in Fix performance issue caused by solr-suggest.

Troubleshooting Migration

Fellow Hyrax developers are gathering their experiences with Troubleshooting Migration from Hyrax 2.0.x to 2.1.0. You may want to visit this guide and contribute your experiences.

Changes

v2.0.1...v2.1.0

Hyrax 2.1.0.rc4

See full release notes for 2.1.0.
Changes: v2.0.1...v2.1.0.rc4