image_processing 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bbfdce2d8d8f1b750b61f241ee2b73238c87f0f
-  data.tar.gz: 357ac76e747cf48055673ef1d023268cade403c8
+  metadata.gz: 99835dc44c17bab77f81bca431807996d31042d2
+  data.tar.gz: c6b0c1b08d70e871a90f63ae66e5a501edc7c521
 SHA512:
-  metadata.gz: 365f69bc69fa37a072f439c810f45ec421504a8edb9edbc73ae6306d9ed7391153c343b3aae4fb7950b8520b01fe03dcd0bc55f45a83eb5c459a33e40b9191b0
-  data.tar.gz: 4800c9b7f470cb5246543c985854a56edee922508b3882f41002312801d0372b8b47a583e4e1aad628e0cbbe5e3df8be38c27f7fdac8547fdc1e52d13a09b9d6
+  metadata.gz: 529a954d4f587f756e55aa5316743f34747c5786c0c8ec729db1a9977c24bc5304575e9a96394d5270f234e180240fbd0f33035c0640e89993687377df4e744d
+  data.tar.gz: b6752c0ec43316e402b30bd54bd714b392bba09aac391979d4502c54f915cce2ceb989fcf3b366982c16084cc5208fa2168bb67a0d2097ba98b8c1a126fa966b

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## 0.11.1 (2017-03-27)
+## 0.11.2 (2018-03-31)
+
+* [minimagick] Avoid `#resize_*` operations stripping data by switching back to `-resize` (@janko-m)
+
+* [core] Make sure an empty destination file doesn't remain on processing errors when `:destination` is used (@janko-m)
+
+* [vips] Fix `:alpha` not correctly adding alpha for certain types of images (@janko-m)
+
+* [minimagick] Drop official support for GraphicsMagick (@janko-m)
+
+## 0.11.1 (2018-03-27)
 
 * [minimagick] Rename `#limit` to `#limits` to still allow adding `-limit` arguments directly (@janko-m)
 

data/README.md

@@ -1,8 +1,7 @@
 # ImageProcessing
 
 Provides higher-level image processing functionality that is commonly needed
-when accepting user uploads. Supports processing with [VIPS] and
-[ImageMagick]/[GraphicsMagick].
+when accepting user uploads. Supports processing with [libvips] and [ImageMagick].
 
 The goal of this project is to have a single place where common image
 processing helper methods are maintained, instead of Paperclip, CarrierWave,
@@ -11,7 +10,7 @@ Refile, Dragonfly and ActiveStorage each implementing their own versions.
 ## Installation
 
 ```rb
-gem "image_processing", "~> 0.10"
+gem "image_processing", "~> 0.11"
 ```
 
 ## Usage
@@ -103,17 +102,17 @@ See the **[wiki]** for additional "How To" guides for common scenarios.
 
 ## Contributing
 
-Test suite requires `imagemagick`, `graphicsmagick` and `libvips` to be
-installed. On Mac OS you can install them with Homebrew:
+Test suite requires `imagemagick` and `libvips` to be installed. On Mac OS you
+can install them with Homebrew:
 
 ```
-$ brew install imagemagick graphicsmagick vips
+$ brew install imagemagick vips
 ```
 
 Afterwards you can run tests with
 
 ```
-$ rake test
+$ bundle exec rake test
 ```
 
 ## Credits
@@ -125,9 +124,8 @@ The `ImageProcessing::MiniMagick` functionality was extracted from
 
 [MIT](LICENSE.txt)
 
+[libvps]: http://jcupitt.github.io/libvips/
 [ImageMagick]: https://www.imagemagick.org
-[GraphicsMagick]: http://www.graphicsmagick.org
-[VIPS]: http://jcupitt.github.io/libvips/
 [`ImageProcessing::Vips`]: /doc/vips.md#imageprocessingvips
 [`ImageProcessing::MiniMagick`]: /doc/minimagick.md#imageprocessingminimagick
 [refile-mini_magick]: https://github.com/refile/refile-mini_magick

data/image_processing.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.files         = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*.rb", "*.gemspec"]
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.8"
   spec.add_development_dependency "minitest-hooks", ">= 1.4.2"
   spec.add_development_dependency "minispec-metadata"

data/lib/image_processing.rb

@@ -1,5 +1,7 @@
 require "image_processing/chainable"
+require "image_processing/builder"
 require "image_processing/pipeline"
+require "image_processing/processor"
 require "image_processing/version"
 
 module ImageProcessing

data/lib/image_processing/builder.rb

@@ -0,0 +1,13 @@
+module ImageProcessing
+  class Builder
+    include Chainable
+
+    def initialize(options)
+      @default_options = options
+    end
+
+    def call!(**options)
+      Pipeline.new(default_options).call(**options)
+    end
+  end
+end

data/lib/image_processing/chainable.rb

