hyrax 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140c7caa34751f7a525eda269abcee6331a9e7d200863e2cbee29d315966de65
-  data.tar.gz: 7085c394edd0aa1e90baef7d13f90245d8fb0fb65659e54549cedda0487445e9
+  metadata.gz: c050894909dcdbe63b34640d24f9f665e3818850cf2f4c5a0d92af23ae51cf62
+  data.tar.gz: 42a5a185ee2d26c9ab54d544a8261fc2bd24c01b99903092e5d54a9c5dcee054
 SHA512:
-  metadata.gz: 691b84f363281552cbd84f85b767bb5b460ba749e0449aed0498594143767a6cd4dae187a5dd9c88bf3b7bd06a568375da70367b3b8faa674a59f39deaf4df06
-  data.tar.gz: e19605afaa51b569ea79e7e99d65fd0576b172cd6dfeb38f815c4dd3a7ac18678bb6b3ff4ac4a5af2b6358bf55c459baba0c4a98b393d20f7d64388f576c894f
+  metadata.gz: a0fab1e2979598561c1f4afd61e2434c0af3529005c7f6394f9605d5c30e4e95df45a7c23cf665ac6ee647360a27ef286870a7456b8b57a0ec17e905f8d474af
+  data.tar.gz: 55d6ffdace586396f41b327dceca10da11eeedbcee3d0be0abeafa3635574425e79fa6b8dd0ba831870b9f6d464e0067da889d46e5318051d63f00a502cff892

data/.gitignore

@@ -78,3 +78,4 @@ _yardoc
 lib/bundler/man
 spec/reports
 /spec/examples.txt
+node_modules

data/README.md

@@ -158,7 +158,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.4.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.8.0/template.rb
+rails _5.2.4.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v2.9.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/app/assets/javascripts/hyrax/autocomplete.es6

