dragonfly_libvips 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8118fbd55a1cbcb7be9c6e76370e1f83b2a5222e
-  data.tar.gz: 8700640ab82189fbfeaceba1a6a8639bbe1a932d
+SHA256:
+  metadata.gz: 5550340dee7a433f18f190dce904f2fe02caa339677626503f05d408f9e21cd5
+  data.tar.gz: 2b1055e2d247034322a5a6113a7af655d7762e83f4fb22525c26578db14c65a7
 SHA512:
-  metadata.gz: 797f609aa2412b97e5b738b26e429fedc81bc485b5aa19c6c2b3e432dca043c073ff1613934d84e4d5322707a3bac195e8d330df141320cc3cbd9fd2d7bd05e9
-  data.tar.gz: bca9f54bc9b8969fc601fe3d4b7798c1d30c2003c8c1e3483c5f3b1cecc1d26526fb59e92bdfbf6eef64137b6dedbecef9bd92f9c4edeea17b5769fc873fe291
+  metadata.gz: 6dd9e3e8cba7f60fd0eb3ee480f6362f88d1e3270d93ed2503b6ae69a4cb954a4f7994dd9fe1d7c24a7b0266361ea1c930bb2d22fa94ccf5f095b2ef2aabc897
+  data.tar.gz: c56578890115a8c235458b7893bcc07757c0c5422d1b73d006904032924b6fa2f450f8c2644038ac023742430ca37b9452271d405437113bfe8c96bece9ce55c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 2.2.0
+
+* add `SUPPORTED_FORMATS` and `SUPPORTED_OUTPUT_FORMATS` and raise errors when formats are not matching
+* add more thorough tests for supported formats
+* skip unnecessary conversion from-to same format
+* add `extract_area` processor
+
 ## 2.1.3
 
 * make sure the downcase analyser survives nil

data/README.md

@@ -46,9 +46,18 @@ Dragonfly.app.configure do
 end
 ```
 
-### Processors
+## Supported Formats
 
-#### Thumb
+List of supported formats (based on your build and version of the `libvips` library) is available as:
+
+```ruby
+DragonflyLibvips::SUPPORTED_FORMATS # => ["csv", "dz", "gif", …]
+DragonflyLibvips::SUPPORTED_OUTPUT_FORMATS # => ["csv", "dz", "gif", …]
+```
+
+## Processors
+
+### Thumb
 
 Create a thumbnail by resizing/cropping
 
@@ -66,7 +75,7 @@ Below are some examples of geometry strings for `thumb`:
 '400x300>' # resize only if the image is larger than this
 ```
 
-#### Encode
+### Encode
 
 Change the encoding with
 
@@ -74,13 +83,15 @@ Change the encoding with
 image.encode('jpg')
 ```
 
-optionally pass output arguments (specific to format)
+### Extract Area
+
+Extract an area from an image.
 
 ```ruby
-image.encode('jpg')
+image.extract_area(x, y, width, height)
 ```
 
-#### Rotate
+### Rotate
 
 Rotate a number of degrees with
 
@@ -88,7 +99,7 @@ Rotate a number of degrees with
 image.rotate(90)
 ```
 
-#### Options
+### Options
 
 All processors support `input_options` and `output_options` for passing additional options to vips. For example:
 
@@ -104,7 +115,7 @@ input_options: { access: :sequential }
 output_options: { profile: … } # embeds 'sRGB_v4_ICC_preference.icc' profile included with this gem
 ```
 
-### Analysers
+## Analysers
 
 The following methods are provided
 

data/dragonfly_libvips.gemspec

@@ -1,5 +1,5 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dragonfly_libvips/version'
 
@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dragonfly', '~> 1.0'
   spec.add_dependency 'ruby-vips', '~> 2.0', '>= 2.0.6'
-  spec.add_dependency 'activesupport', '>= 4.0'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/dragonfly_libvips.rb

@@ -5,6 +5,29 @@ require 'dragonfly_libvips/version'
 require 'vips'
 
 module DragonflyLibvips
+  class UnsupportedFormat < RuntimeError; end
+  class UnsupportedOutputormat < RuntimeError; end
+
   CMYK_PROFILE_PATH = File.expand_path('../vendor/cmyk.icm', __dir__)
   EPROFILE_PATH = File.expand_path('../vendor/sRGB_v4_ICC_preference.icc', __dir__)
+
+  SUPPORTED_FORMATS = begin
+    output = `vips -l | grep -i ForeignLoad`
+    output.scan(/\.(\w{1,4})/).flatten.sort.uniq
+  end
+
+  SUPPORTED_OUTPUT_FORMATS = begin
+    output = `vips -l | grep -i ForeignSave`
+    output.scan(/\.(\w{1,4})/).flatten.sort.uniq
+  end - %w[
+    csv
+    mat
+    pbm
+    pfm
+    pgm
+    ppm
+    v
+    vips
+    webp
+  ]
 end

data/lib/dragonfly_libvips/analysers/image_properties.rb

@@ -6,18 +6,22 @@ module DragonflyLibvips
       DPI = 300
 
       def call(content)
+        return {} unless SUPPORTED_FORMATS.include?(content.ext)
+
         input_options = {}
-        input_options[:access] = :sequential
-        input_options[:autorotate] = true if content.mime_type == 'image/jpeg'
-        input_options[:dpi] = DPI if content.mime_type == 'application/pdf'
+        input_options['access'] = 'sequential'
+        input_options['autorotate'] = true if content.mime_type == 'image/jpeg'
+        input_options['dpi'] = DPI if content.mime_type == 'application/pdf'
 
         img = ::Vips::Image.new_from_file(content.path, input_options)
 
-        width, height = img.width, img.height
-        xres, yres = img.xres, img.yres
+        width = img.width
+        height = img.height
+        xres = img.xres
+        yres = img.yres
 
         {
-          'format' => content.ext.try(:downcase),
+          'format' => content.ext.to_s,
           'width' => width,
           'height' => height,
           'xres' => xres,

data/lib/dragonfly_libvips/plugin.rb

@@ -1,5 +1,6 @@
 require 'dragonfly_libvips/analysers/image_properties'
 require 'dragonfly_libvips/processors/encode'
+require 'dragonfly_libvips/processors/extract_area'
 require 'dragonfly_libvips/processors/rotate'
 require 'dragonfly_libvips/processors/thumb'
 
@@ -9,43 +10,22 @@ module DragonflyLibvips
       # Analysers
       app.add_analyser :image_properties, DragonflyLibvips::Analysers::ImageProperties.new
 
-      app.add_analyser :width do |content|
-        content.analyse(:image_properties)['width']
+      %w[ width
+          height
+          xres
+          yres
+          format
+      ].each do |name|
+        app.add_analyser(name) { |c| c.analyse(:image_properties)[name] }
       end
 
-      app.add_analyser :height do |content|
-        content.analyse(:image_properties)['height']
-      end
-
-      app.add_analyser :xres do |content|
-        content.analyse(:image_properties)['xres']
-      end
-
-      app.add_analyser :yres do |content|
-        content.analyse(:image_properties)['yres']
-      end
-
-      app.add_analyser :format do |content|
-        content.analyse(:image_properties)['format']
-      end
-
-      app.add_analyser :aspect_ratio do |content|
-        attrs = content.analyse(:image_properties)
-        attrs['width'].to_f / attrs['height']
-      end
-
-      app.add_analyser :portrait do |content|
-        attrs = content.analyse(:image_properties)
-        attrs['width'] <= attrs['height']
-      end
-
-      app.add_analyser :landscape do |content|
-        !content.analyse(:portrait)
-      end
+      app.add_analyser(:aspect_ratio) { |c| c.analyse(:width).to_f / c.analyse(:height).to_f }
+      app.add_analyser(:portrait) { |c| c.analyse(:aspect_ratio) < 1.0 }
+      app.add_analyser(:landscape) { |c| !c.analyse(:portrait) }
 
-      app.add_analyser :image do |content|
+      app.add_analyser(:image) do |c|
         begin
-          content.analyse(:image_properties).key?('format')
+          c.analyse(:image_properties).key?('format')
         rescue ::Vips::Error
           false
         end
@@ -58,6 +38,7 @@ module DragonflyLibvips
 
       # Processors
       app.add_processor :encode, Processors::Encode.new
+      app.add_processor :extract_area, Processors::ExtractArea.new
       app.add_processor :thumb, Processors::Thumb.new
       app.add_processor :rotate, Processors::Rotate.new
     end

data/lib/dragonfly_libvips/processors/encode.rb

@@ -1,10 +1,24 @@
-require 'active_support/core_ext/hash'
-
 module DragonflyLibvips
   module Processors
     class Encode
+      FORMATS_WITHOUT_PROFILE_SUPPORT = %w[dz webp hdr]
+
       def call(content, format, options = {})
-        options = options.deep_stringify_keys
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
+
+        format = format.to_s
+        format = 'tif' if format == 'tiff'
+        format = 'jpg' if format == 'jpeg'
+
+        raise UnsupportedOutputFormat unless SUPPORTED_OUTPUT_FORMATS.include?(format)
+
+        if content.mime_type == Rack::Mime.mime_type(".#{format}")
+          content.ext ||= format
+          content.meta['format'] = format
+          return
+        end
+
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
 
         input_options = options.fetch('input_options', {})
         output_options = options.fetch('output_options', {})
@@ -13,12 +27,18 @@ module DragonflyLibvips
         if content.mime_type == 'image/jpeg'
           input_options['autorotate'] = true unless input_options.has_key?('autorotate')
         end
-        output_options['profile'] ||= DragonflyLibvips::EPROFILE_PATH
+
+        output_options['profile'] ||= EPROFILE_PATH
+        output_options.delete('profile') if FORMATS_WITHOUT_PROFILE_SUPPORT.include?(format)
 
         require 'vips'
         img = ::Vips::Image.new_from_file(content.path, input_options)
 
-        content.update(img.write_to_buffer(".#{format}", output_options), 'format' => format)
+        content.update(
+          img.write_to_buffer(".#{format}", output_options),
+          'name' => "temp.#{format}",
+          'format' => format
+        )
         content.ext = format
       end
 

data/lib/dragonfly_libvips/processors/extract_area.rb

@@ -0,0 +1,39 @@
+module DragonflyLibvips
+  module Processors
+    class ExtractArea
+      def call(content, x, y, width, height, options = {})
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
+
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
+        format = options.fetch('format', content.ext)
+
+        input_options = options.fetch('input_options', {})
+        output_options = options.fetch('output_options', {})
+
+        # input_options['access'] ||= 'sequential'
+        if content.mime_type == 'image/jpeg'
+          input_options['autorotate'] = true unless input_options.has_key?('autorotate')
+        end
+        output_options['profile'] ||= EPROFILE_PATH
+
+        require 'vips'
+        img = ::Vips::Image.new_from_file(content.path, input_options)
+
+        img = img.extract_area(x, y, width, height)
+
+        content.update(
+          img.write_to_buffer(".#{format}", output_options),
+          'name' => "temp.#{format}",
+          'format' => format
+        )
+        content.ext = format
+      end
+
+      def update_url(url_attributes, _, _, _, _, options = {})
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
+        return unless format = options.fetch('format', nil)
+        url_attributes.ext = format
+      end
+    end
+  end
+end

data/lib/dragonfly_libvips/processors/rotate.rb

@@ -1,37 +1,38 @@
-require 'active_support/core_ext/hash'
-
 module DragonflyLibvips
   module Processors
     class Rotate
       def call(content, rotate, options = {})
-        options = options.deep_stringify_keys
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
 
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
         format = options.fetch('format', content.ext)
 
         input_options = options.fetch('input_options', {})
         output_options = options.fetch('output_options', {})
 
-        input_options['access'] ||= 'sequential'
+        # input_options['access'] ||= 'sequential'
         if content.mime_type == 'image/jpeg'
           input_options['autorotate'] = true unless input_options.has_key?('autorotate')
         end
-        output_options['profile'] ||= DragonflyLibvips::EPROFILE_PATH
+        output_options['profile'] ||= EPROFILE_PATH
 
         require 'vips'
         img = ::Vips::Image.new_from_file(content.path, input_options)
 
         img = img.rot("d#{rotate}")
 
-        content.update(img.write_to_buffer(".#{format}", output_options), 'format' => format)
+        content.update(
+          img.write_to_buffer(".#{format}", output_options),
+          'name' => "temp.#{format}",
+          'format' => format
+        )
         content.ext = format
       end
 
       def update_url(url_attributes, _, options = {})
-        options = options.deep_stringify_keys
-
-        if format = options.fetch('format', nil)
-          url_attributes.ext = format
-        end
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
+        return unless format = options.fetch('format', nil)
+        url_attributes.ext = format
       end
     end
   end

data/lib/dragonfly_libvips/processors/thumb.rb

@@ -1,4 +1,3 @@
-require 'active_support/core_ext/hash'
 require 'dragonfly_libvips/dimensions'
 require 'vips'
 
@@ -10,56 +9,63 @@ module DragonflyLibvips
       DPI = 300
 
       def call(content, geometry, options = {})
-        options = options.deep_symbolize_keys
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
+
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
 
         filename = content.path
-        format = options.fetch(:format, content.ext)
+        format = options.fetch('format', content.ext).to_s
 
-        input_options = options.fetch(:input_options, {})
-        input_options[:access] = input_options.fetch(:access, 'sequential')
-        input_options[:autorotate] = input_options.fetch(:autorotate, true) if content.mime_type == 'image/jpeg'
+        input_options = options.fetch('input_options', {})
+        input_options['access'] = input_options.fetch('access', 'sequential')
+        input_options['autorotate'] = input_options.fetch('autorotate', true) if content.mime_type == 'image/jpeg'
 
         if content.mime_type == 'application/pdf'
-          input_options[:dpi] = input_options.fetch(:dpi, DPI) if content.mime_type == 'application/pdf'
-          input_options[:page] = input_options.fetch(:page, 0) if content.mime_type == 'application/pdf'
+          input_options['dpi'] = input_options.fetch('dpi', DPI) if content.mime_type == 'application/pdf'
+          input_options['page'] = input_options.fetch('page', 0) if content.mime_type == 'application/pdf'
         else
-          input_options.delete(:page)
-          input_options.delete(:dpi)
+          input_options.delete('page')
+          input_options.delete('dpi')
         end
 
-        output_options = options.fetch(:output_options, {})
-        output_options[:profile] = input_options.fetch(:profile, DragonflyLibvips::EPROFILE_PATH)
+        output_options = options.fetch('output_options', {})
+        output_options['profile'] = input_options.fetch('profile', EPROFILE_PATH)
 
+        input_options = input_options.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v } # symbolize
         img = ::Vips::Image.new_from_file(filename, input_options)
 
         dimensions = case geometry
-                     when RESIZE_GEOMETRY then DragonflyLibvips::Dimensions.call(geometry, img.width, img.height)
+                     when RESIZE_GEOMETRY then Dimensions.call(geometry, img.width, img.height)
                      else raise ArgumentError, "Didn't recognise the geometry string: #{geometry}"
         end
 
-        thumbnail_options = options.fetch(:thumbnail_options, {})
-        thumbnail_options[:auto_rotate] = input_options.fetch(:autorotate, true) if content.mime_type == 'image/jpeg'
-        thumbnail_options[:height] = thumbnail_options.fetch(:height, dimensions.height.ceil)
-        thumbnail_options[:import_profile] = DragonflyLibvips::CMYK_PROFILE_PATH if img.get('interpretation') == :cmyk
-        thumbnail_options[:size] ||= case geometry
+        thumbnail_options = options.fetch('thumbnail_options', {})
+        thumbnail_options['auto_rotate'] = input_options.fetch('autorotate', true) if content.mime_type == 'image/jpeg'
+        thumbnail_options['height'] = thumbnail_options.fetch('height', dimensions.height.ceil)
+        thumbnail_options['import_profile'] = CMYK_PROFILE_PATH if img.get('interpretation') == :cmyk
+        thumbnail_options['size'] ||= case geometry
                                      when />\z/ then :down # do_not_resize_if_image_smaller_than_requested
                                      when /<\z/ then :up # do_not_resize_if_image_larger_than_requested
                                      else :both
         end
 
         filename += "[page=#{input_options[:page]}]" if content.mime_type == 'application/pdf'
+
+        thumbnail_options = thumbnail_options.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v } # symbolize
         thumb = ::Vips::Image.thumbnail(filename, dimensions.width.ceil, thumbnail_options)
 
-        content.update(thumb.write_to_buffer(".#{format}", output_options), 'format' => format)
+        content.update(
+          thumb.write_to_buffer(".#{format}", output_options),
+          'name' => "temp.#{format}",
+          'format' => format
+        )
         content.ext = format
       end
 
       def update_url(url_attributes, _, options = {})
-        options = options.deep_symbolize_keys
-
-        if format = options.fetch(:format, nil)
-          url_attributes.ext = format
-        end
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
+        return unless format = options.fetch('format', nil)
+        url_attributes.ext = format
       end
     end
   end

data/lib/dragonfly_libvips/version.rb

@@ -1,3 +1,3 @@
 module DragonflyLibvips
-  VERSION = '2.1.3'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/samples/sample.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<svg version="1.1" id="sample_id" xmlns="http://www.w3.org/2000/svg" width="200" height="300" viewBox="0 0 200 300">
+  <rect fill="none" stroke="#000000" x="0" y="0" width="200" height="300" />
+</svg>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_libvips
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
@@ -44,20 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.6
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -151,13 +151,18 @@ files:
 - lib/dragonfly_libvips/dimensions.rb
 - lib/dragonfly_libvips/plugin.rb
 - lib/dragonfly_libvips/processors/encode.rb
+- lib/dragonfly_libvips/processors/extract_area.rb
 - lib/dragonfly_libvips/processors/rotate.rb
 - lib/dragonfly_libvips/processors/thumb.rb
 - lib/dragonfly_libvips/version.rb
-- samples/beach.png
-- samples/cmyk.jpg
-- samples/landscape_beach.png
-- samples/memo.pdf
+- samples/landscape_sample.png
+- samples/sample.gif
+- samples/sample.jpg
+- samples/sample.pdf
+- samples/sample.png
+- samples/sample.svg
+- samples/sample.tif
+- samples/sample_cmyk.jpg
 - samples/white pixel.png
 - vendor/cmyk.icm
 - vendor/sRGB_v4_ICC_preference.icc
@@ -181,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Dragonfly analysers and processors for libvips image processing library.