iiif_print 1.0.0 → 2.0.0

data/lib/iiif_print/configuration.rb

@@ -1,7 +1,38 @@
 module IiifPrint
+  # rubocop:disable Metrics/ClassLength
   class Configuration
     attr_writer :after_create_fileset_handler
 
+    attr_writer :ingest_queue_name
+    ##
+    # @return [Symbol, Proc]
+    def ingest_queue_name
+      return @ingest_queue_name if @ingest_queue_name.present?
+      if defined?(Hyrax)
+        Hyrax.config.ingest_queue_name
+      elsif defined?(Bulkrax) && Bulkrax.config.respond_to?(:ingest_queue_name)
+        Bulkrax.config.ingest_queue_name
+      else
+        :ingest
+      end
+    end
+
+    attr_writer :persistence_adapter
+    def persistence_adapter
+      @persistence_adapter || default_persistence_adapter
+    end
+
+    def default_persistence_adapter
+      # There's probably some configuration of Hyrax we could use to better refine this; but it's
+      # likely a reasonable guess.  The main goal is to not break existing implementations and
+      # maintain an upgrade path.
+      if Gem::Version.new(Hyrax::VERSION) >= Gem::Version.new('6.0.0')
+        IiifPrint::PersistenceLayer::ValkyrieAdapter
+      else
+        IiifPrint::PersistenceLayer::ActiveFedoraAdapter
+      end
+    end
+
     # @param file_set [FileSet]
     # @param user [User]
     def handle_after_create_fileset(file_set, user)
@@ -12,6 +43,17 @@ module IiifPrint
       end
     end
 
+    attr_writer :ancestory_identifier_function
+    # The function, with arity 1, that receives a work and returns it's identifier (as a string) for
+    # the purposes of object ancestry.
+    #
+    # @return [Proc]
+    def ancestory_identifier_function
+      # If the work.id is nil, keep it nil.  Otherwise cast that id to a string; to deal with the
+      # `Valkyrie::ID`.
+      @ancestory_identifier_function ||= ->(work) { work.id&.to_s }
+    end
+
     attr_writer :excluded_model_name_solr_field_values
     # By default, this uses an array of human readable types
     #   ex: ['Generic Work', 'Image']
@@ -21,6 +63,45 @@ module IiifPrint
       @excluded_model_name_solr_field_values = []
     end
 
+    def skip_splitting_pdf_files_that_end_with_these_texts=(values)
+      @skip_splitting_pdf_files_that_end_with_these_texts = Array.wrap(values).map(&:downcase)
+    end
+
+    ##
+    #   @return [Array<String>] the file suffixes (e.g. [".reader.pdf"]) that we will skip.  Per
+    #           the implementation of {.split_for_path_suffix?}, these values are cast to
+    #           downcase.
+    def skip_splitting_pdf_files_that_end_with_these_texts
+      @skip_splitting_pdf_files_that_end_with_these_texts || []
+    end
+
+    attr_writer :unique_child_title_generator_function
+
+    # The function, with keywords (though maybe you'll want to splat ignore a few), is responsible
+    # for generating the child work file title.  of object ancestry.
+    #
+    # The keyword parameters that will be passed to this function are:
+    #
+    # :original_pdf_path - The fully qualified pathname to the original PDF from which the images
+    #                      were split.
+    # :image_path - The fully qualified pathname for an image of the single page from the PDF.
+    # :parent_work - The object in which we're "attaching" the image.
+    # :page_number - The image is of the N-th page_number of the original PDF
+    # :page_padding - A helper number that indicates the number of significant digits of pages
+    #                 (e.g. 150 pages would have a padding of 3).
+    #
+    # @return [Proc]
+    # rubocop:disable Lint/UnusedBlockArgument
+    def unique_child_title_generator_function
+      @unique_child_title_generator_function ||= lambda { |original_pdf_path:, image_path:, parent_work:, page_number:, page_padding:|
+        identifier = parent_work.id
+        filename = File.basename(original_pdf_path)
+        page_suffix = "Page #{(page_number.to_i + 1).to_s.rjust(page_padding.to_i, '0')}"
+        "#{identifier} - #{filename} #{page_suffix}"
+      }
+    end
+    # rubocop:enable Lint/UnusedBlockArgument
+
     # This method wraps Hyrax's configuration so we can sniff out the correct method to use.  The
     # {Hyrax::Configuration#whitelisted_ingest_dirs} is deprecated in favor of
     # {Hyrax::Configuration#registered_ingest_dirs}.
