hyrax 2.6.0 → 2.9.0

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/services/hyrax/workflow/workflow_schema.rb

@@ -14,47 +14,107 @@ module Hyrax
     # @see Sipity::Notification
     # @see Sipity::Method
     # @see ./lib/generators/hyrax/templates/workflow.json.erb
-    WorkflowSchema = Dry::Validation.Schema do
-      configure do
-        def self.messages
-          Dry::Validation::Messages.default.merge(
-            en: { errors: { constant_name?: 'must be an initialized Ruby constant' } }
-          )
+
+    # If using dry-validation < 1, create a Dry::Validation::Schema for backwards-compatibility.
+    # This schema should never ever change.  If you need to modify it, upgrade to dry-validation >= 1
+    # and use the Dry::Validation::Contract subclass below.
+    if defined? Dry::Validation::Schema
+      Deprecation.warn(self, 'The Dry::Validation::Schema implemenation of Hyrax::Workflow::WorkflowSchema is deprecated. ' \
+                       'Please upgrade to dry-validation >= 1 to use the Dry::Validation::Contract implementation which will be part of Hyrax 3.0')
+      WorkflowSchema = Dry::Validation.Schema do
+        configure do
+          def self.messages
+            Dry::Validation::Messages.default.merge(
+              en: { errors: { constant_name?: 'must be an initialized Ruby constant' } }
+            )
+          end
+
+          def constant_name?(value)
+            value.constantize
+            true
+          rescue NameError
+            false
+          end
         end
 
-        def constant_name?(value)
-          value.constantize
-          true
-        rescue NameError
-          false
+        required(:workflows).each do
+          required(:name).filled(:str?) # Sipity::Workflow#name
+          optional(:label).filled(:str?) # Sipity::Workflow#label
+          optional(:description).filled(:str?) # Sipity::Workflow#description
+          optional(:allows_access_grant).filled(:bool?) # Sipity::Workflow#allows_access_grant?
+          required(:actions).each do
+            schema do
+              required(:name).filled(:str?) # Sipity::WorkflowAction#name
+              required(:from_states).each do
+                schema do
+                  required(:names) { array? { each(:str?) } } # Sipity::WorkflowState#name
+                  required(:roles) { array? { each(:str?) } } # Sipity::Role#name
+                end
+              end
+              optional(:transition_to).filled(:str?) # Sipity::WorkflowState#name
+              optional(:notifications).each do
+                schema do
+                  required(:name).value(:constant_name?) # Sipity::Notification#name
+                  required(:notification_type).value(included_in?: Sipity::Notification.valid_notification_types)
+                  required(:to) { array? { each(:str?) } }
+                  optional(:cc) { array? { each(:str?) } }
+                  optional(:bcc) { array? { each(:str?) } }
+                end
+              end
+              optional(:methods) { array? { each(:str?) } } # See it_behaves_like "a Hyrax workflow method"
+            end
+          end
         end
       end
+    elsif defined? Dry::Validation::Contract
+      # For dry-validation >= 1
+      class WorkflowSchema < Dry::Validation::Contract
+        class Types
+          include Dry::Types()
 
-      required(:workflows).each do
-        required(:name).filled(:str?) # Sipity::Workflow#name
-        optional(:label).filled(:str?) # Sipity::Workflow#label
-        optional(:description).filled(:str?) # Sipity::Workflow#description
-        optional(:allows_access_grant).filled(:bool?) # Sipity::Workflow#allows_access_grant?
-        required(:actions).each do
-          schema do
-            required(:name).filled(:str?) # Sipity::WorkflowAction#name
-            required(:from_states).each do
-              schema do
-                required(:names) { array? { each(:str?) } } # Sipity::WorkflowState#name
-                required(:roles) { array? { each(:str?) } } # Sipity::Role#name
-              end
+          Constant = Types::Class.constructor do |v|
+            begin
+              v.constantize
+            rescue NameError => _err
+              v
             end
