hyrax 2.6.0 → 2.9.0

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # This presenter wraps objects in the interface required by `IIIFManifiest`.
+  # It will accept either a Work-like resource or a SolrDocument.
+  #
+  # @example with a work
+  #
+  #   monograph = Monograph.new
+  #   presenter = IiifManifestPresenter.new(monograph)
+  #   presenter.title # => []
+  #
+  #   monograph.title = ['Comet in Moominland']
+  #   presenter.title # => ['Comet in Moominland']
+  #
+  # @see https://www.rubydoc.info/gems/iiif_manifest
+  class IiifManifestPresenter < Draper::Decorator
+    delegate_all
+
+    ##
+    # @!attribute [w] ability
+    #   @return [Ability]
+    # @!attribute [w] hostname
+    #   @return [String]
+    attr_writer :ability, :hostname
+
+    class << self
+      ##
+      # @param [Hyrax::Resource, SolrDocument]
+      def for(model)
+        klass = model.file_set? ? DisplayImagePresenter : IiifManifestPresenter
+
+        klass.new(model)
+      end
+    end
+
+    ##
+    # @return [#can?]
+    def ability
+      @ability ||= NullAbility.new
+    end
+
+    ##
+    # @return [String]
+    def description
+      Array(super).first || ''
+    end
+
+    ##
+    # @return [Boolean]
+    def file_set?
+      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet')
+    end
+
+    ##
+    # @return [Array<DisplayImagePresenter>]
+    def file_set_presenters
+      member_presenters.select(&:file_set?)
+    end
+
+    ##
+    # IIIF metadata for inclusion in the manifest
+    #  Called by the `iiif_manifest` gem to add metadata
+    #
+    # @todo should this use the simple_form i18n keys?! maybe the manifest
+    #   needs its own?
+    #
+    # @return [Array<Hash{String => String}>] array of metadata hashes
+    def manifest_metadata
+      metadata_fields.map do |field_name|
+        {
+          'label' => I18n.t("simple_form.labels.defaults.#{field_name}"),
+          'value' => Array(self[field_name]).map { |value| scrub(value.to_s) }
+        }
+      end
+    end
+
+    ##
+    # @return [String] the URL where the manifest can be found
+    def manifest_url
+      return '' if id.blank?
+
+      Rails.application.routes.url_helpers.polymorphic_url([:manifest, model], host: hostname)
+    end
+
+    ##
+    # @return [Array<#to_s>]
+    def member_ids
+      Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
+    end
+
+    ##
+    # @note cache member presenters to avoid querying repeatedly; we expect this
+    #   presenter to live only as long as the request.
+    #
+    # @note skips presenters for objects the current `@ability` cannot read.
+    #   the default ability has all permissions.
+    #
+    # @return [Array<IiifManifestPresenter>]
+    def member_presenters
+      @member_presenters_cache ||= Factory.build_for(ids: member_ids, presenter_class: self.class).map do |presenter|
+        next unless ability.can?(:read, presenter.model)
+
+        presenter.hostname = hostname
+        presenter.ability  = ability
+        presenter
+      end.compact
+    end
+
+    ##
+    # @return [Array<Hash{String => String}>]
+    def sequence_rendering
+      Array(try(:rendering_ids)).map do |file_set_id|
+        rendering = file_set_presenters.find { |p| p.id == file_set_id }
+        next unless rendering
+
+        { '@id' => Hyrax::Engine.routes.url_helpers.download_url(rendering.id, host: hostname),
+          'format' => rendering.mime_type.present? ? rendering.mime_type : I18n.t("hyrax.manifest.unknown_mime_text"),
+          'label' => I18n.t("hyrax.manifest.download_text") + (rendering.label || '') }
+      end.flatten
+    end
+
+    ##
+    # @return [Boolean]
+    def work?
+      object.try(:work?) || !file_set?
+    end
+
+    ##
+    # @return [Array<IiifManifestPresenter>]
+    def work_presenters
+      member_presenters.select(&:work?)
+    end
+
+    ##
+    # @note ideally, this value will be cheap to retrieve, and will reliably
+    #   change any time the manifest JSON will change. the current implementation
+    #   is more blunt than this, changing only when the work itself changes.
+    #
+    # @return [String] a string tag suitable for cache keys for this manifiest
+    def version
+      object.try(:modified_date)&.to_s || ''
+    end
+
+    ##
+    # An Ability-like object that gives `true` for all `can?` requests
+    class NullAbility
+      ##
+      # @return [Boolean] true
+      def can?(*)
+        true
+      end
+    end
+
+    class Factory < PresenterFactory
+      ##
+      # @return [Array]
+      def build
+        ids.map do |id|
+          solr_doc = load_docs.find { |doc| doc.id == id }
+          presenter_class.for(solr_doc) if solr_doc
+        end.compact
+      end
+
+      private
+
+        ##
+        # cache the docs in this method, rather than #build;
+        # this can probably be pushed up to the parent class
+        def load_docs
+          @cached_docs ||= super
+        end
+    end
+
+    ##
+    # a Presenter for producing `IIIFManifest::DisplayImage` objects
+    #
+    class DisplayImagePresenter < Draper::Decorator
+      delegate_all
+
+      include Hyrax::DisplaysImage
+
+      ##
+      # @!attribute [w] ability
+      #   @return [Ability]
+      # @!attribute [w] hostname
+      #   @return [String]
+      attr_writer :ability, :hostname
+
+      ##
+      # Creates a display image only where #model is an image.
+      #
+      # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
+      def display_image
+        return nil unless model.image?
+        return nil unless latest_file_id
+
+        IIIFManifest::DisplayImage
+          .new(display_image_url(hostname),
+               format: image_format(alpha_channels),
+               width: width,
+               height: height,
+               iiif_endpoint: iiif_endpoint(latest_file_id, base_url: hostname))
+      end
+
+      def hostname
+        @hostname || 'localhost'
+      end
+
+      ##
+      # @return [Boolean] false
+      def work?
+        false
+      end
+    end
+
+    private
+
+      def hostname
+        @hostname || 'localhost'
+      end
+
+      def metadata_fields
+        Hyrax.config.iiif_metadata_fields
+      end
+
+      def scrub(value)
+        Loofah.fragment(value).scrub!(:whitewash).to_s
+      end
+  end
+end

