mini_magick 4.11.0 → 5.3.0

data/lib/mini_magick/shell.rb

@@ -1,5 +1,4 @@
-require "timeout"
-require "benchmark"
+require "open3"
 
 module MiniMagick
   ##
@@ -10,69 +9,42 @@ module MiniMagick
   #
   class Shell
 
-    def run(command, options = {})
-      stdout, stderr, status = execute(command, stdin: options[:stdin])
+    def run(command, errors: MiniMagick.errors, warnings: MiniMagick.warnings, **options)
+      stdout, stderr, status = execute(command, **options)
 
-      if status != 0 && options.fetch(:whiny, MiniMagick.whiny)
-        fail MiniMagick::Error, "`#{command.join(" ")}` failed with error:\n#{stderr}"
+      if status != 0
+        if stderr.include?("time limit exceeded")
+          fail MiniMagick::TimeoutError, "`#{command.join(" ")}` has timed out"
+        elsif errors
+          fail MiniMagick::Error, "`#{command.join(" ")}` failed with status: #{status.inspect} and error:\n#{stderr}"
+        end
       end
 
-      $stderr.print(stderr) unless options[:stderr] == false
+      $stderr.print(stderr) if warnings
 
       [stdout, stderr, status]
     end
 
-    def execute(command, options = {})
-      stdout, stderr, status =
-        log(command.join(" ")) do
-          send("execute_#{MiniMagick.shell_api.gsub("-", "_")}", command, options)
-        end
+    def execute(command, stdin: "", timeout: MiniMagick.timeout)
+      env = MiniMagick.restricted_env ? ENV.to_h.slice("HOME", "PATH", "LANG") : {} # Using #to_h for Ruby 2.5 compatibility.
+      env.merge!(MiniMagick.cli_env)
+      env["MAGICK_TIME_LIMIT"] = timeout.to_s if timeout
+
+      stdout, stderr, status = log(command.join(" ")) do
+        Open3.capture3(env, *command, stdin_data: stdin, unsetenv_others: MiniMagick.restricted_env)
+      end
 
-      [stdout, stderr, status.exitstatus]
+      [stdout, stderr, status&.exitstatus]
     rescue Errno::ENOENT, IOError
       ["", "executable not found: \"#{command.first}\"", 127]
     end
 
     private
 
-    def execute_open3(command, options = {})
-      require "open3"
-
-      # We would ideally use Open3.capture3, but it wouldn't allow us to
-      # terminate the command after timing out.
-      Open3.popen3(*command) do |in_w, out_r, err_r, thread|
-        [in_w, out_r, err_r].each(&:binmode)
-        stdout_reader = Thread.new { out_r.read }
-        stderr_reader = Thread.new { err_r.read }
-        begin
-          in_w.write options[:stdin].to_s
-        rescue Errno::EPIPE
-        end
-        in_w.close
-
-        begin
-          Timeout.timeout(MiniMagick.timeout) { thread.join }
-        rescue Timeout::Error
-          Process.kill("TERM", thread.pid) rescue nil
-          Process.waitpid(thread.pid)      rescue nil
-          raise Timeout::Error, "MiniMagick command timed out: #{command}"
-        end
-
-        [stdout_reader.value, stderr_reader.value, thread.value]
-      end
-    end
-
-    def execute_posix_spawn(command, options = {})
-      require "posix-spawn"
-      child = POSIX::Spawn::Child.new(*command, input: options[:stdin].to_s, timeout: MiniMagick.timeout)
-      [child.out, child.err, child.status]
-    rescue POSIX::Spawn::TimeoutExceeded
-      raise Timeout::Error, "MiniMagick command timed out: #{command}"
-    end
-
     def log(command, &block)
-      value = nil
-      duration = Benchmark.realtime { value = block.call }
+      time_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      value = block.call
+      duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - time_start
       MiniMagick.logger.debug "[%.2fs] %s" % [duration, command]
       value
     end

data/lib/mini_magick/tool.rb

@@ -2,15 +2,13 @@ require "mini_magick/shell"
 
 module MiniMagick
   ##
