riiif 1.7.1 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b906efd99f3e05a2fd678fc4f94f7d91c97c726b
-  data.tar.gz: 157ee4a7c84affe1bc6816ad8d22c1bfade9ae9c
+  metadata.gz: cd3265a72519ab497b58fcd9314509a8bac800c4
+  data.tar.gz: 51c4d65cd6e0488a5ae225cb7c3d9917fd427033
 SHA512:
-  metadata.gz: d5ec226ff4794db61495802d724cdbb40adcf0f412b44d413f343e2755c0700790de1e84c429c6ab983bf103b5ea8fb68c4ffdfe4f5a546b134467524236dc54
-  data.tar.gz: 07e3b30f166d5f6e944ed7a785b504970e1e970284fe71a85939337c0dca115660f91b9ff05bbc6b717a06392a142db26d09862fba16ebbe677bd09e415a7681
+  metadata.gz: 28447a5eadf4b943759bc3cf3df145aacff7a122528438b2f542779ad8ac06ab6ab1da4567d2cebaeea6d8148b92a3c895b2d077c2c5bee1eaee1a966df2eb8e
+  data.tar.gz: c0b443453bdfe6935f146fd7afa7b2377c239a189888660756406245746aba906a85bdb0c17e22c7d608b4e4fcc3e96901a05e9b8e54c543c1712fcd7bf8e224

data/.rubocop_todo.yml

@@ -1,33 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-05-14 11:34:53 -0500 using RuboCop version 0.47.1.
+# on 2017-04-11 15:07:00 -0500 using RuboCop version 0.47.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-# Configuration parameters: Include.
-# Include: **/Gemfile, **/gems.rb
-Bundler/DuplicatedGem:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: Include.
-# Include: **/Gemfile, **/gems.rb
-Bundler/OrderedGems:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 9
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
   Exclude:
     - 'app/models/riiif/file.rb'
     - 'app/services/riiif/option_decoder.rb'
-    - 'lib/riiif/http_file_resolver.rb'
+    - 'app/resolvers/riiif/http_file_resolver.rb'
 
 # Offense count: 1
 Lint/HandleExceptions:
@@ -39,7 +24,7 @@ Lint/UselessAssignment:
   Exclude:
     - 'app/models/riiif/file.rb'
 
-# Offense count: 6
+# Offense count: 5
 Metrics/AbcSize:
   Max: 29
 
@@ -47,17 +32,21 @@ Metrics/AbcSize:
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 103
+# Offense count: 96
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 153
+  Max: 117
 
 # Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 18
 
+Metrics/ParameterLists:
+  Exclude:
+    - 'app/services/riiif/imagemagick_command_factory.rb'
+
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: nested, compact
@@ -65,7 +54,7 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/riiif/rails/routes.rb'
 
-# Offense count: 13
+# Offense count: 14
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -73,27 +62,12 @@ Style/Documentation:
     - 'app/controllers/riiif/images_controller.rb'
     - 'app/models/riiif/file.rb'
     - 'app/models/riiif/image.rb'
+    - 'app/resolvers/riiif/abstract_file_system_resolver.rb'
+    - 'app/resolvers/riiif/akubra_system_file_resolver.rb'
+    - 'app/resolvers/riiif/file_system_file_resolver.rb'
+    - 'app/resolvers/riiif/http_file_resolver.rb'
+    - 'app/services/riiif/nil_authorization_service.rb'
     - 'lib/riiif.rb'
-    - 'lib/riiif/abstract_file_system_resolver.rb'
-    - 'lib/riiif/akubra_system_file_resolver.rb'
     - 'lib/riiif/engine.rb'
-    - 'lib/riiif/file_system_file_resolver.rb'
-    - 'lib/riiif/http_file_resolver.rb'
-    - 'lib/riiif/nil_authorization_service.rb'
     - 'lib/riiif/rails/routes.rb'
     - 'lib/riiif/routes.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Style/SpaceAroundOperators:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Gemfile'

data/Gemfile

@@ -1,41 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'byebug'
 # Specify your gem's dependencies in riiif.gemspec
 gemspec
-
-ENV['ENGINE_CART_RAILS_OPTIONS']="--skip-bootsnap"
-
-# 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/app/models/riiif/file.rb

@@ -3,6 +3,7 @@ module Riiif
     attr_reader :path
 
     class_attribute :info_extractor_class
+    # TODO: add alternative that uses kdu_jp2info
     self.info_extractor_class = ImageMagickInfoExtractor
 
     # @param input_path [String] The location of an image file
@@ -20,6 +21,8 @@ module Riiif
     end
     deprecation_deprecate read: 'Riiif::File.read is deprecated and will be removed in version 2.0'
 
