hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/helpers/hyrax/iiif_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module IiifHelper
     def iiif_viewer_display(work_presenter, locals = {})
@@ -8,5 +9,13 @@ module Hyrax
     def iiif_viewer_display_partial(work_presenter)
       'hyrax/base/iiif_viewers/' + work_presenter.iiif_viewer.to_s
     end
+
+    def universal_viewer_base_url
+      "#{request&.base_url}/uv/uv.html"
+    end
+
+    def universal_viewer_config_url
+      "#{request&.base_url}/uv/uv-config.json"
+    end
   end
 end

data/app/helpers/hyrax/lease_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module LeaseHelper
     def assets_with_expired_leases
@@ -11,5 +12,25 @@ module Hyrax
     def assets_with_deactivated_leases
       @assets_with_deactivated_leases ||= LeaseService.assets_with_deactivated_leases
     end
+
+    ##
+    # @since 3.0.0
+    #
+    # @param [Valkyrie::Resource, ActiveFedora::Base] resource
+    #
+    # @return [Boolean] whether the resource has an lease that is currently
+    #   enforced (regardless of whether it has expired)
+    def lease_enforced?(resource)
+      case resource
+      when Hydra::AccessControls::Embargoable
+        !resource.lease_expiration_date.nil?
+      when HydraEditor::Form
+        lease_enforced?(resource.model)
+      when Valkyrie::ChangeSet
+        Hyrax::LeaseManager.new(resource: resource.model).enforced?
+      else
+        Hyrax::LeaseManager.new(resource: resource).enforced?
+      end
+    end
   end
 end

data/app/helpers/hyrax/membership_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module MembershipHelper
+    ##
+    # @param resource [#member_of_collection_ids, #member_of_collections_json]
+    #
+    # @return [String] JSON for `data-members`
+    #
+    # @todo optimize collection name lookup. the legacy `WorkForm`
+    #   implementation pulls all the collections already (though maybe with
+    #   instance-level caching?), but we should consider doing this more
+    #   efficiently.
+    #
+    # @see app/assets/javascripts/hyrax/relationships.js
+    def member_of_collections_json(resource)
+      return resource.member_of_collections_json if
+        resource.respond_to?(:member_of_collections_json)
+
+      resource = resource.model if resource.respond_to?(:model)
+
+      Hyrax.custom_queries.find_collections_for(resource: resource).map do |collection|
+        { id: collection.id.to_s,
+          label: collection.title.first,
+          path: url_for(collection) }
+      end.to_json
+    end
+
+    ##
+    # @param resource [#work_members_json]
+    #
+    # @return [String] JSON for `data-members`
+    #
+    # @see app/assets/javascripts/hyrax/relationships.js
+    def work_members_json(resource)
+      return resource.work_members_json if
+        resource.respond_to?(:work_members_json)
+
+      resource = resource.model if resource.respond_to?(:model)
+
+      Hyrax.custom_queries.find_child_works(resource: resource).map do |member|
+        { id: member.id.to_s,
+          label: member.title.first,
+          path: url_for(member) }
+      end.to_json
+    end
+  end
+end

data/app/helpers/hyrax/permission_levels_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module PermissionLevelsHelper
+    ##
+    # @return [Hash<String, String>] a map from i18nized strings to permission
+    #   level keywords
+    def configured_permission_levels
+      Hyrax.config.permission_levels.values.index_by do |level|
+        I18n.t("hyrax.permission_levels.#{level}")
+      end
+    end
+
+    ##
+    # @return [Hash<String, String>] a map from i18nized strings to permission
+    #   level keywords
+    def configured_owner_permission_levels
+      Hyrax.config.owner_permission_levels.values.index_by do |level|
+        I18n.t("hyrax.permission_levels.owner.#{level}")
+      end
+    end
+
+    ##
+    # @return [Hash<String, String>] a map from i18nized strings to permission
+    #   level keywords
+    def configured_permission_options
+      Hyrax.config.permission_options.values.index_by do |option|
+        I18n.t("hyrax.permission_levels.options.#{option}")
+      end
+    end
+  end
+end

data/app/helpers/hyrax/permissions_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module PermissionsHelper
     def help_text(file)
@@ -6,14 +7,14 @@ module Hyrax
 
     private
 
-      def capture_content(file)
-        capture do
-          render file
-        end
+    def capture_content(file)
+      capture do
+        render file
       end
+    end
 
-      def help_icon
-        content_tag 'i', '', 'aria-hidden' => true, class: 'help-icon'
-      end
+    def help_icon
+      tag.i '', 'aria-hidden': true, class: 'help-icon'
+    end
   end
 end

data/app/helpers/hyrax/title_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hyrax::TitleHelper
   def application_name
     t('hyrax.product_name', default: super)
