image_processing 1.2.0 → 1.12.2

data/lib/image_processing/vips.rb

@@ -7,6 +7,7 @@ module ImageProcessing
   module Vips
     extend Chainable
 
+    # Returns whether the given image file is processable.
     def self.valid_image?(file)
       ::Vips::Image.new_from_file(file.path, access: :sequential).avg
       true
@@ -15,107 +16,190 @@ module ImageProcessing
     end
 
     class Processor < ImageProcessing::Processor
-      IMAGE_CLASS  = ::Vips::Image
-      # default sharpening mask that provides a fast and mild sharpen
+      accumulator :image, ::Vips::Image
+
+      # Default sharpening mask that provides a fast and mild sharpen.
       SHARPEN_MASK = ::Vips::Image.new_from_array [[-1, -1, -1],
                                                    [-1, 32, -1],
                                                    [-1, -1, -1]], 24
 
-      def apply_operation(name, image, *args)
-        result = super
-        result.is_a?(::Vips::Image) ? result : image
+
+      # Loads the image on disk into a Vips::Image object. Accepts additional
+      # loader-specific options (e.g. interlacing). Afterwards auto-rotates the
+      # image to be upright.
+      def self.load_image(path_or_image, loader: nil, autorot: true, **options)
+        if path_or_image.is_a?(::Vips::Image)
+          image = path_or_image
+        else
+          path = path_or_image
+
+          if loader
+            image = ::Vips::Image.public_send(:"#{loader}load", path, **options)
+          else
+            options = Utils.select_valid_loader_options(path, options)
+            image = ::Vips::Image.new_from_file(path, **options)
+          end
+        end
+
+        image = image.autorot if autorot && !options.key?(:autorotate)
+        image
+      end
+
+      # See #thumbnail.
+      def self.supports_resize_on_load?
+        true
+      end
+
+      # Writes the Vips::Image object to disk. This starts the processing
+      # 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[:Q] = quality if quality
+
+        if saver
+          image.public_send(:"#{saver}save", path, **options)
+        else
+          options = Utils.select_valid_saver_options(path, options)
+          image.write_to_file(path, **options)
+        end
       end
 
-      def resize_to_limit(image, width, height, **options)
+      # Resizes the image to not be larger than the specified dimensions.
+      def resize_to_limit(width, height, **options)
         width, height = default_dimensions(width, height)
-        thumbnail(image, width, height, size: :down, **options)
+        thumbnail(width, height, size: :down, **options)
       end
 
-      def resize_to_fit(image, width, height, **options)
+      # Resizes the image to fit within the specified dimensions.
+      def resize_to_fit(width, height, **options)
         width, height = default_dimensions(width, height)
-        thumbnail(image, width, height, **options)
+        thumbnail(width, height, **options)
       end
 
-      def resize_to_fill(image, width, height, **options)
-        thumbnail(image, width, height, crop: :centre, **options)
+      # Resizes the image to fill the specified dimensions, applying any
+      # necessary cropping.
+      def resize_to_fill(width, height, **options)
+        thumbnail(width, height, crop: :centre, **options)
       end
 
-      def resize_and_pad(image, width, height, gravity: "centre", extend: nil, background: nil, alpha: nil, **options)
-        embed_options = { extend: extend, background: background }
-        embed_options.reject! { |name, value| value.nil? }
+      # Resizes the image to fit within the specified dimensions and fills
+      # the remaining area with the specified background color.
+      def resize_and_pad(width, height, gravity: "centre", extend: nil, background: nil, alpha: nil, **options)
+        image = thumbnail(width, height, **options)
+        image = image.add_alpha if alpha && !image.has_alpha?
+        image.gravity(gravity, width, height, extend: extend, background: background)
+      end
 
-        image = thumbnail(image, width, height, **options)
-        image = add_alpha(image) if alpha && !has_alpha?(image)
-        image.gravity(gravity, width, height, **embed_options)
+      # Rotates the image by an arbitrary angle.
+      def rotate(degrees, **options)
+        image.similarity(angle: degrees, **options)
       end
 
-      def load_image(path_or_image, autorot: true, **options)
-        if path_or_image.is_a?(::Vips::Image)
-          image = path_or_image
-        else
-          source_path = path_or_image
-          options     = select_valid_loader_options(source_path, options)
+      # Overlays the specified image over the current one. Supports specifying
+      # composite mode, direction or offset of the overlay image.
+      def composite(overlay, _mode = nil, mode: "over", gravity: "north-west", offset: nil, **options)
+        # if the mode argument is given, call the original Vips::Image#composite
+        if _mode
+          overlay = [overlay] unless overlay.is_a?(Array)
+          overlay = overlay.map { |object| convert_to_image(object, "overlay") }
 
-          image = ::Vips::Image.new_from_file(source_path, **options)
+          return image.composite(overlay, _mode, **options)
         end
 
