image_squeeze 0.1.0 → 0.1.1

data/README.md

@@ -6,6 +6,8 @@ A library for automated lossless image optimization
 
 The default processors depend on ImageMagick, pngcrush, gifsicle, and jpegtran.  ImageMagick is required for all processors.
 
+    gem install image_squeeze
+
 ## Usage
 
     # set up an ImageSqueeze with the default processors

data/lib/image_squeeze.rb

@@ -1,6 +1,8 @@
 $:.unshift File.dirname(__FILE__)
 
+require 'tempfile'
 require 'logger'
+
 require 'image_squeeze/log_factory'
 require 'image_squeeze/utils'
 require 'image_squeeze/image_identifier'
@@ -16,8 +18,9 @@ require 'image_squeeze/processors/gif_to_png_processor'
 
 class ImageSqueeze
   attr_reader :processors
+  attr_reader :tmpdir
   
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   
   # Image Types
   GIF = 'gif'
@@ -40,6 +43,8 @@ class ImageSqueeze
     
     @processors = options[:processors] || []
     @processors += self.class.default_processors if options[:default_processors]
+    
+    @tmpdir = options[:tmpdir] || Dir::tmpdir
   end
   
   def self.default
@@ -55,7 +60,8 @@ class ImageSqueeze
     
     original_file_size = File.size(filename)
     sorted_results = processors.map do |processor_class|
-      output_filename = processor_class.squeeze_to_tmp(filename)
+      output_filename = tmp_filename(filename)
+      processor_class.squeeze(filename, output_filename)
       output_file_size = File.size(output_filename)
       result_options = { :filename => filename, :output_filename => output_filename, :bytes_saved => original_file_size - output_file_size, :output_extension => processor_class.output_extension }
       Result.new(result_options)
@@ -87,22 +93,35 @@ class ImageSqueeze
     output_filename
   end
   
-  def logger
+  def self.logger
     LogFactory.logger
   end
   
+  def logger
+    self.class.logger
+  end
+  
   def self.default_processors
     processors = []
-    ImageSqueeze::Utils.image_utility_available?('identify', 'all image', Logger::ERROR)
-    if ImageSqueeze::Utils.image_utility_available?('pngcrush', 'pngs and gif', Logger::WARN)
+    ImageSqueeze::Utils.image_utility_available?('identify', 'all image', true)
+    if ImageSqueeze::Utils.image_utility_available?('pngcrush', 'pngs and gif')
       processors << PNGCrushProcessor
-      processors << GIFToPNGProcessor if ImageSqueeze::Utils.image_utility_available?('convert', 'gif', Logger::WARN)
+      processors << GIFToPNGProcessor if ImageSqueeze::Utils.image_utility_available?('convert', 'gif')
     end
-    processors << GifsicleProcessor if ImageSqueeze::Utils.image_utility_available?('gifsicle', 'animated gif', Logger::WARN)
-    if ImageSqueeze::Utils.image_utility_available?('jpegtran', 'jpeg', Logger::WARN)
+    processors << GifsicleProcessor if ImageSqueeze::Utils.image_utility_available?('gifsicle', 'animated gif')
+    if ImageSqueeze::Utils.image_utility_available?('jpegtran', 'jpeg')
       processors << JPEGTranProgressiveProcessor
       processors << JPEGTranNonProgressiveProcessor
     end
     processors
   end
+  
+  private
+  def tmp_filename(filename)
+    t = Time.now.strftime("%Y%m%d")
+    path = "#{File.basename(filename)}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+       
+    File.join(tmpdir, path)
+  end
+  
 end

data/lib/image_squeeze/processors/gif_to_png_processor.rb

@@ -9,11 +9,14 @@ class ImageSqueeze
     end
     
     def self.squeeze(filename, output_filename)
-      intermediate_tmp_filename = tmp_filename(filename)
+      intermediate_tmp_filename = "%s-%s" % [output_filename, '.tmp']
       
       system("convert #{filename} PNG:#{intermediate_tmp_filename} 2> /dev/null")
+      response = PNGCrushProcessor.squeeze(intermediate_tmp_filename, output_filename) # run it through PNGCrush afterwards
       
-      PNGCrushProcessor.squeeze(intermediate_tmp_filename, output_filename) # run it through PNGCrush afterwards
+      FileUtils.rm(intermediate_tmp_filename) # clean up after ourselves
+      
+      response
     end
   end
 end

data/lib/image_squeeze/processors/processor.rb

@@ -1,22 +1,7 @@
-require 'tempfile'
-
 class ImageSqueeze
   class Processor
     attr_reader :filename
     
-    def self.tmp_filename(filename)
-      t = Time.now.strftime("%Y%m%d")
-      path = "#{File.basename(filename)}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
-         
-      File.join(Dir::tmpdir, path)
-    end
-    
-    def self.squeeze_to_tmp(filename)
-      tmp = tmp_filename(filename)
-      squeeze(filename, tmp)
-      tmp
-    end
-    
     def self.squeeze(filename, output_filename)
       raise "#{to_s}#squeeze should be defined in subclass and should convert filename to something at output_filename"
     end

data/lib/image_squeeze/utils.rb

@@ -1,13 +1,14 @@
 class ImageSqueeze
   module Utils
-    def self.image_utility_available?(bin, extension, log_level = Logger::WARN)
+    def self.image_utility_available?(bin, extension, raise_when_missing = false)
       return true if system("which #{bin} > /dev/null")
-      if log_level >= Logger::ERROR
+      if raise_when_missing
         ImageSqueeze.logger.error("#{bin} utility is required for running ImageSqueeze, get it installed already")
         raise StandardError, "#{bin} utility is required for running ImageSqueeze, get it installed already"
       else
-        ImageSqueeze.logger.log(log_level, "#{bin} utility could not be found, your #{extension} files won't be squeezed")
+        ImageSqueeze.logger.warn("#{bin} utility could not be found, your #{extension} files won't be squeezed")
       end
+      false
     end
   end
 end

data/test/functional/default_processors_test.rb

@@ -55,6 +55,7 @@ class DefaultProcessorsTest < Test::Unit::TestCase
     filename = fixtures(file)
     old_size = File.size(filename)
     new_filename = squeezer.squeeze!(filename)
-    assert File.size(new_filename) >= old_size, "New file size of #{File.size(new_filename)} should be at least as big as original of #{old_size}"
+    new_file_size = File.size(new_filename) if new_filename
+    assert new_filename.nil?, "New file size of #{new_file_size} should be at least as big as original of #{old_size}"
   end
 end

data/test/functional/squeeze_test.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
-require 'mocha'
 
 class SqueezeTest < Test::Unit::TestCase
   def setup
@@ -77,6 +76,17 @@ class SqueezeTest < Test::Unit::TestCase
     assert_equal old_size, File.size(filename)
   end
   
+  def test_override_tmp_dir_stores_output_files_in_correct_location
+    tmpdir = File.join(File.dirname(__FILE__), '..', 'tmp')
+    FileUtils.mkdir_p(tmpdir)
+    image_squeezer = custom_image_squeezer(AlwaysOptimize, :tmpdir => tmpdir)
+    
+    result = image_squeezer.squeeze(fixtures('already_optimized_gif.gif'))
+    assert_equal 0, result.output_filename.index(tmpdir), "Output file should be located in tmpdir: #{tmpdir}"
+  ensure
+    FileUtils.rm(result.output_filename) if result && result.output_filename && File.exists?(result.output_filename)
+  end
+  
   private
   class AlwaysOptimize < ImageSqueeze::Processor
     def self.squeeze(filename, output_filename)
@@ -111,6 +121,8 @@ class SqueezeTest < Test::Unit::TestCase
   end
 
   def custom_image_squeezer(*processors)
-    ImageSqueeze.new(:processors => processors )
+    options = processors.last.is_a?(Hash) ? processors.pop : {}
+    
+    ImageSqueeze.new(options.merge(:processors => processors))
   end
 end

data/test/functional/utils_test.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class UtilsTest < Test::Unit::TestCase
+  def test_utility_available_returns_true_when_found
+    assert ImageSqueeze::Utils.image_utility_available?('ls', 'files'), "You don't have ls, wtf?"
+  end
+
+  def test_utility_available_returns_false_when_not_found
+    ImageSqueeze.logger.stubs(:warn)
+    assert !ImageSqueeze::Utils.image_utility_available?('andrewMagicNonexistantFileDestroyer', 'magic'), "Uhhh...where'd you get that?"
+  end
+  
+  def test_utility_logs_warning_when_not_found
+    ImageSqueeze.logger.expects(:warn).with(regexp_matches(/marbles/))
+    ImageSqueeze::Utils.image_utility_available?('andrewMagicNonexistantFileDestroyer', 'marbles')
+  end
+  
+  def test_utility_available_raises_when_not_found_and_raise_when_missing_true
+    ImageSqueeze.logger.stubs(:error)
+    assert_raises StandardError do
+      !ImageSqueeze::Utils.image_utility_available?('andrewMagicNonexistantFileDestroyer', 'magic', true)
+    end
+  end
+
+  def test_utility_logs_error_when_missing_true
+    ImageSqueeze.logger.expects(:error)
+    ImageSqueeze::Utils.image_utility_available?('andrewMagicNonexistantFileDestroyer', 'dolphins', true) rescue StandardError
+  end
+end

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 require 'test/unit'
 require 'ruby-debug'
+require 'mocha'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'image_squeeze')
 
 class Test::Unit::TestCase

data/test/tmp/already_optimized_gif.gif20100520-30783-189g816

@@ -0,0 +1 @@
+real small

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Andrew Grim
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-17 00:00:00 -07:00
+date: 2010-05-20 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -54,7 +54,9 @@ files:
 - test/functional/image_identifier_test.rb
 - test/functional/result_test.rb
 - test/functional/squeeze_test.rb
+- test/functional/utils_test.rb
 - test/test_helper.rb
+- test/tmp/already_optimized_gif.gif20100520-30783-189g816
 - CONTRIBUTORS
 - LICENSE
 - Rakefile