iiif_print 1.0.0 → 1.1.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif_print
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sean Upton
@@ -14,36 +14,42 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight_iiif_search
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: dry-monads
+  name: derivative-rodeo
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: hyrax
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +59,7 @@ dependencies:
         version: '2.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +69,7 @@ dependencies:
         version: '2.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -78,20 +84,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.13.2
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rdf-vocab
   requirement: !ruby/object:Gem::Requirement
@@ -216,20 +208,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: json-canonicalization
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-activemodel-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -278,6 +284,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem/Engine for IIIF Print works in Hyrax-based Samvera Application.
 email:
 - sean.upton@utah.edu
@@ -294,20 +328,25 @@ files:
 - ".coveralls.yml"
 - ".env"
 - ".fcrepo_wrapper"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/release.yml"
 - ".github/workflows/branches.yml"
 - ".github/workflows/build-lint-test-action.yaml"
 - ".github/workflows/release_labels.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".solargraph.yml"
 - ".solr_wrapper"
 - ".travis.yml"
 - CONTRIBUTING.md
 - Dockerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- app/actors/iiif_print/actors/cleanup_file_sets_actor_decorator.rb
 - app/actors/iiif_print/actors/file_set_actor_decorator.rb
 - app/assets/config/iiif_print_manifest.js
 - app/assets/images/iiif_print/.keep
@@ -319,8 +358,10 @@ files:
 - app/assets/stylesheets/iiif_print/_issues_calendar.scss
 - app/assets/stylesheets/iiif_print/_newspapers_search.scss
 - app/assets/stylesheets/iiif_print/_search_results.scss
-- app/helpers/hyrax/iiif_helper.rb
+- app/controllers/iiif_print/split_pdfs_controller.rb
 - app/helpers/iiif_print/application_helper.rb
+- app/helpers/iiif_print/iiif_helper_decorator.rb
+- app/helpers/iiif_print/iiif_print_helper_behavior.rb
 - app/helpers/iiif_print_helper.rb
 - app/indexers/concerns/iiif_print/child_indexer.rb
 - app/indexers/concerns/iiif_print/file_set_indexer.rb
@@ -329,6 +370,7 @@ files:
 - app/models/concerns/iiif_print/solr/document.rb
 - app/models/iiif_print/application_record.rb
 - app/models/iiif_print/derivative_attachment.rb
+- app/models/iiif_print/iiif_search_decorator.rb
 - app/models/iiif_print/iiif_search_response_decorator.rb
 - app/models/iiif_print/ingest_file_relation.rb
 - app/models/iiif_print/pending_relationship.rb
@@ -336,14 +378,18 @@ files:
 - app/presenters/iiif_print/iiif_manifest_presenter_factory_behavior.rb
 - app/presenters/iiif_print/work_show_presenter_decorator.rb
 - app/renderers/hyrax/renderers/faceted_attribute_renderer_decorator.rb
+- app/search_builders/concerns/iiif_print/allinson_flex_fields.rb
 - app/search_builders/concerns/iiif_print/exclude_models.rb
 - app/search_builders/concerns/iiif_print/highlight_search_params.rb
+- app/services/iiif_print/derivative_rodeo_service.rb
 - app/services/iiif_print/manifest_builder_service_behavior.rb
 - app/services/iiif_print/pluggable_derivative_service.rb
+- app/views/catalog/_index_header_list_default.html.erb
 - app/views/catalog/_snippets_more.html.erb
 - app/views/hyrax/base/_representative_media.html.erb
 - app/views/hyrax/base/iiif_viewers/_universal_viewer.html.erb
 - app/views/hyrax/file_sets/_actions.html.erb
+- app/views/hyrax/file_sets/_show_actions.html.erb
 - bin/rails
 - config/fcrepo_wrapper_test.yml
 - config/initializers/assets.rb
@@ -354,6 +400,7 @@ files:
 - config/locales/iiif_print.it.yml
 - config/locales/iiif_print.pt-BR.yml
 - config/locales/iiif_print.zh.yml
+- config/routes.rb
 - config/solr_wrapper_test.yml
 - config/test-fixture/solr-config/_rest_managed.json
 - config/test-fixture/solr-config/admin-extra.html
@@ -376,12 +423,14 @@ files:
 - db/migrate/20181214181358_create_iiif_print_derivative_attachments.rb
 - db/migrate/20190107165909_create_iiif_print_ingest_file_relations.rb
 - db/migrate/20230109000000_create_iiif_print_pending_relationships.rb
+- db/migrate/20231110163052_add_model_details_to_iiif_print_pending_relationships.rb
 - docker-compose.yml
 - iiif_print.gemspec
 - lib/generators/iiif_print/assets_generator.rb
 - lib/generators/iiif_print/catalog_controller_generator.rb
 - lib/generators/iiif_print/install_generator.rb
 - lib/generators/iiif_print/templates/config/initializers/iiif_print.rb
