imforger 0.1.1 → 0.2.2

data/.autotest

@@ -1,23 +0,0 @@
-# -*- ruby -*-
-
-require 'autotest/restart'
-
-# Autotest.add_hook :initialize do |at|
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception 'vendor'
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-# end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler"
+  gem "hoe"
+  gem "hoe-git"
+  gem "hoe-doofus"
+  gem "hoe-gemcutter"
+  gem "rake-compiler"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gemcutter (0.7.0)
+    hoe (2.9.1)
+      rake (>= 0.8.7)
+    hoe-doofus (1.0.0)
+    hoe-gemcutter (1.0.0)
+      gemcutter (>= 0.1.3)
+      hoe (>= 2.3.3)
+    hoe-git (1.3.0)
+      hoe (>= 2.2.0)
+    rake (0.8.7)
+    rake-compiler (0.7.6)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  hoe
+  hoe-doofus
+  hoe-gemcutter
+  hoe-git
+  rake-compiler

data/History.txt

@@ -1,6 +1,18 @@
-=== 1.0.0 / 2011-03-25
+=== 0.2.2 / 2011-03-31
 
-* 1 major enhancement
+* Supports explicit format declaration:
 
-  * Birthday!
+Imforger.new(input_file_path).to_file(output_file_path, :format => 'tif')
+
+=== 0.2.1 / 2011-03-31
+
+* Deghettofied the options to use symbols instead of string:
+
+Imforger.new(input_file_path).to_file(output_file_path, :width => 100,
+:height => 100)
+
+=== 0.2.0 / 2011-03-31
+
+* Library now supports :maxwidth, :maxheight
+* Includes benchmark/benchmark.rb
 

data/Manifest.txt

@@ -1,10 +1,15 @@
 .autotest
+Gemfile
+Gemfile.lock
 History.txt
 Manifest.txt
 README.txt
 Rakefile
+benchmark/benchmark.rb
 ext/imforger/extconf.rb
 ext/imforger/imforger.c
 lib/imforger.rb
+lib/imforger.so
+test/fixtures/large.original.jpg
 test/helper.rb
 test/test_imforger.rb

data/README.txt

@@ -2,11 +2,15 @@
 
 == DESCRIPTION:
 
-Imforger relies on the Imlib2 library to quickly convert between different file types, scaling and compressing on the way.
+Imforger
+[short for Image Forger, because we are making copies of images]
+
+This class relies on the Imlib2 library to quickly convert between different file types, scaling and compressing on the way.
 
 == FEATURES/PROBLEMS:
 
-As far as I know, this gem only works on Linux and Ruby 1.9+
+As far as I know, this gem only works on Linux and Ruby 1.9+  Anyone
+know how to install the dev files for Imlib2, please let me know.
 
 Imlib2 drops the ICC profile and XMP tags when it creates the new image.  I have been using exiftool to copy the ICC profile and XMP tags over.  This is still much faster than ImageMagick et al.
 
@@ -15,6 +19,18 @@ Imlib2 drops the ICC profile and XMP tags when it creates the new image.  I have
 require 'imforger'
 Imforger.new(input_file_path).to_file(output_file_path)
 
+or:
+
+Imforger.new(input_file_path).to_file(output_file_path, :width => 100,
+:height => 100)
+
+or:
+
+Imforger.new(input_file_path).to_file(output_file_path, :maxwidth => 1000,
+:maxheight => 1000, :format => 'tif')
+
+See the test file for other examples.
+
 == REQUIREMENTS:
 
 Imlib2
@@ -25,7 +41,21 @@ gem install imforger
 
 == SPEED:
 