@@ -44,7 +125,7 @@ module IiifPrint
 
     attr_writer :default_iiif_manifest_version
     def default_iiif_manifest_version
-      @default_iiif_manifest_version || 2
+      @default_iiif_manifest_version.presence || 2
     end
 
     attr_writer :metadata_fields
@@ -81,19 +162,135 @@ module IiifPrint
     end
     # rubocop:enable Metrics/MethodLength
 
+    attr_writer :additional_tesseract_options
+    ##
+    # The additional options to pass to the Tesseract configuration
+    #
+    # @see https://tesseract-ocr.github.io/tessdoc/Command-Line-Usage.html
+    # @return [String]
+    def additional_tesseract_options
+      @additional_tesseract_options || ""
+    end
+
+    attr_writer :uv_config_path
+    ##
+    # According to https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide#universal-viewer-config
+    # the name of the UV config file should be /uv/uv_config.json (with an _)
+    # However, in most applications, it is /uv/uv-config.json (with a -)
+    def uv_config_path
+      @uv_config_path || "/uv/uv-config.json"
+    end
+
+    attr_writer :uv_base_path
+    ##
+    # While we're at it, we're going to go ahead and make the base path configurable as well
+    def uv_base_path
+      @uv_base_path || "/uv/uv.html"
+    end
+
+    attr_writer :child_work_attributes_function
+    ##
+    # Here we allow for customization of the child work attributes
+    # rubocop:disable Metrics/MethodLength, Metrics/BlockLength
+    def child_work_attributes_function
+      @child_work_attributes_function ||= lambda do |parent_work:, admin_set_id:|
+        embargo = parent_work.embargo
+        lease = parent_work.lease
+        embargo_params = {}
+        lease_params = {}
+        visibility_params = {}
+
+        if embargo
+          embargo_params = {
+            visibility: 'embargo',
+            visibility_after_embargo: embargo.visibility_after_embargo,
+            visibility_during_embargo: embargo.visibility_during_embargo,
+            embargo_release_date: embargo.embargo_release_date
+          }
+        elsif lease
+          lease_params = {
+            visibility: 'lease',
+            visibility_after_lease: lease.visibility_after_lease,
+            visibility_during_lease: lease.visibility_during_lease,
+            lease_release_date: lease.lease_release_date
+          }
+        else
+          visibility_params = { visibility: parent_work.visibility.to_s }
+        end
+
+        params = {
+          admin_set_id: admin_set_id.to_s,
+          creator: parent_work.creator.to_a,
+          rights_statement: parent_work.rights_statement.to_a,
+          is_child: true
+        }
+
+        params.merge!(embargo_params).merge!(lease_params).merge!(visibility_params)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/BlockLength
+
     attr_writer :sort_iiif_manifest_canvases_by
+    ##
+    # Normally, the canvases are sorted by the `ordered_members` association.
+    # However, if you want it to be sorted by another property, you can set this
+    # configuration.  Change `nil` to something like `:title` or `:identifier`.
+    #
+    # Should you want to sort by the filename of the image, you
+    # set `nil` to `:label`.  This looks at the canvas label, which is typically set
+    # to the filename of the image.
     def sort_iiif_manifest_canvases_by
-      @sort_iiif_manifest_canvases_by || :title
+      @sort_iiif_manifest_canvases_by || nil
     end
 
-    attr_writer :additional_tessearct_options
+    attr_writer :ocr_coords_from_json_function
     ##
-    # The additional options to pass to the Tesseract configuration
+    # This is used to determine where to pull the OCR coordinates from.  By default, it will
+    # pull from the JSON file that is generated by the OCR engine.  However, if you have a
+    # different source, you can set this configuration.  Current implementation has access to
+    # the `file_set_id`` and the `document` [SolrDocument].
     #
