hyrax 3.3.0 → 4.0.0.beta1

data/app/models/concerns/hyrax/file_set/characterization.rb

@@ -29,7 +29,7 @@ module Hyrax
           :page_count, :file_title, :last_modified, :original_checksum,
           :duration, :sample_rate, :alpha_channels
         ]
-        self.characterization_proxy = :original_file
+        self.characterization_proxy = Hyrax.config.characterization_proxy
 
         delegate(*characterization_terms, to: :characterization_proxy)
 
@@ -64,6 +64,12 @@ module Hyrax
       end
 
       ActiveFedora::WithMetadata::DefaultMetadataClassFactory.file_metadata_schemas << AlphaChannelsSchema
+
+      # Add file_set_id for Valkyrie support.
+      class FileSetIdSchema < ActiveTriples::Schema
+        property :file_set_id, predicate: ::RDF::URI.new('http://vocabulary.samvera.org/ns#fileSetId')
+      end
+      ActiveFedora::WithMetadata::DefaultMetadataClassFactory.file_metadata_schemas << FileSetIdSchema
     end
   end
 end

data/app/models/concerns/hyrax/file_set_behavior.rb

@@ -35,7 +35,7 @@ module Hyrax
 
     # Cast to a SolrDocument by querying from Solr
     def to_presenter
-      CatalogController.new.fetch(id).last
+      Blacklight::SearchService.new(config: CatalogController.blacklight_config).fetch(id).last
     end
   end
 end

data/app/models/concerns/hyrax/in_admin_set.rb

@@ -6,12 +6,5 @@ module Hyrax
     included do
       belongs_to :admin_set, predicate: Hyrax.config.admin_set_predicate
     end
-
-    ##
-    # @deprecated Use `Sipity::Workflow.find_active_workflow_for` instead.
-    def active_workflow
-      Deprecation.warn 'Use `Sipity::Workflow.find_active_workflow_for` instead.'
-      Sipity::Workflow.find_active_workflow_for(admin_set_id: admin_set_id)
-    end
   end
 end

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -52,6 +52,7 @@ module Hyrax
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
         attribute :admin_set, Solr::Array, "admin_set_tesim"
+        attribute :admin_set_id, Solr::Array, "admin_set_id_ssim"
         attribute :member_ids, Solr::Array, "member_ids_ssim"
         attribute :member_of_collection_ids, Solr::Array, "member_of_collection_ids_ssim"
         attribute :member_of_collections, Solr::Array, "member_of_collections_ssim"

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -65,7 +65,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def admin_set?
-      hydra_model == ::AdminSet
+      hydra_model == Hyrax.config.admin_set_class
     end
 
     ##
@@ -75,9 +75,9 @@ module Hyrax
     end
 
     # Method to return the model
-    def hydra_model(classifier: ActiveFedora.model_mapper)
+    def hydra_model(classifier: nil)
       first('has_model_ssim')&.safe_constantize ||
-        classifier.classifier(self).best_model
+        model_classifier(classifier).classifier(self).best_model
     end
 
     def depositor(default = '')
@@ -107,5 +107,11 @@ module Hyrax
     def collection_type_gid
       first(Hyrax.config.collection_type_index_field)
     end
+
+    private
+
+    def model_classifier(classifier)
+      classifier || ActiveFedora.model_mapper
+    end
   end
 end

data/app/models/concerns/hyrax/user.rb

@@ -34,12 +34,12 @@ module Hyrax::User
     scope :without_system_accounts, -> { where("#{::User.user_key_field} not in (?)", [::User.batch_user_key, ::User.audit_user_key, ::User.system_user_key]) }
 
     # Validate and normalize ORCIDs
-    validates_with OrcidValidator
+    validates_with Hyrax::OrcidValidator
     after_validation :normalize_orcid
 
     # Set up user profile avatars
-    mount_uploader :avatar, AvatarUploader, mount_on: :avatar_file_name
-    validates_with AvatarValidator
+    mount_uploader :avatar, Hyrax::AvatarUploader, mount_on: :avatar_file_name
+    validates_with Hyrax::AvatarValidator
 
     # Add token to authenticate Arkivo API calls
     after_initialize :set_arkivo_token, unless: :persisted? if Hyrax.config.arkivo_api?
@@ -53,6 +53,13 @@ module Hyrax::User
     public_send(self.class.user_key_field)
   end
 
+  ##
+  # @return [String] a local identifier for this user; for use (e.g.) in ACL
+  #   data
+  def agent_key
+    user_key
+  end
+
   # Look for, in order:
   #   A cached version of the agent
   #   A non-cached version (direct read of the database)
@@ -177,6 +184,10 @@ module Hyrax::User
       User.find_by_user_key(user_key) || User.create!(user_key_field => user_key, password: Devise.friendly_token[0, 20])
     end
 
+    def from_agent_key(key)
+      User.find_by_user_key(key)
+    end
+
     def from_url_component(component)
       User.find_by_user_key(component.gsub(/-dot-/, '.'))
     end

data/app/models/concerns/hyrax/work_behavior.rb

@@ -10,7 +10,6 @@ module Hyrax
     include Hydra::WithDepositor
     include HasRepresentative
     include HasRendering
-    include WithFileSets
     include Naming
     include CoreMetadata
     include InAdminSet
@@ -34,7 +33,7 @@ module Hyrax
 
     module ClassMethods
       # This governs which partial to draw when you render this type of object
-      def _to_partial_path #:nodoc:
+      def _to_partial_path # :nodoc:
         @_to_partial_path ||= begin
           element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
           collection = ActiveSupport::Inflector.tableize(name)

data/app/models/content_block.rb

@@ -24,12 +24,6 @@ class ContentBlock < ActiveRecord::Base
   end
 
   class << self
-    # @deprecated
-    def whitelisted?(key)
-      Deprecation.warn(self, "Samvera is deprecating '#{self}.whitelisted?' in Hyrax 3.0. Use #{self}.registered? instead.")
-      registered?(key)
-    end
-
     def registered?(key)
       NAME_REGISTRY.include?(key)
     end

data/app/models/featured_work_list.rb

@@ -18,7 +18,6 @@ class FeaturedWorkList
     @works = FeaturedWork.all
     add_solr_document_to_works
     @works = @works.reject do |work|
-      work.destroy if work.presenter.blank?
       work.presenter.blank?
     end
   end

data/app/models/hyrax/administrative_set.rb

@@ -1,18 +1,53 @@
 # frozen_string_literal: true
 
+require_dependency 'hyrax/administrative_set_name'
+
 module Hyrax
   ##
   # Valkyrie model for Admin Set domain objects.
+  #
+  # ## Relationships
+  #
+  # ### Administrative Set and Work
+  #
+  # * Defined: The relationship is defined by the inverse relationship stored in the
+  #   work's `:admin_set_id` attribute.
+  # * Tested: The work tests the relationship.
+  # * Administrative Set to Work: (1..m)  An admin set can have many works.
+  #
+  # @example Get works in an admin set:
+  #       works = Hyrax.query_service.find_inverse_references_by(id: admin_set.id, property: :admin_set_id)
+  #
+  # * Work to Administrative Set: (1..1)  A work must be in one and only one admin set.
+  #   * See Hyrax::Work for code to get and set the admin set for the work.
+  #
+  # @see Hyrax::Work
+  # @see Valkyrie query adapter's #find_inverse_references_by
+  #
   class AdministrativeSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
 
     attribute :alternative_title, Valkyrie::Types::Set.of(Valkyrie::Types::String)
     attribute :creator,           Valkyrie::Types::Set.of(Valkyrie::Types::String)
-    attribute :description,       Valkyrie::Types::Set.of(Valkyrie::Types::String)
+    attribute :description,       Valkyrie::Types::String
+
+    ##
+    # @return [Boolean] true
+    def collection?
+      true
+    end
 
     def collection_type_gid
       # allow AdministrativeSet to behave more like a regular PcdmCollection
       Hyrax::CollectionType.find_or_create_admin_set_type.to_global_id
     end
