hyrax 4.0.0.beta1 → 4.0.0.rc1

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/restriction_service.rb

@@ -18,7 +18,7 @@ module Hyrax
       end
 
       def repository
-        config.repository
+        config.blacklight_config.repository
       end
 
       def config

data/app/services/hyrax/solr_query_service.rb

@@ -26,21 +26,29 @@ module Hyrax
     end
 
     ##
+    # execute the query using a GET request
     # @return [Hash] the results returned from solr for the current query
     def get
       solr_service.get(build)
     end
 
+    ##
+    # execute the solr query and return results
+    # @return [Hash] the results returned from solr for the current query
+    def query_result
+      solr_service.query_result(build)
+    end
+
     ##
     # @return [Enumerable<SolrDocument>]
     def solr_documents
-      get['response']['docs'].map { |doc| self.class.document_model.new(doc) }
+      query_result['response']['docs'].map { |doc| self.class.document_model.new(doc) }
     end
 
     ##
     # @return [Array<String>] ids of documents matching the current query
     def get_ids # rubocop:disable Naming/AccessorMethodName
-      results = get
+      results = query_result
       results['response']['docs'].map { |doc| doc['id'] }
     end
 

data/app/services/hyrax/solr_service.rb

@@ -38,7 +38,7 @@ module Hyrax
       end
 
       delegate :add, :commit, :count, :delete, :get, :instance, :ping, :post,
-               :query, :delete_by_query, :search_by_id, :wipe!, to: :new
+               :query, :query_result, :delete_by_query, :search_by_id, :wipe!, to: :new
     end
 
     # Wraps rsolr get
@@ -72,21 +72,27 @@ module Hyrax
       connection.post(solr_path, data: args)
     end
 
-    # Wraps get by default
+    # Query solr using the provided or default http method, returning the result as a hash.
+    # @return [Hash] raw query result from solr
+    def query_result(query, **args)
+      Hyrax.logger.warn rows_warning unless args.key?(:rows)
+      # Use the provided solr query method, or fall back to the configured default
+      method = args.delete(:method) || Hyrax.config.solr_default_method
+
+      case method
+      when :get
+        get(query, **args)
+      when :post
+        post(query, **args)
+      else
+        raise "Unsupported HTTP method for querying SolrService (#{method.inspect})"
+      end
+    end
+
+    # Execute the provided query. Uses the configured http method 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)
-      method = args.delete(:method) || :get
-
-      result = case method
-               when :get
-                 get(query, **args)
-               when :post
-                 post(query, **args)
-               else
-                 raise "Unsupported HTTP method for querying SolrService (#{method.inspect})"
-               end
-      result['response']['docs'].map do |doc|
+      query_result(query, **args)['response']['docs'].map do |doc|
         ::SolrHit.new(doc)
       end
     end
@@ -114,10 +120,10 @@ module Hyrax
     end
 
     # Wraps rsolr count
-    # @return [Hash] the hash straight form rsolr
+    # @return [Hash] the hash straight from rsolr
     def count(query)
       args = { rows: 0 }
-      get(query, **args)['response']['numFound'].to_i
+      query_result(query, **args)['response']['numFound'].to_i
     end
 
     # Wraps ActiveFedora::Base#search_by_id(id, opts)

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

@@ -28,10 +28,11 @@ module Hyrax
       end
 
       def fetch_thumbnail(object)
-        return object if object.thumbnail_id == object.id
+        return object if object.thumbnail_id == object.id ||
+                         object.try(:file_ids)&.detect { |fid| fid == object.thumbnail_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
 
@@ -53,13 +54,20 @@ module Hyrax
       # @return true if there a file on disk for this object, otherwise false
       # @param [FileSet] thumb - the object that is the thumbnail
       def thumbnail?(thumb)
-        File.exist?(thumbnail_filepath(thumb))
+        File.exist?(thumbnail_filepath(thumb)) ||
+          (thumb.is_a?(Hyrax::Resource) && file_in_storage?(thumb))
       end
 
       # @param [FileSet] thumb - the object that is the thumbnail
       def thumbnail_filepath(thumb)
         Hyrax::DerivativePath.derivative_path_for_reference(thumb, 'thumbnail')
       end
+
+      def file_in_storage?(thumb)
+        Hyrax.custom_queries.find_thumbnail(file_set: thumb)
+      rescue Valkyrie::StorageAdapter::FileNotFound, Valkyrie::Persistence::ObjectNotFoundError
+        false
+      end
     end
   end
 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

@@ -16,22 +16,25 @@ module Hyrax
     # @param [#read] stream the derivative filestream
     # @param [Hash] directives
     # @option directives [String] :url a url to the file destination
-    def self.call(stream, directives)
-      filepath = URI(directives.fetch(:url)).path
-      fileset_id = fileset_id_from_path(filepath)
-      fileset = Hyrax.metadata_adapter.query_service.find_by(id: fileset_id)
+    def self.call(stream,
+                  directives,
+                  uploader: Hyrax::ValkyrieUpload.new(storage_adapter: Hyrax.config.derivatives_storage_adapter))
+      file_set = fileset_for_directives(directives)
 
       # Valkyrie storage adapters will typically expect an IO-like object that
       # responds to #path -- here we only have a StringIO, so some
       # transformation is in order
-      tmpfile = Tempfile.new(fileset_id, encoding: 'ascii-8bit')
+      tmpfile = Tempfile.new(file_set.id, encoding: 'ascii-8bit')
       tmpfile.write stream.read
 
-      Rails.logger.debug "Uploading thumbnail for FileSet #{fileset_id} as #{filepath}"
-      Hyrax.config.derivatives_storage_adapter.upload(
-        file: tmpfile,
-        original_filename: filepath,
-        resource: fileset
+      filename = filename(directives)
+      Hyrax.logger.debug "Uploading thumbnail for FileSet #{file_set.id} as #{filename}"
+
+      uploader.upload(
+        io: tmpfile,
+        filename: filename,
+        file_set: file_set,
+        use: Hyrax::FileMetadata::Use::THUMBNAIL
       )
     end
 
@@ -40,11 +43,19 @@ module Hyrax
     # we want to extract the FileSet id, which in this case would be 9593tv123
     #
     # @param [String] path
-    # @return [String]
-    def self.fileset_id_from_path(path)
-      path.sub(Hyrax.config.derivatives_path.to_s, "")
-          .sub(/-[^\/]+\..*$/, "")
-          .delete("/")
+    # @return [Hyrax::FileSet]
+    def self.fileset_for_directives(directives)
+      path = URI(directives.fetch(:url)).path
+      id = path.sub(Hyrax.config.derivatives_path.to_s, "")
+               .delete('/')
+               .match(/^(.*)-\w*(\.\w+)*$/) { |m| m[1] }
+      raise "Could not extract fileset id from path #{path}" unless id
+
+      Hyrax.metadata_adapter.query_service.find_by(id: id)
+    end
+
+    def self.filename(directives)
+      URI(directives.fetch(:url)).path.split('/').last
     end
   end
 end

data/app/services/hyrax/valkyrie_upload.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-module Hyrax::ValkyrieUpload
+class Hyrax::ValkyrieUpload
   # @param [IO] io
   # @param [String] filename
   # @param [Hyrax::FileSet] file_set
+  # @param [Valkyrie::StorageAdapter] storage_adapter
   # @param [RDF::URI] use
   # @param [User] user
   #
@@ -19,31 +20,33 @@ module Hyrax::ValkyrieUpload
     use: Hyrax::FileMetadata::Use::ORIGINAL_FILE,
     user: nil
   )
+    new(storage_adapter: storage_adapter)
+      .upload(filename: filename, file_set: file_set, io: io, use: use, user: user)
+  end
 
-    streamfile = storage_adapter.upload(
-      file: io,
-      original_filename: filename,
-      resource: file_set,
-      use: use
-    )
-    io.close
+  ##
+  # @!attribute [r] storage_adapter
+  #   @return [Valkyrie::StorageAdapter] storage_adapter
+  attr_reader :storage_adapter
+  ##
+  # @param [Valkyrie::StorageAdapter] storage_adapter
+  def initialize(storage_adapter: Hyrax.storage_adapter)
+    @storage_adapter = storage_adapter
+  end
 
-    file_metadata = find_or_create_metadata(id: streamfile.id, file: streamfile)
+  def upload(filename:, file_set:, io:, use: Hyrax::FileMetadata::Use::ORIGINAL_FILE, user: nil)
+    streamfile = storage_adapter.upload(file: io, original_filename: filename, resource: file_set)
+    file_metadata = Hyrax::FileMetadata(streamfile)
     file_metadata.file_set_id = file_set.id
+    file_metadata.type += [use]
 
-    case use
-    when Hyrax::FileMetadata::Use::ORIGINAL_FILE
+    if use == Hyrax::FileMetadata::Use::ORIGINAL_FILE
       # Set file set label.
       reset_title = file_set.title.first == file_set.label
       # set title to label if that's how it was before this characterization
       file_set.title = file_metadata.original_filename if reset_title
       # always set the label to the original_name
       file_set.label = file_metadata.original_filename
-    when Hyrax::FileMetadata::Use::THUMBNAIL
-      # TODO: the parent work's thumbnail_id remains incorrect (it's set to the
-      # FileSet ID, rather than the ID of this thumbnail FileMetadata; but
-      # trying to update the parent attributes here doesn't seem to stick
-      file_set.thumbnail_id = file_metadata.id
     end
 
     saved_metadata = Hyrax.persister.save(resource: file_metadata)
@@ -64,7 +67,7 @@ module Hyrax::ValkyrieUpload
   # @param [::User] user  the user performing the add
   #
   # @return [Hyrax::FileSet] updated file set
-  def self.add_file_to_file_set(file_set:, file_metadata:, user:)
+  def add_file_to_file_set(file_set:, file_metadata:, user:)
     file_set.file_ids << file_metadata.id
     set_file_use_ids(file_set, file_metadata)
 
@@ -72,12 +75,14 @@ module Hyrax::ValkyrieUpload
     Hyrax.publisher.publish('object.membership.updated', object: file_set, user: user)
   end
 
+  private
+
   # @api private
   # @param [Hyrax::FileSet] file_set the file set to add to
   # @param [Hyrax::FileMetadata] file_metadata the metadata object representing
   #   the file to add
   # @return [void]
-  def self.set_file_use_ids(file_set, file_metadata)
+  def set_file_use_ids(file_set, file_metadata)
     file_metadata.type.each do |type|
       case type
       when Hyrax::FileMetadata::Use::ORIGINAL_FILE
@@ -87,20 +92,8 @@ 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
-
-  # @api private
-  # @param [#to_s] id
-  # @param [Valkyrie::StorageAdapter::StreamFile] file
-  def self.find_or_create_metadata(id:, file:)
-    Hyrax.custom_queries.find_file_metadata_by(id: id)
-  rescue Valkyrie::Persistence::ObjectNotFoundError => e
-    Hyrax.logger.warn "Failed to find existing metadata for #{id}:"
-    Hyrax.logger.warn e.message
-    Hyrax.logger.warn "Creating Hyrax::FileMetadata now"
-    Hyrax::FileMetadata.for(file: file)
-  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

data/app/services/hyrax/visibility_propagator.rb

@@ -15,13 +15,13 @@ module Hyrax
       when Hyrax::Resource # Valkyrie
         ResourceVisibilityPropagator.new(source: source)
       else
-        NullVisibilityPropogator.new(source: source)
+        NullVisibilityPropagator.new(source: source)
       end
     end
 
     ##
-    # Provides a null/logging implementation of the visibility propogator.
-    class NullVisibilityPropogator
+    # Provides a null/logging implementation of the visibility propagator.
+    class NullVisibilityPropagator
       ##
       # @!attribute [rw] source
       #   @return [#visibility]
@@ -36,8 +36,8 @@ module Hyrax
       ##
       # @return [void]
       # @raise [RuntimeError] if we're in development mode
-      def propogate
-        message =  "Tried to propogate visibility to members of #{source} " \
+      def propagate
+        message =  "Tried to propagate visibility to members of #{source} " \
                    "but didn't know what kind of object it is. Model " \
                    "name #{source.try(:model_name)}. Called from #{caller[0]}."