iiif_print 1.1.0 → 2.0.0

data/db/migrate/20190107165909_create_iiif_print_ingest_file_relations.rb

@@ -1,11 +1,13 @@
 class CreateIiifPrintIngestFileRelations < ActiveRecord::Migration[5.0]
   def change
-    create_table :iiif_print_ingest_file_relations do |t|
-      t.string :file_path
-      t.string :derivative_path
+    unless table_exists?(:iiif_print_ingest_file_relations)
+      create_table :iiif_print_ingest_file_relations do |t|
+        t.string :file_path
+        t.string :derivative_path
 
-      t.timestamps
+        t.timestamps
+      end
+      add_index :iiif_print_ingest_file_relations, :file_path
     end
-    add_index :iiif_print_ingest_file_relations, :file_path
   end
 end

data/db/migrate/20230109000000_create_iiif_print_pending_relationships.rb

@@ -1,11 +1,13 @@
 class CreateIiifPrintPendingRelationships < ActiveRecord::Migration[5.1]
   def change
-    create_table :iiif_print_pending_relationships do |t|
-      t.string :child_title, null: false
-      t.string :parent_id, null: false
-      t.string :child_order, null: false
-      t.timestamps
+    unless table_exists?(:iiif_print_pending_relationships)
+      create_table :iiif_print_pending_relationships do |t|
+        t.string :child_title, null: false
+        t.string :parent_id, null: false
+        t.string :child_order, null: false
+        t.timestamps
+      end
+      add_index :iiif_print_pending_relationships, :parent_id
     end
-    add_index :iiif_print_pending_relationships, :parent_id
   end
 end

data/db/migrate/20231110163052_add_model_details_to_iiif_print_pending_relationships.rb

@@ -1,7 +1,7 @@
 class AddModelDetailsToIiifPrintPendingRelationships < ActiveRecord::Migration[5.2]
   def change
-    add_column :iiif_print_pending_relationships, :parent_model, :string
-    add_column :iiif_print_pending_relationships, :child_model, :string
-    add_column :iiif_print_pending_relationships, :file_id, :string
+    add_column :iiif_print_pending_relationships, :parent_model, :string unless column_exists?(:iiif_print_pending_relationships, :parent_model)
+    add_column :iiif_print_pending_relationships, :child_model, :string  unless column_exists?(:iiif_print_pending_relationships, :child_model)
+    add_column :iiif_print_pending_relationships, :file_id, :string  unless column_exists?(:iiif_print_pending_relationships, :file_id)
   end
 end

data/iiif_print.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   IiifPrint is a gem (Rails "engine") for Hyrax-based digital repository applications to support displaying parent/child works in the same viewer (Universal Viewer) and the ability to search OCR from the parent work to the child work(s). IiifPring was originally based off of the samvera-labs Newspaper gem.
 SUMMARY
   spec.license = 'Apache-2.0'
-  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\/?} && f != 'bin/rails' }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.add_dependency 'blacklight_iiif_search', '>= 1.0', '< 3.0'
   spec.add_dependency 'derivative-rodeo', "~> 0.5"

data/lib/iiif_print/base_derivative_service.rb

@@ -7,7 +7,11 @@ module IiifPrint
     class_attribute :target_extension, default: nil
 
     def initialize(file_set)
-      @file_set = file_set
+      @file_set = if file_set.is_a?(Hyrax::FileMetadata)
+                    Hyrax.query_service.find_by(id: file_set.file_set_id)
+                  else
+                    file_set
+                  end
       @dest_path = nil
       @source_path = nil
       @source_meta = nil
@@ -26,7 +30,10 @@ module IiifPrint
     # @return [Boolean]
     def valid?
       # @note We are taking a shortcut because currently we are only concerned about images.
-      file_set.class.image_mime_types.include?(file_set.mime_type)
+      # @TODO: verify if this works for ActiveFedora and if so, remove commented code.
+      #        If not, modify to use adapter.
+      # file_set.class.image_mime_types.include?(file_set.mime_type)
+      file_set.original_file.image?
     end
 
     def derivative_path_factory
@@ -110,5 +117,9 @@ module IiifPrint
       # intermediate -> PDF
       im_convert
     end
+
+    def mime_type_for(extension)
+      Marcel::MimeType.for extension: extension
+    end
   end
 end

data/lib/iiif_print/blacklight_iiif_search/annotation_decorator.rb

@@ -103,10 +103,10 @@ module IiifPrint
       def file_set_id
         return document['id'] if document.file_set?
 
-        file_set_ids = document['file_set_ids_ssim']
+        file_set_ids = document['member_ids_ssim']
         raise "#{self.class}: NO FILE SET ID" if file_set_ids.blank?
 
-        # Since a parent work's `file_set_ids_ssim` can contain child work ids as well as file set ids,
+        # Since a parent work's `member_ids_ssim` can contain child work ids as well as file set ids,
         # this will ensure that the file set id is indeed a `FileSet`
         file_set_ids.detect { |id| SolrDocument.find(id).file_set? }
       end