@@ -7,12 +9,12 @@ module Hyrax::TitleHelper
     (elements.flatten.compact + [application_name]).join(' // ')
   end
 
+  ##
+  # @deprecated
   def curation_concern_page_title(curation_concern)
-    if curation_concern.persisted?
-      construct_page_title(curation_concern.to_s, "#{curation_concern.human_readable_type} [#{curation_concern.to_param}]")
-    else
-      construct_page_title("New #{curation_concern.human_readable_type}")
-    end
+    Deprecation.warn 'The curation_concern_page_title helper will be removed in Hyrax 4.0.' \
+                     "\n\tUse title_presenter(curation_concern).page_title instead."
+    title_presenter(curation_concern).page_title
   end
 
   def default_page_title
@@ -20,4 +22,8 @@ module Hyrax::TitleHelper
     text = "#{action_name.titleize} " + text if action_name
     construct_page_title(text)
   end
+
+  def title_presenter(resource)
+    Hyrax::PageTitleDecorator.new(resource)
+  end
 end

data/app/helpers/hyrax/trophy_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module TrophyHelper
     def display_trophy_link(user, id, args = {}, &_block)

data/app/helpers/hyrax/url_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module UrlHelper
     # generated models get registered as curation concerns and need a

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, Hyrax::Forms::ResourceForm]
+    # @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, Hyrax::Forms::ResourceForm]
+    # @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/indexers/concerns/hyrax/indexes_basic_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # This module can be mixed in on an indexer in order to index the basic metadata fields
   module IndexesBasicMetadata

data/app/indexers/concerns/hyrax/indexes_linked_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # This module can be mixed in on an indexer in order to index the linked metadata fields
   module IndexesLinkedMetadata

data/app/indexers/hyrax/admin_set_indexer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class AdminSetIndexer < ActiveFedora::IndexingService
     include Hyrax::IndexesThumbnails
@@ -7,7 +8,12 @@ module Hyrax
     def generate_solr_document
       super.tap do |solr_doc|
         # Makes Admin Sets show under the "Admin Sets" tab
-        Solrizer.set_field(solr_doc, 'generic_type', 'Admin Set', :facetable)
+        solr_doc['generic_type_sim']        = ['Admin Set']
+        solr_doc['alternative_title_tesim'] = object.alternative_title
+        solr_doc['creator_ssim']            = object.creator
+        solr_doc['description_tesim']       = object.description
+        solr_doc['title_tesim']             = object.title
+        solr_doc['title_sim']               = object.title
       end
     end
   end

data/app/indexers/hyrax/basic_metadata_indexer.rb

@@ -1,57 +1,58 @@
+# frozen_string_literal: true
 module Hyrax
   # This class gets called by ActiveFedora::IndexingService#olrize_rdf_assertions
   class BasicMetadataIndexer < ActiveFedora::RDF::IndexingService
     class_attribute :stored_and_facetable_fields, :stored_fields, :symbol_fields
     self.stored_and_facetable_fields = %i[resource_type creator contributor keyword publisher subject language based_near]
-    self.stored_fields = %i[description license rights_statement date_created identifier related_url bibliographic_citation source]
+    self.stored_fields = %i[alternative_title description abstract license rights_statement rights_notes access_right date_created identifier related_url bibliographic_citation source]
     self.symbol_fields = %i[import_url]
 
     private
 
-      # This method overrides ActiveFedora::RDF::IndexingService
-      # @return [ActiveFedora::Indexing::Map]
-      def index_config
+    # This method overrides ActiveFedora::RDF::IndexingService
+    # @return [ActiveFedora::Indexing::Map]
+    def index_config
+      merge_config(
         merge_config(
-          merge_config(
-            merge_config(super, stored_and_facetable_index_config),
-            stored_searchable_index_config
-          ),
-          symbol_index_config
-        )
-      end
+          merge_config(super, stored_and_facetable_index_config),
+          stored_searchable_index_config
+        ),
+        symbol_index_config
+      )
+    end
 
-      # This can be replaced by a simple merge once
-      # https://github.com/samvera/active_fedora/pull/1227
-      # is available to us
-      # @param [ActiveFedora::Indexing::Map] first
-      # @param [Hash] second
-      def merge_config(first, second)
-        first_hash = first.instance_variable_get(:@hash).deep_dup
-        ActiveFedora::Indexing::Map.new(first_hash.merge(second))
-      end
+    # This can be replaced by a simple merge once
+    # https://github.com/samvera/active_fedora/pull/1227
+    # is available to us
+    # @param [ActiveFedora::Indexing::Map] first
+    # @param [Hash] second
+    def merge_config(first, second)
+      first_hash = first.instance_variable_get(:@hash).deep_dup
+      ActiveFedora::Indexing::Map.new(first_hash.merge(second))
+    end
 
