iiif_print 1.0.0 → 1.1.0

data/spec/models/iiif_print/iiif_search_decorator_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe IiifPrint::IiifSearchDecorator do
+  let(:iiif_config) { { object_relation_field: 'is_page_of_ssim' } }
+  let(:parent_document) { double(SolrDocument, id: 'abc123') }
+  let(:iiif_search) { BlacklightIiifSearch::IiifSearch.new(params, iiif_config, parent_document) }
+
+  describe '#solr_params' do
+    subject { iiif_search.solr_params }
+
+    context 'when q is nil' do
+      let(:params) { { q: nil } }
+
+      it 'returns nil:nil' do
+        expect(subject).to eq({ q: 'nil:nil' })
+      end
+    end
+
+    context 'when q is not nil' do
+      let(:params) { { q: 'catscan' } }
+
+      it 'returns a query with the search term and filters for child or parent id' do
+        expect(subject).to eq({ q: "catscan AND (is_page_of_ssim:\"abc123\" OR id:\"abc123\")", rows: 50, page: nil })
+      end
+    end
+  end
+end

data/spec/presenters/iiif_print/iiif_manifest_presenter_behavior_spec.rb

@@ -16,4 +16,55 @@ RSpec.describe IiifPrint::IiifManifestPresenterBehavior do
       expect(presenter.search_service).to include("#{solr_document.id}/iiif_search")
     end
   end
+
+  context 'with IIIF external support' do
+    let(:presenter) { Hyrax::IiifManifestPresenter::DisplayImagePresenter.new(solr_document) }
+    let(:id) { 'abc123' }
+    let(:url) { 'external_iiif_url' }
+    let(:iiif_info_url_builder) { ->(file_id, base_url) { "#{base_url}/#{file_id}" } }
+
+    before { allow(solr_document).to receive(:image?).and_return(true) }
+
+    context 'when external iiif is enabled' do
+      before do
+        allow(ENV).to receive(:[])
+        allow(ENV).to receive(:[]).with('EXTERNAL_IIIF_URL').and_return(url)
+        allow(presenter).to receive(:latest_file_id).and_return(id)
+      end
+
+      describe '#display_image' do
+        it 'renders a external url' do
+          expect(presenter.display_image.iiif_endpoint.url).to eq "#{url}/#{id}"
+          expect(presenter.display_image.iiif_endpoint.profile).to eq "http://iiif.io/api/image/2/level2.json"
+        end
+      end
+
+      describe '#display_content' do
+        it 'renders a external url' do
+          expect(presenter.display_content.iiif_endpoint.url).to eq "#{url}/#{id}"
+          expect(presenter.display_content.iiif_endpoint.profile).to eq "http://iiif.io/api/image/2/level2.json"
+        end
+      end
+    end
+
+    context 'when external iiif is not enabled' do
+      before do
+        allow(presenter).to receive(:latest_file_id).and_return(id)
+        allow(Hyrax.config).to receive(:iiif_image_server?).and_return(true)
+        allow(Hyrax.config).to receive(:iiif_info_url_builder).and_return(iiif_info_url_builder)
+      end
+
+      describe '#display_image' do
+        it 'does not render a external url' do
+          expect(presenter.display_image.iiif_endpoint.url).to eq "localhost/#{id}"
+        end
+      end
+
+      describe '#display_content' do
+        it 'does not render a external url' do
+          expect(presenter.display_content.iiif_endpoint.url).to eq "localhost/#{id}"
+        end
+      end
+    end
+  end
 end

data/spec/samvera/derivatives/configuration_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'samvera/derivatives/configuration'
+
+RSpec.describe Samvera::Derivatives::Configuration do
+  let(:file_set) { double(:file_set) }
+  let(:config) { described_class.new }
+
+  describe '#registry_for' do
+    it 'has a applicable_for that is falsey' do
+      register = config.registry_for(type: :thumbnail)
+      expect(register.applicable_for?(file_set: file_set)).to be_falsey
+    end
+  end
+
+  describe '#register' do
+    it 'amends the existing registry' do
+      locator = double
+      type = :thumbnail
+      expect do
+        config.register(type: type, locators: [locator], applicators: [])
+      end.to change { config.registry_for(type: type).locators }.from([]).to([locator])
+    end
+
+    context 'validation' do
+      it 'defaults to a truthy validator' do
+        registry = config.register(type: :thumbnail, locators: [], applicators: [])
+        expect(registry.applicable_for?(file_set: file_set)).to be_truthy
+      end
+
+      it 'allows for block configuration' do
+        registry = config.register(type: :thumbnail, locators: [], applicators: []) do |_file_set|
+          false
+        end
+
+        expect(registry.applicable_for?(file_set: file_set)).to be_falsey
+      end
+    end
+  end
+end

