mini_magick 3.8.0 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7708f032a0b010ff31ed437bd5f28c5bdf4b269b
-  data.tar.gz: 866153c83f7e87dfe3d1564ca32821221240d6a4
+  metadata.gz: 4f4ae6b4f7d224af6275ad37b108c978f3fd8817
+  data.tar.gz: 69d6e3f3b1289af2dd54a0309166e71fce1e2f45
 SHA512:
-  metadata.gz: f1af9965e59c483a1566299d984f1657a2fc673c398a07e2fc07fb8e3d821eb9ec4f4f6fbcbcbb2f4497714f703f410ab64bc2b02ded74cb952b019171663ef7
-  data.tar.gz: efe209dfdd7bedd32e7d44dc49cdda24e339a68e49fe4cfbfa900edb60c7a7b9c9627316df330d8ab90a6054e03f6db213c6360313d4ce26d35c925094437a11
+  metadata.gz: 248c08f2af654156c2a422bb3bb3e48a9b97087bab6dacace044bbc2175465c9a2e5de09eac05cb4110cc4efcc8a47f25424f03f6effa6df2cbb2fda85524557
+  data.tar.gz: 3c000c0861b8e66312d875b8858cdc3fe0b32c842332b70c979675acbf9b4fc62fcb4732c5c49db96240e0bf400974a90ee01e90a34b1c3d817eaf60444030fb

data/lib/mini_magick.rb

@@ -1,8 +1,3 @@
-require 'tempfile'
-require 'subexec'
-require 'stringio'
-require 'pathname'
-require 'shellwords'
 require 'mini_magick/command_builder'
 require 'mini_magick/errors'
 require 'mini_magick/image'
@@ -16,23 +11,20 @@ module MiniMagick
     attr_accessor :processor
     attr_accessor :processor_path
     attr_accessor :timeout
+    attr_accessor :debug
     attr_accessor :validate_on_create
     attr_accessor :validate_on_write
 
     ##
-    # Tries to detect the current processor based if any of the processors exist.
-    # Mogrify have precedence over gm by default.
+    # Tries to detect the current processor based if any of the processors
+    # exist. Mogrify have precedence over gm by default.
     #
     # === Returns
-    # * [String] The detected procesor
-    def choose_processor
-      self.processor = if MiniMagick::Utilities.which('mogrify')
-                         :mogrify
-                       elsif MiniMagick::Utilities.which('gm')
-                         :gm
-                       else
-                         nil
-                       end
+    # * [Symbol] The detected procesor
+    def processor
+      @processor ||= [:mogrify, :gm].detect do |processor|
+        MiniMagick::Utilities.which(processor.to_s)
+      end
     end
 
     ##
@@ -63,27 +55,21 @@ module MiniMagick
     end
 
     ##
-    # Picks the right processor if it isn't set and returns whether it's mogrify or not.
+    # Checks whether the current processory is mogrify.
     #
     # === Returns
     # * [Boolean]
     def mogrify?
-      choose_processor if processor.nil?
-
-      return processor.to_s.downcase.to_sym == :mogrify unless processor.nil?
-      false
+      processor && processor.to_sym == :mogrify
     end
 
     ##
-    # Picks the right processor if it isn't set and returns whether it's graphicsmagick or not.
+    # Checks whether the current processor is graphicsmagick.
     #
     # === Returns
     # * [Boolean]
     def gm?
-      choose_processor if processor.nil?
-
-      return processor.to_s.downcase.to_sym == :gm unless processor.nil?
-      false
+      processor && processor.to_sym == :gm
     end
   end
 end

data/lib/mini_magick/command_builder.rb

@@ -13,16 +13,12 @@ module MiniMagick
       com = "#{@tool} #{args.join(' ')}".strip
       com = "#{MiniMagick.processor} #{com}" unless MiniMagick.mogrify?
 
-      com = File.join MiniMagick.processor_path, com unless MiniMagick.processor_path.nil?
+      com = File.join MiniMagick.processor_path, com if MiniMagick.processor_path
       com.strip
     end
 
     def args
-      if !MiniMagick::Utilities.windows?
-        @args.map(&:shellescape)
-      else
-        @args.map { |arg| Utilities.windows_escape(arg) }
-      end
+      @args.map { |arg| Utilities.escape(arg) }
     end
 
     # Add each mogrify command in both underscore and dash format
@@ -75,30 +71,18 @@ module MiniMagick
     end
 
     def +(*options)
