hyrax 3.3.0 → 4.0.0.beta1

data/lib/generators/hyrax/install_generator.rb

@@ -45,13 +45,15 @@ module Hyrax
     end
 
     def replace_blacklight_layout
-      gsub_file 'app/controllers/application_controller.rb', /layout 'blacklight'/,
+      gsub_file 'app/controllers/application_controller.rb', /layout :determine_layout.+$/,
                 "include Hyrax::ThemedLayoutController\n  with_themed_layout '1_column'\n"
     end
 
     def insert_builder
-      insert_into_file 'app/models/search_builder.rb', after: /include Hydra::AccessControlsEnforcement/ do
-        "\n  include Hyrax::SearchFilters\n"
+      insert_into_file 'app/models/search_builder.rb', after: /include Blacklight::Solr::SearchBuilderBehavior/ do
+        "\n  # Add a filter query to restrict the search to documents the current user has access to\n"\
+        "  include Hydra::AccessControlsEnforcement\n"\
+        "  include Hyrax::SearchFilters\n"
       end
     end
 
@@ -151,21 +153,13 @@ module Hyrax
 
     def datatables
       javascript_manifest = 'app/assets/javascripts/application.js'
-      # Generator is broken https://github.com/rweng/jquery-datatables-rails/issues/225
-      # generate 'jquery:datatables:install bootstrap3'
       insert_into_file javascript_manifest, after: /jquery.?\n/ do
-        "//= require jquery_ujs\n" \
-        "//= require dataTables/jquery.dataTables\n" \
-        "//= require dataTables/bootstrap/3/jquery.dataTables.bootstrap\n"
+        "//= require jquery.dataTables\n" \
+        "//= require dataTables.bootstrap4\n"
       end
 
-      # This is only necessary for Rails 5.1 and hopefully is temporary.
-      # There was some trouble getting the file-manager javascript (remote forms) to work well
-      # with rails-ujs. Note jquery_ujs was added to the block above (after jQuery)
-      gsub_file javascript_manifest, 'require rails-ujs', ''
-
       insert_into_file 'app/assets/stylesheets/application.css', before: ' *= require_self' do
-        " *= require dataTables/bootstrap/3/jquery.dataTables.bootstrap\n"
+        " *= require dataTables.bootstrap4\n"
       end
     end
 
@@ -183,16 +177,7 @@ module Hyrax
 
     def universalviewer_files
       rake('hyrax:universal_viewer:install')
-    end
-
-    # Blacklight::Controller will by default add an after_action filter to discard all flash messages on xhr requests.
-    # This has caused problems when we perform a post-redirect-get cycle using xhr and turbolinks.
-    # This injector will modify the generated ApplicationController to skip this action.
-    # TODO: This may be removed in Blacklight 7.x, so we'll likely need to remove this after updating.
-    def inject_skip_blacklilght_flash_discarding
-      insert_into_file "app/controllers/application_controller.rb", after: "include Blacklight::Controller\n" do
-        "  skip_after_action :discard_flash_if_xhr\n"
-      end
+      rake('yarn:install')
     end
   end
 end

data/lib/generators/hyrax/templates/catalog_controller.rb

@@ -19,10 +19,6 @@ class CatalogController < ApplicationController
   configure_blacklight do |config|
     config.search_builder_class = Hyrax::CatalogSearchBuilder
 
-    # Show gallery view
-    config.view.gallery.partials = [:index_header, :index]
-    config.view.slideshow.partials = [:index]
-
     # Because too many times on Samvera tech people raise a problem regarding a failed query to SOLR.
     # Often, it's because they inadvertently exceeded the character limit of a GET request.
     config.http_method = :post
@@ -39,6 +35,17 @@ class CatalogController < ApplicationController
     config.index.display_type_field = "has_model_ssim"
     config.index.thumbnail_field = 'thumbnail_path_ss'
 
+    config.add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    config.add_results_collection_tool(:sort_widget)
+    config.add_results_collection_tool(:per_page_widget)
+    config.add_results_collection_tool(:view_type_group)
+    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
+    config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
+    config.add_show_tools_partial(:citation)
+    config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
+    config.add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
+
     # solr fields that will be treated as facets by the blacklight application
     #   The ordering of the field names is the order of the display
     config.add_facet_field "human_readable_type_sim", label: "Type", limit: 5
