hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/app/services/hyrax/collections_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
-  class CollectionsService
+  class CollectionsService < Hyrax::SearchService
     attr_reader :context
 
     class_attribute :list_search_builder_class
@@ -8,22 +8,22 @@ module Hyrax
 
     # @param [#repository,#blacklight_config,#current_ability] context
     def initialize(context)
-      @context = context
+      super(config: context.blacklight_config, user_params: context.params, search_builder_class: self.class.list_search_builder_class, scope: context)
+      @current_ability = context.current_ability
     end
 
     # @param [Symbol] access :read or :edit
-    def search_results(access)
-      builder = list_search_builder(access)
-      response = context.repository.search(builder)
-      response.documents
-    end
+    def search_results(access = nil)
+      response, _docs = super() do |builder|
+        builder.with_access(access) if access
+        builder.rows(100)
 
-    private
+        yield builder if block_given?
 
-    def list_search_builder(access)
-      list_search_builder_class.new(context)
-                               .rows(100)
-                               .with_access(access)
+        builder
+      end
+
+      response.documents
     end
   end
 end

data/app/services/hyrax/custom_queries/find_collections_by_type.rb

@@ -4,7 +4,7 @@ module Hyrax
     # @example
     #   collection_type = Hyrax::CollectionType.find(1)
     #
-    #   Hyrax.custom_queries.find_collections_by_type(global_id: collection_type.to_global_id)
+    #   Hyrax.custom_queries.find_collections_by_type(global_id: Hyrax::GlobalID(collection_type))
     #
     # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
     class FindCollectionsByType

data/app/services/hyrax/custom_queries/navigators/child_collections_navigator.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
-# Navigate from a resource to the child collections in the resource.
+
 module Hyrax
   module CustomQueries
     module Navigators
+      ##
+      # Navigate from a resource to the child collections in the resource.
+      #
+      # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+      # @since 3.0.0
       class ChildCollectionsNavigator
         # Define the queries that can be fulfilled by this navigator.
         def self.queries
@@ -15,16 +20,22 @@ module Hyrax
           @query_service = query_service
         end
 
+        ##
         # Find child collections of a given resource, and map to Valkyrie Resources
-        # @param [Valkyrie::Resource]
+        #
+        # @param [Valkyrie::Resource] resource
+        #
         # @return [Array<Valkyrie::Resource>]
         def find_child_collections(resource:)
           query_service
             .find_inverse_references_by(resource: resource, property: :member_of_collection_ids)
         end
 
+        ##
         # Find the ids of child collections of a given resource, and map to Valkyrie Resources IDs
-        # @param [Valkyrie::Resource]
+        #
+        # @param [Valkyrie::Resource] resource
+        #
         # @return [Array<Valkyrie::ID>]
         def find_child_collection_ids(resource:)
           find_child_collections(resource: resource).map(&:id)

data/app/services/hyrax/custom_queries/navigators/child_filesets_navigator.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
-# Navigate from a resource to the child filesets in the resource.
+
 module Hyrax
   module CustomQueries
     module Navigators
+      ##
+      # Navigate from a resource to the child filesets in the resource.
+      #
+      # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+      # @since 3.0.0
       class ChildFilesetsNavigator
         # Define the queries that can be fulfilled by this navigator.
         def self.queries
@@ -15,15 +20,21 @@ module Hyrax
           @query_service = query_service
         end
 
+        ##
         # Find child filesets of a given resource, and map to Valkyrie Resources
-        # @param [Valkyrie::Resource]
+        #
+        # @param [Valkyrie::Resource] resource
+        #
         # @return [Array<Valkyrie::Resource>]
         def find_child_filesets(resource:)
           query_service.find_members(resource: resource).select(&:file_set?)
         end
 
+        ##
         # Find the ids of child filesets of a given resource, and map to Valkyrie Resources IDs
-        # @param [Valkyrie::Resource]
+        #
+        # @param [Valkyrie::Resource] resource
+        #
         # @return [Array<Valkyrie::ID>]
         def find_child_fileset_ids(resource:)
           find_child_filesets(resource: resource).map(&:id)

data/app/services/hyrax/custom_queries/navigators/child_works_navigator.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
-# Navigate from a resource to the child works in the resource.
+
 module Hyrax
   module CustomQueries
     module Navigators