-      push(@args.pop.gsub(/^-/, '+'))
-      if options.any?
-        options.each do |o|
-          push o
-        end
-      end
+      push(@args.pop.gsub(/\A-/, '+'))
+      options.to_a.each { |option| push(option) }
     end
 
     def add_command(command, *options)
       push "-#{command}"
-      if options.any?
-        options.each do |o|
-          push o
-        end
-      end
+      options.to_a.each { |option| push(option) }
     end
 
     def add_creation_operator(command, *options)
       creation_command = command
-      if options.any?
-        options.each do |option|
-          creation_command << ":#{option}"
-        end
-      end
+      options.to_a.each { |option| creation_command << ":#{option}" }
       push creation_command
     end
 

data/lib/mini_magick/image.rb

@@ -1,35 +1,37 @@
+require 'tempfile'
+require 'subexec'
+require 'stringio'
+require 'pathname'
+
 module MiniMagick
   class Image
     # @return [String] The location of the current working file
     attr_writer :path
 
-    def path_for_windows_quote_space(path)
-      path = Pathname.new(@path).to_s
-      # For Windows, if a path contains space char, you need to quote it, otherwise you SHOULD NOT quote it.
-      # If you quote a path that does not contains space, it will not work.
-      @path.include?(' ') ? path.inspect : path
-    end
-
     def path
       run_queue if @command_queued
-      MiniMagick::Utilities.windows? ? path_for_windows_quote_space(@path) : @path
+      MiniMagick::Utilities.path(@path)
     end
 
     # Class Methods
     # -------------
     class << self
-      # This is the primary loading method used by all of the other class methods.
+      # This is the primary loading method used by all of the other class
+      # methods.
       #
-      # Use this to pass in a stream object. Must respond to Object#read(size) or be a binary string object (BLOBBBB)
+      # Use this to pass in a stream object. Must respond to Object#read(size)
+      # or be a binary string object (BLOBBBB)
       #
-      # As a change from the old API, please try and use IOStream objects.
-      # They are much, much better and more efficient!
+      # As a change from the old API, please try and use IOStream objects. They
+      # are much, much better and more efficient!
       #
-      # Probably easier to use the #open method if you want to open a file or a URL.
+      # Probably easier to use the #open method if you want to open a file or a
+      # URL.
       #
-      # @param stream [IOStream, String] Some kind of stream object that needs to be read or is a binary String blob!
-      # @param ext [String] A manual extension to use for reading the file. Not required, but if you are having issues,
-      # give this a try.
+      # @param stream [IOStream, String] Some kind of stream object that needs
+      #   to be read or is a binary String blob!
+      # @param ext [String] A manual extension to use for reading the file. Not
+      #   required, but if you are having issues, give this a try.
       # @return [Image]
       def read(stream, ext = nil)
         if stream.is_a?(String)
@@ -57,31 +59,32 @@ module MiniMagick
         create(ext) { |f| f.write(blob) }
       end
 
-      # Creates an image object from a binary string blob which contains raw pixel data (i.e. no header data).
-      #
-      # === Returns
+      # Creates an image object from a binary string blob which contains raw
+      # pixel data (i.e. no header data).
       #
-      # * [Image] The loaded image.
-      #
-      # === Parameters
-      #
-      # * [blob] <tt>String</tt> -- Binary string blob containing raw pixel data.
-      # * [columns] <tt>Integer</tt> -- Number of columns.
-      # * [rows] <tt>Integer</tt> -- Number of rows.
-      # * [depth] <tt>Integer</tt> -- Bit depth of the encoded pixel data.
-      # * [map] <tt>String</tt> -- A code for the mapping of the pixel data. Example: 'gray' or 'rgb'.
-      # * [format] <tt>String</tt> -- The file extension of the image format to be used when creating the image object.
+      # @param blob [String] Binary string blob containing raw pixel data.
+      # @param columns [Integer] Number of columns.
+      # @param rows [Integer] Number of rows.
+      # @param depth [Integer] Bit depth of the encoded pixel data.
+      # @param map [String] A code for the mapping of the pixel data. Example:
+      #   'gray' or 'rgb'.
+      # @param format [String] The file extension of the image format to be
+      #   used when creating the image object.
       # Defaults to 'png'.
+      # @return [Image] The loaded image.
       #
       def import_pixels(blob, columns, rows, depth, map, format = 'png')
         # Create an image object with the raw pixel data string:
         image = create('.dat', false) { |f| f.write(blob) }
