hyrax 3.1.0 → 3.4.0

data/app/services/hyrax/default_middleware_stack.rb

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 module Hyrax
+  ##
+  # Defines the Hyrax "Actor Stack", used in creation of works when using
+  # +ActiveFedora+.
+  #
+  # @note this stack, and the Actor classes it calls, is not used when
+  #   +Valkyrie+ models are defined by the application. in that context,
+  #   this behavior is replaced by `Hyrax::Transactions::Container`.
+  #
+  # @see Hyrax::CurationConcern.actor
+  # @see Hyrax::WorksControllerBehavior#create
+  # @see Hyrax::WorksControllerBehavior#update
   class DefaultMiddlewareStack
     # rubocop:disable Metrics/MethodLength
     def self.build_stack
@@ -31,6 +42,9 @@ module Hyrax
         # Decode the private/public/institution on the form into permisisons on
         # the model
         middleware.use Hyrax::Actors::InterpretVisibilityActor
+        #
+        # Handles transfering ownership of works from one user to another
+        middleware.use Hyrax::Actors::TransferRequestActor
 
         # Copies default permissions from the PermissionTemplate to the work
         middleware.use Hyrax::Actors::ApplyPermissionTemplateActor

data/app/services/hyrax/ensure_well_formed_admin_set_service.rb

@@ -14,12 +14,12 @@ module Hyrax
     #
     # @param admin_set_id [String, nil]
     #
-    # @return [String] an admin_set_id; if you provide a "present"
+    # @return [#to_s] an admin_set_id; if you provide a "present"
     #   admin_set_id, this service will return that.
     #
-    # @see AdminSet.find_or_create_default_admin_set_id
+    # @see Hyrax::AdminSetCreateService.find_or_create_default_admin_set
     def self.call(admin_set_id: nil)
-      admin_set_id = admin_set_id.presence || AdminSet.find_or_create_default_admin_set_id
+      admin_set_id = admin_set_id.presence&.to_s || Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s
       Hyrax::PermissionTemplate.find_or_create_by!(source_id: admin_set_id)
       admin_set_id
     end

data/app/services/hyrax/file_set_derivatives_service.rb

@@ -3,13 +3,22 @@ module Hyrax
   # Responsible for creating and cleaning up the derivatives of a file_set
   class FileSetDerivativesService
     attr_reader :file_set
-    delegate :uri, :mime_type, to: :file_set
+    delegate :mime_type, to: :file_set
 
     # @param file_set [Hyrax::FileSet] At least for this class, it must have #uri and #mime_type
     def initialize(file_set)
       @file_set = file_set
     end
 
+    def uri
+      # If given a FileMetadata object, use its parent ID.
+      if file_set.respond_to?(:file_set_id)
+        file_set.file_set_id.to_s
+      else
+        file_set.uri
+      end
+    end
+
     def cleanup_derivatives
       derivative_path_factory.derivatives_for_reference(file_set).each do |path|
         FileUtils.rm_f(path)
@@ -33,12 +42,22 @@ module Hyrax
     # The destination_name parameter has to match up with the file parameter
     # passed to the DownloadsController
     def derivative_url(destination_name)
-      path = derivative_path_factory.derivative_path_for_reference(file_set, destination_name)
+      path = derivative_path_factory.derivative_path_for_reference(derivative_url_target, destination_name)
       URI("file://#{path}").to_s
     end
 
     private
 
+    # If given a FileMetadata object pass the file_set_id for derivative URL
+    # creation.
+    def derivative_url_target
+      if file_set.try(:file_set_id)
+        file_set.file_set_id.to_s
+      else
+        file_set
+      end
+    end
+
     def supported_mime_types
       file_set.class.pdf_mime_types +
         file_set.class.office_document_mime_types +

data/app/services/hyrax/file_set_type_service.rb

@@ -17,13 +17,10 @@ module Hyrax
     attr_reader :file_set
 
     ##
-    # @todo make `file_set_characterization_proxy` (or something better?)
-    #   application-level configuration.
-    #
     # @param [Hyrax::FileSet] file_set
     # @param [Symbol] characterization_proxy defaults to the setting provided by
     #   the application's ActiveFedora `FileSet` class.
-    def initialize(file_set:, characterization_proxy: ::FileSet.characterization_proxy, query_service: Hyrax.custom_queries)
+    def initialize(file_set:, characterization_proxy: Hyrax.config.characterization_proxy, query_service: Hyrax.custom_queries)
       @file_set = file_set
       @proxy_use = Hyrax::FileMetadata::Use.uri_for(use: characterization_proxy)
       @queries = query_service
@@ -48,7 +45,7 @@ module Hyrax
     private
 
     def audio_types
-      return ::FileSet.audio_mime_types if defined?(::FileSet)
+      return ::FileSet.audio_mime_types if defined?(::FileSet) && ::FileSet.respond_to?(:audio_mime_types)
       DEFAULT_AUDIO_TYPES
     end
   end

data/app/services/hyrax/listeners/acl_index_listener.rb

@@ -11,7 +11,9 @@ module Hyrax
       ##
       # Re-index the resource for the updated ACL.
       #
-      # @param event [Dry::Event]
+      # Called when 'object.acl.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_acl_updated(event)
         return unless event[:result] == :success # do nothing on failure
         Hyrax.index_adapter.save(resource: event[:acl].resource)

data/app/services/hyrax/listeners/active_fedora_acl_index_listener.rb

@@ -11,8 +11,11 @@ module Hyrax
       ##
       # Re-index the resource for the updated ACL.
       #
-      # @param event [Dry::Event]
+      # Called when 'object.acl.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_acl_updated(event)
+        return if Hyrax.config.disable_wings
         return unless event[:result] == :success # do nothing on failure
 
         if Hyrax.metadata_adapter.is_a?(Wings::Valkyrie::MetadataAdapter)

data/app/services/hyrax/listeners/batch_notification_listener.rb

@@ -8,7 +8,9 @@ module Hyrax
       ##
       # Notify requesting users of batch success/failure
       #
-      # @param event [Dry::Event]
+      # Called when 'batch.created' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_batch_created(event)
         case event[:result]
         when :success

data/app/services/hyrax/listeners/file_metadata_listener.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Listeners
+    ##
+    # Listens for events related to {Hyrax::FileMetadata}
+    class FileMetadataListener
+      ##
+      # Called when 'file.metadata.updated' event is published; reindexes a
+      # {Hyrax::FileSet} when a file claiming to be its `pcdm_use:OriginalFile`
+      #
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_file_metadata_updated(event)
+        return unless event[:metadata].original_file?
+
+        file_set = Hyrax.query_service.find_by(id: event[:metadata].file_set_id)
+        Hyrax.index_adapter.save(resource: file_set)
+      rescue Valkyrie::Persistence::ObjectNotFoundError => err
+        Hyrax.logger.warn "tried to index file with id #{event[:metadata].id} " \
+                          "in response to an event of type #{event.id} but " \
+                          "encountered an error #{err.message}. should this " \
+                          "object be in a FileSet #{event[:metadata]}"
+      end
+
+      ##
+      # Called when 'object.file.uploaded' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_object_file_uploaded(event)
+        # Run characterization
+        Hyrax.config
+             .characterization_service
+             .run(metadata: event[:metadata], file: event[:metadata].file)
+      end
+    end
+  end
+end

data/app/services/hyrax/listeners/file_set_lifecycle_listener.rb

@@ -6,13 +6,17 @@ module Hyrax
     # Listens for events related to Hydra Works FileSets
     class FileSetLifecycleListener
       ##
-      # @param event [Dry::Event]
+      # Called when 'file.set.attached' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_attached(event)
         FileSetAttachedEventJob.perform_later(event[:file_set], event[:user])
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'file.set.restored' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_restored(event)
         ContentRestoredVersionEventJob
           .perform_later(event[:file_set], event[:user], event[:revision])

data/app/services/hyrax/listeners/file_set_lifecycle_notification_listener.rb

@@ -9,7 +9,9 @@ module Hyrax
       ##
       # Send a notification to the depositor for failed checksum audits.
       #
-      # @param event [Dry::Event]
+      # Called when 'file.set.audited' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_audited(event)
         return unless event[:result] == :failure # do nothing on success
 
@@ -24,7 +26,9 @@ module Hyrax
       # Send a notification to the depositing user for FileSet url import
       # failures.
       #
-      # @param event [Dry::Event]
+      # Called when 'file.set.url.imported' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_url_imported(event)
         Hyrax::ImportUrlFailureService.new(event[:file_set], event[:user]).call if
           event[:result] == :failure

data/app/services/hyrax/listeners/member_cleanup_listener.rb

@@ -3,17 +3,20 @@
 module Hyrax
   module Listeners
     ##
