hyrax 2.6.0 → 2.9.0

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/indexers/hyrax/collection_indexer.rb

@@ -11,9 +11,7 @@ module Hyrax
     def generate_solr_document
       super.tap do |solr_doc|
         # Makes Collections show under the "Collections" tab
-        Solrizer.set_field(solr_doc, 'generic_type', 'Collection', :facetable)
-        # Index the size of the collection in bytes
-        solr_doc[Solrizer.solr_name(:bytes, STORED_LONG)] = object.bytes
+        solr_doc['generic_type_sim'] = ["Collection"]
         solr_doc['visibility_ssi'] = object.visibility
 
         object.in_collections.each do |col|

data/app/indexers/hyrax/deep_indexing_service.rb

@@ -67,13 +67,13 @@ module Hyrax
       # @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
-        self.class.create_and_insert_terms(solr_field_key,
-                                           val.first,
-                                           field_info.behaviors, solr_doc)
+        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
-        self.class.create_and_insert_terms("#{solr_field_key}_label",
-                                           label(val),
-                                           field_info.behaviors, solr_doc)
+        create_and_insert_terms_handler.create_and_insert_terms("#{solr_field_key}_label",
+                                                                label(val),
+                                                                field_info.behaviors, solr_doc)
       end
 
       # Use this method to append a string value from a controlled vocabulary field
@@ -83,12 +83,12 @@ module Hyrax
       # @param [Hash] field_info
       # @param [String] val
       def append_label(solr_doc, solr_field_key, field_info, val)
-        self.class.create_and_insert_terms(solr_field_key,
-                                           val,
-                                           field_info.behaviors, solr_doc)
-        self.class.create_and_insert_terms("#{solr_field_key}_label",
-                                           val,
-                                           field_info.behaviors, solr_doc)
+        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
 
       # Return a label for the solrized term:
@@ -98,5 +98,14 @@ module Hyrax
       def label(val)
         val.last[:label].split('$').first
       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)
+
+        'ActiveFedora::Indexing::Inserter'.constantize
+      end
   end
 end

data/app/indexers/hyrax/file_set_indexer.rb

@@ -27,6 +27,7 @@ module Hyrax
         solr_doc['duration_tesim']          = object.duration
         solr_doc['sample_rate_tesim']       = object.sample_rate
         solr_doc['original_checksum_tesim'] = object.original_checksum
+        solr_doc['alpha_channels_ssi']      = object.try(:alpha_channels)
         solr_doc['original_file_id_ssi']    = original_file_id
       end
     end
@@ -40,7 +41,11 @@ module Hyrax
 
       def original_file_id
         return unless object.original_file
-        object.original_file.id
+        if object.original_file.versions.present?
+          ActiveFedora::File.uri_to_id(object.current_content_version_uri)
+        else
+          object.original_file.id
+        end
       end
 
       def file_format

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/collection_behavior.rb

@@ -93,25 +93,15 @@ module Hyrax
       end
     end
 
-    # Compute the sum of each file in the collection using Solr to
-    # avoid having to access Fedora
-    #
-    # @return [Fixnum] size of collection in bytes
-    # @raise [RuntimeError] unsaved record does not exist in solr
+    # @deprecated to be removed in 4.0.0; this feature was replaced with a
+    #   hard-coded null implementation
+    # @return [Fixnum] 0
     def bytes
-      return 0 if member_object_ids.empty?
-
-      raise "Collection must be saved to query for bytes" if new_record?
-
-      # One query per member_id because Solr is not a relational database
-      member_object_ids.collect { |work_id| size_for_work(work_id) }.sum
-    end
-
-    # Use this query to get the ids of the member objects (since the containment
-    # association has been flipped)
-    def member_object_ids
-      return [] unless id
-      ActiveFedora::Base.search_with_conditions("member_of_collection_ids_ssim:#{id}").map(&:id)
+      Deprecation.warn('#bytes has been deprecated for removal in Hyrax 4.0.0; ' \
+                       'The implementation of the indexed Collection size ' \
+                       'feature is extremely inefficient, so it has been removed. ' \
+                       'This method now returns a hard-coded `0` for compatibility.')
+      0
     end
 
     # @api public
@@ -158,22 +148,6 @@ module Hyrax
         []
       end
 
-      # Calculate the size of all the files in the work
-      # @param work_id [String] identifer for a work
-      # @return [Integer] the size in bytes
-      def size_for_work(work_id)
-        argz = { fl: "id, #{file_size_field}",
-                 fq: "{!join from=#{member_ids_field} to=id}id:#{work_id}" }
-        files = ::FileSet.search_with_conditions({}, argz)
-        files.reduce(0) { |sum, f| sum + f[file_size_field].to_i }
-      end
-
-      # Field name to look up when locating the size of each file in Solr.
-      # Override for your own installation if using something different
-      def file_size_field
-        Solrizer.solr_name(:file_size, Hyrax::FileSetIndexer::STORED_LONG)
-      end
-
       # Solr field name works use to index member ids
       def member_ids_field
         Solrizer.solr_name('member_ids', :symbol)

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

