image_processing 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e15f100c14c6b60a0107e1d3b2f6ff41e2890f9ecd1fb3f73ae4838249650746
-  data.tar.gz: 2a8c07a6891465aebb7d172354780a5cba8d75933c4c7354d7b68acf8c6b321f
+  metadata.gz: 0e86e76046f3b8e0b9fd36a71d52b158a923c75f33848692de1e199ecb17366f
+  data.tar.gz: 7267f19b5cb3224a61e04be0a0d3b3f17d353750a1a522a11f2912b9ba49b809
 SHA512:
-  metadata.gz: 21f23471ac04698370c6b3a77a82d8a4be70a754ff4f5440ae91ee03a9d1e52c03b5b0bf0a54e7bd523fdb174ecc805158dd0a013ad88bfa1c3945cc2b973c81
-  data.tar.gz: f90f0ae07f460358571b929ef2f831fdb640bbbcfda7c7ba9f6416e0d24ea303c8431e0cd193137d4228a626c0f74a7f09839f732db0289c092459e7c4c28ade
+  metadata.gz: 473958a39a8e760cdb9d352399190f1cdea0dcd915ad729ec740fb7f424dc05041c43fe1085439c0f54763c388b83c2b7dcf32f66cc15caa9dbc0f21c325a166
+  data.tar.gz: ac3cc41432e9dc786035f77c721eb1407c84c6307fccc9d8f01f42ca909618229134411f503eeeb770809f620804468750414e6dc8900c442a46d08d3d02e660

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 1.12.0 (2020-09-20)
+
+* Add instrumentation support via `#instrumenter` (@janko)
+
+## 1.11.0 (2020-05-17)
+
+* [minimagick] Handle destination format having no file extension (@janko)
+
+* [minimagick] Disable sharpening on `#resize_*` operators by default (@flori)
+
+* [minimagick] Add `#crop` which accepts `left, top, width, height` arguments (@janko)
+
+## 1.10.3 (2020-01-12)
+
+* [vips] Fix auto-rotation not working in certain cases on libvips 8.9.0 (@janko)
+
+## 1.10.2 (2020-01-11)
+
+* Fix Ruby 2.7 warnings for separation of positional and keyword arguments (@kamipo, @janko)
+
+## 1.10.1 (2020-01-07)
+
+* [vips] Fix compatibility with ruby-vips 2.0.17+ (@janko)
+
 ## 1.10.0 (2019-12-18)
 
 * [minimagick] Add `:loader` option for explicitly setting input file type (@janko)

data/README.md

@@ -42,9 +42,9 @@ how to resize and process images.
 
 ## Usage
 
-Processing is performed through [`ImageProcessing::Vips`] or
-[`ImageProcessing::MiniMagick`] modules. Both modules share the same chainable
-API for defining the processing pipeline:
+Processing is performed through **[`ImageProcessing::Vips`]** or
+**[`ImageProcessing::MiniMagick`]** modules. Both modules share the same
+chainable API for defining the processing pipeline:
 
 ```rb
 require "image_processing/mini_magick"
@@ -148,6 +148,34 @@ You can continue reading the API documentation for specific modules:
 See the **[wiki]** for additional "How To" guides for common scenarios. The wiki
 is publicly editable, so you're encouraged to add your own guides.
 
+## Instrumentation
+
+You can register an `#instrumenter` block for a given pipeline, which will wrap
+the pipeline execution, allowing you to record performance metrics.
+
+```rb
+pipeline = ImageProcessing::Vips.instrumenter do |**options, &processing|
+  options[:source]     #=> #<File:...>
+  options[:loader]     #=> { fail: true }
+  options[:saver]      #=> { quality: 85 }
+  options[:format]     #=> "png"
+  options[:operations] #=> [[:resize_to_limit, 500, 500], [:flip, [:horizontal]]]
+  options[:processor]  #=> ImageProcessing::Vips::Processor
+
+  ActiveSupport::Notifications.instrument("process.image_processing", **options) do
+    processing.call # calls the pipeline
+  end
+end
+
+pipeline
+  .source(image)
+  .loader(fail: true)
+  .saver(quality: 85)
+  .convert("png")
+  .resize_to_limit(500, 500)
+  .flip(:horizontal)
+  .call # calls instrumenter
+```
 
 ## Contributing
 

data/image_processing.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3"
 
-  spec.summary       = "Set of higher-level helper methods for image processing."
-  spec.description   = "Set of higher-level helper methods for image processing."
+  spec.summary       = "High-level wrapper for processing images for the web with ImageMagick or libvips."
+  spec.description   = "High-level wrapper for processing images for the web with ImageMagick or libvips."
   spec.homepage      = "https://github.com/janko/image_processing"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "mini_magick", ">= 4.9.5", "< 5"
-  spec.add_dependency "ruby-vips", ">= 2.0.13", "< 3"
+  spec.add_dependency "ruby-vips", ">= 2.0.17", "< 3"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.8"

data/lib/image_processing/builder.rb

@@ -9,8 +9,24 @@ module ImageProcessing
     end
 
     # Calls the pipeline to perform the processing from built options.