+      ##
+      # Navigate from a resource to the child works in the resource.
+      #
+      # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+      # @since 3.0.0
       class ChildWorksNavigator
         # Define the queries that can be fulfilled by this navigator.
         def self.queries
@@ -18,7 +23,8 @@ module Hyrax
         ##
         # Find child works of a given resource, and map to Valkyrie Resources
         #
-        # @param [Valkyrie::Resource]
+        # @param [Valkyrie::Resource] resource
+        #
         # @return [Array<Valkyrie::Resource>]
         def find_child_works(resource:)
           query_service.find_members(resource: resource).select(&:work?)
@@ -27,7 +33,8 @@ module Hyrax
         ##
         # Find the ids of child works of a given resource, and map to Valkyrie Resources IDs
         #
-        # @param [Valkyrie::Resource]
+        # @param [Valkyrie::Resource] resource
+        #
         # @return [Array<Valkyrie::ID>]
         def find_child_work_ids(resource:)
           find_child_works(resource: resource).map(&:id)

data/app/services/hyrax/custom_queries/navigators/collection_members.rb

@@ -6,6 +6,7 @@ module Hyrax
       ##
       # Find members of collections and collections for members
       #
+      # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
       # @since 3.0.0
       class CollectionMembers
         ##

data/app/services/hyrax/custom_queries/navigators/find_files.rb

@@ -8,6 +8,9 @@ module Hyrax
       #   Hyrax.custom_queries.find_original_file(file_set: file_set_resource)
       #   Hyrax.custom_queries.find_extracted_text(file_set: file_set_resource)
       #   Hyrax.custom_queries.find_thumbnail(file_set: file_set_resource)
