hyrax 4.0.0.beta1 → 4.0.0.beta2

data/app/services/hyrax/collections/nested_collection_query_service.rb

@@ -4,26 +4,6 @@ module Hyrax
     ##
     # A query service handling nested collection queries.
     module NestedCollectionQueryService
-      ##
-      # @api private
-      #
-      # an encapsulation of a collection's nesting index attributes
-      class NestingAttributes
-        attr_accessor :parents, :pathnames, :ancestors, :depth, :id
-
-        def initialize(id:, scope:)
-          query_builder = Hyrax::CollectionSearchBuilder.new(scope).where(id: id.to_s)
-          query = Hyrax::Collections::NestedCollectionQueryService.clean_lucene_error(builder: query_builder)
-          response = scope.repository.search(query)
-          collection_doc = response.documents.first
-          @id = id.to_s
-          @parents = collection_doc[Samvera::NestingIndexer.configuration.solr_field_name_for_storing_parent_ids]
-          @pathnames = collection_doc[Samvera::NestingIndexer.configuration.solr_field_name_for_storing_pathnames]
-          @ancestors = collection_doc[Samvera::NestingIndexer.configuration.solr_field_name_for_storing_ancestors]
-          @depth = collection_doc[Samvera::NestingIndexer.configuration.solr_field_name_for_deepest_nested_depth]
-        end
-      end
-
       ##
       # @api public
       #
@@ -71,8 +51,7 @@ module Hyrax
       def self.parent_collections(child:, scope:, page: 1)
         return [] unless nestable?(collection: child)
         query_builder = Hyrax::NestedCollectionsParentSearchBuilder.new(scope: scope, child: child, page: page)
-        query = clean_lucene_error(builder: query_builder)
-        scope.repository.search(query)
+        scope.repository.search(query_builder.query)
       end
 
       ##
@@ -86,39 +65,18 @@ module Hyrax
       #   id is in the response. Useful for validation.
       # @param nest_direction [Symbol] :as_child or :as_parent
       def self.query_solr(collection:, access:, scope:, limit_to_id:, nest_direction:)
-        nesting_attributes = NestingAttributes.new(id: collection.id.to_s, scope: scope)
         query_builder = Hyrax::Dashboard::NestedCollectionsSearchBuilder.new(
           access: access,
           collection: collection,
           scope: scope,
-          nesting_attributes: nesting_attributes,
           nest_direction: nest_direction
         )
 
         query_builder.where(id: limit_to_id.to_s) if limit_to_id
-        query = clean_lucene_error(builder: query_builder)
-        scope.repository.search(query)
+        scope.repository.search(query_builder.query)
       end
       private_class_method :query_solr
 
-      ##
-      # @api private
-      #
-      # clean query for +{!lucene}+ error
-      #
-      # @param builder [SearchBuilder]
-      # @return [Blacklight::Solr::Request] cleaned and functional query
-      def self.clean_lucene_error(builder:)
-        # TODO: Need to investigate further to understand why these particular queries
-        # using the where cause fail when others in the app apparently work
-        #
-        # Perhaps see <https://github.com/projectblacklight/blacklight/blob/064302f73eee4baae4d2abf863c68317d3efb5b7/lib/blacklight/solr/search_builder_behavior.rb#L84-L102>.
-        # This can be averted by using #with in at least some cases?
-        query = builder.query.to_hash
-        query['q'] = query['q'].gsub('{!lucene}', '') if query.key?('q')
-        query
-      end
-
       ##
       # @api public
       #
@@ -144,73 +102,6 @@ module Hyrax
         true
       end
 
