riiif 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba70ff2bc96642dfaef0a13aa368721e64d819b9
-  data.tar.gz: f2211f18a7da732e70f6151b907c6cbf66d2a88a
+  metadata.gz: 3a1934121b4a1108f275c5a0331519770bb408eb
+  data.tar.gz: eb9d3f833d1e77fe46421a754a2d8365eb081102
 SHA512:
-  metadata.gz: a593880f25ace996a90457cf99aaba644fc4c4410622e4203f3e968609d598ffd1080b33698e45d9de3b9f63be76b836b89b12a236c49e5bfb9c231e2b8dcaeb
-  data.tar.gz: b560c0e4f6bb82d44c671f1c32a0ddf24eb6aeac633357aa9e0885886e247a6e987055c629b2ef618499c486f9c1c80d5c285bda00ee972a81a6070e66d1cdc5
+  metadata.gz: 848a8082a7768d0011f3e13dedebd36987aebbf5fef0c77103f0847539550066a84bac07f526689a80bd2b2d6fbd09b31c0eb9b19b732fec06dcfa3d4512a6d2
+  data.tar.gz: 58b1a338bf60c86fbba8b53fe7f340bab83d8a28bce65d7a84e2fab82bc2c79440340e498a1e52c248e7e5e5286dd3486a29638551298170a1d19d78e3958893

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails

data/.rubocop_todo.yml

@@ -0,0 +1,153 @@
+require: rubocop-rspec
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-07-11 08:45:16 -0500 using RuboCop version 0.41.2.
+# 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
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'app/models/riiif/file.rb'
+    - 'app/models/riiif/image.rb'
+    - 'lib/riiif/http_file_resolver.rb'
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/models/riiif/http_file_resolver_spec.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'app/models/riiif/file.rb'
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 28
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 65
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 160
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 17
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/RedundantMatch:
+  Exclude:
+    - 'lib/riiif/file_system_file_resolver.rb'
+
+# Offense count: 1
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/routing/resize_routes_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/controllers/riiif/images_controller_spec.rb'
+    - 'spec/models/riiif/http_file_resolver_spec.rb'
+
+# Offense count: 4
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/controllers/riiif/images_controller_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Style/AlignHash:
+  Exclude:
+    - 'lib/riiif/routes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'app/models/riiif/image.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/riiif/rails/routes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ColonMethodCall:
+  Exclude:
+    - 'lib/riiif/http_file_resolver.rb'
+
+# Offense count: 13
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'app/controllers/riiif/images_controller.rb'
+    - 'app/models/riiif/file.rb'
+    - 'app/models/riiif/image.rb'
+    - 'lib/riiif.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: 3
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Exclude:
+    - 'app/models/riiif/image.rb'
+    - 'lib/riiif/file_system_file_resolver.rb'
+    - 'lib/riiif/http_file_resolver.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, no_empty_lines
+Style/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'app/models/riiif/file.rb'
+    - 'app/models/riiif/image.rb'
+    - 'lib/riiif/file_system_file_resolver.rb'
+    - 'lib/riiif/http_file_resolver.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'app/models/riiif/file.rb'
+    - 'app/models/riiif/image.rb'
+    - 'lib/riiif/rails/routes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Style/ExtraSpacing:
+  Exclude:
+    - 'lib/riiif/routes.rb'
+

data/Rakefile

@@ -1,11 +1,17 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'bundler/setup'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
 require 'engine_cart/rake_task'
-task ci: ['engine_cart:generate'] do
-  Rake::Task["spec"].invoke
+task ci: [:rubocop, 'engine_cart:generate'] do
+  Rake::Task['spec'].invoke
 end
 
-task default: :ci
+task default: :ci

data/app/controllers/riiif/images_controller.rb

@@ -13,12 +13,12 @@ module Riiif
                    :ok
                  else
                    :unauthorized
-                  end
+                 end
       rescue ImageNotFoundError
         status = :not_found
       end
 
