image_optim_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a27fab3ec29968a0f1461aa69f5d1f3238d2a05
+  data.tar.gz: 14e3da57b4023c649e9ed3a4874ab5621174c545
+SHA512:
+  metadata.gz: ff3b6c95266bbb357df1faab872a7427af1eea240f5d29eeedfd99b8f9b0fbcea8efd01049643c266b6a7822b3c6898ca8c1c8cb97007bd463cee098e4b6b6fe
+  data.tar.gz: 5a0cc79969ee1ea39c78246e6a9b7f66b6846985749f6e7ffb39a275ed8fc8cd1f14469abee011dd841221e04c33b9b824b4067ddd7d184ef1fe0d5a5d80670e

data/.gitignore

@@ -0,0 +1,14 @@
+/pkg/
+/*.gem
+
+/doc/
+/rdoc/
+/.yardoc/
+/coverage/
+
+Makefile
+*.o
+*.bundle
+/tmp/
+
+/Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,75 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'vendor/**/*'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IfUnlessModifier:
+  MaxLineLength: 40
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/IndentAssignment:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,43 @@
+sudo: false
+language: ruby
+cache:
+  bundler: true
+  directories:
+  - $(npm root)
+  - ~/bin
+script: |
+  (
+    set -ex
+    if [ -n "$RUBOCOP" ]; then
+      bundle exec rubocop
+    else
+      bundle exec image_optim --info
+      bundle exec rspec
+    fi
+  )
+before_install: |
+  (
+    set -ex
+    if [ -z "$RUBOCOP" ]; then
+      command -v svgo || npm install svgo
+      command -v pngout || {
+        mkdir -p ~/bin
+        curl -L "http://static.jonof.id.au/dl/kenutils/pngout-20130221-linux.tar.gz" | tar -xz -C ~/bin --strip-components 2 --wildcards '*/x86_64/pngout'
+      }
+    fi
+  )
+matrix:
+  fast_finish: true
+  include:
+    - env: RAILS_VERSION='~> 3.2'
+      rvm: default
+    - env: RAILS_VERSION='~> 4.0' SPROCKETS_RAILS_VERSION='~> 2.0'
+      rvm: '2'
+    - env: RAILS_VERSION='~> 4.0'
+      rvm: '2'
+    - env: RAILS_VERSION='~> 5.0' SPROCKETS_RAILS_VERSION='~> 2.0'
+      rvm: '2.2.2'
+    - env: RAILS_VERSION='~> 5.0'
+      rvm: '2.2.2'
+    - env: RUBOCOP=true
+      rvm: '2.2.2'

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+%w[
+  rails
+  sprockets
+  sprockets-rails
+].each do |gem_name|
+  version = ENV[gem_name.tr('-', '_').upcase + '_VERSION']
+  gem gem_name, version if version
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2016 Ivan Kuchin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,45 @@
+[![Gem Version](https://img.shields.io/gem/v/image_optim_rails.svg?style=flat)](https://rubygems.org/gems/image_optim_rails)
+[![Build Status](https://img.shields.io/travis/toy/image_optim_rails/master.svg?style=flat)](https://travis-ci.org/toy/image_optim_rails)
+[![Code Climate](https://img.shields.io/codeclimate/github/toy/image_optim_rails.svg?style=flat)](https://codeclimate.com/github/toy/image_optim_rails)
+[![Dependency Status](https://img.shields.io/gemnasium/toy/image_optim_rails.svg?style=flat)](https://gemnasium.com/toy/image_optim_rails)
+[![Inch CI](https://inch-ci.org/github/toy/image_optim_rails.svg?branch=master&style=flat)](https://inch-ci.org/github/toy/image_optim_rails)
+
+# image\_optim\_rails
+
+Optimize rails image assets using image_optim gem.
+
+Options and instructions for getting binaries can be found in [image_optim readme](https://github.com/toy/image_optim).
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'image_optim'
+```
+
+With [`image_optim_pack`](https://github.com/toy/image_optim_pack):
+
+```ruby
+gem 'image_optim'
+gem 'image_optim_pack'
+```
+
+## Usage
+
+`ImageOptim::Railtie` will automatically register sprockets preprocessor unless you set `config.assets.image_optim = false` or `config.assets.compress = false` (later for partial rails 3 compatibility).
+
+You can provide options for image_optim used for preprocessor through config:
+
+```ruby
+config.assets.image_optim.nice = 20
+config.assets.image_optim.svgo = false
+```
+
+Check available options in [options section of image_optim](https://github.com/toy/image_optim#options).
+
+Image optimization can be time consuming, so depending on your deployment process you may prefer to optimize original asset files.
+
+## Copyright
+
+Copyright (c) 2013-2016 Ivan Kuchin. See [LICENSE.txt](LICENSE.txt) for details.

data/image_optim_rails.gemspec

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name        = 'image_optim_rails'
+  s.version     = '0.1.0'
+  s.summary     = %q{Optimize image assets using image_optim}
+  s.homepage    = "http://github.com/toy/#{s.name}"
+  s.authors     = ['Ivan Kuchin']
+  s.license     = 'MIT'
+
+  s.rubyforge_project = s.name
+
+  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 = %w[lib]
+
+  s.add_dependency 'image_optim', '~> 0.24.0'
+  s.add_dependency 'rails'
+  s.add_dependency 'sprockets'
+
+  s.add_development_dependency 'image_optim_pack', '~> 0.2', '>= 0.2.2'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  if RUBY_VERSION >= '2.0'
+    s.add_development_dependency 'rubocop', '~> 0.37'
+  end
+end

data/lib/image_optim/railtie.rb

@@ -0,0 +1,66 @@
+require 'image_optim'
+
+class ImageOptim
+  # Adds image_optim as preprocessor for gif, jpeg, png and svg images
+  class Railtie < Rails::Railtie
+    MIME_TYPES = %w[
+      image/gif
+      image/jpeg
+      image/png
+      image/svg+xml
+    ].freeze
+
+    config.before_configuration do |app|
+      worker_names = ImageOptim::Worker.klasses.map(&:bin_sym)
+      app.config.assets.image_optim =
+        ActiveSupport::OrderedOptions.new do |hash, key|
+          if worker_names.include?(key.to_sym)
+            hash[key] = ActiveSupport::OrderedOptions.new
+          end
+        end
+    end
+
+    initializer 'image_optim.initializer' do |app|
+      next if app.config.assets.compress == false
+      next if app.config.assets.image_optim == false
+
+      @image_optim = ImageOptim.new(options(app))
+
+      register_preprocessor(app) do |*args|
+        if args[1] # context and data arguments in sprockets 2
+          optimize_image_data(args[1])
+        else
+          input = args[0]
+          {
+            :data => optimize_image_data(input[:data]),
+            :charset => nil, # no gzipped version with rails/sprockets#228
+          }
+        end
+      end
+    end
+
+    def options(app)
+      if app.config.assets.image_optim == true
+        {}
+      else
+        app.config.assets.image_optim || {}
+      end
+    end
+
+    def optimize_image_data(data)
+      @image_optim.optimize_image_data(data) || data
+    end
+
+    def register_preprocessor(app, &processor)
+      MIME_TYPES.each do |mime_type|
+        if app.assets
+          app.assets.register_preprocessor mime_type, :image_optim, &processor
+        else
+          app.config.assets.configure do |env|
+            env.register_preprocessor mime_type, :image_optim, &processor
+          end
+        end
+      end
+    end
+  end
+end

data/lib/image_optim_rails.rb

@@ -0,0 +1 @@
+require 'image_optim/railtie'

data/spec/image_optim/railtie_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+require 'rails/all'
+require 'image_optim/railtie'
+
+describe 'ImageOptim::Railtie' do
+  def init_rails_app
+    Class.new(Rails::Application) do
+      # Rails 4 requires application class to have name
+      define_singleton_method :name do
+        'Dummy'
+      end
+
+      config.active_support.deprecation = :stderr
+      config.eager_load = false
+
+      config.logger = Logger.new('/dev/null')
+
+      config.assets.tap do |assets|
+        assets.enabled = true
+        assets.version = '1.0'
+        assets.cache_store = :null_store
+
+        # grab images from image_optim gem
+        image_optim_root = Gem.loaded_specs['image_optim'].gem_dir
+        assets.paths = [FSPath.new(image_optim_root) / 'spec/images']
+
+        assets.delete(:compress)
+      end
+
+      yield config if block_given?
+    end.initialize!
+  end
+
+  after do
+    Rails.application = nil
+  end
+
+  describe 'initialization' do
+    it 'initializes by default' do
+      expect(ImageOptim).to receive(:new)
+      init_rails_app
+    end
+
+    it 'initializes if config.assets.image_optim is nil' do
+      expect(ImageOptim).to receive(:new)
+      init_rails_app do |config|
+        config.assets.image_optim = nil
+      end
+    end
+
+    it 'does not initialize if config.assets.image_optim is false' do
+      expect(ImageOptim).not_to receive(:new)
+      init_rails_app do |config|
+        config.assets.image_optim = false
+      end
+    end
+
+    it 'does not initialize if config.assets.compress is false' do
+      expect(ImageOptim).not_to receive(:new)
+      init_rails_app do |config|
+        config.assets.compress = false
+      end
+    end
+
+    describe 'options' do
+      it 'initializes with empty hash by default' do
+        expect(ImageOptim).to receive(:new).with({})
+        init_rails_app
+      end
+
+      it 'initializes with empty hash if config.assets.image_optim is true' do
+        expect(ImageOptim).to receive(:new).with({})
+        init_rails_app do |config|
+          config.assets.image_optim = true
+        end
+      end
+
+      it 'initializes with empty hash if config.assets.image_optim is nil' do
+        expect(ImageOptim).to receive(:new).with({})
+        init_rails_app do |config|
+          config.assets.image_optim = nil
+        end
+      end
+
+      it 'initializes with hash assigned to config.assets.image_optim' do
+        hash = double
+        expect(ImageOptim).to receive(:new).with(hash)
+        init_rails_app do |config|
+          config.assets.image_optim = hash
+        end
+      end
+
+      it 'is possible to set individual options' do
+        hash = {:config_paths => 'config/image_optim.yml'}
+        expect(ImageOptim).to receive(:new).with(hash)
+        init_rails_app do |config|
+          config.assets.image_optim.config_paths = 'config/image_optim.yml'
+        end
+      end
+
+      it 'is possible to set individual worker options' do
+        hash = {:advpng => {:level => 3}}
+        expect(ImageOptim).to receive(:new).with(hash)
+        init_rails_app do |config|
+          expect(config.assets.image_optim.advpng).to eq({})
+          config.assets.image_optim.advpng.level = 3
+        end
+      end
+
+      it 'is not possible to set unknown worker options' do
+        expect(ImageOptim).to receive(:new).with({})
+        init_rails_app do |config|
+          expect(config.assets.image_optim.unknown).to eq(nil)
+          expect do
+            config.assets.image_optim.unknown.level = 3
+          end.to raise_error(NoMethodError)
+        end
+      end
+    end
+  end
+
+  describe 'optimizing assets' do
+    before do
+      stub_const('Path', ImageOptim::Path)
+    end
+
+    %w[
+      icecream.gif
+      lena.jpg
+      rails.png
+      test.svg
+    ].each do |asset_name|
+      it "optimizes #{asset_name}" do
+        asset = init_rails_app.assets.find_asset(asset_name)
+
+        asset_data = asset.source
+        original = Path.convert(asset.pathname)
+
+        expect(asset_data).to be_smaller_than(original)
+
+        Path.temp_file_path %W[spec .#{original.image_format}] do |temp|
+          temp.binwrite(asset_data)
+
+          expect(temp).to be_similar_to(original, 0)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+require 'image_optim/pack'
+require 'image_optim/path'
+
+ENV['PATH'] = [
+  ImageOptim::Pack.path,
+  ENV['PATH'],
+].compact.join File::PATH_SEPARATOR
+
+RSpec.configure do |c|
+  c.before do
+    stub_const('ImageOptim::Config::GLOBAL_PATH', ImageOptim::Path::NULL)
+    stub_const('ImageOptim::Config::LOCAL_PATH', ImageOptim::Path::NULL)
+    ImageOptim.class_eval{ def pack; end }
+  end
+
+  c.order = :random
+end
+
+def flatten_animation(image)
+  if image.image_format == :gif
+    flattened = image.temp_path
+    command = %W[
+      convert
+      #{image.to_s.shellescape}
+      -coalesce
+      -append
+      #{flattened.to_s.shellescape}
+    ].join(' ')
+    expect(ImageOptim::Cmd.run(command)).to be_truthy
+    flattened
+  else
+    image
+  end
+end
+
+def mepp(image_a, image_b)
+  coalesce_a = flatten_animation(image_a)
+  coalesce_b = flatten_animation(image_b)
+  command = %W[
+    compare
+    -metric MEPP
+    -alpha Background
+    #{coalesce_a.to_s.shellescape}
+    #{coalesce_b.to_s.shellescape}
+    #{ImageOptim::Path::NULL}
+    2>&1
+  ].join(' ')
+  output = ImageOptim::Cmd.capture(command)
+  if [0, 1].include?($CHILD_STATUS.exitstatus)
+    num_r = '\d+(?:\.\d+(?:[eE][-+]?\d+)?)?'
+    output[/\((#{num_r}), #{num_r}\)/, 1].to_f
+  else
+    fail "compare #{image_a} with #{image_b} failed with `#{output}`"
+  end
+end
+
+RSpec::Matchers.define :be_smaller_than do |expected|
+  match{ |actual| actual.size < expected.size }
+end
+
+RSpec::Matchers.define :be_similar_to do |expected, max_difference|
+  match do |actual|
+    @diff = mepp(actual, expected)
+    @diff <= max_difference
+  end
+  failure_message do |actual|
+    "expected #{actual} to have at most #{max_difference} difference from "\
+        "#{expected}, got normalized root-mean-square error of #{@diff}"
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: image_optim_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Kuchin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: image_optim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 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: image_optim_pack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- image_optim_rails.gemspec
+- lib/image_optim/railtie.rb
+- lib/image_optim_rails.rb
+- spec/image_optim/railtie_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/toy/image_optim_rails
+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: image_optim_rails
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Optimize image assets using image_optim
+test_files:
+- spec/image_optim/railtie_spec.rb
+- spec/spec_helper.rb