@@ -99,7 +99,11 @@ module Hyrax
       end
 
       def original_checksum
-        self[Solrizer.solr_name("original_checksum")]
+        self["original_checksum_tesim"]
+      end
+
+      def alpha_channels
+        self["alpha_channels_ssi"]
       end
     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')
@@ -75,14 +76,15 @@ module Hyrax
         attribute :rendering_ids, Solr::Array, solr_name(Hyrax.config.rendering_predicate.value.split(/#|\/|,/).last, :symbol)
         attribute :thumbnail_id, Solr::String, solr_name('hasRelatedImage', :symbol)
         attribute :thumbnail_path, Solr::String, CatalogController.blacklight_config.index.thumbnail_field
-        attribute :label, Solr::String, solr_name('label')
-        attribute :file_format, Solr::String, solr_name('file_format')
-        attribute :suppressed?, Solr::String, solr_name('suppressed', Solrizer::Descriptor.new(:boolean, :stored, :indexed))
 
-        attribute :date_modified, Solr::Date, solr_name('date_modified', :stored_sortable, type: :date)
-        attribute :date_uploaded, Solr::Date, solr_name('date_uploaded', :stored_sortable, type: :date)
-        attribute :create_date, Solr::Date, solr_name('system_create', :stored_sortable, type: :date)
-        attribute :modified_date, Solr::Date, solr_name('system_modified', :stored_sortable, type: :date)
+        attribute :label, Solr::String, "label_tesim"
+        attribute :file_format, Solr::String, "file_format_tesim"
+        attribute :suppressed?, Solr::String, "suppressed_bsi"
+        attribute :original_file_id, Solr::String, "original_file_id_ssi"
+        attribute :date_modified, Solr::Date, "date_modified_dtsi"
+        attribute :date_uploaded, Solr::Date, "date_uploaded_dtsi"
+        attribute :create_date, Solr::Date, "system_create_dtsi"
+        attribute :modified_date, Solr::Date, "system_modified_dtsi"
         attribute :embargo_release_date, Solr::Date, Hydra.config.permissions.embargo.release_date
         attribute :lease_expiration_date, Solr::Date, Hydra.config.permissions.lease.expiration_date
       end

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/models/hyrax/uploaded_file.rb

@@ -10,7 +10,5 @@ module Hyrax
              class_name: 'JobIoWrapper',
              dependent: :destroy
     belongs_to :user, class_name: '::User'
-
-    before_destroy :remove_file!
   end
 end

data/app/presenters/hyrax/collection_presenter.rb

@@ -49,6 +49,9 @@ module Hyrax
       self.class.terms.select { |t| self[t].present? }
     end
 
+    ##
+    # @param [Symbol] key
+    # @return [Object]
     def [](key)
       case key
       when :size
@@ -60,8 +63,16 @@ module Hyrax
       end
     end
 
+    # @deprecated to be removed in 4.0.0; this feature was replaced with a
+    #   hard-coded null implementation
+    # @return [String] 'unknown'
     def size
-      number_to_human_size(@solr_document['bytes_lts'])
+      Deprecation.warn('#size has been deprecated for removal in Hyrax 4.0.0; ' \
+                       'The implementation of the indexed Collection size ' \
+                       'feature is extremely inefficient, so it has been removed. ' \
+                       'This method now returns a hard-coded `"unknown"` for ' \
+                       'compatibility.')
+      'unknown'
     end
 
     def total_items

data/app/presenters/hyrax/displays_image.rb

@@ -10,30 +10,56 @@ module Hyrax
     #
     # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
     def display_image
-      return nil unless ::FileSet.exists?(id) && solr_document.image? && current_ability.can?(:read, id)
-      # @todo this is slow, find a better way (perhaps index iiif url):
-      original_file = ::FileSet.find(id).original_file
-
-      url = Hyrax.config.iiif_image_url_builder.call(
-        original_file.id,
-        request.base_url,
-        Hyrax.config.iiif_image_size_default
-      )
+      return nil unless solr_document.image? && current_ability.can?(:read, solr_document)
+      return nil unless latest_file_id
+
       # @see https://github.com/samvera-labs/iiif_manifest
-      IIIFManifest::DisplayImage.new(url,
-                                     width: 640,
-                                     height: 480,
-                                     iiif_endpoint: iiif_endpoint(original_file.id))
+      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))
     end
 
     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'
+      end
+
+      def unindexed_current_file_version
+        Rails.logger.warn "Indexed current_file_version for #{id} not found, falling back to Fedora."
+        ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
+      end
+
+      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/file_set_presenter.rb

@@ -30,8 +30,13 @@ module Hyrax
              :embargo_release_date, :lease_expiration_date,
              :depositor, :keyword, :title_or_label, :keyword,
              :date_created, :date_modified, :itemtype,
+             :original_file_id,
              to: :solr_document
 
+    def alpha_channels
+      []
+    end
+
     def single_use_links
       @single_use_links ||= SingleUseLink.where(itemId: id).map { |link| link_presenter_class.new(link) }
     end