+
+    ##
+    # @api private
+    #
+    # @return [Class] an ActiveModel::Name compatible class
+    def self._hyrax_default_name_class
+      Hyrax::AdministrativeSetName
+    end
   end
 end

data/app/models/hyrax/collection_type.rb

@@ -109,9 +109,9 @@ module Hyrax
 
     ##
     # @return [Enumerable<Collection, PcdmCollection>]
-    def collections(use_valkyrie: false)
+    def collections(use_valkyrie: Hyrax.config.use_valkyrie?)
       return [] unless id
-      return Hyrax.custom_queries.find_collections_by_type(global_id: to_global_id) if use_valkyrie
+      return Hyrax.custom_queries.find_collections_by_type(global_id: to_global_id.to_s) if use_valkyrie
       ActiveFedora::Base.where(Hyrax.config.collection_type_index_field.to_sym => to_global_id.to_s)
     end
 

data/app/models/hyrax/file_metadata.rb

@@ -1,7 +1,30 @@
 # frozen_string_literal: true
 
 module Hyrax
+  ##
+  # Casts a resource to an associated FileMetadata
+  #
+  # @param [Valkyrie::StorageAdapter::File] file
+  #
+  # @return [Hyrax::FileMetadata]
+  # @raise [ArgumentError]
+  def self.FileMetadata(file)
+    raise(ArgumentError, "Expected a Valkyrie::StorageAdapter::File; got #{file.class}: #{file}") if
+      file.is_a?(Valkyrie::Resource)
+
+    Hyrax.custom_queries.find_file_metadata_by(id: file.id)
+  rescue Hyrax::ObjectNotFoundError, Ldp::BadRequest
+    Hyrax.logger.debug('Could not find an existing metadata node for file ' \
+                       "with id #{file.id}. Initializing a new one")
+
+    FileMetadata.new(file_identifier: file.id, alternative_ids: [file.id])
+  end
+
   class FileMetadata < Valkyrie::Resource
+    # Include mime-types for Hydra Derivatives mime-type checking. We may want
+    # to move this logic someday.
+    include Hydra::Works::MimeTypes
+
     GENERIC_MIME_TYPE = 'application/octet-stream'
 
     ##
@@ -35,7 +58,7 @@ module Hyrax
     end
 
     attribute :file_identifier, Valkyrie::Types::ID # id of the file stored by the storage adapter
-    attribute :alternate_ids, Valkyrie::Types::Set.of(Valkyrie::Types::ID) # id of the Hydra::PCDM::File which holds metadata and the file in ActiveFedora
+    attribute :alternate_ids, Valkyrie::Types::Set.of(Valkyrie::Types::ID) # id of the file, populated for queryability
     attribute :file_set_id, ::Valkyrie::Types::ID # id of parent file set resource
 
     # all remaining attributes are on AF::File metadata_node unless otherwise noted
@@ -103,7 +126,9 @@ module Hyrax
     attribute :aspect_ratio, ::Valkyrie::Types::Set
 
     # @param [ActionDispatch::Http::UploadedFile] file
+    # @deprecated Use #new instead; for removal in 4.0.0
     def self.for(file:)
+      Deprecation.warn "#{self.class}##{__method__} is deprecated; use #new instead."
       new(label: file.original_filename,
           original_filename: file.original_filename,
           mime_type: file.content_type)
@@ -151,8 +176,17 @@ module Hyrax
       ''
     end
 
+    ##
+    # @return [Valkyrie::StorageAdapter::File]
+    #
+    # @raise [Valkyrie::StorageAdapter::AdapterNotFoundError] if no adapter
+    #   could be found matching the file_identifier's scheme
+    # @raise [Valkyrie::StorageAdapter::FileNotFound] when the file can't
+    #   be found in the registered adapter
     def file
-      Hyrax.storage_adapter.find_by(id: file_identifier)
+      Valkyrie::StorageAdapter
+        .adapter_for(id: file_identifier)
+        .find_by(id: file_identifier)
     end
   end
 end