+- lib/generators/iiif_print/templates/helpers/iiif_print_helper.rb
 - lib/generators/iiif_print/templates/iiif_print.scss
 - lib/iiif_print.rb
 - lib/iiif_print/base_derivative_service.rb
@@ -396,17 +445,24 @@ files:
 - lib/iiif_print/data/work_files.rb
 - lib/iiif_print/engine.rb
 - lib/iiif_print/errors.rb
+- lib/iiif_print/homepage_search_builder.rb
 - lib/iiif_print/image_tool.rb
 - lib/iiif_print/jobs/application_job.rb
 - lib/iiif_print/jobs/child_works_from_pdf_job.rb
 - lib/iiif_print/jobs/create_relationships_job.rb
+- lib/iiif_print/jobs/request_split_pdf_job.rb
 - lib/iiif_print/jp2_derivative_service.rb
 - lib/iiif_print/jp2_image_metadata.rb
 - lib/iiif_print/lineage_service.rb
 - lib/iiif_print/metadata.rb
 - lib/iiif_print/pdf_derivative_service.rb
+- lib/iiif_print/split_pdfs/base_splitter.rb
 - lib/iiif_print/split_pdfs/child_work_creation_from_pdf_service.rb
-- lib/iiif_print/split_pdfs/pages_into_images_service.rb
+- lib/iiif_print/split_pdfs/derivative_rodeo_splitter.rb
+- lib/iiif_print/split_pdfs/destroy_pdf_child_works_service.rb
+- lib/iiif_print/split_pdfs/pages_to_jpgs_splitter.rb
+- lib/iiif_print/split_pdfs/pages_to_pngs_splitter.rb
+- lib/iiif_print/split_pdfs/pages_to_tiffs_splitter.rb
 - lib/iiif_print/split_pdfs/pdf_image_extraction_service.rb
 - lib/iiif_print/text_extraction.rb
 - lib/iiif_print/text_extraction/alto_reader.rb
@@ -419,6 +475,9 @@ files:
 - lib/iiif_print/tiff_derivative_service.rb
 - lib/iiif_print/version.rb
 - lib/iiif_print/works_controller_behavior.rb
+- lib/samvera/derivatives.rb
+- lib/samvera/derivatives/configuration.rb
+- lib/samvera/derivatives/hyrax.rb
 - lib/tasks/set_child_works.rake
 - spec/.keep.txt
 - spec/factories/ability.rb
@@ -429,6 +488,8 @@ files:
 - spec/factories/uploaded_pdf_file.rb
 - spec/factories/uploaded_txt_file.rb
 - spec/factories/user.rb
+- spec/fixtures/authorities/licenses.yml
+- spec/fixtures/authorities/rights_statements.yml
 - spec/fixtures/files/4.1.07.jp2
 - spec/fixtures/files/4.1.07.tiff
 - spec/fixtures/files/README.md
@@ -469,7 +530,12 @@ files:
 - spec/iiif_print/jp2_image_metadata_spec.rb
 - spec/iiif_print/lineage_service_spec.rb
 - spec/iiif_print/metadata_spec.rb
-- spec/iiif_print/split_pdfs/pages_into_images_service_spec.rb
+- spec/iiif_print/split_pdfs/base_splitter_spec.rb
+- spec/iiif_print/split_pdfs/derivative_rodeo_splitter_spec.rb
+- spec/iiif_print/split_pdfs/destroy_pdf_child_works_service_spec.rb
+- spec/iiif_print/split_pdfs/pages_to_jpgs_splitter_spec.rb
+- spec/iiif_print/split_pdfs/pages_to_pngs_splitter_spec.rb
+- spec/iiif_print/split_pdfs/pages_to_tiffs_splitter_spec.rb
 - spec/iiif_print/text_extraction/alto_reader_spec.rb
 - spec/iiif_print/text_extraction/hocr_reader_spec.rb
 - spec/iiif_print/text_extraction/page_ocr_spec.rb
@@ -478,11 +544,17 @@ files:
 - spec/iiif_print_spec.rb
 - spec/misc_shared.rb
 - spec/models/iiif_print/derivative_attachment_spec.rb
+- spec/models/iiif_print/iiif_search_decorator_spec.rb
 - spec/models/iiif_print/ingest_file_relation_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/presenters/iiif_print/iiif_manifest_presenter_behavior_spec.rb
 - spec/presenters/iiif_print/iiif_manifest_presenter_factory_behavior_spec.rb
+- spec/samvera/derivatives/configuration_spec.rb
+- spec/samvera/derivatives/hyrax_spec.rb
+- spec/samvera/derivatives_spec.rb
+- spec/services/iiif_print/derivative_rodeo_service_spec.rb
 - spec/services/iiif_print/jp2_derivative_service_spec.rb