data/lib/iiif_print/catalog_search_builder.rb

@@ -25,9 +25,9 @@ module IiifPrint
     # rubocop:enable Naming/PredicateName
     def show_parents_only(solr_parameters)
       query = if blacklight_params["include_child_works"] == 'true'
-                ActiveFedora::SolrQueryBuilder.construct_query(is_child_bsi: 'true')
+                IiifPrint.solr_construct_query(is_child_bsi: 'true')
               else
-                ActiveFedora::SolrQueryBuilder.construct_query(is_child_bsi: nil)
+                IiifPrint.solr_construct_query(is_child_bsi: nil)
               end
       solr_parameters[:fq] += [query]
     end

data/lib/iiif_print/configuration.rb

@@ -3,6 +3,36 @@ module IiifPrint
   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)
@@ -14,11 +44,14 @@ module IiifPrint
     end
 
     attr_writer :ancestory_identifier_function
-    # The function, with arity 1, that receives a work and returns it's identifier for the purposes
-    # of object ancestry.
+    # 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
-      @ancestory_identifier_function ||= ->(work) { work.id }
+      # 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
@@ -158,17 +191,44 @@ module IiifPrint
     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,
-          visibility: parent_work.visibility.to_s,
           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
     ##

data/lib/iiif_print/data/fileset_helper.rb

@@ -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

@@ -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

@@ -11,6 +11,15 @@ 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"
@@ -37,16 +46,51 @@ 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)
+
+        # 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)
+
+        # 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
 
       ::BlacklightIiifSearch::IiifSearchResponse.prepend(IiifPrint::IiifSearchResponseDecorator)
       ::BlacklightIiifSearch::IiifSearchAnnotation.prepend(IiifPrint::BlacklightIiifSearch::AnnotationDecorator)

data/lib/iiif_print/homepage_search_builder.rb

@@ -7,9 +7,9 @@ module IiifPrint
 
     def show_parents_only(solr_parameters)
       query = if blacklight_params["include_child_works"] == 'true'
-                ActiveFedora::SolrQueryBuilder.construct_query(is_child_bsi: 'true')
+                IiifPrint.solr_construct_query(is_child_bsi: 'true')
               else
-                ActiveFedora::SolrQueryBuilder.construct_query(is_child_bsi: nil)
+                IiifPrint.solr_construct_query(is_child_bsi: nil)
               end
       solr_parameters[:fq] += [query]
     end

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

@@ -3,6 +3,7 @@ module IiifPrint
   #
   # - {.ancestor_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,13 +16,21 @@ 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|
+      # 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.is_child
+        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
 
     ##
@@ -43,6 +52,8 @@ module IiifPrint
     # 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
       #
       # https://github.com/samvera/hydra-works/blob/c9b9dd0cf11de671920ba0a7161db68ccf9b7f6d/lib/hydra/works/models/concerns/work_behavior.rb#L90-L92
@@ -50,10 +61,12 @@ module IiifPrint
       # 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
-      object.ordered_works&.each do |child|
-        file_set_ids += descendent_member_ids_for(child)
+      IiifPrint.object_ordered_works(object)&.each do |child|
+        file_set_ids += Array.wrap(descendent_member_ids_for(child))
       end
-      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

data/lib/iiif_print/pdf_derivative_service.rb

@@ -24,7 +24,9 @@ module IiifPrint
     #   JP2 source, and whether we have color or grayscale material.
     def convert_cmd
       template = use_color? ? COLOR_PDF_CMD : GRAY_PDF_CMD
-      format(template, source_file: @source_path, out_file: @dest_path)
+      data = format(template, source_file: @source_path, out_file: @dest_path)
+      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) })
+      data
     end
 
     def create_derivatives(filename)

data/lib/iiif_print/persistence_layer/active_fedora_adapter.rb