@@ -29,7 +29,7 @@ module ImageProcessing
 
     def method_missing(name, *args)
       if name.to_s.end_with?("!")
-        send(name.to_s.chomp("!"), *args).call!
+        send(name.to_s.chomp("!"), *args).call
       elsif name.to_s.end_with?("?")
         super
       else
@@ -37,26 +37,28 @@ module ImageProcessing
       end
     end
 
-    def call(file = nil, **call_options)
+    def call(file = nil, destination: nil, **call_options)
       options = default_options
       options = options.merge(source: file) if file
+      options = options.merge(destination: destination) if destination
 
       branch(options).call!(**call_options)
     end
 
     def branch(options)
-      options = options.merge(processor: self::Processor) if self.is_a?(Module)
-      Pipeline.new(options)
+      options = options.merge(processor_class: self::Processor) unless self.is_a?(Builder)
+
+      Builder.new(options)
     end
 
     def default_options
       @default_options ||= {
-        source:     nil,
-        loader:     {},
-        saver:      {},
-        format:     nil,
-        operations: [],
-        processor:  nil,
+        source:          nil,
+        loader:          {},
+        saver:           {},
+        format:          nil,
+        operations:      [],
+        processor_class: nil,
       }
     end
   end

data/lib/image_processing/mini_magick.rb

@@ -17,27 +17,19 @@ module ImageProcessing
       false
     end
 
-    class Processor
+    class Processor < ImageProcessing::Processor
       IMAGE_CLASS = ::MiniMagick::Tool
 
-      def apply_operation(name, magick, *args)
-        if respond_to?(name)
-          public_send(name, magick, *args)
-        else
-          magick.send(name, *args)
-        end
-      end
-
       def resize_to_limit(magick, width, height)
-        magick.thumbnail "#{width}x#{height}>"
+        magick.resize "#{width}x#{height}>"
       end
 
       def resize_to_fit(magick, width, height)
-        magick.thumbnail "#{width}x#{height}"
+        magick.resize "#{width}x#{height}"
       end
 
       def resize_to_fill(magick, width, height, gravity: "Center")
-        magick.thumbnail "#{width}x#{height}^"
+        magick.resize "#{width}x#{height}^"
         magick.gravity gravity
         magick.background "rgba(255,255,255,0.0)" # transparent
         magick.extent "#{width}x#{height}"
@@ -46,7 +38,7 @@ module ImageProcessing
       def resize_and_pad(magick, width, height, background: :transparent, gravity: "Center")
         background = "rgba(255,255,255,0.0)" if background.to_s == "transparent"
 
-        magick.thumbnail "#{width}x#{height}"
+        magick.resize "#{width}x#{height}"
         magick.background background
         magick.gravity gravity
         magick.extent "#{width}x#{height}"

data/lib/image_processing/pipeline.rb

@@ -2,58 +2,91 @@ require "tempfile"
 
 module ImageProcessing
   class Pipeline
-    include Chainable
+    DEFAULT_FORMAT = "jpg"
+
+    attr_reader :source, :loader, :saver, :format, :operations, :processor_class, :destination
 
     def initialize(options)
-      @default_options = options
+      options.each do |name, value|
+        value = normalize_source(value, options) if name == :source
+        instance_variable_set(:"@#{name}", value)
+      end
     end
 
-    def call!(save: true, destination: nil)
-      fail Error, "source file is not provided" unless default_options[:source]
+    def call(save: true)
+      processor = processor_class.new(self)
+      image     = processor.load_image(source, **loader)
 
-      image_class = default_options[:processor]::IMAGE_CLASS
+      operations.each do |name, args|
+        image = processor.apply_operation(name, image, *args)
+      end
 
-      if default_options[:source].is_a?(image_class)
-        source = default_options[:source]
-      elsif default_options[:source].is_a?(String)
-        source = default_options[:source]
-      elsif default_options[:source].respond_to?(:path)
-        source = default_options[:source].path
-      elsif default_options[:source].respond_to?(:to_path)
-        source = default_options[:source].to_path
+      if save == false
+        image
+      elsif destination
+        handle_destination do
+          processor.save_image(image, destination, **saver)
+        end
       else
-        fail Error, "source file needs to respond to #path, or be a String, a Pathname, or a #{image_class} object"
+        create_tempfile do |tempfile|
+          processor.save_image(image, tempfile.path, **saver)
+        end
       end
+    end
 
-      processor = default_options[:processor].new
-      image     = processor.load_image(source, default_options[:loader])
+    def source_path
+      source if source.is_a?(String)
+    end
 
-      default_options[:operations].each do |name, args|
-        if name == :custom
-          image = args.first.call(image) || image
-        else
-          image = processor.apply_operation(name, image, *args)
-        end
-      end
+    def destination_format
+      format   = File.extname(destination)[1..-1] if destination
+      format ||= self.format
+      format ||= File.extname(source_path)[1..-1] if source_path
 