data/spec/samvera/derivatives/hyrax_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'samvera/derivatives'
+require 'samvera/derivatives/hyrax'
+
+RSpec.describe Samvera::Derivatives::Hyrax::ServiceShim do
+  let(:config) { Samvera::Derivatives::Configuration.new }
+  let(:file_set) { FileSet.new }
+  let(:other_locator) { double('Locator', locate: nil) }
+  let(:other_applicator) { double('Applicator', apply!: nil) }
+  before do
+    config.register(
+      type: :thumbnail,
+      locators: [other_locator, Samvera::Derivatives::Hyrax::FileLocatorStrategy],
+      applicators: [other_applicator, Samvera::Derivatives::Hyrax::FileApplicatorStrategy]
+    ) { |_file_set| true }
+    config.register(
+      type: :jpg,
+      locators: [other_locator, Samvera::Derivatives::Hyrax::FileLocatorStrategy],
+      applicators: [other_applicator, Samvera::Derivatives::Hyrax::FileApplicatorStrategy]
+    ) { |_file_set| true }
+  end
+
+  let(:shim) { described_class.new(file_set, candidate_derivative_types: [:thumnail, :jpg], config: config) }
+
+  subject { shim }
+
+  it { is_expected.to be_valid }
+
+  describe '#create_derivatives' do
+    let(:file_path) { __FILE__ }
+    subject { shim.create_derivatives(file_path) }
+
+    context 'when other locator and applicator are not applicable' do
+      it 'locates and applies the derivatives using the underlying service' do
+        expect_any_instance_of(Samvera::Derivatives::Hyrax::FileApplicatorStrategy).to receive(:apply!).and_call_original
+        expect_any_instance_of(Samvera::Derivatives::Hyrax::FileSetDerivativesServiceWrapper).to receive(:apply!).and_call_original
+        expect_any_instance_of(::Hyrax::FileSetDerivativesService).to receive(:valid?).and_return(true)
+        expect_any_instance_of(::Hyrax::FileSetDerivativesService).to receive(:create_derivatives).with(file_path)
+        expect(other_applicator).to receive(:apply!)
+
+        subject
+      end
+    end
+
+    context 'when the other locator finds the derivative' do
+      let(:other_locator) { double(locate: file_path) }
+
+      it 'uses that located derivative and applies it' do
+        # Yes, we will attempt to apply the derivative...
+        expect_any_instance_of(Samvera::Derivatives::Hyrax::FileApplicatorStrategy).to receive(:apply!).and_call_original
+        # ...however, we won't be leveraging the wrapper's derivative work; meaning no default behavior.
+        expect_any_instance_of(Samvera::Derivatives::Hyrax::FileSetDerivativesServiceWrapper).not_to receive(:apply!)
+        expect_any_instance_of(::Hyrax::FileSetDerivativesService).not_to receive(:valid?)
+        expect_any_instance_of(::Hyrax::FileSetDerivativesService).not_to receive(:create_derivatives)
+        expect(other_applicator).to receive(:apply!)
+
+        subject
+      end
+    end
+  end
+end

data/spec/samvera/derivatives_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'samvera/derivatives'
+
+RSpec.describe Samvera::Derivatives do
+  describe '.config' do
+    subject { described_class.config }
+
+    it { is_expected.to be_a(described_class::Configuration) }
+  end
+
+  describe '.locate_and_apply_derivative_for' do
+    let(:file_set) { double(FileSet) }
+    let(:file_path) { __FILE__ }
+    let(:applicability) { true }
+    let(:type) { :thumbnail }
+    let(:locator) { described_class::FileLocator::Strategy }
+    let(:applicator) { described_class::FileApplicator::Strategy }
+
+    let(:derivative) do
+      described_class::Configuration::RegisteredType.new(
+        type: type,
+        applicators: [applicator],
+        locators: [locator],
+        applicability: ->(_) { applicability }
+      )
+    end
+
+    subject do
+      described_class.locate_and_apply_derivative_for(
+        file_set: file_set,
+        derivative: derivative,
+        file_path: file_path
+      )
+    end
+
+    context 'when not applicable' do
+      let(:applicability) { false }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when applicable' do
+      let(:from_location) { :from_location }
+
+      it 'locates then applies the derivative' do
+        expect(locator).to receive(:locate).and_return(from_location)
+        expect(applicator).to receive(:apply!).with(file_set: file_set, derivative_type: type, from_location: from_location)
+
+        subject
+      end
+    end
+  end
+end

