imanip 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2008-06-13
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Aaron Quint, Quirkey NYC, LLC.
+
+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/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+init.rb
+install.rb
+lib/imanip.rb
+lib/imanip/errors.rb
+lib/imanip/image.rb
+lib/imanip/imanip_magick.rb
+lib/imanip/version.rb
+test/landscape_test.jpg
+test/portrait_test.jpg
+test/test_helper.rb
+test/test_imanip_magick.rb
+uninstall.rb

data/README.txt

@@ -0,0 +1,116 @@
+= imanip
+
+http://quirkey.sourceforge.com/imanip/
+http://github.com/quirkey/imanip/
+
+== DESCRIPTION:
+
+Super-quick image resizing using the ImageMagick command line tools
+
+== FEATURES/PROBLEMS:
+
+ - Simple API
+ - 0% Overhead
+ - Uses the ImageMagick command line tools (convert, identify)
+
+	NOTE:
+	The API is going to be changing a lot as I try to lock down something really useful. As a quick git-er-done type doodad
+	it works really well, and I'm already using it on some very high volume production sites.
+
+== SYNOPSIS:
+
+
+	First things, first, Tell me where you keep them:
+	
+	
+	# Rails: production|development|etc.rb
+	# or somewhere that gets loaded before you initialize
+	
+	Imanip::Interface::Magick.execute_path = '/path/to/your/bins/' # eg /usr/local/bin/
+	
+
+	With an image file at /dir/image.jpg
+	
+	image = Imanip::Image.new('/dir/image.jpg')
+	
+	This will run identify on the image and make sure its convert-able. If it cant read or interpret it it will raise an Imanip::NotAnImageError.
+	Once you have the image you can check some properties/attributes
+	
+	image.width #=> 410 (Fixnum)
+	image.height #=> 100 (Fixnum)
+	image.format #=> JPEG (String)
+
+	There are also some helpers to do some rule based cropping.
+	
+	image.portrait? #=> false
+	image.landscape? #=> true
+	image.orientation #=> :landscape
+	
+	After that you can resize and whatever
+	
+	image.resize('outputfile.jpg', :dimensions => [200,100])
+	
+	I like crop_resize better. It crops AND resizes so you get an image of the exact pixel dimensions you desire.
+	
+	image.crop_resize('/file/to/output.jpg', :width => 50, :height => 50) #=> output file is an exact 50x50 image
+
+	You might also want to catch errors, because they will inevitably happen. Possible Errors
+	Imanip::Error # the root, the root, the root is on fire
+	Imanip::NotAnImageError # Descends from above, thrown during Imanip#Image.new
+	Imanip::CouldNotConvertError # Also from above, thrown if theres an issue with #resize or #crop_resize (options, etc.)
+
+	More examples coming soon.
+
+== REQUIREMENTS:
+
+	You need ImageMagick. Really any version will do, but I am developing with ImageMagick 6.3.3.
+	http://www.imagemagick.org/script/download.php
+	
+
+== INSTALL:
+
+	First, install ImageMagick:
+	http://www.imagemagick.org/script/download.php
+	
+	Make sure you get the command line tools:
+		
+	$ which 'convert'
+
+	Imanip works as a gem or a plugin for Rails.
+	
+	As a gem:
+	
+	$ sudo gem install imanip
+	
+	In Rails/environment.rb
+	config.gem 'imanip'
+
+	Or you can get the latest from github:
+	$ sudo gem sources -a http://gems.github.com
+	$ sudo gem install quirkey-imanip
+		
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Aaron Quint, Quirkey
+
+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

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'imanip/version'
+
+AUTHOR = 'Aaron Quint'  # can also be an array of Authors
+EMAIL = 'aaron@quirkey.com'
+DESCRIPTION = "Super-quick image resizing using the ImageMagick command line tools"
+GEM_NAME = 'imanip' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'quirkey' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Imanip::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'imanip documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.expand_path(File.dirname(__FILE__)) + "/lib/imanip"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/imanip.rb

@@ -0,0 +1,3 @@
+%w{image imanip_magick errors}.each do |lib|
+  require File.expand_path(File.dirname(__FILE__)) + "/imanip/#{lib}"
+end

data/lib/imanip/errors.rb

@@ -0,0 +1,5 @@
+module Imanip
+  class ImanipError < RuntimeError; end;
+  class NotAnImageError < ImanipError; end;
+  class CouldNotConvertError < ImanipError; end;
+end

data/lib/imanip/image.rb