-    # @see https://tesseract-ocr.github.io/tessdoc/Command-Line-Usage.html
-    # @return [String]
-    def additional_tessearct_options
-      @additional_tessearct_options || ""
+    # @see IiifPrint::BlacklightIiifSearch::AnnotationDecorator#fetch_and_parse_coords
+    def ocr_coords_from_json_function
+      @ocr_coords_from_json_function ||= lambda do |file_set_id:, **|
+        IiifPrint::Data::WorkDerivatives.data(from: file_set_id, of_type: 'json')
+      end
+    end
+
+    attr_writer :all_text_generator_function
+    ##
+    # This configuration determines where to pull the full text from.  By default, it will
+    # pull from the TXT file that is generated by the OCR engine.  However, if your
+    # application has its own implementation of generating the full text, then you can
+    # set your own configuration here.
+    def all_text_generator_function
+      @all_text_generator_function ||= lambda do |object:|
+        IiifPrint::Data::WorkDerivatives.data(from: object, of_type: 'txt')
+      end
+    end
+
+    attr_writer :iiif_metadata_field_presentation_order
+    ##
+    # This is the default sorter for the metadata.  It will sort by the order of the keys specificied.
+    # By default, this is turned off as it returns nil. If you want to turn it on, you can set this
+    # this to an array of symbols the properties on the work.
+    #
+    # @example [:title, :description, :date_created]
+    # @return [Array<Symbol>]
+    def iiif_metadata_field_presentation_order
+      @iiif_metadata_field_presentation_order || nil
+    end
+
+    def questioning_authority_fields=(fields)
+      @questioning_authority_fields = Array.wrap(fields).map(&:to_s)
+    end
+
+    ##
+    # This is used to explicitly set which fields should be rendered as a Questioning Authority in the UV.
+    # By default, we render `rights_statement` and `license` as QA fields.
+    def questioning_authority_fields
+      @questioning_authority_fields ||= ['rights_statement', 'license']
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/iiif_print/data/fileset_helper.rb

@@ -7,7 +7,7 @@ module IiifPrint
         # if context is itself a string, presume it is a file set id
         return @work if @work.is_a? String
         # if context is not a String, presume a work or fileset context:
-        fileset.nil? ? nil : fileset.id
+        fileset&.id
       end
 
       def first_fileset
@@ -15,9 +15,9 @@ module IiifPrint
         #   get the fileset from that id
         return FileSet.find(@work) if @work.is_a?(String)
         # if "work" context is a FileSet, not actual work, return it
-        return @work if @work.is_a? FileSet
+        return @work if @work.is_a?(Hyrax::FileSet) || @work.is_a?(FileSet)
         # in most cases, get from work's members:
-        filesets = @work.members.select { |m| m.is_a? FileSet }
+        filesets = @work.members.select { |m| m.is_a?(Hyrax::FileSet) || m.is_a?(FileSet) }
         filesets.empty? ? nil : filesets[0]
       end
     end

data/lib/iiif_print/data/work_derivatives.rb

@@ -42,16 +42,16 @@ module IiifPrint
       #
       # @return [String]
       def self.data(from:, of_type:)
-        new(from).data(of_type)
+        new(work: from).data(of_type)
       end
 
       # alternate constructor spelling:
       def self.of(work, fileset = nil, parent = nil)
-        new(work, fileset, parent)
+        new(work: work, fileset: fileset, parent: parent)
       end
 
       # Adapt work and either specific or first fileset
-      def initialize(work, fileset = nil, parent = nil)
+      def initialize(work: nil, fileset: nil, parent: nil)
         # adapted context usually work, may be string id of FileSet
         @work = work
         @fileset = fileset.nil? ? first_fileset : fileset
@@ -239,7 +239,7 @@ module IiifPrint
           #   of the first assigned file path for single-file work.
           work_file = parent
           return if work_file.nil?
