riiif 1.7.1 → 2.0.0.beta1

data/app/services/riiif/size/percent.rb

@@ -0,0 +1,44 @@
+module Riiif
+  module Size
+    # The width and height of the returned image is scaled to n% of the width and height
+    # of the extracted region. The aspect ratio of the returned image is the same as that
+    # of the extracted region.
+    class Percent < Resize
+      def initialize(info, percentage)
+        @image_info = info
+        @percentage = percentage
+      end
+
+      attr_reader :percentage
+
+      # @return [String] a resize directive for imagemagick to use
+      def to_imagemagick
+        "#{percentage}%"
+      end
+
+      # @return [Integer] the height in pixels
+      def height
+        percent_of(image_info.height)
+      end
+
+      # @return [Integer] the width in pixels
+      def width
+        percent_of(image_info.width)
+      end
+
+      # @param [Integer] factor number of times to reduce by 1/2
+      def reduce(factor)
+        pct = percentage.to_f * 2**factor
+        Percent.new(image_info, pct)
+      end
+
+      private
+
+        # @param [Integer] value a value to convert to the percentage
+        # @return [Float]
+        def percent_of(value)
+          value * Integer(percentage).to_f / 100
+        end
+    end
+  end
+end

data/app/services/riiif/size/width.rb

@@ -0,0 +1,24 @@
+module Riiif
+  module Size
+    # The image or region should be scaled so that its width is exactly equal
+    # to the provided parameter, and the height will be a calculated value that
+    # maintains the aspect ratio of the extracted region
+    class Width < Resize
+      def initialize(info, width)
+        @image_info = info
+        @width = width.to_i
+      end
+
+      # @return [String] a resize directive for imagemagick to use
+      def to_imagemagick
+        @width.to_s
+      end
+
+      attr_reader :width
+
+      def height
+        width * image_info.height / image_info.width
+      end
+    end
+  end
+end

data/app/transformers/riiif/abstract_transformer.rb

@@ -0,0 +1,30 @@
+module Riiif
+  # Transforms an image using a backend
+  class AbstractTransformer
+    # @param path [String] The path of the source image file
+    # @param image_info [ImageInformation] information about the source
+    # @param [Transformation] transformation
+    def self.transform(path, image_info, transformation)
+      new(path, image_info, transformation).transform
+    end
+
+    def initialize(path, image_info, transformation)
+      @path = path
+      @image_info = image_info
+      @transformation = transformation
+    end
+
+    attr_reader :path, :image_info, :transformation
+
+    def transform
+      execute(command_builder.command)
+    end
+
+    def command_builder
+      @command_builder ||= command_factory.new(path, image_info, transformation)
+    end
+
+    delegate :execute, to: Riiif::CommandRunner
+    private :execute
+  end
+end

data/app/transformers/riiif/imagemagick_transformer.rb

@@ -0,0 +1,8 @@
+module Riiif
+  # Transforms an image using Imagemagick
+  class ImagemagickTransformer < AbstractTransformer
+    def command_factory
+      ImagemagickCommandFactory
+    end
+  end
+end

data/app/transformers/riiif/kakadu_transformer.rb

@@ -0,0 +1,39 @@
+module Riiif
+  # Transforms an image using Kakadu
+  class KakaduTransformer < AbstractTransformer
+    def command_factory
+      KakaduCommandFactory
+    end
+
+    def transform
+      with_tempfile do |file_name|
+        execute(command_builder.command(file_name))
+        post_process(file_name, command_builder.reduction_factor)
+      end
+    end
+
+    def with_tempfile
+      Tempfile.open(['riiif-intermediate', '.bmp']) do |f|
+        yield f.path
+      end
+    end
+
+    # The data we get back from kdu_expand is a bmp and we need to change it
+    # to the requested format by calling Imagemagick.
+    def post_process(intermediate_file, reduction_factor)
+      # Calculate a new set of transforms with respect to reduction_factor
+      transformation = if reduction_factor
+                         self.transformation.without_crop(image_info).reduce(reduction_factor)
+                       else
+                         self.transformation.without_crop(image_info)
+                       end
+      Riiif::File.new(intermediate_file).extract(transformation, image_info)
+    end
+
+    private
+
+      def tmp_path
+        @link_path ||= LinkNameService.create
+      end
+  end
+end

data/lib/riiif.rb

