nanoc-image-compressor 0.0.1 → 0.1.0

data/README.md

@@ -1,16 +1,13 @@
 # Nanoc Image Compressor
 
-A [nanoc](http://nanoc.stoneship.org/) filter that compresses `jpg` and `png` images losslessly.
+[![Build Status](https://secure.travis-ci.org/jingoro/nanoc-image-compressor.png?branch=master)](http://travis-ci.org/jingoro/nanoc-image-compressor)
 
-## Dependencies
-
-This gem uses the [sprockets-image_compressor](https://github.com/botandrose/sprockets-image_compressor)
-gem which depends on [pngcrush](http://pmt.sourceforge.net/pngcrush/) and
-[jpegoptim](http://www.kokkonen.net/tjko/projects.html) being installed.
-As a fall back, the gem includes 32-bit and 64-bit binaries for Linux.
+A [nanoc](http://nanoc.stoneship.org/) filter that compresses `gif`, `jpg` and `png` images losslessly.
 
 ## Installation
 
+### 1. Install the gem
+
 Add this line to your site's `Gemfile`:
 
     gem 'nanoc-image-compressor'
@@ -23,7 +20,16 @@ Or install it yourself as:
 
     $ gem install nanoc-image-compressor
 
-Then, add this line to your site's `lib/default.rb`:
+### 2. Install the binaries
+
+This gem uses the [image\_optim](https://github.com/toy/image_optim)
+gem which depends on binaries being installed (`advpng`, `gifsicle`, `jpegoptim`, `jpegtran`,
+`optipng`, `pngcrush`, `pngout`). See the [image\_optim README](https://github.com/toy/image_optim)
+for instructions on how to install these binaries.
+
+### 3. Add a `require` statement
+
+Add this line to your site's `lib/default.rb`:
 
     require 'nanoc/filters/image_compressor'
 
@@ -34,3 +40,12 @@ Add a filter within a `compile` block in your site's `Rules`:
     compile '/images/*/' do
       filter :image_compressor if item.binary?
     end
+
+Any options will be passed to `image_optim`:
+
+    compile '/images/*/' do
+      if item.binary?
+        # we don't have pngout on our system
+        filter :image_compressor, :pngout => false
+      end
+    end

data/lib/nanoc/filters/image_compressor.rb

@@ -1,12 +1,12 @@
 require 'fileutils'
+require 'image_optim'
 require 'nanoc'
-require 'sprockets/image_compressor'
 
 module Nanoc
   module Filters
     class ImageCompressor < Nanoc::Filter
       
-      VERSION = '0.0.1'
+      VERSION = '0.1.0'
 
       identifier :image_compressor
       type :binary
@@ -14,25 +14,13 @@ module Nanoc
       # Compresses the content with Sprockets::ImageCompressor.
       #
       # @param [String] filename The filename to compress
-      # @option params [String] :type ('auto') png, jpg or auto
+      # @param [Hash] params Passed through to ImageOptim.new
       # @return [void]
       def run(filename, params={})
-        type = (params[:type] || 'auto').to_s.downcase
-        type = filetype_guess(filename) if type == 'auto'
-        content = File.read(filename)
-        compressor = case type
-          when 'png'
-            content = Sprockets::ImageCompressor::PngCompressor.new.compress(content)
-          when 'jpg', 'jpeg'
-            content = Sprockets::ImageCompressor::JpgCompressor.new.compress(content)
-          end
-        File.open(output_filename, 'wb') { |f| f.write content }
-      end
-      
-    private
-    
-      def filetype_guess(filename)
-        filename.sub(/^.+\.([a-z]+)$/i, '\1').downcase
+        io = ImageOptim.new(params.merge(:threads => false))
+        result = io.optimize_image(filename)
+        path = result ? result.to_s : filename
+        FileUtils.cp path, output_filename
       end
 
     end

data/nanoc-image-compressor.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["John Nishinaga"]
   gem.email         = ["jingoro@casa-z.org"]
   gem.description   = %q{Nanoc image compressor filter}
-  gem.summary       = %q{A nanoc filter that compresses jpg and png images losslessly}
+  gem.summary       = %q{A nanoc filter that compresses gif, jpg and png images losslessly}
   gem.homepage      = "https://github.com/jingoro/nanoc-image-compressor"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -12,10 +12,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "nanoc-image-compressor"
   gem.require_paths = ["lib"]
-  gem.version       = '0.0.1'
-  
-  gem.add_dependency 'nanoc', '>= 3.3.0'
-  gem.add_dependency 'sprockets-image_compressor'
+  gem.version       = '0.1.0'
+
+  gem.add_dependency 'nanoc', '>= 3.3.1'
+  gem.add_dependency 'image_optim'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'yard'

data/spec/image_compressor_spec.rb

@@ -1,8 +1,15 @@
 require 'tempfile'
+require 'fileutils'
+
 require 'nanoc/filters/image_compressor'
 
 describe Nanoc::Filters::ImageCompressor do
   
+  let(:gif_path) { File.expand_path('../test.gif', __FILE__) }
+  let(:jpg_path) { File.expand_path('../test.jpg', __FILE__) }
+  let(:png_path) { File.expand_path('../test.png', __FILE__) }
+  let(:run_options) { { :pngout => false } }
+  
   before do
     item = double('item')
     item.stub(:identifier) { '/test/' }
@@ -14,63 +21,50 @@ describe Nanoc::Filters::ImageCompressor do
   
   let(:extension) { path.sub(/^.+\.([a-z]+)$/, '\1') }
   let(:output_size) { File.size subject.output_filename }
-  
-  def self.it_should_compress_to_less_than(max_size)
 
-    it 'should compress implicitly' do
-      subject.run path
-      output_size.should be < max_size
-    end
-
-    it 'should compress explicitly' do
-      subject.run path, :type => extension
-      output_size.should be < max_size
+  context 'jpg image' do
+    let(:path) { jpg_path }
+    it 'should compress' do
+      subject.run path, run_options
+      output_size.should be < 300
     end
-
   end
   
-  def self.it_should_not_compress
-
-    it 'should pass through implicitly' do
-      subject.run path
-      output_size.should == File.size(path)
-    end
-
-    it 'should pass through explicitly' do
-      subject.run path, :type => extension
-      output_size.should == File.size(path)
-    end
-
-  end
-
-  context 'jpg image' do
-    let(:path) { File.expand_path '../test.jpg', __FILE__ }
-    it_should_compress_to_less_than 300
-  end
-
   context 'jpeg image' do
     let(:path) do
       file = Tempfile.new(['test', '.jpeg'])
-      file.write File.read(File.expand_path('../test.jpg', __FILE__))
       file.close
+      FileUtils.cp jpg_path, file.path
       file.path
     end
-    it_should_compress_to_less_than 300
+    it 'should compress' do
+      subject.run path, run_options
+      output_size.should be < 300
+    end
   end
   
   context 'png image' do
-    let(:path) { File.expand_path '../test.png', __FILE__ }
-    it_should_compress_to_less_than 1900
+    let(:path) { png_path }
+    it 'should compress' do
+      subject.run path, run_options
+      output_size.should be < 1900
+    end
   end
-
+  
   context 'gif image' do
-    let(:path) { File.expand_path '../test.gif', __FILE__ }
-    it_should_not_compress
+    let(:path) { gif_path }
+    it 'should compress' do
+      subject.run path, run_options
+      output_size.should be < 400
+    end
   end
   
   context 'text file' do
     let(:path) { __FILE__ }
-    it_should_not_compress
+    it 'should pass through' do
+      subject.run path, run_options
+      output_size.should == File.size(__FILE__)
+    end
   end
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc-image-compressor
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - John Nishinaga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-13 00:00:00 Z
+date: 2012-02-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nanoc
@@ -25,16 +25,16 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 9
         segments: 
         - 3
         - 3
-        - 0
-        version: 3.3.0
+        - 1
+        version: 3.3.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: sprockets-image_compressor
+  name: image_optim
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -159,7 +159,7 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A nanoc filter that compresses jpg and png images losslessly
+summary: A nanoc filter that compresses gif, jpg and png images losslessly
 test_files: 
 - spec/image_compressor_spec.rb
 - spec/test.gif