-        # Use ImageMagick to convert the raw data file to an image file of the desired format:
+        # Use ImageMagick to convert the raw data file to an image file of the
+        # desired format:
         converted_image_path = image.path[0..-4] + format
         arguments = ['-size', "#{columns}x#{rows}", '-depth', "#{depth}", "#{map}:#{image.path}", "#{converted_image_path}"]
-        cmd = CommandBuilder.new('convert', *arguments) # Example: convert -size 256x256 -depth 16 gray:blob.dat blob.png
+        # Example: convert -size 256x256 -depth 16 gray:blob.dat blob.png
+        cmd = CommandBuilder.new('convert', *arguments)
         image.run(cmd)
-        # Update the image instance with the path of the properly formatted image, and return:
+        # Update the image instance with the path of the properly formatted
+        # image, and return:
         image.path = converted_image_path
         image
       end
@@ -90,15 +93,18 @@ module MiniMagick
       #
       # Use this if you don't want to overwrite the image file.
       #
-      # Extension is either guessed from the path or you can specify it as a second parameter.
+      # Extension is either guessed from the path or you can specify it as a
+      # second parameter.
       #
-      # If you pass in what looks like a URL, we require 'open-uri' before opening it.
+      # If you pass in what looks like a URL, we require 'open-uri' before
+      # opening it.
       #
-      # @param file_or_url [String] Either a local file path or a URL that open-uri can read
+      # @param file_or_url [String] Either a local file path or a URL that
+      #   open-uri can read
       # @param ext [String] Specify the extension you want to read it as
       # @return [Image] The loaded image
       def open(file_or_url, ext = nil)
-        file_or_url = file_or_url.to_s # Force it to be a String... Hell or high water
+        file_or_url = file_or_url.to_s # Force String... Hell or high water
         if file_or_url.include?('://')
           require 'open-uri'
           ext ||= File.extname(URI.parse(file_or_url).path)
@@ -119,43 +125,47 @@ module MiniMagick
         open(file, ext)
       end
 
-      # Used to create a new Image object data-copy. Not used to "paint" or that kind of thing.
+      # Used to create a new Image object data-copy. Not used to "paint" or
+      # that kind of thing.
       #
-      # Takes an extension in a block and can be used to build a new Image object. Used
-      # by both #open and #read to create a new object! Ensures we have a good tempfile!
+      # Takes an extension in a block and can be used to build a new Image
+      # object. Used by both #open and #read to create a new object! Ensures we
+      # have a good tempfile!
       #
       # @param ext [String] Specify the extension you want to read it as
-      # @param validate [Boolean] If false, skips validation of the created image. Defaults to true.
-      # @yield [IOStream] You can #write bits to this object to create the new Image
+      # @param validate [Boolean] If false, skips validation of the created
+      #   image. Defaults to true.
+      # @yield [IOStream] You can #write bits to this object to create the new
+      #   Image
       # @return [Image] The created image
       def create(ext = nil, validate = MiniMagick.validate_on_create, &block)
-        begin
-          tempfile = Tempfile.new(['mini_magick', ext.to_s.downcase])
-          tempfile.binmode
-          block.call(tempfile)
-          tempfile.close
-
-          image = new(tempfile.path, tempfile)
-
-          fail MiniMagick::Invalid if validate && !image.valid?
-          return image
-        ensure
-          tempfile.close if tempfile
-        end
+        tempfile = Tempfile.new(['mini_magick', ext.to_s.downcase])
+        tempfile.binmode
+        block.call(tempfile)
+        tempfile.close
+
+        image = new(tempfile.path, tempfile)
+
+        fail MiniMagick::Invalid if validate && !image.valid?
+        return image
+      ensure
+        tempfile.close if tempfile
       end
     end
 
     # Create a new MiniMagick::Image object
     #
-    # _DANGER_: The file location passed in here is the *working copy*. That is, it gets *modified*.
-    # you can either copy it yourself or use the MiniMagick::Image.open(path) method which creates a
-    # temporary file for you and protects your original!
+    # _DANGER_: The file location passed in here is the *working copy*. That
+    # is, it gets *modified*. you can either copy it yourself or use the
+    # MiniMagick::Image.open(path) method which creates a temporary file for
+    # you and protects your original!
     #
     # @param input_path [String] The location of an image file
