mini_magick 3.0 → 3.2.1

data/README.rdoc

@@ -87,6 +87,14 @@ For more on the format command see
 http://www.imagemagick.org/script/command-line-options.php#format
 
 
+== Using GraphicsMagick
+
+Simply set 
+
+  MiniMagick.processor = :gm
+  
+And you are sorted.
+
 == Requirements
 
 You must have ImageMagick or GraphicsMagick installed.

data/VERSION

@@ -1 +1 @@
-3.0
+3.2.1

data/lib/mini_magick.rb

@@ -1,5 +1,7 @@
 require 'tempfile'
 require 'subexec'
+require 'stringio'
+require 'pathname'
 
 module MiniMagick
   class << self
@@ -20,14 +22,14 @@ module MiniMagick
     end
   end
 
-  MOGRIFY_COMMANDS = %w{adaptive-blur adaptive-resize adaptive-sharpen adjoin affine alpha annotate antialias append authenticate auto-gamma auto-level auto-orient background bench iterations bias black-threshold blue-primary point blue-shift factor blur border bordercolor brightness-contrast caption string cdl filename channel type charcoal radius chop clip clamp clip-mask filename clip-path id clone index clut contrast-stretch coalesce colorize color-matrix colors colorspace type combine comment string compose operator composite compress type contrast convolve coefficients crop cycle amount decipher filename debug events define format:option deconstruct delay delete index density depth despeckle direction type display server dispose method distort type coefficients dither method draw string edge radius emboss radius encipher filename encoding type endian type enhance equalize evaluate operator evaluate-sequence operator extent extract family name fft fill filter type flatten flip floodfill flop font name format string frame function name fuzz distance fx expression gamma gaussian-blur geometry gravity type green-primary point help identify ifft implode amount insert index intent type interlace type interline-spacing interpolate method interword-spacing kerning label string lat layers method level limit type linear-stretch liquid-rescale log format loop iterations mask filename mattecolor median radius modulate monitor monochrome morph morphology method kernel motion-blur negate noise radius normalize opaque ordered-dither NxN orient type page paint radius ping pointsize polaroid angle posterize levels precision preview type print string process image-filter profile filename quality quantizespace quiet radial-blur angle raise random-threshold low,high red-primary point regard-warnings region remap filename render repage resample resize respect-parentheses roll rotate degrees sample sampling-factor scale scene seed segments selective-blur separate sepia-tone threshold set attribute shade degrees shadow sharpen shave shear sigmoidal-contrast size sketch solarize threshold splice spread radius strip stroke strokewidth stretch type style type swap indexes swirl degrees texture filename threshold thumbnail tile filename tile-offset tint transform transparent transparent-color transpose transverse treedepth trim type type undercolor unique-colors units type unsharp verbose version view vignette virtual-pixel method wave weight type white-point point white-threshold write filename}
+  MOGRIFY_COMMANDS = %w{adaptive-blur adaptive-resize adaptive-sharpen adjoin affine alpha annotate antialias append authenticate auto-gamma auto-level auto-orient background bench iterations bias black-threshold blue-primary point blue-shift factor blur border bordercolor brightness-contrast caption string cdl filename channel type charcoal radius chop clip clamp clip-mask filename clip-path id clone index clut contrast-stretch coalesce colorize color-matrix colors colorspace type combine comment string compose operator composite compress type contrast convolve coefficients crop cycle amount decipher filename debug events define format:option deconstruct delay delete index density depth despeckle direction type display server dispose method distort type coefficients dither method draw string edge radius emboss radius encipher filename encoding type endian type enhance equalize evaluate operator evaluate-sequence operator extent extract family name fft fill filter type flatten flip floodfill flop font name format string frame function name fuzz distance fx expression gamma gaussian-blur geometry gravity type green-primary point help identify ifft implode amount insert index intent type interlace type interline-spacing interpolate method interword-spacing kerning label string lat layers method level limit type linear-stretch liquid-rescale log format loop iterations mask filename mattecolor median radius modulate monitor monochrome morph morphology method kernel motion-blur negate noise radius normalize opaque ordered-dither NxN orient type page paint radius ping pointsize polaroid angle posterize levels precision preview type print string process image-filter profile filename quality quantize quiet radial-blur angle raise random-threshold low,high red-primary point regard-warnings region remap filename render repage resample resize respect-parentheses roll rotate degrees sample sampling-factor scale scene seed segments selective-blur separate sepia-tone threshold set attribute shade degrees shadow sharpen shave shear sigmoidal-contrast size sketch solarize threshold splice spread radius strip stroke strokewidth stretch type style type swap indexes swirl degrees texture filename threshold thumbnail tile filename tile-offset tint transform transparent transparent-color transpose transverse treedepth trim type type undercolor unique-colors units type unsharp verbose version view vignette virtual-pixel method wave weight type white-point point white-threshold write filename}
 
   class Error < RuntimeError; end
   class Invalid < StandardError; end
 
   class Image
     # @return [String] The location of the current working file