+- spec/services/iiif_print/manifest_builder_service_behavior_spec.rb
 - spec/services/iiif_print/pdf_derivative_service_spec.rb
 - spec/services/iiif_print/pluggable_derivative_service_spec.rb
 - spec/services/iiif_print/text_extraction_derivative_service_spec.rb
@@ -498,9 +570,10 @@ files:
 - spec/test_app_templates/solr.yml
 - spec/test_app_templates/solr/conf/schema.xml
 - spec/test_app_templates/solr/conf/solrconfig.xml
+- tasks/copy_authorities_to_test_app.rake
 - tasks/iiif_print_dev.rake
 - tmp/.keep
-homepage: https://github.com/samvera-labs/iiif_print
+homepage: https://github.com/scientist-softserv/iiif_print/
 licenses:
 - Apache-2.0
 metadata: {}
@@ -519,11 +592,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: iiif_print is a Rails Engine gem providing model and administrative functions
-  to Hyrax-based Samvera applications, for management of (primarily scanned) content.
+summary: 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.
 test_files:
 - spec/.keep.txt
 - spec/factories/ability.rb
@@ -534,6 +609,8 @@ test_files:
 - spec/factories/uploaded_pdf_file.rb
 - spec/factories/uploaded_txt_file.rb
 - spec/factories/user.rb
+- spec/fixtures/authorities/licenses.yml
+- spec/fixtures/authorities/rights_statements.yml
 - spec/fixtures/files/4.1.07.jp2
 - spec/fixtures/files/4.1.07.tiff
 - spec/fixtures/files/README.md
@@ -574,7 +651,12 @@ test_files:
 - spec/iiif_print/jp2_image_metadata_spec.rb
 - spec/iiif_print/lineage_service_spec.rb
 - spec/iiif_print/metadata_spec.rb
-- spec/iiif_print/split_pdfs/pages_into_images_service_spec.rb
+- spec/iiif_print/split_pdfs/base_splitter_spec.rb
+- spec/iiif_print/split_pdfs/derivative_rodeo_splitter_spec.rb
+- spec/iiif_print/split_pdfs/destroy_pdf_child_works_service_spec.rb
+- spec/iiif_print/split_pdfs/pages_to_jpgs_splitter_spec.rb
+- spec/iiif_print/split_pdfs/pages_to_pngs_splitter_spec.rb
+- spec/iiif_print/split_pdfs/pages_to_tiffs_splitter_spec.rb
 - spec/iiif_print/text_extraction/alto_reader_spec.rb
 - spec/iiif_print/text_extraction/hocr_reader_spec.rb
 - spec/iiif_print/text_extraction/page_ocr_spec.rb
@@ -583,11 +665,17 @@ test_files:
 - spec/iiif_print_spec.rb
 - spec/misc_shared.rb
 - spec/models/iiif_print/derivative_attachment_spec.rb
+- spec/models/iiif_print/iiif_search_decorator_spec.rb
 - spec/models/iiif_print/ingest_file_relation_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/presenters/iiif_print/iiif_manifest_presenter_behavior_spec.rb
 - spec/presenters/iiif_print/iiif_manifest_presenter_factory_behavior_spec.rb
+- spec/samvera/derivatives/configuration_spec.rb
+- spec/samvera/derivatives/hyrax_spec.rb
+- spec/samvera/derivatives_spec.rb
+- spec/services/iiif_print/derivative_rodeo_service_spec.rb
 - spec/services/iiif_print/jp2_derivative_service_spec.rb
+- spec/services/iiif_print/manifest_builder_service_behavior_spec.rb
 - spec/services/iiif_print/pdf_derivative_service_spec.rb
 - spec/services/iiif_print/pluggable_derivative_service_spec.rb
 - spec/services/iiif_print/text_extraction_derivative_service_spec.rb

data/app/helpers/hyrax/iiif_helper.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  module IiifHelper
-    def iiif_viewer_display(work_presenter, locals = {})
-      render iiif_viewer_display_partial(work_presenter),
-             locals.merge(presenter: work_presenter)
-    end
-
-    def iiif_viewer_display_partial(work_presenter)
-      'hyrax/base/iiif_viewers/' + work_presenter.iiif_viewer.to_s
-    end
-
-    def universal_viewer_base_url
-      "#{request&.base_url}/uv/uv.html"
-    end
-
-    def universal_viewer_config_url
-      "#{request&.base_url}/uv/uv-config.json"
-    end
-  end
-end

data/lib/iiif_print/split_pdfs/pages_into_images_service.rb