-    # Listens for object deleted events and cleans up associated members
+    # Listens for resource deleted events and cleans up associated members
     class MemberCleanupListener
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
         return unless event.payload.key?(:object) # legacy callback
         return if event[:object].is_a?(ActiveFedora::Base) # handled by legacy code
 
-        Hyrax.custom_queries.find_child_filesets(resource: event[:object]).each do |file_set|
+        Hyrax.custom_queries.find_child_file_sets(resource: event[:object]).each do |file_set|
           begin
             Hyrax.persister.delete(resource: file_set)
             Hyrax.publisher
-                 .publish('object.deleted', object: file_set, id: file_set.id, user: user)
+                 .publish('object.deleted', object: file_set, id: file_set.id, user: event[:user])
           rescue StandardError # we don't uncaught errors looping filesets
             Hyrax.logger.warn "Failed to delete #{file_set.class}:#{file_set.id} " \
                               "during cleanup for resource: #{event[:object]}. " \
@@ -21,6 +24,26 @@ module Hyrax
           end
         end
       end
+
+      # Called when 'collection.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_collection_deleted(event)
+        return unless event.payload.key?(:collection) # legacy callback
+        return if event[:collection].is_a?(ActiveFedora::Base) # handled by legacy code
+
+        Hyrax.custom_queries.find_members_of(collection: event[:collection]).each do |resource|
+          begin
+            resource.member_of_collection_ids -= [event[:collection].id]
+            Hyrax.persister.save(resource: resource)
+            Hyrax.publisher
+                 .publish('collection.membership.updated', collection: event[:collection], user: event[:user])
+          rescue StandardError
+            Hyrax.logger.warn "Failed to remove collection reference from #{work.class}:#{work.id} " \
+                              "during cleanup for collection: #{event[:collection]}. "
+          end
+        end
+      end
     end
   end
 end

data/app/services/hyrax/listeners/metadata_index_listener.rb

@@ -14,30 +14,91 @@ module Hyrax
       ##
       # Re-index the resource.
       #
-      # @param event [Dry::Event]
-      def on_object_metadata_updated(event)
-        log_non_resource(event) && return unless
-          event[:object].is_a?(Valkyrie::Resource)
+      # Called when 'collection.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_collection_metadata_updated(event)
+        return unless resource? event[:collection]
+        Hyrax.index_adapter.save(resource: event[:collection])
+      end
+
+      ##
+      # Re-index the resource.
+      #
+      # Called when 'file.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_file_metadata_updated(event)
+        return unless resource? event[:metadata]
+        Hyrax.index_adapter.save(resource: event[:metadata])
+      end
 
+      ##
+      # Re-index the resource.
+      #
+      # Called when 'object.membership.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_object_membership_updated(event)
+        resource = event.to_h.fetch(:object) { Hyrax.query_service.find_by(id: event[:object_id]) }
+        return unless resource?(resource)
+
+        Hyrax.index_adapter.save(resource: resource)
+      rescue Valkyrie::Persistence::ObjectNotFoundError => err
+        Hyrax.logger.error("Tried to index for an #{event.id} event with " \
+                           "payload #{event.payload}, but failed due to error:\n"\
+                           "\t#{err.message}")
+      end
+
+      ##
+      # Re-index the resource.
+      #
+      # Called when 'object.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_object_metadata_updated(event)
+        return unless resource? event[:object]
         Hyrax.index_adapter.save(resource: event[:object])
       end
 
       ##
       # Remove the resource from the index.
       #
-      # @param event [Dry::Event]
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
-        log_non_resource(event.payload) && return unless
-          event.payload[:object].is_a?(Valkyrie::Resource)
-
+        return unless resource?(event.payload[:object])
         Hyrax.index_adapter.delete(resource: event[:object])
       end
 
+      ##
+      # Remove the resource from the index.
+      #
+      # Called when 'collection.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_collection_deleted(event)
+        return unless resource?(event.payload[:collection])
+        Hyrax.index_adapter.delete(resource: event[:collection])
+      end
+
       private
 
-      def log_non_resource(event)
-        Hyrax.logger.info('Skipping object reindex because the object ' \
-                          "#{event[:object]} was not a Valkyrie::Resource.")
+      def resource?(resource)
+        return true if resource.is_a? Valkyrie::Resource
+        log_non_resource(resource)
+        false
+      end
+
+      def log_non_resource(resource)
+        generic_type = resource_generic_type(resource)
+        Hyrax.logger.info("Skipping #{generic_type} reindex because the " \
+                          "#{generic_type} #{resource} was not a Valkyrie::Resource.")
+      end
+
+      def resource_generic_type(resource)
+        resource.try(:collection?) ? 'collection' : 'object'
       end
     end
   end