-    attr :path
+    attr_accessor :path
 
     # Class Methods
     # -------------
@@ -61,6 +63,34 @@ 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
+      #
+      # * [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. Defaults to 'png'.
+      #
+      def import_pixels(blob, columns, rows, depth, map, format="png")
+        # Create an image object with the raw pixel data string:
+        image = create(".dat", validate = false) { |f| f.write(blob) }
+        # Use ImageMagick to convert the raw data file to an image file of the desired format:
+        converted_image_path = image.path[0..-4] + format
+        argument = "-size #{columns}x#{rows} -depth #{depth} #{map}:#{image.path} #{converted_image_path}"
+        cmd = CommandBuilder.new("convert", argument) #Example: convert -size 256x256 -depth 16 gray:blob.dat blob.png
+        image.run(cmd)
+        # Update the image instance with the path of the properly formatted image, and return:
+        image.path = converted_image_path
+        image
+      end
+
       # Opens a specific image file either on the local file system or at a URI.
       #
       # Use this if you don't want to overwrite the image file.
@@ -72,12 +102,14 @@ module MiniMagick
       # @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 = File.extname(file_or_url))
+      def open(file_or_url, ext = nil)
         file_or_url = file_or_url.to_s # Force it to be a String... hell or highwater
         if file_or_url.include?("://")
           require 'open-uri'
+          ext ||= File.extname(URI.parse(file_or_url).path)
           self.read(Kernel::open(file_or_url), ext)
         else
+          ext ||= File.extname(file_or_url)
           File.open(file_or_url, "rb") do |f|
             self.read(f, ext)
           end
@@ -96,9 +128,10 @@ module MiniMagick
       # 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
       # @return [Image] The created image
-      def create(ext = nil, &block)
+      def create(ext = nil, validate = true, &block)
         begin
           tempfile = Tempfile.new(['mini_magick', ext.to_s])
           tempfile.binmode
@@ -107,7 +140,7 @@ module MiniMagick
 
           image = self.new(tempfile.path, tempfile)
 
-          if !image.valid?
+          if validate and !image.valid?
             raise MiniMagick::Invalid
           end
           return image
@@ -130,6 +163,9 @@ module MiniMagick
       @tempfile = tempfile # ensures that the tempfile will stick around until this image is garbage collected.
     end
 
+    def escaped_path
+      "\"#{Pathname.new(@path).to_s}\""
+    end
 
     # Checks to make sure that MiniMagick can read the file and understand it.
     #
@@ -152,6 +188,7 @@ module MiniMagick
     #    image["format"]      #=> "TIFF"
     #    image["height"]      #=> 41 (pixels)
     #    image["width"]       #=> 50 (pixels)
+    #    image["colorspace"]  #=> "DirectClassRGB"
     #    image["dimensions"]  #=> [50, 41]
     #    image["size"]        #=> 2050 (bits)
     #    image["original_at"] #=> 2005-02-23 23:17:24 +0000 (Read from Exif data)
