riiif 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c83cf037ced763741c5aa704db17564fd43ee2610866d27629b1de4700c518a
-  data.tar.gz: 447135b1b851c29969cd42a91a51b26facb1084b47dc246422b11a15de0dcbc5
+  metadata.gz: 9993f1679d618e86c346172bc70c57947d1fcf8d06ee7c704981b099270fe605
+  data.tar.gz: dab42c9074cf26db432fca000121fcf54772cd03d80d05cbfbdb38ca9b53ae40
 SHA512:
-  metadata.gz: 86952c0517dfd44217aee70ae4927209aaa7c4078c9142126a6f0a06fe831774371dffb0191c2719cb868249b98b324cbfbf7853c2518622bb67dc2d1afab182
-  data.tar.gz: f315b4762cf831614a80728ac072678ea4ad9f1fc38cbc836cd7f6e3eaf6c2009b870682e0024d4cebca02c9da919a33dde3b66bcd98ac8da5f2f4d5691b23fd
+  metadata.gz: 162484c5fa19da91a13ba5168e0902f7ccaa315026299eca14f7556abee5b2c00d7d1667cd840dff77156089f355230f763460cc9a761071d9eb277c51394a74
+  data.tar.gz: 68d5b87acb4e5d19efff588dbdc5a352e839529be45bff33a58443497f0939dc94a30001ff95cb3be37d52c99090b5c3b49f70638902f047e8a78c9960e969ba

data/.github/workflows/ruby.yml

@@ -22,8 +22,11 @@ jobs:
         rails: ["8.1.1", "8.0.4", "7.2.3"]
     steps:
       - name: Install ImageMagick
-        run: sudo apt install imagemagick
-      - uses: actions/checkout@v6
+        run: |
+          sudo rm -f /var/lib/man-db/auto-update
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends imagemagick
+      - uses: actions/checkout@v7
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/README.md