+    # Yields a tempfile to the provided block
+    # @return [Riiif::File] a file backed by the Tempfile
     def self.create(ext = nil, _validate = true, &block)
       tempfile = Tempfile.new(['mini_magick', ext.to_s.downcase])
       tempfile.binmode
@@ -32,22 +35,26 @@ module Riiif
     deprecation_deprecate create: 'Riiif::File.create is deprecated and will be removed in version 2.0'
 
     # @param [Transformation] transformation
-    def extract(transformation)
-      command = command_factory.build(path, transformation)
-      execute(command)
+    # @param [ImageInformation] image_info
+    # @return [String] the processed image data
+    def extract(transformation, image_info = info)
+      transformer.transform(path, image_info, transformation)
     end
 
-    def info
-      @info ||= info_extractor_class.new(path).extract
+    def transformer
+      if Riiif.kakadu_enabled? && path.ends_with?('.jp2')
+        KakaduTransformer
+      else
+        ImagemagickTransformer
+      end
     end
 
-    delegate :execute, to: Riiif::CommandRunner
-    private :execute
-
-    private
+    def info
+      @info ||= info_extractor.extract
+    end
 
-      def command_factory
-        ImagemagickCommandFactory
-      end
+    def info_extractor
+      @info_extractor ||= info_extractor_class.new(path)
+    end
   end
 end

data/app/models/riiif/image.rb

@@ -4,24 +4,24 @@ require 'digest/md5'
 # These explict requires are needed because in some contexts the Rails
 # autoloader can either: unload already loaded classes, or cause a lock while
 # trying to load a needed class.
-require_dependency 'riiif/region/imagemagick/absolute_decoder'
-require_dependency 'riiif/region/imagemagick/full_decoder'
-require_dependency 'riiif/region/imagemagick/percentage_decoder'
-require_dependency 'riiif/region/imagemagick/square_decoder'
+require_dependency 'riiif/region/absolute'
+require_dependency 'riiif/region/full'
+require_dependency 'riiif/region/percentage'
+require_dependency 'riiif/region/square'
 
-require_dependency 'riiif/size/imagemagick/absolute_decoder'
-require_dependency 'riiif/size/imagemagick/best_fit_decoder'
-require_dependency 'riiif/size/imagemagick/full_decoder'
-require_dependency 'riiif/size/imagemagick/height_decoder'
-require_dependency 'riiif/size/imagemagick/percent_decoder'
-require_dependency 'riiif/size/imagemagick/width_decoder'
+require_dependency 'riiif/size/absolute'
+require_dependency 'riiif/size/best_fit'
+require_dependency 'riiif/size/full'
+require_dependency 'riiif/size/height'
+require_dependency 'riiif/size/percent'
+require_dependency 'riiif/size/width'
 
 module Riiif
   class Image
     extend Deprecation
 
     class_attribute :file_resolver, :info_service, :authorization_service, :cache
-    self.file_resolver = FileSystemFileResolver.new(base_path: ::File.join(Rails.root, 'tmp'))
+    self.file_resolver = FileSystemFileResolver.new(base_path: File.join(Rails.root, 'tmp'))
     self.authorization_service = NilAuthorizationService
     self.cache = Rails.cache
 
@@ -54,12 +54,13 @@ module Riiif
 
     ##
     # @param [ActiveSupport::HashWithIndifferentAccess] args
+    # @return [String] the image data
     def render(args)
       cache_opts = args.select { |a| %w(region size quality rotation format).include? a.to_s }
       key = Image.cache_key(id, cache_opts)
 
       cache.fetch(key, compress: true, expires_in: Image.expires_in) do
-        file.extract(OptionDecoder.decode(args, info))
+        file.extract(OptionDecoder.decode(args, info), info)
       end
     end
 

data/app/models/riiif/image_information.rb

@@ -14,6 +14,10 @@ module Riiif
       { width: width, height: height }
     end
 
+    def aspect_ratio
+      width.to_f / height
+    end
+
     def [](key)
       to_h[key]
     end

data/app/models/riiif/transformation.rb

@@ -0,0 +1,35 @@
+module Riiif
+  # Represents a IIIF request
+  class Transformation
+    attr_reader :crop, :size, :quality, :rotation, :format
+    def initialize(crop, size, quality, rotation, format)
+      @crop = crop
+      @size = size
+      @quality = quality
+      @rotation = rotation
+      @format = format
+    end
+
+    # Create a clone of this Transformation, scaled by the factor
+    # @param [Integer] factor the scale for the new transformation
+    # @return [Transformation] a new transformation, scaled by factor
+    def reduce(factor)
+      Transformation.new(crop.dup,
+                         size.reduce(factor),
+                         quality,
+                         rotation,
+                         format)
+    end
+
+    # Create a clone of this Transformation, without the crop
+    # @return [Transformation] a new transformation
+    # TODO: it would be nice if we didn't need image_info
+    def without_crop(image_info)
+      Transformation.new(Region::Full.new(image_info),
+                         size.dup,
+                         quality,
+                         rotation,
+                         format)
+    end
+  end
+end