@@ -163,28 +200,30 @@ module MiniMagick
     def [](value)
       # Why do I go to the trouble of putting in newlines? Because otherwise animated gifs screw everything up
       case value.to_s
+      when "colorspace"
+        run_command("identify", "-format", format_option("%r"), escaped_path).split("\n")[0]
       when "format"
-        run_command("identify", "-format", format_option("%m"), @path).split("\n")[0]
+        run_command("identify", "-format", format_option("%m"), escaped_path).split("\n")[0]
       when "height"
-        run_command("identify", "-format", format_option("%h"), @path).split("\n")[0].to_i
+        run_command("identify", "-format", format_option("%h"), escaped_path).split("\n")[0].to_i
       when "width"
-        run_command("identify", "-format", format_option("%w"), @path).split("\n")[0].to_i
+        run_command("identify", "-format", format_option("%w"), escaped_path).split("\n")[0].to_i
       when "dimensions"
-        run_command("identify", "-format", format_option("%w %h"), @path).split("\n")[0].split.map{|v|v.to_i}
+        run_command("identify", "-format", format_option("%w %h"), escaped_path).split("\n")[0].split.map{|v|v.to_i}
       when "size"
         File.size(@path) # Do this because calling identify -format "%b" on an animated gif fails!
       when "original_at"
         # Get the EXIF original capture as a Time object
         Time.local(*self["EXIF:DateTimeOriginal"].split(/:|\s+/)) rescue nil
       when /^EXIF\:/i
-        result = run_command('identify', '-format', "\"%[#{value}]\"", @path).chop
+        result = run_command('identify', '-format', "\"%[#{value}]\"", escaped_path).chop
         if result.include?(",")
           read_character_data(result)
         else
           result
         end
       else
-        run_command('identify', '-format', "\"#{value}\"", @path).split("\n")[0]
+        run_command('identify', '-format', "\"#{value}\"", escaped_path).split("\n")[0]
       end
     end
 
@@ -194,7 +233,7 @@ module MiniMagick
     #
     # @return [String] Whatever the result from the command line is. May not be terribly useful.
     def <<(*args)
-      run_command("mogrify", *args << @path)
+      run_command("mogrify", *args << escaped_path)
     end
 
     # This is used to change the format of the image. That is, from "tiff to jpg" or something like that.
@@ -212,7 +251,10 @@ module MiniMagick
     # @param page [Integer] If this is an animated gif, say which 'page' you want with an integer. Leave as default if you don't care.
     # @return [nil]
     def format(format, page = 0)
-      run_command("mogrify", "-format", format, @path)
+      c = CommandBuilder.new('mogrify', '-format', format)
+      yield c if block_given?
+      c << @path
+      run(c)
 
       old_path = @path.dup
       @path.sub!(/(\.\w*)?$/, ".#{format}")
@@ -246,7 +288,9 @@ module MiniMagick
     def write(output_to)
       if output_to.kind_of?(String) || !output_to.respond_to?(:write)
         FileUtils.copy_file @path, output_to
-        run_command "identify", output_to # Verify that we have a good image
+        # We need to escape the output path if it contains a space
+        escaped_output_to = output_to.to_s.gsub(' ', '\\ ')
+        run_command "identify", escaped_output_to # Verify that we have a good image
       else # stream
         File.open(@path, "rb") do |f|
           f.binmode
@@ -322,6 +366,11 @@ module MiniMagick
     end
 
     def run_command(command, *args)
+      # -ping "efficiently determine image characteristics."
+      if command == 'identify'
+        args.unshift '-ping'
+      end
+
       run(CommandBuilder.new(command, *args))
     end
 
@@ -385,15 +434,27 @@ module MiniMagick
         raise Error, "You must call 'format' on the image object directly!"
       elsif MOGRIFY_COMMANDS.include?(guessed_command_name)
         add(guessed_command_name, *options)
