hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/services/hyrax/file_set_fixity_check_service.rb

@@ -1,3 +1,4 @@
+# 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.
@@ -62,61 +63,54 @@ module Hyrax
       results.flatten.group_by(&:file_id)
     end
 
-    # Return current fixity status for this FileSet based on
-    # ChecksumAuditLog records on file.
-    def logged_fixity_status
-      Deprecation.warn(self, "logged_fixity_status is deprecated, use FixityStatusPresenter instead")
-      FixityStatusPresenter.new(file_set.id).render_file_set_status
-    end
-
     private
 
-      # 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]
+    # 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]
 
-        versions = [versions.max_by(&:created)] if file.has_versions? && latest_version_only
+      versions = [versions.max_by(&:created)] if file.has_versions? && latest_version_only
 
-        versions.collect { |v| fixity_check_file_version(file.id, v.uri.to_s) }.flatten
-      end
+      versions.collect { |v| fixity_check_file_version(file.id, v.uri.to_s) }.flatten
+    end
 
-      # Retrieve or generate the fixity check for a specific version of a file
-      # @param [String] file_id used to find the file within its parent object (usually "original_file")
-      # @param [String] version_uri the version to be fixity checked (or the file uri for non-versioned files)
-      def fixity_check_file_version(file_id, version_uri)
-        latest_fixity_check = ChecksumAuditLog.logs_for(file_set.id, checked_uri: version_uri).first
-        return latest_fixity_check unless needs_fixity_check?(latest_fixity_check)
+    # Retrieve or generate the fixity check for a specific version of a file
+    # @param [String] file_id used to find the file within its parent object (usually "original_file")
+    # @param [String] version_uri the version to be fixity checked (or the file uri for non-versioned files)
+    def fixity_check_file_version(file_id, version_uri)
+      latest_fixity_check = ChecksumAuditLog.logs_for(file_set.id, checked_uri: version_uri).first
+      return latest_fixity_check unless needs_fixity_check?(latest_fixity_check)
 
-        if async_jobs
-          FixityCheckJob.perform_later(version_uri.to_s, file_set_id: file_set.id, file_id: file_id)
-        else
-          FixityCheckJob.perform_now(version_uri.to_s, file_set_id: file_set.id, file_id: file_id)
-        end
+      if async_jobs
+        FixityCheckJob.perform_later(version_uri.to_s, file_set_id: file_set.id, file_id: file_id)
+      else
+        FixityCheckJob.perform_now(version_uri.to_s, file_set_id: file_set.id, file_id: file_id)
       end
+    end
 
-      # Check if time since the last fixity check is greater than the maximum days allowed between fixity checks
-      # @param [ChecksumAuditLog] latest_fixity_check the most recent fixity check
-      def needs_fixity_check?(latest_fixity_check)
-        return true unless latest_fixity_check
-        unless latest_fixity_check.updated_at
-          logger.warn "***FIXITY*** problem with fixity check log! Latest Fixity check is not nil, but updated_at is not set #{latest_fixity_check}"
-          return true
-        end
-        days_since_last_fixity_check(latest_fixity_check) >= max_days_between_fixity_checks
+    # Check if time since the last fixity check is greater than the maximum days allowed between fixity checks
+    # @param [ChecksumAuditLog] latest_fixity_check the most recent fixity check
+    def needs_fixity_check?(latest_fixity_check)
+      return true unless latest_fixity_check
+      unless latest_fixity_check.updated_at
+        logger.warn "***FIXITY*** problem with fixity check log! Latest Fixity check is not nil, but updated_at is not set #{latest_fixity_check}"
+        return true
       end
+      days_since_last_fixity_check(latest_fixity_check) >= max_days_between_fixity_checks
+    end
 
-      # Return the number of days since the latest fixity check
-      # @param [ChecksumAuditLog] latest_fixity_check the most recent fixity check
-      def days_since_last_fixity_check(latest_fixity_check)
-        (DateTime.current - latest_fixity_check.updated_at.to_date).to_i
-      end
+    # Return the number of days since the latest fixity check
+    # @param [ChecksumAuditLog] latest_fixity_check the most recent fixity check
+    def days_since_last_fixity_check(latest_fixity_check)
+      (DateTime.current - latest_fixity_check.updated_at.to_date).to_i
+    end
 
-      # Loads the FileSet from Fedora if needed
-      def file_set
-        @file_set ||= ::FileSet.find(id)
-      end
+    # Loads the FileSet from Fedora if needed
+    def file_set
+      @file_set ||= ::FileSet.find(id)
+    end
   end
 end

data/app/services/hyrax/file_set_visibility_propagator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Propagates visibility from a given Work to its FileSets
+  class FileSetVisibilityPropagator
+    ##
+    # @!attribute [rw] source
+    #   @return [#visibility]
+    attr_accessor :source
+
+    ##
+    # @param source [#visibility] the object to propagate visibility from
+    def initialize(source:)
+      self.source = source
+    end
+
+    ##
+    # @return [void]
+    #
+    # @raise [RuntimeError] if visibility propagation fails
+    def propagate
+      source.file_sets.each do |file|
+        file.visibility = source.visibility # visibility must come first, because it can clear an embargo/lease
+        copy_visibility_modifier(source: source, file: file, modifier: :lease)
+        copy_visibility_modifier(source: source, file: file, modifier: :embargo)
+        file.save!
+      end
+    end
+
+    private
+
+    def copy_visibility_modifier(source:, file:, modifier:)
+      source_modifier = source.public_send(modifier)
+      return unless source_modifier
+      file.public_send("build_#{modifier}") unless file.public_send(modifier)
+      file.public_send(modifier).attributes = source_modifier.attributes.except('id')
+      file.public_send(modifier).save
+    end
+  end
+end

data/app/services/hyrax/fixity/active_fedora_fixity_service.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Hyrax
+  module Fixity
+    ##
+    # Wraps `ActiveFedora::FixityService` to avoid leaking Fedora-specific errors.
+    #
+    # @see ActiveFedora::FixityService
+    class ActiveFedoraFixityService < ActiveFedora::FixityService
+      ##
+      # @raise MissingContentError
+      # @see ActiveFedora::FixityService#response
+      def response
+        super
+      rescue Ldp::NotFound
+        raise MissingContentError,
+              "Tried to check fixity of #{@target}, but it was not found."
+      end
+    end
+  end
+end

data/app/services/hyrax/fixity/missing_content_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Hyrax
+  module Fixity
+    ##
+    # @note this inherits `Ldp::NotFonud` for backwards compatibility.
+    #   This should be a `RuntimeError` or `ArgumentError` in Hyrax 4.0.
+    class MissingContentError < Ldp::NotFound; end
+  end
+end

data/app/services/hyrax/fixity_check_failure_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class FixityCheckFailureService < AbstractMessageService
     attr_reader :log_date, :checksum_audit_log, :file_set
@@ -15,11 +16,11 @@ module Hyrax
     def message
       uri = file_set.original_file.uri.to_s
       file_title = file_set.title.first
-      "The fixity check run at #{log_date} for #{file_title} (#{uri}) failed."
+      I18n.t('hyrax.notifications.fixity_check_failure.message', log_date: log_date, file_title: file_title, uri: uri)
     end
 
     def subject
-      'Failing Fixity Check'
+      I18n.t('hyrax.notifications.fixity_check_failure.subject')
     end
   end
 end

data/app/services/hyrax/form_factory.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A factory class for Hyrax forms.
+  #
+  # @note We use a factory class (rather than a factory method like `.for`) to
+  #   provide compatibility with the legacy `Hyrax::WorkFormService`.
+  #
+  # @example
+  #   factory = Hyrax::FormFactory.new
+  #
+  #   form_change_set = factory.build(work)
+  #
+  # @since 3.0.0
+  class FormFactory
+    ##
+    # Builds and prepopulates a form for the given model.
+    #
+    # @param model      [Object]
+    # @param ability    [Hyrax::Ability]
+    # @param controller [ApplicationController]
+    #
+    # @see https://trailblazer.to/2.0/gems/reform/prepopulator.html
+    def build(model, _ability, _controller)
+      Hyrax::Forms::ResourceForm.for(model).prepopulate!
+    end
+  end
+end

data/app/services/hyrax/form_metadata_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Answers queries about the cardinality of each field on the form.
   class FormMetadataService < HydraEditor::FieldMetadataService

data/app/services/hyrax/graph_exporter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Retrieves the graph for an object with the internal triples removed
   # and the uris translated to external uris.