-ImageMagick was too slow and used too much memory.  [I didn't even bother frobnicating with RMagick.]  I also compared to the NetPBM library for good measure.
+The purpose of this gem is to scale images and save them out quickly.  ImageMagick was too slow and used too much memory.  [I didn't even bother frobnicating with RMagick.]  I include a benchmark that I used in the benchmark dir.  Results belew.  I also compared to the NetPBM library for good measure.
+
+$ ruby benchmark/benchmark.rb
+
+                  user     system      total        real
+ImageMagick   0.000000   0.010000   1.710000 (  0.729113)
+NetPBM        0.000000   0.000000   0.700000 (  0.391043)
+Imforger      0.310000   0.010000   0.320000 (  0.321695)
+
+Changing the input file size and format showed similar results: Imforger
+is roughly twice as fast as calling out ImageMagick in realtime on a
+dual-core laptop, and also
+noticeably faster than NetPBM.  I don't include memory usage numbers
+here, but anecdotally I did notice significantly less RAM usage with Imforger vs
+ImageMagick.
 
 == LICENSE:
 

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'psych'
 require 'hoe'
 
 class Hoe

data/benchmark/benchmark.rb

@@ -0,0 +1,45 @@
+require 'imforger'
+require 'benchmark'
+require 'fileutils'
+require 'open3'
+
+Benchmark.bm(12) do |x|
+  #test these image scaling methods
+  benchmark = [
+    :imagemagick,
+    :netpbm,
+    :imlib
+  ]
+
+  @original_file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'test', 'fixtures', 'large.original.jpg'))
+  @input_file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'input.jpg'))
+  @output_file = lambda{|type| File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', "output.#{type}.jpg"))}
+
+  #prep the files
+  raise "Cannot find original file #{@original_file}." unless File.exist?(@original_file)
+  FileUtils.cp(@original_file, @input_file)
+
+  #silence stupid pnmtojpeg
+  $stderr.reopen(File.open('/dev/null','w+'))
+
+  x.report("ImageMagick") do
+    `convert #{@input_file} -resize 100x100\! #{@output_file.call('ImageMagick')}`
+  end if benchmark.include?(:imagemagick)
+
+  x.report("NetPBM") do
+    `/usr/bin/anytopnm #{@input_file} | /usr/bin/pamscale -width 100 -height 100 | /usr/bin/pnmtojpeg > #{@output_file.call('NetPBM')}`
+  end if benchmark.include?(:netpbm)
+
+  x.report("Imlib") do
+    fr = Imforger.new @input_file
+    fr.to_file "#{@output_file.call('Imlib')}", :width => 100, :height => 100
+  end if benchmark.include?(:imlib)
+
+  #cleanup files
+  if true  && false
+    FileUtils.rm @input_file
+    [ 'ImageMagick', 'NetPBM', 'Imforger'].each do |type|
+      FileUtils.rm @output_file.call(type)
+    end
+  end
+end

data/ext/imforger/imforger.c

@@ -10,21 +10,35 @@
 /* ruby */
 #include <ruby.h>
 
-static VALUE imforger_save_file(VALUE self, VALUE anObject)
+static VALUE imforger_save_file(VALUE self, VALUE outputString)
 {
-  VALUE input_image;
-  VALUE output_image;
+  VALUE r_input_image;
+  VALUE r_output_image;
+  VALUE r_options;
+  VALUE r_width;
+  VALUE r_height;
+  VALUE r_maxwidth;
+  VALUE r_maxheight;
+  VALUE r_format;
+
   char *imagePath1;
   char *imagePath2;
+  char *format;
+
+  int width;
+  int height;
+  float scale;
+
   /* image handles */
   Imlib_Image image1;
   Imlib_Image image2;
 
-  input_image = rb_iv_get(self, "@input_image");
-  output_image = rb_iv_set(self, "@output_image", anObject);
+  r_input_image  = rb_iv_get(self, "@input_image");
+  r_output_image = rb_iv_set(self, "@output_image", outputString);
+  r_options      = rb_iv_get(self, "@options");
 
-  imagePath1 = StringValuePtr(input_image);
-  imagePath2 = StringValuePtr(output_image);
+  imagePath1 = StringValuePtr(r_input_image);
+  imagePath2 = StringValuePtr(r_output_image);
 
   /* check that the file exists and can be read */
   /* TODO: raise a real error */
@@ -40,17 +54,57 @@ static VALUE imforger_save_file(VALUE self, VALUE anObject)
     char *tmp;
     /* set the image1 we loaded as the current context image1 to work on */
     imlib_context_set_image(image1);
-    /* set the image1 format to be the format of the extension of our last */
+
+    /* if the width and height were set, use that; otherwise use the
+     * current dimensions */
+    r_width  = rb_hash_aref(r_options, ID2SYM(rb_intern("width")));
+    r_height = rb_hash_aref(r_options, ID2SYM(rb_intern("height")));
+    if(r_width == Qnil){
+      width = imlib_image_get_width();
+    } else {
+      width = NUM2INT(r_width);
+    }
+    if(r_height == Qnil){
+      height = imlib_image_get_height();
+    } else {
+      height = NUM2INT(r_height);
+    }
+
+    /* going for maximum height */
+    r_maxwidth  = rb_hash_aref(r_options, ID2SYM(rb_intern("maxwidth")));
+    r_maxheight = rb_hash_aref(r_options, ID2SYM(rb_intern("maxheight")));
+    if(r_maxwidth != Qnil){
+      if(width > NUM2INT(r_maxwidth)){
+        scale  = NUM2INT(r_maxwidth) / (float)width;
+        width  = NUM2INT(r_maxwidth);
+        height = (int)(scale * height);
+      }
+    }
+    if(r_maxheight != Qnil){
+      if(height > NUM2INT(r_maxheight)){
+        scale  = NUM2INT(r_maxheight) / (float)height;
+        height = NUM2INT(r_maxheight);
+        width  = (int)(scale * width);
+      }
+    }
+
+    /* set the image1 format 
+     * to be the format of the extension of our last */
     /* argument - i.e. .png = png, .tif = tiff etc. */
-    tmp = strrchr(imagePath2, '.');
-      if(tmp)
-        imlib_context_set_anti_alias(1);
-        image2 = imlib_create_cropped_scaled_image(0,0,imlib_image_get_width(),imlib_image_get_height(),100,100);
-        imlib_context_set_image(image2);
-        imlib_image_set_format(tmp + 1);
-      /* save the image1 */
-      imlib_save_image(imagePath2);
+    r_format = rb_hash_aref(r_options, ID2SYM(rb_intern("format")));
+    if(r_format != Qnil){
+      format = StringValuePtr(r_format);
+    } else {
+      tmp = strrchr(imagePath2, '.');
+      format = (tmp + 1);
     }
+    imlib_context_set_anti_alias(1);
+    image2 = imlib_create_cropped_scaled_image(0,0,imlib_image_get_width(),imlib_image_get_height(),width,height);
+    imlib_context_set_image(image2);
+    imlib_image_set_format(format);
+    /* save the image1 */
+    imlib_save_image(imagePath2);
+  }
   return Qtrue;
 }
 

