image_processing 1.9.3 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ab84d40ad0605bafb61684f6f684c95b9bea98ff808791b8ee7316133f3f4c8
-  data.tar.gz: aa388b9bf19c55e869d4dfce8c4c47a82621c35022ddb77bcf6d940dcc0a9edc
+  metadata.gz: 31d06cb35ac94ec0787b21dd2118626f3a3a96685efab0d7eb58d9079b1fbf2c
+  data.tar.gz: 8f840074b8fe9511e59f4f005d144e39c9aba4d0699a48c29ffc6cb2513ec645
 SHA512:
-  metadata.gz: 74a38f90d9bc088a3919b884d46ff594ece2d9f1b4ae746c94fdd65198915f927245ed3d8a220070259e87bd0f36ac945d6b1378b823535496b02ee7d554cade
-  data.tar.gz: 2e865256acd306dcbb100687be16e826a6e9381c519a81925e0226684118cc129123124927ac91f5cbeb34e07facb25958789ebaac2acebd7cdb2561623fff9f
+  metadata.gz: 1d0fb1d9363b9b85e1895d05849a5c29b2c50b8213bf9e9d6ff8c2e1391a9bf6448a4e319a4cfd747183ec741ac42d6b1b1b9629ee91d97cc4a287ec6615042c
+  data.tar.gz: dd31dd0ca012ceb35aa276c5e00efd3e9bd2c40246f9b063ea39280ea13c546373fa641518fb55ebcf0e9d00ad6020be995b8d8636c8a3939bda31c643485cef

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 1.12.2 (2022-03-01)
+
+* Prevent remote shell execution when using `#apply` with operations coming from user input (@janko)
+
+## 1.12.1 (2020-11-06)
+
+* Fix format fallback for files ending with a dot on Ruby 2.7+ (@coding-chimp)
+
+## 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)
+
 ## 1.9.3 (2019-08-11)
 
 * [vips] Use integer precision when sharpening for better quality (@metaskills)

data/README.md

@@ -29,10 +29,18 @@ how to resize and process images.
 
 1. Install ImageMagick and/or libvips:
 
-  ```sh
+In a Mac terminal:
+  
+```sh
   $ brew install imagemagick vips
   ```
 
+ In a debian/ubuntu terminal:
+
+```sh
+  $ sudo apt install imagemagick libvips
+  ```
+
 2. Add the gem to your Gemfile:
 
   ```rb
@@ -42,9 +50,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,15 +156,50 @@ 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
 
 Our test suite requires both `imagemagick` and `libvips` libraries to be installed.
 
+In a Mac terminal:
+
 ```
 $ brew install imagemagick vips
 ```
 
+In a debian/ubuntu terminal:
+```shell
+sudo apt install imagemagick libvips
+```
+
 Afterwards you can run tests with
 
 ```

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,11 +17,11 @@ 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"
   spec.add_development_dependency "minitest-hooks", ">= 1.4.2"
   spec.add_development_dependency "minispec-metadata"
-  spec.add_development_dependency "phashion" unless RUBY_ENGINE == "jruby"
+  spec.add_development_dependency "dhash-vips"
 end

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)
@@ -29,24 +34,17 @@ module ImageProcessing
     def apply(operations)
       operations.inject(self) do |builder, (name, argument)|
         if argument == true || argument == nil
-          builder.send(name)
+          builder.public_send(name)
         elsif argument.is_a?(Array)
-          builder.send(name, *argument)
+          builder.public_send(name, *argument)
+        elsif argument.is_a?(Hash)
+          builder.public_send(name, **argument)
         else
-          builder.send(name, argument)
+          builder.public_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]]
@@ -56,26 +54,42 @@ module ImageProcessing
     # 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 if file
+      options[:destination] = destination if destination
 
-      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

@@ -25,20 +25,21 @@ module ImageProcessing
       # Initializes the image on disk into a MiniMagick::Tool object. Accepts
       # additional options related to loading the image (e.g. geometry).
       # Additionally auto-orients the image to be upright.
-      def self.load_image(path_or_magick, page: nil, geometry: nil, auto_orient: true, **options)
+      def self.load_image(path_or_magick, loader: nil, page: nil, geometry: nil, auto_orient: true, **options)
         if path_or_magick.is_a?(::MiniMagick::Tool)
           magick = path_or_magick
         else
           source_path = path_or_magick
           magick = ::MiniMagick::Tool::Convert.new
 
-          Utils.apply_options(magick, options)
+          Utils.apply_options(magick, **options)
 
-          input_path  = source_path
-          input_path += "[#{page}]" if page
-          input_path += "[#{geometry}]" if geometry
+          input  = source_path
+          input  = "#{loader}:#{input}" if loader
+          input += "[#{page}]" if page
+          input += "[#{geometry}]" if geometry
 
-          magick << input_path
+          magick << input
         end
 
         magick.auto_orient if auto_orient
@@ -49,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
@@ -85,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.
@@ -160,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
@@ -191,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/pipeline.rb

@@ -37,9 +37,9 @@ module ImageProcessing
 
     # Determines the appropriate destination image format.
     def destination_format
-      format   = File.extname(destination)[1..-1] if destination
+      format   = determine_format(destination) if destination
       format ||= self.format
-      format ||= File.extname(source_path)[1..-1] if source_path
+      format ||= determine_format(source_path) if source_path
 
       format || DEFAULT_FORMAT
     end
@@ -93,5 +93,11 @@ module ImageProcessing
         @source
       end
     end
+
+    def determine_format(file_path)
+      extension = File.extname(file_path)
+
+      extension[1..-1] if extension.size > 1
+    end
   end
 end

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.9.3"
+  VERSION = "1.12.2"
 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.9.3
+  version: 1.12.2
 platform: ruby
 authors:
 - Janko Marohnić
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-11 00:00:00.000000000 Z
+date: 2022-03-01 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'
@@ -107,7 +107,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: phashion
+  name: dhash-vips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -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: []
@@ -143,7 +144,7 @@ homepage: https://github.com/janko/image_processing
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +159,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+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: []