-    # @todo Allow this to accept a block that can pass off to Image#combine_options
+    # @todo Allow this to accept a block that can pass off to
+    #   Image#combine_options
     def initialize(input_path, tempfile = nil)
       @path = input_path
-      @tempfile = tempfile # ensures that the tempfile will stick around until this image is garbage collected.
+      @tempfile = tempfile
       @info = {}
       reset_queue
     end
@@ -168,16 +178,16 @@ module MiniMagick
 
     def run_queue
       return nil unless @command_queued
-      @queue << (MiniMagick::Utilities.windows? ? path_for_windows_quote_space(@path) : @path)
+      @queue << MiniMagick::Utilities.path(@path)
       run(@queue)
       reset_queue
     end
 
     # Checks to make sure that MiniMagick can read the file and understand it.
     #
-    # This uses the 'identify' command line utility to check the file. If you are having
-    # issues with this, then please work directly with the 'identify' command and see if you
-    # can figure out what the issue is.
+    # This uses the 'identify' command line utility to check the file. If you
+    # are having issues with this, then please work directly with the
+    # 'identify' command and see if you can figure out what the issue is.
     #
     # @return [Boolean]
     def valid?
@@ -192,8 +202,10 @@ module MiniMagick
 
       @info[key]
     end
-    # A rather low-level way to interact with the "identify" command. No nice API here, just
-    # the crazy stuff you find in ImageMagick. See the examples listed!
+
+    # A rather low-level way to interact with the "identify" command. No nice
+    # API here, just the crazy stuff you find in ImageMagick. See the examples
+    # listed!
     #
     # @example
     #    image["format"]      #=> "TIFF"
@@ -206,13 +218,15 @@ module MiniMagick
     #    image["EXIF:ExifVersion"] #=> "0220" (Can read anything from Exif)
     #
     # @param format [String] A format for the "identify" command
-    # @see For reference see http://www.imagemagick.org/script/command-line-options.php#format
-    # @return [String, Numeric, Array, Time, Object] Depends on the method called! Defaults to String for unknown commands
+    # @see http://www.imagemagick.org/script/command-line-options.php#format
+    # @return [String, Numeric, Array, Time, Object] Depends on the method
+    #   called! Defaults to String for unknown commands
     def [](value)
       retrieved = info(value)
       return retrieved unless retrieved.nil?
 
-      # Why do I go to the trouble of putting in newlines? Because otherwise animated gifs screw everything up
+      # Why do I go to the trouble of putting in newlines? Because otherwise
+      # animated gifs screw everything up
       retrieved = case value.to_s
                   when 'colorspace'
                     run_command('identify', '-format', '%r\n', path).split("\n")[0].strip
@@ -226,7 +240,7 @@ module MiniMagick
                     @info[:width] = width_height[0]
                     @info[:height] = width_height[1]
                     @info[:dimensions] = width_height
-                    nil
+                    @info[value.to_sym]
                   when 'size'
                     File.size(path) # Do this because calling identify -format "%b" on an animated gif fails!
                   when 'original_at'
@@ -247,33 +261,38 @@ module MiniMagick
       @info[value]
     end
 
-    # Sends raw commands to imagemagick's `mogrify` command. The image path is automatically appended to the command.
+    # Sends raw commands to imagemagick's `mogrify` command. The image path is
+    # automatically appended to the command.
     #
-    # Remember, we are always acting on this instance of the Image when messing with this.
+    # Remember, we are always acting on this instance of the Image when messing
+    # with this.
     #
-    # @return [String] Whatever the result from the command line is. May not be terribly useful.
+    # @return [String] Whatever the result from the command line is. May not be
+    #   terribly useful.
     def <<(*args)
       run_command('mogrify', *args << path)
     end
 
-    # This is used to change the format of the image. That is, from "tiff to jpg" or something like that.
-    # Once you run it, the instance is pointing to a new file with a new extension!
+    # This is used to change the format of the image. That is, from "tiff to
+    # jpg" or something like that. Once you run it, the instance is pointing to
+    # a new file with a new extension!
     #
-    # *DANGER*: This renames the file that the instance is pointing to. So, if you manually opened the
-    # file with Image.new(file_path)... Then that file is DELETED! If you used Image.open(file) then
-    # you are OK. The original file will still be there. But, any changes to it might not be...
+    # *DANGER*: This renames the file that the instance is pointing to. So, if
+    # you manually opened the file with Image.new(file_path)... Then that file
+    # is DELETED! If you used Image.open(file) then you are OK. The original
+    # file will still be there. But, any changes to it might not be...
     #