data/lib/imforger.rb

@@ -1,9 +1,9 @@
 require 'imforger.so'
 
 class Imforger
-  VERSION = '0.1.1'
+  VERSION = '0.2.2'
 
-  attr_accessor :input_image, :output_image
+  attr_accessor :input_image, :output_image, :options
 
   class Exception < RuntimeError; end
 
@@ -12,9 +12,20 @@ class Imforger
 
     raise(Imforger::Exception, "Input file not found!") unless File.exists?(path)
     @input_image = path
+    @options = {}
   end
 
-  def to_file(output_path)
+  def to_file(output_path, opts = {})
+    @options.merge!(opts)
+    check_format
+
     save_file(File.expand_path(output_path))
   end
+
+private
+  def check_format
+    if @options[:format]
+      raise(Imforger::Exception, "I don't know if that file format is supported!") unless %w(tif png jpg).include?(@options[:format])
+    end
+  end
 end

data/test/test_imforger.rb

@@ -1,9 +1,60 @@
 require 'helper'
+require 'fileutils'
 
 class TestImforger < MiniTest::Unit::TestCase
+  def setup
+    @original_file = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'large.original.jpg'))
+    @input_file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'input.jpg'))
+    @output_file = lambda{|type| File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', "output.#{type}.jpg"))}
+
+    #prep the files
+    raise "Cannot find original file #{@original_file}." unless File.exist?(@original_file)
+    FileUtils.cp(@original_file, @input_file)
+  end
+
   def test_raise_an_error_if_no_path_to_file
     assert_raises Imforger::Exception do
       Imforger.new('./this_file_doesnt_exist')
     end
   end
+
+  def test_creates_new_image
+    path = @output_file.call('copy')
+
+    fr = Imforger.new @input_file
+    fr.to_file path
+    assert File.exists?(path)
+    assert File.size(path) > 1500000
+  end
+
+  def test_creates_new_image_smaller_size
+    path = @output_file.call('smaller')
+
+    fr = Imforger.new @input_file
+    fr.to_file path, :width => 100, :height => 100
+    assert File.size(path) > 3000
+  end
+
+  def test_creates_new_bounded_size
+    path = @output_file.call('bounded')
+
+    fr = Imforger.new @input_file
+    fr.to_file path, :maxwidth => 117, :maxheight => 120
+    assert File.size(path) > 3900
+  end
+
+  def test_creates_new_image_different_format
+    %w(tif png jpg).each do |extension|
+      path = "#{@output_file.call('format')}.#{extension}"
+      fr = Imforger.new(@input_file).to_file(path, :format => extension)
+      assert((File.size(path) > 1500000), "Could not create file of type #{extension}.")
+    end
+  end
+
+  def test_raises_an_error_if_unknown_format
+    fr = Imforger.new @input_file
+    assert_raises Imforger::Exception do
+      fr.to_file '/dev/null', :format => 'pizza'
+    end
+  end
 end

metadata

@@ -1,111 +1,139 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: imforger
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.2
   prerelease: 
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Casey Rosenthal
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
+cert_chain:
+- ! '-----BEGIN CERTIFICATE-----
+
   MIIDKjCCAhKgAwIBAgIBADANBgkqhkiG9w0BAQUFADA7MQwwCgYDVQQDDANjbHIx
+
   FjAUBgoJkiaJk/IsZAEZFgZwb3J0NDkxEzARBgoJkiaJk/IsZAEZFgNjb20wHhcN
+
   MTEwMzI1MjIyNTA2WhcNMTIwMzI0MjIyNTA2WjA7MQwwCgYDVQQDDANjbHIxFjAU
+
   BgoJkiaJk/IsZAEZFgZwb3J0NDkxEzARBgoJkiaJk/IsZAEZFgNjb20wggEiMA0G
+
   CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFO65jA8Vm6mrySAEh0p9zMJ/c8pif
+
   AwrL8K/fQzBOD8WjaHbt3WlDut4tBtzBpspaObbszg0QhH8ixvdIteaNaqWt5ivB
+
   85BPy2NV/yBBhKZ3JshlivgcKr6RRwP/NfwVVWXMBCmX6d1/9hicHES7gLP61RLY
+
   a13gfyuVSm1FipnzIWrgj1ArEQvLc5Qzp08ekolU3xvTQaItDPCh2ImaCixhlFaV
+
   SZxGk2HEv5sdK2HiZfdN4P8dVBhWEK+HXh4WuyqivGI0mHioQNrAU2VSka0NN/dZ
+
   NysVmj3E+P3EQaSJ1Apey6WVgozw/Jd2tRrcPp4bvNTcMcstXxDDdajLAgMBAAGj
+
   OTA3MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJGwO8OOOSuETTTIgEHrFaPYZY50MAsG
+
   A1UdDwQEAwIEsDANBgkqhkiG9w0BAQUFAAOCAQEAFZq0kRxt5VII27uV/lReyzAz
+
   q5MWDtOv8hgUcF6DqsR8vMwYUtbl8CpKerY7CCdq8SBgI73gTSg0FlKhu/TWJyVS
+
   vbD8qTsLMSJ1eagrRzY0W/hbl07CdFAunPKYw9vIOsQXBDLPoJoPogpSkbTGaUnD
+
   NqVRcPwXgmwCdlJYOOBXh6QxArisZ/dFNtVZY2zUJCfdxpUwlXEtNvh9z+502nWp
+
   B5PckRdTFq05psR5w5RInK0QZstX464GDSUs+CL7JvwXJKtnDGLb4/+xY3j5a/f6
+
   ZZgY9wEKsxYB1Clu7uMdVBMb1hI4Kr/k6wDqXfpoZW9ltiyjmmgWvWAfPEsgSg==
+
   -----END CERTIFICATE-----
 
-date: 2011-03-25 00:00:00 -07:00
+'
+date: 2011-03-31 00:00:00.000000000 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake-compiler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &16507700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.1
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *16507700
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &16475160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.9.1
   type: :development
-  version_requirements: *id002
-description: Imforger relies on the Imlib2 library to quickly convert between different file types, scaling and compressing on the way.
-email: 
+  prerelease: false
+  version_requirements: *16475160
+description: ! 'Imforger
+
+  [short for Image Forger, because we are making copies of images]
+
+
+  This class relies on the Imlib2 library to quickly convert between different file
+  types, scaling and compressing on the way.'
+email:
 - clr@port49.com
 executables: []
-
-extensions: 
+extensions:
 - ext/imforger/extconf.rb
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
-files: 
+files:
 - .autotest
+- Gemfile
+- Gemfile.lock
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
+- benchmark/benchmark.rb
 - ext/imforger/extconf.rb
 - ext/imforger/imforger.c
 - lib/imforger.rb
+- lib/imforger.so
+- test/fixtures/large.original.jpg
 - test/helper.rb
 - test/test_imforger.rb
 - .gemtest
 has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: imforger
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Imforger relies on the Imlib2 library to quickly convert between different file types, scaling and compressing on the way.
-test_files: 
+summary: Imforger [short for Image Forger, because we are making copies of images]  This
+  class relies on the Imlib2 library to quickly convert between different file types,
+  scaling and compressing on the way.
+test_files:
 - test/test_imforger.rb