riiif 2.1.0 → 2.8.1

data/spec/models/riiif/file_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe Riiif::File do
+  describe '#info_extractor_class' do
+    subject { described_class.info_extractor_class }
+
+    context 'when not using vips' do
+      it { is_expected.to eq Riiif::ImageMagickInfoExtractor }
+    end
+
+    context 'when vips is configured' do
+      before { allow(Riiif).to receive(:use_vips?).and_return true }
+
+      it { is_expected.to eq Riiif::VipsInfoExtractor }
+    end
+  end
+
+  describe '#transformer' do
+    subject { described_class.new('path.jp2', double).transformer }
+
+    context 'when vips is configured' do
+      before { allow(Riiif).to receive(:use_vips?).and_return true }
+
+      it { is_expected.to eq Riiif::VipsTransformer }
+    end
+
+    context 'when Kakadu is enabled' do
+      before { allow(Riiif).to receive(:kakadu_enabled?).and_return true }
+
+      it { is_expected.to eq Riiif::KakaduTransformer }
+    end
+
+    context 'when using image/graphicsmagick without Kakadu' do
+      it { is_expected.to eq Riiif::ImagemagickTransformer }
+    end
+  end
+end

data/spec/models/riiif/file_system_file_resolver_spec.rb

@@ -78,5 +78,12 @@ describe Riiif::FileSystemFileResolver do
         expect(subject).to be_nil
       end
     end
+
+    context 'as an integer' do
+      let(:id) { 1 }
+      it 'converts it to a string before parsing' do
+        expect { subject }.not_to raise_error
+      end
+    end
   end
 end

data/spec/models/riiif/http_file_resolver_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Riiif::HTTPFileResolver do
+describe Riiif::HttpFileResolver do
   subject { described_class.new }
 
   before do

data/spec/models/riiif/image_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe Riiif::Image do
 
     it 'renders' do
       expect(Riiif::CommandRunner).to receive(:execute)
-        .with("convert -quality 85 -sampling-factor 4:2:0 -strip #{filename} jpg:-")
+        .with("convert -quality 85 -sampling-factor 4:2:0 -strip \'#{filename}\' jpg:-")
         .and_return('imagedata')
 
       expect(subject.render('size' => 'full', format: 'jpg')).to eq 'imagedata'
@@ -28,6 +28,9 @@ RSpec.describe Riiif::Image do
   end
 
   it 'is able to override the file used for the Image' do
+    allow(Riiif::CommandRunner).to receive(:execute)
+      .with("identify -format '%h %w %m %[channels]' \'#{filename}[0]\'").and_return('400 800')
+
     img = described_class.new('some_id', Riiif::File.new(filename))
     expect(img.id).to eq 'some_id'
     expect(img.info).to eq Riiif::ImageInformation.new(width: 800, height: 400)
@@ -35,13 +38,16 @@ RSpec.describe Riiif::Image do
 
   describe 'info' do
     it 'returns the data' do
+      allow(Riiif::CommandRunner).to receive(:execute)
+        .with("identify -format '%h %w %m %[channels]' \'#{filename}[0]\'").and_return('400 800')
+
       expect(subject.info).to eq Riiif::ImageInformation.new(width: 800, height: 400)
     end
   end
 
-  context 'using HTTPFileResolver' do
+  context 'using HttpFileResolver' do
     before do
-      described_class.file_resolver = Riiif::HTTPFileResolver.new
+      described_class.file_resolver = Riiif::HttpFileResolver.new
       described_class.file_resolver.id_to_uri = lambda do |id|
         "https://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/#{id}.jpg/600px-#{id}.jpg"
       end
@@ -71,7 +77,7 @@ RSpec.describe Riiif::Image do
   describe '#render' do
     before do
       allow(Riiif::CommandRunner).to receive(:execute)
-        .with("identify -format '%h %w %m %[channels]' #{filename}[0]").and_return('131 175 JPEG')
+        .with("identify -format '%h %w %m %[channels]' \'#{filename}[0]\'").and_return('131 175 JPEG')
     end
 
     describe 'region' do
@@ -82,7 +88,7 @@ RSpec.describe Riiif::Image do
 
         it 'returns the original' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -strip #{filename} png:-")
+            .with("convert -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -92,7 +98,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -crop 60x75+80+15 -strip #{filename} png:-")
+            .with("convert -crop 60x75+80+15 -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -102,7 +108,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -crop 80.0%x70.0+18+13 -strip #{filename} png:-")
+            .with("convert -crop 80.0%x70.0+18+13 -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -112,7 +118,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -crop 131x131+22+0 -strip #{filename} png:-")
+            .with("convert -crop 131x131+22+0 -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -134,7 +140,7 @@ RSpec.describe Riiif::Image do
 
         it 'returns the original' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -strip #{filename} png:-")
+            .with("convert -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -144,7 +150,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -resize 50.0% -strip #{filename} png:-")
+            .with("convert -resize 50.0% -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -154,7 +160,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -resize 12.5% -strip #{filename} png:-")
+            .with("convert -resize 12.5% -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -164,7 +170,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -resize 50 -strip #{filename} png:-")
+            .with("convert -resize 50 -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -174,7 +180,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -resize x50 -strip #{filename} png:-")
+            .with("convert -resize x50 -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -184,7 +190,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -resize 150x75! -strip #{filename} png:-")
+            .with("convert -resize 150x75! -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -193,7 +199,7 @@ RSpec.describe Riiif::Image do
 
         it 'runs the correct imagemagick command' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -resize 150x75 -strip #{filename} png:-")
+            .with("convert -resize 150x75 -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -215,7 +221,7 @@ RSpec.describe Riiif::Image do
 
         it 'returns the original' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -strip #{filename} png:-")
+            .with("convert -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -225,7 +231,7 @@ RSpec.describe Riiif::Image do
 
         it 'handles floats' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -virtual-pixel white +distort srt 22.5 -strip #{filename} png:-")
+            .with("convert -virtual-pixel white +distort srt 22.5 -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -247,7 +253,7 @@ RSpec.describe Riiif::Image do
 
         it 'returns the original when specifing default' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -strip #{filename} png:-")
+            .with("convert -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -257,7 +263,7 @@ RSpec.describe Riiif::Image do
 
         it 'returns the original when specifing color' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -strip #{filename} png:-")
+            .with("convert -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -267,7 +273,7 @@ RSpec.describe Riiif::Image do
 
         it 'converts to grayscale' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -colorspace Gray -strip #{filename} png:-")
+            .with("convert -colorspace Gray -strip \'#{filename}\' png:-")
           render
         end
       end
@@ -277,7 +283,7 @@ RSpec.describe Riiif::Image do
 
         it 'converts to bitonal' do
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with("convert -colorspace Gray -type Bilevel -strip #{filename} png:-")
+            .with("convert -colorspace Gray -type Bilevel -strip \'#{filename}\' png:-")
           render
         end
       end

data/spec/spec_helper.rb

@@ -1,11 +1,5 @@
-require 'coveralls'
 require 'simplecov'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-                                                                 SimpleCov::Formatter::HTMLFormatter,
-                                                                 Coveralls::SimpleCov::Formatter
-                                                               ])
-
 SimpleCov.start('rails')
 
 require 'engine_cart'

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

@@ -1,9 +1,14 @@
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base
-  source_root 'spec/test_app_templates'
+  # source_root 'spec/test_app_templates'
+  source_root File.expand_path("../../../spec", __dir__)
 
   def add_routes
     route "mount Riiif::Engine => '/images', as: 'riiif'"
   end
+
+  def copy_fixtures
+    directory 'fixtures', 'spec/fixtures'
+  end
 end

data/spec/transformers/riiif/kakadu_transformer_spec.rb

@@ -42,7 +42,7 @@ RSpec.describe Riiif::KakaduTransformer do
           .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 ' \
                 '-region "{0.1,0.2},{0.1,0.1}" -reduce 4 -o /tmp/foo.bmp')
         expect(Riiif::CommandRunner).to receive(:execute)
-          .with('convert -resize 38x38! -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+          .with('convert -resize 38x38! -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
         transform
       end
     end
@@ -54,7 +54,7 @@ RSpec.describe Riiif::KakaduTransformer do
           expect(Riiif::CommandRunner).to receive(:execute)
             .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 -o /tmp/foo.bmp')
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with('convert -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+            .with('convert -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
           transform
         end
       end
@@ -67,7 +67,7 @@ RSpec.describe Riiif::KakaduTransformer do
           expect(Riiif::CommandRunner).to receive(:execute)
             .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 -o /tmp/foo.bmp')
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with('convert -resize 651 -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+            .with('convert -resize 651 -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
           transform
         end
       end
@@ -80,7 +80,7 @@ RSpec.describe Riiif::KakaduTransformer do
           expect(Riiif::CommandRunner).to receive(:execute)
             .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 -o /tmp/foo.bmp')
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with('convert -resize x581 -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+            .with('convert -resize x581 -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
           transform
         end
       end
@@ -96,7 +96,7 @@ RSpec.describe Riiif::KakaduTransformer do
           expect(Riiif::CommandRunner).to receive(:execute)
             .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 -reduce 1 -o /tmp/foo.bmp')
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with('convert -resize 60.0% -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+            .with('convert -resize 60.0% -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
           transform
         end
       end
@@ -109,7 +109,7 @@ RSpec.describe Riiif::KakaduTransformer do
           expect(Riiif::CommandRunner).to receive(:execute)
             .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 -reduce 1 -o /tmp/foo.bmp')
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with('convert -resize 408 -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+            .with('convert -resize 408 -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
           transform
         end
       end
@@ -122,7 +122,7 @@ RSpec.describe Riiif::KakaduTransformer do
           expect(Riiif::CommandRunner).to receive(:execute)
             .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 -reduce 1 -o /tmp/foo.bmp')
           expect(Riiif::CommandRunner).to receive(:execute)
-            .with('convert -resize x481 -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+            .with('convert -resize x481 -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
           transform
         end
       end
@@ -135,7 +135,7 @@ RSpec.describe Riiif::KakaduTransformer do
         expect(Riiif::CommandRunner).to receive(:execute)
           .with('kdu_expand -quiet -i baseball.jp2 -num_threads 4 -reduce 2 -o /tmp/foo.bmp')
         expect(Riiif::CommandRunner).to receive(:execute)
-          .with('convert -resize 80.0% -quality 85 -sampling-factor 4:2:0 -strip /tmp/foo.bmp jpg:-')
+          .with('convert -resize 80.0% -quality 85 -sampling-factor 4:2:0 -strip \'/tmp/foo.bmp\' jpg:-')
         transform
       end
     end

data/spec/transformers/riiif/vips_transformer_spec.rb

@@ -0,0 +1,271 @@
+require 'spec_helper'
+
+begin
+  require 'ruby-vips'
+rescue LoadError
+  module Vips
+    class Image
+      # Intentionally blank.
+      #
+      # This prevents uninitialized constant errors if vips
+      # is not installed.
+    end
+  end
+end
+
+RSpec.describe Riiif::VipsTransformer do
+  let(:channels) { 'rgb' }
+
+  let(:path) { "path/to/image.tif" }
+
+  let(:image) { double('Vips Image', has_alpha?: false) }
+
+  let(:image_info) do
+    double({ height: 376,
+             width: 500,
+             format: 'jpg',
+             channels: channels })
+  end
+
+  let(:target) { 'jpg' }
+
+  let(:transformation) do
+    IIIF::Image::Transformation.new(region: region,
+                                    size: size,
+                                    rotation: rotation,
+                                    format: target)
+  end
+
+  # Default/Placeholder values that should be modified in tests
+  let(:size) { IIIF::Image::Size::Full.new }
+  let(:region) { IIIF::Image::Region::Full.new }
+  let(:rotation) { 0 }
+
+  before do
+    allow(Vips::Image).to receive(:new_from_file).and_return(image)
+  end
+
+  describe '#initialize' do
+    let(:path) { Pathname.new("path/to/image.tif") }
+
+    it 'normalizes pathnames to strings' do
+      expect(Vips::Image).to receive(:new_from_file).with("path/to/image.tif")
+      described_class.new(path, image_info, transformation)
+    end
+  end
+
+  describe '#transform' do
+    subject { described_class.new(path, image_info, transformation).transform }
+    before { allow(image).to receive(:write_to_buffer) }
+    after { subject }
+
+    context 'when requesting jpg format with default options' do
+      it 'writes to jpg format' do
+        expect(image).to receive(:write_to_buffer).with(".jpg[Q=85,optimize-coding,strip]")
+      end
+    end
+
+    context 'when requesting png format with default options' do
+      let(:target) { 'png' }
+
+      it 'writes to png format' do
+        expect(image).to receive(:write_to_buffer).with(".png[Q=85,strip]")
+      end
+    end
+
+    context 'when requesting jpeg format for a png' do
+      let(:image) { double('Vips Image', has_alpha?: true) }
+
+      it 'writes to png anyway to preserve transparency' do
+        expect(image).to receive(:write_to_buffer).with(".png[Q=85,strip]")
+      end
+    end
+
+    context 'with subsampling turned off' do
+      subject { described_class.new(path, image_info, transformation, subsample: false).transform }
+
+      it 'does not subsample' do
+        expect(image).to receive(:write_to_buffer).with(".jpg[Q=85,optimize-coding,strip,no-subsample]")
+      end
+    end
+
+    context 'when specifying compression factor' do
+      subject { described_class.new(path, image_info, transformation, compression: 90).transform }
+
+      it 'compresses to the correct quality' do
+        expect(image).to receive(:write_to_buffer).with(".jpg[Q=90,optimize-coding,strip]")
+      end
+    end
+
+    context 'when strip_metadata is false' do
+      subject { described_class.new(path, image_info, transformation, strip_metadata: false).transform }
+
+      it 'does not strip metadata' do
+        expect(image).to receive(:write_to_buffer).with(".jpg[Q=85,optimize-coding]")
+      end
+    end
+  end
+
+  describe '#transform_image' do
+    subject { described_class.new(path, image_info, transformation).send(:transform_image) }
+
+    before do
+      allow(image).to receive_messages(crop: image, resize: image, rotate: image, thumbnail_image: image, colourspace: image)
+    end
+
+    describe 'resize' do
+      context 'when specifing full size' do
+        it 'does not resize' do
+          expect(image).not_to receive(:resize)
+          expect(image).not_to receive(:thumbnail_image)
+          subject
+        end
+      end
+
+      context 'when specifing percent size' do
+        let(:size) { IIIF::Image::Size::Percent.new(50) }
+
+        it 'resizes the image' do
+          expect(image).to receive(:resize).with(50.0)
+          expect(image).not_to receive(:thumbnail_image)
+          subject
+        end
+      end
+
+      context 'when specifing float percent size' do
+        let(:size) { IIIF::Image::Size::Percent.new(12.5) }
+
+        it 'resizes the image' do
+          expect(image).to receive(:resize).with(12.5)
+          expect(image).not_to receive(:thumbnail_image)
+          subject
+        end
+      end
+
+      context 'when specifying width and/or height' do
+        context 'when specifing w, size' do
+          let(:size) { IIIF::Image::Size::Width.new(300) }
+
+          before { allow(image).to receive(:width).and_return(600) }
+
+          it 'resizes the image to 300px wide, maintaining aspect ratio' do
+            expect(image).to receive(:resize).with(0.5)
+            subject
+          end
+        end
+
+        context 'when specifing ,h size' do
+          let(:size) { IIIF::Image::Size::Height.new(200) }
+
+          before { allow(image).to receive(:height).and_return(500) }
+
+          it 'resizes the image to 300px high, maintaining aspect ratio' do
+            expect(image).to receive(:resize).with(0.4)
+            subject
+          end
+        end
+
+        context 'when specifing absolute w,h size' do
+          let(:size) { IIIF::Image::Size::Absolute.new(200, 300) }
+
+          it 'resizes the image, ignoring aspect ratio' do
+            expect(image).to receive(:thumbnail_image).with(200, height: 300, size: :force)
+            subject
+          end
+        end
+
+        context 'when specifing bestfit (!w,h) size' do
+          let(:size) { IIIF::Image::Size::BestFit.new(200, 300) }
+
+          it 'resizes the image so that the width and height are equal or less than the requested value' do
+            expect(image).to receive(:thumbnail_image).with(200, height: 300)
+            subject
+          end
+        end
+      end
+    end
+
+    describe 'crop' do
+      after { subject }
+
+      context 'when specifing full size' do
+        let(:region) { IIIF::Image::Region::Full.new }
+
+        it 'does not crop' do
+          expect(image).not_to receive(:crop)
+        end
+      end
+
+      context 'when specifing absolute geometry' do
+        let(:region) { IIIF::Image::Region::Absolute.new(80, 15, 60, 75) }
+
+        it 'crops to that region' do
+          expect(image).to receive(:crop).with(80, 15, 60, 75)
+        end
+      end
+
+      context 'when specifing percent geometry' do
+        let(:region) { IIIF::Image::Region::Percent.new(10, 10, 80, 70) }
+        before { allow(image_info).to receive_messages(width: 100, height: 100, format: 'jpeg', channels: channels) }
+
+        it 'crops to that region' do
+          expect(image).to receive(:crop).with(10, 10, 80, 70)
+        end
+      end
+
+      context 'when specifing square geometry' do
+        let(:region) { IIIF::Image::Region::Square.new }
+
+        it 'crops a square the size of the shortest edge' do
+          expect(image).to receive(:crop).with(62, 0, 376, 376)
+        end
+      end
+    end
+
+    describe 'rotate' do
+      after { subject }
+
+      context 'when no rotation (0) is specified' do
+        it 'does not rotate' do
+          expect(image).not_to receive(:rotate)
+        end
+      end
+
+      context 'when rotation is specified' do
+        let(:rotation) { 45 }
+
+        it 'rotates the image' do
+          expect(image).to receive(:rotate).with(45)
+        end
+      end
+    end
+
+    describe 'colourspace' do
+      after { subject }
+
+      context 'when quality is default or color' do
+        it 'leaves the image in color' do
+          expect(image).not_to receive(:colourspace).with(:b_w)
+          expect(image).not_to receive(:>)
+        end
+      end
+
+      context 'when quality is gray' do
+        let(:transformation) { IIIF::Image::Transformation.new(region: region, size: size, rotation: rotation, quality: 'gray') }
+
+        it 'makes the image grayscale' do
+          expect(image).to receive(:colourspace).with(:b_w)
+        end
+      end
+
+      context 'when quality is bitonal' do
+        let(:transformation) { IIIF::Image::Transformation.new(region: region, size: size, rotation: rotation, quality: 'bitonal') }
+
+        it 'makes the image bitonal' do
+          expect(image).to receive(:colourspace).with(:b_w)
+          expect(image).to receive(:>).with(200)
+        end
+      end
+    end
+  end
+end