@@ -1,130 +0,0 @@
-require 'open3'
-require 'securerandom'
-require 'tmpdir'
-require 'iiif_print/split_pdfs/pdf_image_extraction_service'
-
-module IiifPrint
-  module SplitPdfs
-    class PagesIntoImagesService
-      include Enumerable
-
-      def initialize(path)
-        @baseid = SecureRandom.uuid
-        @pdfpath = path
-        @info = nil
-        @entries = nil
-        @tmpdir = nil
-        @size = nil
-        @pagecount = nil
-        @pdftext = nil
-        @compression = 'lzw'
-      end
-
-      # return
-      def pdfinfo
-        @info = IiifPrint::SplitPdfs::PdfImageExtractionService.new(@pdfpath) if @info.nil?
-        @info
-      end
-
-      # TODO: put this test somewhere to prevent invalid pdfs from crashing the image service.
-      def invalid_pdf?
-        return true if pdfinfo.color.include?(nil) || pdfinfo.width.nil? || pdfinfo.height.nil? || pdfinfo.entries.length.zero?
-        false
-      end
-
-      def tmpdir
-        @tmpdir = Dir.mktmpdir if @tmpdir.nil?
-        @tmpdir
-      end
-
-      def colordevice(channels, bpc)
-        bits = bpc * channels
-        # will be either 8bpc/16bpd color TIFF,
-        #   with any CMYK source transformed to 8bpc RBG
-        bits = 24 unless [24, 48].include? bits
-        "tiff#{bits}nc"
-      end
-
-      def gsdevice
-        color, channels, bpc = pdfinfo.color
-        device = nil
-        # CCITT Group 4 Black and White, if applicable:
-        if color == 'gray' && bpc == 1
-          device = 'tiffg4'
-          @compression = 'g4'
-        end
-        # 8 Bit Grayscale, if applicable:
-        device = 'tiffgray' if color == 'gray' && bpc > 1
-        # otherwise color:
-        device = colordevice(channels, bpc) if device.nil?
-        device
-      end
-
-      # TODO: this method came from newspaper gem but appears to be unused. Is it needed anywhere?
-      # def gstext
-      #   cmd = "gs -q -dNOPAUSE -dBATCH -sDEVICE=txtwrite " \
-      #         "-sOutputFile=- -f #{@pdfpath}"
-      #   Open3.popen3(cmd) do |_stdin, stdout, _stderr, _wait_thr|
-      #     @pdftext = stdout.read
-      #   end
-      #   @pdftext
-      # end
-
-      def pagecount
-        cmd = "pdfinfo #{@pdfpath}"
-        Open3.popen3(cmd) do |_stdin, stdout, _stderr, _wait_thr|
-          output = stdout.read.split("\n")
-          # rubocop:disable Performance/Detect
-          pages_e = output.select { |e| e.start_with?('Pages:') }[0]
-          # rubocop:enable Performance/Detect
-          @pagecount = pages_e.split[-1].to_i
-        end
-        @pagecount
-      end
-
-      def looks_scanned
-        max_image_px = pdfinfo.width * pdfinfo.height
-        single_image_per_page = pdfinfo.entries.length == pagecount
-        # single 10mp+ image per page?
-        single_image_per_page && max_image_px > 1024 * 1024 * 10
-      end
-
-      def ppi
-        unless looks_scanned
-          # 400 dpi for something that does not look like scanned media:
-          return 400
-        end
-        # For scanned media, defer to detected image PPI:
-        pdfinfo.ppi
-      end
-
-      # ghostscript convert all pages to TIFF
-      def gsconvert
-        output_base = File.join(tmpdir, "#{@baseid}-page%d.tiff")
-        cmd = "gs -dNOPAUSE -dBATCH -sDEVICE=#{gsdevice} " \
-              "-dTextAlphaBits=4 -sCompression=#{@compression} " \
-              "-sOutputFile=#{output_base} -r#{ppi} -f #{@pdfpath}"
-        Open3.popen3(cmd) do |_stdin, stdout, _stderr, _wait_thr|
-          output = stdout.read.split("\n")
-          # rubocop:disable Performance/Count
-          @size = output.select { |e| e.start_with?('Page ') }.length
-          # rubocop:enable Performance/Count
-        end
-        # Return an array of expected filenames
-        (1..@size).map { |n| File.join(tmpdir, "#{@baseid}-page#{n}.tiff") }
-      end
-
-      # entries for each page
-      def entries
-        @entries = gsconvert if @entries.nil?
-        @entries
-      end
-
-      def each
-        entries.each do |e|
-          yield(e)
-        end
-      end
-    end
-  end
-end

data/spec/iiif_print/split_pdfs/pages_into_images_service_spec.rb

@@ -1,6 +0,0 @@
-require 'spec_helper'
-require 'misc_shared'
-
-RSpec.describe IiifPrint::SplitPdfs::PagesIntoImagesService do
-  # TODO: add specs
-end