iiif_print 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25d3d965d8ac8495fd610cb98428ba86090fbdd5c84a60953eeb38c5031c5500
-  data.tar.gz: e7df5c7d69bd03300d4c4ea79c0e4023b072e3ecd9ff1eb87c8d8e5dee8e1779
+  metadata.gz: d4f22906e84ce3a40c02f62c3a6c0d0272b3f267186fd8efcafb635c56b9b789
+  data.tar.gz: f0cbb7d93bf521ca711148b51c0c51ffc993272589daabc8735949f3dd36908d
 SHA512:
-  metadata.gz: feaf33f9dfb535617f3952955904671b4ae20a0043553005c436d5b6ee1fbb2939717b75b1cf8dd7069cddd83599968e9002ec7a69c65d5069c4223a17adafa4
-  data.tar.gz: 10afb034b806bf09f48b22fe355a74bc1e508802f821f3246444e17b7876023f5503c507078d2283960132d035d0f81740ddad2a9f872cb290a4f4d93461bb2b
+  metadata.gz: bd7ce954cce06910bc219df4ae19333b67d4307767fa40d740b419a8c118f843c0cd4d0d9f199eb5623f3577ddae43f96dd3e339ac82829ae0576d0d6a8b9969
+  data.tar.gz: 83fa85c26ab115d40e161e3f53ad091e6ceb3df3deb1fbc4f0e3752ab868b84c106f53831570b24d232a0c3024471b5154fa27b7ca731b006eea78a77159267f

data/.rubocop.yml

@@ -72,7 +72,7 @@ Metrics/MethodLength:
     - 'lib/generators/iiif_print/catalog_controller_generator.rb'
     - 'lib/iiif_print/ingest/ndnp/ndnp_mets_helper.rb'
     - 'lib/iiif_print/ingest/pdf_issue_ingester.rb'
-    - 'lib/iiif_print/jobs/create_relationships_job.rb'
+    - 'app/jobs/iiif_print/jobs/create_relationships_job.rb'
     - 'spec/model_shared.rb'
 
 Naming/PredicateName:

data/Gemfile.lock

@@ -206,7 +206,7 @@ GEM
       railties (>= 4.1.0)
       responders
       warden (~> 1.2.3)
-    devise-guests (0.8.1)
+    devise-guests (0.8.2)
       devise
     diff-lcs (1.5.0)
     disposable (0.4.7)
@@ -913,7 +913,7 @@ GEM
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    sqlite3 (1.6.9)
+    sqlite3 (1.7.2)
       mini_portile2 (~> 2.8.0)
     ssrf_filter (1.0.8)
     sxp (1.2.4)

data/README.md

@@ -115,6 +115,10 @@ uv = createUV('#uv', {
 ## Configuration to enable IiifPrint features
 **NOTE: WorkTypes and models are used synonymously here.**
 
+### Persistence Layer Adapter
+
+We created IiifPrint with an assumption of ActiveFedora.  However, as Hyrax now supports Valkyrie, we need an alternate approach.  We introduced `IiifPrint::Configuration#persistence_layer` as a configuration option.  By default it will use `ActiveFedora` methods; but you can switch adapters to use Valkyrie instead.  (See `IiifPrint::PersistentLayer` for more details).
+
 ### IIIF URL configuration
 
 If you set EXTERNAL_IIIF_URL in your environment, then IiifPrint will use that URL as the root for your IIIF URLs. It will also switch from using the file set ID to using the SHA1 of the file as the identifier. This enables using serverless_iiif or Cantaloupe (refered to as the service) by pointing the service to the same S3 bucket that FCREPO writes the uploaded files to. By setting it up that way you do not need the service to connect to FCREPO or Hyrax at all, both natively support connecting to an S3 bucket to get their data.

data/app/actors/iiif_print/actors/file_set_actor_decorator.rb

@@ -48,7 +48,7 @@ module IiifPrint
         # we destroy the children before the file_set, because we need the parent relationship
         IiifPrint::SplitPdfs::DestroyPdfChildWorksService.conditionally_destroy_spawned_children_of(
           file_set: file_set,
-          work: file_set.parent
+          work: IiifPrint.parent_for(file_set)
         )
         # and now back to your regularly scheduled programming
         super

data/app/indexers/concerns/iiif_print/child_work_indexer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module IiifPrint
+  module ChildWorkIndexer
+    def to_solr
+      super.tap do |index_document|
+        index_solr_doc(index_document)
+      end
+    end
+
+    def generate_solr_document
+      super.tap do |solr_doc|
+        index_solr_doc(solr_doc)
+      end
+    end
+
+    private
+
+    def index_solr_doc(solr_doc)
+      object ||= @object || resource
+      solr_doc['is_child_bsi'] ||= object.try(:is_child)
+      solr_doc['split_from_pdf_id_ssi'] ||= object.try(:split_from_pdf_id)
+      solr_doc['is_page_of_ssim'] = iiif_print_lineage_service.ancestor_ids_for(object)
+      solr_doc['member_ids_ssim'] = iiif_print_lineage_service.descendent_member_ids_for(object)
+    end
+  end
+end

data/app/indexers/concerns/iiif_print/file_set_indexer.rb

@@ -2,39 +2,54 @@
 
 module IiifPrint
   module FileSetIndexer
-    # Why `.decorate`?  In my tests for Rails 5.2, I'm not able to use the prepended nor included
-    # blocks to assign a class_attribute when I "prepend" a module to the base class.  This method
-    # allows me to handle that behavior.
-    #
-    # @param base [Class]
-    # @return [Class] the given base, now decorated in all of it's glory
-    def self.decorate(base)
-      base.prepend(self)
-      base.class_attribute :iiif_print_lineage_service, default: IiifPrint::LineageService
-      base
+    def to_solr
+      super.tap do |index_document|
+        index_solr_doc(index_document)
+      end
     end
 
     def generate_solr_document
       super.tap do |solr_doc|
-        # only UV viewable images should have is_page_of, it is only used for iiif search
-        solr_doc['is_page_of_ssim'] = iiif_print_lineage_service.ancestor_ids_for(object) if object.mime_type&.match(/image/)
-        # index for full text search
-        solr_doc['all_text_timv'] = all_text
-        solr_doc['all_text_tsimv'] = all_text
-        solr_doc['digest_ssim'] = digest_from_content
+        index_solr_doc(solr_doc)
       end
     end
 
     private
 
-    def digest_from_content
-      return unless object.original_file
-      object.original_file.digest.first.to_s
+    def index_solr_doc(solr_doc)
+      object ||= @object || resource
+      # only UV viewable images should have is_page_of, it is only used for iiif search
+      solr_doc['is_page_of_ssim'] = IiifPrint::LineageService.ancestor_ids_for(object) if image?(object)
+      # index for full text search
+      solr_doc['all_text_tsimv'] = solr_doc['all_text_timv'] = all_text(object)
+      solr_doc['digest_ssim'] = find_checksum(object)
+    end
+
+    def image?(object)
+      mime_type = object.try(:mime_type) || object.original_file.try(:mime_type)
+      mime_type&.match(/image/)
+    end
+
+    def find_checksum(object)
+      file = object.original_file
+      return unless file
+
+      digest ||= if file.is_a?(Hyrax::FileMetadata)
+                   Array.wrap(file.checksum).first
+                 else # file is a Hydra::PCDM::File (ActiveFedora)
+                   file.digest.first
+                 end
+      return unless digest
+
+      digest.to_s
     end
 
-    def all_text
-      text = IiifPrint.config.all_text_generator_function.call(object: object) || ''
-      return text if text.empty?
+    def all_text(object)
+      file = object.original_file
+      return unless file
+
+      text = IiifPrint.extract_text_for(file_set: object)
+      return text if text.blank?
 
       text.tr("\n", ' ').squeeze(' ')
     end

data/{lib → app/jobs}/iiif_print/jobs/application_job.rb

@@ -2,7 +2,8 @@ module IiifPrint
   module Jobs
     # TODO: Consider inheriting from ::Application job.  That means we would have the upstreams
     # based job behavior.
-    class ApplicationJob < ActiveJob::Base
+    class ApplicationJob < ::ApplicationJob
+      queue_as ::IiifPrint.config.ingest_queue_name
     end
   end
 end

data/{lib → app/jobs}/iiif_print/jobs/child_works_from_pdf_job.rb

@@ -1,3 +1,5 @@
+require 'iiif_print/jobs/application_job'
+
 module IiifPrint
   module Jobs
     # @deprecated
@@ -10,7 +12,9 @@ module IiifPrint
       # @param user: [User]
       # @param admin_set_id: [<String>]
       # rubocop:disable Metrics/MethodLength
-      def perform(candidate_for_parency, pdf_paths, user, admin_set_id, *)
+      def perform(id, pdf_paths, user, admin_set_id, *)
+        candidate_for_parency = IiifPrint.find_by(id: id)
+
         ##
         # We know that we have cases where parent_work is nil, this will definitely raise an
         # exception; which is fine because we were going to do it later anyway.
@@ -29,7 +33,7 @@ module IiifPrint
         # However, there seem to be cases where we still don't have the file when we get here, so to be sure, we
         # re-do the same command that was previously used to prepare the file path. If the file is already here, it
         # simply returns the path, but if not it will copy the file there, giving us one more chance to have what we need.
-        pdf_paths = [Hyrax::WorkingDirectory.find_or_retrieve(pdf_file_set.files.first.id, pdf_file_set.id, pdf_paths.first)] if pdf_file_set
+        pdf_paths = [Hyrax::WorkingDirectory.find_or_retrieve(pdf_file_set.original_file.id, pdf_file_set.id, pdf_paths.first)] if pdf_file_set
         # handle each input pdf (when input is a file set, we will only have one).
         pdf_paths.each do |original_pdf_path|
           split_pdf(original_pdf_path, user, child_model, pdf_file_set)
@@ -42,7 +46,7 @@ module IiifPrint
         # @param child_model: [<String>] child model
         IiifPrint::Jobs::CreateRelationshipsJob.set(wait: 10.minutes).perform_later(
           user: user,
-          parent_id: @parent_work.id,
+          parent_id: @parent_work.id.to_s,
           parent_model: @parent_work.class.to_s,
           child_model: child_model.to_s
         )
@@ -56,17 +60,18 @@ module IiifPrint
       # rubocop:disable Metrics/ParameterLists
       # rubocop:disable Metrics/MethodLength
       def split_pdf(original_pdf_path, user, child_model, pdf_file_set)
-        image_files = @parent_work.iiif_print_config.pdf_splitter_service.call(original_pdf_path, file_set: pdf_file_set)
+        user = User.find_by_user_key(user) unless user.is_a?(User)
+        image_files = @parent_work.iiif_print_config.pdf_splitter_service.call(original_pdf_path)
 
         # give as much info as possible if we don't have image files to work with.
         if image_files.blank?
-          raise "#{@parent_work.class} (ID=#{@parent_work.id} " /
-                "to_param:#{@parent_work.to_param}) " /
-                "original_pdf_path #{original_pdf_path.inspect} " /
+          raise "#{@parent_work.class} (ID=#{@parent_work.id} " \
+                "to_param:#{@parent_work.to_param}) " \
+                "original_pdf_path #{original_pdf_path.inspect} " \
                 "pdf_file_set #{pdf_file_set.inspect}"
         end
 
-        @split_from_pdf_id = pdf_file_set&.id
+        @split_from_pdf_id = pdf_file_set&.id.to_s
         prepare_import_data(original_pdf_path, image_files, user)
 
         # submit the job to create all the child works for one PDF
@@ -133,7 +138,7 @@ module IiifPrint
       def create_uploaded_file(user, path)
         # TODO: Could we create a remote path?
         uf = Hyrax::UploadedFile.new
-        uf.user_id = user.id
+        uf.user_id = user.try(:id) || user
         uf.file = CarrierWave::SanitizedFile.new(path)
         uf.save!
         uf.id

data/{lib → app/jobs}/iiif_print/jobs/create_relationships_job.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Metrics/ClassLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 module IiifPrint
   module Jobs
     # Link newly created child works to the parent
@@ -34,12 +35,12 @@ module IiifPrint
             @pending_children.each(&:destroy)
             raise "CreateRelationshipsJob for parent id: #{@parent_id} " \
                   "added #{@number_of_successes} children, " \
-                  "expected #{@pending_children} children."
+                  "expected #{@pending_children.count} children."
           else
             # report failures & keep pending relationships
             raise "CreateRelationshipsJob failed for parent id: #{@parent_id} " \
                   "had #{@number_of_successes} successes & #{@number_of_failures} failures, " \
-                  "with errors: #{@errors}. Wanted #{@pending_children} children."
+                  "with errors: #{@errors}. Wanted #{@pending_children.count} children."
           end
         else
           # if we aren't ready yet, reschedule the job and end this one normally
@@ -61,7 +62,7 @@ module IiifPrint
         # find child works (skip out if any haven't yet been created)
         @pending_children.each do |child|
           # find by title... if any aren't found, the child works are not yet ready
-          found_children = find_children_by_title_for(child.child_title, @child_model)
+          found_children = IiifPrint.find_by_title_for(title: child.child_title, model: @child_model)
           found_all_children = false if found_children.empty?
           break unless found_all_children == true
           @child_works += found_children
@@ -70,13 +71,8 @@ module IiifPrint
         found_all_children
       end
 
-      def find_children_by_title_for(title, model)
-        # We should only find one, but there is no guarantee of that and `:where` returns an array.
-        model.constantize.where(title: title)
-      end
-
       def add_children_to_parent
-        parent_work = @parent_model.constantize.find(@parent_id)
+        parent_work = IiifPrint.find_by(id: @parent_id)
         create_relationships(parent: parent_work, ordered_children: @child_works)
       end
 
@@ -103,25 +99,19 @@ module IiifPrint
               @errors << e
             end
           end
-          parent.save! if @parent_record_members_added && @number_of_failures.zero?
+
+          IiifPrint.save(object: parent) if @parent_record_members_added && @number_of_failures.zero?
         end
 
         # Bulkrax no longer reindexes file_sets, but IiifPrint needs both to add is_page_of_ssim for universal viewer.
         # This is where child works need to be indexed (AFTER the parent save), as opposed to how Bulkrax does it.
-        ordered_children.each do |child_work|
-          child_work.update_index
-          child_work.file_sets.each(&:update_index) if child_work.respond_to?(:file_sets)
-        end
+        IiifPrint.index_works(objects: ordered_children)
       end
 
       def add_to_work(child_record:, parent_record:)
-        return true if parent_record.ordered_members.to_a.include?(child_record)
-
-        parent_record.ordered_members << child_record
-        @parent_record_members_added = true
-        # Bulkrax does child_record.save! here, but it makes no sense
-        # as there is nothing to save or index at this point.
+        @parent_record_members_added = IiifPrint.create_relationship_between(child_record: child_record, parent_record: parent_record)
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 end

data/app/listeners/iiif_print/listener.rb

@@ -0,0 +1,31 @@
+##
+# @see https://github.com/samvera/hyrax/wiki/Hyrax's-Event-Bus-(Hyrax::Publisher)
+# @see https://www.rubydoc.info/gems/hyrax/Hyrax/Publisher
+# @see https://dry-rb.org/gems/dry-events
+module IiifPrint
+  class Listener
+    ##
+    # Responsible for conditionally enqueuing the creation of child works from a PDF.
+    #
+    # @param event [#[]] a hash like construct with keys :user and :file_set
+    # @param service [#conditionally_enqueue]
+    #
+    # @see Hyrax::WorkUploadsHandler
+    def on_file_characterized(event, service: IiifPrint::SplitPdfs::ChildWorkCreationFromPdfService)
+      file_set = event[:file_set]
+      return false unless file_set
+      return false unless file_set.file_set?
+      return false unless file_set.original_file.pdf?
+
+      work = IiifPrint.parent_for(file_set)
+      # A short-circuit to avoid fetching the underlying file.
+      return false unless work
+
+      user = work.depositor
+      # TODO: Verify that this is the correct thing to be sending off for conditional enquing.  That
+      # will require a more involved integration test.
+      file = file_set.original_file
+      service.conditionally_enqueue(file_set: file_set, work: work, file: file, user: user)
+    end
+  end
+end

data/app/models/concerns/iiif_print/set_child_flag.rb

@@ -30,7 +30,7 @@ module IiifPrint
     end
 
     def set_children
-      ordered_works.each do |child_work|
+      IiifPrint.object_ordered_works(self).each do |child_work|
         child_work.update(is_child: true) unless child_work.is_child
       end
     end

data/app/models/concerns/iiif_print/solr/document.rb

@@ -39,16 +39,18 @@ module IiifPrint::Solr::Document
 
   def method_missing(method_name, *args, &block)
     super unless iiif_print_solr_field_names.include? method_name.to_s
-    self[::ActiveFedora.index_field_mapper.solr_name(method_name.to_s)]
+    self[IiifPrint.solr_name(method_name.to_s)]
   end
 
   def respond_to_missing?(method_name, include_private = false)
     iiif_print_solr_field_names.include?(method_name.to_s) || super
   end
 
-  # TODO: consider configuring this field name; we use the magic field in lots of places.
+  # @see https://github.com/samvera/hyrax/commit/7108409c619cd2ba4ae8c836b9f3b429a7e9837b
   def file_set_ids
-    self['file_set_ids_ssim']
+    # Yes, this looks a little odd.  But the truth is the prior key (e.g. `file_set_ids_ssim`) was
+    # an alias of `member_ids_ssim`.
+    self['member_ids_ssim']
   end
 
   def any_highlighting?

data/app/presenters/iiif_print/file_set_presenter_decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module IiifPrint
+  module FileSetPresenterDecorator
+    # uses Hyku's TenantConfig to determine whether to allow PDF splitting button
+    def show_split_button?
+      return parent.try(:split_pdfs?) if parent.respond_to?(:split_pdfs?)
+      true
+    end
+  end
+end

data/app/presenters/iiif_print/iiif_manifest_presenter_factory_behavior.rb

@@ -14,7 +14,7 @@ module IiifPrint
           presenter_class.for(solr_doc)
         elsif Hyrax.config.curation_concerns.include?(solr_doc.hydra_model)
           # look up file set ids and loop through those
-          file_set_docs = load_file_set_docs(solr_doc.try(:file_set_ids) || solr_doc.try(:[], 'file_set_ids_ssim'))
+          file_set_docs = load_file_set_docs(solr_doc.try(:member_ids) || solr_doc.try(:[], 'member_ids_ssim'))
           file_set_docs.map { |doc| presenter_class.for(doc) } if file_set_docs.length
         end
       end.flatten.compact

data/app/presenters/iiif_print/work_show_presenter_decorator.rb

@@ -2,7 +2,8 @@
 
 module IiifPrint
   module WorkShowPresenterDecorator
-    delegate :file_set_ids, to: :solr_document
+    delegate :member_ids, to: :solr_document
+    alias file_set_ids member_ids
 
     # OVERRIDE Hyrax 2.9.6 to remove check for representative_presenter.image?
     # @return [Boolean] render a IIIF viewer
@@ -20,8 +21,10 @@ module IiifPrint
     # overriding Hyrax to include file sets for both work and child works (file set ids include both)
     # process each id, short-circuiting the loop once one true value is found. This speeds up the test
     # by not loading more member_presenters than needed.
+    #
+    # @todo Review if this is necessary for Hyrax 5.
     def members_include_viewable_image?
-      all_member_ids = (solr_document.try(:file_set_ids) || solr_document.try(:[], 'file_set_ids_ssim'))
+      all_member_ids = solr_document.try(:member_ids) || solr_document.try(:[], 'member_ids_ssim')
       Array.wrap(all_member_ids).each do |id|
         return true if file_type_and_permissions_valid?(member_presenters_for([id]).first)
       end

data/app/services/iiif_print/manifest_builder_service_behavior.rb

@@ -142,9 +142,11 @@ module IiifPrint
       results = []
       ids.each_slice(SOLR_QUERY_PAGE_SIZE) do |paged_ids|
         query = "id:(#{paged_ids.join(' OR ')})"
-        results += ActiveFedora::SolrService.query(
+        results += IiifPrint.solr_query(
           query,
-          { fq: "-has_model_ssim:FileSet", rows: paged_ids.size, method: :post }
+          fq: "-has_model_ssim:FileSet",
+          rows: paged_ids.size,
+          method: :post
         )
       end
       results

data/app/services/iiif_print/pluggable_derivative_service.rb

@@ -27,7 +27,11 @@ class IiifPrint::PluggableDerivativeService
   class_attribute :derivative_path_factory, default: Hyrax::DerivativePath
 
   def initialize(file_set, plugins: plugins_for(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
     @plugins = Array.wrap(plugins)
     @valid_plugins = plugins.map { |plugin| plugin.new(file_set) }.select(&:valid?)
   end

data/app/services/iiif_print/simple_schema_loader_decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# OVERRIDE Hyrax v5.0.0rc2 to add schemas that are located in config/metadata/*.yaml
+
+module IiifPrint
+  module SimpleSchemaLoaderDecorator
+    def config_search_paths
+      super + [IiifPrint::Engine.root]
+    end
+  end
+end

data/app/transactions/hyrax/transactions/iiif_print_container_decorator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Transactions
+    ##
+    # This decorator does the following:
+    #
+    # - Prepend the {ConditionallyDestroyChildrenFromSplit} transaction to the "file_set.destroy"
+    #   step.  The prependment corresponds to the behavior for
+    #   {IiifPrint::Actors::FileSetActorDecorator#destroy}
+    #
+    # For more information about adjusting transactions, see
+    # [Transitioning workshop solution for adding transaction](https://github.com/samvera-labs/transitioning-to-valkyrie-workshop/commit/bcab2bb8f65078e88395c68f72be00e7ffad57ec)
+    #
+    # @see https://github.com/samvera/hyrax/blob/f875d61dc87229cf1f05eb2bb6d414b5ef314616/lib/hyrax/transactions/container.rb
+    class IiifPrintContainerDecorator
+      extend Dry::Container::Mixin
+
+      namespace 'file_set' do |ops|
+        ops.register 'iiif_print_conditionally_destroy_spawned_children' do
+          Steps::ConditionallyDestroyChildrenFromSplit.new
+        end
+        ops.register 'destroy' do
+          Hyrax::Transactions::FileSetDestroy.new(
+            steps: (['file_set.iiif_print_conditionally_destroy_spawned_children'] +
+              Hyrax::Transactions::FileSetDestroy::DEFAULT_STEPS)
+          )
+        end
+      end
+    end
+  end
+end
+
+"Hyrax::Transactions::Container".safe_constantize&.merge(Hyrax::Transactions::IiifPrintContainerDecorator)

data/app/transactions/hyrax/transactions/steps/conditionally_destroy_children_from_split.rb

@@ -0,0 +1,32 @@
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # For a FileSet that is a PDF, we need to delete any works and file_sets that are the result of
+      # splitting that PDF into constituent images of each page of the PDF.  This is responsible for
+      # that work.
+      class ConditionallyDestroyChildrenFromSplit
+        include Dry::Monads[:result]
+
+        ##
+        # @param resource [Hyrax::FileSet]
+        def call(resource, user: nil)
+          return Failure(:resource_not_persisted) unless resource.persisted?
+
+          parent = IiifPrint.persistence_adapter.parent_for(resource)
+          return Success(true) unless parent
+
+          # We do not care about the results of this call; as it is conditionally looking for things
+          # to destroy.
+          IiifPrint::SplitPdfs::DestroyPdfChildWorksService.conditionally_destroy_spawned_children_of(
+            file_set: resource,
+            work: parent,
+            user: user
+          )
+
+          Success(resource)
+        end
+      end
+    end
+  end
+end

data/app/transactions/hyrax/transactions/steps/delete_all_file_sets_decorator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# OVERRIDE Hyrax 5.0.0rc2 to add file_set.iiif_print_conditionally_destroy_spawned_children with user args
+
+module Hyrax
+  module Transactions
+    module Steps
+      module DeleteAllFileSetsDecorator
+        include Dry::Monads[:result]
+
+        ##
+        # @param [Valkyrie::Resource] resource
+        # @param [::User] the user resposible for the delete action
+        #
+        # @return [Dry::Monads::Result]
+        def call(resource, user: nil)
+          return Failure(:resource_not_persisted) unless resource.persisted?
+
+          @query_service.custom_queries.find_child_file_sets(resource: resource).each do |file_set|
+            return Failure[:failed_to_delete_file_set, file_set] unless
+              Hyrax::Transactions::Container['file_set.destroy']
+              .with_step_args('file_set.remove_from_work' => { user: user },
+                              'file_set.delete' => { user: user },
+                              'file_set.iiif_print_conditionally_destroy_spawned_children' => { user: user })
+              .call(file_set).success?
+          rescue ::Ldp::Gone
+            nil
+          end
+
+          Success(resource)
+        end
+      end
+    end
+  end
+end

data/app/views/hyrax/file_sets/_show_actions.html.erb

@@ -14,7 +14,7 @@
                   method: :delete %>
   <% end %>
 
-  <% if @presenter.editor? && @presenter.pdf? %>
+  <% if @presenter.show_split_button? && @presenter.editor? && @presenter.pdf? %>
     <%= link_to t("iiif_print.file_set.split_this"), iiif_print.split_pdf_path(@presenter),
      class: 'btn btn-default', data: { confirm: t("iiif_print.file_set.confirm_split_this") },
      method: :post %>

data/config/initializers/simple_schema_loader.rb

@@ -0,0 +1 @@
+"Hyrax::SimpleSchemaLoader".safe_constantize&.prepend(IiifPrint::SimpleSchemaLoaderDecorator)

data/config/metadata/child_works_from_pdf_splitting.yaml

@@ -0,0 +1,21 @@
+attributes:
+  is_child:
+    type: bool
+    multiple: false
+    index_keys:
+      - "is_child_bsi"
+    form:
+      required: false
+      primary: false
+      multiple: false
+    predicate: "http://id.loc.gov/vocabulary/identifiers/isChild"
+  split_from_pdf_id:
+    type: string
+    multiple: false
+    index_keys:
+      - "split_from_pdf_id_ssi"
+    form:
+      required: false
+      primary: false
+      multiple: false
+    predicate: "http://id.loc.gov/vocabulary/identifiers/splitFromPdfId"

data/db/migrate/20181214181358_create_iiif_print_derivative_attachments.rb

@@ -1,12 +1,14 @@
 class CreateIiifPrintDerivativeAttachments < ActiveRecord::Migration[5.0]
   def change
-    create_table :iiif_print_derivative_attachments do |t|
-      t.string :fileset_id
-      t.string :path
-      t.string :destination_name
+    unless table_exists?(:iiif_print_derivative_attachments)
+      create_table :iiif_print_derivative_attachments do |t|
+        t.string :fileset_id
+        t.string :path
+        t.string :destination_name
 
-      t.timestamps
+        t.timestamps
+      end
+      add_index :iiif_print_derivative_attachments, :fileset_id
     end
-    add_index :iiif_print_derivative_attachments, :fileset_id
   end
 end