@@ -0,0 +1,189 @@
+module IiifPrint
+  module PersistenceLayer
+    class ActiveFedoraAdapter < AbstractAdapter
+      ##
+      # @param object [ActiveFedora::Base]
+      # @return [Array<SolrDocument>]
+      def self.object_in_works(object)
+        object.in_works
+      end
+
+      ##
+      # @param object [ActiveFedora::Base]
+      # @return [Array<SolrDocument>]
+      def self.object_ordered_works(object)
+        object.ordered_works
+      end
+
+      ##
+      # @param work_type [Class<ActiveFedora::Base>]
+      # @return indexer for the given :work_type
+      def self.decorate_with_adapter_logic(work_type:)
+        work_type.send(:include, IiifPrint::SetChildFlag) unless work_type.included_modules.include?(IiifPrint::SetChildFlag)
+        work_type.indexer
+      end
+
+      ##
+      # @param work_type [Class<ActiveFedora::Base>]
+      # @return indexer for the given :work_type
+      def self.decorate_form_with_adapter_logic(work_type:)
+        work_type.indexer
+      end
+
+      ##
+      # Return the immediate parent of the given :file_set.
+      #
+      # @param file_set [FileSet]
+      # @return [#work?, Hydra::PCDM::Work]
+      # @return [NilClass] when no parent is found.
+      def self.parent_for(file_set)
+        # fallback to Fedora-stored relationships if work's aggregation of
+        #   file set is not indexed in Solr
+        file_set.parent || file_set.member_of.find(&:work?)
+      end
+
+      ##
+      # Return the parent's parent of the given :file_set.
+      #
+      # @param file_set [FileSet]
+      # @return [#work?, Hydra::PCDM::Work]
+      # @return [NilClass] when no grand parent is found.
+      def self.grandparent_for(file_set)
+        parent_of_file_set = parent_for(file_set)
+        # HACK: This is an assumption about the file_set structure, namely that an image page split from
+        # a PDF is part of a file set that is a child of a work that is a child of a single work.  That
+        # is, it only has one grand parent.  Which is a reasonable assumption for IIIF Print but is not
+        # valid when extended beyond IIIF Print.  That is GenericWork does not have a parent method but
+        # does have a parents method.
+        parent_of_file_set.try(:parent_works).try(:first) ||
+          parent_of_file_set.try(:parents).try(:first) ||
+          parent_of_file_set&.member_of&.find(&:work?)
+      end
+
+      def self.solr_construct_query(*args)
+        if defined?(Hyrax::SolrQueryBuilderService)
+          Hyrax::SolrQueryBuilderService.construct_query(*args)
+        else
+          ActiveFedora::SolrQueryBuilder.construct_query(*args)
+        end
+      end
+
+      def self.clean_for_tests!
+        super do
+          ActiveFedora::Cleaner.clean!
+        end
+      end
+
+      def self.solr_query(query, **args)
+        if defined?(ActiveFedora::SolrService)
+          ActiveFedora::SolrService.query(query, **args)
+        else
+          Hyrax::SolrService.query(query, **args)
+        end
+      end
+
+      def self.solr_name(field_name)
+        if defined?(Hyrax) && Hyrax.config.respond_to?(:index_field_mapper)
+          Hyrax.config.index_field_mapper.solr_name(field_name.to_s)
+        else
+          ::ActiveFedora.index_field_mapper.solr_name(field_name.to_s)
+        end
+      end
+
+      ##
+      # @param file_set [Object]
+      # @param work [Object]
+      # @param model [Class] The class name for which we'll split children.
+      def self.destroy_children_split_from(file_set:, work:, model:, **_args)
+        # look first for children by the file set id they were split from
+        children = model.where(split_from_pdf_id: file_set.id)
+        if children.blank?
+          # find works where file name and work `to_param` are both in the title
+          children = model.where(title: file_set.label).where(title: work.to_param)
+        end
+        return if children.blank?
+        children.each do |rcd|
+          rcd.destroy(eradicate: true)
+        end
+        true
+      end
+
+      def self.pdf?(file_set)
+        file_set.class.pdf_mime_types.include?(file_set.mime_type)
+      end
+
+      ##
+      # Add a child record as a member of a parent record
+      #
+      # @param model [child_record] an ActiveFedora::Base model
+      # @param model [parent_record] an ActiveFedora::Base model
+      # @return [TrueClass]
+      def self.create_relationship_between(child_record:, parent_record:)
+        return true if parent_record.ordered_members.to_a.include?(child_record)
+        parent_record.ordered_members << child_record
+        true
+      end
+
+      ##
+      # find a work by title
+      # We should only find one, but there is no guarantee of that and `:where` returns an array.
+      #
+      # @param title [String]
+      # @param model [String] an ActiveFedora::Base model
+      def self.find_by_title_for(title:, model:)
+        work_type = model.constantize
+
+        work_type.where(title: title)
+      end
+
+      ##
+      # find a work or file_set
+      #
+      # @param id [String]
+      # @return [Array<ActiveFedora::Base]
+      def self.find_by(id:)
+        ActiveFedora::Base.find(id)
+      end
+
+      ##
+      # save a work
+      #
+      # @param object [Array<ActiveFedora::Base]
+      def self.save(object:)
+        object.save!
+      end
+
+      ##
+      # reindex an array of works and their file_sets
+      #
+      # @param objects [Array<ActiveFedora::Base]
+      # @return [TrueClass]
+      def self.index_works(objects:)
+        objects.each do |work|
+          work.update_index
+          work.file_sets.each(&:update_index) if work.respond_to?(:file_sets)
+        end
+        true
+      end
+
+      ##
+      # does nothing for ActiveFedora;
+      # allows valkyrie works to have an extra step to create the Hyrax::Metadata objects.
+      #
+      # @param []
+      # @return [TrueClass]
+      def self.copy_derivatives_from_data_store(*)
+        true
+      end
+
+      ##
+      # Extract text from the derivatives
+      #
+      # @param [FileSet] an ActiveFedora fileset
+      # @return [String] Text from fileset's file
+      def self.extract_text_for(file_set:)
+        IiifPrint.config.all_text_generator_function.call(object: file_set) || ''
+      end
+    end
+  end
+end