@@ -67,22 +74,22 @@ class CatalogController < ApplicationController
     #   The ordering of the field names is the order of the display
     config.add_index_field "title_tesim", label: "Title", itemprop: 'name', if: false
     config.add_index_field "description_tesim", itemprop: 'description', helper_method: :iconify_auto_link
-    config.add_index_field "keyword_tesim", itemprop: 'keywords', link_to_search: "keyword_sim"
-    config.add_index_field "subject_tesim", itemprop: 'about', link_to_search: "subject_sim"
-    config.add_index_field "creator_tesim", itemprop: 'creator', link_to_search: "creator_sim"
-    config.add_index_field "contributor_tesim", itemprop: 'contributor', link_to_search: "contributor_sim"
+    config.add_index_field "keyword_tesim", itemprop: 'keywords', link_to_facet: "keyword_sim"
+    config.add_index_field "subject_tesim", itemprop: 'about', link_to_facet: "subject_sim"
+    config.add_index_field "creator_tesim", itemprop: 'creator', link_to_facet: "creator_sim"
+    config.add_index_field "contributor_tesim", itemprop: 'contributor', link_to_facet: "contributor_sim"
     config.add_index_field "proxy_depositor_ssim", label: "Depositor", helper_method: :link_to_profile
     config.add_index_field "depositor_tesim", label: "Owner", helper_method: :link_to_profile
-    config.add_index_field "publisher_tesim", itemprop: 'publisher', link_to_search: "publisher_sim"
-    config.add_index_field "based_near_label_tesim", itemprop: 'contentLocation', link_to_search: "based_near_label_sim"
-    config.add_index_field "language_tesim", itemprop: 'inLanguage', link_to_search: "language_sim"
+    config.add_index_field "publisher_tesim", itemprop: 'publisher', link_to_facet: "publisher_sim"
+    config.add_index_field "based_near_label_tesim", itemprop: 'contentLocation', link_to_facet: "based_near_label_sim"
+    config.add_index_field "language_tesim", itemprop: 'inLanguage', link_to_facet: "language_sim"
     config.add_index_field "date_uploaded_dtsi", itemprop: 'datePublished', helper_method: :human_readable_date
     config.add_index_field "date_modified_dtsi", itemprop: 'dateModified', helper_method: :human_readable_date
     config.add_index_field "date_created_tesim", itemprop: 'dateCreated'
     config.add_index_field "rights_statement_tesim", helper_method: :rights_statement_links
     config.add_index_field "license_tesim", helper_method: :license_links
-    config.add_index_field "resource_type_tesim", label: "Resource Type", link_to_search: "resource_type_sim"
-    config.add_index_field "file_format_tesim", link_to_search: "file_format_sim"
+    config.add_index_field "resource_type_tesim", label: "Resource Type", link_to_facet: "resource_type_sim"
+    config.add_index_field "file_format_tesim", link_to_facet: "file_format_sim"
     config.add_index_field "identifier_tesim", helper_method: :index_field_link, field_name: 'identifier'
     config.add_index_field Hydra.config.permissions.embargo.release_date, label: "Embargo release date", helper_method: :human_readable_date
     config.add_index_field Hydra.config.permissions.lease.expiration_date, label: "Lease expiration date", helper_method: :human_readable_date

data/lib/generators/hyrax/templates/config/initializers/riiif.rb

@@ -20,7 +20,7 @@ ActiveSupport::Reloader.to_prepare do
     end
   end
 
-  Riiif::Image.authorization_service = Hyrax::IIIFAuthorizationService
+  Riiif::Image.authorization_service = Hyrax::IiifAuthorizationService
 
   Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
   Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')

data/lib/generators/hyrax/templates/config/locales/hyrax.de.yml

@@ -50,7 +50,7 @@ de:
     directory:
       suffix: "@ Example.org"
     footer:
-      copyright_html: "<strong>Copyright © 2018 Samvera lizenziert</strong> unter der Apache Lizenz, Version 2.0"
+      copyright_html: "<strong>Copyright © 2022 Samvera lizenziert</strong> unter der Apache Lizenz, Version 2.0"
       service_html: Ein Dienst von <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a> .
     institution_name: Institution
     institution_name_full: Name des Instituts

data/lib/generators/hyrax/templates/config/locales/hyrax.en.yml

@@ -50,7 +50,7 @@ en:
     directory:
       suffix: "@example.org"
     footer:
-      copyright_html: "<strong>Copyright &copy; 2018 Samvera</strong> Licensed under the Apache License, Version 2.0"
+      copyright_html: "<strong>Copyright &copy; 2022 Samvera</strong> Licensed under the Apache License, Version 2.0"
       service_html: A service of <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a>.
     institution_name: Institution
     institution_name_full: The Institution Name

data/lib/generators/hyrax/templates/config/locales/hyrax.es.yml

@@ -50,7 +50,7 @@ es:
     directory:
       suffix: "@example.org"
     footer:
-      copyright_html: "<strong>Copyright &copy; 2018 Samvera</strong> bajo licencia de Apache, Version 2.0"
+      copyright_html: "<strong>Copyright &copy; 2022 Samvera</strong> bajo licencia de Apache, Version 2.0"
       service_html: Un servicio de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a>.
     institution_name: institución
     institution_name_full: El nombre de la institución

data/lib/generators/hyrax/templates/config/locales/hyrax.fr.yml

@@ -50,7 +50,7 @@ fr:
     directory:
       suffix: "@ Example.org"
     footer:
-      copyright_html: "<strong>Copyright © 2018 Samvera</strong> Licence sous Licence Apache, Version 2.0"
+      copyright_html: "<strong>Copyright © 2022 Samvera</strong> Licence sous Licence Apache, Version 2.0"
       service_html: Un service de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a> .
     institution_name: Institution
     institution_name_full: Nom de l'établissement

data/lib/generators/hyrax/templates/config/locales/hyrax.it.yml

@@ -50,7 +50,7 @@ it:
     directory:
       suffix: "@ example.org"
     footer:
-      copyright_html: "<strong>Copyright © 2018 Samvera</strong> Licenza sotto la licenza Apache, versione 2.0"
+      copyright_html: "<strong>Copyright © 2022 Samvera</strong> Licenza sotto la licenza Apache, versione 2.0"
       service_html: Un servizio di <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a> .
     institution_name: Istituzione
     institution_name_full: Nome dell'Istituzione

data/lib/generators/hyrax/templates/config/locales/hyrax.pt-BR.yml

@@ -50,7 +50,7 @@ pt-BR:
     directory:
       suffix: "@ Example.org"
     footer:
-      copyright_html: "<strong>Copyright © 2018 Samvera </strong> Licenciado sob a Licença Apache, Versão 2.0"
+      copyright_html: "<strong>Copyright © 2022 Samvera </strong> Licenciado sob a Licença Apache, Versão 2.0"
       service_html: Um serviço de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a> .
     institution_name: Instituição
     institution_name_full: O Nome da Instituição

data/lib/generators/hyrax/templates/config/locales/hyrax.zh.yml

@@ -50,7 +50,7 @@ zh:
     directory:
       suffix: "@example.org"
     footer:
-      copyright_html: "<strong>版权所有 &copy; 2018 Samvera</strong> 根据Apache许可证2.0版许可"
+      copyright_html: "<strong>版权所有 &copy; 2022 Samvera</strong> 根据Apache许可证2.0版许可"
       service_html: 的服务<a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a>.
     institution_name: 机构
     institution_name_full: 机构名称

data/lib/generators/hyrax/templates/hyrax.scss

@@ -4,14 +4,13 @@
  *= require_self
 */
 
-@import "bootstrap-sprockets";
 @import "bootstrap-default-overrides";
 @import 'bootstrap';
-@import 'blacklight/blacklight';
 @import "font-awesome";
 @import "blacklight_gallery/gallery";
 @import "blacklight_gallery/masonry";
 @import "blacklight_gallery/slideshow";
 @import "blacklight_gallery/osd_viewer";
