mini_magick 1.2.0 → 1.2.3

data/History.txt

@@ -0,0 +1,11 @@
+== 1.2.2 / 2007-06-01
+
+# 1.) all image commands return the image object (The output of the last command is saved in @output)
+# 2.) identify doesn't trip over strangley named files
+# 3.) TempFile uses file extention now (Thanks http://marsorange.com/archives/of-mogrify-ruby-tempfile-dynamic-class-definitions)
+# 4.) identify commands escape output path correctly
+
+== 1.2.3 / 2007-06-15
+
+# 1.) Image::from_file doesn't drop the file extension anymore, it and use the image_temp_file correctly
+# 4.) TempFiles are stored as an instance variable in Image instances so they don't get cleaned up prematurely via garbage collection

data/Manifest.txt

@@ -0,0 +1,14 @@
+MIT-LICENSE
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+init.rb
+lib/image_temp_file.rb
+lib/mini_magick.rb
+test/actually_a_gif.jpg
+test/not_an_image.php
+test/simple.gif
+test/test_image_temp_file.rb
+test/test_mini_magick_test.rb
+test/trogdor.jpg

data/{README → README.txt}

@@ -1,10 +1,13 @@
-MiniMagick
-==========
+mini_magick
+    by Coery Johnson
+    FIX (url)
 
+== DESCRIPTION:
+  
 A ruby wrapper for ImageMagick command line.
 
-Why?
----
+- 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|
@@ -13,14 +16,16 @@ 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!
----------
+- 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)
 
+
+== FEATURES/PROBLEMS:
+  
 MiniMagick gives you access to all the commandline options ImageMagick has (Found here http://www.imagemagick.org/script/mogrify.php)
 
-Examples
---------
+== SYNOPSIS:
 
 Want to make a thumbnail from a file...
 
@@ -55,12 +60,13 @@ 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 found here http://www.imagemagick.org/script/command-line-options.php#format
 
-Requirements
-------------
+
+== REQUIREMENTS:
+
 You must have ImageMagick installed.
 
-How To Install
---------------
+== INSTALL:
+
 If you downloaded the plugin version, just drop the plugin into RAILS_ROOT/plugins/
 
 If you installed this as a gem, then to get it to work add <require "mini_magick"> to RAILS_ROOT/config/environment.rb
@@ -69,4 +75,27 @@ If you have just downloaded this files then copy the mini_magick.rb file into yo
 
 MiniMagick does NOT require rails though. All the code you need to use MiniMagick is located in the mini_magick/lib/mini_magick.rb file.
 
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+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/Rakefile

@@ -1,68 +1,17 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-
-$:.unshift(File.dirname(__FILE__) + "/lib")
-require 'mini_magick'
-
-PKG_NAME      = 'mini_magick'
-PKG_VERSION   = MiniMagick::VERSION
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc "Clean generated files"
-task :clean do
-  rm FileList['test/output/*.png']
-  rm_rf 'pkg'
-  rm_rf 'doc'
-end
-
-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 --inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/mini_magick.rb'
+
+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")
 end
 
-
-# Create compressed packages
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = PKG_NAME
-  s.summary = "Manipulate images with minimal use of memory."
-  s.description = %q{Uses command-line ImageMagick tools to resize, rotate, and mogrify images.}
-  s.version = PKG_VERSION
-
-  s.author = "Corey Johnson"
-  s.email = "probablycorey@gmail.com"
-  s.rubyforge_project = PKG_NAME
-  s.homepage = "http://gleepglop.com"
-
-  s.has_rdoc = true
-  s.requirements << 'none'
-  s.require_path = 'lib'
-  s.autorequire = 'mini_magick'
-
-  s.files = [ "Rakefile", "README", "MIT-LICENSE" ]
-  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) || item.include?("\.png") }
-end
-  
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = false
-  p.need_zip = true
-end
+# vim: syntax=Ruby

data/init.rb

@@ -0,0 +1,2 @@
+require 'mini_magick'
+require 'image_temp_file'

data/lib/image_temp_file.rb

@@ -0,0 +1,13 @@
+require "tempfile"
+
+module MiniMagick
+  class ImageTempFile < Tempfile
+    def make_tmpname(basename, n)
+      # force tempfile to use basename's extension if provided
+      ext = File.extname(basename)
+    
+      # force hyphens instead of periods in name
+      sprintf('%s%d-%d%s', File.basename(basename, ext), $$, n, ext)
+    end
+  end
+end