@@ -3,13 +3,7 @@ require 'deprecation'
 require 'riiif/engine'
 module Riiif
   extend ActiveSupport::Autoload
-  autoload :Image
-  autoload :AbstractFileSystemResolver
-  autoload :FileSystemFileResolver
-  autoload :HTTPFileResolver
   autoload :Routes
-  autoload :AkubraSystemFileResolver
-  autoload :NilAuthorizationService
 
   class Error < RuntimeError; end
   class InvalidAttributeError < Error; end
@@ -18,7 +12,10 @@ module Riiif
   # This error is raised when Riiif can't convert an image
   class ConversionError < Error; end
 
-  Transformation = Struct.new(:crop, :size, :quality, :rotation, :format)
   mattr_accessor :not_found_image # the image to use when a lookup fails
   mattr_accessor :unauthorized_image # the image to use when a user doesn't have access
+
+  def self.kakadu_enabled?
+    Engine.config.kakadu_enabled
+  end
 end

data/lib/riiif/engine.rb

@@ -5,8 +5,9 @@ module Riiif
     # How long to cache the tiles for.
     config.cache_duration_in_days = 3
 
-    config.action_dispatch.rescue_responses.merge!(
-      'Riiif::ImageNotFoundError' => :not_found
-    )
+    config.action_dispatch.rescue_responses['Riiif::ImageNotFoundError'] = :not_found
+
+    # Set to true to use kdu for jp2000 source images
+    config.kakadu_enabled = false
   end
 end

data/lib/riiif/version.rb

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

data/riiif.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'deprecation', '>= 1.0.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'engine_cart', '~> 2.0'
+  spec.add_development_dependency 'engine_cart', '~> 0.8'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'rubocop', '~> 0.47.1'

data/spec/models/riiif/image_spec.rb

@@ -15,11 +15,14 @@ RSpec.describe Riiif::Image do
 
   describe 'happy path' do
     before do
-      expect(subject.file).to receive(:execute)
-        .with("convert -quality 85 -sampling-factor 4:2:0 -strip #{filename} jpg:-")
-        .and_return('imagedata')
+      allow(image.info_service).to receive(:call).and_return({})
     end
+
     it 'renders' do
+      expect(Riiif::CommandRunner).to receive(:execute)
+        .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'
     end
   end

data/spec/models/riiif/transformation_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Riiif::Transformation do
+  subject(:transformation) do
+    Riiif::Transformation.new(region,
+                              size,
+                              quality,
+                              rotation,
+                              fmt)
+  end
+
+  let(:region) { Riiif::Region::Full.new(image_info) }
+  let(:size) { Riiif::Size::Percent.new(image_info, 20) }
+  let(:quality) { nil }
+  let(:rotation) { nil }
+  let(:fmt) { nil }
+  let(:image_info) { double('Image info', height: 4381, width: 6501) }
+
+  describe 'reduce' do
+    subject { transformation.reduce(factor) }
+    context 'when reduced by 2' do
+      let(:factor) { 2 }
+      let(:size) { Riiif::Size::Percent.new(image_info, 20) }
+
+      it 'downsamples the size' do
+        expect(subject.size).to be_kind_of Riiif::Size::Percent
+        expect(subject.size.percentage).to eq 80.0
+      end
+    end
+  end
+
+  describe 'without_crop' do
+    let(:region) { Riiif::Region::Absolute.new(image_info, 5, 6, 7, 8) }
+
+    subject { transformation.without_crop(image_info) }
+    it 'nullifies the crop' do
+      expect(subject.crop).to be_kind_of Riiif::Region::Full
+    end
+  end
+end

data/spec/services/riiif/imagemagick_command_factory_spec.rb

@@ -2,13 +2,15 @@ require 'spec_helper'
 
 RSpec.describe Riiif::ImagemagickCommandFactory do
   let(:path) { 'foo.tiff' }
+  let(:info) { double('foo') }
 
-  describe '.build' do
-    subject { described_class.build(path, transformation) }
+  describe '.command' do
+    subject { instance.command }
+    let(:instance) { described_class.new(path, info, transformation) }
 
     let(:transformation) do