data/app/services/hyrax/listeners/object_lifecycle_listener.rb

@@ -6,19 +6,25 @@ module Hyrax
     # Listens for events related to the PCDM Object lifecycles.
     class ObjectLifecycleListener
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
         ContentDeleteEventJob.perform_later(event[:id].to_s, event[:user])
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.deposited' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deposited(event)
         ContentDepositEventJob.perform_later(event[:object], event[:user])
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_metadata_updated(event)
         ContentUpdateEventJob.perform_later(event[:object], event[:user])
       end

data/app/services/hyrax/listeners/proxy_deposit_listener.rb

@@ -3,17 +3,25 @@
 module Hyrax
   module Listeners
     ##
-    # Listens for deposit events, and checks for proxy situations. When a user
+    # @deprecated transfer requests are now carried out synchronously during
+    # object save
+    #
+    ## Listens for deposit events, and checks for proxy situations. When a user
     # deposits an item `on_behalf_of` another, ensures transfer is handled.
     class ProxyDepositListener
       ##
-      # @param event [Dry::Event]
-      def on_object_deposited(event)
-        return if event[:object].try(:on_behalf_of).blank? ||
-                  (event[:object].on_behalf_of == event[:object].depositor)
-
-        ContentDepositorChangeEventJob
-          .perform_later(event[:object], ::User.find_by_user_key(event[:object].on_behalf_of))
+      # Called when 'object.deposited' event is published
+      # @param [Dry::Events::Event] _event
+      # @return [void]
+      def on_object_deposited(_event)
+        Deprecation.warn(
+          "The ProxyDepositListener was deprecated, effective immediately, in \
+          response to a difficult-to-diagnose race condition bug. This listener \
+          is now a no-op. To retain functionality ensure that \
+          DefaultMiddlewareStack is configured to use \
+          Hyrax::Actors::TransferRequestActor. To quiet this deprecation remove any \
+          local initializer configuration that subscribes this listener."
+        )
       end
     end
   end

data/app/services/hyrax/listeners/trophy_cleanup_listener.rb

@@ -5,6 +5,9 @@ module Hyrax
     ##
     # Listens for object deleted events and cleans up associated members
     class TrophyCleanupListener
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
         Trophy.where(work_id: event[:id]).destroy_all
       rescue StandardError => err

data/app/services/hyrax/listeners/workflow_listener.rb

@@ -21,7 +21,9 @@ module Hyrax
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.deposited' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deposited(event)
         return Rails.logger.warn("Skipping workflow initialization for #{event[:object]}; no user is given\n\t#{event}") if
           event[:user].blank?

data/app/services/hyrax/listeners.rb

@@ -7,11 +7,19 @@ module Hyrax
   #
   #    You may need to register a listener as autoload.  See
   #    ./app/services/hyrax/listeners.rb
+  #
+  # When an instance of a listener class is registered with
+  # Dry::Events::Publisher#subscribe, its method(s) will be called when a event
+  # is published that maps to the method name using the pattern:
+  #   on_event_fired => 'event.fired'
+  #
+  # @see https://dry-rb.org/gems/dry-events/0.2/#event-listeners
   module Listeners
     extend ActiveSupport::Autoload
 
     autoload :AclIndexListener
     autoload :BatchNotificationListener
+    autoload :FileMetadataListener
     autoload :FileSetLifecycleListener
     autoload :FileSetLifecycleNotificationListener
     autoload :MemberCleanupListener

data/app/services/hyrax/location_service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Hyrax
+  class LocationService < ::Qa::Authorities::Geonames
+    CACHE_KEY_PREFIX = 'hyrax_geonames_label-v1-'
+    CACHE_EXPIRATION = 1.week
+
+    def full_label(uri)
+      return if uri.blank?
+      id = extract_id uri
+      Rails.cache.fetch(cache_key(id), expires_in: CACHE_EXPIRATION) do
+        label.call(find(id))
+      end
+    end
+
+    private
+
+    def extract_id(obj)
+      uri = case obj
+            when String
+              URI(obj)
+            when URI
+              obj
+            else
+              raise ArgumentError, "#{obj} is not a valid type"
+            end
+      uri.path.split('/').last
+    end
+
+    def cache_key(id)
+      "#{CACHE_KEY_PREFIX}#{id}"
+    end
+  end
+end