-            optional(:transition_to).filled(:str?) # Sipity::WorkflowState#name
-            optional(:notifications).each do
-              schema do
-                required(:name).value(:constant_name?) # Sipity::Notification#name
+          end
+        end
+
+        # Wrap the result for backwards-compatibility. This will be removed in Hyrax 3.0.
+        class ResultWrapper < SimpleDelegator
+          def messages(opts = {})
+            errors(opts)
+          end
+        end
+
+        # Provide a class method for backwards-compatibility. This will be removed in Hyrax 3.0.
+        def self.call(data)
+          ResultWrapper.new(new.call(data))
+        end
+
+        params do
+          required(:workflows).array(:hash) do
+            required(:name).filled(:string) # Sipity::Workflow#name
+            optional(:label).filled(:string) # Sipity::Workflow#label
+            optional(:description).filled(:string) # Sipity::Workflow#description
+            optional(:allows_access_grant).filled(:bool) # Sipity::Workflow#allows_access_grant?
+            required(:actions).array(:hash) do
+              required(:name).filled(:string) # Sipity::WorkflowAction#name
+              required(:from_states).array(:hash) do
+                required(:names) { array? { each(:string) } } # Sipity::WorkflowState#name
+                required(:roles) { array? { each(:string) } } # Sipity::Role#name
+              end
+              optional(:transition_to).filled(:string) # Sipity::WorkflowState#name
+              optional(:notifications).array(:hash) do
+                required(:name).value(Types::Constant) # Sipity::Notification#name
                 required(:notification_type).value(included_in?: Sipity::Notification.valid_notification_types)
-                required(:to) { array? { each(:str?) } }
-                optional(:cc) { array? { each(:str?) } }
-                optional(:bcc) { array? { each(:str?) } }
+                required(:to) { array? { each(:string) } }
+                optional(:cc) { array? { each(:string) } }
+                optional(:bcc) { array? { each(:string) } }
               end
             end
-            optional(:methods) { array? { each(:str?) } } # See it_behaves_like "a Hyrax workflow method"
+            optional(:methods) { array? { each(:string) } } # See it_behaves_like "a Hyrax workflow method"
           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

@@ -16,9 +16,8 @@ SUMMARY
 
   spec.homepage      = "http://github.com/samvera/hyrax"
 
-  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR).select { |f| File.dirname(f) !~ %r{\A"?spec\/?} }
   spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.name          = "hyrax"
   spec.require_paths = ["lib"]
   spec.version       = Hyrax::VERSION
@@ -31,7 +30,7 @@ SUMMARY
   # http://guides.rubyonrails.org/maintenance_policy.html
   spec.add_dependency 'rails', '~> 5.0'
 
-  spec.add_dependency 'active-fedora', '~> 11.5', '>= 11.5.2'
+  spec.add_dependency 'active-fedora', '>= 11.5.2', '< 12.2'
   spec.add_dependency 'almond-rails', '~> 0.1'
   spec.add_dependency 'awesome_nested_set', '~> 3.1'
   spec.add_dependency 'blacklight', '~> 6.14'
@@ -40,10 +39,11 @@ 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'
+  spec.add_dependency 'dry-struct', '>= 0.1', '< 2.0'
   spec.add_dependency 'dry-transaction', '~> 0.11'
-  spec.add_dependency 'dry-validation', '~> 0.9'
+  spec.add_dependency 'dry-validation', '>= 0.9', '< 2.0'
   spec.add_dependency 'flipflop', '~> 2.3'
   # Pin more tightly because 0.x gems are potentially unstable
   spec.add_dependency 'flot-rails', '~> 0.0.6'
@@ -59,7 +59,7 @@ SUMMARY
   # Pin more tightly because 0.x gems are potentially unstable
   spec.add_dependency 'kaminari_route_prefix', '~> 0.1.1'
   spec.add_dependency 'legato', '~> 0.3'
-  spec.add_dependency 'linkeddata' # Required for getting values from geonames
+  spec.add_dependency 'linkeddata', '~> 3.1' # Required for getting values from geonames
   spec.add_dependency 'mailboxer', '~> 0.12'
   spec.add_dependency 'nest', '~> 3.1'
   spec.add_dependency 'noid-rails', '~> 3.0.0'
@@ -71,12 +71,14 @@ SUMMARY
   spec.add_dependency 'qa', '~> 2.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'
   spec.add_dependency 'redis-namespace', '~> 1.5'
   spec.add_dependency 'redlock', '>= 0.1.2'
   spec.add_dependency 'retriable', '>= 2.9', '< 4.0'
   spec.add_dependency 'samvera-nesting_indexer', '~> 2.0'
   spec.add_dependency 'select2-rails', '~> 3.5'
   spec.add_dependency 'signet'
+  spec.add_dependency 'solrizer', '>= 3.4', '< 5'
   spec.add_dependency 'tinymce-rails', '~> 4.1'
 
   # temporary pin to 2.17 due to failures caused in 2.18.0

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'
@@ -17,6 +18,7 @@ require 'hyrax/engine'
 require 'hyrax/version'
 require 'hyrax/inflections'
 require 'kaminari_route_prefix'
+require 'solrizer'
 
 module Hyrax
   extend ActiveSupport::Autoload

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