+@import "hyrax/blacklight_gallery";
 @import 'hyrax/hyrax';
 @import 'hyrax/login_signup';

data/lib/generators/hyrax/templates/package.json

@@ -3,15 +3,14 @@
   "private": true,
   "repository": "git@github.com:samvera/hyrax.git",
   "dependencies": {
-  "universalviewer": "^3.0.16"
-},
-"scripts": {
-  "preinstall": "rm -rf ./public/uv",
-  "postinstall": "yarn run uv-install && yarn run uv-config",
-  "uv-install": "shx cp -r ./node_modules/universalviewer/dist ./public/uv",
-  "uv-config": "shx cp ./config/uv/uv.html ./public/uv/uv.html & shx cp ./config/uv/uv-config.json ./public/uv/"
+    "universalviewer": "^3.1.4"
+  },
+  "scripts": {
+    "preinstall": "rm -rf ./public/uv",
+    "postinstall": "yarn run uv-install && yarn run uv-config",
+    "uv-install": "cp -r ./node_modules/universalviewer/dist ./public/uv",
+    "uv-config": "cp ./config/uv/uv.html ./public/uv/uv.html & cp ./config/uv/uv-config.json ./public/uv/"
   },
   "devDependencies": {
-  "shx": "^0.3.2"
   }
 }

data/lib/hyrax/administrative_set_name.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A custom name for Valkyrie AdministrativeSet objects. Route keys are mapped to `admin_set`
+  # not be the same as the model name.
+  class AdministrativeSetName < Name
+    def initialize(klass, namespace = nil, name = nil)
+      super
+      @human              = 'AdminSet'
+      @i18n_key           = :admin_set
+      @param_key          = 'admin_set'
+      @plural             = 'admin_sets'
+      @route_key          = 'admin_sets'
+      @singular_route_key = 'admin_set'
+    end
+  end
+end

data/lib/hyrax/collection_name.rb

@@ -14,6 +14,8 @@ module Hyrax
       @plural             = 'collections'
       @route_key          = 'collections'
       @singular_route_key = 'collection'
+      @collection         = 'collections'
+      @element            = 'collection'
     end
   end
 end

data/lib/hyrax/configuration.rb

@@ -137,21 +137,6 @@ module Hyrax
     attr_writer :analytic_start_date
     attr_reader :analytic_start_date
 
-    ##
-    # @deprecated use analytics_id from config/analytics.yml instead
-    def google_analytics_id=(value)
-      Deprecation.warn("google_analytics_id is deprecated; use analytics_id from config/analytics.yml instead.")
-      Hyrax::Analytics.config.analytics_id = value
-    end
-
-    ##
-    # @deprecated use analytics_id from config/analytics.yml instead
-    def google_analytics_id
-      Deprecation.warn("google_analytics_id is deprecated; use analytics_id from config/analytics.yml instead.")
-      Hyrax::Analytics.config.analytics_id
-    end
-    alias google_analytics_id? google_analytics_id
-
     # @!endgroup
     # @!group Groups
 
@@ -427,6 +412,18 @@ module Hyrax
       @branding_storage_adapter = Valkyrie::StorageAdapter.find(adapter.to_sym)
     end
 
+    ##
+    # @return [Valkyrie::StorageAdapter]
+    def derivatives_storage_adapter
+      @derivatives_storage_adapter ||= Valkyrie::StorageAdapter.find(:derivatives_disk)
+    end
+
+    ##
+    # @param [#to_sym] adapter
+    def derivatives_storage_adapter=(adapter)
+      @derivatives_storage_adapter = Valkyrie::StorageAdapter.find(adapter.to_sym)
+    end
+
     ##
     # @return [#save, #save_all, #delete, #wipe!] an indexing adapter
     def index_adapter
@@ -449,6 +446,7 @@ module Hyrax
     ##
     # @return [Boolean] whether to use experimental valkyrie storage features
     def use_valkyrie?
+      return true if disable_wings # always return true if wings is disabled
       ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_VALKYRIE', false))
     end
     # @!endgroup
