sprockets-image_compressor 0.1.2 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.0 (01/28/2012)
+-------------------------
+
+* Feature: Fallback to vendored binaries if pngcrush and/or jpegoptim aren't installed on the system. Works on Heroku, now!
+
 0.1.2 (01/26/2012)
 -------------------------
 

data/README.md

@@ -1,6 +1,6 @@
 # Image compressor processor for Sprockets
 
-Sprockets preprocessor to losslessly compress .png and .jpg images. Requires [pngcrush](http://pmt.sourceforge.net/pngcrush/) and [jpegoptim](http://www.kokkonen.net/tjko/projects.html) to be installed and in your PATH.
+Sprockets preprocessor to losslessly compress .png and .jpg images using [pngcrush](http://pmt.sourceforge.net/pngcrush/) and [jpegoptim](http://www.kokkonen.net/tjko/projects.html).
 
 ## Integration with Rails 3.1+
 
@@ -12,12 +12,19 @@ gem 'sprockets-image_compressor'
 
 The gem ships with a Railtie which will automatically register the compressor preprocessors.
 
+## Now with vendored binary fallbacks / Heroku support!
+
+If the environment doesn't have pngcrush and/or jpegoptim installed, the gem will fall back on binaries packaged with the gem. Currently, only 32bit and 64bit linux binaries are included. Pull requests welcome for other architectures!
+
 ## TODO
 
-* Detect missing pngcrush or jpegoptim installations (vendor?)
 * Provide configuration hooks
 * Test Railtie
 
+## Credits
+
+* Thanks to @nhogle for help with compiling and packaging the jpegoptim and pngcrush binaries
+
 ## License
 
-(MIT License) - Copyright (c) 2011 Micah Geisel
+(MIT License) - Copyright (c) 2012 Micah Geisel

data/lib/sprockets/image_compressor/base.rb

@@ -0,0 +1,31 @@
+module Sprockets
+  module ImageCompressor
+    GEM_ROOT = File.expand_path File.join(File.dirname(__FILE__), "../../../")
+
+    class Base
+      def binary_path
+        @binary_path ||= begin
+          try_system_binary or try_vendored_binaries or raise """
+            Can't find an installed version of #{@name}, and none of the vendored binaries seem to work.
+            Please install #{@name}, or open an issue on the project page at https://github.com/botandrose/sprockets-image_compressor
+          """
+        end
+      end
+
+      private
+
+      def try_system_binary
+        system_binary = `which #{@name}`.chomp
+        system_binary if system_binary.length > 0
+      end
+
+      def try_vendored_binaries
+        # use the first vendored binary that doesn't shit the bed when we ask for its version
+        vendored_binaries = Dir["#{GEM_ROOT}/bin/#{@name}.*"].sort
+        vendored_binaries.find do |path|
+          system("#{path} -version 2> /dev/null > /dev/null")
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/image_compressor/jpg_compressor.rb

@@ -1,6 +1,12 @@
+require "sprockets/image_compressor/base"
+
 module Sprockets
   module ImageCompressor
-    class JpgCompressor
+    class JpgCompressor < Base
+      def initialize
+        @name = "jpegoptim"
+      end
+
       def compress(content)
         compressed_jpg_data = ""
         Tempfile.open ["file", ".jpg"] do |file|
@@ -8,7 +14,7 @@ module Sprockets
           file.write content
           file.close
 
-          out = `jpegoptim --strip-all #{file.path} 2>&1`
+          out = `#{binary_path} --strip-all #{file.path} 2>&1`
           file.open
           compressed_jpg_data = file.read
         end

data/lib/sprockets/image_compressor/png_compressor.rb

@@ -1,6 +1,12 @@
+require "sprockets/image_compressor/base"
+
 module Sprockets
   module ImageCompressor
-    class PngCompressor
+    class PngCompressor < Base
+      def initialize
+        @name = "pngcrush"
+      end
+
       def compress(content)
         compressed_png_data = ""
         Tempfile.open ["in_file", ".png"] do |in_file|
@@ -8,7 +14,7 @@ module Sprockets
           out_file_path = in_file.path + ".optimized.png"
           in_file.write content
           in_file.close
-          out = `pngcrush #{in_file.path} #{out_file_path} 2>&1`
+          out = `#{binary_path} #{in_file.path} #{out_file_path} 2>&1`
           in_file.delete
 
           File.open out_file_path, "rb" do |out_file|

data/lib/sprockets/image_compressor/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Imagecompressor
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/spec/compressors/jpg_compressor_spec.rb

@@ -0,0 +1,40 @@
+require "sprockets/image_compressor"
+
+describe Sprockets::ImageCompressor::JpgCompressor do
+  let(:compressor) { Sprockets::ImageCompressor::JpgCompressor.new }
+  let(:gem_root) { Sprockets::ImageCompressor::GEM_ROOT }
+
+  describe "#binary_path" do
+    context "when jpegoptim is installed" do
+      before do
+        compressor.should_receive(:`).with("which jpegoptim").and_return("/path/to/jpegoptim\n")
+      end
+
+      it "prefers the system's binary" do
+        compressor.binary_path.should == "/path/to/jpegoptim"
+      end
+    end
+
+    context "when jpegoptim is missing and we're on a supported system" do
+      before do
+        compressor.should_receive(:`).with("which jpegoptim").and_return("")
+        compressor.should_receive(:system).and_return(true)
+      end
+
+      it "falls back to a vendored binary" do
+        compressor.binary_path.should include("#{gem_root}/bin/jpegoptim")
+      end
+    end
+
+    context "when jpegoptim is missing and we're on an unsupported system" do
+      before do
+        compressor.should_receive(:`).with("which jpegoptim").and_return("")
+        compressor.should_receive(:system).twice.and_return(false)
+      end
+
+      it "raises hell" do
+        lambda { compressor.binary_path }.should raise_exception
+      end
+    end
+  end
+end

data/spec/compressors/png_compressor_spec.rb

@@ -0,0 +1,40 @@
+require "sprockets/image_compressor"
+
+describe Sprockets::ImageCompressor::PngCompressor do
+  let(:compressor) { Sprockets::ImageCompressor::PngCompressor.new }
+  let(:gem_root) { Sprockets::ImageCompressor::GEM_ROOT }
+
+  describe "#binary_path" do
+    context "when pngcrush is installed" do
+      before do
+        compressor.should_receive(:`).with("which pngcrush").and_return("/path/to/pngcrush\n")
+      end
+
+      it "prefers the system's binary" do
+        compressor.binary_path.should == "/path/to/pngcrush"
+      end
+    end
+
+    context "when pngcrush is missing and we're on a supported system" do
+      before do
+        compressor.should_receive(:`).with("which pngcrush").and_return("")
+        compressor.should_receive(:system).and_return(true)
+      end
+
+      it "falls back to a vendored binary" do
+        compressor.binary_path.should include("#{gem_root}/bin/pngcrush")
+      end
+    end
+
+    context "when pngcrush is missing and we're an unsupported system" do
+      before do
+        compressor.should_receive(:`).with("which pngcrush").and_return("")
+        compressor.should_receive(:system).twice.and_return(false)
+      end
+
+      it "raises hell" do
+        lambda { compressor.binary_path }.should raise_exception
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-image_compressor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000Z
+date: 2012-01-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &80292680 !ruby/object:Gem::Requirement
+  requirement: &73839430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *80292680
+  version_requirements: *73839430
 - !ruby/object:Gem::Dependency
   name: ruby-debug
-  requirement: &80292420 !ruby/object:Gem::Requirement
+  requirement: &73839200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80292420
+  version_requirements: *73839200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80292210 !ruby/object:Gem::Requirement
+  requirement: &73838940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80292210
+  version_requirements: *73838940
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &80291950 !ruby/object:Gem::Requirement
+  requirement: &73838700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,11 +54,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80291950
+  version_requirements: *73838700
 description: Losslessly compress images in the Rails asset pipeline
 email:
 - micah@botandrose.com
-executables: []
+executables:
+- jpegoptim.i386.linux
+- jpegoptim.x86_64.linux
+- pngcrush.i386.linux
+- pngcrush.x86_64.linux
 extensions: []
 extra_rdoc_files: []
 files:
@@ -67,13 +71,20 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/jpegoptim.i386.linux
+- bin/jpegoptim.x86_64.linux
+- bin/pngcrush.i386.linux
+- bin/pngcrush.x86_64.linux
 - lib/sprockets-image_compressor.rb
 - lib/sprockets/image_compressor.rb
+- lib/sprockets/image_compressor/base.rb
 - lib/sprockets/image_compressor/integration.rb
 - lib/sprockets/image_compressor/jpg_compressor.rb
 - lib/sprockets/image_compressor/png_compressor.rb
 - lib/sprockets/image_compressor/railtie.rb
 - lib/sprockets/image_compressor/version.rb
+- spec/compressors/jpg_compressor_spec.rb
+- spec/compressors/png_compressor_spec.rb
 - spec/fixtures/largejpg.jpg
 - spec/fixtures/largepng.png
 - spec/fixtures/smalljpg.jpg