data/app/models/hyrax/file_set.rb

@@ -4,22 +4,61 @@ module Hyrax
   ##
   # Valkyrie model for `FileSet` domain objects in the Hydra Works model.
   #
+  # ## Relationships
+  #
+  # ### File Set and Work
+  #
+  # * Defined: The relationship is defined by the inverse relationship stored in the
+  #   work's `:member_ids` attribute.
+  # * Tested: The work tests the relationship.
+  # * File Set to Work: (1..1)  A file set must be in one and only one work.
+  #
+  # @example Get work for a file set:
+  #       work = Hyrax.custom_queries.find_parent_work(resource: file_set)
+  #
+  # * Work to File Set: (0..m)  A work can have many file sets.
+  #   * See Hyrax::Work for code to get and set file sets for the work.
+  #
+  # ### File Set and File (TBD)
+  #
+  # @see Hyrax::Work
+  # @see Hyrax::CustomQueries::Navigators::ParentWorkNavigator#find_parent_work
+  #
+  # @todo The description in Hydra::Works Shared Modeling is out of date and uses
+  #   terminology to describe the relationships that is no longer used in code.
+  #   Update the model and link to it.  This can be a simple relationship diagram
+  #   with a link to the original Works Shared Modeling for historical perspective.
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
     include Hyrax::Schema(:basic_metadata)
 
     def self.model_name(name_class: Hyrax::Name)
-      @_model_name ||= begin
-        name_class.new(self, nil, 'FileSet')
-      end
+      @_model_name ||= name_class.new(self, nil, 'FileSet')
     end
 
+    class_attribute :characterization_proxy
+    self.characterization_proxy = Hyrax.config.characterization_proxy
+
     attribute :file_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID) # id for FileMetadata resources
+    attribute :thumbnail_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
     attribute :original_file_id, Valkyrie::Types::ID # id for FileMetadata resource
-    attribute :thumbnail_id, Valkyrie::Types::ID # id for FileMetadata resource
     attribute :extracted_text_id, Valkyrie::Types::ID # id for FileMetadata resource
 
+    ##
+    # @return [Valkyrie::ID]
+    def representative_id
+      id
+    end
+
+    ##
+    # @return [Valkyrie::ID]
+    # If one is set then return it, otherwise use self as the ID to allow for
+    # derivative generators to find the on-disk path for the thumbnail.
+    def thumbnail_id
+      self.[](:thumbnail_id) || id
+    end
+
     ##
     # @return [Boolean] true
     def pcdm_object?

data/app/models/hyrax/group.rb

@@ -7,12 +7,31 @@ module Hyrax
       DEFAULT_NAME_PREFIX
     end
 
+    ##
+    # @return [Hyrax::Group]
+    def self.from_agent_key(key)
+      new(key.delete_prefix(name_prefix))
+    end
+
     def initialize(name)
       @name = name
     end
 
     attr_reader :name
 
+    ##
+    # @return [Boolean]
+    def ==(other)
+      other.class == self.class && other.name == name
+    end
+
+    ##
+    # @return [String] a local identifier for this group; for use (e.g.) in ACL
+    #   data
+    def agent_key
+      self.class.name_prefix + name
+    end
+
     def to_sipity_agent
       sipity_agent || create_sipity_agent!
     end

data/app/models/hyrax/pcdm_collection.rb

@@ -5,9 +5,42 @@ require_dependency 'hyrax/collection_name'
 module Hyrax
   ##
   # Valkyrie model for Collection domain objects in the Hydra Works model.
+  #
+  # ## Relationships
+  #
+  # ### Collection and Collection (TBA)
+  #
+  # ### Collection and Work
+  #
+  # * Defined: The relationship is defined by the inverse relationship stored in the
+  #   work's `:member_of_collection_ids` attribute.
+  # * Tested: The work tests the relationship.
+  # * Collection to Work: (0..m)  A collection can have many works.
+  #
+  # @example Get works in a collection:
+  #       works = Hyrax.custom_queries.find_child_works(resource: collection)
+  #
+  # * Work to Collection: (0..m)  A work can be in many collections.
+  #   * See Hyrax::Work for code to get and set collections for the work.
+  #
+  # @note Some collection types limit a work to belong to one and only one collection of that type.
+  #
+  # ### All children
+  #
+  # * There are additional methods for finding all children without respect to
+  #   the child's type.
+  #
+  # @example Get works and child collections in a collection using:
+  #       members = Hyrax.custom_queries.find_members_of(resource: collection)
+  #
+  # @see Hyrax::Work
+  #
+  # @see Hyrax::CustomQueries::Navigators::ChildCollectionsNavigator#find_child_collections
+  # @see Hyrax::CustomQueries::Navigators::ChildWorksNavigator#find_child_works
+  # @see Hyrax::CustomQueries::Navigators::CollectionMembers#find_members_of
+  #
   class PcdmCollection < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
-    include Hyrax::Schema(:basic_metadata)
 
     attribute :collection_type_gid, Valkyrie::Types::String
     attribute :member_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)
@@ -32,5 +65,27 @@ module Hyrax
     def pcdm_object?
       true
     end
+
+    def permission_manager
+      @permission_manager ||= Hyrax::PermissionManager.new(resource: self)
+    end
+
+    def visibility=(value)
+      visibility_writer.assign_access_for(visibility: value)
+    end
+
+    def visibility
+      visibility_reader.read
+    end
+
+    protected
+
+    def visibility_writer
+      Hyrax::VisibilityWriter.new(resource: self)
+    end
+
+    def visibility_reader
+      Hyrax::VisibilityReader.new(resource: self)
+    end
   end
 end

data/app/models/hyrax/permission_template.rb

@@ -4,7 +4,7 @@ module Hyrax
   # Holds policy data about the workflow and permissions applied objects when
   # they are deposited through an Administrative Set or a Collection. Each
   # template record has a {#source} (through {#source_id}); the template's
-  # rules inform the behavior of objects deposited through that {#source_model}.
+  # rules inform the behavior of objects deposited through that {#source}.
   #
   # The {PermissionTemplate} specifies:
   #
@@ -81,36 +81,16 @@ module Hyrax
     # A bit of an analogue for a `belongs_to :source_model` as it crosses from Fedora to the DB
     # @return [AdminSet, ::Collection]
     # @raise [Hyrax::ObjectNotFoundError] when neither an AdminSet or Collection is found
+    # @note This method will eventually be replaced by #source which returns a Hyrax::Resource
+    #   object.  Many methods are equally able to process both Hyrax::Resource and
+    #   ActiveFedora::Base.  Only call this method if you need the ActiveFedora::Base object.
+    # @see #source
     def source_model
       ActiveFedora::Base.find(source_id)
     rescue ActiveFedora::ObjectNotFoundError
       raise Hyrax::ObjectNotFoundError
     end
 
-    # A bit of an analogue for a `belongs_to :admin_set` as it crosses from Fedora to the DB
-    # @deprecated Use #source_model instead
-    # @return [AdminSet]
-    # @raise [Hyrax::ObjectNotFoundError] when the we cannot find the AdminSet
-    def admin_set
-      Deprecation.warn('Use #source_model instead')
-      return AdminSet.find(source_id) if AdminSet.exists?(source_id)
-      raise Hyrax::ObjectNotFoundError
-    rescue ActiveFedora::ActiveFedoraError # TODO: remove the rescue when active_fedora issue #1276 is fixed
-      raise Hyrax::ObjectNotFoundError
-    end
-
-    # A bit of an analogue for a `belongs_to :collection` as it crosses from Fedora to the DB
-    # @deprecated Use #source_model instead
-    # @return [Collection]
-    # @raise [Hyrax::ObjectNotFoundError] when the we cannot find the Collection
-    def collection
-      Deprecation.warn('Use #source_model instead')
-      return ::Collection.find(source_id) if ::Collection.exists?(source_id)
-      raise Hyrax::ObjectNotFoundError
-    rescue ActiveFedora::ActiveFedoraError # TODO: remove the rescue when active_fedora issue #1276 is fixed
-      raise Hyrax::ObjectNotFoundError
-    end
-
     # Valid Release Period values
     RELEASE_TEXT_VALUE_FIXED = 'fixed'
     RELEASE_TEXT_VALUE_NO_DELAY = 'now'
@@ -215,15 +195,6 @@ module Hyrax
         [::Ability.registered_group_name, ::Ability.public_group_name]
     end
 
-    ##
-    # @param interpret_visibility [Boolean] whether to retain the existing
-    #   visibility when applying permission template ACLs
-    # @return [Boolean]
-    def reset_access_controls(interpret_visibility: false)
-      reset_access_controls_for(collection: source_model,
-                                interpret_visibility: interpret_visibility)
-    end
-
     ##
     # @param collection [::Collection, Hyrax::Resource]
     # @param interpret_visibility [Boolean] whether to retain the existing

data/app/models/hyrax/work.rb

@@ -4,6 +4,97 @@ module Hyrax
   ##
   # Valkyrie model for `Work` domain objects in the Hydra Works model.
   #
+  # ## Relationships
+  #
+  # ### Administrative Set and Work
+  #
+  # * Defined: The relationship is defined by the work's `:admin_set_id` attribute.
+  # * Tested: The relationship is tested in shared spec `'a Hyrax::Work'` by testing
+  #   `#admin_set_id`.  Shared specs are defined in /lib/hyrax/specs/shared_specs/hydra_works.rb.
+  # * Administrative Set to Work: (1..m) An admin set can have many works.
+  #   * See Hyrax::AdministrativeSet for code to get works in an admin set.
+  # * Work to Administrative Set: (1..1)  A work must be in one and only one admin set.
+  #
+  # @example Set admin set for a work:
+  #       work.admin_set_id = admin_set.id
+  # @example Get admin set a work is in:
+  #       admin_set = Hyrax.query_service.find_by(id: work.admin_set_id)
+  #
+  # ### Collection and Work
+  #
+  # * Defined: The relationship is defined by the work's `:member_of_collection_ids` attribute.
+  # * Tested: The relationship is tested in shared spec `'a Hyrax::Work'` by testing
+  #   `it_behaves_like 'belongs to collections'`.  Shared specs are defined in /lib/hyrax/specs/shared_specs/hydra_works.rb.
+  # * Collection to Work: (0..m)  A collection can have many works.
+  #   * See Hyrax::PcdmCollection for code to get works in a collection.
+  # * Work to Collection: (0..m)  A work can be in many collections.
+  #
+  # @example Add a work to a collection using Hyrax::CollectionMemberService (multiple method options)
+  #       Hyrax::CollectionMemberService.add_members(collection_id: col.id, members: works, user: current_user)
+  # @example Get collections a work is in:
+  #       collections = Hyrax.custom_queries.find_collections_for(resource: work)
+  #
+  # @note Some collection types limit a work to belong to one and only one collection of that type.
+  #
+  # ### Work and Work
+  #
+  # * Defined: The relationship is defined in the parent work's `:member_ids` attribute.
+  # * Tested: The relationship is tested in shared spec `'a Hyrax::Work'` by testing
+  #   `it_behaves_like 'has_members'`.  Shared specs are defined in /lib/hyrax/specs/shared_specs/hydra_works.rb.
+  # * Work to child Work: (0..m)  A work can have many child works.
+  #
+  # @example Add a child work to a work:
+  #       Hyrax::Transactions::Container['work_resource.add_to_parent']
+  #         .call(child_work, parent_id: parent_work.id, user: current_user)
+  # @example Get child works:
+  #       works = Hyrax.custom_queries.find_child_works(resource: parent_work)
+  #
+  # * Work to parent Work: (0..1)  A work can be in at most one parent work.
+  #
+  # @example Get parent work:
+  #       parent_work = Hyrax.custom_queries.find_parent_work(resource: child_work)
+  #
+  # @note `:member_ids` holds ids of child works and file sets.
+  #
+  # ### Work and File Set
+  #
+  # * Defined: The relationship is defined in the parent work's `:member_ids` attribute.
+  # * Tested: The relationship is tested in shared spec `'a Hyrax::Work'` by testing
+  #   `it_behaves_like 'has_members'`.  Shared specs are defined in /lib/hyrax/specs/shared_specs/hydra_works.rb.
+  # * Work to File Set: (0..m)  A work can have many file sets.
+  # @example Add a file set to a work (code from Hyrax::WorkUploadsHandler#append_to_work)
+  #       work.member_ids << file_set.id
+  #       work.representative_id = file_set.id if work.respond_to?(:representative_id) && work.representative_id.blank?
+  #       work.thumbnail_id = file_set.id if work.respond_to?(:thumbnail_id) && work.thumbnail_id.blank?
+  #       Hyrax.persister.save(resource: work)
+  #       Hyrax.publisher.publish('object.metadata.updated', object: work, user: files.first.user)
+  # @example Get file sets:
+  #       file_sets = Hyrax.custom_queries.find_child_file_sets(resource: work)
+  #
+  # * File Set to Work: (1..1)  A file set must be in one and only one work.
+  #   * See Hyrax::FileSet for code to get the work a file set is in.
+  #
+  # @see Hyrax::AdministrativeSet
+  # @see Hyrax::PcdmCollection
+  # @see Hyrax::FileSet
+  #
+  # @see Hyrax::CollectionMemberService
+  # @see Hyrax::Transactions::Steps::AddToParent
+  # @see Hyrax::Transactions::Steps::AddFileSets
+  # @see Hyrax::WorksControllerBehavior
+  # @see Hyrax::WorkUploadsHandler#append_to_work
+  #
+  # @see Valkyrie query adapter's #find_by
+  # @see Hyrax::CustomQueries::Navigators::CollectionMembers#find_collections_for
+  # @see Hyrax::CustomQueries::Navigators::ParentWorkNavigator#find_parent_work
+  # @see Hyrax::CustomQueries::Navigators::ChildFileSetsNavigator#find_child_file_sets
+  #
+  # @see /lib/hyrax/specs/shared_specs/hydra_works.rb
+  #
+  # @todo The description in Hydra::Works Shared Modeling is out of date and uses
+  #   terminology to describe the relationships that is no longer used in code.
+  #   Update the model and link to it.  This can be a simple relationship diagram
+  #   with a link to the original Works Shared Modeling for historical perspective.
   # @see https://wiki.lyrasis.org/display/samvera/Hydra::Works+Shared+Modeling
   class Work < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)