-          work_files = work_file.parent
+          work_files = IiifPrint.parent_for(work_file)
           return if work_files.nil?
           work_files.assigned[0]
         else

data/lib/iiif_print/engine.rb

@@ -1,6 +1,7 @@
 require 'active_fedora'
 require 'hyrax'
 require 'blacklight_iiif_search'
+require 'derivative_rodeo'
 
 module IiifPrint
   # module constants:
@@ -10,8 +11,18 @@ module IiifPrint
   class Engine < ::Rails::Engine
     isolate_namespace IiifPrint
 
+    config.eager_load_paths += %W[#{config.root}/app/transactions]
+
+    initializer 'requires' do
+      require 'hyrax/transactions/iiif_print_container_decorator'
+      require 'iiif_print/persistence_layer'
+      require 'iiif_print/persistence_layer/active_fedora_adapter' if defined?(ActiveFedora)
+      require 'iiif_print/persistence_layer/valkyrie_adapter' if defined?(Valkyrie)
+    end
+
     # rubocop:disable Metrics/BlockLength
     config.to_prepare do
+      require "iiif_print/jobs/create_relationships_job"
       # We don't have a hard requirement of Bullkrax but in our experience, lingering on earlier
       # versions can introduce bugs of both Bulkrax and some of the assumptions that we've resolved.
       # Very early versions of Bulkrax do not have VERSION defined
@@ -35,32 +46,57 @@ module IiifPrint
         IiifPrint::PluggableDerivativeService
       )
 
+      Hyrax.publisher.subscribe(IiifPrint::Listener.new) if Hyrax.respond_to?(:publisher)
+
       Hyrax::IiifManifestPresenter.prepend(IiifPrint::IiifManifestPresenterBehavior)
       Hyrax::IiifManifestPresenter::Factory.prepend(IiifPrint::IiifManifestPresenterFactoryBehavior)
       Hyrax::ManifestBuilderService.prepend(IiifPrint::ManifestBuilderServiceBehavior)
       Hyrax::Renderers::FacetedAttributeRenderer.prepend(Hyrax::Renderers::FacetedAttributeRendererDecorator)
       Hyrax::WorksControllerBehavior.prepend(IiifPrint::WorksControllerBehaviorDecorator)
+      "Hyrax::Transactions::Steps::DeleteAllFileSets".safe_constantize&.prepend(Hyrax::Transactions::Steps::DeleteAllFileSetsDecorator)
+      # Hyku::WorksControllerBehavior was introduced in Hyku v6.0.0+.  Yes we don't depend on Hyku,
+      # but this allows us to do minimal Hyku antics with IiifPrint.
+      'Hyku::WorksControllerBehavior'.safe_constantize&.prepend(IiifPrint::WorksControllerBehaviorDecorator)
+
+      Hyrax::FileSetPresenter.prepend(IiifPrint::FileSetPresenterDecorator)
       Hyrax::WorkShowPresenter.prepend(IiifPrint::WorkShowPresenterDecorator)
+      Hyrax::IiifHelper.prepend(IiifPrint::IiifHelperDecorator)
 
-      IiifPrint::ChildIndexer.decorate_work_types!
-      IiifPrint::FileSetIndexer.decorate(Hyrax::FileSetIndexer)
+      if ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_VALKYRIE', false))
+        # Newer versions of Hyrax favor `Hyrax::Indexers::FileSetIndexer` and deprecate
+        # `Hyrax::ValkyrieFileSetIndexer`.
+        'Hyrax::Indexers::FileSetIndexer'.safe_constantize&.prepend(IiifPrint::FileSetIndexer)
 
-      ::BlacklightIiifSearch::IiifSearchResponse.prepend(IiifPrint::IiifSearchResponseDecorator)
-      ::BlacklightIiifSearch::IiifSearchAnnotation.prepend(IiifPrint::BlacklightIiifSearch::AnnotationDecorator)
-      Hyrax::Actors::FileSetActor.prepend(IiifPrint::Actors::FileSetActorDecorator)
+        # Versions 3.0+ of Hyrax have `Hyrax::ValkyrieFileSetIndexer` so we want to decorate that as
+        # well.  We want to use the elsif construct because later on Hyrax::ValkyrieFileSetIndexer
+        # inherits from Hyrax::Indexers::FileSetIndexer and only implements:
+        # `def initialize(*args); super; end`
+        'Hyrax::ValkyrieFileSetIndexer'.safe_constantize&.prepend(IiifPrint::FileSetIndexer)
 
