image_proc 0.1.1 → 1.0.1

data/History.txt

@@ -1,10 +1,12 @@
 === 1.0.1 / 2009-01-09
 
-* Small updates to Hoe and other software rot prevention
+* Remove the old geometry string API
 
-  * Birthday!
+=== 0.1.1 / 2009-01-09
+
+* Small updates to Hoe and other software rot prevention
 
-=== 1.0.0 / 2009-01-09
+=== 0.1.0 / 2009-01-09
 
 * 1 major enhancement
 

data/README.txt

@@ -2,6 +2,11 @@
 
 * http://wiretap.rubyforge.org/image_proc
 
+== SYNPOSIS
+
+    require "image_proc"
+    ImageProc.resize("/tmp/source_file.jpg", :width => 128, :height => 200, :fill => :true)
+
 == DESCRIPTION:
 
 A no-frills image resizer, with pluggable backends. No extra software required on OS X

data/lib/image_proc.rb

@@ -4,12 +4,12 @@ require 'open3'
 # design. Sort of like the Processors in attachment_fu but less. Less.
 #
 #    width, height = ImageProc.get_bounds("image.png")
-#    thumb_filename = ImageProc.resize("image.png", "thumb.png", "50x50")
+#    thumb_filename = ImageProc.resize("image.png", "thumb.png", :width => 50. :height => 50)
 #
 # The whole idea is: a backend does not have to support cropping (we don't do it), it has only to be able to resize,
 # and a backend should have 2 public methods. That's the game.
 class ImageProc
-  VERSION = '0.1.1'
+  VERSION = '1.0.1'
 
   class Error < RuntimeError; end
   class MissingInput < Error; end
@@ -41,12 +41,12 @@ class ImageProc
     
     # Tries to detect the best engine available
     def detect_engine