@@ -0,0 +1,19 @@
+module Imanip
+  class Image
+    
+    def initialize(path,interface = :magick)
+      @image_path = path
+      load_interface(interface)
+    end
+    
+    private
+    def load_interface(interface)
+      @interface = Imanip::Interface.const_get("#{interface.to_s.capitalize}").new(@image_path)
+    end
+    
+    def method_missing(method, *args)
+      @interface.send(method,*args)
+    end
+    
+  end
+end

data/lib/imanip/imanip_magick.rb

@@ -0,0 +1,147 @@
+module Imanip
+  module Interface
+
+    class Magick
+      class << self
+        @execute_path = ''
+        attr_accessor :execute_path
+      end
+
+      attr_reader :width, :height, :format
+
+      def initialize(path)
+        @image_path = path
+        identify
+      end
+
+      def dimensions
+        [width,height]
+      end
+
+      def portrait?
+        width < height
+      end
+
+      def landscape?
+        width > height
+      end
+
+      def orientation
+        landscape? ? :landscape : :portrait
+      end
+
+      def crop(to_file, options = {})
+        @options = options
+        parse_size_options!
+        @options[:crop] = to_geometry_string(@geometry)
+        convert(to_file, options)
+      end
+
+      def resize(to_file, options = {})
+        @options = options
+        parse_size_options!
+        @options[:resize] = to_geometry_string(@geometry)
+        convert(to_file, @options)
+      end
+
+      def crop_resize(to_file, options = {})
+        @options = options.dup
+        parse_size_options!
+        crop_resize_string = ""
+        crop_width = @geometry[:width]
+        crop_height =  @geometry[:height]
+        if !(crop_height.nil? || crop_width.nil?)
+          if width == height
+            if portrait?
+              crop_resize_string << "-resize #{to_geometry_string(:width => crop_width)}"
+            else
+              crop_resize_string << "-resize #{to_geometry_string(:height => crop_height)}"
+            end
+          elsif portrait?
+            crop_resize_string << "-resize #{to_geometry_string(:width => crop_width)}"
+          else
+            crop_resize_string << "-resize #{to_geometry_string(:height => crop_height)}"
+          end
+        else
+          crop_resize_string << "-resize #{to_geometry_string(:height => crop_height, :width => crop_width)}"
+        end
+        gravity = @options.delete(:gravity) || 'North'
+        crop_resize_string << " -gravity '#{gravity}'"
+        crop_resize_string << " -crop #{to_geometry_string(@geometry)}+0+0"
+        crop_resize_string << " #{options_to_string(@options)}"
+        convert(to_file,crop_resize_string)
+      end
+      alias :crop_resized :crop_resize
+
+      def identify(options = {})
+        response = execute("#{execute_path}identify #{options_to_string(options)} #{@image_path}")
+        matches = response.match(/(JPEG|PNG|GIF)\ (\d+)x(\d+)/)
+        raise NotAnImageError, "Could not identify the image #{@image_path} as an image: #{response}" if matches.nil?
+        @format = matches[1]
+        @width = matches[2].to_i
+        @height = matches[3].to_i
+      end
+
+      def convert(to_file,options = {})
+        command = "#{execute_path}convert #{@image_path} #{options_to_string(options)} #{to_file}"
+        # puts command
+        response = execute(command)
+        # catch errors in response
+        possible_errors = [
+          /invalid argument/
+        ]
+        possible_errors.each do |error|
+          raise(CouldNotConvertError, response + " when " + command) if response =~ error
+        end
+        # assert that the new file exits
+        File.readable?(to_file) ? to_file : raise(CouldNotConvertError)
+      end
+
+      private
+
+      def parse_size_options!
+        @geometry = {}
+        if @options[:geometry]
+          width, height = @options.delete(:geometry).split('x')
+          @geometry = {:width => width, :height => height}
+        end
+        if @options[:dimensions]
+          width, height = @options.delete(:dimensions) 
+          @geometry = {:width => width, :height => height}
+        end
+        @geometry = {:width => @options.delete(:width), :height => @options.delete(:height) } if @options[:width] || @options[:height]
+        @geometry.collect {|d| d[1].to_i unless d.nil? }
+      end
+
+      def to_geometry_string(width_height)
+        # puts "width_height: #{width_height.inspect}"
+        case width_height
+        when Array
+          width_height.join("x")
+        when Hash
+          "#{width_height[:width]}x#{width_height[:height]}"
+        else
+          width_height.to_s
+        end
+      end
+
+      def options_to_string(options)
+        return options if options.is_a?(String)
+        option_string = ""
+        options.each do |name,value|
+          option_string << "-#{name} #{value} "
+        end
+        option_string
+      end
+
+      def execute(command)
+        `#{command} 2>&1`
+      end
+
+      def execute_path
+        self.class.execute_path
+      end
+    end
+
+  end
+end