@@ -10,6 +10,34 @@ export default class Autocomplete {
    * @param {string} url - The url for the autocompete search endpoint
    */
   setup (element, fieldName, url) {
+    if(element.data('autocomplete-type') && element.data('autocomplete-type').length > 0) {
+      this.byDataAttribute(element, url)
+    } else {
+      this.byFieldName(element, fieldName, url)
+    }
+  }
+
+  byDataAttribute(element, url) {
+    let type = element.data('autocomplete-type')
+    let exlude = element.data('exclude-work')
+    if(type === 'resource' && exclude.length > 0) {
+      new Resource(
+        element,
+        url,
+        { excluding: exclude }
+      )
+    } else if(type === 'resource' ) {
+      new Resource(
+        element,
+        url)
+    } else if(type === 'linked') {
+      new LinkedData(element, url)
+    } else {
+      new Default(element, url)
+    }
+  }
+
+  byFieldName(element, fieldName, url) {
     switch (fieldName) {
       case 'work':
         new Resource(
@@ -30,4 +58,5 @@ export default class Autocomplete {
         break
     }
   }
+
 }

data/app/assets/javascripts/hyrax/editor.es6

@@ -53,17 +53,16 @@ export default class {
       $('[data-autocomplete]').each((function() {
         var elem = $(this)
         autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
+        elem.parents('.multi_value.form-group').manage_fields({
+          add: function(e, element) {
+            var elem = $(element)
+            // Don't mark an added element as readonly even if previous element was
+            // Enable before initializing, as otherwise LinkedData fields remain disabled
+            elem.attr('readonly', false)
+            autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
+          }
+        })
       }))
-
-      $('.multi_value.form-group').manage_fields({
-        add: function(e, element) {
-          var elem = $(element)
-          // Don't mark an added element as readonly even if previous element was
-          // Enable before initializing, as otherwise LinkedData fields remain disabled
-          elem.attr('readonly', false)
-          autocomplete.setup(elem, elem.data('autocomplete'), elem.data('autocompleteUrl'))
-        }
-      })
   }
 
   // initialize any controlled vocabulary widgets

data/app/controllers/concerns/hyrax/works_controller_behavior.rb

@@ -10,10 +10,11 @@ module Hyrax
       with_themed_layout :decide_layout
       copy_blacklight_config_from(::CatalogController)
 
-      class_attribute :_curation_concern_type, :show_presenter, :work_form_service, :search_builder_class
+      class_attribute :_curation_concern_type, :show_presenter, :work_form_service, :search_builder_class, :iiif_manifest_builder
       self.show_presenter = Hyrax::WorkShowPresenter
       self.work_form_service = Hyrax::WorkFormService
       self.search_builder_class = WorkSearchBuilder
+      self.iiif_manifest_builder = (Flipflop.cache_work_iiif_manifest? ? Hyrax::CachingIiifManifestBuilder.new : Hyrax::ManifestBuilderService.new)
       attr_accessor :curation_concern
       helper_method :curation_concern, :contextual_path
 
@@ -127,14 +128,28 @@ module Hyrax
 
     def manifest
       headers['Access-Control-Allow-Origin'] = '*'
+
+      json = iiif_manifest_builder.manifest_for(presenter: iiif_manifest_presenter)
+
       respond_to do |wants|
-        wants.json { render json: manifest_builder.to_h }
-        wants.html { render json: manifest_builder.to_h }
+        wants.json { render json: json }
+        wants.html { render json: json }
       end
     end
 
     private
 
+      def iiif_manifest_builder
+        self.class.iiif_manifest_builder
+      end
+
+      def iiif_manifest_presenter
+        IiifManifestPresenter.new(curation_concern_from_search_results).tap do |p|
+          p.hostname = request.hostname
+          p.ability = current_ability
+        end
+      end
+
       def user_collections
         collections_service.search_results(:deposit)
       end
@@ -157,10 +172,6 @@ module Hyrax
         @form = work_form_service.build(curation_concern, current_ability, self)
       end
 
-      def manifest_builder
-        ::IIIFManifest::ManifestFactory.new(presenter)
-      end
-
       def actor
         @actor ||= Hyrax::CurationConcern.actor
       end

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -12,6 +12,7 @@ module Hyrax
     include Hyrax::ChartsHelper
     include Hyrax::DashboardHelperBehavior
     include Hyrax::IiifHelper
+    include Hyrax::WorkFormHelper
 
     # Which translations are available for the user to select
     # @return [Hash<String,String>] locale abbreviations as keys and flags as values

data/app/helpers/hyrax/work_form_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module Hyrax
+  module WorkFormHelper
+    ##
+    # This helper allows downstream applications and engines to add/remove/reorder the tabs to be
+    # rendered on the work form.
+    #
+    # @example with additional tabs
+    #  Override this helper and ensure that it loads after Hyrax's helpers.
+    #  module WorksHelper
+    #    def form_tabs_for(form:)
+    #      super + ["my_new_tab"]
+    #    end
+    #  end
+    #  Add the new section partial at app/views/hyrax/base/_form_my_new_tab.html.erb
+    #
+    # @todo The share tab isn't included because it wasn't in guts4form.  guts4form should be
+    #   cleaned up so share is treated the same as other tabs and can be included below.
+    # @param form [Hyrax::Forms::WorkForm]
+    # @return [Array<String>] the list of names of tabs to be rendered in the form
+    def form_tabs_for(form:)
+      if form.instance_of? Hyrax::Forms::BatchUploadForm
+        %w[files metadata relationships]
+      else
+        %w[metadata files relationships]
+      end
+    end
+
+    ##
+    # This helper allows downstream applications and engines to add additional sections to be
+    # rendered after the visibility section in the Save Work panel on the work form.
+    #
+    # @example with additional sections
+    #  Override this helper and ensure that it loads after Hyrax's helpers.
+    #  module WorksHelper
+    #    def form_progress_sections_for(*)
+    #      super + ["my_new_section"]
+    #    end
+    #  end
+    #  Add the new section partial at app/views/hyrax/base/_form_progress_my_new_section.html.erb
+    #
+    # @param form [Hyrax::Forms::WorkForm]
+    # @return [Array<String>] the list of names of sections to be rendered in the form_progress panel
+    def form_progress_sections_for(*)
+      []
+    end
+  end
+end

data/app/jobs/iiif_manifest_cache_prewarm_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class IiifManifestCachePrewarmJob < Hyrax::ApplicationJob
+  ##
+  # @param work [ActiveFedora::Base]
+  def perform(work)
+    presenter = Hyrax::IiifManifestPresenter.new(work)
+    manifest_builder.manifest_for(presenter: presenter)
+  end
+
+  private
+
+    def manifest_builder
+      Hyrax::CachingIiifManifestBuilder.new
+    end
+end

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -54,6 +54,7 @@ module Hyrax
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
         attribute :admin_set, Solr::Array, solr_name('admin_set')
+        attribute :member_ids, Solr::Array, "member_ids_ssim"
         attribute :member_of_collection_ids, Solr::Array, solr_name('member_of_collection_ids', :symbol)
         attribute :description, Solr::Array, solr_name('description')
         attribute :title, Solr::Array, solr_name('title')

data/app/models/concerns/hyrax/solr_document/ordered_members.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module Hyrax
+  module SolrDocument
+    ##
+    # Decorates an object responding to `#id` with an `#ordered_member_ids` method.
+    #
+    # @note this decorator is intended for use with data representations other
+    #   than the core model objects, as an alternative to a direct query of the
+    #   canonical database. for example, it can be used with `SolrDocument` to
+    #   quickly retrieve member order in a way that is compatible with the
+    #   fast access required in Blacklight's search contexts.
+    #
+    # @example
+    #   base_document = SolrDocument.new(my_work.to_solr)
+    #   solr_document = Hyrax::SolrDocument::OrderedMembers.decorate(base_document)
+    #
+    #   solr_document.ordered_member_ids # => ['abc', '123']
+    #
+    class OrderedMembers < Draper::Decorator
+      delegate_all
+
+      ##
+      # @note the purpose of this method is to provide fast access to member
+      #   order. currently this is achieved by accessing indexed list proxies
+      #   from Solr. however, this strategy may change in the future.
+      #
+      # @return [Enumerable<String>] ids in the order of their membership,
+      #   only includes ids of ordered members.
+      def ordered_member_ids
+        return [] if id.blank?
+        @ordered_member_ids ||= query_for_ordered_ids
+      end
+
+      private
+
+        def query_for_ordered_ids(limit: 10_000,
+                                  proxy_field: 'proxy_in_ssi',
+                                  target_field: 'ordered_targets_ssim')
+          ActiveFedora::SolrService
+            .query("#{proxy_field}:#{id}", rows: limit, fl: target_field)
+            .flat_map { |x| x.fetch(target_field, nil) }
+            .compact
+        end
+    end
+  end
+end

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -61,10 +61,20 @@ module Hyrax
       @model ||= ModelWrapper.new(hydra_model, id)
     end
 
+    ##
+    # @return [Boolean]
     def collection?
       hydra_model == ::Collection
     end
 
+    ##
+    # @return [Boolean]
+    def file_set?
+      hydra_model == ::FileSet
+    end
+
+    ##
+    # @return [Boolean]
     def admin_set?
       hydra_model == ::AdminSet
     end

data/app/presenters/hyrax/displays_image.rb

@@ -11,20 +11,11 @@ module Hyrax
     # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
     def display_image
       return nil unless solr_document.image? && current_ability.can?(:read, solr_document)
-
-      latest_file_id = lookup_original_file_id
-
       return nil unless latest_file_id
 
-      url = Hyrax.config.iiif_image_url_builder.call(
-        latest_file_id,
-        request.base_url,
-        Hyrax.config.iiif_image_size_default
-      )
-
       # @see https://github.com/samvera-labs/iiif_manifest
-      IIIFManifest::DisplayImage.new(url,
-                                     format: image_format([]),
+      IIIFManifest::DisplayImage.new(display_image_url(request.base_url),
+                                     format: image_format(alpha_channels),
                                      width: width,
                                      height: height,
                                      iiif_endpoint: iiif_endpoint(latest_file_id))
@@ -32,16 +23,24 @@ module Hyrax
 
     private
 
-      def iiif_endpoint(file_id)
+      def display_image_url(base_url)
+        Hyrax.config.iiif_image_url_builder.call(
+          latest_file_id,
+          base_url,
+          Hyrax.config.iiif_image_size_default
+        )
+      end
+
+      def iiif_endpoint(file_id, base_url: request.base_url)
         return unless Hyrax.config.iiif_image_server?
         IIIFManifest::IIIFEndpoint.new(
-          Hyrax.config.iiif_info_url_builder.call(file_id, request.base_url),
+          Hyrax.config.iiif_info_url_builder.call(file_id, base_url),
           profile: Hyrax.config.iiif_image_compliance_level_uri
         )
       end
 
       def image_format(channels)
-        channels.find { |c| c.include?('rgba') }.nil? ? 'jpg' : 'png'
+        channels&.find { |c| c.include?('rgba') }.nil? ? 'jpg' : 'png'
       end
 
       def unindexed_current_file_version
@@ -49,13 +48,18 @@ module Hyrax
         ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
       end
 
-      def lookup_original_file_id
-        result = original_file_id
-        if result.blank?
-          Rails.logger.warn "original_file_id for #{id} not found, falling back to Fedora."
-          result = ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
-        end
-        result
+      def latest_file_id
+        @latest_file_id ||=
+          begin
+            result = original_file_id
+
+            if result.blank?
+              Rails.logger.warn "original_file_id for #{id} not found, falling back to Fedora."
+              result = Hyrax::VersioningService.versioned_file_id ::FileSet.find(id).original_file
+            end
+
+            result
+          end
       end
   end
 end

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/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/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

data/app/services/hyrax/manifest_builder_service.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A class responsible for converting a Hyrax::Work like thing into a IIIF
+  # manifest.
+  #
+  # @see !{.as_json}
+  class ManifestBuilderService
+    ##
+    # @api public
+    #
+    # @param presenter [Hyrax::WorkShowPresenter] the work presenter from which
+    #        we'll build a manifest.
+    # @param iiif_manifest_factory [Class] a class that initializes with presenter
+    #        object and returns an object that responds to `#to_h`
+    #
+    # @note While the :presenter may be a Hyrax::WorkShowPresenter it is likely
+    #       defined by Hyrax::WorksControllerBehavior.show_presenter
+    #
+    # @return [Hash] a Ruby hash representation of a IIIF manifest document
+    #
+    # @see Hyrax::WorksControllerBehavior
+    def self.manifest_for(presenter:, iiif_manifest_factory: ::IIIFManifest::ManifestFactory)
+      new(iiif_manifest_factory: iiif_manifest_factory)
+        .manifest_for(presenter: presenter)
+    end
+
+    ##
+    # @!attribute [r] manifest_factory
+    #   @return [#to_h]
+    attr_reader :manifest_factory
+
+    ##
+    # @api public
+    #
+    # @param iiif_manifest_factory [Class] a class that initializes with presenter
+    #        object and returns an object that responds to `#to_h`
+    def initialize(iiif_manifest_factory: ::IIIFManifest::ManifestFactory)
+      @manifest_factory = iiif_manifest_factory
+    end
+
+    ##
+    # @api public
+    #
+    # @param presenter [Hyrax::WorkShowPresenter]
+    #
+    # @return [Hash] a Ruby hash representation of a IIIF manifest document
+    def manifest_for(presenter:)
+      sanitized_manifest(presenter: presenter)
+    end
+
+    private
+
+      ##
+      # @api private
+      # @param presenter [Hyrax::WorkShowPresenter]
+      def sanitized_manifest(presenter:)
+        # ::IIIFManifest::ManifestBuilder#to_h returns a
+        # IIIFManifest::ManifestBuilder::IIIFManifest, not a Hash.
+        # to get a Hash, we have to call its #to_json, then parse.
+        #
+        # wild times. maybe there's a better way to do this with the
+        # ManifestFactory interface?
+        manifest = manifest_factory.new(presenter).to_h
+        hash = JSON.parse(manifest.to_json)
+
+        hash['label'] = sanitize_value(hash['label']) if hash.key?('label')
+        hash['description'] = Array(hash['description'])&.collect { |elem| sanitize_value(elem) } if hash.key?('description')
+
+        hash['sequences']&.each do |sequence|
+          sequence['canvases']&.each do |canvas|
+            canvas['label'] = sanitize_value(canvas['label'])
+          end
+        end
+
+        hash
+      end
+
+      ##
+      # @api private
+      # @param [#to_s] text
+      # @return [String] a sanitized verison of `text`
+      def sanitize_value(text)
+        Loofah.fragment(text.to_s).scrub!(:prune).to_s
+      end
+  end
+end

data/app/services/hyrax/versioning_service.rb

@@ -22,5 +22,14 @@ module Hyrax
       return if version.nil?
       VersionCommitter.create(version_id: version.uri, committer_login: user_key)
     end
+
+    # @param [ActiveFedora::File | Hyrax::FileMetadata] content
+    def self.versioned_file_id(file)
+      versions = file.versions.all
+
+      return ActiveFedora::Base.uri_to_id(versions.last.uri) if versions.present?
+
+      file.id
+    end
   end
 end

data/app/views/hyrax/base/_form.html.erb

@@ -19,7 +19,7 @@
       <p class="switch-upload-type">To create a separate work for each of the files, go to <%= link_to "Batch upload", hyrax.new_batch_upload_path %></p>
     <% end %>
   <% end %>
-  <%= render 'hyrax/base/guts4form', f: f %>
+  <%= render 'hyrax/base/guts4form', f: f, tabs: form_tabs_for(form: f.object) %>
 <% end %>
 
 <script type="text/javascript">

data/app/views/hyrax/base/_form_progress.html.erb

@@ -26,6 +26,10 @@
           <%= f.input :on_behalf_of, collection: current_user.can_make_deposits_for.map(&:user_key), prompt: "Yourself" %>
         </div>
     <% end %>
+
+    <% form_progress_sections_for(form: f.object).each do |section| %>
+      <%= render "form_progress_#{section}", f: f %>
+    <% end %>
   </div>
   <div class="panel-footer text-center">
     <% if ::Flipflop.show_deposit_agreement? %>

data/app/views/hyrax/base/_guts4form.html.erb

@@ -1,5 +1,11 @@
 <% # we will yield to content_for for each tab, e.g. :files_tab %>
-<% tabs ||= %w[metadata files relationships] # default tab order %>
+<%# Not passing tabs local param to this partial is deprecated and the tabs param will be required in Hyrax 3.0 %>
+<% unless defined?(tabs) %>
+  <% Deprecation.warn(self, "Passing the tabs local param to the _guts4form partial will be required in Hyrax 3.0.  " \
+                            "Consider removing overriding view partials and customizing the tab list " \
+                            "by overriding the new form_tabs_for(form:) helper.") %>
+  <% tabs = form_tabs_for(form: f.object) # default tab order %>
+<% end %>
 <div class="row">
   <div class="col-xs-12 col-sm-8">
     <div class="panel panel-default tabs" role="main">

data/app/views/hyrax/batch_uploads/_form.html.erb

@@ -10,7 +10,7 @@
       <%= link_to t("hyrax.batch_uploads.files.button_label"), [main_app, :new, Hyrax.primary_work_type.model_name.singular_route_key] %>
     </p>
   <% end %>
-  <%= render 'hyrax/base/guts4form', f: f, tabs: %w[files metadata relationships] %>
+  <%= render 'hyrax/base/guts4form', f: f, tabs: form_tabs_for(form: f.object) %>
   <%= f.hidden_field :payload_concern, value: @form.payload_concern %>
 <% end %>
 

data/app/views/hyrax/dashboard/_sidebar.html.erb

@@ -1,6 +1,6 @@
 <% menu = Hyrax::MenuPresenter.new(self) %>
 <div class="sidebar-toggle"><span class="fa fa-chevron-circle-right"></span></div>
-<nav>
+<nav aria-label="sidebar-nav">
   <ul class="nav nav-pills nav-stacked">
     <li>
       <div class="profile">

data/config/features.rb

@@ -42,4 +42,8 @@ Flipflop.configure do
   feature :hide_users_list,
           default: true,
           description: "Do not show users list unless user has authenticated."
+
+  feature :cache_work_iiif_manifest,
+          default: false,
+          description: "Use Rails.cache to cache the JSON document for IIIF manifests"
 end

data/hyrax.gemspec

@@ -39,6 +39,7 @@ SUMMARY
   spec.add_dependency 'browse-everything', '>= 0.16'
   spec.add_dependency 'carrierwave', '~> 1.0'
   spec.add_dependency 'clipboard-rails', '~> 1.5'
+  spec.add_dependency 'draper', '~> 4.0'
   spec.add_dependency 'dry-equalizer', '~> 0.2'
   spec.add_dependency 'dry-struct', '>= 0.1', '< 2.0'
   spec.add_dependency 'dry-transaction', '~> 0.11'

data/lib/generators/hyrax/templates/config/initializers/hyrax.rb

@@ -266,6 +266,11 @@ Hyrax.config do |config|
   # mount point.
   #
   # config.whitelisted_ingest_dirs = []
+
+  ## Remote identifiers configuration
+  # Add registrar implementations by uncommenting and adding to the hash below.
+  # See app/services/hyrax/identifier/registrar.rb for the registrar interface
+  # config.identifier_registrars = {}
 end
 
 Date::DATE_FORMATS[:standard] = "%m/%d/%Y"

data/lib/hyrax.rb

@@ -8,6 +8,7 @@ require 'font-awesome-rails'
 require 'tinymce-rails'
 require 'blacklight'
 require 'blacklight/gallery'
+require 'iiif_manifest'
 require 'noid-rails'
 require 'hydra/head'
 require 'hydra-editor'

data/lib/hyrax/configuration.rb

@@ -431,6 +431,16 @@ module Hyrax
     end
     attr_writer :iiif_metadata_fields
 
+    # Duration in which we should cache the generated IIIF manifest.
+    # Default is 30 days (in seconds).
+    #
+    # @return [Integer] number of seconds
+    # @see https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch
+    def iiif_manifest_cache_duration
+      @iiif_manifest_cache_duration ||= 30.days.to_i
+    end
+    attr_writer :iiif_manifest_cache_duration
+
     # Should a button with "Share my work" show on the front page to users who are not logged in?
     attr_writer :display_share_button_when_not_logged_in
     def display_share_button_when_not_logged_in?
@@ -514,6 +524,11 @@ module Hyrax
       ->(id:, extent:) { Samvera::NestingIndexer.reindex_relationships(id: id, extent: extent) }
     end
 
+    attr_writer :identifier_registrars
+    def identifier_registrars
+      @identifier_registrars ||= {}
+    end
+
     private
 
       # @param [Symbol, #to_s] model_name - symbol representing the model

data/lib/hyrax/engine.rb

@@ -5,6 +5,7 @@ module Hyrax
     # These gems must be required outside of an initializer or they don't get loaded.
     require 'awesome_nested_set'
     require 'breadcrumbs_on_rails'
+    require 'draper'
     require 'jquery-ui-rails'
     require 'flot-rails'
     require 'almond-rails'

data/lib/hyrax/specs/shared_specs.rb

@@ -1,2 +1,3 @@
 require 'hyrax/specs/shared_specs/derivative_service'
+require 'hyrax/specs/shared_specs/identifiers'
 require 'hyrax/specs/shared_specs/workflow_method'

data/lib/hyrax/specs/shared_specs/identifiers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a Hyrax::Identifier::Builder' do
+  subject(:builder) { described_class.new }
+
+  describe '#build' do
+    it 'returns an identifier string' do
+      expect(builder.build(hint: 'moomin'))
+        .to respond_to :to_str
+    end
+  end
+end
+
+RSpec.shared_examples 'a Hyrax::Identifier::Registrar' do
+  subject(:registrar) { described_class.new(builder: builder) }
+  let(:builder)       { instance_double(Hyrax::Identifier::Builder, build: 'moomin') }
+  let(:object)        { instance_double(GenericWork, id: 'moomin_id') }
+
+  it { is_expected.to have_attributes(builder: builder) }
+
+  describe '#register!' do
+    it 'creates an identifier record' do
+      expect(registrar.register!(object: object).identifier)
+        .to respond_to :to_str
+    end
+  end
+end

data/lib/hyrax/version.rb

@@ -1,3 +1,3 @@
 module Hyrax
-  VERSION = '2.8.0'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/template.rb

@@ -1,6 +1,6 @@
 # Hack for https://github.com/rails/rails/issues/35153
 gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"'
-gem 'hyrax', '2.6.0'
+gem 'hyrax', '2.9.0'
 run 'bundle install'
 generate 'hyrax:install', '-f'
 rails_command 'db:migrate'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyrax
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,6 +162,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -1460,6 +1474,7 @@ files:
 - app/helpers/hyrax/title_helper.rb
 - app/helpers/hyrax/trophy_helper.rb
 - app/helpers/hyrax/url_helper.rb
+- app/helpers/hyrax/work_form_helper.rb
 - app/indexers/concerns/hyrax/indexes_basic_metadata.rb
 - app/indexers/concerns/hyrax/indexes_linked_metadata.rb
 - app/indexers/hyrax/admin_set_indexer.rb
@@ -1497,6 +1512,7 @@ files:
 - app/jobs/hyrax/grant_read_to_members_job.rb
 - app/jobs/hyrax/revoke_edit_from_members_job.rb
 - app/jobs/hyrax/revoke_edit_job.rb
+- app/jobs/iiif_manifest_cache_prewarm_job.rb
 - app/jobs/import_export_job.rb
 - app/jobs/import_url_job.rb
 - app/jobs/ingest_job.rb
@@ -1541,6 +1557,7 @@ files:
 - app/models/concerns/hyrax/solr_document/characterization.rb
 - app/models/concerns/hyrax/solr_document/export.rb
 - app/models/concerns/hyrax/solr_document/metadata.rb
+- app/models/concerns/hyrax/solr_document/ordered_members.rb
 - app/models/concerns/hyrax/solr_document_behavior.rb
 - app/models/concerns/hyrax/suppressible.rb
 - app/models/concerns/hyrax/user.rb
@@ -1619,6 +1636,7 @@ files:
 - app/presenters/hyrax/file_usage.rb
 - app/presenters/hyrax/fixity_status_presenter.rb
 - app/presenters/hyrax/homepage_presenter.rb
+- app/presenters/hyrax/iiif_manifest_presenter.rb
 - app/presenters/hyrax/inspect_work_presenter.rb
 - app/presenters/hyrax/lease_presenter.rb
 - app/presenters/hyrax/member_presenter_factory.rb
@@ -1705,6 +1723,7 @@ files:
 - app/services/hyrax/analytics.rb
 - app/services/hyrax/batch_create_failure_service.rb
 - app/services/hyrax/batch_create_success_service.rb
+- app/services/hyrax/caching_iiif_manifest_builder.rb
 - app/services/hyrax/change_content_depositor_service.rb
 - app/services/hyrax/collection_member_service.rb
 - app/services/hyrax/collection_size_service.rb
@@ -1733,6 +1752,9 @@ files:
 - app/services/hyrax/fixity_check_failure_service.rb
 - app/services/hyrax/form_metadata_service.rb
 - app/services/hyrax/graph_exporter.rb
+- app/services/hyrax/identifier/builder.rb
+- app/services/hyrax/identifier/dispatcher.rb
+- app/services/hyrax/identifier/registrar.rb
 - app/services/hyrax/iiif_authorization_service.rb
 - app/services/hyrax/import_url_failure_service.rb
 - app/services/hyrax/indexes_thumbnails.rb
@@ -1743,6 +1765,7 @@ files:
 - app/services/hyrax/local_file_service.rb
 - app/services/hyrax/lock_manager.rb
 - app/services/hyrax/lockable.rb
+- app/services/hyrax/manifest_builder_service.rb
 - app/services/hyrax/messenger_service.rb
 - app/services/hyrax/microdata.rb
 - app/services/hyrax/multiple_membership_checker.rb
@@ -2371,6 +2394,7 @@ files:
 - lib/hyrax/search_state.rb
 - lib/hyrax/specs/shared_specs.rb
 - lib/hyrax/specs/shared_specs/derivative_service.rb
+- lib/hyrax/specs/shared_specs/identifiers.rb
 - lib/hyrax/specs/shared_specs/workflow_method.rb
 - lib/hyrax/transactions.rb
 - lib/hyrax/transactions/container.rb