+      #
+      # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+      # @since 3.0.0
       class FindFiles
         def self.queries
           [:find_files,

data/app/services/hyrax/database_migrator.rb

@@ -3,19 +3,22 @@ require 'rails/generators/actions'
 require 'rails/generators/active_record'
 
 module Hyrax
-  # Hyrax::DatabaseMigrator is responsible for copying Hyrax's required database
-  # migrations into applications. Rails engines typically use the built-in
-  # `{ENGINE_NAME}:install:migrations` task to handle this; instead Hyrax
-  # follows the practice used by Devise to dynamically subclass migrations with
-  # the version of `ActiveRecord::Migration` corresponding to the version of
-  # Rails used by the application. This class was added to resolve Hyrax issue
-  # #2347
+  ##
+  # {Hyrax::DatabaseMigrator} is responsible for copying {Hyrax}'s required database
+  # migrations into applications.
+  #
+  # Rails engines typically use the built-in +[ENGINE_NAME]:install:migrations+
+  # task to handle this; instead {Hyrax} follows the practice used by +Devise+
+  # to dynamically subclass migrations with he version of +ActiveRecord::Migration+
+  # corresponding to the version of Rails used by the application.
   #
   # @see https://github.com/samvera/hyrax/issues/2347
   #
-  # @note Hyrax::DatabaseMigrator uses Rails' generator internals to avoid
-  #       having to re-implement code that knows how to copy migrations only if
-  #       needed
+  # @note {Hyrax::DatabaseMigrator} uses Rails' generator internals to avoid
+  #   having to re-implement code that knows how to copy migrations only if
+  #   needed.
+  #
+  # @note This class was added to resolve Hyrax issue #2347
   class DatabaseMigrator < Rails::Generators::Base
     # @note included to pick up AR's migration numbering algorithm
     include ActiveRecord::Generators::Migration

data/app/services/hyrax/default_middleware_stack.rb

@@ -32,9 +32,6 @@ module Hyrax
         # 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
 
@@ -49,9 +46,6 @@ module Hyrax
 
         # Persist the metadata changes on the resource
         middleware.use Hyrax::Actors::ModelActor
-
-        # Start the workflow for this work
-        middleware.use Hyrax::Actors::InitializeWorkflowActor
       end
     end
     # rubocop:enable Metrics/MethodLength

data/app/services/hyrax/ensure_well_formed_admin_set_service.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Hyrax
+  # This "service" ensures that we have a well formed AdminSet.
+  #
+  # @note For historical reasons, we lazily apply the default admin
+  #   set to curation concerns that don't already have an admin set.
+  #
+  # @see AdminSet
+  # @see Hyrax::PermissionTemplate
+  # @see Hyrax::Actors::DefaultAdminSetActor
+  module EnsureWellFormedAdminSetService
+    # @api public
+    # @since v3.0.0
+    #
+    # @param admin_set_id [String, nil]
+    #
+    # @return [String] 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
+    def self.call(admin_set_id: nil)
+      admin_set_id = admin_set_id.presence || AdminSet.find_or_create_default_admin_set_id
+      Hyrax::PermissionTemplate.find_or_create_by!(source_id: admin_set_id)
+      admin_set_id
+    end
+  end
+end

data/app/services/hyrax/file_set_fixity_check_service.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 module Hyrax
-  # This class runs fixity checks on a FileSet, potentially on multiple
-  # files each with multiple versions in the FileSet.
+  ##
+  # This class runs fixity checks on a {FileSetBehavior}, potentially on multiple
+  # files each with multiple versions in the +FileSet+.
   #
-  # The FixityCheck itself is performed by FixityCheckJob, which
+  # The fixity check itself is performed by {FixityCheckJob}, which
   # just uses the fedora service to ask for fixity verification.
-  # The outcome will be some created ChecksumAuditLog (ActiveRecord)
+  # The outcome will be some created {ChecksumAuditLog} (ActiveRecord)
   # objects, recording the checks and their results.
   #
-  # By default this runs the checks async using ActiveJob, so
-  # returns no useful info -- the checks are still going on. Use
-  # FixityStatusService if you'd like a human-readable status based on
-  # latest recorded checks, or ChecksumAuditLog.latest_for_fileset_id
-  # if you'd like the the machine-readable checks.
+  # By default this runs the checks async using +ActiveJob+, so
+  # returns no useful info -- the checks are still going Use
+  # {ChecksumAuditLog.latest_for_file_set_id} to retrieve the latest
+  # machine-readable checks.
   #
-  # But if you initialize with `async_jobs: false`, checks will be done
-  # blocking in foreground, and you can get back the ChecksumAuditLog
+  # But if you initialize with +async_jobs: false+, checks will be done
+  # blocking in foreground, and you can get back the {ChecksumAuditLog}
   # records created.
   #
   # It will only run fixity checks if there are not recent
-  # ChecksumAuditLogs on record. "recent" is defined by
-  # `max_days_between_fixity_checks` arg, which defaults to config'd
-  # `Hyrax.config.max_days_between_fixity_checks`
+  # {ChecksumAuditLog}s on record. "recent" is defined by
+  # +max_days_between_fixity_checks+ arg, which defaults to configured
+  # {Hyrax::Configuration#max_days_between_fixity_checks}
   class FileSetFixityCheckService
     attr_reader :id, :latest_version_only,
                 :async_jobs, :max_days_between_fixity_checks
@@ -30,8 +30,8 @@ module Hyrax
     # @param async_jobs [Boolean] Run actual fixity checks in background. Default true.
     # @param max_days_between_fixity_checks [int] if an exisitng fixity check is
     #   recorded within this window, no new one will be created. Default
-    #   `Hyrax.config.max_days_between_fixity_checks`. Set to -1 to force
-    #    check.
+    #   {Hyrax::Configuration#max_days_between_fixity_checks}. Set to -1 to force
+    #   check.
     # @param latest_version_only [Booelan]. Check only latest version instead of all
     #   versions. Default false.
     def initialize(file_set,
@@ -68,7 +68,6 @@ module Hyrax
     # Retrieve or generate the fixity check for a file
     # (all versions are checked for versioned files unless latest_version_only set)
     # @param [ActiveFedora::File] file to fixity check
-    # @param [Array] log container for messages
     def fixity_check_file(file)
       versions = file.has_versions? ? file.versions.all : [file]
 

data/app/services/hyrax/file_set_type_service.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Resolves file sets to a mime type. Provides a series of utility methods for
+  # figuring out what a file set is all about.
+  #
+  # @note this service is for `Hyrax::FileSet` Valkyrie Resources. for
+  #   ActiveFedora file sets see Hydra::Works::MimeTypes
+  class FileSetTypeService
+    DEFAULT_AUDIO_TYPES = ['audio/mp3', 'audio/mpeg', 'audio/wav',
+                           'audio/x-wave', 'audio/x-wav', 'audio/ogg'].freeze
+
+    ##
+    # @!attribute [r] file_set
+    #   @return [Hyrax::FileSet]
+    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)
+      @file_set = file_set
+      @proxy_use = Hyrax::FileMetadata::Use.uri_for(use: characterization_proxy)
+      @queries = query_service
+    end
+
+    def metadata
+      @metadata ||= @queries.find_many_file_metadata_by_use(resource: file_set, use: @proxy_use).first
+    end
+
+    ##
+    # @return [String]
+    def mime_type
+      metadata&.mime_type || Hyrax::FileMetadata::GENERIC_MIME_TYPE
+    end
+
+    ##
+    # @return [Boolean]
+    def audio?
+      audio_types.include?(mime_type)
+    end
+
+    private
+
+    def audio_types
+      return ::FileSet.audio_mime_types if defined?(::FileSet)
+      DEFAULT_AUDIO_TYPES
+    end
+  end
+end

data/app/services/hyrax/graph_exporter.rb

@@ -1,19 +1,38 @@
 # frozen_string_literal: true
 module Hyrax
+  ##
+  # @api public
+  #
   # Retrieves the graph for an object with the internal triples removed
   # and the uris translated to external uris.
   class GraphExporter
-    # @param [SolrDocument] solr_document idea here is that in the future, ActiveFedora may serialize the object as JSON+LD
+    ##
+    # @param [SolrDocument, #id] solr_document idea here is that in the future, ActiveFedora may serialize the object as JSON+LD
     # @param [ActionDispatch::Request] request the http request context
-    def initialize(solr_document, request)
+    # @param [String] hostname  the current http host
+    def initialize(solr_document, request = nil, hostname: nil)
+      Deprecation.warn('passing `request` is deprecated; pass a host as `hostname:` instead.') if request
       @solr_document = solr_document
       @request = request
+      @hostname = hostname || request.host
       @additional_resources = []
       @visited_subresources = Set.new
     end
 
-    attr_reader :solr_document, :request, :additional_resources
+    ##
+    # @!attribute [r] additional_resources
+    #   @return [Array<RDF::Graph>]
+    # @!attribute [r] request
+    #   @deprecated use {#hostname} to access the host
+    #   @return [ActionDispatch::Request]
+    # @!attribute [r] solr_document
+    #   @return [#id]
+    # @!attribute [r] hostname
+    #   @return [String]
+    attr_reader :solr_document, :request, :additional_resources, :hostname
+    deprecation_deprecate :request
 
+    ##
     # @return [RDF::Graph]
     def fetch
       clean_graph_repository.find(solr_document.id).tap do |g|
@@ -58,9 +77,10 @@ module Hyrax
 
       if @visited_subresources.add?(resource_id)
         additional_resources << ListSourceExporter.new(
-          resource_id,
-          request,
-          subject_replacer(parent_klass, parent_id)
+          id: resource_id,
+          parent_url: subject_replacer(parent_klass, parent_id),
+          hostname: hostname,
+          connection: connection
         ).fetch
       end
 
@@ -87,8 +107,44 @@ module Hyrax
       Rails.application.routes.url_helpers.solr_document_url(id, host: hostname, anchor: anchor)
     end
 
-    def hostname
-      request.host
+    ##
+    # @api private
+    class ListSourceExporter
+      def initialize(hostname:, id:, parent_url:, connection: CleanConnection.new(ActiveFedora.fedora.connection))
+        @connection = connection
+        @id = id
+        @hostname = hostname
+        @parent_url = parent_url
+      end
+
+      # @!attribute [r] hostname
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [String]
+      # @!attribute [r] parent_url
+      #   @return [String]
+      attr_reader :hostname, :id, :parent_url
+
+      ##
+      # @return [RDF::Graph]
+      def fetch
+        clean_graph_repository.find(id)
+      end
+
+      private
+
+      def clean_graph_repository
+        Hydra::ContentNegotiation::CleanGraphRepository.new(@connection, replacer)
+      end
+
+      # This method is called once for each statement in the graph.
+      def replacer
+        lambda do |resource_id, _graph|
+          parent_id = Hyrax::Base.uri_to_id(parent_url)
+          return parent_url + resource_id.sub(parent_id, '') if resource_id.start_with?(parent_id)
+          Rails.application.routes.url_helpers.solr_document_url(resource_id, host: hostname)
+        end
+      end
     end
   end
 end