riiif 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 467ee3abb93cc36ac8131647ebe8a7bd074abe34
-  data.tar.gz: cb3acc22191a073f47522887ee649674b7196839
+  metadata.gz: c0bb1c35a0544e1cf55ab8af94b47ba48edcb6de
+  data.tar.gz: a591cfb9fe134db6b9ab8e68ca20b4d6008e859d
 SHA512:
-  metadata.gz: 6467d2920aac954f97b7b290fb3e7b18481865f6fbe359a005bfedbb8b76ce24f35b404d2d8c2436b415a2eaa861597f9fa31c9a43c105893a9b9fe7fdd49e15
-  data.tar.gz: fc26e3a58da0f6328bd76bdf5f4881aeeb8293b79dd383124a091196d9d2b7d476f7824c65f0b1bf12ad2d82a24786dc953698db9e51d9502ba533e43626fd40
+  metadata.gz: 69e0af123b2b0d0bf47f7c8c156bb58f88fa48f8534ce3b15a3b30c24b214acbfc832d238fbf7bf7afbd71b3df6898d91d0756ecb462f45d7cc6e032c28e0a5a
+  data.tar.gz: 9fe0ca382348abcb23fc7f5b684a125b14116d96a98fdfc62e13b11644c7907f69e1035c90ef2735c1c9ef8a8bc79fc0f81c95a4349a2bc56d6935c0c14eb039

data/README.md