data/lib/mini_magick.rb

@@ -1,52 +1,58 @@
 require "open-uri"
-require "tempfile"
 require "stringio"
 require "fileutils"
 
+require File.join(File.dirname(__FILE__), '/image_temp_file')
+
 module MiniMagick
-  class MiniMagickError < Exception; end
-  
-  VERSION = '1.2.0'
-    
+  class MiniMagickError < RuntimeError; end
+
+  VERSION = '1.2.3'
+
   class Image
     attr :path
+    attr :tempfile
+    attr :output
 
     # Class Methods
     # -------------
     class <<self
-      def from_blob(blob)      
+      def from_blob(blob, extension=nil)
         begin
-          tmp = Tempfile.new("minimagic")
-          tmp.binmode 
-          tmp.write(blob)
+          tempfile = ImageTempFile.new("minimagick#{extension}")
+          tempfile.binmode
+          tempfile.write(blob)
         ensure
-          tmp.close
-        end      
-        return self.new(tmp.path)
+          tempfile.close
+        end
+        
+        return self.new(tempfile.path, tempfile)
       end
-      
+
       # Use this if you don't want to overwrite the image file
-      def from_file(image_path)      
+      def from_file(image_path)
         File.open(image_path, "rb") do |f|
-          self.from_blob(f.read)
+          self.from_blob(f.read, File.extname(image_path))
         end
       end
     end
-    
+
     # Instance Methods
-    # ----------------    
-    def initialize(input_path)      
+    # ----------------
+    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}")      
+      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 newline chars? 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
       case value.to_s
       when "format"
-        run_command("identify", "-format", format_option("%m"), @path).split("\n")[0]        	
+        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"
@@ -55,87 +61,87 @@ module MiniMagick
         # 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              
+        run_command('identify', '-format', "\"%[#{value}]\"", @path).chop
       else
-        run_command('identify', '-format', "\"#{value}\"", @path)
+        run_command('identify', '-format', "\"#{value}\"", @path).split("\n")[0]
       end
     end
-    
+
     # This is a 'special' command because it needs to change @path to reflect the new extension
     def format(format)
       run_command("mogrify", "-format", format, @path)
-      @path = @path.sub(/\.\w+$/, ".#{format}")
+      @path = @path.sub(/(\.\w+)?$/, ".#{format}")
       
       raise "Unable to format to #{format}" unless File.exists?(@path)
     end
-    
+
     # Writes the temporary image that we are using for processing to the output path
-    def write(output_path)        
+    def write(output_path)
       FileUtils.copy_file @path, output_path
-      run_command "identify #{output_path}"		# Verify that we have a good image
+      run_command "identify", output_path # Verify that we have a good image
     end
-      
+
+    # Give you raw data back
+    def to_blob
+      File.read @path
+    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)      
+    def combine_options(&block)
       c = CommandBuilder.new
       block.call c
       run_command("mogrify", *c.args << @path)
     end
-          
-    # Private (Don't look in here!)
-    # -----------------------------
-    private
-    
-    # Check to see if we are running on win32 -- we need to escape things differently    
+
+    # 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 
+      !(RUBY_PLATFORM =~ /win32/).nil?
+    end
+
+    # Outputs a carriage-return delimited format string for Unix and Windows
     def format_option(format)
-        if windows?
-        	format = "#{format}\\n"
-        else
-        	format = "#{format}\\\\n"
-        end              
-    end    
-        
+      windows? ? "#{format}\\n" : "#{format}\\\\n"
+    end
+
     def run_command(command, *args)
-      args = args.collect do |a|
-        a = a.to_s
-        unless a[0,1] == '-'  # don't quote switches
-          "\"#{a}\""          # values quoted because they can contain characters like '>'
-        else
-          a
-        end
+      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
-      
-      output = `#{command} #{args.join(' ')}`
-      
+
+      @output = `#{command} #{args.join(' ')}`
+
       if $? != 0
         raise MiniMagickError, "ImageMagick command (#{command} #{args.join(' ')}) failed: Error Given #{$?}"
       else
-        return output
-      end  
+        @output
+      end
     end
   end
 
   class CommandBuilder
     attr :args
-    
+
     def initialize
       @args = []
     end
-    
+
     def method_missing(symbol, *args)
-      @args += ["-#{symbol}"] + args
-    end    
+      @args << "-#{symbol}"
+      @args += args
+    end
+    
+    def +(value)
+      @args << "+#{value}"
+    end
   end
 end