has_image 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,7 +1,11 @@
 2008-07-28 Norman Clarke <norman@randomba.org>
 
+  * Added sorted thumbnail processing. This improves thumbnail generation
+    speed by about 25% for 4.5 meg jpegs with 5 thumbnails.
+  * Fixed broken resize for non-fixed-width thumbnails.
+  * Added check for bad geometry strings.
   * Added dependencies and Rubyforge project to gemspec, updated docs.
-  
+
 2008-07-25 Norman Clarke <norman@randomba.org>
 
 	* First public release.	

data/lib/has_image/processor.rb

@@ -8,6 +8,21 @@ module HasImage
     attr_accessor :options
     
     class << self
+      
+      # Given a geometry string, return the maxium possible output dimensions.
+      # For example:
+      #   area("50x50>") == 2500 
+      def area(dimensions)
+        dimensions.split("x")[0].to_i * dimensions.split("x")[1].to_i 
+      end
+
+      # "The form of an {extended geometry
+      # string}[http://www.imagemagick.org/script/command-line-options.php?#resize] is
+      # <width>x<height>{+-}<xoffset>{+-}<yoffset>{%}{!}{<}{>}"
+      def geometry_string_valid?(string)
+        string =~ /\A[\d]*x[\d]*([+-][0-9][+-][0-9])?[%@!<>^]?\Z/
+      end
+      
       # Arg should be either a file, or a path. This runs ImageMagick's
       # "identify" command and looks for an exit status indicating an error. If
       # there is no error, then ImageMagick has identified the file as something
@@ -30,6 +45,7 @@ module HasImage
     # format if necessary. The size should be a valid ImageMagick {geometry
     # string}[http://www.imagemagick.org/script/command-line-options.php#resize].
     def resize(file, size)
+      raise InvalidGeometryError.new unless Processor.geometry_string_valid?(size)
       silence_stderr do
         path = file.respond_to?(:path) ? file.path : file
         file.close if file.respond_to?(:close) && !file.closed?
@@ -55,9 +71,15 @@ module HasImage
       @image.combine_options do |commands|
         commands.send("auto-orient".to_sym)
         commands.strip
-        commands.resize "#{size}^"
-        commands.gravity "center"
-        commands.extent size
+        # Fixed-dimension images
+        if size =~ /\A[\d]*x[\d]*!?\Z/
+          commands.resize "#{size}^"
+          commands.gravity "center"
+          commands.extent size
+        # Non-fixed-dimension images
+        else
+          commands.resize "#{size}"
+        end
         commands.quality options[:output_quality]
       end
     end

data/lib/has_image/storage.rb

@@ -105,6 +105,26 @@ module HasImage
       options[:convert_to].to_s.downcase.gsub("jpeg", "jpg")
     end
     
+    # Returns the options[:thumbnails] hash, coverted to an array and sorted
+    # by thumbnail area, highest to lowest. For example:
+    #
+    #   options[:thumbnails] == {:a => "20x20", :b => "2x2", :c => "100x100"}
+    #   sorted_thumbnails == [[:c, "100x100"], [:a, "20x20"], [:b, "2x2"]]
+    #
+    # This is done to speed up processing images with several thumbnails. Rather
+    # than create the thumbnail starting from the highest quality version each
+    # time, the next biggest thumbnail is used as the base image for its
+    # immediately smaller variant. For example, given an image with 3 thumbnails
+    # HasImage will use the 800x800 as the basis of the 500x500, and then the
+    # 500x500 as the basis of the 200x200, etc. My benchmarks showed that this
+    # will speed up processing by up to around 25% for a 4.5 meg JPEG with 5
+    # thumbnails.
+    def sorted_thumbnails
+      options[:thumbnails].to_a.sort do |b,a| 
+        Processor.area(a[1]) <=> Processor.area(b[1])
+      end
+    end
+
     private
     
     # File name, plus thumbnail suffix, plus extension. For example:
@@ -141,13 +161,14 @@ module HasImage
     def install_thumbnails(id, name)
       FileUtils.mkdir_p path_for(id)
       path = File.join(path_for(id), file_name_for(name))
-      options[:thumbnails].each do |thumb_name, size|
-        thumb = processor.resize(path, size)
-        thumb.write(File.join(path_for(id), file_name_for(name, thumb_name)))
+      sorted_thumbnails.each do |t|
+        thumb = processor.resize(path, t[1])
+        path = File.join(path_for(id), file_name_for(name, t[0]))
+        thumb.write(path)
         thumb.tempfile.close!
       end
     end
-    
+
     # Get the full path for the id. For example:
     #
     #  /var/sites/example.org/production/public/photos/0000/0001

data/lib/has_image.rb

@@ -64,9 +64,10 @@ require 'has_image/view_helpers'
 module HasImage
 
   class ProcessorError < StandardError ; end
-  class StorageError < StandardError ; end  
-  class FileTooBigError < StorageError ; end  
-  class FileTooSmallError < StorageError ; end  
+  class StorageError < StandardError ; end
+  class FileTooBigError < StorageError ; end
+  class FileTooSmallError < StorageError ; end
+  class InvalidGeometryError < ProcessorError ; end
   
   class << self
     

data/test/processor_test.rb

@@ -13,6 +13,10 @@ class StorageTest < Test::Unit::TestCase
     return @temp_file
   end
   
+  def test_area
+    assert_equal 2500, HasImage::Processor.area("50x50>")
+  end
+  
   def test_detect_valid_image
     assert HasImage::Processor.valid?(File.dirname(__FILE__) + "/../test_rails/fixtures/image.jpg")
   end
@@ -28,12 +32,24 @@ class StorageTest < Test::Unit::TestCase
   def test_detect_invalid_image_from_tmp_file
     assert !HasImage::Processor.valid?(temp_file("bad_image.jpg"))
   end
+
+  def test_resize_with_invalid_geometry
+    @processor = HasImage::Processor.new({:convert_to => "JPEG", :output_quality => "85"})
+    assert_raises HasImage::InvalidGeometryError do
+      @processor.resize(temp_file("image.jpg"), "bad_geometry")
+    end
+  end
   
-  def test_resize
+  def test_resize_fixed
     @processor = HasImage::Processor.new({:convert_to => "JPEG", :output_quality => "85"})
     assert @processor.resize(temp_file("image.jpg"), "100x100")
   end
 
+  def test_resize_unfixed
+    @processor = HasImage::Processor.new({:convert_to => "JPEG", :output_quality => "85"})
+    assert @processor.resize(temp_file("image.jpg"), "1024x768>")
+  end
+
   def test_resize_and_convert
     @processor = HasImage::Processor.new({:convert_to => "JPEG", :output_quality => "85"})
     assert @processor.resize(temp_file("image.png"), "100x100")

data/test/storage_test.rb

@@ -16,6 +16,13 @@ class StorageTest < Test::Unit::TestCase
     )
   end
   
+  def test_sorted_thumbnails
+    thumbs = {:a => "20x20", :b => "2x2", :c => "100x100"}
+    sorted = [[:c, "100x100"], [:a, "20x20"], [:b, "2x2"]]
+    @storage = HasImage::Storage.new(default_options.merge(:thumbnails => thumbs))
+    assert_equal sorted, @storage.send(:sorted_thumbnails) 
+  end
+  
   def test_partitioned_path
     assert_equal(["0001", "2345"], HasImage::Storage.partitioned_path("12345"))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: has_image
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Norman Clarke