-      if RUBY_PLATFORM =~ /darwin/i
-        ImageProcSips
-      elsif (`which convert` =~ /^\// )
+      if (`which convert` =~ /^\// )
         ImageProcConvert
+      elsif RUBY_PLATFORM =~ /darwin/i
+        ImageProcSips
       else
-        raise "This system has no image processing facitilites that we can use"
+        raise "This system has no image processing facitilites that we can use. Time to compile RMagick or install a decent OS."
       end
     end
     
@@ -61,20 +61,13 @@ class ImageProc
     end
   end
   
-  # Deprecated - pass the fitting as geometry string. Will use proportional fitting.
-  def resize(from, to, geom)
-    to_width, to_height = geom.scan(/(\d+)/).flatten
-    resize_fit_both(from, to, to_width, to_height).shift
-  end
-  alias_method :process, :resize
-  
-  # Resizes with specific options passed as a hash
-  #   ImageProc.resize_with_options "/tmp/foo.jpg", "bla.jpg", :width => 120, :height => 30
-  def resize_with_options(from_path, to_path, opts = {})
+  # Resizes with specific options passed as a hash, and return the destination path to the resized image
+  #   ImageProc.resize "/tmp/foo.jpg", "bla.jpg", :width => 120, :height => 30
+  def resize(from_path, to_path, opts = {})
     # raise InvalidOptions,
     #   "The only allowed options are :width, :height and :fill" if (opts.keys - [:width, :height, :fill]).any?
-    raise InvalidOptions,
-      "Pass width, height or both" unless (opts.keys & [:width, :height]).any?
+    raise InvalidOptions, "Geometry string is no longer supported as argument for resize()" if opts.is_a?(String)
+    raise InvalidOptions, "Pass width, height or both" unless (opts.keys & [:width, :height]).any?
     opts.each_pair { |k,v|  raise InvalidOptions, "#{k.inspect} cannot be set to nil" if v.nil? }
     
     if opts[:width] && opts[:height] && opts[:fill]
@@ -88,6 +81,7 @@ class ImageProc
     else
       raise "This should never happen"
     end
+    to_path
   end
   
   # Resize an image fitting the biggest side of it to the side of a square. A must for thumbs.
@@ -186,13 +180,19 @@ class ImageProc
   # It's recommended to clip the image which will be created with these bounds using CSS, as not all resizers support
   # cropping - and besides it's just too many vars.
   def fit_sizes_with_crop(bounds, opts)
-    raise Error, "fit_sizes_with_crop requires both width and height" unless (opts.keys & [:width, :height]).length == 2
+    force_keys!(opts, :width, :height)
     scale = [opts[:width].to_f / bounds[0], opts[:height].to_f / bounds[1]].sort.pop
     result = [bounds[0] * scale, bounds[1] * scale]
     result.map{|e| e.round}
   end
   
   private
+    def force_keys!(in_hash, *keynames)
+      unless (in_hash.keys & keynames).length == keynames.length
+        raise Error, "This method requires #{keynames.join(', ')}" 
+      end
+    end
+    
     def prevent_zeroes_in(floats)
       floats.map!{|f| r = f.round.to_i; (r.zero? ? 1 : r) }
     end
@@ -244,7 +244,7 @@ ImageProc.keep_quiet do
   class ImageProcConvert < ImageProc
     HARMLESS = [/unknown field with tag/]
     def process_exact
-      wrap_stderr("convert -resize #{@target_w}x#{@target_h}! #{@source} #{@dest}")
+      wrap_stderr("convert -filter Gaussian -resize #{@target_w}x#{@target_h}! #{@source} #{@dest}")
     end
   
     def get_bounds(of)

data/test/resize_test_helper.rb

@@ -36,7 +36,8 @@ module ResizeTestHelper
   
   def test_resize_raises_when_trying_to_overwrite
     assert_raise(ImageProc::NoOverwrites) do
-      @processor.resize INPUTS + '/' + @landscapes[0], INPUTS + '/' + @portraits[0], "100x100"
+      @processor.resize INPUTS + '/' + @landscapes[0], INPUTS + '/' + @portraits[0], 
+        :width => 100, :height => 100
     end
   end
   
@@ -44,7 +45,8 @@ module ResizeTestHelper
     missing_input = "/tmp/___imageproc_missing.jpg"
     assert !File.exist?(missing_input)
     assert_raise(ImageProc::MissingInput) do
-      @processor.resize missing_input, OUTPUTS + '/zeoutput.jpg', "100x100"
+      @processor.resize missing_input, OUTPUTS + '/zeoutput.jpg', 
+        :width => 100, :height => 100
     end
   end
   
@@ -54,7 +56,7 @@ module ResizeTestHelper
     
     assert !File.exist?(File.dirname(missing_output))
     assert_raise(ImageProc::NoDestinationDir) do
-      @processor.resize from, missing_output, "100x100"
+      @processor.resize from, missing_output, :width => 100, :height => 100
     end    
   end
   
@@ -147,7 +149,7 @@ module ResizeTestHelper
   
   def test_resize_is_alias_for_fit_with_geometry_string
      with_each_horizontal_path_and_name do | source, name |
-       assert_nothing_raised { @processor.resize(source, OUTPUTS + '/' + name, "300x300") }
+       assert_nothing_raised { @processor.resize(source, OUTPUTS + '/' + name, :width => 300, :height => 300) }
      
        result_p = OUTPUTS + '/' + File.basename(source)
        assert File.exist?(result_p), "#{result_p} should have been created"
@@ -156,8 +158,7 @@ module ResizeTestHelper
    
      with_each_vertical_path_and_name do | source, name |
        assert_nothing_raised do
-          path = @processor.resize(source, OUTPUTS + '/' + name, "300x300")
-          assert_kind_of String, path, "ImageProc#resize is legacy so it should return the path and nothing else"
+          path = @processor.resize(source, OUTPUTS + '/' + name, :width => 300, :height => 300)
           assert_equal OUTPUTS + '/' + File.basename(source), path, "The proc should return the path to the result"
        end
        

data/test/test_image_proc.rb

@@ -19,7 +19,7 @@ class TestQuickProcessWithOptions < Test::Unit::TestCase
     opts = {:height=>75, :fill=>true}
     begin
       assert_nothing_raised do
-        path, w, h = ImageProc.resize_with_options(source, dest, opts)
+        path, w, h = ImageProc.resize(source, dest, opts)
       end
     ensure
       File.unlink(dest) rescue nil
@@ -31,14 +31,14 @@ class TestQuickProcessWithOptions < Test::Unit::TestCase
       source = File.dirname(__FILE__) + '/input/horizontal.jpg'
       dest = File.dirname(__FILE__) + '/output/resized.jpg'
       opts = {:too => 4, :doo => 10}
-      ImageProc.resize_with_options(source, dest, opts)
+      ImageProc.resize(source, dest, opts)
     end
 
     assert_raise(ImageProc::InvalidOptions) do
       source = File.dirname(__FILE__) + '/input/horizontal.jpg'
       dest = File.dirname(__FILE__) + '/output/resized.jpg'
       opts = {}
-      ImageProc.resize_with_options(source, dest, opts)
+      ImageProc.resize(source, dest, opts)
     end
   end
 end
@@ -63,13 +63,13 @@ if RUBY_PLATFORM =~ /darwin/i
   
     def test_sips_does_not_grok_pngs
       assert_raise(ImageProc::FormatUnsupported) do
-        @processor.resize(INPUTS + '/horizontal.gif', OUTPUTS + '/horizontal.gif', "100x100")
+        @processor.resize(INPUTS + '/horizontal.gif', OUTPUTS + '/horizontal.gif', :width=> 100, :height => 100)
       end
     end
   
     def test_sips_does_not_grok_gifs
       assert_raise(ImageProc::FormatUnsupported) do
-        @processor.resize(INPUTS + '/horizontal.png', OUTPUTS + '/horizontal.png', "100x100")
+        @processor.resize(INPUTS + '/horizontal.png', OUTPUTS + '/horizontal.png', :width=> 100, :height => 100)
       end
     end
   

metadata

@@ -2,7 +2,7 @@
 name: image_proc
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Julik
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-28 00:00:00 Z
+date: 2011-07-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe