I11 job split pdfs into child works #83

laritakr · 2023-01-25T15:09:40Z

Create jobs to split pdfs into child works, using Hyrax's BatchCreateJob and CreateChildWork
Create job to add child works to parent work
Create services to split PDFs into TIFFs
Migration to create IiifPrintPendingRelationships to track child works and add to parent
Allow functionality to be added to work types by including configuration to the model: include IiifPrint.model_configuration(pdf_split_child_model: GenericWork)

Specs are still pending completion. Skeleton spec files have been added with TODO notes.

Ref issue #11 * Create jobs to split pdfs into child works, using Hyrax's BatchCreateJob and CreateChildWork * Create job to add child works to parent work * Create services to split PDFs into TIFFs * Migration to create IiifPrintPendingRelationships to track child works and add to parent * Allow functionality to be added to work models by including configuration `include IiifPrint.model_configuration(pdf_split_child_model: GenericWork)` Specs are still pending completion at this point.

Create TODO specs or passing specs for all files related to jobs issue.

laritakr · 2023-01-26T19:31:57Z

To test via hyku, create a Generic Work with a PDF file. This can be done via the UI or via Bulkrax. (If via bulkrax, the file name must be in the same CSV row as the work itself).

Other work types are not configured to split PDFs, and should behave normally.

You should see:

parent work is created with the pdf in a fileset with the derivative thumbnail.
each page of the pdf is split as a TIFF into it's own Image child work. The title will match the title of the parent, with the PDF sequence and page numbers added.
when viewing the parent work show page, the PDF fileset will appear first, and all child works will follow in page number sequence.
if multiple PDFs are attached to the parent, sequence should still work appropriately as long as all PDFs are added at the same time. (see note re edit below)

Note:

editing and adding a second PDF to a work will currently result in duplicate file names because PDF sequencing when adding PDFs is not yet implemented.
relationships are created last. Until the relationships are completed, the new works will not appear on the parent work.

kirkkwang · 2023-01-27T22:27:22Z

app/actors/iiif_print/actors/iiif_print_upload_actor.rb

@@ -28,16 +30,20 @@ def hold_upload_paths(env)
        return if upload_ids.empty?
        uploads = Hyrax::UploadedFile.find(upload_ids)
        paths = uploads.map(&method(:upload_path))
-        @pdf_paths = paths.select { |path| path.end_with?('.pdf') }
+        @pdf_paths = paths.select { |path| path.end_with?('.pdf', '.PDF') }


just in case there's something weird like a_file.Pdf consider using case insensitive regex

@pdf_paths = paths.select { |path| path.match? /\.pdf$/i }

Possibly? I was thinking a TODO may be necessary to find a way to identify PDFs differently which is why I left it this way for now. Remote URLS can contain PDF files but don't always end in .pdf (i.e. google docs links).

app/actors/iiif_print/actors/iiif_print_upload_actor.rb

lib/iiif_print/split_pdfs/pages_into_images_service.rb

spec/actors/iiif_print/actors/iiif_print_upload_actor_spec.rb

spec/lib/iiif_print/jobs/child_works_from_pdf_job_spec.rb

spec/lib/iiif_print/jobs/create_relationship_job_spec.rb

spec/lib/iiif_print/split_pdfs/pages_into_images_service_spec.rb

spec/models/concerns/iiif_print/iiif_print_behavior_spec.rb

kirkkwang

Looks good to me, thanks for answering the questions and awesome job on this feature!

ShanaLMoore · 2023-02-02T21:37:09Z

blocked by #100

LaRita Robinson added 3 commits January 20, 2023 14:20

Add specs

d2a0f3e

Create TODO specs or passing specs for all files related to jobs issue.

Fix lint errors

4986276

laritakr mentioned this pull request Jan 25, 2023

Specs for createIssuePageJob work #77

Open

4 tasks

laritakr marked this pull request as ready for review January 26, 2023 19:25