riiif 2.0.0.beta2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e944a8c92ae1774d9dd42515c3202a18b6a70f64
-  data.tar.gz: a4fa5460db8fc3703f21d3c8a07a62b920e4aa5e
+SHA256:
+  metadata.gz: b274258986b942fec11fa586bd52f13e9bf8a567725954f8ca6fd92282780207
+  data.tar.gz: d786222b5b9be2b1c6d514917adb239d498ed819f88f9de93d9a8f61852f1c5a
 SHA512:
-  metadata.gz: 33d4db4a5c49e09845ecdac04bdd35d88fa3ab1526eab8fbdd55bfbde786aee6adc1843e90e4f2bf0389c83570c005cb143e1dc831c18ec664fde6919a7feb6e
-  data.tar.gz: '05628c076ffc69365d0821f368118d0e078d7bbae5c946f4f59fafc485d8948d56b954338f0dfbdb4b8628212d48954b1a972fc937e4099985b97f67ca12ba9b'
+  metadata.gz: d4b7a1b45f2513f51abb150a0bc6678bc1578b4ab64da8487b7447af3a0cab2db922d8e7a49a5c737cfd9931e2abcd4f2bbeec37838862ecee49ffaeee6e9eb7
+  data.tar.gz: 4d06560bdbbf84747e7dba9f341fb6d5eff45dd6e1e573839aa8ec236b42dc242d7a31b8ff9c2bc4d6f31248839c9c3c0e39a76e884569904f7c36aa5aa5834b

data/.rubocop.yml

@@ -1,12 +1,3 @@
 inherit_from: .rubocop_todo.yml
-
-AllCops:
-  TargetRubyVersion: 2.1
-  DisplayCopNames: true
-
-Style/IndentationConsistency:
-  EnforcedStyle: rails
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
+inherit_gem:
+    bixby: bixby_default.yml

data/.rubocop_todo.yml

@@ -1,17 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-04-11 15:07:00 -0500 using RuboCop version 0.47.1.
+# on 2018-02-23 11:28:05 -0600 using RuboCop version 0.52.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: 9
+# Offense count: 2
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
   Exclude:
     - 'app/models/riiif/file.rb'
-    - 'app/services/riiif/option_decoder.rb'
+    - 'app/resolvers/riiif/http_file_resolver.rb'
+
+# Offense count: 1
+Lint/DuplicateMethods:
+  Exclude:
     - 'app/resolvers/riiif/http_file_resolver.rb'
 
 # Offense count: 1
@@ -24,50 +28,89 @@ Lint/UselessAssignment:
   Exclude:
     - 'app/models/riiif/file.rb'
 
-# Offense count: 5
-Metrics/AbcSize:
-  Max: 29
+# Offense count: 21
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 233
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 7
 
-# Offense count: 96
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 117
-
-# Offense count: 6
+# Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 18
 
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/routing/resize_routes_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: SkipBlocks, EnforcedStyle.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
   Exclude:
-    - 'app/services/riiif/imagemagick_command_factory.rb'
+    - 'spec/models/riiif/image_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/controllers/riiif/images_controller_spec.rb'
+    - 'spec/models/riiif/http_file_resolver_spec.rb'
+    - 'spec/transformers/riiif/kakadu_transformer_spec.rb'
 
 # Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
+RSpec/LeadingSubject:
   Exclude:
-    - 'lib/riiif/rails/routes.rb'
+    - 'spec/transformers/riiif/kakadu_transformer_spec.rb'
+
+# Offense count: 43
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
 
-# Offense count: 14
-Style/Documentation:
+# Offense count: 23
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/controllers/riiif/images_controller_spec.rb'
+    - 'spec/models/riiif/akubra_system_file_resolver_spec.rb'
+    - 'spec/models/riiif/file_system_file_resolver_spec.rb'
+    - 'spec/models/riiif/http_file_resolver_spec.rb'
+    - 'spec/models/riiif/image_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/controllers/riiif/images_controller_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/controllers/riiif/images_controller_spec.rb'
+    - 'spec/services/riiif/imagemagick_command_factory_spec.rb'
+    - 'spec/services/riiif/kakadu_command_factory_spec.rb'
+
+# Offense count: 1
+Rails/FilePath:
+  Exclude:
+    - 'spec/models/riiif/akubra_system_file_resolver_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - '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/engine.rb'
-    - 'lib/riiif/rails/routes.rb'
-    - 'lib/riiif/routes.rb'
+    - 'spec/controllers/riiif/images_controller_spec.rb'
+    - 'spec/models/riiif/http_file_resolver_spec.rb'

data/README.md

@@ -63,6 +63,14 @@ If you need to use HTTP basic authentication you can enable it like this:
 This file resolver caches the network files, so you will want to clear out the old files or the cache will expand until you run out of disk space.
 Using a script like this would be a good idea: https://github.com/pulibrary/loris/blob/607567b921404a15a2111fbd7123604f4fdec087/bin/loris-cache_clean.sh
 By default the cache is located in `tmp/network_files`. You can set the cache path like this: `Riiif::Image.file_resolver.cache_path = '/var/cache'`
+### Kakadu (for faster jp2 decoding)
+To configure Riiif to use Kakadu set:
+
+```ruby
+Riiif::Engine.config.kakadu_enabled = true
+```
+
+See [benchmark](docs/benchmark.md) for details
 
 ### GraphicsMagick
 
@@ -167,7 +175,14 @@ Riiif::Image.info_service = lambda do |id, file|
   resp = ActiveFedora::SolrService.get("id:#{fs_id}")
   doc = resp['response']['docs'].first
   raise "Unable to find solr document with id:#{fs_id}" unless doc
-  { height: doc['height_is'], width: doc['width_is'] }
+
+  # You’ll want default values if you make thumbnails of PDFs or other
+  # file types that `identify` won’t return dimensions for
+  {
+    height: doc["height_is"] || 100,
+    width: doc["width_is"] || 100,
+    format: doc["mime_type_ssi"],
+  }
 end
 
 def logger
@@ -179,7 +194,7 @@ end
 # Rails.cache. Some cache stores may not automatically purge expired content,
 # such as the default FileStore.
 # http://guides.rubyonrails.org/caching_with_rails.html#cache-stores
-Riiif::Engine.config.cache_duration_in_days = 30
+Riiif::Engine.config.cache_duration = 30.days
 ```
 #### Special note for Passenger and Apache users
 If you are running riiif in Passenger under Apache, you must set the following in your virtual host definition:

data/app/controllers/riiif/images_controller.rb

@@ -2,7 +2,7 @@ module Riiif
   class ImagesController < ::ApplicationController
     before_action :link_header, only: [:show, :info]
 
-    rescue_from Riiif::InvalidAttributeError do
+    rescue_from IIIF::Image::InvalidAttributeError do
       head 400
     end
 
@@ -44,6 +44,12 @@ module Riiif
       end
     end
 
+    # See https://fetch.spec.whatwg.org/#http-access-control-allow-headers
+    def info_options
+      response.headers['Access-Control-Allow-Headers'] = 'Authorization'
+      self.response_body = ''
+    end
+
     # this is a workaround for https://github.com/rails/rails/issues/25087
     def redirect
       # This was attempted with just info_path, but it gave a NoMethodError
@@ -120,7 +126,7 @@ module Riiif
           CONTEXT => CONTEXT_URI,
           ID => request.original_url.sub('/info.json', ''),
           PROTOCOL => PROTOCOL_URI,
-          PROFILE => [LEVEL1, 'formats' => OptionDecoder::OUTPUT_FORMATS]
+          PROFILE => [LEVEL1, 'formats' => IIIF::Image::OptionDecoder::OUTPUT_FORMATS]
         }
       end
   end

data/app/models/riiif/image.rb

@@ -1,27 +1,11 @@
 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/absolute'
-require_dependency 'riiif/region/full'
-require_dependency 'riiif/region/percentage'
-require_dependency 'riiif/region/square'
-
-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
 
@@ -60,20 +44,31 @@ module Riiif
       key = Image.cache_key(id, cache_opts)
 
       cache.fetch(key, compress: true, expires_in: Image.expires_in) do
-        file.extract(OptionDecoder.decode(args, info), info)
+        file.extract(IIIF::Image::OptionDecoder.decode(args), info)
       end
     end
 
     def info
       @info ||= begin
                   result = info_service.call(id, file)
-                  ImageInformation.new(result[:width], result[:height])
+                  ImageInformation.new(
+                    width: result[:width],
+                    height: result[:height],
+                    format: result[:format]
+                  )
                 end
     end
 
     class << self
       def expires_in
-        Riiif::Engine.config.cache_duration_in_days.days
+        if Riiif::Engine.config.respond_to?(:cache_duration_in_days)
+          Deprecation.warn(self,
+                           'Riiif::Engine.config.cache_duration_in_days is deprecated; '\
+                           'use #cache_duration instead and pass a fully-qualified date (e.g., `3.days`)')
+          Riiif::Engine.config.cache_duration_in_days.days
+        else
+          Riiif::Engine.config.cache_duration
+        end
       end
 
       def cache_key(id, options)

data/app/models/riiif/image_information.rb

@@ -1,41 +1,29 @@
 module Riiif
   # This is the result of calling the Riiif.image_info service. It stores the height & width
-  class ImageInformation
+  class ImageInformation < IIIF::Image::Dimension
     extend Deprecation
 
-    def initialize(width, height)
-      @width = width
-      @height = height
+    def initialize(*args)
+      if args.size == 2
+        Deprecation.warn(self, 'calling initialize without kwargs is deprecated. Use named parameters.')
+        super(width: args.first, height: args.second)
+      else
+        @width = args.first[:width]
+        @height = args.first[:height]
+        @format = args.first[:format]
+      end
     end
-
-    attr_reader :width, :height
+    attr_reader :format, :height, :width
 
     def to_h
-      { width: width, height: height }
-    end
-
-    def aspect_ratio
-      width.to_f / height
+      { width: width, height: height, format: format }
     end
 
-    def [](key)
-      to_h[key]
-    end
-    deprecation_deprecate :[] => 'Riiif::ImageInformation#[] has been deprecated ' \
-      'and will be removed in version 2.0. Use Riiif::ImageInformation#to_h and ' \
-      'call #[] on that result OR consider using #height and #width directly.'
-
     # Image information is only valid if height and width are present.
     # If an image info service doesn't have the value yet (not characterized perhaps?)
     # then we wouldn't want to cache this value.
     def valid?
       width.present? && height.present?
     end
-
-    def ==(other)
-      other.class == self.class &&
-        other.width == width &&
-        other.height == height
-    end
   end
 end

data/app/services/riiif/crop.rb

@@ -1,54 +1,123 @@
 module Riiif
   # Represents a cropping operation
   class Crop
-    attr_reader :image_info
+    # @param transformation [IIIF::Image::Region] the result the user requested
+    # @param image_info []
+    def initialize(region, image_info)
+      @region = region
+      @image_info = image_info
+    end
+
+    attr_reader :image_info, :region
 
     # @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}"
+      case region
+      when IIIF::Image::Region::Full
+        nil
+      when IIIF::Image::Region::Absolute
+        "#{region.width}x#{region.height}+#{region.offset_x}+#{region.offset_y}"
+      when IIIF::Image::Region::Square
+        imagemagick_square
+      when IIIF::Image::Region::Percent
+        imagemagick_percent
+      else
+        raise "Unknown region #{region.class}"
+      end
     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}\}"
+      case region
+      when IIIF::Image::Region::Full
+        nil
+      when IIIF::Image::Region::Absolute
+        "\{#{decimal_offset_y(region.offset_y)},#{decimal_offset_x(region.offset_x)}\}," \
+        "\{#{decimal_height(region.height)},#{decimal_width(region.width)}\}"
+      when IIIF::Image::Region::Square
+        kakadu_square
+      when IIIF::Image::Region::Percent
+        kakadu_percent
+      else
+        raise "Unknown region #{region.class}"
+      end
     end
 
-    attr_reader :offset_x
+    private
 
-    attr_reader :offset_y
+      def imagemagick_percent
+        offset_x = (image_info.width * percentage_to_fraction(region.x_pct)).round
+        offset_y = (image_info.height * percentage_to_fraction(region.y_pct)).round
+        "#{region.width_pct}%x#{region.height_pct}+#{offset_x}+#{offset_y}"
+      end
 
-    # @return [Integer] the height in pixels
-    def height
-      image_info.height
-    end
+      def kakadu_percent
+        offset_x = (image_info.width * percentage_to_fraction(region.x_pct)).round
+        offset_y = (image_info.height * percentage_to_fraction(region.y_pct)).round
+        "\{#{decimal_offset_y(offset_y)},#{decimal_offset_x(offset_x)}\}," \
+        "\{#{percentage_to_fraction(region.height_pct)},#{percentage_to_fraction(region.width_pct)}\}"
+      end
 
-    # @return [Integer] the width in pixels
-    def width
-      image_info.width
-    end
+      def kakadu_square
+        min, max = [image_info.width, image_info.height].minmax
+        offset = (max - min) / 2
+        if image_info.height >= image_info.width
+          # Portrait
+          "\{#{decimal_height(offset)},0\}," \
+          "\{#{decimal_height(image_info.height)},#{decimal_width(image_info.height)}\}"
+        else
+          # Landscape
+          "\{0,#{decimal_width(offset)}\}," \
+          "\{#{decimal_height(image_info.width)},#{decimal_width(image_info.width)}\}"
+        end
+      end
 
-    # @return [Float] the fractional height with respect to the original size
-    def decimal_height(n = height)
-      n.to_f / image_info.height
-    end
+      def imagemagick_square
+        min, max = [image_info.width, image_info.height].minmax
+        offset = (max - min) / 2
+        if image_info.height >= image_info.width
+          "#{min}x#{min}+0+#{offset}"
+        else
+          "#{min}x#{min}+#{offset}+0"
+        end
+      end
 
-    # @return [Float] the fractional width with respect to the original size
-    def decimal_width(n = width)
-      n.to_f / image_info.width
-    end
+      # @return [Integer] the height in pixels
+      def height
+        image_info.height
+      end
 
-    def decimal_offset_x
-      offset_x.to_f / image_info.width
-    end
+      # @return [Integer] the width in pixels
+      def width
+        image_info.width
+      end
 
-    def decimal_offset_y
-      offset_y.to_f / image_info.height
-    end
+      # @return [Float] the fractional height with respect to the original size
+      def decimal_height(n = height)
+        n.to_f / image_info.height
+      end
 
-    def maintain_aspect_ratio?
-      (height / width) == (image_info.height / image_info.width)
-    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)
+        offset_x.to_f / image_info.width
+      end
+
+      def decimal_offset_y(offset_y)
+        offset_y.to_f / image_info.height
+      end
+
+      def maintain_aspect_ratio?
+        (height / width) == (image_info.height / image_info.width)
+      end
+
+      def percentage_to_fraction(n)
+        n / 100.0
+      end
   end
 end