@@ -495,6 +493,15 @@ module Hyrax
         Hyrax::Characterization::ValkyrieCharacterizationService
     end
 
+    ##
+    # @!attribute [w] characterization_proxy
+    #   Which FileSet file to use for mime type resolution
+    #   @ see Hyrax::FileSetTypeService
+    attr_writer :characterization_proxy
+    def characterization_proxy
+      @characterization_proxy ||= :original_file
+    end
+
     # Attributes for the lock manager which ensures a single process/thread is mutating a ore:Aggregation at once.
     # @!attribute [w] lock_retry_count
     #   How many times to retry to acquire the lock before raising UnableToAcquireLockError
@@ -524,20 +531,6 @@ module Hyrax
       @ingest_queue_name ||= :default
     end
 
-    # @deprecated
-    def whitelisted_ingest_dirs
-      Deprecation.warn(self, "Samvera is deprecating #{self.class}#whitelisted_ingest_dirs " \
-        "in Hyrax 3.0. Instead use #{self.class}#registered_ingest_dirs.")
-      registered_ingest_dirs
-    end
-
-    # @deprecated
-    def whitelisted_ingest_dirs=(input)
-      Deprecation.warn(self, "Samvera is deprecating #{self.class}#whitelisted_ingest_dirs= " \
-        "in Hyrax 3.0. Instead use #{self.class}#registered_ingest_dirs=.")
-      self.registered_ingest_dirs = input
-    end
-
     # @!attribute [w] registered_ingest_dirs
     #   List of directories which can be used for local file system ingestion.
     attr_writer :registered_ingest_dirs
@@ -816,17 +809,6 @@ module Hyrax
       end
     end
 
-    attr_writer :resource_id_to_uri_transformer
-    def resource_id_to_uri_transformer
-      Deprecation.warn('Use Hyrax.config.translate_uri_to_id instead.')
-
-      @resource_id_to_uri_transformer ||= lambda do |resource, base_url|
-        file_id = CGI.escape(resource.file_identifier.to_s)
-        fs_id = CGI.escape(resource.file_set_id.to_s)
-        "#{base_url}#{::Noid::Rails.treeify(fs_id)}/files/#{file_id}"
-      end
-    end
-
     attr_writer :contact_email
     def contact_email
       @contact_email ||= "repo-admin@example.org"

data/lib/hyrax/controlled_vocabularies/location.rb

@@ -4,10 +4,17 @@ module Hyrax
     class Location < ActiveTriples::Resource
       configure rdf_label: ::RDF::Vocab::GEONAMES.name
 
+      include ResourceLabelCaching
+
       # Return a tuple of url & label
       def solrize
-        return [rdf_subject.to_s] if rdf_label.first.to_s.blank? || rdf_label.first.to_s == rdf_subject.to_s
-        [rdf_subject.to_s, { label: "#{rdf_label.first}$#{rdf_subject}" }]
+        label = full_label || rdf_label.first.to_s
+        return [rdf_subject.to_s] if label.blank? || label == rdf_subject.to_s
+        [rdf_subject.to_s, { label: "#{label}$#{rdf_subject}" }]
+      end
+
+      def full_label
+        Hyrax::LocationService.new.full_label(rdf_subject.to_s)
       end
     end
   end

data/lib/hyrax/controlled_vocabularies/resource_label_caching.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Hyrax
+  module ControlledVocabularies
+    ##
+    # adds caching to the {#rdf_label} method.
+    #
+    # for systems that check the {#rdf_label}and use {#fetch} to get upstream
+    # data if it is not present, this can be used to avoid making round trips
+    # to an authoritative web source.
+    #
+    # @see Hyrax::DeepIndexingService
+    module ResourceLabelCaching
+      CACHE_KEY_PREFIX = "hy_label-v1-"
+
+      ##
+      # @note uses the Rails cache to avoid repeated lookups.
+      # @see ActiveTriples::Resource#rdf_label
+      def rdf_label
+        # only cache if this rdf source is represented by a URI;
+        # i.e. don't cache for blank nodes
+        return super unless uri?
+
+        Rails.cache.fetch(cache_key) { super }
+      end
+
+      ##
+      # @note adds behavior to clear the cache whenever a manual fetch of data
+      #   is performed.
+      # @see ActiveTriples::Resource#fetch
+      def fetch(*)
+        Rails.cache.delete(cache_key)
+        super
+      end
+
+      private
+
+      def cache_key
+        "#{CACHE_KEY_PREFIX}#{to_uri.canonicalize.pname}"
+      end
+    end
+  end
+end

data/lib/hyrax/controlled_vocabularies.rb

@@ -5,6 +5,7 @@ module Hyrax
 
     eager_autoload do
       autoload :Location
+      autoload :ResourceLabelCaching
     end
   end
 end

data/lib/hyrax/engine.rb

@@ -15,9 +15,8 @@ module Hyrax
     require 'flipflop'
     require 'flot-rails'
     require 'hydra-file_characterization'
-    require 'jquery-datatables-rails'
-    require 'jquery-ui-rails'
     require 'legato'
+    require 'openseadragon'
     require 'qa'
     require 'tinymce-rails'
     require 'valkyrie'

data/lib/hyrax/publisher.rb

@@ -94,18 +94,45 @@ module Hyrax
     # @macro a_registered_event
     register_event('batch.created')
 
+    # @since 3.4.0
+    # @macro a_registered_event
+    register_event('collection.deleted')
+
     # @since 3.0.0
     # @macro a_registered_event
+    #   @note this event SHOULD be published whevener the metadata is saved
+    #     for a PCDM Collection. the payload for each published event MUST
+    #     include an `:collection` (the updated Collection) AND a `:user` (the
+    #     {::User} responsible for the update). the event SHOULD NOT be
+    #     published for changes that only impact membership properties
+    #     (`#member_of_ids`, `#member_of_collection_ids`, and `#member_ids`)
     register_event('collection.metadata.updated')
 
     # @since 3.0.0
     # @macro a_registered_event
+    #   @note this event SHOULD be published whevener the membership is changed
+    #     for a PCDM Collection. this includes changes to the Collection's
+    #     `#member_ids` attribute, as well as inverse membership changes via
+    #     another Collection/Object's `#member_of_ids` or
+    #     `#member_of_collection_ids` attribute. the event payload MUST include
+    #     either a `:collection` OR a `:collection_id` (the Collection OR its
+    #     unique id), AND a `:user` (the ::User responsible for the update).
     register_event('collection.membership.updated')
 
     # @since 3.3.0
     # @macro a_registered_event
     register_event('file.downloaded')
 
+    # @since 3.4.0
+    # @macro a_registered_event
+    #   @note this event SHOULD be published whenever a {Hyrax::FileMetadata}
+    #     object is updated; i.e. whenever the metadata directly associated with
+    #     a file changes. the event payload MUST include a `:metadata` (the
+    #     {Hyrax::FileMetadata} that has been updated) AND a `:user`. note that
+    #     the `:user` responsible for {FileMetadata} changes may frequently be
+    #     a system user.
+    register_event('file.metadata.updated')
+
     # @since 3.0.0
     # @macro a_registered_event
     register_event('file.set.audited')
@@ -138,8 +165,26 @@ module Hyrax
     # @macro a_registered_event
     register_event('object.acl.updated')
 
+    # @since 3.4.0
+    # @macro a_registered_event
+    #   @note this event SHOULD be published whevener the membership is changed
+    #     for a PCDM Object (including a Hydra Works FileSet). this includes
+    #     changes to the Object's `#member_ids` attribute, as well as inverse
+    #     membership changes via another Object's `#member_of_ids` attribute.
+    #     the event payload MUST include either an `:object` OR an `:object_id`
+    #     (the Object OR its unique id), AND a `:user` (the ::User responsible
+    #     for the update).
+    register_event('object.membership.updated')
+
     # @since 3.0.0
     # @macro a_registered_event
+    #   @note this event SHOULD be published whevener the metadata is saved
+    #     for a PCDM Object (including a Hydra Works FileSet). the payload for
+    #     each published event MUST include an `:object` (the updated Object),
+    #     AND a `:user` (the ::User responsible for the update). the event
+    #     SHOULD NOT be published for changes that only impact membership
+    #     properties (`#member_of_ids`, `#member_of_collection_ids`, and
+    #     `#member_ids`)
     register_event('object.metadata.updated')
 
     # @since 3.2.0