-      # Extending the presenter to the base url which includes the protocol.
-      # We need the base url to render the facet links and normalize the interface.
-      Hyrax::IiifManifestPresenter.send(:attr_accessor, :base_url)
-      Hyrax::IiifManifestPresenter::DisplayImagePresenter.send(:attr_accessor, :base_url)
-      # Extending this class because there is an #ability= but not #ability and this definition
-      # mirrors the Hyrax::IiifManifestPresenter#ability.
-      module Hyrax::IiifManifestPresenter::DisplayImagePresenterDecorator
-        def ability
-          @ability ||= NullAbility.new
+        # Newer versions of Hyrax favor `Hyrax::Indexers::PcdmObjectIndexer` and deprecate
+        # `Hyrax::ValkyrieWorkIndexer`
+        indexers = Hyrax.config.curation_concerns.map do |concern|
+          "#{concern}ResourceIndexer".safe_constantize
         end
+        indexers.each { |indexer| indexer.prepend(IiifPrint::ChildWorkIndexer) }
+
+        # Versions 3.0+ of Hyrax have `Hyrax::ValkyrieWorkIndexer` so we want to decorate that as
+        # well.  We want to use the elsif construct because later on Hyrax::ValkyrieWorkIndexer
+        # inherits from Hyrax::Indexers::PcdmObjectIndexer and only implements:
+        # `def initialize(*args); super; end`
+        'Hyrax::ValkyrieWorkIndexer'.safe_constantize&.prepend(IiifPrint::ChildWorkIndexer)
+      else
+        # The ActiveFedora::Base indexer for FileSets
+        Hyrax::FileSetIndexer.prepend(IiifPrint::FileSetIndexer)
+        # The ActiveFedora::Base indexer for Works
+        Hyrax::WorkIndexer.prepend(IiifPrint::ChildWorkIndexer)
       end
-      Hyrax::IiifManifestPresenter::DisplayImagePresenter.prepend(Hyrax::IiifManifestPresenter::DisplayImagePresenterDecorator)
+
+      ::BlacklightIiifSearch::IiifSearchResponse.prepend(IiifPrint::IiifSearchResponseDecorator)
+      ::BlacklightIiifSearch::IiifSearchAnnotation.prepend(IiifPrint::BlacklightIiifSearch::AnnotationDecorator)
+      ::BlacklightIiifSearch::IiifSearch.prepend(IiifPrint::IiifSearchDecorator)
+      Hyrax::Actors::FileSetActor.prepend(IiifPrint::Actors::FileSetActorDecorator)
+      Hyrax::Actors::CleanupFileSetsActor.prepend(IiifPrint::Actors::CleanupFileSetsActorDecorator)
 
       Hyrax.config do |config|
         config.callback.set(:after_create_fileset) do |file_set, user|
@@ -71,6 +107,8 @@ module IiifPrint
 
     config.after_initialize do
       IiifPrint::Solr::Document.decorate(SolrDocument)
+      Hyrax::IiifManifestPresenter::DisplayImagePresenter
+        .prepend(IiifPrint::IiifManifestPresenterBehavior::DisplayImagePresenterBehavior)
     end
     # rubocop:enable Metrics/BlockLength
   end

data/lib/iiif_print/errors.rb

@@ -6,4 +6,22 @@ module IiifPrint
   # Data transformation or read-error:
   class DataError < IiifPrintError
   end