data/spec/services/iiif_print/derivative_rodeo_service_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe IiifPrint::DerivativeRodeoService do
+  let(:work) { double("Work", { :id => 'work-5678', described_class.parent_work_identifier_property_name => 'hello-1234-id' }) }
+  let(:file_set) { FileSet.new.tap { |fs| fs.save!(validate: false) } }
+  let(:generator) { DerivativeRodeo::Generators::CopyGenerator }
+  let(:output_extension) { "rb" }
+
+  before do
+    allow(file_set).to receive(:parent).and_return(work)
+
+    # TODO: This is a hack that leverages the internals oof Hydra::Works; not excited about it but
+    # this part is only one piece of the over all integration.
+    allow(file_set).to receive(:original_file).and_return(double(original_filename: __FILE__))
+  end
+
+  let(:instance) { described_class.new(file_set) }
+
+  subject(:klass) { described_class }
+
+  describe '.preprocessed_location_adapter_name' do
+    subject { described_class.preprocessed_location_adapter_name }
+    it { is_expected.to eq 's3' }
+  end
+
+  describe '.parent_work_identifier_property_name' do
+    subject { described_class.parent_work_identifier_property_name }
+    it { is_expected.to be_a String }
+  end
+
+  describe '.named_derivatives_and_generators_by_type' do
+    subject { described_class.named_derivatives_and_generators_by_type }
+    it { is_expected.to be_a Hash }
+  end
+
+  describe '.derivative_rodeo_uri' do
+    subject { described_class.derivative_rodeo_uri(file_set: file_set, filename: __FILE__) }
+
+    context 'when the file_set does not have a parent' do
+      xit 'is expected to raise an error' do
+        expect { subject }.to raise_error(IiifPrint::DataError)
+      end
+    end
+
+    context 'when the file_set has a parent' do
+      it { is_expected.to start_with("#{described_class.preprocessed_location_adapter_name}://") }
+      it { is_expected.to end_with(File.basename(__FILE__)) }
+    end
+
+    context 'for a thumbnail based on a PDF' do
+      let(:extension) { DerivativeRodeo::Generators::ThumbnailGenerator.output_extension }
+      let(:filename) { "/tmp/d20230714-1897-1wgmauo/#{work.aark_id}.ARCHIVAL.pdf" }
+      it 'has the correct filename' do
+        expect(described_class.derivative_rodeo_uri(file_set: file_set, filename: filename, extension: extension,
+adapter_name: 'file')).to eq("file://#{work.aark_id}/#{work.aark_id}.ARCHIVAL.#{extension}")
+      end
+    end
+
+    context 'for the original file' do
+      let(:extension) { nil }
+      let(:filename) { "/tmp/d20230714-1897-1wgmauo/#{work.aark_id}.ARCHIVAL.pdf" }
+      it 'has the correct filename' do
+        expect(described_class.derivative_rodeo_uri(file_set: file_set, filename: filename, extension: extension, adapter_name: 'file')).to eq("file://#{work.aark_id}/#{work.aark_id}.ARCHIVAL.pdf")
+      end
+    end
+  end
+
+  # TODO: Need Faux Bucket for Derivative Rodeo
+  xdescribe '#valid?' do
+    subject { instance.valid? }
+
+    before do
+      allow(file_set).to receive(:mime_type).and_return(mime_type)
+      allow(file_set).to receive(:parent).and_return(work)
+    end
+
+    context 'when the mime_type of the file is not supported' do
+      let(:mime_type) { "text/plain" }
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when derivative rodeo has not pre-processed the file set' do
+      before { instance.preprocessed_location_adapter_name = "file" }
+
+      let(:mime_type) { "application/pdf" }
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when the mime type is supported and the derivative rodeo has pre-processed the file set' do
+      before do
+        # TODO: write to the rodeo; consider using AWS's spec support; I want to be able to "fake" S3
+        # with a "fake" bucket.
+        #
+        # Dependent on https://github.com/scientist-softserv/derivative_rodeo/pull/37
+      end
+
+      let(:mime_type) { "application/pdf" }
+      it { is_expected.to be_truthy }
+    end
+  end
+end

data/spec/services/iiif_print/manifest_builder_service_behavior_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe IiifPrint::ManifestBuilderServiceBehavior do
+  context '#initialize' do
+    it 'uses defaults to set the version' do
+      builder_service = Hyrax::ManifestBuilderService.new
+      expect(builder_service.manifest_factory).to eq(::IIIFManifest::ManifestFactory)
+      expect(builder_service.version).to eq(IiifPrint.config.default_iiif_manifest_version)
+    end
+
+    it 'allows version overrides' do
+      # This in part verifies the expected interaction of the version as a parameter being picked up
+      # by another parameter.
+      builder_service = Hyrax::ManifestBuilderService.new(version: 3)
+      expect(builder_service.manifest_factory).to eq(::IIIFManifest::V3::ManifestFactory)
+      expect(builder_service.version).to eq(3)
+    end
+  end
+end

