sprockets-image_compressor_holder 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efb078028d8af5713ba2f1aed4396e0cdbefda21
+  data.tar.gz: 790b170766c6c92f81c434905282b934ca87d6b4
+SHA512:
+  metadata.gz: 70fcdd1369e4ba5b1b2230bea6068b73693bac8e4973f99bfadd55e7564ea2648388590a22fea688f1148b74b7a73f43d5aafb9e14806766ada522337a307b68
+  data.tar.gz: 6956c8fdc7fc12eced7734ab9fd6a83513c76bde43bd187a04ba4b498f79a637681b6edd360f3e1a0dfe4a0bc82386216947a29fcf6d199b3d00109fd277c9ee

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.ruby-version
+.ruby-gemset
+.rvmrc
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1
+  # 2.1.0 throws exception until issue is resolved: https://github.com/travis-ci/travis-ci/issues/2220
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -y jpegoptim pngcrush
+

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+0.2.4 (05/18/2014)
+-------------------------
+* Bugfix: jpgs weren't being opened in binary mode. Thanks, @JakeTheSnake3p0!
+
+0.2.3 (04/10/2014)
+-------------------------
+* Bugfix: Return original file and warn if compression fails. Thanks, @tomchentw!
+
+0.2.2 (09/20/2013)
+-------------------------
+
+* Bugfix: Work on Rails 4. Thanks, @dkubb!
+
+0.2.1 (07/20/2012)
+-------------------------
+
+* Bugfix: Work with Sprockets::Rails. Thanks, @florentmorin!
+* Bugfix: Include license in gemspec. Thanks, @sunny!
+
+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)
+-------------------------
+
+* Bugfix: Works on Rails 3.1 and 3.2 on Ruby 1.9
+
+0.1.1 (12/26/2011)
+-------------------------
+
+* Bugfix: Make sure we're using binary encoding when dealing with the image files
+* Bugfix: Add basic sprockets integration tests
+
+0.1.0 (09/21/2011)
+-------------------------
+
+* Initial public release!

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sprockets-image_compressor.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# Image compressor processor for Sprockets
+
+[![Build Status](https://travis-ci.org/botandrose/sprockets-image_compressor.svg?branch=master)](https://travis-ci.org/botandrose/sprockets-image_compressor)
+
+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+
+
+Just add this gem to your Gemfile:
+
+```ruby
+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!
+
+## Gotchas
+
+If you have other sprockets processors registered for images, e.g. `sprockets-webp`, the relative order that they are required can matter. Please load `sprockets-image_compressor` _before_ the others:
+
+```ruby
+gem 'sprockets-image_compressor'
+gem 'sprockets-webp'
+```
+
+See [#15](https://github.com/botandrose/sprockets-image_compressor/issues/15) for more information.
+
+## TODO
+
+* Provide configuration hooks
+* Test Railtie
+
+## Credits
+
+* @nhogle for help with compiling and packaging the jpegoptim and pngcrush binaries
+* @florentmorin for compatibility with sprockets-rails
+* @dkubb for compatibility with Rails 4
+
+## License
+
+(MIT License) - Copyright (c) 2012 Micah Geisel

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sprockets-image_compressor.rb

@@ -0,0 +1 @@
+require "sprockets/image_compressor"

data/lib/sprockets/image_compressor.rb

@@ -0,0 +1,5 @@
+require "sprockets/image_compressor/version"
+require "sprockets/image_compressor/png_compressor"
+require "sprockets/image_compressor/jpg_compressor"
+require "sprockets/image_compressor/integration"
+require "sprockets/image_compressor/railtie" if defined?(Rails)

data/lib/sprockets/image_compressor/base.rb

@@ -0,0 +1,33 @@
+require "tempfile"
+
+module Sprockets
+  module ImageCompressor
+    GEM_ROOT = File.expand_path File.join(File.dirname(__FILE__), "../../../")
+
+    class Base
+      def binary_path
+        @binary_path ||= begin
+           try_vendored_binaries || try_system_binary 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/integration.rb

@@ -0,0 +1,128 @@
+module Sprockets
+  module ImageCompressor
+    class Integration
+      def self.setup env
+        monkey_patch_older_sprockets!
+
+        env.register_mime_type 'image/png', '.png'
+        env.register_postprocessor 'image/png', :png_compressor do |context, data|
+          PngCompressor.new.compress data
+        end
+
+        env.register_mime_type 'image/jpeg', '.jpg'
+        env.register_postprocessor 'image/jpeg', :jpg_compressor do |context, data|
+          JpgCompressor.new.compress data
+        end
+      end
+
+      # Rails locks down Sprockets to an older version, which will cause the image compressor to barf on ruby 1.9.
+      # Monkey patch in binary fixes from Sprockets 2.2.0.
+      def self.monkey_patch_older_sprockets!
+        return unless Sprockets::VERSION =~ /2\.[01]\.\d/ # Sprockets version >= 2.0.0 and < 2.2.0
+        return unless "".respond_to?(:valid_encoding?) # is ruby 1.9?
+
+        Sprockets::BundledAsset.class_eval do
+          def build_dependency_context_and_body
+            start_time = Time.now.to_f
+
+            context = blank_context
+
+            # Read original data once and pass it along to `Context`
+            mime_type = environment.mime_types(pathname.extname)
+            encoding = environment.encoding_for_mime_type(mime_type)
+            if encoding && "".respond_to?(:valid_encoding?)
+              data = Sprockets::Utils.read_unicode(pathname, encoding)
+            else
+              data = Sprockets::Utils.read_unicode(pathname)
+            end
+
+            # Prime digest cache with data, since we happen to have it
+            environment.file_digest(pathname, data)
+
+            # Runs all processors on `Context`
+            body = context.evaluate(pathname, :data => data)
+
+            @dependency_context, @body = context, body
+
+            elapsed_time = ((Time.now.to_f - start_time) * 1000).to_i
+            logger.info "Compiled #{logical_path}  (#{elapsed_time}ms)  (pid #{Process.pid})"
+
+            return context, body
+          end
+        end
+
+        Sprockets::Context.class_eval do
+          def evaluate(path, options = {})
+            pathname   = resolve(path)
+            attributes = environment.attributes_for(pathname)
+            processors = options[:processors] || attributes.processors
+
+            if options[:data]
+              result = options[:data]
+            else
+              mime_type = environment.mime_types(pathname.extname)
+              encoding = environment.encoding_for_mime_type(mime_type)
+              if encoding && "".respond_to?(:valid_encoding?)
+                result = Sprockets::Utils.read_unicode(pathname, encoding)
+              else
+                result = Sprockets::Utils.read_unicode(pathname)
+              end
+            end
+
+            processors.each do |processor|
+              begin
+                template = processor.new(pathname.to_s) { result }
+                result = template.render(self, {})
+              rescue Exception => e
+                annotate_exception! e
+                raise
+              end
+            end
+
+            result
+          end
+        end
+
+        Sprockets::Mime.module_eval do
+          # Mime types that should be opened with BINARY encoding.
+          def binary_mime_types
+            @binary_mime_types ||= [ %r{^(image|audio|video)/} ]
+          end
+
+          # Returns the correct encoding for a given mime type, while falling
+          # back on the default external encoding, if it exists.
+          def encoding_for_mime_type(type)
+            encoding = "BINARY" if binary_mime_types.any? { |matcher| matcher === type }
+            encoding ||= default_external_encoding if respond_to?(:default_external_encoding)
+            encoding
+          end
+        end
+
+        Sprockets::Utils.module_eval do
+          def self.utf8_bom_pattern
+            @ut8_bom_pattern ||= Regexp.new("\\A\uFEFF".encode('utf-8'))
+          end
+
+          def self.read_unicode(pathname, external_encoding = Encoding.default_external)
+            pathname.open("r:#{external_encoding}") do |f|
+              f.read.tap do |data|
+                # Eager validate the file's encoding. In most cases we
+                # expect it to be UTF-8 unless `default_external` is set to
+                # something else. An error is usually raised if the file is
+                # saved as UTF-16 when we expected UTF-8.
+                if !data.valid_encoding?
+                  raise EncodingError, "#{pathname} has a invalid " +
+                  "#{data.encoding} byte sequence"
+
+                  # If the file is UTF-8 and theres a BOM, strip it for safe concatenation.
+                elsif data.encoding.name == "UTF-8" && data =~ utf8_bom_pattern
+                  data.sub!(utf8_bom_pattern, "")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/image_compressor/jpg_compressor.rb

@@ -0,0 +1,24 @@
+require "sprockets/image_compressor/base"
+
+module Sprockets
+  module ImageCompressor
+    class JpgCompressor < Base
+      def initialize
+        @name = "convert"
+      end
+
+      def compress(content)
+        compressed_jpg_data = ""
+        Tempfile.open ["file", ".jpg"] do |file|
+          file.binmode
+          file.write content
+          file.close
+
+          out = `#{binary_path} -strip -interlace Plance #{file.path} 2>&1`
+          compressed_jpg_data = IO.binread(file.path)
+        end
+        compressed_jpg_data
+      end
+    end
+  end
+end

data/lib/sprockets/image_compressor/png_compressor.rb

@@ -0,0 +1,32 @@
+require "sprockets/image_compressor/base"
+
+module Sprockets
+  module ImageCompressor
+    class PngCompressor < Base
+      def initialize
+        @name = "pngcrush"
+      end
+
+      def compress(content)
+        compressed_png_data = ""
+        Tempfile.open ["in_file", ".png"] do |in_file|
+          in_file.binmode
+          out_file_path = in_file.path + ".optimized.png"
+          in_file.write content
+          in_file.close
+
+          out = `#{binary_path} -rem alla -rem text #{in_file.path} #{out_file_path} 2>&1`
+          compressed_png_data = IO.binread(out_file_path)
+          File.unlink out_file_path
+        end
+        compressed_png_data
+
+      rescue Errno::ENOENT => e
+        # error during compression so out_file not found
+        # return original content as a fallback
+        warn "sprockets-image_compressor: PNG compression failed... returning original."
+        content
+      end
+    end
+  end
+end

data/lib/sprockets/image_compressor/railtie.rb

@@ -0,0 +1,9 @@
+module Sprockets
+  module ImageCompressor
+    class Railtie < ::Rails.version < '4.0' ? ::Rails::Engine : ::Rails::Railtie
+      initializer :setup_image_compressors do |app|
+        Integration.setup app.assets if app.config.assets.compress
+      end
+    end
+  end
+end

data/lib/sprockets/image_compressor/version.rb

@@ -0,0 +1,5 @@
+module Sprockets
+  module Imagecompressor
+    VERSION = "0.3.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,47 @@
+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
+
+  describe "#compress" do
+    it "returns uncompressable content as-is with a warning" do
+      compressor.should_receive(:warn)
+      compressor.compress("asdf").should == "asdf"
+    end
+  end
+end

data/spec/fixtures/test.css

@@ -0,0 +1,3 @@
+html {
+  body: red; // UTF8 ☃
+}

data/spec/integration/sprockets_integration_spec.rb

@@ -0,0 +1,33 @@
+require "rack/test"
+require "sprockets"
+require "sprockets/image_compressor"
+
+describe "sprockets integration" do
+  include Rack::Test::Methods
+
+  let(:app) do
+    Sprockets::Environment.new.tap do |env|
+      Sprockets::ImageCompressor::Integration.setup env
+      env.append_path "spec/fixtures"
+    end
+  end
+
+  it "should compress pngs" do
+    big_response = get "/largepng.png"
+    small_response = get "/smallpng.png"
+    big_response.headers["Content-Length"].should == small_response.headers["Content-Length"]
+    big_response.body.should == small_response.body
+  end
+
+  it "should compress jpgs" do
+    big_response = get "/largejpg.jpg"
+    small_response = get "/smalljpg.jpg"
+    big_response.headers["Content-Length"].should == small_response.headers["Content-Length"]
+    big_response.body.should == small_response.body
+  end
+
+  it "should still serve text assets" do
+    response = get "/test.css"
+    response.status.should == 200
+  end
+end

data/sprockets-image_compressor.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sprockets/image_compressor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sprockets-image_compressor_holder"
+  s.version     = Sprockets::Imagecompressor::VERSION
+  s.authors     = ["Micah Geisel"]
+  s.email       = ["micah@botandrose.com"]
+  s.homepage    = ""
+  s.summary     = %q{Losslessly compress images in the Rails asset pipeline}
+  s.description = %q{Losslessly compress images in the Rails asset pipeline}
+  s.license     = "MIT"
+
+  s.rubyforge_project = "sprockets-image_compressor_holder"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "sprockets"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rack-test"
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-image_compressor_holder
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Micah Geisel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Losslessly compress images in the Rails asset pipeline
+email:
+- micah@botandrose.com
+executables:
+- jpegoptim.i386.linux
+- jpegoptim.x86_64.linux
+- pngcrush.i386.linux
+- pngcrush.x86_64.linux
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- 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
+- spec/fixtures/smallpng.png
+- spec/fixtures/test.css
+- spec/integration/sprockets_integration_spec.rb
+- sprockets-image_compressor.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sprockets-image_compressor_holder
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Losslessly compress images in the Rails asset pipeline
+test_files:
+- spec/compressors/jpg_compressor_spec.rb
+- spec/compressors/png_compressor_spec.rb
+- spec/fixtures/largejpg.jpg
+- spec/fixtures/largepng.png
+- spec/fixtures/smalljpg.jpg
+- spec/fixtures/smallpng.png
+- spec/fixtures/test.css
+- spec/integration/sprockets_integration_spec.rb