-      return image unless save
+      format || DEFAULT_FORMAT
+    end
 
-      return processor.save_image(image, destination, default_options[:saver]) if destination
+    private
 
-      source_path = source if source.is_a?(String)
-      format      = default_options[:format] || File.extname(source_path.to_s)[1..-1] || "jpg"
+    def create_tempfile
+      tempfile = Tempfile.new(["image_processing", ".#{destination_format}"], binmode: true)
 
-      result = Tempfile.new(["image_processing", ".#{format}"], binmode: true)
+      yield tempfile
 
-      begin
-        processor.save_image(image, result.path, default_options[:saver])
-      rescue
-        result.close!
-        raise
-      end
+      tempfile.open
+      tempfile
+    rescue
+      tempfile.close! if tempfile
+      raise
+    end
+
+    # In case of processing errors, both libvips and imagemagick will leave the
+    # empty destination file they created, so this method makes sure it is
+    # deleted in case an exception is raised on saving the image.
+    def handle_destination
+      destination_existed = File.exist?(destination)
+      yield
+    rescue
+      File.delete(destination) if File.exist?(destination) && !destination_existed
+      raise
+    end
 
-      result.open
-      result
+    def normalize_source(source, options)
+      fail Error, "source file is not provided" unless source
+
+      image_class = options[:processor_class]::IMAGE_CLASS
+
+      if source.is_a?(image_class)
+        source
+      elsif source.is_a?(String)
+        source
+      elsif source.respond_to?(:path)
+        source.path
+      elsif source.respond_to?(:to_path)
+        source.to_path
+      else
+        fail Error, "source file needs to respond to #path, or be a String, a Pathname, or a #{image_class} object"
+      end
     end
   end
 end

data/lib/image_processing/processor.rb

@@ -0,0 +1,23 @@
+module ImageProcessing
+  class Processor
+    def initialize(pipeline)
+      @pipeline = pipeline
+    end
+
+    def apply_operation(name, image, *args)
+      if respond_to?(name)
+        public_send(name, image, *args)
+      else
+        image.send(name, *args)
+      end
+    end
+
+    def custom(image, block)
+      block.call(image) || image
+    end
+
+    private
+
+    attr_reader :pipeline
+  end
+end

data/lib/image_processing/version.rb

@@ -1,3 +1,3 @@
 module ImageProcessing
-  VERSION = "0.11.1"
+  VERSION = "0.11.2"
 end

data/lib/image_processing/vips.rb

@@ -14,19 +14,15 @@ module ImageProcessing
       false
     end
 
-    class Processor
+    class Processor < ImageProcessing::Processor
       IMAGE_CLASS = ::Vips::Image
       # libvips has this arbitrary number as a sanity-check upper bound on image
       # size.
       MAX_COORD = 10_000_000
 
       def apply_operation(name, image, *args)
-        if respond_to?(name)
-          public_send(name, image, *args)
-        else
-          result = image.send(name, *args)
-          result.is_a?(::Vips::Image) ? result : image
-        end
+        result = super
+        result.is_a?(::Vips::Image) ? result : image
       end
 
       def resize_to_limit(image, width, height, **options)
@@ -48,7 +44,7 @@ module ImageProcessing
         embed_options.reject! { |name, value| value.nil? }
 
         image = image.thumbnail_image(width, height: height, **options)
-        image = image.bandjoin(255) if alpha && image.bands == 3
+        image = add_alpha(image) if alpha && !has_alpha?(image)
         image.gravity(gravity, width, height, **embed_options)
       end
 
@@ -74,6 +70,19 @@ module ImageProcessing
 
       private
 
+      # Port of libvips' vips_addalpha().
+      def add_alpha(image)
+        max_alpha = (image.interpretation == :grey16 || image.interpretation == :rgb16) ? 65535 : 255
+        image.bandjoin(max_alpha)
+      end
+
+      # Port of libvips' vips_hasalpha().
+      def has_alpha?(image)
+        image.bands == 2 ||
+        (image.bands == 4 && image.interpretation != :cmyk) ||
+        image.bands > 4
+      end
+
       def default_dimensions(width, height)
         raise Error, "either width or height must be specified" unless width || height
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: image_processing
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -106,10 +120,12 @@ files:
 - README.md
 - image_processing.gemspec
 - lib/image_processing.rb
+- lib/image_processing/builder.rb
 - lib/image_processing/chainable.rb
 - lib/image_processing/mini_magick.rb
 - lib/image_processing/mini_magick/deprecated_api.rb
 - lib/image_processing/pipeline.rb
+- lib/image_processing/processor.rb
 - lib/image_processing/version.rb
 - lib/image_processing/vips.rb
 homepage: https://github.com/janko-m/image_processing