-      # @api public
-      #
-      # Does the nesting depth fall within defined limit?
-      #
-      # @param parent [::Collection]
-      # @param child [nil, ::Collection] will be nil if we are nesting a new
-      #   collection under the parent
-      # @param scope [Object] Typically a controller object that responds
-      #   to +repository+, +can?+, +blacklight_config+, +current_ability+
-      #
-      # @return [Boolean] true if the parent can nest the child; false otherwise
-      def self.valid_combined_nesting_depth?(parent:, child: nil, scope:)
-        # We limit the total depth of collections to the size specified in the samvera-nesting_indexer configuration.
-        child_depth = child_nesting_depth(child: child, scope: scope)
-        parent_depth = parent_nesting_depth(parent: parent, scope: scope)
-        return false if parent_depth + child_depth > Samvera::NestingIndexer.configuration.maximum_nesting_depth
-        true
-      end
-
-      # @api private
-      #
-      # Get the child collection's nesting depth
-      #
-      # @param child [::Collection]
-      # @return [Fixnum] the largest number of collections in a path nested
-      #   under this collection (including this collection)
-      def self.child_nesting_depth(child:, scope:)
-        return 1 unless child
-        # The nesting depth of a child collection is found by finding the largest nesting depth
-        # among all collections and works which have the child collection in the paths, and
-        # subtracting the nesting depth of the child collection itself.
-        # => 1) First we find all the collections with this child in the path, sort the results in descending order, and take the first result.
-        # note: We need to include works in this search. They are included in the depth validations in
-        # the indexer, so we do NOT use collection search builder here.
-        builder = Hyrax::SearchBuilder.new(scope).with({
-                                                         q: "#{Samvera::NestingIndexer.configuration.solr_field_name_for_storing_pathnames}:/.*#{child.id}.*/",
-                                                         sort: "#{Samvera::NestingIndexer.configuration.solr_field_name_for_deepest_nested_depth} desc"
-                                                       })
-        builder.rows = 1
-        query = clean_lucene_error(builder: builder)
-        response = scope.repository.search(query).documents.first
-
-        # Now we have the largest nesting depth for all paths containing this collection
-        descendant_depth = response[Samvera::NestingIndexer.configuration.solr_field_name_for_deepest_nested_depth]
-
-        # => 2) Then we get the stored depth of the child collection itself to eliminate the collections above this one from our count, and add 1 to add back in this collection itself
-        child_depth = NestingAttributes.new(id: child.id.to_s, scope: scope).depth
-        nesting_depth = descendant_depth - child_depth + 1
-
-        # this should always be positive, but just being safe
-        nesting_depth.positive? ? nesting_depth : 1
-      end
-      private_class_method :child_nesting_depth
-
-      # @api private
-      #
-      # Get the parent collection's nesting depth
-      #
-      # @param parent [::Collection]
-      # @return [Fixnum] the largest number of collections above
-      #   this collection (includes this collection)
-      def self.parent_nesting_depth(parent:, scope:)
-        return 1 if parent.nil?
-        NestingAttributes.new(id: parent.id.to_s, scope: scope).depth
-      end
-      private_class_method :parent_nesting_depth
-
       # @api private
       #
       # @param collection [Hyrax::PcdmCollection,::Collection]
@@ -218,8 +109,7 @@ module Hyrax
       def self.nestable?(collection:)
         return false if collection.blank?
         return collection.nestable? if collection.respond_to? :nestable?
-        collection_type = Hyrax::CollectionType.find_by_gid!(collection.collection_type_gid)
-        collection_type.nestable?
+        Hyrax::CollectionType.for(collection: collection).nestable?
       end
       private_class_method :nestable?
     end

data/app/services/hyrax/derivative_service.rb

@@ -1,26 +1,59 @@
 # frozen_string_literal: true
+
+# @api public
+#
+# A factory class _and_ interface defining class that finds the **first** valid registered service for the given object.
+#
+# The .for method is the factory.  The instance_methods of this class defines the interface.
+#
+# @see https://github.com/samvera-labs/newspaper_works/blob/d0c0c0595ad318178896fb7f2abd93c5139fe5b7/lib/newspaper_works/engine.rb#L15-L35 for an example extending the service.
+# @see ValkyrieCreateDerivativesJob for example of this object's usage within Hyrax
+# @see Hyrax::FileSet::Derivatives for example of this object's usage within Hyrax
+# @see Hyrax::FileSetDerivativesService for a class that implements the Hyrax::DerivativeService interface
 class Hyrax::DerivativeService
