riiif 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b274258986b942fec11fa586bd52f13e9bf8a567725954f8ca6fd92282780207
-  data.tar.gz: d786222b5b9be2b1c6d514917adb239d498ed819f88f9de93d9a8f61852f1c5a
+  metadata.gz: 2e92c056972609b8cb70468fae8b71b34e1974b2ec4caa691af4422187886fa8
+  data.tar.gz: eae0755c48ed444ebc292b56f30bd13520d1e34988ec6c7c37087483bbfbd8d8
 SHA512:
-  metadata.gz: d4b7a1b45f2513f51abb150a0bc6678bc1578b4ab64da8487b7447af3a0cab2db922d8e7a49a5c737cfd9931e2abcd4f2bbeec37838862ecee49ffaeee6e9eb7
-  data.tar.gz: 4d06560bdbbf84747e7dba9f341fb6d5eff45dd6e1e573839aa8ec236b42dc242d7a31b8ff9c2bc4d6f31248839c9c3c0e39a76e884569904f7c36aa5aa5834b
+  metadata.gz: 5fe8da75c42178b50f8768cdb8f8383043d994865ab917d6b1b74083660b925265f0cd7d08f90f0670e7640c41dcf1b48736926a02855a391c51210ef96256f9
+  data.tar.gz: 11dbed920c6e8bd094cbd2ae01e9e5f29de71670833b3d39d231c5ad0415b39fbc4c3da95b9f79dc46d6e6e12f50a962ed4b425ad3d65fa28d960868655db9e1

data/.rubocop.yml

@@ -1,3 +1,11 @@
 inherit_from: .rubocop_todo.yml
 inherit_gem:
     bixby: bixby_default.yml
+
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+Bundler/OrderedGems:
+  Exclude:
+    - 'Gemfile'

data/Gemfile

@@ -3,3 +3,38 @@ source 'https://rubygems.org'
 gem 'byebug'
 # Specify your gem's dependencies in riiif.gemspec
 gemspec
+
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 2.0.1
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  end
+end
+# END ENGINE_CART BLOCK

data/README.md