-      image = not_found_image unless status == :ok 
+      image = not_found_image unless status == :ok
 
       data = image.render(params.permit(:region, :size, :rotation, :quality, :format))
       headers['Access-Control-Allow-Origin'] = '*'
@@ -46,43 +46,43 @@ module Riiif
 
     protected
 
-    LEVEL1 = 'http://iiif.io/api/image/2/level1.json'
+      LEVEL1 = 'http://iiif.io/api/image/2/level1.json'.freeze
 
-    def model
-      params.fetch(:model, "riiif/image").camelize.constantize
-    end
+      def model
+        params.fetch(:model, 'riiif/image').camelize.constantize
+      end
 
-    def image_id
-      params[:id]
-    end
+      def image_id
+        params[:id]
+      end
 
-    def authorization_service
-      model.authorization_service.new(self)
-    end
+      def authorization_service
+        model.authorization_service.new(self)
+      end
 
-    def link_header
-      response.headers["Link"] = "<#{LEVEL1}>;rel=\"profile\""
-    end
+      def link_header
+        response.headers['Link'] = "<#{LEVEL1}>;rel=\"profile\""
+      end
 
-    def not_found_image
-      raise "Not found image doesn't exist" unless Riiif.not_found_image
-      model.new(image_id, Riiif::File.new(Riiif.not_found_image))
-    end
+      def not_found_image
+        raise "Not found image doesn't exist" unless Riiif.not_found_image
+        model.new(image_id, Riiif::File.new(Riiif.not_found_image))
+      end
 
-    CONTEXT = '@context'
-    CONTEXT_URI = 'http://iiif.io/api/image/2/context.json'
-    ID = '@id'
-    PROTOCOL = 'protocol'
-    PROTOCOL_URI = 'http://iiif.io/api/image'
-    PROFILE = 'profile'
+      CONTEXT = '@context'.freeze
+      CONTEXT_URI = 'http://iiif.io/api/image/2/context.json'.freeze
+      ID = '@id'.freeze
+      PROTOCOL = 'protocol'.freeze
+      PROTOCOL_URI = 'http://iiif.io/api/image'.freeze
+      PROFILE = 'profile'.freeze
 
-    def server_info
-      {
-        CONTEXT => CONTEXT_URI,
-        ID => request.original_url.sub('/info.json', ''),
-        PROTOCOL => PROTOCOL_URI,
-        PROFILE => [LEVEL1, 'formats' => model::OUTPUT_FORMATS]
-      }
-    end
+      def server_info
+        {
+          CONTEXT => CONTEXT_URI,
+          ID => request.original_url.sub('/info.json', ''),
+          PROTOCOL => PROTOCOL_URI,
+          PROFILE => [LEVEL1, 'formats' => model::OUTPUT_FORMATS]
+        }
+      end
   end
 end

data/app/models/riiif/file.rb

@@ -22,16 +22,16 @@ module Riiif
       end
     end
 
-    def self.create(ext = nil, validate = true, &block)
-      begin
-        tempfile = Tempfile.new(['mini_magick', ext.to_s.downcase])
-        tempfile.binmode
-        block.call(tempfile)
-        tempfile.close
-        image = self.new(tempfile.path, tempfile)
-      ensure
-        tempfile.close if tempfile
-      end
+    def self.create(ext = nil, _validate = true, &block)
+
+      tempfile = Tempfile.new(['mini_magick', ext.to_s.downcase])
+      tempfile.binmode
+      block.call(tempfile)
+      tempfile.close
+      image = new(tempfile.path, tempfile)
+    ensure
+      tempfile.close if tempfile
+
     end
 
     def extract(options)
@@ -57,24 +57,24 @@ module Riiif
     def info
       return @info if @info
       height, width = execute("identify -format %hx%w #{path}").split('x')
-      @info = {height: Integer(height), width: Integer(width)}
+      @info = { height: Integer(height), width: Integer(width) }
     end
 
     private
 
       def execute(command)