-  class_attribute :services
-  self.services = [Hyrax::FileSetDerivativesService]
-  def self.for(file_set)
+  # @deprecated favor Hyrax.config.derivative_services=
+  def self.services=(services)
+    Deprecation.warn("Hyrax::DerivativeService.services= is deprecated; favor Hyrax.config.derivative_servies=")
+    Hyrax.config.derivative_services = Array(services)
+  end
+
+  # @deprecated favor Hyrax.config.derivative_services
+  def self.services
+    Deprecation.warn("Hyrax::DerivativeService.services is deprecated; favor Hyrax.config.derivative_servies")
+    Hyrax.config.derivative_services
+  end
+
+  # @api public
+  #
+  # Get the first valid registered service for the given file_set.
+  #
+  # @param file_set [#uri, #file_set]
+  # @return [#cleanup_derivatives, #create_derivatives, #derivative_url]
+  def self.for(file_set, services: Hyrax.config.derivative_services)
     services.map { |service| service.new(file_set) }.find(&:valid?) ||
       new(file_set)
   end
   attr_reader :file_set
   delegate :mime_type, :uri, to: :file_set
+
+  # @api private
   def initialize(file_set)
     @file_set = file_set
   end
 
+  # @api public
   def cleanup_derivatives; end
 
+  # @api public
   def create_derivatives(_file_path); end
 
-  # What should this return?
+  # @api public
+  # @note What should this return?
   def derivative_url(_destination_name)
     ""
   end
 
+  # @api public
   def valid?
     true
   end

data/app/services/hyrax/edit_permissions_service.rb

@@ -202,20 +202,7 @@ module Hyrax
         # Hyrax::AdministrativeSet, we need to test both cases.
         true
       else
-        if resource.respond_to?(:share_applies_to_new_works?)
-          # The Collection model has traditionally delegated #share_applies_to_new_works? to
-          # the underlying collection_type
-          # (see https://github.com/samvera/hyrax/blob/696da5db/spec/models/collection_spec.rb#L189)
-          resource.share_applies_to_new_works?
-        elsif resource.respond_to?(:collection_type_gid)
-          # This is likely a Hyrax::PcdmCollection object, which means we don't have the delegation
-          # behavior.  Instead we'll query the collection type directly.
-          collection_type = CollectionType.find_by_gid(resource.collection_type_gid)
-          collection_type&.share_applies_to_new_works?
-        else
-          # How might we get here?
-          false
-        end
+        Hyrax::CollectionType.for(collection: resource).share_applies_to_new_works?
       end
     end
 

data/app/services/hyrax/embargo_manager.rb

@@ -161,6 +161,15 @@ module Hyrax
       resource.embargo || Embargo.new
     end
 
+    ##
+    # Drop the embargo by setting its release date to `nil`.
+    #
+    # @return [void]
+    def nullify
+      return unless under_embargo?
+      embargo.embargo_release_date = nil
+    end
+
     ##
     # Sets the visibility of the resource to the embargo's visibility condition.
     # no-op if the embargo period is current.

data/app/services/hyrax/embargo_service.rb

@@ -26,6 +26,10 @@ module Hyrax
         presenters(builder)
       end
 
+      def search_state_class
+        nil
+      end
+
       private
 
       def presenter_class