-      def stored_and_facetable_index_config
-        stored_and_facetable_fields.each_with_object({}) do |name, hash|
-          hash[name] = index_object_for(name, as: [:stored_searchable, :facetable])
-        end
+    def stored_and_facetable_index_config
+      stored_and_facetable_fields.each_with_object({}) do |name, hash|
+        hash[name] = index_object_for(name, as: [:stored_searchable, :facetable])
       end
+    end
 
-      def stored_searchable_index_config
-        stored_fields.each_with_object({}) do |name, hash|
-          hash[name] = index_object_for(name, as: [:stored_searchable])
-        end
+    def stored_searchable_index_config
+      stored_fields.each_with_object({}) do |name, hash|
+        hash[name] = index_object_for(name, as: [:stored_searchable])
       end
+    end
 
-      def symbol_index_config
-        symbol_fields.each_with_object({}) do |name, hash|
-          hash[name] = index_object_for(name, as: [:symbol])
-        end
+    def symbol_index_config
+      symbol_fields.each_with_object({}) do |name, hash|
+        hash[name] = index_object_for(name, as: [:symbol])
       end
+    end
 
-      def index_object_for(attribute_name, as: [])
-        ActiveFedora::Indexing::Map::IndexObject.new(attribute_name) do |idx|
-          idx.as(*as)
-        end
+    def index_object_for(attribute_name, as: [])
+      ActiveFedora::Indexing::Map::IndexObject.new(attribute_name) do |idx|
+        idx.as(*as)
       end
+    end
   end
 end

data/app/indexers/hyrax/collection_indexer.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Hyrax
   class CollectionIndexer < Hydra::PCDM::CollectionIndexer
     include Hyrax::IndexesThumbnails
 
-    STORED_LONG = Solrizer::Descriptor.new(:long, :stored)
+    STORED_LONG = ActiveFedora::Indexing::Descriptor.new(:long, :stored)
 
     self.thumbnail_path_service = Hyrax::CollectionThumbnailPathService
 

data/app/indexers/hyrax/collection_with_basic_metadata_indexer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class CollectionWithBasicMetadataIndexer < CollectionIndexer
     include Hyrax::IndexesBasicMetadata

data/app/indexers/hyrax/deep_indexing_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'linkeddata' # we need all the linked data types, because we don't know what types a service might return.
 module Hyrax
   class DeepIndexingService < BasicMetadataIndexer
@@ -26,86 +27,77 @@ module Hyrax
 
     private
 
-      # Grab the labels for controlled properties from the remote sources
-      def fetch_external
-        object.controlled_properties.each do |property|
-          object[property].each do |value|
-            resource = value.respond_to?(:resource) ? value.resource : value
-            next unless resource.is_a?(ActiveTriples::Resource)
-            next if value.is_a?(ActiveFedora::Base)
-            fetch_with_persistence(resource)
-          end
+    # Grab the labels for controlled properties from the remote sources
+    def fetch_external
+      object.controlled_properties.each do |property|
+        object[property].each do |value|
+          resource = value.respond_to?(:resource) ? value.resource : value
+          next unless resource.is_a?(ActiveTriples::Resource)
+          next if value.is_a?(ActiveFedora::Base)
+          fetch_with_persistence(resource)
         end
       end
+    end
 
-      def fetch_with_persistence(resource)
-        old_label = resource.rdf_label.first
-        return unless old_label == resource.rdf_subject.to_s || old_label.nil?
-        fetch_value(resource)
-        return if old_label == resource.rdf_label.first || resource.rdf_label.first == resource.rdf_subject.to_s
-        resource.persist! # Stores the fetched values into our marmotta triplestore
-      end
-
-      def fetch_value(value)
-        Rails.logger.info "Fetching #{value.rdf_subject} from the authorative source. (this is slow)"
-        value.fetch(headers: { 'Accept'.freeze => default_accept_header })
-      rescue IOError, SocketError => e
-        # IOError could result from a 500 error on the remote server
-        # SocketError results if there is no server to connect to
-        Rails.logger.error "Unable to fetch #{value.rdf_subject} from the authorative source.\n#{e.message}"
-      end
-
-      # Stripping off the */* to work around https://github.com/rails/rails/issues/9940
-      def default_accept_header
-        RDF::Util::File::HttpAdapter.default_accept_header.sub(/, \*\/\*;q=0\.1\Z/, '')
-      end
+    def fetch_with_persistence(resource)
+      old_label = resource.rdf_label.first
+      return unless old_label == resource.rdf_subject.to_s || old_label.nil?
+      fetch_value(resource)
+      return if old_label == resource.rdf_label.first || resource.rdf_label.first == resource.rdf_subject.to_s
+      resource.persist! # Stores the fetched values into our marmotta triplestore
+    end
 
