Merge pull request #6441 from samvera/refactor_indexers

Refactor Valkyrie indexer API (to match forms)

app/indexers/hyrax/permission_indexer.rb → app/indexers/concerns/hyrax/permission_indexer.rb

@@ -6,7 +6,7 @@ module Hyrax
   # permissions being up-to-date in the index to support `Hyrax::Ability`.
   #
   # @example
-  #   class MyIndexer < Hyrax::ValkyrieIndexer
+  #   class MyIndexer < Hyrax::Indexers::ResourceIndexer
   #     include Hyrax::PermissionIndexer
   #   end
   module PermissionIndexer

app/indexers/hyrax/visibility_indexer.rb → app/indexers/concerns/hyrax/visibility_indexer.rb

@@ -7,7 +7,7 @@ module Hyrax
   # views.
   #
   # @example
-  #   class MyIndexer < Hyrax::ValkyrieIndexer
+  #   class MyIndexer < Hyrax::Indexers::ResourceIndexer
   #     include Hyrax::VisibilityIndexer
   #   end
   module VisibilityIndexer

app/indexers/hyrax/administrative_set_indexer.rb

@@ -2,23 +2,11 @@
 
 module Hyrax
   ##
-  # Indexes Hyrax::AdministrativeSet objects
-  class AdministrativeSetIndexer < Hyrax::ValkyrieIndexer
-    include Hyrax::ResourceIndexer
-    include Hyrax::PermissionIndexer
-    include Hyrax::VisibilityIndexer
-    include Hyrax::Indexer(:core_metadata)
-
-    def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-      super.tap do |solr_doc|
-        solr_doc[Hyrax.config.collection_type_index_field.to_sym] = Array(resource.try(:collection_type_gid)&.to_s)
-        solr_doc[:alternative_title_tesim] = resource.alternative_title
-        solr_doc[:creator_ssim]            = [resource.creator]
-        solr_doc[:creator_tesim]           = [resource.creator]
-        solr_doc[:description_tesim]       = resource.description
-        solr_doc[:generic_type_sim]        = ['Admin Set']
-        solr_doc[:thumbnail_path_ss]       = Hyrax::CollectionThumbnailPathService.call(resource)
-      end
+  # @deprecated use +Hyrax::Indexers::AdministrativeSetIndexer+ instead
+  class AdministrativeSetIndexer < Hyrax::Indexers::AdministrativeSetIndexer
+    def initialize(*args, **kwargs)
+      Deprecation.warn "`Hyrax::AdministrativeSetIndexer` is deprecated. Use `Hyrax::Indexers::AdministrativeSetIndexer` instead."
+      super
     end
   end
 end

app/indexers/hyrax/indexers/administrative_set_indexer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Indexers
+    ##
+    # Indexes Hyrax::AdministrativeSet objects
+    class AdministrativeSetIndexer < Hyrax::Indexers::ResourceIndexer
+      include Hyrax::PermissionIndexer
+      include Hyrax::VisibilityIndexer
+      include Hyrax::Indexer(:core_metadata)
+
+      def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        super.tap do |solr_doc|
+          solr_doc[Hyrax.config.collection_type_index_field.to_sym] = Array(resource.try(:collection_type_gid)&.to_s)
+          solr_doc[:alternative_title_tesim] = resource.alternative_title
+          solr_doc[:creator_ssim]            = [resource.creator]
+          solr_doc[:creator_tesim]           = [resource.creator]
+          solr_doc[:description_tesim]       = resource.description
+          solr_doc[:generic_type_sim]        = ['Admin Set']
+          solr_doc[:thumbnail_path_ss]       = Hyrax::CollectionThumbnailPathService.call(resource)
+        end
+      end
+    end
+  end
+end