data/app/services/hyrax/file_set_file_service.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A service for accessing specific Hyrax::FileMetadata objects referenced by a
+  # Hyrax::FileSet.
+  class FileSetFileService
+    ##
+    # @!attribute [r] file_set
+    #   @return [Hyrax::FileSet]
+    attr_reader :file_set
+
+    ##
+    # @!attribute [r] query_service
+    #   @return [#find_by]
+    attr_reader :query_service
+
+    ##
+    # @param resource [Hyrax::FileSet]
+    def initialize(file_set:, query_service: Hyrax.query_service)
+      @query_service = query_service
+      @file_set = file_set
+    end
+
+    ##
+    # Return the Hyrax::FileMetadata which should be considered “original” for
+    # indexing and version‐tracking.
+    #
+    # If +file_set.original_file_id+ is defined, it will be used; otherwise,
+    # this requires a custom query. The ultimate fallback, if no
+    # pcdm:OriginalFile is associated with the :file_set, is to just use the
+    # first file in its :file_ids.
+    #
+    # @return [Hyrax::FileMetadata]
+    def original_file
+      if file_set.original_file_id
+        # Always just use original_file_id if it is defined.
+        #
+        # NOTE: This needs to use :find_file_metadata_by, not :find_by, because
+        # at time of writing the latter does not work in Wings.
+        query_service.custom_queries.find_file_metadata_by(id: file_set.original_file_id)
+      else
+        # Cache the fallback to avoid needing to do this query twice.
+        #
+        # See NOTE above regarding use of :find_file_metadata_by.
+        @original_file ||= begin
+                             query_service.custom_queries.find_original_file(file_set: file_set)
+                           rescue Valkyrie::Persistence::ObjectNotFoundError
+                             fallback_id = file_set.file_ids.first
+                             query_service.custom_queries.find_file_metadata_by(id: fallback_id) if fallback_id
+                           end
+      end
+    end
+  end
+end

data/app/services/hyrax/lease_manager.rb

@@ -89,6 +89,15 @@ module Hyrax
       resource.lease || Lease.new
     end
 
+    ##
+    # Drop the lease by setting its release date to `nil`.
+    #
+    # @return [void]
+    def nullify
+      return unless under_lease?
+      lease.lease_expiration_date = nil
+    end
+
     ##
     # @return [Boolean]
     def release

data/app/services/hyrax/lease_service.rb

@@ -22,6 +22,10 @@ module Hyrax
         presenters(builder)
       end
 
+      def search_state_class
+        nil
+      end
+
       private
 
       def presenter_class

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

@@ -5,6 +5,17 @@ module Hyrax
     ##
     # Listens for events related to {Hyrax::FileMetadata}
     class FileMetadataListener
+      ##
+      # Called when 'file.characterized' event is published;
+      # allows post-characterization handling, like derivatives generation.
+      #
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_file_characterized(event)
+        CreateDerivativesJob
+          .perform_later(event[:file_set], event[:file_id], event[:path_hint])
+      end
+
       ##
       # Called when 'file.metadata.updated' event is published; reindexes a
       # {Hyrax::FileSet} when a file claiming to be its `pcdm_use:OriginalFile`

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

@@ -25,13 +25,13 @@ module Hyrax
       # @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
+        return Hyrax.logger.warn("Skipping workflow initialization for #{event[:object]}; no user is given\n\t#{event}") if
           event[:user].blank?
 
         factory.create(event[:object], {}, event[:user])
       rescue Sipity::StateError, Sipity::ConversionError => err
         # don't error on known sipity error types; log instead
-        Rails.logger.error(err)
+        Hyrax.logger.error(err)
       end
     end
   end

data/app/services/hyrax/local_file_service.rb

@@ -5,7 +5,9 @@ module Hyrax
     # @param [Hash] _options
     # @yield [File] opens the file and yields it to the block
     def self.call(file_name, _options)
-      yield File.open(file_name)
+      File.open(file_name) do |file|
+        yield(file)
+      end
     end
   end
 end

data/app/services/hyrax/solr_service.rb

@@ -75,7 +75,7 @@ module Hyrax
     # Wraps get by default
     # @return [Array<SolrHit>] the response docs wrapped in SolrHit objects
     def query(query, **args)
-      Rails.logger.warn rows_warning unless args.key?(:rows)
+      Hyrax.logger.warn rows_warning unless args.key?(:rows)
       method = args.delete(:method) || :get
 
       result = case method

data/app/services/hyrax/statistics/depositors/summary.rb

@@ -33,7 +33,7 @@ module Hyrax
 
         private
 