-          out = nil
-          benchmark ("Riiif executed #{command}") do
-            stdin, stdout, stderr, wait_thr = popen3(command)
-            stdin.close
-            stdout.binmode
-            out = stdout.read
-            stdout.close
-            err = stderr.read
-            stderr.close
-            raise "Unable to execute command \"#{command}\"\n#{err}" unless wait_thr.value.success?
-          end
-          out
+        out = nil
+        benchmark("Riiif executed #{command}") do
+          stdin, stdout, stderr, wait_thr = popen3(command)
+          stdin.close
+          stdout.binmode
+          out = stdout.read
+          stdout.close
+          err = stderr.read
+          stderr.close
+          raise "Unable to execute command \"#{command}\"\n#{err}" unless wait_thr.value.success?
+        end
+        out
       end
 
   end

data/app/models/riiif/image.rb

@@ -17,13 +17,13 @@ module Riiif
       end
     end
 
-    OUTPUT_FORMATS = %W{jpg png}
+    OUTPUT_FORMATS = %w(jpg png).freeze
 
     attr_reader :id
 
     # @param [String] id The identifier of the file to be looked up.
     # @param [Riiif::File] file Optional: The Riiif::File to use instead of looking one up.
-    def initialize(id, file=nil)
+    def initialize(id, file = nil)
       @id = id
       @image = file if file.present?
     end
@@ -50,7 +50,7 @@ module Riiif
 
 
       def cache_key(id, options)
-        str = options.merge(id: id).delete_if {|_, v| v.nil?}.to_s
+        str = options.merge(id: id).delete_if { |_, v| v.nil? }.to_s
         # Use a MD5 digest to ensure the keys aren't too long.
         Digest::MD5.hexdigest(str)
       end
@@ -70,9 +70,9 @@ module Riiif
       end
 
       def decode_quality(quality)
-        return if quality.nil? || ['default', 'color'].include?(quality)
-        return quality if ['bitonal', 'grey'].include?(quality)
-        raise InvalidAttributeError, "Unsupported quality: #{quality}" 
+        return if quality.nil? || %w(default color).include?(quality)
+        return quality if %w(bitonal grey).include?(quality)
+        raise InvalidAttributeError, "Unsupported quality: #{quality}"
       end
 
       def decode_rotation(rotation)
@@ -91,7 +91,7 @@ module Riiif
 
       def decode_region(region)
         if region.nil? || region == 'full'
-          nil 
+          nil
         elsif md = /^pct:(\d+),(\d+),(\d+),(\d+)$/.match(region)
           # Image magic can't do percentage offsets, so we have to calculate it
           offset_x = (info[:width] * Integer(md[1]).to_f / 100).round
@@ -110,7 +110,7 @@ module Riiif
         elsif md = /^,(\d+)$/.match(size)
           "x#{md[1]}"
         elsif md = /^(\d+),$/.match(size)
-          "#{md[1]}"
+          (md[1]).to_s
         elsif md = /^pct:(\d+(.\d+)?)$/.match(size)
           "#{md[1]}%"
         elsif md = /^(\d+),(\d+)$/.match(size)

data/lib/riiif/abstract_file_system_resolver.rb

@@ -0,0 +1,26 @@
+module Riiif
+  class AbstractFileSystemResolver
+    attr_accessor :root, :base_path
+
+    def initialize
+      @root = ::File.expand_path(::File.join(::File.dirname(__FILE__), '../..'))
+      @base_path = ::File.join(root, 'spec/samples')
+    end
+
+    def find(id)
+      Riiif::File.new(path(id))
+    end
+
+    # @param [String] id the id to resolve
+    # @return the path of the file
+    def path(id)
+      search = pattern(id)
+      Dir.glob(search).first || raise(ImageNotFoundError, search)
+    end
+
+    def pattern(id)
+      raise NotImplementedError, "Implement `pattern(id)' in the concrete class"
+    end
+  end
+end
+