app/indexers/hyrax/indexers/file_set_indexer.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Indexers
+    ##
+    # Indexes Hyrax::FileSet objects
+    class FileSetIndexer < Hyrax::Indexers::ResourceIndexer # rubocop:disable Metrics/ClassLength
+      include Hyrax::PermissionIndexer
+      include Hyrax::VisibilityIndexer
+      include Hyrax::ThumbnailIndexer
+      include Hyrax::Indexer(:core_metadata)
+      include Hyrax::Indexer(:file_set_metadata)
+
+      def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+        super.tap do |solr_doc| # rubocop:disable Metrics/BlockLength
+          solr_doc['generic_type_si'] = 'FileSet'
+
+          # Metadata from the FileSet
+          solr_doc['file_ids_ssim']                = resource.file_ids&.map(&:to_s)
+          solr_doc['original_file_id_ssi']         = resource.iiif_id
+          solr_doc['extracted_text_id_ssi']        = resource.extracted_text_id.to_s
+          solr_doc['hasRelatedMediaFragment_ssim'] = resource.representative_id.to_s
+          solr_doc['hasRelatedImage_ssim']         = resource.thumbnail_id.to_s
+
+          index_lease(solr_doc)
+          index_embargo(solr_doc)
+
+          # Add in metadata from the primary file.
+          file_metadata = Hyrax.config.file_set_file_service.new(file_set: resource).primary_file
+          return solr_doc unless file_metadata
+
+          # Label is the actual file name. It's not editable by the user.
+          solr_doc['original_file_alternate_ids_tesim'] = file_metadata.alternate_ids&.map(&:to_s) if file_metadata.alternate_ids.present?
+
+          solr_doc['original_filename_tesi']  = file_metadata.original_filename if file_metadata.original_filename.present?
+          solr_doc['original_filename_ssi']   = file_metadata.original_filename if file_metadata.original_filename.present?
+          solr_doc['mime_type_tesi']          = file_metadata.mime_type if file_metadata.mime_type.present?
+          solr_doc['mime_type_ssi']           = file_metadata.mime_type if file_metadata.mime_type.present?
+
+          solr_doc['file_format_tesim']       = file_format(file_metadata)
+          solr_doc['file_format_sim']         = file_format(file_metadata)
+          solr_doc['file_size_lts']           = file_metadata.recorded_size[0]
+          solr_doc['type_tesim']              = file_metadata.pcdm_use.map(&:to_s) if file_metadata.pcdm_use.present?
+          solr_doc['pcdm_use_tesim'] = file_metadata.pcdm_use.map(&:to_s) if file_metadata.pcdm_use.present?
+
+          # attributes set by fits
+          solr_doc['format_label_tesim']      = file_metadata.format_label if file_metadata.format_label.present?
+          solr_doc['size_tesim']              = file_metadata.recorded_size if file_metadata.recorded_size.present?
+          solr_doc['well_formed_tesim']       = file_metadata.well_formed if file_metadata.well_formed.present?
+          solr_doc['valid_tesim']             = file_metadata.valid if file_metadata.valid.present?
+          solr_doc['fits_version_tesim']      = file_metadata.fits_version if file_metadata.fits_version.present?
+          solr_doc['exif_version_tesim']      = file_metadata.exif_version if file_metadata.exif_version.present?
+          solr_doc['checksum_tesim']          = file_metadata.checksum if file_metadata.checksum.present?
+
+          # shared attributes across multiple file types
+          solr_doc['frame_rate_tesim']        = file_metadata.frame_rate if file_metadata.frame_rate.present? # audio, video
+          solr_doc['bit_rate_tesim']          = file_metadata.bit_rate if file_metadata.bit_rate.present? # audio, video
+          solr_doc['duration_tesim']          = file_metadata.duration if file_metadata.duration.present? # audio, video
+          solr_doc['sample_rate_tesim']       = file_metadata.sample_rate if file_metadata.sample_rate.present? # audio, video
+
+          solr_doc['height_tesim']            = file_metadata.height if file_metadata.height.present? # image, video
+          solr_doc['width_tesim']             = file_metadata.width if file_metadata.width.present? # image, video
+          solr_doc['height_is']               = Integer(file_metadata.height.first) if file_metadata.height.present?
+          solr_doc['width_is']                = Integer(file_metadata.width.first) if file_metadata.width.present?
+
+          # attributes set by fits for audio files
+          solr_doc['bit_depth_tesim']         = file_metadata.bit_depth if file_metadata.bit_depth.present?
+          solr_doc['channels_tesim']          = file_metadata.channels if file_metadata.channels.present?
+          solr_doc['alpha_channels_ssi']      = file_metadata.channels.first if file_metadata.channels.present?
+          solr_doc['data_format_tesim']       = file_metadata.data_format if file_metadata.data_format.present?
+          solr_doc['offset_tesim']            = file_metadata.offset if file_metadata.offset.present?
+
+          # attributes set by fits for documents
+          solr_doc['file_title_tesim']        = file_metadata.file_title if file_metadata.file_title.present?
+          solr_doc['page_count_tesim']        = file_metadata.page_count if file_metadata.page_count.present?
+          solr_doc['language_tesim']          = file_metadata.language if file_metadata.language.present?
+          solr_doc['word_count_tesim']        = file_metadata.word_count if file_metadata.word_count.present?
+          solr_doc['character_count_tesim']   = file_metadata.character_count if file_metadata.character_count.present?
+          solr_doc['line_count_tesim']        = file_metadata.line_count if file_metadata.line_count.present?
+          solr_doc['character_set_tesim']     = file_metadata.character_set if file_metadata.character_set.present?
+          solr_doc['markup_basis_tesim']      = file_metadata.markup_basis if file_metadata.markup_basis.present?
+          solr_doc['paragraph_count_tesim']   = file_metadata.paragraph_count if file_metadata.paragraph_count.present?
+          solr_doc['markup_language_tesim']   = file_metadata.markup_language if file_metadata.markup_language.present?
+          solr_doc['table_count_tesim']       = file_metadata.table_count if file_metadata.table_count.present?
+          solr_doc['graphics_count_tesim']    = file_metadata.graphics_count if file_metadata.graphics_count.present?
+
+          # attributes set by fits for images
+          solr_doc['byte_order_tesim']        = file_metadata.byte_order if file_metadata.byte_order.present?
+          solr_doc['compression_tesim']       = file_metadata.compression if file_metadata.compression.present?
+          solr_doc['color_space_tesim']       = file_metadata.color_space if file_metadata.color_space.present?
+          solr_doc['profile_name_tesim']      = file_metadata.profile_name if file_metadata.profile_name.present?
+          solr_doc['profile_version_tesim']   = file_metadata.profile_version if file_metadata.profile_version.present?
+          solr_doc['orientation_tesim']       = file_metadata.orientation if file_metadata.orientation.present?
+          solr_doc['color_map_tesim']         = file_metadata.color_map if file_metadata.color_map.present?
+          solr_doc['image_producer_tesim']    = file_metadata.image_producer if file_metadata.image_producer.present?
+          solr_doc['capture_device_tesim']    = file_metadata.capture_device if file_metadata.capture_device.present?
+          solr_doc['scanning_software_tesim'] = file_metadata.scanning_software if file_metadata.scanning_software.present?
+          solr_doc['gps_timestamp_tesim']     = file_metadata.gps_timestamp if file_metadata.gps_timestamp.present?
+          solr_doc['latitude_tesim']          = file_metadata.latitude if file_metadata.latitude.present?
+          solr_doc['longitude_tesim']         = file_metadata.longitude if file_metadata.longitude.present?
+
+          # attributes set by fits for video
+          solr_doc['aspect_ratio_tesim']      = file_metadata.aspect_ratio if file_metadata.aspect_ratio.present?
+        end
+      end
+
+      private
+
+      def file_format(file)
+        if file.mime_type.present? && file.format_label.present?
+          "#{file.mime_type.split('/').last} (#{file.format_label.join(', ')})"
+        elsif file.mime_type.present?
+          file.mime_type.split('/').last
+        elsif file.format_label.present?
+          file.format_label
+        end
+      end
+
+      def index_lease(doc)
+        if resource.lease&.active?
+          doc['lease_expiration_date_dtsi'] = resource.lease.lease_expiration_date&.to_datetime
+          doc['visibility_after_lease_ssim'] = resource.lease.visibility_after_lease
+          doc['visibility_during_lease_ssim'] = resource.lease.visibility_during_lease
+        else
+          doc['lease_history_ssim'] = resource&.lease&.lease_history
+        end
+
+        doc
+      end
+
+      def index_embargo(doc)
+        if resource.embargo&.active?
+          doc['embargo_release_date_dtsi'] = resource.embargo.embargo_release_date&.to_datetime
+          doc['visibility_after_embargo_ssim'] = resource.embargo.visibility_after_embargo
+          doc['visibility_during_embargo_ssim'] = resource.embargo.visibility_during_embargo
+        else
+          doc['embargo_history_ssim'] = resource&.embargo&.embargo_history
+        end
+
+        doc
+      end
+    end
+  end
+end