-      Riiif::Transformation.new('region',
-                                'size',
+      Riiif::Transformation.new(Riiif::Region::Full.new(info),
+                                Riiif::Size::Full.new,
                                 'quality',
                                 'rotation',
                                 format)

data/spec/services/riiif/kakadu_command_factory_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Riiif::KakaduCommandFactory do
+  subject(:instance) { described_class.new(path, info, transformation) }
+
+  let(:info) { double(:info) }
+  let(:path) { 'foo.jp2' }
+  let(:region) { Riiif::Region::Full.new(info) }
+  let(:size) { Riiif::Size::Full.new }
+  let(:quality) { nil }
+  let(:rotation) { nil }
+  let(:fmt) { nil }
+
+  let(:transformation) do
+    Riiif::Transformation.new(region,
+                              size,
+                              quality,
+                              rotation,
+                              fmt)
+  end
+
+  describe '#command' do
+    subject { instance.command '/tmp/bar.bmp' }
+
+    context 'with a full size image' do
+      it { is_expected.to eq 'kdu_expand -quiet -i foo.jp2 -num_threads 4 -o /tmp/bar.bmp' }
+    end
+  end
+
+  describe '#region' do
+    subject { instance.send(:region) }
+    let(:info) { double(height: 300, width: 300) }
+
+    context 'with a full' do
+      it { is_expected.to be nil }
+    end
+
+    context 'with absolute' do
+      let(:region) { Riiif::Region::Absolute.new(info, 25, 75, 150, 100) }
+      it { is_expected.to eq ' -region "{0.25,0.08333333333333333},{0.3333333333333333,0.5}"' }
+    end
+
+    context 'with a square' do
+      let(:region) { Riiif::Region::Square.new(info) }
+      it { is_expected.to eq ' -region "{0.0,0},{1.0,1.0}"' }
+    end
+
+    context 'with a percentage' do
+      let(:region) { Riiif::Region::Percentage.new(info, 20, 30, 40, 50) }
+      it { is_expected.to eq ' -region "{0.3,0.2},{0.5,0.4}"' }
+    end
+  end
+
+  describe '#reduction_factor' do
+    subject { instance.send(:reduction_factor) }
+
+    let(:info) { Riiif::ImageInformation.new(300, 300) }
+
+    context 'for a full size image' do
+      it { is_expected.to eq nil }
+    end
+
+    context 'when the aspect ratio is maintined for absolute' do
+      let(:size) { Riiif::Size::Absolute.new(info, 145, 145) }
+      it { is_expected.to eq 1 }
+    end
+
+    context 'when the aspect ratio is not-maintined' do
+      let(:size) { Riiif::Size::Absolute.new(info, 100, 145) }
+      it { is_expected.to eq nil }
+    end
+
+    context 'when aspect ratio is maintained for 45 pct' do
+      let(:size) { Riiif::Size::Percent.new(info, 45) }
+      it { is_expected.to eq 1 }
+    end
+
+    context 'when aspect ratio is maintained for 20 pct' do
+      let(:size) { Riiif::Size::Percent.new(info, 20) }
+      it { is_expected.to eq 2 }
+    end
+  end
+end

data/spec/services/riiif/region/absolute_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Riiif::Region::Absolute do
+  let(:image_info) { double }
+
+  context 'when initialized with strings' do
+    let(:instance) { described_class.new(image_info, '5', '15', '50', '100') }
+
+    it 'casts height to an integer' do
+      expect(instance.height).to eq 100
+    end
+
+    it 'casts width to an integer' do
+      expect(instance.width).to eq 50
+    end
+  end
+end

data/spec/services/riiif/size/absolute_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Riiif::Size::Absolute do
+  let(:image_info) { double }
+
+  context 'when initialized with strings' do
+    let(:instance) { described_class.new(image_info, '50', '100') }
+
+    it 'casts height to an integer' do
+      expect(instance.height).to eq 100
+    end
+
+    it 'casts width to an integer' do
+      expect(instance.width).to eq 50
+    end
+  end
+end

data/spec/services/riiif/size/height_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+RSpec.describe Riiif::Size::Height do
+  let(:image_info) { double }
+
+  context 'when initialized with strings' do
+    let(:instance) { described_class.new(image_info, '50') }
+
+    it 'casts height to an integer' do
+      expect(instance.height).to eq 50
+    end
+  end
+end

data/spec/services/riiif/size/width_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+RSpec.describe Riiif::Size::Width do
+  let(:image_info) { double }
+
+  context 'when initialized with strings' do
+    let(:instance) { described_class.new(image_info, '50') }
+
+    it 'casts height to an integer' do
+      expect(instance.width).to eq 50
+    end
+  end
+end