mini_magick 1.2.3 → 2.0.0

data/README.rdoc

@@ -0,0 +1,81 @@
+= MiniMagick
+
+A ruby wrapper for ImageMagick or GraphicsMagick command line.
+
+Tested on both Ruby 1.9.2 and Ruby 1.8.7.
+
+== Why?
+
+I was using RMagick and loving it, but it was eating up huge amounts
+of memory. A simple script like this...
+
+  Magick::read("image.jpg") do |f|
+    f.write("manipulated.jpg")
+  end
+
+...would use over 100 Megs of Ram. On my local machine this wasn't a
+problem, but on my hosting server the ruby apps would crash because of
+their 100 Meg memory limit.
+
+
+== Solution!
+
+Using MiniMagick the ruby processes memory remains small (it spawns
+ImageMagick's command line program mogrify which takes up some memory
+as well, but is much smaller compared to RMagick)
+
+MiniMagick gives you access to all the commandline options ImageMagick
+has (Found here http://www.imagemagick.org/script/mogrify.php)
+
+
+== Examples
+
+Want to make a thumbnail from a file...
+
+  image = MiniMagick::Image.from_file("input.jpg")
+  image.resize "100x100"
+  image.write("output.jpg")
+
+Want to make a thumbnail from a blob...
+
+  image = MiniMagick::Image.from_blob(blob)
+  image.resize "100x100"
+  image.write("output.jpg")
+
+Need to combine several options?
+
+  image = MiniMagick::Image.from_file("input.jpg")
+  image.combine_options do |c|
+    c.sample "50%"
+    c.rotate "-90>"
+  end
+  image.write("output.jpg")
+
+Want to composite two images? Super easy! (Aka, put a watermark on!)
+
+  image = Image.from_file("original.png")
+  result = image.composite(Image.open("watermark.png", "jpg") do |c|
+    c.gravity "center"
+  end
+  result.write("my_output_file.jpg")
+
+Want to manipulate an image at its source (You won't have to write it
+out because the transformations are done on that file)
+
+  image = MiniMagick::Image.new("input.jpg")
+  image.resize "100x100"
+
+Want to get some meta-information out?
+
+  image = MiniMagick::Image.from_file("input.jpg")
+  image[:width]               # will get the width (you can also use :height and :format)
+  image["EXIF:BitsPerSample"] # It also can get all the EXIF tags
+  image["%m:%f %wx%h"]        # Or you can use one of the many options of the format command
+
+For more on the format command see
+http://www.imagemagick.org/script/command-line-options.php#format
+
+
+== Requirements
+
+You must have ImageMagick or GraphicsMagick installed.

data/Rakefile

@@ -1,17 +1,32 @@
-# -*- ruby -*-
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
 
-require 'rubygems'
-require 'hoe'
-require './lib/mini_magick.rb'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'mini_magick'
 
-Hoe.new('mini_magick', MiniMagick::VERSION) do |p|
-  p.rubyforge_name = 'mini_magick'
-  p.author = 'Corey Johnson'
-  p.email = 'probablycorey+ruby@gmail.com'
-  p.summary = 'A simple image manipulation library based on ImageMagick.'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  #p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mini_magick plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the mini_magick plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MiniMagick'
+  rdoc.options << '--line-numbers'
+  rdoc.options << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-# vim: syntax=Ruby
+spec = eval(File.read('mini_magick.gemspec'))
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/mini_gmagick.rb

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

data/lib/mini_magick.rb

@@ -1,13 +1,16 @@
-require "open-uri"
-require "stringio"
-require "fileutils"
-
-require File.join(File.dirname(__FILE__), '/image_temp_file')
+require 'tempfile'
+require 'subexec'
 
 module MiniMagick
-  class MiniMagickError < RuntimeError; end
+  class << self
+    attr_accessor :processor
+    attr_accessor :timeout
+  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}
 
-  VERSION = '1.2.3'
+  class Error < RuntimeError; end
+  class Invalid < StandardError; end
 
   class Image
     attr :path
@@ -16,25 +19,30 @@ module MiniMagick
 
     # Class Methods
     # -------------
-    class <<self
-      def from_blob(blob, extension=nil)
+    class << self
+      def from_blob(blob, ext = nil)
         begin
-          tempfile = ImageTempFile.new("minimagick#{extension}")
+          tempfile = Tempfile.new(['mini_magick', ext.to_s])
           tempfile.binmode
           tempfile.write(blob)
         ensure
-          tempfile.close
+          tempfile.close if tempfile
         end
-        
-        return self.new(tempfile.path, tempfile)
+
+        image = self.new(tempfile.path, tempfile)
+        if !image.valid?
+          raise MiniMagick::Invalid
+        end
+        image
       end
 
       # Use this if you don't want to overwrite the image file
-      def from_file(image_path)
+      def open(image_path)
         File.open(image_path, "rb") do |f|
           self.from_blob(f.read, File.extname(image_path))
         end
       end
+      alias_method :from_file, :open
     end
 
     # Instance Methods
@@ -42,9 +50,13 @@ module MiniMagick
     def initialize(input_path, tempfile=nil)
       @path = input_path
       @tempfile = tempfile # ensures that the tempfile will stick around until this image is garbage collected.
-
-      # Ensure that the file is an image
+    end
+    
+    def valid?
       run_command("identify", @path)
+      true
+    rescue MiniMagick::Invalid
+      false
     end
 
     # For reference see http://www.imagemagick.org/script/command-line-options.php#format
@@ -57,22 +69,58 @@ module MiniMagick
         run_command("identify", "-format", format_option("%h"), @path).split("\n")[0].to_i
       when "width"
         run_command("identify", "-format", format_option("%w"), @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}
+      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
-        run_command('identify', '-format', "\"%[#{value}]\"", @path).chop
+        result = run_command('identify', '-format', "\"%[#{value}]\"", @path).chop
+        if result.include?(",")
+          read_character_data(result)
+        else
+          result
+        end
       else
         run_command('identify', '-format', "\"#{value}\"", @path).split("\n")[0]
       end
     end
 
+    # Sends raw commands to imagemagick's mogrify command. The image path is automatically appended to the command
+    def <<(*args)
+      run_command("mogrify", *args << @path)
+    end
+
     # This is a 'special' command because it needs to change @path to reflect the new extension
-    def format(format)
+    # 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.
+    def format(format, page=0)
       run_command("mogrify", "-format", format, @path)
-      @path = @path.sub(/(\.\w+)?$/, ".#{format}")
-      
-      raise "Unable to format to #{format}" unless File.exists?(@path)
+
+      old_path = @path.dup
+      @path.sub!(/(\.\w*)?$/, ".#{format}")
+      File.delete(old_path) unless old_path == @path
+
+      unless File.exists?(@path)
+        begin
+          FileUtils.copy_file(@path.sub(".#{format}", "-#{page}.#{format}"), @path)
+        rescue => ex
+          raise MiniMagickError, "Unable to format to #{format}; #{ex}" unless File.exist?(@path)
+        end
+      end
+    ensure
+      Dir[@path.sub(/(\.\w+)?$/, "-[0-9]*.#{format}")].each do |fname|
+        File.unlink(fname)
+      end
+    end
+    
+    # Collapse images with sequences to the first frame (ie. animated gifs) and
+    # preserve quality
+    def collapse!
+      run_command("mogrify", "-quality", "100", "#{path}[0]")
     end
 
     # Writes the temporary image that we are using for processing to the output path
@@ -83,28 +131,57 @@ module MiniMagick
 
     # Give you raw data back
     def to_blob
-      File.read @path
+      f = File.new @path
+      f.binmode
+      f.read
+    ensure
+      f.close if f
     end
 
     # If an unknown method is called then it is sent through the morgrify program
     # Look here to find all the commands (http://www.imagemagick.org/script/mogrify.php)
     def method_missing(symbol, *args)
-      args.push(@path) # push the path onto the end
-      run_command("mogrify", "-#{symbol}", *args)
-      self
+      guessed_command_name = symbol.to_s.gsub('_','-')
+
+      if MOGRIFY_COMMANDS.include?(guessed_command_name)
+        args.push(@path) # push the path onto the end
+        run_command("mogrify", "-#{guessed_command_name}", *args)
+        self
+      else
+        super(symbol, *args)
+      end
     end
 
     # You can use multiple commands together using this method
     def combine_options(&block)
-      c = CommandBuilder.new
+      c = CommandBuilder.new('mogrify')
       block.call c
-      run_command("mogrify", *c.args << @path)
+      c << @path
+      run(c)
     end
 
     # Check to see if we are running on win32 -- we need to escape things differently
     def windows?
       !(RUBY_PLATFORM =~ /win32/).nil?
     end
+    
+    def composite(other_image, output_extension = 'jpg', &block)
+      begin
+        tempfile = Tempfile.new(output_extension)
+        tempfile.binmode
+      ensure
+        tempfile.close
+      end
+      
+      command = CommandBuilder.new("composite")
+      block.call(command) if block
+      command.push(other_image.path)
+      command.push(self.path)
+      command.push(tempfile.path)
+      
+      run(command)
+      return Image.new(tempfile.path)
+    end
 
     # Outputs a carriage-return delimited format string for Unix and Windows
     def format_option(format)
@@ -112,36 +189,89 @@ module MiniMagick
     end
 
     def run_command(command, *args)
-      args.collect! do |arg|
-        arg = arg.to_s
-        arg = %|"#{arg}"| unless arg[0] == ?- # values quoted because they can contain characters like '>', but don't quote switches          
-        arg
-      end
+      run(CommandBuilder.new(command, *args))
+    end
+    
+    def run(command_builder)
+      command = command_builder.command
 
-      @output = `#{command} #{args.join(' ')}`
+      sub = Subexec.run(command, :timeout => MiniMagick.timeout)
 
-      if $? != 0
-        raise MiniMagickError, "ImageMagick command (#{command} #{args.join(' ')}) failed: Error Given #{$?}"
+      if sub.exitstatus != 0
+        # Clean up after ourselves in case of an error
+        destroy!
+        
+        # Raise the appropriate error
+        if sub.output =~ /no decode delegate/i || sub.output =~ /did not return an image/i
+          raise Invalid, sub.output
+        else
+          # TODO: should we do something different if the command times out ...?
+          # its definitely better for logging.. otherwise we dont really know
+          raise Error, "Command (#{command.inspect}) failed: #{{:status_code => sub.exitstatus, :output => sub.output}.inspect}"
+        end
       else
-        @output
+        sub.output
       end
     end
+    
+    def destroy!
+      return if tempfile.nil?
+      File.unlink(tempfile.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
+      end
   end
 
   class CommandBuilder
     attr :args
+    attr :command
 
-    def initialize
+    def initialize(command, *options)
+      @command = command
       @args = []
+  
+      options.each { |val| push(val) }
     end
-
+    
+    def command
+      "#{MiniMagick.processor} #{@command} #{@args.join(' ')}".strip
+    end
+    
     def method_missing(symbol, *args)
-      @args << "-#{symbol}"
-      @args += args
+      guessed_command_name = symbol.to_s.gsub('_','-')
+      if MOGRIFY_COMMANDS.include?(guessed_command_name)
+        # This makes sure we always quote if we are passed a single
+        # arguement with spaces in it
+        if (args.size == 1) && (args.first.to_s.include?(' '))
+          push("-#{guessed_command_name}")
+          push(args.join(" "))
+        else
+          push("-#{guessed_command_name} #{args.join(" ")}")
+        end
+      else
+        super(symbol, *args)
+      end
     end
     
+    def push(value)
+      # args can contain characters like '>' so we must escape them, but don't quote switches
+      @args << ((value !~ /^[\+\-]/) ? "\"#{value}\"" : value.to_s.strip)
+    end
+    alias :<< :push
+
     def +(value)
-      @args << "+#{value}"
+      puts "MINI_MAGICK: The + command has been deprecated. Please use c << '+#{value}')"
+      push "+#{value}"
     end
   end
 end

data/test/command_builder_test.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'test/unit'
+require File.expand_path('../../lib/mini_magick', __FILE__)
+
+class CommandBuilderTest < Test::Unit::TestCase
+  include MiniMagick
+
+  def test_basic
+    c = CommandBuilder.new("test")
+    c.resize "30x40"
+    assert_equal "-resize 30x40", c.args.join(" ")
+  end
+
+  def test_complicated
+    c = CommandBuilder.new("test")
+    c.resize "30x40"
+    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_valid_command
+    begin
+      c = CommandBuilder.new("test", "path")
+      c.input 2
+      assert false
+    rescue NoMethodError
+      assert true
+    end
+  end
+  
+  def test_full_command
+    c = CommandBuilder.new("test")
+    c.resize "30x40"
+    c.alpha 1, 3, 4
+    c.resize "mome fingo"
+    assert_equal "test -resize 30x40 -alpha 1 3 4 -resize \"mome fingo\"", c.command
+  end
+
+  def test_dashed
+    c = CommandBuilder.new("test")
+    c.auto_orient
+    assert_equal "-auto-orient", c.args.join(" ")
+  end
+end