-  # Abstract class that wraps command-line tools. It shouldn't be used directly,
-  # but through one of its subclasses (e.g. {MiniMagick::Tool::Mogrify}). Use
-  # this class if you want to be closer to the metal and execute ImageMagick
-  # commands directly, but still with a nice Ruby interface.
+  # Class that wraps command-line tools directly, as opposed MiniMagick::Image
+  # which is more high-level.
   #
   # @example
-  #   MiniMagick::Tool::Mogrify.new do |builder|
-  #     builder.resize "500x500"
-  #     builder << "path/to/image.jpg"
+  #   MiniMagick.mogrify do |mogrify|
+  #     mogrify.resize "500x500"
+  #     mogrify << "path/to/image.jpg"
   #   end
   #
   class Tool
@@ -23,15 +21,14 @@ module MiniMagick
     # executes the command in the end.
     #
     # @example
-    #   version = MiniMagick::Tool::Identify.new { |b| b.version }
-    #   puts version
+    #   puts MiniMagick.identify(&:version)
     #
     # @return [MiniMagick::Tool, String] If no block is given, returns an
     #   instance of the tool, if block is given, returns the output of the
     #   command.
     #
-    def self.new(*args)
-      instance = super(*args)
+    def self.new(name, **options)
+      instance = super
 
       if block_given?
         yield instance
@@ -46,31 +43,31 @@ module MiniMagick
 
     # @param name [String]
     # @param options [Hash]
-    # @option options [Boolean] :whiny Whether to raise errors on non-zero
+    # @option options [Boolean] :errors Whether to raise errors on non-zero
     #   exit codes.
+    # @option options [Boolean] :warnings Whether to print warnings to stderrr.
+    # @option options [String] :stdin Content to send to standard input stream.
     # @example
-    #   MiniMagick::Tool::Identify.new(whiny: false) do |identify|
+    #   MiniMagick.identify(errors: false) do |identify|
     #     identify.help # returns exit status 1, which would otherwise throw an error
     #   end
-    def initialize(name, options = {})
-      warn "MiniMagick::Tool.new(false) is deprecated and will be removed in MiniMagick 5, use MiniMagick::Tool.new(whiny: false) instead." if !options.is_a?(Hash)
-
-      @name  = name
-      @args  = []
-      @whiny = options.is_a?(Hash) ? options.fetch(:whiny, MiniMagick.whiny) : options
+    def initialize(name, **options)
+      @name = name
+      @args = []
+      @options = options
     end
 
     ##
     # Executes the command that has been built up.
     #
     # @example
-    #   mogrify = MiniMagick::Tool::Mogrify.new
+    #   mogrify = MiniMagick.mogrify
     #   mogrify.resize("500x500")
     #   mogrify << "path/to/image.jpg"
     #   mogrify.call # executes `mogrify -resize 500x500 path/to/image.jpg`
     #
     # @example
-    #   mogrify = MiniMagick::Tool::Mogrify.new
+    #   mogrify = MiniMagick.mogrify
     #   # build the command
     #   mogrify.call do |stdout, stderr, status|
     #     # ...
@@ -80,16 +77,12 @@ module MiniMagick
     #
     # @return [String] Returns the output of the command
     #
-    def call(*args)
-      options = args[-1].is_a?(Hash) ? args.pop : {}
-      warn "Passing whiny to MiniMagick::Tool#call is deprecated and will be removed in MiniMagick 5, use MiniMagick::Tool.new(whiny: false) instead." if args.any?
-      whiny = args.fetch(0, @whiny)
-
-      options[:whiny] = whiny
-      options[:stderr] = false if block_given?
+    def call(**options)
+      options = @options.merge(options)
+      options[:warnings] = false if block_given?
 
       shell = MiniMagick::Shell.new
-      stdout, stderr, status = shell.run(command, options)
+      stdout, stderr, status = shell.run(command, **options)
       yield stdout, stderr, status if block_given?
 
       stdout.chomp("\n")
@@ -101,7 +94,7 @@ module MiniMagick
     # @return [Array<String>]
     #
     # @example
-    #   mogrify = MiniMagick::Tool::Mogrify.new
+    #   mogrify = MiniMagick.mogrify
     #   mogrify.resize "500x500"
     #   mogrify.contrast
     #   mogrify.command #=> ["mogrify", "-resize", "500x500", "-contrast"]
@@ -112,31 +105,26 @@ module MiniMagick
 
     ##
     # The executable used for this tool. Respects
-    # {MiniMagick::Configuration#cli}, {MiniMagick::Configuration#cli_path},
-    # and {MiniMagick::Configuration#cli_prefix}.
+    # {MiniMagick::Configuration#cli_prefix}.
     #
     # @return [Array<String>]
     #
     # @example
-    #   MiniMagick.configure { |config| config.cli = :graphicsmagick }
-    #   identify = MiniMagick::Tool::Identify.new
-    #   identify.executable #=> ["gm", "identify"]
+    #   identify = MiniMagick.identify
+    #   identify.executable #=> ["magick", "identify"]
     #
     # @example
     #   MiniMagick.configure do |config|
-    #     config.cli = :graphicsmagick
     #     config.cli_prefix = ['firejail', '--force']
     #   end
-    #   identify = MiniMagick::Tool::Identify.new
-    #   identify.executable #=> ["firejail", "--force", "gm", "identify"]
+    #   identify = MiniMagick.identify
+    #   identify.executable #=> ["firejail", "--force", "magick", "identify"]
     #
     def executable
-      exe = [name]
-      exe.unshift "magick" if MiniMagick.imagemagick7? && name != "magick"
-      exe.unshift "gm" if MiniMagick.graphicsmagick?
-      exe.unshift File.join(MiniMagick.cli_path, exe.shift) if MiniMagick.cli_path
-      Array(MiniMagick.cli_prefix).reverse_each { |p| exe.unshift p } if MiniMagick.cli_prefix
-      exe
+      exe = Array(MiniMagick.cli_prefix)
+      exe << "magick" if MiniMagick.imagemagick7? && name != "magick"
+      exe << "gm" if MiniMagick.graphicsmagick
+      exe << name
     end
 
     ##
@@ -163,7 +151,7 @@ module MiniMagick
     # Changes the last operator to its "plus" form.
     #
     # @example
-    #   MiniMagick::Tool::Mogrify.new do |mogrify|
+    #   MiniMagick.mogrify do |mogrify|
     #     mogrify.antialias.+
     #     mogrify.distort.+("Perspective", "0,0,4,5 89,0,45,46")
     #   end
@@ -181,7 +169,7 @@ module MiniMagick
     # Create an ImageMagick stack in the command (surround.
     #
     # @example
-    #   MiniMagick::Tool::Convert.new do |convert|
+    #   MiniMagick.convert do |convert|
     #     convert << "wand.gif"
     #     convert.stack do |stack|
     #       stack << "wand.gif"
@@ -208,7 +196,7 @@ module MiniMagick
     # Adds ImageMagick's pseudo-filename `-` for standard input.
     #
     # @example
-    #   identify = MiniMagick::Tool::Identify.new
+    #   identify = MiniMagick.identify
     #   identify.stdin
     #   identify.call(stdin: image_content)
     #   # executes `identify -` with the given standard input
@@ -221,7 +209,7 @@ module MiniMagick
     # Adds ImageMagick's pseudo-filename `-` for standard output.
     #
     # @example
-    #   content = MiniMagick::Tool::Convert.new do |convert|
+    #   content = MiniMagick.convert do |convert|
     #     convert << "input.jpg"
     #     convert.auto_orient
     #     convert.stdout
@@ -241,7 +229,7 @@ module MiniMagick
     #   mogrify.command.join(" ") #=> "mogrify canvas:khaki"
     #
     CREATION_OPERATORS.each do |operator|
-      define_method(operator.gsub('-', '_')) do |value = nil|
+      define_method(operator.tr('-', '_')) do |value = nil|
         self << "#{operator}:#{value}"
         self
       end
@@ -273,35 +261,14 @@ module MiniMagick
       self
     end
 