+        self
       else
         super(symbol, *args)
       end
     end
 
+    def +(*options)
+      push(@args.pop.gsub(/^-/, '+'))
+      if options.any?
+        options.each do |o|
+          push "\"#{ o }\""
+        end
+      end
+    end
+
     def add(command, *options)
       push "-#{command}"
       if options.any?
-        push "\"#{options.join(" ")}\""
+        options.each do |o|
+          push "\"#{ o }\""
+        end
       end
     end
 
@@ -401,11 +462,5 @@ module MiniMagick
       @args << arg.to_s.strip
     end
     alias :<< :push
-
-    # @deprecated Please don't use the + method its has been deprecated
-    def +(value)
-      warn "Warning: The MiniMagick::ComandBuilder#+ command has been deprecated. Please use c << '+#{value}' instead"
-      push "+#{value}"
-    end
   end
 end

data/test/command_builder_test.rb

@@ -14,10 +14,16 @@ class CommandBuilderTest < Test::Unit::TestCase
   def test_complicated
     c = CommandBuilder.new("test")
     c.resize "30x40"
-    c.alpha 1, 3, 4
+    c.alpha "1 3 4"
     c.resize "mome fingo"
     assert_equal "-resize \"30x40\" -alpha \"1 3 4\" -resize \"mome fingo\"", c.args.join(" ")
   end
+
+  def test_plus_modifier_and_multiple_options
+    c = CommandBuilder.new("test")
+    c.distort.+ 'srt', '0.6 20'
+    assert_equal "+distort \"srt\" \"0.6 20\"", c.args.join(" ")
+  end
   
   def test_valid_command
     begin

data/test/image_test.rb

@@ -1,8 +1,6 @@
 require 'rubygems'
 require 'test/unit'
-require 'mocha'
 require 'pathname'
-require 'stringio'
 require File.expand_path('../../lib/mini_magick', __FILE__)
 
 #MiniMagick.processor = :gm
@@ -14,7 +12,7 @@ class ImageTest < Test::Unit::TestCase
 
   SIMPLE_IMAGE_PATH = CURRENT_DIR + "simple.gif"
   MINUS_IMAGE_PATH  = CURRENT_DIR + "simple-minus.gif"
-  TIFF_IMAGE_PATH   = CURRENT_DIR + "leaves.tiff"
+  TIFF_IMAGE_PATH   = CURRENT_DIR + "leaves (spaced).tiff"
   NOT_AN_IMAGE_PATH = CURRENT_DIR + "not_an_image.php"
   GIF_WITH_JPG_EXT  = CURRENT_DIR + "actually_a_gif.jpg"
   EXIF_IMAGE_PATH   = CURRENT_DIR + "trogdor.jpg"
@@ -37,6 +35,7 @@ class ImageTest < Test::Unit::TestCase
   def test_image_io_reading
     buffer = StringIO.new(File.read(SIMPLE_IMAGE_PATH))
     image = Image.read(buffer)
+    assert image.valid?
     image.destroy!
   end
 
@@ -54,7 +53,13 @@ class ImageTest < Test::Unit::TestCase
 
   def test_remote_image
     image = Image.open("http://www.google.com/images/logos/logo.png")
-    image.valid?
+    assert image.valid?
+    image.destroy!
+  end
+
+  def test_remote_image_with_complex_url
+    image = Image.open("http://a0.twimg.com/a/1296609216/images/fronts/logo_withbird_home.png?extra=foo&plus=bar")
+    assert image.valid?
     image.destroy!
   end
 
@@ -71,6 +76,19 @@ class ImageTest < Test::Unit::TestCase
     image.destroy!
   end
 
+  def test_image_write_with_space_in_output_path
+    output_path = "test output.gif"
+    begin
+      image = Image.new(SIMPLE_IMAGE_PATH)
+      image.write output_path
+
+      assert File.exists?(output_path)
+    ensure
+      File.delete output_path
+    end
+    image.destroy!
+  end
+
   def test_image_write_with_stream
     stream = StringIO.new
     image = Image.open(SIMPLE_IMAGE_PATH)
@@ -98,6 +116,7 @@ class ImageTest < Test::Unit::TestCase
     assert_equal 150, image[:width]
     assert_equal 55, image[:height]
     assert_equal [150, 55], image[:dimensions]
+    assert_equal 'PseudoClassRGB', image[:colorspace]
     assert_match(/^gif$/i, image[:format])
     image.destroy!
   end
@@ -240,6 +259,25 @@ class ImageTest < Test::Unit::TestCase
     FileUtils.rm("test.gif")
   end
 
+  # https://github.com/probablycorey/mini_magick/issues/37
+  def test_nonstandard_locale
+    original_lang = ENV["LANG"]
+    ENV["LANG"] = "fr_FR.UTF-8"
+
+    # This test should break
+    test_throw_on_openining_not_an_image
+  ensure
+    ENV["LANG"] = original_lang
+  end
+
+  def test_poop
+    img = MiniMagick::Image.open(SIMPLE_IMAGE_PATH)
+    img.gravity "Center"
+    img.crop "480x480"
+    img.resize "250x250"
+    img.write CURRENT_DIR + "output.png"
+  end
+
   def test_throw_format_error
     image = Image.open(SIMPLE_IMAGE_PATH)
     assert_raise MiniMagick::Error do
@@ -250,15 +288,35 @@ class ImageTest < Test::Unit::TestCase
     image.destroy!
   end
 
-  # testing that if copying files formatted from an animation fails,
-  # it raises an appropriate error
-  def test_throw_animation_copy_after_format_error
-    image = Image.open(ANIMATION_PATH)
-    FileUtils.stubs(:copy_file).raises(Errno::ENOENT)
-    assert_raises MiniMagick::Error do
-      image.format('png')
-    end
+  def test_import_pixels_default_format
+    columns = 325
+    rows = 200
+    depth = 16 # 16 bits (2 bytes) per pixel
+    map = 'gray'
+    pixels = Array.new(columns*rows) {|i| i}
+    blob = pixels.pack("S*") # unsigned short, native byte order
+    image = Image.import_pixels(blob, columns, rows, depth, map)
+    assert image.valid?
+    assert_equal "png", image[:format].downcase
+    assert_equal columns, image[:width]
+    assert_equal rows, image[:height]
+    image.write(CURRENT_DIR + "imported_pixels_image.png")
   end
 
+  def test_import_pixels_custom_format
+    columns = 325
+    rows = 200
+    depth = 16 # 16 bits (2 bytes) per pixel
+    map = 'gray'
+    format = 'jpeg'
+    pixels = Array.new(columns*rows) {|i| i}
+    blob = pixels.pack("S*") # unsigned short, native byte order
+    image = Image.import_pixels(blob, columns, rows, depth, map, format)
+    assert image.valid?
+    assert_equal format, image[:format].downcase
+    assert_equal columns, image[:width]
+    assert_equal rows, image[:height]
+    image.write(CURRENT_DIR + "imported_pixels_image." + format)
+  end
 
 end

metadata

@@ -4,8 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 3
-  - 0
-  version: "3.0"
+  - 2
+  - 1
+  version: 3.2.1
 platform: ruby
 authors: 
 - Corey Johnson
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-28 00:00:00 +01:00
+date: 2011-04-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,20 +33,6 @@ dependencies:
         version: 0.0.4
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 9
-        version: 0.9.9
-  type: :development
-  version_requirements: *id002
 description: ""
 email: 
 - probablycorey@gmail.com
@@ -100,7 +87,7 @@ test_files:
 - test/command_builder_test.rb
 - test/composited.jpg
 - test/image_test.rb
-- test/leaves.tiff
+- test/leaves (spaced).tiff
 - test/not_an_image.php
 - test/simple-minus.gif
 - test/simple.gif