data/app/models/job_io_wrapper.rb

@@ -94,7 +94,7 @@ class JobIoWrapper < ApplicationRecord
 
   def extracted_original_name
     eon = uploaded_file.uploader.filename if uploaded_file
-    eon ||= File.basename(path) if path.present? # note: uploader.filename is `nil` with uncached remote files (e.g. AWSFile)
+    eon ||= File.basename(path) if path.present? # NOTE: uploader.filename is `nil` with uncached remote files (e.g. AWSFile)
     eon
   end
 

data/app/models/proxy_deposit_request.rb

@@ -129,7 +129,7 @@ class ProxyDepositRequest < ActiveRecord::Base
 
   # @param [TrueClass,FalseClass] reset (false)  if true, reset the access controls. This revokes edit access from the depositor
   def transfer!(reset = false)
-    ContentDepositorChangeEventJob.perform_later(work, receiving_user, reset)
+    Hyrax::ChangeDepositorService.call(work, receiving_user, reset)
     fulfill!(status: ACCEPTED)
   end
 

data/app/presenters/hyrax/admin/repository_object_presenter.rb

@@ -2,8 +2,6 @@
 module Hyrax
   module Admin
     class RepositoryObjectPresenter
-      include Blacklight::SearchHelper
-
       def as_json(*)
         counts.map do |k, v|
           { label: I18n.translate(k, scope: 'hyrax.admin.stats.repository_objects.series'),