-    # Formatting an animation into a non-animated type will result in ImageMagick creating multiple
-    # pages (starting with 0).  You can choose which page you want to manipulate.  We default to the
-    # first page.
+    # Formatting an animation into a non-animated type will result in
+    # ImageMagick creating multiple pages (starting with 0).  You can choose
+    # which page you want to manipulate.  We default to the first page.
     #
     # If you would like to convert between animated formats, pass nil as your
     # page and ImageMagick will copy all of the pages.
     #
-    # @param format [String] The target format... Like 'jpg', 'gif', 'tiff', etc.
-    # @param page [Integer] If this is an animated gif, say which 'page' you want
-    # with an integer. Default 0 will convert only the first page; 'nil' will
-    # convert all pages.
+    # @param format [String] The target format... Like 'jpg', 'gif', 'tiff' etc.
+    # @param page [Integer] If this is an animated gif, say which 'page' you
+    #   want with an integer. Default 0 will convert only the first page; 'nil'
+    #   will convert all pages.
     # @return [nil]
     def format(format, page = 0)
       run_queue if @command_queued
@@ -300,12 +319,14 @@ module MiniMagick
       run_command('mogrify', '-quality', '100', "#{path}[0]")
     end
 
-    # Writes the temporary file out to either a file location (by passing in a String) or by
-    # passing in a Stream that you can #write(chunk) to repeatedly
+    # Writes the temporary file out to either a file location (by passing in a
+    # String) or by passing in a Stream that you can #write(chunk) to
+    # repeatedly
     #
-    # @param output_to [IOStream, String] Some kind of stream object that needs to be read or a file path as a String
-    # @return [IOStream, Boolean] If you pass in a file location [String] then you get a success boolean. If its a stream, you get it back.
-    # Writes the temporary image that we are using for processing to the output path
+    # @param output_to [IOStream, String] Some kind of stream object that needs
+    #   to be read or a file path as a String
+    # @return [IOStream, Boolean] If you pass in a file location [String] then
+    #   you get a success boolean. If its a stream, you get it back.
     def write(output_to)
       run_queue if @command_queued
 
@@ -313,7 +334,7 @@ module MiniMagick
         FileUtils.copy_file path, output_to
         if MiniMagick.validate_on_write
           run_command(
-            'identify', MiniMagick::Utilities.windows? ? path_for_windows_quote_space(output_to.to_s) : output_to.to_s
+            'identify', MiniMagick::Utilities.path(output_to.to_s)
           ) # Verify that we have a good image
         end
       else # stream
@@ -344,14 +365,17 @@ module MiniMagick
       'image/' + format.to_s.downcase
     end
 
-    # If an unknown method is called then it is sent through the mogrify program
-    # Look here to find all the commands (http://www.imagemagick.org/script/mogrify.php)
+    # If an unknown method is called then it is sent through the mogrify
+    # program.
+    #
+    # @see http://www.imagemagick.org/script/mogrify.php
     def method_missing(symbol, *args)
       @queue.send(symbol, *args)
       @command_queued = true
     end
 
-    # You can use multiple commands together using this method. Very easy to use!
+    # You can use multiple commands together using this method. Very easy to
+    # use!
     #
     # @example
     #   image.combine_options do |c|
@@ -393,7 +417,7 @@ module MiniMagick
 
       if command == 'identify'
         args.unshift '-ping'  # -ping "efficiently determine image characteristics."
-        args.unshift '-quiet' if MiniMagick.mogrify? # graphicsmagick has no -quiet option.
+        args.unshift '-quiet' if MiniMagick.mogrify? && !MiniMagick.debug # graphicsmagick has no -quiet option.
       end
 
       run(CommandBuilder.new(command, *args))
@@ -423,20 +447,15 @@ module MiniMagick
 
     def destroy!
       return if @tempfile.nil?
-      File.unlink(path) if File.exist?(path)
+      File.unlink(@path) if File.exist?(@path)
       @tempfile = nil
     end
 
     private
 
     # Sometimes we get back a list of character values
-    def read_character_data(list_of_characters)
-      chars = list_of_characters.gsub(' ', '').split(',')
-      result = ''
-      chars.each do |val|
-        result << ('%c' % val.to_i)
-      end
-      result
+    def read_character_data(string)
+      string.scan(/\d+/).map(&:to_i).map(&:chr).join
     end
   end
 end