-    def self.option_methods
-      @option_methods ||= (
-        tool = new(whiny: false)
-        tool << "-help"
-        help_page = tool.call(stderr: false)
-
-        cli_options = help_page.scan(/^\s+-[a-z\-]+/).map(&:strip)
-        if tool.name == "mogrify" && MiniMagick.graphicsmagick?
-          # These options were undocumented before 2015-06-14 (see gm bug 302)
-          cli_options |= %w[-box -convolve -gravity -linewidth -mattecolor -render -shave]
+    # deprecated tool subclasses
+    %w[animate compare composite conjure convert display identify import magick mogrify montage stream].each do |tool|
+      const_set(tool.capitalize, Class.new(self) {
+        define_method(:initialize) do |*args|
+          super(tool, *args)
         end
-
-        cli_options.map { |o| o[1..-1].tr('-','_') }
-      )
+      })
+      deprecate_constant(tool.capitalize)
     end
-
   end
 end
-
-require "mini_magick/tool/animate"
-require "mini_magick/tool/compare"
-require "mini_magick/tool/composite"
-require "mini_magick/tool/conjure"
-require "mini_magick/tool/convert"
-require "mini_magick/tool/display"
-require "mini_magick/tool/identify"
-require "mini_magick/tool/import"
-require "mini_magick/tool/magick"
-require "mini_magick/tool/mogrify"
-require "mini_magick/tool/mogrify_restricted"
-require "mini_magick/tool/montage"
-require "mini_magick/tool/stream"

data/lib/mini_magick/utilities.rb

@@ -24,12 +24,10 @@ module MiniMagick
     end
 
     def tempfile(extension)
-      Tempfile.new(["mini_magick", extension]).tap do |tempfile|
-        tempfile.binmode
-        yield tempfile if block_given?
-        tempfile.close
-      end
+      tempfile = Tempfile.new(["mini_magick", extension], MiniMagick.tmpdir, binmode: true)
+      yield tempfile if block_given?
+      tempfile.close
+      tempfile
     end
-
   end
 end

data/lib/mini_magick/version.rb

@@ -7,8 +7,8 @@ module MiniMagick
   end
 
   module VERSION
-    MAJOR = 4
-    MINOR = 11
+    MAJOR = 5
+    MINOR = 3
     TINY  = 0
     PRE   = nil
 

data/lib/mini_magick.rb

@@ -1,64 +1,40 @@
 require 'mini_magick/version'
 require 'mini_magick/configuration'
+require 'mini_magick/utilities'
+require 'mini_magick/tool'
+require 'mini_magick/image'
 
 module MiniMagick
 
-  extend MiniMagick::Configuration
-
-  ##
-  # You might want to execute only certain blocks of processing with a
-  # different CLI, because for example that CLI does that particular thing
-  # faster. After the block CLI resets to its previous value.
-  #
-  # @example
-  #   MiniMagick.with_cli :graphicsmagick do
-  #     # operations that are better done with GraphicsMagick
-  #   end
-  def self.with_cli(cli)
-    old_cli = self.cli
-    self.cli = cli
-    yield
-  ensure
-    self.cli = old_cli
-  end
+  Error = Class.new(RuntimeError)
+  Invalid = Class.new(StandardError)
+  TimeoutError = Class.new(Error)
 
-  ##
-  # Checks whether the CLI used is ImageMagick.
-  #
-  # @return [Boolean]
-  def self.imagemagick?
-    cli == :imagemagick
-  end
+  extend MiniMagick::Configuration
 
   ##
-  # Checks whether the CLI used is ImageMagick 7.
+  # Checks whether ImageMagick 7 is installed.
   #
   # @return [Boolean]
   def self.imagemagick7?
-    cli == :imagemagick7
+    return false if graphicsmagick
+    return @imagemagick7 if defined?(@imagemagick7)
+    @imagemagick7 = !!MiniMagick::Utilities.which("magick")
   end
 
-  ##
-  # Checks whether the CLI used is GraphicsMagick.
-  #
-  # @return [Boolean]
-  def self.graphicsmagick?
-    cli == :graphicsmagick
+  %w[animate compare composite conjure convert display identify import mogrify montage stream].each do |tool|
+    define_singleton_method(tool) do |**options, &block|
+      name = imagemagick7? && tool == "convert" ? "magick" : tool
+      MiniMagick::Tool.new(name, **options, &block)
+    end
   end
 
   ##
-  # Returns ImageMagick's/GraphicsMagick's version.
+  # Returns ImageMagick version.
   #
   # @return [String]
   def self.cli_version