data/app/services/hyrax/multiple_membership_checker.rb

@@ -11,6 +11,26 @@ module Hyrax
       @item = item
     end
 
+    # @api public
+    #
+    # Validate member_of_collection_ids does not have any membership conflicts
+    # based on the collection types of the members.
+    #
+    # Collections that have a collection type declaring
+    # `allow_multiple_membership` as `false` require that its members do not
+    # also belong to other collections of the same type.
+    #
+    # @return [True, String] true if no conflicts; otherwise, an error message string
+    def validate
+      return true if item.member_of_collection_ids.empty? || item.member_of_collection_ids.count <= 1
+      return true unless single_membership_collection_types_exist?
+
+      collections_to_check = filter_to_single_membership_collections(item.member_of_collection_ids)
+      problematic_collections = check_collections(collections_to_check)
+      errs = build_error_message(problematic_collections)
+      errs.presence || true
+    end
+
     # @api public
     #
     # Scan a list of collection_ids for multiple single-membership collections.
@@ -42,15 +62,18 @@ module Hyrax
 
     private
 
+    # @return [Boolean] true if there a any collection types that restrict membership
     def single_membership_collection_types_exist?
       single_membership_collection_types_gids.present?
     end
 
+    # @return [Array<String] global ids of collection types that restrict membership
     def single_membership_collection_types_gids
       @single_membership_collection_types_gids ||=
         Hyrax::CollectionType.gids_that_do_not_allow_multiple_membership&.map(&:to_s)
     end
 
+    # @return [Array<Hyrax::PcdmCollection>] list of collection instances for single membership collections
     def filter_to_single_membership_collections(collection_ids)
       return [] if collection_ids.blank?
       field_pairs = {
@@ -58,11 +81,14 @@ module Hyrax
       }
       Hyrax::SolrQueryService.new
                              .with_generic_type(generic_type: "Collection")
-                             .with_ids(ids: Array[collection_ids])
+                             .with_ids(ids: Array(collection_ids).map(&:to_s))
                              .with_field_pairs(field_pairs: field_pairs, join_with: ' OR ')
                              .get_objects(use_valkyrie: true).to_a
     end
 
+    # @param proposed [Array<Hyrax::PcdmCollection>] collections with restricted membership that are being added
+    # @param include_current_members [Boolean] true if current collections for item should also be checked
+    # @return [Array<Hyrax::PcdmCollection>] collections with restricted membership
     def collections_to_check(proposed, include_current_members)
       # ActorStack does a wholesale collection membership replacement, such that
       # proposed collections include existing and new collections.  Parameter
@@ -72,6 +98,19 @@ module Hyrax
       proposed | filter_to_single_membership_collections(item.member_of_collection_ids)
     end
 
+    # @param collections_to_check [Array<Hyrax::PcdmCollection>] collections with restricted membership
+    # @return [Array<Array>] collections groups by collection type
+    # @example example return result
+    #   [
+    #     [
+    #       <Collection(id: 1, collection_type_gid: 1, ...)>,
+    #       <Collection(id: 4, collection_type_gid: 1, ...)>
+    #     ],
+    #     [
+    #       <Collection(id: 13, collection_type_gid: 8, ...)>,
+    #       <Collection(id: 26, collection_type_gid: 8, ...)>
+    #     ]
+    #   ]
     def check_collections(collections_to_check)
       # uniq insures we include a collection only once when it is in the list multiple
       # group_by groups collections of the same collection type together
@@ -82,6 +121,7 @@ module Hyrax
                           .select { |_gid, list| list.count > 1 }
     end
 
+    # @return [nil, String] nil if no errors; otherwise, errors appended into a single human readable message
     def build_error_message(problematic_collections)
       return if problematic_collections.blank?
       error_message_clauses = problematic_collections.map do |gid, list|
@@ -93,10 +133,13 @@ module Hyrax
         "#{error_message_clauses.join('; ')}"
     end
 
+    # @return [String] title of the collection type
     def collection_type_title_from_gid(gid)
       Hyrax::CollectionType.find_by_gid(gid).title
     end
 
+    # @return [String] comma separated (with and before final) list of titles
+    # @example "Title 1, Title 2, and Title 3"
     def collection_titles_from_list(collection_list)
       collection_list.map do |collection|
         collection.title.first