-        image = image.autorot if autorot && !options.key?(:autorotate)
-        image
-      end
+        overlay = convert_to_image(overlay, "overlay")
+        # add alpha channel so that #gravity can use a transparent background
+        overlay = overlay.add_alpha unless overlay.has_alpha?
+
+        # apply offset with correct gravity and make remainder transparent
+        if offset
+          opposite_gravity = gravity.to_s.gsub(/\w+/, "north"=>"south", "south"=>"north", "east"=>"west", "west"=>"east")
+          overlay = overlay.gravity(opposite_gravity, overlay.width + offset.first, overlay.height + offset.last)
+        end
 
-      def save_image(image, destination_path, quality: nil, **options)
-        options = options.merge(Q: quality) if quality
-        options = select_valid_saver_options(destination_path, options)
+        # create image-sized transparent background and apply specified gravity
+        overlay = overlay.gravity(gravity, image.width, image.height)
 
-        image.write_to_file(destination_path, **options)
+        # apply the composition
+        image.composite(overlay, mode, **options)
       end
 
+      # make metadata setter methods chainable
+      def set(*args)       image.tap { |img| img.set(*args) }       end
+      def set_type(*args)  image.tap { |img| img.set_type(*args) }  end
+      def set_value(*args) image.tap { |img| img.set_value(*args) } end
+      def remove(*args)    image.tap { |img| img.remove(*args) }    end
+
       private
 
-      def thumbnail(image, width, height, sharpen: SHARPEN_MASK, **options)
-        image = image.thumbnail_image(width, height: height, **options)
-        image = image.conv(sharpen) if sharpen
-        image
-      end
+      # Resizes the image according to the specified parameters, and sharpens
+      # the resulting thumbnail.
+      def thumbnail(width, height, sharpen: SHARPEN_MASK, **options)
+        if self.image.is_a?(String) # path
+          # 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)
 
-      # Port of libvips' vips_addalpha().
-      def add_alpha(image)
-        max_alpha = (image.interpretation == :grey16 || image.interpretation == :rgb16) ? 65535 : 255
-        image.bandjoin(max_alpha)
-      end
+          image = self.image.thumbnail_image(width, height: height, **options)
+        end
 
-      # Port of libvips' vips_hasalpha().
-      def has_alpha?(image)
-        image.bands == 2 ||
-        (image.bands == 4 && image.interpretation != :cmyk) ||
-        image.bands > 4
+        image = image.conv(sharpen, precision: :integer) if sharpen
+        image
       end
 
+      # Hack to allow omitting one dimension.
       def default_dimensions(width, height)
         raise Error, "either width or height must be specified" unless width || height
 
         [width || ::Vips::MAX_COORD, height || ::Vips::MAX_COORD]
       end
 
-      def select_valid_loader_options(source_path, options)
-        loader = ::Vips.vips_foreign_find_load(source_path)
-        loader ? select_valid_options(loader, options) : options
-      end
+      # Converts the image on disk in various forms into a Vips::Image object.
+      def convert_to_image(object, name)
+        return object if object.is_a?(::Vips::Image)
+
+        if object.is_a?(String)
+          path = object
+        elsif object.respond_to?(:to_path)
+          path = object.to_path
+        elsif object.respond_to?(:path)
+          path = object.path
+        else
+          raise ArgumentError, "#{name} must be a Vips::Image, String, Pathname, or respond to #path"
+        end
 
-      def select_valid_saver_options(destination_path, options)
-        saver = ::Vips.vips_foreign_find_save(destination_path)
-        saver ? select_valid_options(saver, options) : options
+        ::Vips::Image.new_from_file(path)
       end
 
-      def select_valid_options(operation_name, options)
-        operation = ::Vips::Operation.new(operation_name)
+      module Utils
+        module_function
 
-        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)
+        # libvips uses various loaders depending on the input format.
+        def select_valid_loader_options(source_path, options)
+          loader = ::Vips.vips_foreign_find_load(source_path)
+          loader ? select_valid_options(loader, options) : options
+        end
 
-        options.select { |name, value| operation_options.include?(name) }
+        # Filters out unknown options for saving images.
+        def select_valid_saver_options(destination_path, options)
+          saver = ::Vips.vips_foreign_find_save(destination_path)
+          saver ? select_valid_options(saver, options) : options
+        end
+
+        # libvips uses various loaders and savers depending on the input and
+        # 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 some introspection and filter out options that
+        # don't exist for a particular loader or saver.
+        def select_valid_options(operation_name, options)
+          introspect        = ::Vips::Introspect.get(operation_name)
+          operation_options = introspect.optional_input.keys.map(&:to_sym)
+
+          options.select { |name, value| operation_options.include?(name) }
+        end
       end
     end
   end

metadata

@@ -1,36 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: image_processing
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.12.2
 platform: ruby
 authors:
 - Janko Marohnić
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.5
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.5
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -40,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -101,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:
     - - ">="
@@ -114,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: []
@@ -133,11 +140,11 @@ files:
 - lib/image_processing/processor.rb
 - lib/image_processing/version.rb
 - lib/image_processing/vips.rb
-homepage: https://github.com/janko-m/image_processing
+homepage: https://github.com/janko/image_processing
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,16 +152,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-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: []