-    output = MiniMagick::Tool::Identify.new(&:version)
+    output = MiniMagick.identify(&:version)
     output[/\d+\.\d+\.\d+(-\d+)?/]
   end
-
-  class Error < RuntimeError; end
-  class Invalid < StandardError; end
-
 end
-
-require 'mini_magick/tool'
-require 'mini_magick/image'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_magick
 version: !ruby/object:Gem::Version
-  version: 4.11.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Corey Johnson
@@ -10,61 +10,18 @@ authors:
 - James Miller
 - Thiago Fernandes Massa
 - Janko Marohnić
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 1980-01-02 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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-- !ruby/object:Gem::Dependency
-  name: guard
-  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: guard-rspec
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -72,7 +29,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: posix-spawn
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,20 +43,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Manipulate images with minimal use of memory via ImageMagick / GraphicsMagick
+        version: '3.5'
+description: Manipulate images with minimal use of memory via ImageMagick
 email:
 - probablycorey@gmail.com
 - hcatlin@gmail.com
@@ -112,34 +69,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
-- lib/mini_gmagick.rb
 - lib/mini_magick.rb
 - lib/mini_magick/configuration.rb
 - lib/mini_magick/image.rb
 - lib/mini_magick/image/info.rb
 - lib/mini_magick/shell.rb
 - lib/mini_magick/tool.rb
-- lib/mini_magick/tool/animate.rb
-- lib/mini_magick/tool/compare.rb
-- lib/mini_magick/tool/composite.rb
-- lib/mini_magick/tool/conjure.rb
-- lib/mini_magick/tool/convert.rb
-- lib/mini_magick/tool/display.rb
-- lib/mini_magick/tool/identify.rb
-- lib/mini_magick/tool/import.rb
-- lib/mini_magick/tool/magick.rb
-- lib/mini_magick/tool/mogrify.rb
-- lib/mini_magick/tool/mogrify_restricted.rb
-- lib/mini_magick/tool/montage.rb
-- lib/mini_magick/tool/stream.rb
 - lib/mini_magick/utilities.rb
 - lib/mini_magick/version.rb
 homepage: https://github.com/minimagick/minimagick
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/minimagick/minimagick/releases
 rdoc_options: []
 require_paths:
 - lib
@@ -147,16 +91,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- You must have ImageMagick or GraphicsMagick installed
-rubygems_version: 3.1.4
-signing_key: 
+- You must have ImageMagick installed
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Manipulate images with minimal use of memory via ImageMagick / GraphicsMagick
+summary: Manipulate images with minimal use of memory via ImageMagick
 test_files: []

data/lib/mini_gmagick.rb

@@ -1,3 +0,0 @@
-require 'mini_magick'
-
-MiniMagick.processor = :gm

data/lib/mini_magick/tool/animate.rb

@@ -1,14 +0,0 @@
-module MiniMagick
-  class Tool
-    ##
-    # @see http://www.imagemagick.org/script/animate.php
-    #
-    class Animate < MiniMagick::Tool
-
-      def initialize(*args)
-        super("animate", *args)
-      end
-
-    end
-  end
-end

data/lib/mini_magick/tool/compare.rb

@@ -1,14 +0,0 @@
-module MiniMagick
-  class Tool
-    ##
-    # @see http://www.imagemagick.org/script/compare.php
-    #
-    class Compare < MiniMagick::Tool
-
-      def initialize(*args)
-        super("compare", *args)
-      end
-
-    end
-  end
-end

data/lib/mini_magick/tool/composite.rb

@@ -1,14 +0,0 @@
-module MiniMagick
-  class Tool
-    ##
-    # @see http://www.imagemagick.org/script/composite.php
-    #
-    class Composite < MiniMagick::Tool
-
-      def initialize(*args)
-        super("composite", *args)
-      end
-
-    end
-  end
-end

data/lib/mini_magick/tool/conjure.rb

@@ -1,14 +0,0 @@
-module MiniMagick
-  class Tool
-    ##
-    # @see http://www.imagemagick.org/script/conjure.php
-    #
-    class Conjure < MiniMagick::Tool
-
-      def initialize(*args)
-        super("conjure", *args)
-      end
-
-    end
-  end
-end