@@ -2,6 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/riiif.png)](http://badge.fury.io/rb/riiif)
 [![Coverage Status](https://coveralls.io/repos/github/curationexperts/riiif/badge.svg?branch=master)](https://coveralls.io/github/curationexperts/riiif?branch=master)
 
+
 A Ruby IIIF image server as a rails engine
 
 ## Installation

data/app/models/riiif/image.rb

@@ -54,7 +54,8 @@ module Riiif
                   ImageInformation.new(
                     width: result[:width],
                     height: result[:height],
-                    format: result[:format]
+                    format: result[:format],
+                    channels: result[:channels]
                   )
                 end
     end

data/app/models/riiif/image_information.rb

@@ -11,12 +11,13 @@ module Riiif
         @width = args.first[:width]
         @height = args.first[:height]
         @format = args.first[:format]
+        @channels = args.first[:channels]
       end
     end
-    attr_reader :format, :height, :width
+    attr_reader :format, :height, :width, :channels
 
     def to_h
-      { width: width, height: height, format: format }
+      { width: width, height: height, format: format, channels: channels }
     end
 
     # Image information is only valid if height and width are present.

data/app/services/riiif/image_magick_info_extractor.rb

@@ -1,5 +1,5 @@
 module Riiif
-  # Get height and width information using imagemagick to interrogate the file
+  # Get information using imagemagick to interrogate the file
   class ImageMagickInfoExtractor
     # perhaps you want to use GraphicsMagick instead, set to "gm identify"
     class_attribute :external_command
@@ -10,14 +10,15 @@ module Riiif
     end
 
     def extract
-      height, width, format = Riiif::CommandRunner.execute(
-        "#{external_command} -format '%h %w %m' #{@path}[0]"
+      height, width, format, channels = Riiif::CommandRunner.execute(
+        "#{external_command} -format '%h %w %m %[channels]' #{@path}[0]"
       ).split(' ')
 
       {
         height: Integer(height),
         width: Integer(width),
-        format: format
+        format: format,
+        channels: channels
       }
     end
   end

data/app/services/riiif/imagemagick_command_factory.rb

@@ -27,7 +27,19 @@ module Riiif
 
     # @return [String] a command for running imagemagick to produce the requested output
     def command
-      [external_command, crop, size, rotation, colorspace, quality, sampling, metadata, input, output].join
+      [
+        external_command,
+        crop,
+        size,
+        rotation,
+        colorspace,
+        quality,
+        sampling,
+        metadata,
+        alpha_channel,
+        input,
+        output
+      ].join
     end
 
     def reduction_factor
@@ -44,6 +56,10 @@ module Riiif
         transformation.format == 'jpg'.freeze
       end
 
+      def alpha_channel?
+        info.channels =~ /rgba/i
+      end
+
       def layer_spec
         '[0]' if info.format =~ /pdf/i
       end
@@ -52,9 +68,15 @@ module Riiif
         " #{path}#{layer_spec}"
       end
 
+      # In cases where the input file has an alpha_channel but the transformation
+      #   format is 'jpg', change to 'png' as jpeg does not support alpha channels
       # pipe the output to STDOUT
       def output
-        " #{transformation.format}:-"
+        if alpha_channel? && jpeg?
+          " png:-"
+        else
+          " #{transformation.format}:-"
+        end
       end
 
       def crop
@@ -81,7 +103,15 @@ module Riiif
       end
 
       def sampling
-        " -sampling-factor #{sampling_factor}" if jpeg?
+        " -sampling-factor #{sampling_factor}" if jpeg? && !alpha_channel?
+      end
+
+      def alpha_channel
+        if info.format =~ /pdf/i
+          ' -alpha remove'
+        elsif alpha_channel?
+          ' -alpha on'
+        end
       end
 
       def colorspace

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/riiif.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'railties', '>= 4.2', '<6'
   spec.add_dependency 'deprecation', '>= 1.0.0'
   spec.add_dependency 'iiif-image-api', '~> 0.1.0'
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'engine_cart', '~> 0.8'
+  spec.add_development_dependency 'engine_cart', '~> 2.0'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'bixby', '~> 1.0.0'

data/spec/controllers/riiif/images_controller_spec.rb

@@ -147,7 +147,7 @@ RSpec.describe Riiif::ImagesController do
       before do
         allow(Riiif::Image).to receive(:new).with('abcd1234').and_return(image)
         allow(image).to(
-          receive(:info).and_return(Riiif::ImageInformation.new(width: 6000, height: 4000, format: 'JPEG'))
+          receive(:info).and_return(Riiif::ImageInformation.new(width: 6000, height: 4000, format: 'JPEG', channels: 'rgb'))
         )
       end
 
@@ -159,6 +159,7 @@ RSpec.describe Riiif::ImagesController do
                            'width' => 6000,
                            'height' => 4000,
                            'format' => 'JPEG',
+                           'channels' => 'rgb',
                            'profile' => ['http://iiif.io/api/image/2/level1.json', 'formats' => %w(jpg png)],
                            'protocol' => 'http://iiif.io/api/image'
         expect(response.headers['Link']).to eq '<http://iiif.io/api/image/2/level1.json>;rel="profile"'

data/spec/models/riiif/image_spec.rb

@@ -71,7 +71,7 @@ RSpec.describe Riiif::Image do
   describe '#render' do
     before do
       allow(Riiif::CommandRunner).to receive(:execute)
-        .with("identify -format '%h %w %m' #{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

data/spec/services/riiif/imagemagick_command_factory_spec.rb

@@ -1,33 +1,79 @@
 require 'spec_helper'
 
 RSpec.describe Riiif::ImagemagickCommandFactory do
-  let(:path) { 'foo.tiff' }
-  let(:info) { double(height: 100, width: 100, format: 'JPEG') }
+  let(:tiff) { 'foo.tiff' }
+  let(:pdf) { 'faa.pdf' }
+  let(:png) { 'laa.png' }
+  let(:channels) { 'rgb' }
+  let(:info) { double(height: 100, width: 100, format: source, channels: channels) }
 
   describe '.command' do
-    subject { instance.command }
-    let(:instance) { described_class.new(path, info, transformation) }
-
     let(:transformation) do
       IIIF::Image::Transformation.new(region: IIIF::Image::Region::Full.new,
                                       size: IIIF::Image::Size::Full.new,
                                       quality: 'quality',
                                       rotation: 15.2,
-                                      format: format)
+                                      format: target)
     end
 
-    context "when it's a jpeg" do
-      let(:format) { 'jpg' }
+    context "when the target format is jpeg" do
+      subject { described_class.new(tiff, info, transformation).command }
+
+      let(:source) { 'tif' }
+      let(:target) { 'jpg' }
+
       it { is_expected.to match(/-quality 85/) }
     end
 
-    context "when it's a tiff" do
-      let(:format) { 'tif' }
+    context "when the target format is tiff" do
+      subject { described_class.new(tiff, info, transformation).command }
+
+      let(:source) { 'tif' }
+      let(:target) { 'tif' }
+
       it { is_expected.not_to match(/-quality/) }
     end
 
+    context "when the source format is pdf" do
+      subject { described_class.new(pdf, info, transformation).command }
+      let(:source) { 'pdf' }
+      let(:target) { 'jpg' }
+
+      it { is_expected.to match(/-alpha\ remove/) }
+    end
+
+    context "when the source and target format is png" do
+      subject { described_class.new(png, info, transformation).command }
+      let(:source) { 'png' }
+      let(:target) { 'png' }
+
+      it { is_expected.to match(/png:-/) }
+    end
+
+    context "when the source format is png, the png has an alpha channel and the target format is png" do
+      subject { described_class.new(png, info, transformation).command }
+      let(:source) { 'png' }
+      let(:target) { 'png' }
+      let(:channels) { 'rgba' }
+
+      it { is_expected.to match(/alpha on/) }
+    end
+
+    context "when the source format is png, the png has an alpha channel and the target format is jpg" do
+      subject { described_class.new(png, info, transformation).command }
+      let(:source) { 'png' }
+      let(:target) { 'jpg' }
+      let(:channels) { 'rgba' }
+
+      it { is_expected.to match(/alpha on/) }
+      it { is_expected.to match(/png:-/) }
+    end
+
     describe '#external_command' do
-      let(:format) { 'jpg' }
+      subject { described_class.new(tiff, info, transformation).command }
+      let(:source) { 'tif' }
+      let(:target) { 'jpg' }
+
       around do |example|
         orig = described_class.external_command
         described_class.external_command = 'gm convert'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -62,16 +62,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: A rails engine that support IIIF requests