data/app/presenters/hyrax/member_presenter_factory.rb

@@ -36,14 +36,8 @@ module Hyrax
       @work_presenters ||= member_presenters(ordered_ids - file_set_ids, work_presenter_class)
     end
 
-    # TODO: Extract this to ActiveFedora::Aggregations::ListSource
     def ordered_ids
-      @ordered_ids ||= begin
-                         ActiveFedora::SolrService.query("proxy_in_ssi:#{id}",
-                                                         rows: 10_000,
-                                                         fl: "ordered_targets_ssim")
-                                                  .flat_map { |x| x.fetch("ordered_targets_ssim", []) }
-                       end
+      @ordered_ids ||= Hyrax::SolrDocument::OrderedMembers.decorate(@work).ordered_member_ids
     end
 
     private

data/app/search_builders/hyrax/embargo_search_builder.rb

@@ -14,7 +14,7 @@ module Hyrax
 
     def only_active_embargoes(solr_params)
       solr_params[:fq] ||= []
-      solr_params[:fq] = 'embargo_release_date_dtsi:*'
+      solr_params[:fq] = 'embargo_release_date_dtsi:[* TO *]'
     end
   end
 end

data/app/search_builders/hyrax/lease_search_builder.rb

@@ -14,7 +14,7 @@ module Hyrax
 
     def only_active_leases(solr_params)
       solr_params[:fq] ||= []
-      solr_params[:fq] = 'lease_expiration_date_dtsi:*'
+      solr_params[:fq] = 'lease_expiration_date_dtsi:[* TO *]'
     end
   end
 end

data/app/services/hyrax/caching_iiif_manifest_builder.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # constructs IIIF Manifests and holds them in the Rails cache,
+  # this approach avoids long manifest build times for some kinds of requests,
+  # at the cost of introducing cache invalidation issues.
+  class CachingIiifManifestBuilder < ManifestBuilderService
+    KEY_PREFIX = 'iiif-cache-v1'
+
+    attr_accessor :expires_in
+
+    ##
+    # @api public
+    #
+    # @param iiif_manifest_factory [Class] a class that initializes with presenter
+    #        object and returns an object that responds to `#to_h`
+    # @param expires_in [Integer] the number of seconds until the cache expires
+    # @see Hyrax::Configuration#iiif_manifest_cache_duration
+    def initialize(iiif_manifest_factory: ::IIIFManifest::ManifestFactory, expires_in: Hyrax.config.iiif_manifest_cache_duration)
+      self.expires_in = expires_in
+
+      super(iiif_manifest_factory: iiif_manifest_factory)
+    end
+
+    ##
+    # @see ManifestBuilderService#as_json
+    def manifest_for(presenter:)
+      Rails.cache.fetch(manifest_cache_key(presenter: presenter), expires_in: expires_in) do
+        super
+      end
+    end
+
+    private
+
+      ##
+      # @note adding a version_for suffix helps us manage cache expiration,
+      #   reducing false cache hits
+      #
+      # @param presenter [Hyrax::IiifManifestPresenter]
+      #
+      # @return [String]
+      def manifest_cache_key(presenter:)
+        "#{KEY_PREFIX}_#{presenter.id}/#{version_for(presenter)}"
+      end
+
+      ##
+      # @return [String]
+      def version_for(presenter)
+        presenter.version
+      end
+  end
+end

data/app/services/hyrax/file_set_csv_service.rb

@@ -1,3 +1,4 @@
+require 'csv'
 module Hyrax
   #
   # Generates CSV from a FileSet

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

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module Hyrax
+  module Identifier
+    class Registrar
+      class << self
+        ##
+        # @param type [Symbol]
+        # @param opts [Hash]
+        # @option opts [Hyrax::Identifier::Builder] :builder
+        #
+        # @return [Hyrax::Identifier::Registrar] a registrar for the given type
+        def for(type, **opts)
+          return Hyrax.config.identifier_registrars[type].new(**opts) if Hyrax.config.identifier_registrars.include?(type)
+          raise ArgumentError, "Hyrax::Identifier::Registrar not found to handle #{type}"
+        end
+      end
+
+      ##
+      # @!attribute builder [rw]
+      #   @return [Hyrax::Identifier::Builder]
+      attr_accessor :builder
+
+      ##
+      # @param builder [Hyrax::Identifier::Builder]
+      def initialize(builder:)
+        @builder = builder
+      end
+
+      ##
+      # @abstract
+      #
+      # @param object [#id]
+      #
+      # @return [#identifier]
+      # @raise [NotImplementedError] when the method is abstract
+      def register!(*)
+        raise NotImplementedError
+      end
+    end
+  end
+end