data/spec/services/iiif_print/pluggable_derivative_service_spec.rb

@@ -111,10 +111,7 @@ RSpec.describe IiifPrint::PluggableDerivativeService do
         def expected_plugins
           [
             Hyrax::FileSetDerivativesService,
-            IiifPrint::JP2DerivativeService,
-            IiifPrint::PDFDerivativeService,
-            IiifPrint::TextExtractionDerivativeService,
-            IiifPrint::TIFFDerivativeService
+            IiifPrint::TextExtractionDerivativeService
           ]
         end
 
@@ -123,7 +120,7 @@ RSpec.describe IiifPrint::PluggableDerivativeService do
           plugins = described_class.new(persisted_file_set).plugins
           fs = persisted_file_set
           services = plugins.map { |plugin| plugin.new(fs) }.select(&:valid?)
-          expect(services.length).to eq 5
+          expect(services.length).to eq 2
           used_plugins = services.map(&:class)
           expected_plugins.each do |plugin|
             expect(used_plugins).to include plugin
@@ -136,8 +133,6 @@ RSpec.describe IiifPrint::PluggableDerivativeService do
           made = derivatives_for(persisted_file_set)
           made.each { |path| expect(File.exist?(path)) }
           extensions = made.map { |path| path.split('.')[-1] }
-          expect(extensions).to include 'pdf'
-          expect(extensions).to include 'jp2'
           expect(extensions).not_to include 'tiff'
           # Thumbnail, created by Hyrax:
           expect(extensions).to include 'jpeg'
@@ -154,19 +149,21 @@ RSpec.describe IiifPrint::PluggableDerivativeService do
           )
         end
 
-        def jp2_plugin?(plugins)
-          r = plugins.select { |p| p.is_a? IiifPrint::JP2DerivativeService }
+        def text_plugin?(plugins)
+          r = plugins.select { |p| p.is_a? IiifPrint::TextExtractionDerivativeServiceService }
           !r.empty?
         end
 
-        it "will not attempt creating over pre-made derivative" do
+        # TODO: This is not working with the default configuration and is part of a larger refactor
+        # regarding specs.
+        xit "will not attempt creating over pre-made derivative" do
           service = described_class.new(persisted_file_set)
           # this should be respected, evaluate by obtaining filtered
           #   services list, which must omit JP2DerivativeService
           plugins = service.services(:create_derivatives)
           # initially has jp2 plugin
           expect(jp2_plugin?(plugins)).to be true
-          # blacklist jp2 by effect of log entry of pre-made attachment
+          # deny jp2 by effect of log entry of pre-made attachment
           log_attachment(service.file_set)
           # omits, after logging intent of previous attachment:
           plugins = service.services(:create_derivatives)

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -5,7 +5,7 @@ class TestAppGenerator < Rails::Generators::Base
   source_root File.expand_path('../../../spec/test_app_templates', __dir__)
 
   def install_redis
-    gem 'redis', '4.8.0'
+    gem 'redis', '4.8.1'
     Bundler.with_unbundled_env do
       run "bundle install"
     end

data/tasks/copy_authorities_to_test_app.rake

@@ -0,0 +1,11 @@
+namespace :engine_cart do
+  desc "Copy custom rights_statement and license questioning authority YAML files into the test app"
+  task copy_authorities: :generate do
+    test_app_path = ENV['ENGINE_CART_DESTINATION'] || File.expand_path(".internal_test_app", File.dirname(__FILE__))
+    src_dir = File.expand_path("../spec/fixtures/authorities", __dir__)
+    dest_dir = File.join(test_app_path, "config/authorities")
+
+    FileUtils.mkdir_p(dest_dir)
+    FileUtils.cp_r("#{src_dir}/.", dest_dir)
+  end
+end

data/tasks/iiif_print_dev.rake

@@ -20,14 +20,14 @@ task :spec_with_app_load do
 end
 
 if ENV.fetch('IN_DOCKER', false)
-  desc 'Generate the engine_cart and spin up test servers and run specs'
-  task ci: %w[rubocop engine_cart:generate] do
+  desc 'Generate the engine_cart, copy authorities and spin up test servers and run specs'
+  task ci: %w[rubocop engine_cart:generate engine_cart:copy_authorities] do
     puts 'running continuous integration'
     Rake::Task['spec'].invoke
   end
 else
-  desc 'Generate the engine_cart and spin up test servers and run specs'
-  task ci: %w[rubocop engine_cart:generate] do
+  desc 'Generate the engine_cart, copy authorities and spin up test servers and run specs'
+  task ci: %w[rubocop engine_cart:generate engine_cart:copy_authorities] do
     puts 'running continuous integration'
     Rake::Task['spec_with_app_load'].invoke
   end