+
+  class MissingFileError < IiifPrintError
+  end
+
+  class WorkNotConfiguredToSplitFileSetError < IiifPrintError
+    def initialize(file_set:, work:)
+      message = "Expected that we would be splitting #{file_set.class} ID=#{file_set&.id} #to_param=#{file_set&.to_param} " \
+                "for work #{work.class} ID=#{work&.id} #to_param=#{work&.to_param}.  " \
+                "However it was not configured for PDF splitting."
+      super(message)
+    end
+  end
+
+  class UnexpectedMimeTypeError < IiifPrintError
+    def initialize(file_set:, mime_type:)
+      super "Unexpected mime_type #{mime_type} for #{file_set.class} ID=#{file_set.id.inspect}"
+    end
+  end
 end

data/lib/iiif_print/homepage_search_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Overrides Hyrax to add show_parents_only to processor chain
+module IiifPrint
+  class HomepageSearchBuilder < Hyrax::HomepageSearchBuilder
+    self.default_processor_chain += [:show_parents_only]
+
+    def show_parents_only(solr_parameters)
+      query = if blacklight_params["include_child_works"] == 'true'
+                IiifPrint.solr_construct_query(is_child_bsi: 'true')
+              else
+                IiifPrint.solr_construct_query(is_child_bsi: nil)
+              end
+      solr_parameters[:fq] += [query]
+    end
+  end
+end

data/lib/iiif_print/image_tool.rb

@@ -3,11 +3,10 @@ require 'tmpdir'
 
 module IiifPrint
   class ImageTool
-    attr_accessor :path, :ftype
+    attr_accessor :path
 
     def initialize(path)
       @path = path
-      @ftype = magic
       @metadata = nil
     end
 
@@ -60,7 +59,7 @@ module IiifPrint
     end
 
     def im_line_select(lines, key)
-      line = lines.find { |l| l.scrub.downcase.strip.start_with?(key) }
+      line = lines.find { |l| l.scrub.downcase.strip.start_with?(key.downcase) }
       # Given "key: value" line, return the value as String stripped of
       #   leading and trailing whitespace
       return line if line.nil?
@@ -75,20 +74,25 @@ module IiifPrint
 
     # @return [Array<String>] lines of output from imagemagick `identify`
     def im_identify
-      cmd = "identify -verbose #{path}"
+      cmd = "identify -format 'Geometry: %G\nDepth: %[bit-depth]\nColorspace: %[colorspace]\nAlpha: %A\nMIME type: %m\n' #{path}"
       `#{cmd}`.lines
     end
 
     def im_mime(lines)
       return 'application/pdf' if pdf? # workaround older imagemagick bug
-      im_line_select(lines, 'mime type')
+
+      format = im_line_select(lines, 'mime type')
+      return if format.blank?
+
+      # `identify -format` with the `%m` switch only gives the format, we are coercing it into an image mime type
+      Mime::Type.lookup_by_extension(format.downcase).to_s
     end
 
     def populate_im_color!(lines, result)
       bpc = im_line_select(lines, 'depth').split('-')[0].to_i # '1-bit' -> 1
       colorspace = im_line_select(lines, 'colorspace')
       color = colorspace == 'Gray' ? 'gray' : 'color'
-      has_alpha = !im_line_select(lines, 'Alpha').nil?
+      has_alpha = !im_line_select(lines, 'alpha') == 'Undefined'
       result[:num_components] = (color == 'gray' ? 1 : 3) + (has_alpha ? 1 : 0)
       result[:color] = bpc == 1 ? 'monochrome' : color
       result[:bits_per_component] = bpc
@@ -105,11 +109,11 @@ module IiifPrint
     end
 
     def magic
-      File.read(@path, 23, 0)
+      @magic ||= File.read(@path, 23, 0)
     end
 
     def jp2?
-      @ftype.end_with?('ftypjp2')
+      magic.end_with?('ftypjp2')
     end
 
     def pdf?

data/lib/iiif_print/jp2_derivative_service.rb

@@ -53,7 +53,10 @@ module IiifPrint
       render_cmd = opj_command
 
       # Run the generated command to make derivative file at @dest_path
-      `#{render_cmd}`
+      data = `#{render_cmd}`
+
+      # Create Hyrax::FileMetadata object for the derivatives (if Valkyrie)
+      IiifPrint.copy_derivatives_from_data_store(stream: data, directives: { url: file_set.id.to_s, container: 'service_file', mime_type: mime_type_for(target_extension) })
 
       # Clean up any intermediate files or symlinks used during creation
       cleanup_intermediate