data/lib/hyrax/schema.rb

@@ -4,24 +4,27 @@ module Hyrax
   ##
   # @api public
   #
-  # Builds a schema module for a Valkyrie resource. The schema itself is
-  # resolved by schema loader, which must respond to
-  # `#attributes_for(schema: :name)` with a hash from attribute names to
-  # `Dry::Type` types.
+  # Builds a schema module for a +Valkyrie::Resource+. The schema itself is
+  # resolved by a schema loader instance, which must implement
+  # {SimpleSchemaLoader#attributes_for}, with a hash from attribute names to
+  # +Dry::Type+ types.
   #
   # For the default schema loader, configuration is loaded from
-  # `config/metadata/[name]}.yaml`. Custom schema loaders can be provided
-  # for other types.
+  # +config/metadata/{name}.yaml+. A custom schema loader can be provided as
+  # +:schema_loader+ to
+  # resolve the schema in other ways.
   #
-  # @note `Valkyrie::Resources`/`Hyrax::Resources` are not required to use this
-  # interface, and may define custom attributes using the base
-  # `Valkyrie::Resource.attribute` interface. This mechanism is provided to
-  # allow schemas to be defined in a unified way that don't require programmer
-  # intervention ("configurable schemas"). While the default usage defines
-  # schemas in application configuration, they could also be held in repository
-  # storage, an external schema service, etc... by using a custom schema loader.
+  # @note +Valkyrie::Resource+ and {Hyrax::Resource} classes are not required to
+  #   use this interface, and may define custom attributes using the base
+  #   +Valkyrie::Resource.attribute+ interface. This mechanism is provided to
+  #   allow schemas to be defined in a unified way that don't require programmer
+  #   intervention ("configurable schemas"). While the default schema loader derives
+  #   schemas from configuration files, alternate implementations could provide
+  #   schema definitions pulled from repository storage, an external schema service,
+  #   etc...
   #
   # @param [Symbol] schema_name
+  # @param [#attributes_for] schema_loader
   #
   # @return [Module] a module that, when included, applies a schema to a
   #   `Valkyire::Resource`

data/lib/hyrax/specs/capybara.rb

@@ -17,11 +17,13 @@ require 'capybara-screenshot/rspec'
 require 'selenium-webdriver'
 require 'webdrivers' unless ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
 
+Capybara.save_path = ENV['CI'] ? "/tmp/test-results" : Rails.root.join('tmp', 'capybara')
+
 if ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
   args = %w[disable-gpu no-sandbox whitelisted-ips window-size=1400,1400]
   args.push('headless') if ActiveModel::Type::Boolean.new.cast(ENV['CHROME_HEADLESS_MODE'])
 
-  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(chromeOptions: { args: args })
+  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome("goog:chromeOptions" => { args: args })
 
   Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
     driver = Capybara::Selenium::Driver.new(app,
@@ -67,8 +69,8 @@ Capybara::Screenshot.register_driver(:selenium_chrome_headless_sandboxless) do |
   driver.browser.save_screenshot(path)
 end
 
-Capybara::Screenshot.autosave_on_failure = false
-Capybara::Screenshot.prune_strategy = { keep: 10 }
+Capybara::Screenshot.autosave_on_failure = true
+Capybara::Screenshot.prune_strategy = :keep_last_run
 
 # Save CircleCI artifacts
 
@@ -79,7 +81,7 @@ def save_timestamped_page_and_screenshot(page, meta)
   time_now = Time.zone.now
   timestamp = "#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec / 1000).to_i}"
 
-  artifact_dir = ENV['CI'] ? "/tmp/test-results" : Rails.root.join('tmp', 'capybara')
+  artifact_dir = Capybara.save_path
 
   screenshot_name = "screenshot-#{filename}-#{line_number}-#{timestamp}.png"
   screenshot_path = "#{artifact_dir}/#{screenshot_name}"