-        delegate :blacklight_config, to: CatalogController
+        delegate :blacklight_config, :search_state_class, to: CatalogController
         delegate :depositor_field, to: DepositSearchBuilder
 
         # results come from Solr in an array where the first item is the user and

data/app/services/hyrax/statistics/term_query.rb

@@ -28,7 +28,7 @@ module Hyrax
                                       'json.nl': 'map',
                                       omitHeader: 'true')
         unless json
-          Rails.logger.error "Unable to reach TermsComponent via Solr connection. Is it enabled in your solr config?"
+          Hyrax.logger.error "Unable to reach TermsComponent via Solr connection. Is it enabled in your solr config?"
           return []
         end
 

data/app/services/hyrax/thumbnail_path_service.rb

@@ -31,7 +31,7 @@ module Hyrax
         return object if object.thumbnail_id == object.id
         Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: object.thumbnail_id)
       rescue Valkyrie::Persistence::ObjectNotFoundError, Hyrax::ObjectNotFoundError
-        Rails.logger.error("Couldn't find thumbnail #{object.thumbnail_id} for #{object.id}")
+        Hyrax.logger.error("Couldn't find thumbnail #{object.thumbnail_id} for #{object.id}")
         nil
       end
 

data/app/services/hyrax/user_stat_importer.rb

@@ -9,7 +9,7 @@ module Hyrax
       if options[:verbose]
         stdout_logger = Logger.new(STDOUT)
         stdout_logger.level = Logger::INFO
-        Rails.logger.extend(ActiveSupport::Logger.broadcast(stdout_logger))
+        Hyrax.logger.extend(ActiveSupport::Logger.broadcast(stdout_logger))
       end
       @logging = options[:logging]
       @delay_secs = options[:delay_secs].to_f
@@ -84,6 +84,8 @@ module Hyrax
     rescue StandardError => exception
       log_message fail_message
       log_message "Last exception #{exception}"
+      # Without returning false, we return the results of log_message; which is true.
+      false
     end
 
     def date_since_last_cache(user)
@@ -145,7 +147,7 @@ module Hyrax
     end
 
     def log_message(message)
-      Rails.logger.info "#{self.class}: #{message}" if @logging
+      Hyrax.logger.info "#{self.class}: #{message}" if @logging
     end
 
     def retry_options

data/app/services/hyrax/valkyrie_persist_derivatives.rb

@@ -27,7 +27,7 @@ module Hyrax
       tmpfile = Tempfile.new(fileset_id, encoding: 'ascii-8bit')
       tmpfile.write stream.read
 
-      Rails.logger.debug "Uploading thumbnail for FileSet #{fileset_id} as #{filepath}"
+      Hyrax.logger.debug "Uploading thumbnail for FileSet #{fileset_id} as #{filepath}"
       Hyrax.config.derivatives_storage_adapter.upload(
         file: tmpfile,
         original_filename: filepath,

data/app/services/hyrax/valkyrie_upload.rb

@@ -87,7 +87,7 @@ module Hyrax::ValkyrieUpload
       when Hyrax::FileMetadata::Use::EXTRACTED_TEXT
         file_set.extracted_text_id = file_metadata.id
       else
-        Rails.logger.warn "Unknown file use #{file_metadata.type} specified for #{file_metadata.file_identifier}"
+        Hyrax.logger.warn "Unknown file use #{file_metadata.type} specified for #{file_metadata.file_identifier}"
       end
     end
   end

data/app/services/hyrax/versioning_service.rb

@@ -1,7 +1,80 @@
 # frozen_string_literal: true
 
 module Hyrax
+  ##
+  # Provides methods for dealing with versions of files across both ActiveFedora
+  # and Valkyrie.
+  #
+  # Note that many of the methods pertaining to version creation are currently
+  # implemented as static methods.
   class VersioningService
+    ##
+    # @!attribute [rw] resource
+    #   @return [ActiveFedora::File | Hyrax::FileMetadata | NilClass]
+    attr_accessor :resource
+
+    ##
+    # @!attribute [r] storage_adapter
+    #   @return [#supports?]
+    attr_reader :storage_adapter
+
+    ##
+    # @param resource [ActiveFedora::File | Hyrax::FileMetadata | NilClass]
+    def initialize(resource:, storage_adapter: Hyrax.storage_adapter)
+      @storage_adapter = storage_adapter
+      self.resource = resource
+    end
+
+    ##
+    # Returns an array of versions for the resource associated with this
+    # Hyrax::VersioningService.
+    #
+    # If the resource is nil, or if it is a Hyrax::FileMetadata and versioning
+    # is not supported in the storage adapter, an empty array will be returned.
+    def versions
+      if resource.nil?
+        []
+      elsif resource.is_a?(Hyrax::FileMetadata)
+        if storage_adapter.try(:"supports?", :versions)
+          storage_adapter.find_versions(id: resource.file_identifier).to_a
+        else
+          []
+        end
+      else
+        resource.versions.all.to_a
+      end
+    end
+
+    ##
+    # Returns the latest version of the file associated with this
+    # Hyrax::VersioningService.
+    def latest_version
+      versions.last
+    end
+
+    ##
+    # Returns the file ID of the latest version of the file associated with this
+    # Hyrax::VersioningService, or the ID of the file resource itself if no
+    # latest version is defined.
+    #
+    # If the resource is nil, this method returns an empty string.
+    def versioned_file_id
+      latest = latest_version
+      if latest
+        if latest.respond_to?(:id)
+          latest.id
+        else
+          Hyrax.config.translate_uri_to_id.call(latest.uri)
+        end
+      elsif resource.nil?
+        ""
+      elsif resource.is_a?(Hyrax::FileMetadata)
+        resource.file_identifier
+      else
+        resource.id
+      end
+    end
+
     class << self
       # Make a version and record the version committer
       # @param [ActiveFedora::File | Hyrax::FileMetadata] content
@@ -11,19 +84,14 @@ module Hyrax
         perform_create(content, user, use_valkyrie)
       end
 
-      # @param [ActiveFedora::File | Hyrax::FileMetadata] content
+      # @param [ActiveFedora::File | Hyrax::FileMetadata] file
       def latest_version_of(file)
-        file.versions.last
+        Hyrax::VersioningService.new(resource: file).latest_version
       end
 
-      # @param [ActiveFedora::File | Hyrax::FileMetadata] content
+      # @param [ActiveFedora::File | Hyrax::FileMetadata] file
       def versioned_file_id(file)
-        versions = file.versions.all
-        if versions.present?
-          Hyrax.config.translate_uri_to_id.call(versions.last.uri)
-        else
-          file.id
-        end
+        Hyrax::VersioningService.new(resource: file).versioned_file_id
       end
 
       # Record the version committer of the last version
@@ -42,7 +110,7 @@ module Hyrax
       def perform_create(content, user, use_valkyrie)
         use_valkyrie ? perform_create_through_valkyrie(content, user) : perform_create_through_active_fedora(content, user)
       rescue NotImplementedError
-        Rails.logger.warn "Declining to create a Version for #{content}; #{self} doesn't support versioning with use_valkyrie: #{use_valkyrie}"
+        Hyrax.logger.warn "Declining to create a Version for #{content}; #{self} doesn't support versioning with use_valkyrie: #{use_valkyrie}"
       end
 
       def perform_create_through_active_fedora(content, user)

data/app/services/hyrax/visibility_map.rb

@@ -51,15 +51,23 @@ module Hyrax
     end
 
     def additions_for(visibility:)
-      self[visibility][:additions]
+      fetch(visibility)&.fetch(:additions)
     end
 
     def deletions_for(visibility:)
-      self[visibility][:deletions]
+      fetch(visibility)&.fetch(:deletions)
+    end
+
+    def fetch(key, &block)
+      @map.fetch(key, &block)
+    rescue KeyError => e
+      raise(UnknownVisibility, e.message)
     end
 
     def visibilities
       @map.keys
     end
+
+    class UnknownVisibility < KeyError; end
   end
 end