data/lib/riiif/akubra_system_file_resolver.rb

@@ -1,22 +1,13 @@
 require 'digest'
 require 'cgi'
 module Riiif
-  class AkubraSystemFileResolver
+  class AkubraSystemFileResolver < AbstractFileSystemResolver
     attr_accessor :pathroot, :imagetype, :akubraconfig
 
-  def initialize(pr="/yourfedora/data/datastreamStore/",ir="jp2",ac=[[0,2],[2,2],[4,1]])
-    @pathroot = pr
-    @imagetype = ir
-    @akubraconfig = ac
-  end
-
-    def find(id)
-      Riiif::File.new(path(id))
-    end
-
-    def path(id)
-      search = pattern(id)
-      Dir.glob(search).first || raise(ImageNotFoundError, search)
+    def initialize(pr = '/yourfedora/data/datastreamStore/', ir = 'jp2', ac = [[0, 2], [2, 2], [4, 1]])
+      @pathroot = pr
+      @imagetype = ir
+      @akubraconfig = ac
     end
 
     def pattern(id)
@@ -24,8 +15,8 @@ module Riiif
       md5 = Digest::MD5.new
       md5.update fullpid
       digest = md5.hexdigest
-      directorystr = ""
-      @akubraconfig.each { |a| directorystr << digest[a[0],a[1]] << "/" }
+      directorystr = ''
+      @akubraconfig.each { |a| directorystr << digest[a[0], a[1]] << '/' }
       filename = CGI.escape(fullpid)
       @pathroot + directorystr + filename
     end

data/lib/riiif/file_system_file_resolver.rb

@@ -1,27 +1,16 @@
 module Riiif
-  class FileSystemFileResolver
-    attr_accessor :root, :base_path, :input_types
-
-    def initialize
-      @root = ::File.expand_path(::File.join(::File.dirname(__FILE__), '../..'))
-      @base_path = ::File.join(root, 'spec/samples')
-      @input_types = %W{png jpg tiff jp jp2}
-    end
-
-    def find(id)
-      Riiif::File.new(path(id))
-    end
-
-    def path(id)
-      search = pattern(id)
-      Dir.glob(search).first || raise(ImageNotFoundError, search)
-    end
-
+  class FileSystemFileResolver < AbstractFileSystemResolver
+    attr_writer :input_types
 
     def pattern(id)
-      raise ArgumentError, "Invalid characters in id `#{id}`" unless /^[\w\-:]+$/.match(id)
+      raise ArgumentError, "Invalid characters in id `#{id}`" unless %r{^[\w\-:]+$}.match(id)
       ::File.join(base_path, "#{id}.{#{input_types.join(',')}}")
     end
 
+    private
+
+      def input_types
+        @input_types ||= %w(png jpg tiff jp jp2)
+      end
   end
 end

data/lib/riiif/http_file_resolver.rb

@@ -51,48 +51,48 @@ module Riiif
 
       private
 
-      def ext
-        @ext ||= ::File.extname(URI.parse(url).path)
-      end
+        def ext
+          @ext ||= ::File.extname(URI.parse(url).path)
+        end
 
-      def file_name
-        @cache_file_name ||= ::File.join(cache_path, Digest::MD5.hexdigest(url)+"#{ext}")
-      end
+        def file_name
+          @cache_file_name ||= ::File.join(cache_path, Digest::MD5.hexdigest(url) + ext.to_s)
+        end
 
-      def download_file
-        ensure_cache_path(::File.dirname(file_name))
-        benchmark ("Riiif downloaded #{url}") do
-          ::File.atomic_write(file_name, cache_path) do |local|
-            begin
-              Kernel::open(url, download_opts) do |remote|
-                while chunk = remote.read(8192)
-                  local.write(chunk)
+        def download_file
+          ensure_cache_path(::File.dirname(file_name))
+          benchmark("Riiif downloaded #{url}") do
+            ::File.atomic_write(file_name, cache_path) do |local|
+              begin
+                Kernel::open(url, download_opts) do |remote|
+                  while chunk = remote.read(8192)
+                    local.write(chunk)
+                  end
                 end
+              rescue OpenURI::HTTPError => e
+                raise ImageNotFoundError, e
               end
-            rescue OpenURI::HTTPError => e
-              raise ImageNotFoundError.new(e)
             end
           end
         end
-      end
 
-      # Get a hash of options for passing to Kernel::open
-      # This is the primary pathway for passing basic auth credentials
-      def download_opts
-        basic_auth_credentials ? { http_basic_authentication: basic_auth_credentials } : {}
-      end
+        # Get a hash of options for passing to Kernel::open
+        # This is the primary pathway for passing basic auth credentials
+        def download_opts
+          basic_auth_credentials ? { http_basic_authentication: basic_auth_credentials } : {}
+        end
 
-      # Make sure a file path's directories exist.
-      def ensure_cache_path(path)
-        FileUtils.makedirs(path) unless ::File.exist?(path)
-      end
+        # Make sure a file path's directories exist.
+        def ensure_cache_path(path)
+          FileUtils.makedirs(path) unless ::File.exist?(path)
+        end
     end
 
 
     protected
 
       def uri(id)
-        raise "Must set the id_to_uri lambda" if id_to_uri.nil?
+        raise 'Must set the id_to_uri lambda' if id_to_uri.nil?
         id_to_uri.call(id)
       end
 

data/lib/riiif/rails/routes.rb

@@ -9,4 +9,4 @@ module ActionDispatch::Routing
 
     end
   end
-end
+end

data/lib/riiif/routes.rb

@@ -8,7 +8,7 @@ module Riiif
       @options = options
     end
 
-    def add_routes &blk
+    def add_routes(&blk)
       @router.instance_exec(@options, &blk)
     end
 
@@ -17,12 +17,12 @@ module Riiif
         resource = options.fetch(:resource)
         route_prefix = options[:at]
         route_prefix ||= "/#{options[:as]}" if options[:as]
-        get "#{route_prefix}/:id/:region/:size/:rotation/:quality.:format" => "riiif/images#show",
+        get "#{route_prefix}/:id/:region/:size/:rotation/:quality.:format" => 'riiif/images#show',
           constraints: { rotation: ALLOW_DOTS, size: SIZES },
           defaults: { format: 'jpg', rotation: '0', region: 'full', quality: 'default', model: resource },
-          as: options[:as] || "image"
+          as: options[:as] || 'image'
 
-        get "#{route_prefix}/:id/info.json" => "riiif/images#info", defaults: { format: 'json', model: resource  }, as: [options[:as], "info"].compact.join("_")
+        get "#{route_prefix}/:id/info.json" => 'riiif/images#info', defaults: { format: 'json', model: resource  }, as: [options[:as], 'info'].compact.join('_')
 
         # This doesn't work presently
         # get "#{route_prefix}/:id", to: redirect("#{route_prefix}/%{id}/info.json")

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = "0.3.0"
+  VERSION = '0.4.0'.freeze
 end

data/lib/riiif.rb

@@ -1,9 +1,10 @@
-require "riiif/version"
-require "riiif/engine"
+require 'riiif/version'
+require 'riiif/engine'
 
 module Riiif
   extend ActiveSupport::Autoload
   autoload :Image
+  autoload :AbstractFileSystemResolver
   autoload :FileSystemFileResolver
   autoload :HTTPFileResolver
   autoload :Routes
@@ -14,7 +15,7 @@ module Riiif
   class InvalidAttributeError < Error; end
   class ImageNotFoundError < Error
     attr_reader :original_exception
-    def initialize(orig=nil)
+    def initialize(orig = nil)
       @original_exception = orig
     end
   end