@@ -1,5 +1,6 @@
 # Riiif
 [![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
 

data/app/controllers/riiif/images_controller.rb

@@ -77,9 +77,9 @@ module Riiif
       ##
       # @return [ActiveSupport::HashWithIndifferentAccess]
       def image_request_params
-        result = params.permit(:region, :size, :rotation, :quality, :format).to_h
+        result = params.permit(:region, :size, :rotation, :quality, :format, :model, :id).to_h
         return result.with_indifferent_access if Rails.version < '5'
-        result
+        result.except(:model, :id)
       end
 
       def authorization_service

data/app/models/riiif/file.rb

@@ -18,6 +18,7 @@ module Riiif
         end
       end
     end
+    deprecation_deprecate read: 'Riiif::File.read is deprecated and will be removed in version 2.0'
 
     def self.create(ext = nil, _validate = true, &block)
       tempfile = Tempfile.new(['mini_magick', ext.to_s.downcase])
@@ -28,6 +29,7 @@ module Riiif
     ensure
       tempfile.close if tempfile
     end
+    deprecation_deprecate create: 'Riiif::File.create is deprecated and will be removed in version 2.0'
 
     # @param [Transformation] transformation
     def extract(transformation)

data/app/models/riiif/image.rb

@@ -17,9 +17,12 @@ require_dependency 'riiif/size/imagemagick/percent_decoder'
 require_dependency 'riiif/size/imagemagick/width_decoder'
 
 module Riiif
+  # rubocop:disable Metrics/ClassLength
   class Image
+    extend Deprecation
+
     class_attribute :file_resolver, :info_service, :authorization_service, :cache
-    self.file_resolver = FileSystemFileResolver.new
+    self.file_resolver = FileSystemFileResolver.new(base_path: File.join(Rails.root, 'tmp'))
     self.authorization_service = NilAuthorizationService
     self.cache = Rails.cache
 
@@ -40,27 +43,32 @@ module Riiif
 
     # @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, passed_file = nil)
       @id = id
-      @image = file if file.present?
+      @file = passed_file if passed_file.present?
     end
 
-    def image
-      @image ||= file_resolver.find(id)
+    def file
+      @file ||= file_resolver.find(id)
     end
 
+    alias image file
+    deprecation_deprecate image: 'Use Image#file instead. This will be removed in riiif 2.0'
+
     ##
     # @param [ActiveSupport::HashWithIndifferentAccess] args
     def render(args)
-      options = decode_options!(args)
-      cache.fetch(Image.cache_key(id, options), compress: true, expires_in: Image.expires_in) do
-        image.extract(options)
+      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(decode_options!(args))
       end
     end
 
     def info
       @info ||= begin
-                  result = info_service.call(id, image)
+                  result = info_service.call(id, file)
                   ImageInformation.new(result[:width], result[:height])
                 end
     end
@@ -71,7 +79,11 @@ module Riiif
       end
 
       def cache_key(id, options)
-        str = options.to_h.merge(id: id).delete_if { |_, v| v.nil? }.to_s
+        str = options.to_h.merge(id: id)
+                     .delete_if { |_, v| v.nil? }
+                     .sort_by { |k, _v| k.to_s }
+                     .to_s
+
         # Use a MD5 digest to ensure the keys aren't too long, and a prefix
         # to avoid collisions with other components in shared cache.
         'riiif:' + Digest::MD5.hexdigest(str)
@@ -147,4 +159,5 @@ module Riiif
       end
     # rubocop:enable Metrics/PerceivedComplexity
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/riiif/abstract_file_system_resolver.rb

@@ -1,12 +1,23 @@
+require 'deprecation'
 module Riiif
   class AbstractFileSystemResolver
-    attr_accessor :root, :base_path
+    extend Deprecation
+    attr_accessor :base_path
 
-    def initialize
-      @root = ::File.expand_path(::File.join(::File.dirname(__FILE__), '../..'))
-      @base_path = ::File.join(root, 'spec/samples')
+    def initialize(base_path: nil)
+      @base_path = base_path || default_base_path
     end
 
+    def default_base_path
+      Deprecation.warn(self, 'Initializing a file resolver without setting the base path ' \
+      'is deprecated and will be removed in Riiif 2.0', caller(2))
+      @root ||= ::File.expand_path(::File.join(::File.dirname(__FILE__), '../..'))
+      ::File.join(@root, 'spec/samples')
+    end
+
+    attr_reader :root
+    deprecation_deprecate :root
+
     def find(id)
       Riiif::File.new(path(id))
     end

data/lib/riiif/version.rb

@@ -1,3 +1,3 @@
 module Riiif
-  VERSION = '1.5.1'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/riiif.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'rubocop', '~> 0.47.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.13'
+  spec.add_development_dependency 'coveralls'
 end

data/spec/models/riiif/file_system_file_resolver_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
 describe Riiif::FileSystemFileResolver do
-  let(:resolver) { described_class.new }
+  let(:root) { File.expand_path(::File.join(::File.dirname(__FILE__), '../../..')) }
+  let(:base_path) { ::File.join(root, 'spec/samples') }
+  let(:resolver) { described_class.new(base_path: base_path) }
 
   describe '#find' do
     subject { resolver.find(id) }
@@ -16,13 +18,13 @@ describe Riiif::FileSystemFileResolver do
     context 'when a jpeg2000 file is found' do
       let(:id) { 'world' }
       it 'returns the jpeg2000 file' do
-        expect(subject.path).to eq resolver.root + '/spec/samples/world.jp2'
+        expect(subject.path).to eq base_path + '/world.jp2'
       end
     end
   end
 
   describe '#input_types' do
-    subject { described_class.new.send(:input_types) }
+    subject { resolver.send(:input_types) }
 
     it 'includes jp2 extension' do
       expect(subject).to include 'jp2'

data/spec/models/riiif/image_spec.rb

@@ -1,12 +1,21 @@
 require 'spec_helper'
 
 RSpec.describe Riiif::Image do
-  before { Riiif::Image.cache.clear }
+  subject(:image) { described_class.new('world') }
+
+  let(:root) { File.expand_path(::File.join(::File.dirname(__FILE__), '../../..')) }
+  let(:base_path) { ::File.join(root, 'spec/samples') }
+  let(:resolver) { Riiif::FileSystemFileResolver.new(base_path: base_path) }
   let(:filename) { File.expand_path('spec/samples/world.jp2') }
-  subject { described_class.new('world') }
+
+  before do
+    described_class.file_resolver = resolver
+    Riiif::Image.cache.clear
+  end
+
   describe 'happy path' do
     before do
-      expect(subject.image).to receive(:execute)
+      expect(subject.file).to receive(:execute)
         .with("convert -quality 85 -sampling-factor 4:2:0 -strip #{filename} jpg:-")
         .and_return('imagedata')
     end
@@ -41,7 +50,7 @@ RSpec.describe Riiif::Image do
       end
     end
     after do
-      described_class.file_resolver = Riiif::FileSystemFileResolver.new
+      described_class.file_resolver = resolver
     end
 
     describe 'get info' do
@@ -62,104 +71,226 @@ RSpec.describe Riiif::Image do
     end
   end
 
-  describe 'mogrify' do
+  describe '#render' do
     describe 'region' do
-      it 'returns the original when specifing full size' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -strip #{filename} png:-")
-        subject.render(region: 'full', format: 'png')
+      subject(:render) { image.render(region: region, format: 'png') }
+
+      before do
+        allow(Riiif::CommandRunner).to receive(:execute)
+          .with("identify -format %hx%w #{filename}[0]").and_return('131x175')
       end
-      it 'handles absolute geometry' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -crop 60x75+80+15 -strip #{filename} png:-")
-        subject.render(region: '80,15,60,75', format: 'png')
+
+      context 'when specifing full size' do
+        let(:region) { 'full' }
+
+        it 'returns the original' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -strip #{filename} png:-")
+          render
+        end
       end
 
-      it 'handles percent geometry' do
-        expect(Riiif::CommandRunner).to receive(:execute)
-          .with("identify -format %hx%w #{filename}[0]").and_return('131x175')
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -crop 80%x70+18+13 -strip #{filename} png:-")
-        subject.render(region: 'pct:10,10,80,70', format: 'png')
+      context 'when specifing absolute geometry' do
+        let(:region) { '80,15,60,75' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -crop 60x75+80+15 -strip #{filename} png:-")
+          render
+        end
       end
 
-      it 'handles square geometry' do
-        expect(Riiif::CommandRunner).to receive(:execute)
-          .with("identify -format %hx%w #{filename}[0]").and_return('131x175')
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -crop 131x131+22+0 -strip #{filename} png:-")
-        subject.render(region: 'square', format: 'png')
+      context 'when specifing percent geometry' do
+        let(:region) { 'pct:10,10,80,70' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -crop 80%x70+18+13 -strip #{filename} png:-")
+          render
+        end
       end
-      it 'raises an error for invalid geometry' do
-        expect { subject.render(region: '150x75', format: 'png') }.to raise_error Riiif::InvalidAttributeError
+
+      context 'when specifing square geometry' do
+        let(:region) { 'square' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -crop 131x131+22+0 -strip #{filename} png:-")
+          render
+        end
+      end
+
+      context 'when the geometry is invalid' do
+        let(:region) { '150x75' }
+
+        it 'raises an error' do
+          expect { render }.to raise_error Riiif::InvalidAttributeError
+        end
       end
     end
 
     describe 'resize' do
-      it 'returns the original when specifing full size' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -strip #{filename} png:-")
-        subject.render(size: 'full', format: 'png')
+      subject(:render) { image.render(size: size, format: 'png') }
+
+      context 'when specifing full size' do
+        let(:size) { 'full' }
+
+        it 'returns the original' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -strip #{filename} png:-")
+          render
+        end
       end
-      it 'handles integer percent sizes' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -resize 50% -strip #{filename} png:-")
-        subject.render(size: 'pct:50', format: 'png')
+
+      context 'when specifing percent size' do
+        let(:size) { 'pct:50' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -resize 50% -strip #{filename} png:-")
+          render
+        end
       end
-      it 'handles float percent sizes' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -resize 12.5% -strip #{filename} png:-")
-        subject.render(size: 'pct:12.5', format: 'png')
+
+      context 'when specifing float percent size' do
+        let(:size) { 'pct:12.5' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -resize 12.5% -strip #{filename} png:-")
+          render
+        end
       end
-      it 'handles w,' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -resize 50 -strip #{filename} png:-")
-        subject.render(size: '50,', format: 'png')
+
+      context 'when specifing w, size' do
+        let(:size) { '50,' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -resize 50 -strip #{filename} png:-")
+          render
+        end
       end
-      it 'handles ,h' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -resize x50 -strip #{filename} png:-")
-        subject.render(size: ',50', format: 'png')
+
+      context 'when specifing ,h size' do
+        let(:size) { ',50' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -resize x50 -strip #{filename} png:-")
+          render
+        end
       end
-      it 'handles w,h' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -resize 150x75! -strip #{filename} png:-")
-        subject.render(size: '150,75', format: 'png')
+
+      context 'when specifing w,h size' do
+        let(:size) { '150,75' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -resize 150x75! -strip #{filename} png:-")
+          render
+        end
       end
-      it 'handles bestfit (!w,h)' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -resize 150x75 -strip #{filename} png:-")
-        subject.render(size: '!150,75', format: 'png')
+      context 'when specifing bestfit (!w,h) size' do
+        let(:size) { '!150,75' }
+
+        it 'runs the correct imagemagick command' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -resize 150x75 -strip #{filename} png:-")
+          render
+        end
       end
-      it 'raises an error for invalid size' do
-        expect { subject.render(size: '150x75', format: 'png') }.to raise_error Riiif::InvalidAttributeError
+
+      context 'when the geometry is invalid' do
+        let(:size) { '150x75' }
+
+        it 'raises an error' do
+          expect { render }.to raise_error Riiif::InvalidAttributeError
+        end
       end
     end
 
     describe 'rotate' do
-      it 'returns the original when specifing full size' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -strip #{filename} png:-")
-        subject.render(rotation: '0', format: 'png')
+      subject(:render) { image.render(rotation: rotation, format: 'png') }
+
+      context 'without rotating' do
+        let(:rotation) { '0' }
+
+        it 'returns the original' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -strip #{filename} png:-")
+          render
+        end
       end
-      it 'handles floats' do
-        expect(Riiif::CommandRunner).to receive(:execute)
-          .with("convert -virtual-pixel white +distort srt 22.5 -strip #{filename} png:-")
-        subject.render(rotation: '22.5', format: 'png')
+
+      context 'with a float value' do
+        let(:rotation) { '22.5' }
+
+        it 'handles floats' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -virtual-pixel white +distort srt 22.5 -strip #{filename} png:-")
+          render
+        end
       end
-      it 'raises an error for invalid angle' do
-        expect { subject.render(rotation: '150x', format: 'png') }.to raise_error Riiif::InvalidAttributeError
+
+      context 'with an invalid value' do
+        let(:rotation) { '150x' }
+
+        it 'raises an error for invalid angle' do
+          expect { render }.to raise_error Riiif::InvalidAttributeError
+        end
       end
     end
 
     describe 'quality' do
-      it 'returns the original when specifing default' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -strip #{filename} png:-")
-        subject.render(quality: 'default', format: 'png')
+      subject(:render) { image.render(quality: quality, format: 'png') }
+
+      context 'when default is specified' do
+        let(:quality) { 'default' }
+
+        it 'returns the original when specifing default' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -strip #{filename} png:-")
+          render
+        end
       end
-      it 'returns the original when specifing color' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -strip #{filename} png:-")
-        subject.render(quality: 'color', format: 'png')
+
+      context 'when color is specified' do
+        let(:quality) { 'color' }
+
+        it 'returns the original when specifing color' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -strip #{filename} png:-")
+          render
+        end
       end
-      it 'converts to grayscale' do
-        expect(Riiif::CommandRunner).to receive(:execute).with("convert -colorspace Gray -strip #{filename} png:-")
-        subject.render(quality: 'grey', format: 'png')
+
+      context 'when grey is specified' do
+        let(:quality) { 'grey' }
+
+        it 'converts to grayscale' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -colorspace Gray -strip #{filename} png:-")
+          render
+        end
       end
-      it 'converts to bitonal' do
-        expect(Riiif::CommandRunner).to receive(:execute)
-          .with("convert -colorspace Gray -type Bilevel -strip #{filename} png:-")
-        subject.render(quality: 'bitonal', format: 'png')
+
+      context 'when bitonal is specified' do
+        let(:quality) { 'bitonal' }
+
+        it 'converts to bitonal' do
+          expect(Riiif::CommandRunner).to receive(:execute)
+            .with("convert -colorspace Gray -type Bilevel -strip #{filename} png:-")
+          render
+        end
       end
-      it 'raises an error for invalid angle' do
-        expect { subject.render(rotation: '150x', format: 'png') }.to raise_error Riiif::InvalidAttributeError
+
+      context 'when an invalid quality is specified' do
+        let(:quality) { 'best' }
+
+        it 'raises an error' do
+          expect { render }.to raise_error Riiif::InvalidAttributeError
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,13 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+                                                                 SimpleCov::Formatter::HTMLFormatter,
+                                                                 Coveralls::SimpleCov::Formatter
+                                                               ])
+
+SimpleCov.start('rails')
+
 require 'engine_cart'
 ENV['RAILS_ENV'] ||= 'test'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riiif
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -142,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A IIIF image server
 email:
 - justin@curationexperts.com
@@ -220,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A rails engine that support IIIF requests