data/lib/iiif_print/lineage_service.rb

@@ -2,7 +2,8 @@ module IiifPrint
   # The purpose of this module is to encode lineage related services:
   #
   # - {.ancestor_ids_for}
-  # - {.descendent_file_set_ids_for}
+  # - {.descendent_member_ids_for}
+  # - {.ancestor_identifier_for}
   #
   # The ancestor and descendent_file_sets are useful for ensuring we index together related items.
   # For example, when I have a work that is a book, and one file set per page of that book, when I
@@ -15,27 +16,60 @@ module IiifPrint
     #
     # @param object [#in_works] An object that responds to #in_works
     # @return [Array<String>]
+    #
+    # @note For those implementing their own lineage service, verify that you are not returning
+    #       an array of
     def self.ancestor_ids_for(object)
       ancestor_ids ||= []
-      object.in_works.each do |work|
-        ancestor_ids << work.id
-        ancestor_ids += ancestor_ids_for(work) if work.is_child
+      # Yes, we're fetching the works, then compressing those into identifiers.  Because in the case
+      # of slugs, we need not the identifier, but the slug as the id.
+      IiifPrint.object_in_works(object).each do |work|
+        ancestor_ids << ancestry_identifier_for(work)
+        ancestor_ids += ancestor_ids_for(work) if work.respond_to?(:is_child) && work.is_child
       end
-      ancestor_ids.flatten.compact.uniq
+      # We must convert these to strings as Valkyrie's identifiers will be cast to hashes when we
+      # attempt to write the SolrDocument.  Also, per documentation we return an Array of strings, not
+      # an Array that might include Valkyrie::ID objects.
+      ancestor_ids.flatten.compact.uniq.map(&:to_s)
+    end
+
+    ##
+    # @api public
+    #
+    # Given the :work return it's identifier
+    #
+    # @param [Object]
+    # @return [String]
+    def self.ancestry_identifier_for(work)
+      IiifPrint.config.ancestory_identifier_function.call(work)
     end
 
     ##
     # @param object [#ordered_works, #file_sets, #member_ids]
-    # @return [Array<String>] the ids of associated file sets
-    def self.descendent_file_set_ids_for(object)
+    # @return [Array<String>] the ids of associated file sets and child works
+    #
+    # @see
+    # https://github.com/samvera/hyrax/blob/2b807fe101176d594129ef8a8fe466d3d03a372b/app/indexers/hyrax/work_indexer.rb#L15-L18
+    # for "clarification" of the comingling of file_set_ids and member_ids
+    def self.descendent_member_ids_for(object)
+      return unless object.respond_to?(:member_ids)
+
       # enables us to return parents when searching for child OCR
-      file_set_ids = object.file_sets.map(&:id)
-      object.ordered_works&.each do |child|
-        file_set_ids += descendent_file_set_ids_for(child)
+      #
+      # https://github.com/samvera/hydra-works/blob/c9b9dd0cf11de671920ba0a7161db68ccf9b7f6d/lib/hydra/works/models/concerns/work_behavior.rb#L90-L92
+      #
+      # The Hydara::Works implementation of file_set_ids is "members.select(&:file_set?).map(&:id)";
+      # so no sense doing `object.file_set_ids + object.member_ids`
+      file_set_ids = object.member_ids
+      IiifPrint.object_ordered_works(object)&.each do |child|
+        file_set_ids += Array.wrap(descendent_member_ids_for(child))
       end
-      # enables us to return parents when searching for child metadata
-      file_set_ids += object.member_ids
-      file_set_ids.flatten.uniq.compact
+      # We must convert these to strings as Valkyrie's identifiers will be cast to hashes when we
+      # attempt to write the SolrDocument.
+      file_set_ids.flatten.uniq.compact.map(&:to_s)
+    end
+    class << self
+      alias descendent_file_set_ids_for descendent_member_ids_for
     end
   end
 end