@@ -20,74 +21,74 @@ module Hyrax
       end
     rescue Ldp::NotFound
       # this error is handled with a 404 page.
-      raise ActiveFedora::ObjectNotFoundError
+      raise Hyrax::ObjectNotFoundError
     end
 
     private
 
-      def clean_graph_repository
-        Hydra::ContentNegotiation::CleanGraphRepository.new(connection, replacer)
-      end
+    def clean_graph_repository
+      Hydra::ContentNegotiation::CleanGraphRepository.new(connection, replacer)
+    end
 
-      def connection
-        @connection ||= CleanConnection.new(ActiveFedora.fedora.connection)
-      end
+    def connection
+      @connection ||= CleanConnection.new(ActiveFedora.fedora.connection)
+    end
 
-      # This method is called once for each statement in the graph.
-      def replacer
-        lambda do |resource_id, graph|
-          url = ActiveFedora::Base.id_to_uri(resource_id)
-          klass = graph.query([:s, ActiveFedora::RDF::Fcrepo::Model.hasModel, :o]).first.object.to_s.constantize
+    # This method is called once for each statement in the graph.
+    def replacer
+      lambda do |resource_id, graph|
+        url = Hyrax::Base.id_to_uri(resource_id)
+        klass = graph.query([:s, ActiveFedora::RDF::Fcrepo::Model.hasModel, :o]).first.object.to_s.constantize
 
-          # if the subject URL matches
-          if graph.query([RDF::URI(url), ActiveFedora::RDF::Fcrepo::Model.hasModel, nil]).first
-            subject_replacer(klass, resource_id)
-          elsif resource_id.start_with? solr_document.id
-            subresource_replacer(resource_id, klass)
-          else
-            object_replacer(resource_id, graph)
-          end
+        # if the subject URL matches
+        if graph.query([RDF::URI(url), ActiveFedora::RDF::Fcrepo::Model.hasModel, nil]).first
+          subject_replacer(klass, resource_id)
+        elsif resource_id.start_with? solr_document.id
+          subresource_replacer(resource_id, klass)
+        else
+          object_replacer(resource_id, graph)
         end
       end
+    end
 
-      def subresource_replacer(resource_id, parent_klass)
-        return subject_replacer(parent_klass, resource_id) unless resource_id.include?('/')
-
-        parent_id, local = resource_id.split('/', 2)
+    def subresource_replacer(resource_id, parent_klass)
+      return subject_replacer(parent_klass, resource_id) unless resource_id.include?('/')
 
-        if @visited_subresources.add?(resource_id)
-          additional_resources << ListSourceExporter.new(
-            resource_id,
-            request,
-            subject_replacer(parent_klass, parent_id)
-          ).fetch
-        end
+      parent_id, local = resource_id.split('/', 2)
 
-        parent = subject_replacer(parent_klass, parent_id)
-        "#{parent}/#{local}"
+      if @visited_subresources.add?(resource_id)
+        additional_resources << ListSourceExporter.new(
+          resource_id,
+          request,
+          subject_replacer(parent_klass, parent_id)
+        ).fetch
       end
 
-      def subject_replacer(klass, resource_id, anchor = nil)
-        route_key = if Hyrax.config.curation_concerns.include?(klass)
-                      klass.model_name.singular_route_key
-                    else
-                      SolrDocument.model_name.singular_route_key
-                    end
-        routes = Rails.application.routes.url_helpers
-        builder = ActionDispatch::Routing::PolymorphicRoutes::HelperMethodBuilder
-        resource_id = RDF::URI(resource_id)
-        new_uri = RDF::URI(builder.polymorphic_method(routes, route_key, nil, :url, id: resource_id.path, host: hostname, anchor: anchor))
-        new_uri.fragment = resource_id.fragment
-        new_uri
-      end
+      parent = subject_replacer(parent_klass, parent_id)
+      "#{parent}/#{local}"
+    end
 