@@ -102,6 +102,16 @@ To use [libvips](https://www.libvips.org/) instead of ImageMagick
 Riiif::Engine.config.use_vips = true
 ```
 
+### EXIF orientation
+
+By default, derivatives and `info.json` dimensions use the raw stored pixels and ignore the EXIF Orientation tag. To apply it (as browsers and thumbnailers do):
+
+```ruby
+Riiif::Engine.config.autorotate = true
+```
+
+This works with ImageMagick and libvips. Cached derivatives and `info.json` need to be cleared after changing it.
+
 ## Usage
 
 Add the routes to your application by inserting the following line into `config/routes.rb`

data/app/extractors/riiif/image_magick_info_extractor.rb

@@ -6,7 +6,7 @@ module Riiif
 
     def extract
       height, width, format, channels = Riiif::CommandRunner.execute(
-        "#{external_command} -format '%h %w %m %[channels]' '#{@path}[0]'"
+        "#{external_command}#{' -auto-orient' if Riiif.autorotate?} -format '%h %w %m %[channels]' '#{@path}[0]'"
       ).split(' ')
 
       {

data/app/extractors/riiif/vips_info_extractor.rb

@@ -6,16 +6,17 @@ module Riiif
     self.external_command = 'vipsheader'
 
     def extract
-      attributes = Riiif::CommandRunner.execute("#{external_command} '#{@path}' -a")
-                                       .split(/\n/)
-                                       .map { |str| str.strip.split(': ', 2) }.to_h
-      width, height = attributes.values_at("width", "height")
+      vipsloader = Riiif::CommandRunner.execute(
+        "#{external_command} -f vips-loader '#{@path}'"
+      ).strip
+      image = ::Vips::Image.new_from_file(@path.to_s)
+      image = image.autorot if Riiif.autorotate?
 
       {
-        height: Integer(height),
-        width: Integer(width),
-        format: attributes["vips-loader"].match?("pngload") ? "PNG" : "JPEG",
-        channels: ::Vips::Image.new_from_file(@path.to_s).has_alpha? ? "srgba" : "srgb"
+        height: image.height,
+        width: image.width,
+        format: vipsloader.match?("pngload") ? "PNG" : "JPEG",
+        channels: image.has_alpha? ? "srgba" : "srgb"
       }
     end
   end

data/app/services/riiif/imagemagick_command_factory.rb

@@ -29,6 +29,7 @@ module Riiif
     def command
       [
         external_command,
+        auto_orient,
         crop,
         size,
         rotation,
@@ -79,6 +80,10 @@ module Riiif
         end
       end
 
+      def auto_orient
+        ' -auto-orient' if Riiif.autorotate?
+      end
+
       def crop
         directive = Crop.new(transformation.region, info).to_imagemagick
         " -crop #{directive}" if directive

data/app/transformers/riiif/vips_transformer.rb

@@ -15,6 +15,7 @@ module Riiif
     def initialize(path, image_info, transformation, compression: 85, subsample: true, strip_metadata: true)
       super(path, image_info, transformation)
       @image = ::Vips::Image.new_from_file(path.to_s)
+      @image = @image.autorot if Riiif.autorotate?
       @compression = compression
       @subsample = subsample
       @strip_metadata = strip_metadata

data/lib/riiif/engine.rb

@@ -15,6 +15,9 @@ module Riiif
     # https://www.libvips.org/
     config.use_vips = false
 
+    # Set to true to apply EXIF orientation to derivatives and reported dimensions
+    config.autorotate = false
+
     config.before_configuration do
       # see https://github.com/fxn/zeitwerk#for_gem
       # We put a generator into LOCAL APP lib/generators, so tell

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = '2.8.1'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/lib/riiif.rb

@@ -32,4 +32,8 @@ module Riiif
   def self.use_vips?
     Engine.config.use_vips
   end
+
+  def self.autorotate?
+    Engine.config.autorotate
+  end
 end

data/riiif.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'bixby', '~> 5.0'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
 end

data/spec/extractors/riiif/image_magick_info_extractor_spec.rb

@@ -3,6 +3,15 @@ RSpec.describe Riiif::ImageMagickInfoExtractor do
     expect(described_class.external_command).to eq "identify"
   end
 
+  context 'when autorotate is enabled' do
+    before { allow(Riiif).to receive(:autorotate?).and_return(true) }
+
+    it 'asks identify to auto-orient' do
+      expect(Riiif::CommandRunner).to receive(:execute).with(/\Aidentify -auto-orient /).and_return('376 500 JPEG srgb')
+      expect(described_class.new('x.jpg').extract).to include(width: 500, height: 376)
+    end
+  end
+
   context 'with a jpg' do
     let(:image) { Rails.root.join("spec", "fixtures", "test.jpg") }
 

data/spec/extractors/riiif/vips_info_extractor_spec.rb

@@ -6,15 +6,9 @@ RSpec.describe Riiif::VipsInfoExtractor do
     allow(Vips::Image).to receive(:new_from_file).and_return(image)
   end
 
-  let(:image) { double(has_alpha?: false) }
+  let(:image) { double(has_alpha?: false, width: 500, height: 376) }
 
-  let(:fake_info) do
-    "width: 500
-    height: 376
-    interpretation: srgb
-    filename: spec/fixtures/test.tif
-    vips-loader: tiffload"
-  end
+  let(:fake_info) { "tiffload" }
 
   it 'uses vipsheader as its external command' do
     expect(described_class.external_command).to eq "vipsheader"
@@ -31,45 +25,30 @@ RSpec.describe Riiif::VipsInfoExtractor do
     end
   end
 
-  context 'on a file with transparency' do
-    let(:image) { double(has_alpha?: true) }
+  context 'when autorotate is enabled' do
+    let(:oriented) { double(has_alpha?: false, width: 376, height: 500) }
 
-    let(:fake_info) do
-      "width: 50
-      height: 50
-      interpretation: srgb
-      filename: spec/fixtures/test.tif
-      vips-loader: pngload"
+    before do
+      allow(Riiif).to receive(:autorotate?).and_return(true)
+      allow(image).to receive(:autorot).and_return(oriented)
     end
 
-    it 'returns the extracted attributes' do
-      expect(described_class.new(image).extract).to eq({
-                                                         height: 50,
-                                                         width: 50,
-                                                         format: "PNG",
-                                                         channels: "srgba"
-                                                       })
+    it 'reports the dimensions after orientation is applied' do
+      expect(described_class.new("path/to/image.jpg").extract).to include(width: 376, height: 500)
     end
   end
 
-  context 'on a JPEG file with extra EXIF metadata' do
-    let(:image) { double(has_alpha?: false) }
+  context 'on a file with transparency' do
+    let(:image) { double(has_alpha?: true, width: 50, height: 50) }
 
-    let(:fake_info) do
-      "width: 150
-      height: 150
-      interpretation: srgb
-      filename: spec/fixtures/test.jpeg
-      vips-loader: jpegload
-      exif-ifd0-Artist: University Library (Digital Object: Digital Media Group)"
-    end
+    let(:fake_info) { "pngload" }
 
     it 'returns the extracted attributes' do
       expect(described_class.new(image).extract).to eq({
-                                                         height: 150,
-                                                         width: 150,
-                                                         format: "JPEG",
-                                                         channels: "srgb"
+                                                         height: 50,
+                                                         width: 50,
+                                                         format: "PNG",
+                                                         channels: "srgba"
                                                        })
     end
   end

data/spec/models/riiif/image_spec.rb

@@ -58,8 +58,21 @@ RSpec.describe Riiif::Image do
 
     describe 'get info' do
       subject { described_class.new('Cave_26,_Ajanta') }
-      it 'is easy' do
-        expect(subject.info).to eq Riiif::ImageInformation.new(width: 600, height: 390)
+
+      before do
+        stub_request(:get, "https://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/Cave_26,_Ajanta.jpg/600px-Cave_26,_Ajanta.jpg")
+          .with(
+                   headers: {
+                     'Accept' => '*/*',
+                     'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                     'User-Agent' => 'Ruby'
+                   }
+                 )
+          .to_return(status: 200, body: File.binread('spec/fixtures/test.jpg'), headers: {})
+      end
+
+      it 'gets the info' do
+        expect(subject.info).to eq Riiif::ImageInformation.new(width: 300, height: 397)
       end
     end
 

data/spec/services/riiif/imagemagick_command_factory_spec.rb

@@ -16,6 +16,21 @@ RSpec.describe Riiif::ImagemagickCommandFactory do
                                       format: target)
     end
 
+    context 'with autorotate' do
+      subject { described_class.new(tiff, info, transformation).command }
+
+      let(:source) { 'tif' }
+      let(:target) { 'jpg' }
+
+      it { is_expected.not_to match(/-auto-orient/) }
+
+      context 'when enabled' do
+        before { allow(Riiif).to receive(:autorotate?).and_return(true) }
+
+        it { is_expected.to match(/convert -auto-orient /) }
+      end
+    end
+
     context "when the target format is jpeg" do
       subject { described_class.new(tiff, info, transformation).command }
 

data/spec/spec_helper.rb

@@ -7,6 +7,8 @@ ENV['RAILS_ENV'] ||= 'test'
 
 EngineCart.load_application!
 require 'rspec/rails'
+require 'webmock/rspec'
+WebMock.disable_net_connect!
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

data/spec/transformers/riiif/vips_transformer_spec.rb

@@ -49,9 +49,27 @@ RSpec.describe Riiif::VipsTransformer 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")
+      expect(Vips::Image).to receive(:new_from_file).with("path/to/image.tif").and_return(image)
       described_class.new(path, image_info, transformation)
     end
+
+    it 'does not apply EXIF orientation by default' do
+      expect(image).not_to receive(:autorot)
+      expect(described_class.new(path, image_info, transformation).image).to eq image
+    end
+
+    context 'when autorotate is enabled' do
+      let(:oriented) { double('Oriented Vips Image', has_alpha?: false) }
+
+      before do
+        allow(Riiif).to receive(:autorotate?).and_return(true)
+        allow(image).to receive(:autorot).and_return(oriented)
+      end
+
+      it 'applies the EXIF orientation to the source image' do
+        expect(described_class.new(path, image_info, transformation).image).to eq oriented
+      end
+    end
   end
 
   describe '#transform' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -169,6 +169,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: A IIIF image server
 email:
 - jcoyne85@stanford.edu
@@ -258,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.7
+rubygems_version: 4.0.22
 specification_version: 4
 summary: A Rails engine that support IIIF requests
 test_files: