tupalo-mini_magick 1.2.5

data/.gitignore

@@ -0,0 +1 @@
+/pkg

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2005 Corey Johnson probablycorey@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,72 @@
+= MiniMagick
+
+A ruby wrapper for ImageMagick command line.
+
+
+== 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 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 installed.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'mini_magick'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mini_magick plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  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
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mini_magick"
+    gemspec.summary = "Manipulate images with minimal use of memory."
+    gemspec.email = "probablycorey@gmail.com"
+    gemspec.homepage = "http://github.com/probablycorey/mini_magick"
+    gemspec.authors = ["Corey Johnson"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.2.5

data/lib/image_temp_file.rb

@@ -0,0 +1,9 @@
+require "tempfile"
+
+module MiniMagick
+  class ImageTempFile < Tempfile
+    def make_tmpname(ext, n)
+      'mini_magick%d-%d%s' % [$$, n, ext ? ".#{ext}" : '']
+    end
+  end
+end

data/lib/mini_magick.rb

@@ -0,0 +1,223 @@
+require "open-uri"
+require "stringio"
+require "fileutils"
+require "open3"
+
+require File.join(File.dirname(__FILE__), '/image_temp_file')
+
+module MiniMagick
+  class MiniMagickError < RuntimeError; end
+
+  class Image
+    attr :path
+    attr :tempfile
+    attr :output
+
+    # Class Methods
+    # -------------
+    class << self
+      def from_blob(blob, ext = nil)
+        begin
+          tempfile = ImageTempFile.new(ext)
+          tempfile.binmode
+          tempfile.write(blob)
+        ensure
+          tempfile.close if tempfile
+        end
+
+        return self.new(tempfile.path, tempfile)
+      end
+
+      # Use this if you don't want to overwrite the image file
+      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
+    # ----------------
+    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
+      run_command("identify", @path)
+    end
+
+    # For reference see http://www.imagemagick.org/script/command-line-options.php#format
+    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 "format"
+        run_command("identify", "-format", format_option("%m"), @path).split("\n")[0]
+      when "height"
+        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
+      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
+    # 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)
+
+      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 e
+          raise MiniMagickError, "Unable to format to #{format}; #{e}" unless File.exist?(@path)
+        end
+      end
+    ensure
+      Dir[@path.sub(/(\.\w+)?$/, "-[0-9]*.#{format}")].each do |fname|
+        File.unlink(fname)
+      end
+    end
+
+    # Writes the temporary image that we are using for processing to the output path
+    def write(output_path)
+      FileUtils.copy_file @path, output_path
+      run_command "identify", output_path # Verify that we have a good image
+    end
+
+    # Give you raw data back
+    def to_blob
+      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
+    end
+
+    # You can use multiple commands together using this method
+    def combine_options(&block)
+      c = CommandBuilder.new
+      block.call c
+      run_command("mogrify", *c.args << @path)
+    end
+
+    # Check to see if we are running on win32 -- we need to escape things differently
+    def windows?
+      !(RUBY_PLATFORM =~ /win32/).nil?
+    end
+
+    # Outputs a carriage-return delimited format string for Unix and Windows
+    def format_option(format)
+      windows? ? "#{format}\\n" : "#{format}\\\\n"
+    end
+
+    def run_command(command, *args)
+      args.collect! do |arg|        
+        # args can contain characters like '>' so we must escape them, but don't quote switches
+        if arg !~ /^[\+\-]/
+          "\"#{arg}\""
+        else
+          arg.to_s
+        end
+      end
+
+      command = "#{command} #{args.join(' ')}"
+      output = `#{command} 2>&1`
+
+      if $?.exitstatus != 0
+        raise MiniMagickError, "ImageMagick command (#{command.inspect}) failed: #{{:status_code => $?, :output => output}.inspect}"
+      else
+        output
+      end
+    end
+  end
+
+  # Combines multiple images into a single montage via ImageMagick's montage script
+  class Montage
+    # Class Methods
+    # -------------
+    
+    # To create a montage simply call Montage.new with the images you want combine,
+    # the path to the output file and any command line options you may want. 
+    # You will be returned a MiniMagick::Image instance for the new montage:
+    #
+    #   image1 = MiniMagick::Image.open('alice.png')
+    #   image2 = MiniMagick::Image.open('bob.png')
+    #   output_image = MiniMagick::Composite.new([image1, image2], 'jpg', :background => '#336699')
+    #   output_image.write('montage.jpg')
+    #
+    # The above example would combine the two images into a new JPEG file using a background color of #336699.
+    # The the image is saved using the standard Image.save method.
+    #
+    # The 'montage' script has several options, see here: http://www.imagemagick.org/script/montage.php
+    def self.new(images, output_extension, options={})
+      begin
+        tempfile = ImageTempFile.new(output_extension)
+        tempfile.binmode
+      ensure
+        tempfile.close
+      end
+      
+      args = options.collect { |key,value| "-#{key.to_s} #{value.to_s}" }  # collect hash parts into arguments
+      images.each do |image|
+        args.push image.path
+      end
+      args.push(tempfile.path)
+
+      # This is a little hacky - cannikin's CommandeRunner would be a useful
+      # alternative (http://github.com/cannikin/mini_magick).
+      Image.new(images.first.path).run_command('montage', *args)
+      return Image.open(tempfile.path)
+    end
+
+    def run
+    end
+    
+  end
+
+  class CommandBuilder
+    attr :args
+
+    def initialize
+      @args = []
+    end
+
+    def method_missing(symbol, *args)
+      @args << "-#{symbol}"
+      @args += args
+    end
+
+    def +(value)
+      @args << "+#{value}"
+    end
+  end
+end

data/mini_magick.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tupalo-mini_magick}
+  s.version = "1.2.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Corey Johnson"]
+  s.date = %q{2009-05-27}
+  s.description = %q{This is a fork of peplins fork of the mini_magick gem. It includes support for the montage command.}
+  s.email = %q{thomas@tupalo.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/image_temp_file.rb",
+     "lib/mini_magick.rb",
+     "mini_magick.gemspec",
+     "test/actually_a_gif.jpg",
+     "test/animation.gif",
+     "test/command_builder_test.rb",
+     "test/image_temp_file_test.rb",
+     "test/image_test.rb",
+     "test/leaves.tiff",
+     "test/not_an_image.php",
+     "test/simple.gif",
+     "test/trogdor.jpg"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/fadr/tupalo-mini_magick}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Manipulate images with minimal use of memory.}
+  s.test_files = [
+    "test/command_builder_test.rb",
+     "test/image_temp_file_test.rb",
+     "test/image_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/command_builder_test.rb

@@ -0,0 +1,20 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '../lib/mini_magick')
+
+class CommandBuilderTest < Test::Unit::TestCase
+  include MiniMagick
+
+  def test_basic
+    c = CommandBuilder.new
+    c.resize "30x40"
+    assert_equal "-resize 30x40", c.args.join(" ")
+  end
+
+  def test_complicated
+    c = CommandBuilder.new
+    c.resize "30x40"
+    c.input 1, 3, 4
+    c.lingo "mome fingo"
+    assert_equal "-resize 30x40 -input 1 3 4 -lingo mome fingo", c.args.join(" ")
+  end
+end