-      # Appends the uri to the default solr field and puts the label (if found) in the label solr field
-      # @param [Hash] solr_doc
-      # @param [String] solr_field_key
-      # @param [Hash] field_info
-      # @param [Array] val an array of two elements, first is a string (the uri) and the second is a hash with one key: `:label`
-      def append_label_and_uri(solr_doc, solr_field_key, field_info, val)
-        val = val.solrize
-        create_and_insert_terms_handler.create_and_insert_terms(solr_field_key,
-                                                                val.first,
-                                                                field_info.behaviors, solr_doc)
-        return unless val.last.is_a? Hash
-        create_and_insert_terms_handler.create_and_insert_terms("#{solr_field_key}_label",
-                                                                label(val),
-                                                                field_info.behaviors, solr_doc)
-      end
+    def fetch_value(value)
+      Rails.logger.info "Fetching #{value.rdf_subject} from the authorative source. (this is slow)"
+      value.fetch(headers: { 'Accept' => default_accept_header })
+    rescue IOError, SocketError => e
+      # IOError could result from a 500 error on the remote server
+      # SocketError results if there is no server to connect to
+      Rails.logger.error "Unable to fetch #{value.rdf_subject} from the authorative source.\n#{e.message}"
+    end
 
-      # Use this method to append a string value from a controlled vocabulary field
-      # to the solr document. It just puts a copy into the corresponding label field
-      # @param [Hash] solr_doc
-      # @param [String] solr_field_key
-      # @param [Hash] field_info
-      # @param [String] val
-      def append_label(solr_doc, solr_field_key, field_info, val)
-        create_and_insert_terms_handler.create_and_insert_terms(solr_field_key,
-                                                                val,
-                                                                field_info.behaviors, solr_doc)
-        create_and_insert_terms_handler.create_and_insert_terms("#{solr_field_key}_label",
-                                                                val,
-                                                                field_info.behaviors, solr_doc)
-      end
+    # Stripping off the */* to work around https://github.com/rails/rails/issues/9940
+    def default_accept_header
+      RDF::Util::File::HttpAdapter.default_accept_header.sub(/, \*\/\*;q=0\.1\Z/, '')
+    end
 
-      # Return a label for the solrized term:
-      # @example
-      #   label(["http://id.loc.gov/authorities/subjects/sh85062487", {:label=>"Hotels$http://id.loc.gov/authorities/subjects/sh85062487"}])
-      #   => 'Hotels'
-      def label(val)
-        val.last[:label].split('$').first
-      end
+    # Appends the uri to the default solr field and puts the label (if found) in the label solr field
+    # @param [Hash] solr_doc
+    # @param [String] solr_field_key
+    # @param [Hash] field_info
+    # @param [Array] val an array of two elements, first is a string (the uri) and the second is a hash with one key: `:label`
+    def append_label_and_uri(solr_doc, solr_field_key, field_info, val)
+      val = val.solrize
+      ActiveFedora::Indexing::Inserter.create_and_insert_terms(solr_field_key,
+                                                               val.first,
+                                                               field_info.behaviors, solr_doc)
+      return unless val.last.is_a? Hash
+      ActiveFedora::Indexing::Inserter.create_and_insert_terms("#{solr_field_key}_label",
+                                                               label(val),
+                                                               field_info.behaviors, solr_doc)
+    end
 
-      # create_and_insert_terms was moved to ActiveFedora::Indexing::Inserter
-      # in ActiveFedora 12. broker calls to it through here to ensure an
-      # implementation is available
-      def create_and_insert_terms_handler
-        return self.class if self.class.respond_to?(:create_and_insert_terms)
+    # Use this method to append a string value from a controlled vocabulary field
+    # to the solr document. It just puts a copy into the corresponding label field
+    # @param [Hash] solr_doc
+    # @param [String] solr_field_key
+    # @param [Hash] field_info
+    # @param [String] val
+    def append_label(solr_doc, solr_field_key, field_info, val)
+      ActiveFedora::Indexing::Inserter.create_and_insert_terms(solr_field_key,
+                                                               val,
+                                                               field_info.behaviors, solr_doc)
+      ActiveFedora::Indexing::Inserter.create_and_insert_terms("#{solr_field_key}_label",
+                                                               val,
+                                                               field_info.behaviors, solr_doc)
+    end
 
-        'ActiveFedora::Indexing::Inserter'.constantize
-      end
+    # Return a label for the solrized term:
+    # @example
+    #   label(["http://id.loc.gov/authorities/subjects/sh85062487", {:label=>"Hotels$http://id.loc.gov/authorities/subjects/sh85062487"}])
+    #   => 'Hotels'
+    def label(val)
+      val.last[:label].split('$').first
+    end
   end
 end