data/lib/imanip/version.rb

@@ -0,0 +1,9 @@
+module Imanip #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+require 'test/unit'
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/imanip'))
+
+class Test::Unit::TestCase
+  
+  protected
+  def current_path
+    File.expand_path(File.dirname(__FILE__))
+  end
+  
+  def portrait_image_path
+    File.join(current_path,'portrait_test.jpg')
+  end
+  
+  def landscape_image_path
+    File.join(current_path,'landscape_test.jpg')
+  end
+  
+  def new_image_path
+    File.join(current_path, "new_file.jpg")
+  end
+  
+end

data/test/test_imanip_magick.rb

@@ -0,0 +1,94 @@
+# require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class ImanipMagickTest < Test::Unit::TestCase
+
+  def setup
+    @portrait_image = new_imanip_image(portrait_image_path)
+    @landscape_image  = new_imanip_image(landscape_image_path)
+  end
+  
+  def teardown
+    File.unlink(new_image_path) if File.readable?(new_image_path)
+  end
+
+  def test_should_raise_error_if_not_an_image
+    assert_raise(Imanip::NotAnImageError) do
+      new_imanip_image(__FILE__)
+    end
+  end
+  
+  def test_should_return_dimensions_as_array
+    dimensions = @portrait_image.dimensions
+    assert dimensions.is_a?(Array)
+    assert_equal [411,519], dimensions
+    
+    dimensions = @landscape_image.dimensions
+    assert dimensions.is_a?(Array)
+    assert_equal [400,315], dimensions
+  end
+  
+  def test_portrait_should_return_true_for_portrait_image
+    assert @portrait_image.portrait?
+  end
+  
+  def test_portrait_should_return_false_for_landscape_image
+    assert !@landscape_image.portrait?
+  end
+  
+  def test_landscape_should_return_true_for_landscape_image
+    assert @landscape_image.landscape? 
+  end
+  
+  def test_landscape_should_return_false_for_portrait_image
+    assert !@portrait_image.landscape?
+  end
+  
+  def test_resize_should_save_to_new_file
+    assert !File.readable?(new_image_path)
+    assert @portrait_image.resize(new_image_path, :width => 50)
+    assert File.readable?(new_image_path)
+  end
+  
+  def test_resize_should_resize_image_to_new_image_at_dimensions
+    dimensions = [100,126]
+    assert @portrait_image.resize(new_image_path, :dimensions => dimensions)
+    @new_image = new_imanip_image(new_image_path)
+    assert_equal dimensions, @new_image.dimensions
+  end
+  
+  def test_resize_should_resize_image_to_new_image_at_width
+    width = 100
+    assert @portrait_image.resize(new_image_path, :width => width)
+    @new_image = new_imanip_image(new_image_path)
+    assert_equal width, @new_image.width
+    assert_not_equal @portrait_image.height, @new_image.height
+  end
+  
+  def test_crop_resize_should_crop_and_resize_image_to_exact_dimensions
+    dimensions = [200,153]
+    assert @portrait_image.crop_resize(new_image_path, :dimensions => dimensions)
+    @new_image = new_imanip_image(new_image_path)
+    assert_equal dimensions, @new_image.dimensions
+  end
+  
+  def test_crop_resize_should_crop_and_resize_image_to_exact_dimensions_with_square_dimensions
+    dimensions = [100,100]
+    assert @landscape_image.crop_resize(new_image_path, :dimensions => dimensions)
+    @new_image = new_imanip_image(new_image_path)
+    assert_equal dimensions, @new_image.dimensions
+  end
+  
+  
+  def test_should_throw_errors_if_image_could_not_be_converted
+    assert_raise(Imanip::CouldNotConvertError) do
+       @portrait_image.resize(new_image_path, :v => "bad option")
+    end
+  end
+  
+  protected
+  def new_imanip_image(path,interface = :magick)
+    Imanip::Image.new(path,interface)
+  end
+  
+  
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: imanip
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Quint
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-13 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Super-quick image resizing using the ImageMagick command line tools
+email: 
+- aaron@quirkey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- init.rb
+- install.rb
+- lib/imanip.rb
+- lib/imanip/errors.rb
+- lib/imanip/image.rb
+- lib/imanip/imanip_magick.rb
+- lib/imanip/version.rb
+- test/landscape_test.jpg
+- test/portrait_test.jpg
+- test/test_helper.rb
+- test/test_imanip_magick.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://quirkey.rubyforge.org
+post_install_message: ""
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: quirkey
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Super-quick image resizing using the ImageMagick command line tools
+test_files: 
+- test/test_helper.rb
+- test/test_imanip_magick.rb