app/indexers/hyrax/indexers/pcdm_collection_indexer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Indexers
+    ##
+    # Indexes properties common to PCDM Collections
+    class PcdmCollectionIndexer < Hyrax::Indexers::ResourceIndexer
+      include Hyrax::PermissionIndexer
+      include Hyrax::VisibilityIndexer
+      include Hyrax::LocationIndexer
+      include Hyrax::ThumbnailIndexer
+      include Hyrax::Indexer(:core_metadata)
+
+      self.thumbnail_path_service = CollectionThumbnailPathService
+
+      def to_solr
+        super.tap do |index_document|
+          index_document[Hyrax.config.collection_type_index_field.to_sym] = Array(resource.try(:collection_type_gid)&.to_s)
+          index_document[:generic_type_sim] = ['Collection']
+          index_document[:member_of_collection_ids_ssim] = resource.member_of_collection_ids.map(&:to_s)
+          index_document[:depositor_ssim] = [resource.depositor]
+          index_document[:depositor_tesim] = [resource.depositor]
+        end
+      end
+    end
+  end
+end

app/indexers/hyrax/indexers/pcdm_object_indexer.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Indexers
+    ##
+    # Provides a model‐specific subclass for
+    # +Hyrax::Indexers::PcdmObjectIndexer+.
+    #
+    # The base Hyrax engine could get on without this, but it’s useful for
+    # downstream applications and reflects what we do for forms.
+    def self.PcdmObjectIndexer(work_class)
+      Class.new(Hyrax::Indexers::PcdmObjectIndexer) do
+        @model_class = work_class
+
+        class << self
+          attr_reader :model_class
+
+          ##
+          # @return [String]
+          def inspect
+            return "Hyrax::Indexers::PcdmObjectIndexer(#{model_class})" if name.blank?
+            super
+          end
+        end
+      end
+    end
+
+    ##
+    # Indexes non‐fileset PCDM objects
+    class PcdmObjectIndexer < Hyrax::Indexers::ResourceIndexer
+      include Hyrax::PermissionIndexer
+      include Hyrax::VisibilityIndexer
+      include Hyrax::LocationIndexer
+      include Hyrax::ThumbnailIndexer
+      include Hyrax::Indexer(:core_metadata)
+
+      def to_solr # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        super.tap do |solr_doc|
+          solr_doc['generic_type_si'] = 'Work'
+          solr_doc['suppressed_bsi'] = suppressed?(resource)
+          solr_doc['admin_set_id_ssim'] = [resource.admin_set_id.to_s]
+          admin_set_label = admin_set_label(resource)
+          solr_doc['admin_set_sim']   = admin_set_label
+          solr_doc['admin_set_tesim'] = admin_set_label
+          solr_doc["#{Hyrax.config.admin_set_predicate.qname.last}_ssim"] = [resource.admin_set_id.to_s]
+          solr_doc['member_of_collection_ids_ssim'] = resource.member_of_collection_ids.map(&:to_s)
+          solr_doc['member_ids_ssim'] = resource.member_ids.map(&:to_s)
+          solr_doc['depositor_ssim'] = [resource.depositor]
+          solr_doc['depositor_tesim'] = [resource.depositor]
+          solr_doc['hasRelatedMediaFragment_ssim'] = [resource.representative_id.to_s]
+          solr_doc['hasRelatedImage_ssim'] = [resource.thumbnail_id.to_s]
+          solr_doc['hasFormat_ssim'] = resource.rendering_ids.map(&:to_s) if resource.rendering_ids.present?
+          index_embargo(solr_doc)
+          index_lease(solr_doc)
+        end
+      end
+
+      private
+
+      def suppressed?(resource)
+        Hyrax::ResourceStatus.new(resource: resource).inactive?
+      end
+
+      def admin_set_label(resource)
+        return if resource.admin_set_id.blank?
+        admin_set = Hyrax.query_service.find_by(id: resource.admin_set_id)
+        admin_set.title
+      end
+
+      def index_embargo(doc)
+        if resource.embargo&.active?
+          doc['embargo_release_date_dtsi'] = resource.embargo.embargo_release_date&.to_datetime
+          doc['visibility_after_embargo_ssim'] = resource.embargo.visibility_after_embargo
+          doc['visibility_during_embargo_ssim'] = resource.embargo.visibility_during_embargo
+        else
+          doc['embargo_history_ssim'] = resource&.embargo&.embargo_history
+        end
+
+        doc
+      end
+
+      def index_lease(doc)
+        if resource.lease&.active?
+          doc['lease_expiration_date_dtsi'] = resource.lease.lease_expiration_date&.to_datetime
+          doc['visibility_after_lease_ssim'] = resource.lease.visibility_after_lease
+          doc['visibility_during_lease_ssim'] = resource.lease.visibility_during_lease
+        else
+          doc['lease_history_ssim'] = resource&.lease&.lease_history
+        end
+
+        doc
+      end
+    end
+  end
+end