hyrax 2.8.0 → 2.9.5

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_child_work_relationships.html.erb

@@ -24,7 +24,7 @@ HTML Properties:
   </div>
   <div class="message has-warning hidden"></div>
   <div style="margin-top: 10px">
-    <%= link_to t('.attach_new_work'), polymorphic_path([main_app, :new, :hyrax, :parent, curation_concern.model_name.singular], parent_id: curation_concern.id), target: "_blank", class: 'btn btn-primary' %>
+    <%= link_to t('.attach_new_work'), polymorphic_path([main_app, :new, :hyrax, :parent, curation_concern.model_name.singular.to_sym], parent_id: curation_concern.id), target: "_blank", class: 'btn btn-primary' %>
   </div>
   <table class="table table-striped">
     <caption><%= t('.caption') %></caption>

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/_form_visibility_error.html.erb

@@ -1,3 +1,5 @@
 <%= f.full_error(:visibility) %>
 <%= f.full_error(:embargo_release_date) %>
 <%= f.full_error(:visibility_after_embargo) %>
+<%= f.full_error(:lease_expiration_date) %>
+<%= f.full_error(:visibility_after_lease) %>

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/base/_show_actions.html.erb

@@ -15,7 +15,7 @@
             <ul class="dropdown-menu">
               <% presenter.valid_child_concerns.each do |concern| %>
                 <li>
-                  <%= link_to "Attach #{concern.human_readable_type}", polymorphic_path([main_app, :new, :hyrax, :parent, concern.model_name.singular], parent_id: presenter.id) %>
+                  <%= link_to "Attach #{concern.human_readable_type}", polymorphic_path([main_app, :new, :hyrax, :parent, concern.model_name.singular.to_sym], parent_id: presenter.id) %>
                 </li>
               <% end %>
             </ul>

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

@@ -7,10 +7,10 @@
   <% provide :files_tab do %>
     <p class="instructions"><%= t("hyrax.batch_uploads.files.instructions") %></p>
     <p class="switch-upload-type"><%= t("hyrax.batch_uploads.files.upload_type_instructions") %>
-      <%= link_to t("hyrax.batch_uploads.files.button_label"), [main_app, :new, Hyrax.primary_work_type.model_name.singular_route_key] %>
+      <%= link_to t("hyrax.batch_uploads.files.button_label"), [main_app, :new, Hyrax.primary_work_type.model_name.singular_route_key.to_sym] %>
     </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'
@@ -49,7 +50,7 @@ SUMMARY
   spec.add_dependency 'font-awesome-rails', '~> 4.2'
   spec.add_dependency 'hydra-derivatives', '~> 3.3'
   spec.add_dependency 'hydra-editor', '>= 3.3', '< 6.0'
-  spec.add_dependency 'hydra-head', '>= 10.6.1'
+  spec.add_dependency 'hydra-head', '>= 10.6.1', '< 12'
   spec.add_dependency 'hydra-works', '>= 0.16', '< 2.0'
   spec.add_dependency 'iiif_manifest', '>= 0.3', '< 0.6'
   spec.add_dependency 'jquery-datatables-rails', '~> 3.4'
@@ -67,7 +68,7 @@ SUMMARY
   spec.add_dependency 'posix-spawn'
   spec.add_dependency 'power_converter', '~> 0.1', '>= 0.1.2'
   spec.add_dependency 'pul_uv_rails', '~> 2.0'
-  spec.add_dependency 'qa', '~> 2.0' # questioning_authority
+  spec.add_dependency 'qa', '>= 2.0', '< 6.0' # questioning_authority
   spec.add_dependency 'rails_autolink', '~> 1.1'
   spec.add_dependency 'rdf-rdfxml' # controlled vocabulary importer
   spec.add_dependency 'rdf-vocab', '< 3.1.5'

data/lib/generators/hyrax/templates/catalog_controller.rb

@@ -20,6 +20,10 @@ class CatalogController < ApplicationController
     config.view.gallery.partials = [:index_header, :index]
     config.view.slideshow.partials = [:index]
 
+    # Because too many times on Samvera tech people raise a problem regarding a failed query to SOLR.
+    # Often, it's because they inadvertantly exceeded the character limit of a GET request.
+    config.http_method = :post
+
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
     config.default_solr_params = {
       qt: "search",

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/generators/hyrax/templates/config/locales/hyrax.es.yml

@@ -51,7 +51,7 @@ es:
       suffix: "@example.org"
     footer:
       copyright_html: "<strong>Copyright &copy; 2018 Samvera</strong> bajo licencia de Apache, Version 2.0"
-      service_html: Un servicio de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera/a>.
+      service_html: Un servicio de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a>.
     institution_name: institución
     institution_name_full: El nombre de la institución
     product_name: Hyrax

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?
@@ -469,10 +479,14 @@ module Hyrax
     attr_writer :translate_uri_to_id
 
     def translate_uri_to_id
-      @translate_uri_to_id ||= lambda do |uri|
-        baseparts = 2 + [(::Noid::Rails.config.template.gsub(/\.[rsz]/, '').length.to_f / 2).ceil, 4].min
-        uri.to_s.sub("#{ActiveFedora.fedora.host}#{ActiveFedora.fedora.base_path}", '').split('/', baseparts).last
-      end
+      @translate_uri_to_id ||=
+        begin
+          baseparts = 2 + [(::Noid::Rails.config.template.gsub(/\.[rsz]/, '').length.to_f / 2).ceil, 4].min
+
+          lambda do |uri|
+            uri.to_s.split(ActiveFedora.fedora.base_path).last.split('/', baseparts).last
+          end
+        end
     end
 
     attr_writer :translate_id_to_uri
@@ -514,6 +528,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