data/app/services/riiif/command_runner.rb

@@ -6,6 +6,8 @@ module Riiif
     include ActiveSupport::Benchmarkable
     delegate :logger, to: :Rails
 
+    # TODO: this is being loaded into memory.  We could make this a stream.
+    # @return [String] all the image data
     def execute(command)
       out = nil
       benchmark("Riiif executed #{command}") do

data/app/services/riiif/crop.rb

@@ -0,0 +1,54 @@
+module Riiif
+  # Represents a cropping operation
+  class Crop
+    attr_reader :image_info
+
+    # @return [String] a region for imagemagick to decode
+    #                  (appropriate for passing to the -crop parameter)
+    def to_imagemagick
+      "#{width}x#{height}+#{offset_x}+#{offset_y}"
+    end
+
+    # @return [String] a region for kakadu to decode
+    #                  (appropriate for passing to the -region parameter)
+    def to_kakadu
+      "\{#{decimal_offset_y},#{decimal_offset_x}\},\{#{decimal_height},#{decimal_width}\}"
+    end
+
+    attr_reader :offset_x
+
+    attr_reader :offset_y
+
+    # @return [Integer] the height in pixels
+    def height
+      image_info.height
+    end
+
+    # @return [Integer] the width in pixels
+    def width
+      image_info.width
+    end
+
+    # @return [Float] the fractional height with respect to the original size
+    def decimal_height(n = height)
+      n.to_f / image_info.height
+    end
+
+    # @return [Float] the fractional width with respect to the original size
+    def decimal_width(n = width)
+      n.to_f / image_info.width
+    end
+
+    def decimal_offset_x
+      offset_x.to_f / image_info.width
+    end
+
+    def decimal_offset_y
+      offset_y.to_f / image_info.height
+    end
+
+    def maintain_aspect_ratio?
+      (height / width) == (image_info.height / image_info.width)
+    end
+  end
+end

data/app/services/riiif/imagemagick_command_factory.rb

@@ -9,35 +9,29 @@ module Riiif
 
     # A helper method to instantiate and invoke build
     # @param [String] path the location of the file
+    # @param info [ImageInformation] information about the source
     # @param [Transformation] transformation
     # @param [Integer] compression (85) the compression level to use (set 0 for no compression)
     # @param [String] sampling_factor ("4:2:0") the chroma sample factor (set 0 for no compression)
     # @param [Boolean] strip_metadata (true) do we want to strip EXIF tags?
-    # @return [String] a command for running imagemagick to produce the requested output
-    def self.build(path, transformation, compression: 85, sampling_factor: '4:2:0', strip_metadata: true)
-      new(path, transformation,
-          compression: compression,
-          sampling_factor: sampling_factor,
-          strip_metadata: strip_metadata).build
-    end
-
-    # A helper method to instantiate and invoke build
-    # @param [String] path the location of the file
-    # @param [Transformation] transformation
-    # @param [Integer] compression the compression level to use (set 0 for no compression)
-    def initialize(path, transformation, compression:, sampling_factor:, strip_metadata:)
+    def initialize(path, info, transformation, compression: 85, sampling_factor: '4:2:0', strip_metadata: true)
       @path = path
+      @info = info
       @transformation = transformation
       @compression = compression
       @sampling_factor = sampling_factor
       @strip_metadata = strip_metadata
     end
 
-    attr_reader :path, :transformation, :compression, :sampling_factor, :strip_metadata
+    attr_reader :path, :info, :transformation, :compression, :sampling_factor, :strip_metadata
 
     # @return [String] a command for running imagemagick to produce the requested output
-    def build
-      [external_command, crop, size, rotation, colorspace, quality, sampling, metadata, output].join
+    def command
+      [external_command, crop, size, rotation, colorspace, quality, sampling, metadata, input, output].join
+    end
+
+    def reduction_factor
+      nil
     end
 
     private
@@ -50,16 +44,23 @@ module Riiif
         transformation.format == 'jpg'.freeze
       end
 
+      def input
+        " #{path}"
+      end
+
+      # pipe the output to STDOUT
       def output
-        " #{path} #{transformation.format}:-"
+        " #{transformation.format}:-"
       end
 
       def crop
-        " -crop #{transformation.crop}" if transformation.crop
+        directive = transformation.crop.to_imagemagick
+        " -crop #{directive}" if directive
       end
 
       def size
-        " -resize #{transformation.size}" if transformation.size
+        directive = transformation.size.to_imagemagick
+        " -resize #{directive}" if directive
       end
 
       def rotation