-    def call!(**options)
-      Pipeline.new(self.options).call(**options)
+    def call!(**call_options)
+      instrument do
+        Pipeline.new(pipeline_options).call(**call_options)
+      end
+    end
+
+    private
+
+    def instrument
+      return yield unless options[:instrumenter]
+
+      result = nil
+      options[:instrumenter].call(**pipeline_options) { result = yield }
+      result
+    end
+
+    def pipeline_options
+      options.reject { |key, _| key == :instrumenter }
     end
   end
 end

data/lib/image_processing/chainable.rb

@@ -21,6 +21,11 @@ module ImageProcessing
       branch saver: options
     end
 
+    # Register instrumentation block that will be called around the pipeline.
+    def instrumenter(&block)
+      branch instrumenter: block
+    end
+
     # Add multiple operations as a hash or an array.
     #
     #   .apply(resize_to_limit: [400, 400], strip: true)
@@ -32,21 +37,14 @@ module ImageProcessing
           builder.send(name)
         elsif argument.is_a?(Array)
           builder.send(name, *argument)
+        elsif argument.is_a?(Hash)
+          builder.send(name, **argument)
         else
           builder.send(name, argument)
         end
       end
     end
 
-    # Assume that any unknown method names an operation supported by the
-    # processor. Add a bang ("!") if you want processing to be performed.
-    def method_missing(name, *args, &block)
-      return super if name.to_s.end_with?("?")
-      return send(name.to_s.chomp("!"), *args, &block).call if name.to_s.end_with?("!")
-
-      operation(name, *args, &block)
-    end
-
     # Add an operation defined by the processor.
     def operation(name, *args, &block)
       branch operations: [[name, args, *block]]
@@ -55,27 +53,41 @@ module ImageProcessing
     # Call the defined processing and get the result. Allows specifying
     # the source file and destination.
     def call(file = nil, destination: nil, **call_options)
-      options = {}
-      options = options.merge(source: file) if file
-      options = options.merge(destination: destination) if destination
+      options = { source: file, destination: destination }.compact
 
-      branch(options).call!(**call_options)
+      branch(**options).call!(**call_options)
     end
 
     # Creates a new builder object, merging current options with new options.
-    def branch(loader: nil, saver: nil, operations: nil, **other_options)
-      options = respond_to?(:options) ? self.options : DEFAULT_OPTIONS
+    def branch(**new_options)
+      if self.is_a?(Builder)
+        options = self.options
+      else
+        options = DEFAULT_OPTIONS.merge(processor: self::Processor)
+      end
 
-      options = options.merge(loader: options[:loader].merge(loader)) if loader
-      options = options.merge(saver: options[:saver].merge(saver)) if saver
-      options = options.merge(operations: options[:operations] + operations) if operations
-      options = options.merge(processor: self::Processor) unless self.is_a?(Builder)
-      options = options.merge(other_options)
+      options = options.merge(new_options) do |key, old_value, new_value|
+        case key
+        when :loader, :saver then old_value.merge(new_value)
+        when :operations     then old_value + new_value
+        else                      new_value
+        end
+      end
+
+      Builder.new(options.freeze)
+    end
 
-      options.freeze
+    private
 
-      Builder.new(options)
+    # Assume that any unknown method names an operation supported by the
+    # processor. Add a bang ("!") if you want processing to be performed.
+    def method_missing(name, *args, &block)
+      return super if name.to_s.end_with?("?")
+      return send(name.to_s.chomp("!"), *args, &block).call if name.to_s.end_with?("!")
+
+      operation(name, *args, &block)
     end
+    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
     # Empty options which the builder starts with.
     DEFAULT_OPTIONS = {

data/lib/image_processing/mini_magick.rb

@@ -32,7 +32,7 @@ module ImageProcessing
           source_path = path_or_magick
           magick = ::MiniMagick::Tool::Convert.new
 
-          Utils.apply_options(magick, options)
+          Utils.apply_options(magick, **options)
 
           input  = source_path
           input  = "#{loader}:#{input}" if loader
@@ -50,7 +50,7 @@ module ImageProcessing
       # the result to disk. Accepts additional options related to saving the
       # image (e.g. quality).
       def self.save_image(magick, destination_path, allow_splitting: false, **options)
-        Utils.apply_options(magick, options)
+        Utils.apply_options(magick, **options)
 
         magick << destination_path
         magick.call
@@ -86,6 +86,15 @@ module ImageProcessing
         magick.extent "#{width}x#{height}"
       end
 
+      # Crops the image with the specified crop points.
+      def crop(*args)
+        case args.count
+        when 1 then magick.crop(*args)
+        when 4 then magick.crop("#{args[2]}x#{args[3]}+#{args[0]}+#{args[1]}")
+        else fail ArgumentError, "wrong number of arguments (expected 1 or 4, got #{args.count})"
+        end
+      end
+
       # Rotates the image by an arbitrary angle. For angles that are not
       # multiple of 90 degrees an optional background color can be specified to
       # fill in the gaps.
@@ -161,7 +170,7 @@ module ImageProcessing
 
       # Resizes the image using the specified geometry, and sharpens the
       # resulting thumbnail.
-      def thumbnail(geometry, sharpen: {})
+      def thumbnail(geometry, sharpen: nil)
         magick.resize(geometry)
 
         if sharpen
@@ -192,7 +201,7 @@ module ImageProcessing
         # format, ImageMagick will create multiple images, one for each layer.
         # We want to warn the user that this is probably not what they wanted.
         def disallow_split_layers!(destination_path)
-          layers = Dir[destination_path.sub(/\.\w+$/, '-*\0')]
+          layers = Dir[destination_path.sub(/(\.\w+)?$/, '-*\0')]
 
           if layers.any?
             layers.each { |path| File.delete(path) }

data/lib/image_processing/processor.rb

@@ -34,19 +34,12 @@ module ImageProcessing
       const_set(:ACCUMULATOR_CLASS, klass)
     end
 
-    # Calls the operation to perform the processing. If the operation is
-    # defined on the processor (macro), calls it. Otherwise calls the
-    # operation directly on the accumulator object. This provides a common
-    # umbrella above defined macros and direct operations.
+    # Delegates to #apply_operation.
     def self.apply_operation(accumulator, (name, args, block))
-      if method_defined?(name)
-        instance = new(accumulator)
-        instance.public_send(name, *args, &block)
-      else
-        accumulator.send(name, *args, &block)
-      end
+      new(accumulator).apply_operation(name, *args, &block)
     end
 
+    # Whether the processor supports resizing the image upon loading.
     def self.supports_resize_on_load?
       false
     end
@@ -55,6 +48,21 @@ module ImageProcessing
       @accumulator = accumulator
     end
 
+    # Calls the operation to perform the processing. If the operation is
+    # defined on the processor (macro), calls the method. Otherwise calls the
+    # operation directly on the accumulator object. This provides a common
+    # umbrella above defined macros and direct operations.
+    def apply_operation(name, *args, &block)
+      receiver = respond_to?(name) ? self : @accumulator
+
+      if args.last.is_a?(Hash)
+        kwargs = args.pop
+        receiver.public_send(name, *args, **kwargs, &block)
+      else
+        receiver.public_send(name, *args, &block)
+      end
+    end
+
     # Calls the given block with the accumulator object. Useful for when you
     # want to access the accumulator object directly.
     def custom(&block)

data/lib/image_processing/version.rb

@@ -1,3 +1,3 @@
 module ImageProcessing
-  VERSION = "1.10.0"
+  VERSION = "1.12.0"
 end

data/lib/image_processing/vips.rb

@@ -54,7 +54,7 @@ module ImageProcessing
       # pipeline defined in the Vips::Image object. Accepts additional
       # saver-specific options (e.g. quality).
       def self.save_image(image, path, saver: nil, quality: nil, **options)
-        options = options.merge(Q: quality) if quality
+        options[:Q] = quality if quality
 
         if saver
           image.public_send(:"#{saver}save", path, **options)
@@ -138,8 +138,13 @@ module ImageProcessing
           # resize on load
           image = ::Vips::Image.thumbnail(self.image, width, height: height, **options)
         else
+          # we're already calling Image#autorot when loading the image
+          no_rotate = ::Vips.at_least_libvips?(8, 8) ? { no_rotate: true } : { auto_rotate: false }
+          options   = no_rotate.merge(options)
+
           image = self.image.thumbnail_image(width, height: height, **options)
         end
+
         image = image.conv(sharpen, precision: :integer) if sharpen
         image
       end
@@ -187,15 +192,11 @@ module ImageProcessing
         # output image format. Each of these loaders and savers accept slightly
         # different options, so to allow the user to be able to specify options
         # for a specific loader/saver and have it ignored for other
-        # loaders/savers, we do a little bit of introspection and filter out
-        # options that don't exist for a particular loader or saver.
+        # loaders/savers, we do some introspection and filter out options that
+        # don't exist for a particular loader or saver.
         def select_valid_options(operation_name, options)
-          operation = ::Vips::Operation.new(operation_name)
-
-          operation_options = operation.get_construct_args
-            .select { |name, flags| (flags & ::Vips::ARGUMENT_INPUT)    != 0 }
-            .select { |name, flags| (flags & ::Vips::ARGUMENT_REQUIRED) == 0 }
-            .map(&:first).map(&:to_sym)
+          introspect        = ::Vips::Introspect.get(operation_name)
+          operation_options = introspect.optional_input.keys.map(&:to_sym)
 
           options.select { |name, value| operation_options.include?(name) }
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_processing
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.13
+        version: 2.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.13
+        version: 2.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -120,7 +120,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Set of higher-level helper methods for image processing.
+description: High-level wrapper for processing images for the web with ImageMagick
+  or libvips.
 email:
 - janko.marohnic@gmail.com
 executables: []
@@ -161,5 +162,6 @@ requirements: []
 rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
-summary: Set of higher-level helper methods for image processing.
+summary: High-level wrapper for processing images for the web with ImageMagick or
+  libvips.
 test_files: []