-      def object_replacer(id, _graph)
-        id, anchor = id.split('/', 2)
-        Rails.application.routes.url_helpers.solr_document_url(id, host: hostname, anchor: anchor)
-      end
+    def subject_replacer(klass, resource_id, anchor = nil)
+      route_key = if Hyrax.config.curation_concerns.include?(klass)
+                    klass.model_name.singular_route_key
+                  else
+                    ::SolrDocument.model_name.singular_route_key
+                  end
+      routes = Rails.application.routes.url_helpers
+      builder = ActionDispatch::Routing::PolymorphicRoutes::HelperMethodBuilder
+      resource_id = RDF::URI(resource_id)
+      new_uri = RDF::URI(builder.polymorphic_method(routes, route_key, nil, :url, id: resource_id.path, host: hostname, anchor: anchor))
+      new_uri.fragment = resource_id.fragment
+      new_uri
+    end
 
-      def hostname
-        request.host
-      end
+    def object_replacer(id, _graph)
+      id, anchor = id.split('/', 2)
+      Rails.application.routes.url_helpers.solr_document_url(id, host: hostname, anchor: anchor)
+    end
+
+    def hostname
+      request.host
+    end
   end
 end

data/app/services/hyrax/identifier/builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+module Hyrax
+  module Identifier
+    ##
+    # Builds an identifier string.
+    #
+    # Implementations must accept a `prefix:` to `#initialize`, and a `hint:` to
+    # `#build`. Either or both may be used at the preference of the specific
+    # implementer or ignored entirely when `#build` is called.
+    #
+    # @example
+    #   builder = Hyrax::Identifier::Builder.new(prefix: 'moomin')
+    #   builder.build(hint: '1') # => "moomin/1"
+    class Builder
+      ##
+      # @!attribute prefix [rw]
+      #   @return [String] the prefix to use when building identifiers
+      attr_accessor :prefix
+
+      ##
+      # @param prefix [String] the prefix to use when building identifiers
+      def initialize(prefix: 'pfx')
+        @prefix = prefix
+      end
+
+      ##
+      # @note this default builder requires a `hint` which it appends to the
+      #   prefix to generate the identifier string.
+      #
+      # @param hint [#to_s] a string-able object which may be used by the builder
+      #   to generate an identifier. Hints may be required by some builders, while
+      #   others may ignore them to generate an identifier by other means.
+      #
+      # @return [String]
+      # @raise [ArgumentError] if an identifer can't be built from the provided
+      #   hint.
+      def build(hint: nil)
+        raise(ArgumentError, "No hint provided to #{self.class}#build") if
+          hint.nil?
+
+        "#{prefix}/#{hint}"
+      end
+    end
+  end
+end

data/app/services/hyrax/identifier/dispatcher.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module Hyrax
+  module Identifier
+    class Dispatcher
+      ##
+      # @!attribute [rw] registrar
+      #   @return [Hyrax::Identifier::Registrar]
+      attr_accessor :registrar
+
+      ##
+      # @param registrar [Hyrax::Identifier::Registrar]
+      def initialize(registrar:)
+        @registrar = registrar
+      end
+
+      class << self
+        ##
+        # @param type           [Symbol]
+        # @param registrar_opts [Hash]
+        # @option registrar_opts [Hyrax::Identifier::Builder] :builder
+        #
+        # @return [Hyrax::Identifier::Dispatcher] a dispatcher with an registrar for the
+        #   given type
+        # @see IdentifierRegistrar.for
+        def for(type, **registrar_opts)
+          new(registrar: Hyrax::Identifier::Registrar.for(type, **registrar_opts))
+        end
+      end
+
+      ##
+      # Assigns an identifier to the object.
+      #
+      # This involves two steps:
+      #   - Registering the identifier with the registrar service via `registrar`.
+      #   - Storing the new identifier on the object, in the provided `attribute`.
+      #
+      # @note the attribute for identifier storage must be multi-valued, and will
+      #  be overwritten during assignment.
+      #
+      # @param attribute [Symbol] the attribute in which to store the identifier.
+      #   This attribute will be overwritten during assignment.
+      # @param object    [ActiveFedora::Base, Hyrax::Resource] the object to assign an identifier.
+      #
+      # @return [ActiveFedora::Base, Hyrax::Resource] object
+      def assign_for(object:, attribute: :identifier)
+        record = registrar.register!(object: object)
+        object.public_send("#{attribute}=".to_sym, [record.identifier])
+        object
+      end
+
+      ##
+      # Assigns an identifier and saves the object.
+      #
+      # @see #assign_for
+      def assign_for!(object:, attribute: :identifier)
+        assign_for(object: object, attribute: attribute).save!
+        object
+      end
+    end
+  end
+end