image_optim 0.19.1 → 0.20.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjM5MmFhN2E0NDJiNjFlOGYxODBhNWVjNzRmNjU5NjM1NWQxZmZjMA==
+    ZjNhMTRkY2JmMWRjOTY1NmZiYjI3Yjk3M2U1MTM5YzJkMjMzNWFkMw==
   data.tar.gz: !binary |-
-    MDM3NjNhNjdiYmMwNjY2YmMwMDY5MjMzZjRkNWJmMDA3NGEzYTM0Yg==
+    ZjI1MTQ3ZTdkMmNkNjE3ZDdhYzQyZDlmMmYzYzQwMDNjNTUxODY3Yg==
 SHA512:
   metadata.gz: !binary |-
-    M2Y1NGU4MjFiYTZjNWE4MmZkNTRkM2Q4NmMzZWE2ODgwZmRlMjc0NTA3NTlk
-    MDg1MjIzMzM1YzU0NzVjYjA3OTFiNWU0ODYzMWM0MjcxYWUwYzcwYmJkZjI3
-    MDM4YjZmMTdiYWIyODE4OGM4NDA1Yjc2NzI1MDdhZmU4YmEzNWQ=
+    ZTBiM2M5NmNjY2JhYWExMDNjZDQ3MjlkMmE1MDkxMmNhMGE1OGYwYzkzOTBm
+    ZTcwZTU4ZTFiZDg1ZjBlNjAyNGRlY2MzMzExYzRkNTgzZGNmMjQ1NzcxMzkw
+    YTY0NDJjYTA3NjJjN2Q1ODgwOGEzYzQ3M2I1ZmM3ZmEzNjIwYzA=
   data.tar.gz: !binary |-
-    MGJlOGE1OGNmN2MxZmZkYTU5NzgzZGFmZjRlNWZkNTA4ODg2ZDJhZDViMzMw
-    NTEwZTliN2Y1ZDgzMTkyYTlmYzU1Y2Q0MzllZGE2NTZhYzYwNzdiYjViNTJm
-    MTRjZmI3MGNhNmZlNDQxZjIzMDRiZGMzYjI3YzdmMzAzODU4NTA=
+    YzZiYmUzYmJkODI2Yzg5MTUwN2U1ZjI0MzYxMzM1Y2RjMzVmYTEyMzY3Nzcz
+    M2NjODVjMGU2YmM5ZmZlYzM0NmQ5MDA0OTNhYmI2YmJlZDk3MDE4YTU0MWFk
+    YTk0YWJiNmFkNmZmOWU3Yzc5YzRjNzY0MDBkZDM5ODU0NjcyMjM=

data/.rubocop.yml

@@ -5,6 +5,9 @@ AllCops:
 Lint/EndAlignment:
   AlignWith: variable
 
+Metrics/AbcSize:
+  Max: 30
+
 Metrics/ClassLength:
   Max: 150
 

data/.travis.yml

@@ -3,8 +3,9 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - '2.0'
+  - '2.1'
+  - '2.2'
   - jruby-18mode
   - jruby-19mode
   - ree
@@ -25,6 +26,12 @@ env:
   - PATH=~/bin:$PATH
 matrix:
   fast_finish: true
+  allow_failures:
+    - rvm: '2.2'
   include:
     - env: RUBOCOP=true
       rvm: default
+addons:
+  code_climate:
+    repo_token:
+      secure: FDikT3JnOJHOAFSaKwVPB1VOphU0sSzAnzQ+YjSt9XFE+9uFQHth/j4rFoVoqALhCj+47trv6spwkbcSjGCVzm+87OI80GkLCCzNjDOz2W4sP9JWItVgS1VoWW+ioPxpLgpguTb3wutwKOUMEAf+40EX657ZiHumM7nNHrF+RCU=

data/CHANGELOG.markdown

@@ -2,6 +2,12 @@
 
 ## unreleased
 
+## v0.20.0 (2014-12-15)
+
+* Ignore and show warning for lossy options `jpegoptim#max_quality` and `pngquant#quality` in default/lossless mode [#71](https://github.com/toy/image_optim/issues/71) [@toy](https://github.com/toy)
+* Add `:blacken` option to `pngcrush` worker, to blacken fully transparent pixels, on by default [@toy](https://github.com/toy)
+* Command line option `--no-progress` to disable showing progress of optimizing images [@toy](https://github.com/toy)
+
 ## v0.19.1 (2014-11-22)
 
 * Blacklist pngcrush 1.7.80 as it loses one color in indexed images [@toy](https://github.com/toy)

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9')
+  gem 'codeclimate-test-reporter', :group => :test, :require => nil
+end

data/README.markdown

@@ -1,6 +1,7 @@
 [![Gem Version](https://img.shields.io/gem/v/image_optim.svg?style=flat)](https://rubygems.org/gems/image_optim)
 [![Build Status](https://img.shields.io/travis/toy/image_optim/master.svg?style=flat)](https://travis-ci.org/toy/image_optim)
 [![Code Climate](https://img.shields.io/codeclimate/github/toy/image_optim.svg?style=flat)](https://codeclimate.com/github/toy/image_optim)
+[![Code Climate Coverage](https://img.shields.io/codeclimate/coverage/github/toy/image_optim.svg?style=flat)](https://codeclimate.com/github/toy/image_optim)
 [![Dependency Status](https://img.shields.io/gemnasium/toy/image_optim.svg?style=flat)](https://gemnasium.com/toy/image_optim)
 [![Inch CI](http://inch-ci.org/github/toy/image_optim.svg?branch=master&style=flat)](http://inch-ci.org/github/toy/image_optim)
 
@@ -289,7 +290,7 @@ Worker has no options
 
 ### :jpegoptim =>
 * `:strip` — List of extra markers to strip: `:comments`, `:exif`, `:iptc`, `:icc` or `:all` *(defaults to `:all`)*
-* `:max_quality` — Maximum image quality factor `0`..`100` *(defaults to `100`)*
+* `:max_quality` — Maximum image quality factor `0`..`100`, ignored in default/lossless mode *(defaults to `100`)*
 
 ### :jpegrecompress =>
 * `:quality` — JPEG quality preset: `0` - low, `1` - medium, `2` - high, `3` - veryhigh *(defaults to `3`)*
@@ -307,13 +308,14 @@ Worker has no options
 * `:chunks` — List of chunks to remove or `:alla` - all except tRNS/transparency or `:allb` - all except tRNS and gAMA/gamma *(defaults to `:alla`)*
 * `:fix` — Fix otherwise fatal conditions such as bad CRCs *(defaults to `false`)*
 * `:brute` — Brute force try all methods, very time-consuming and generally not worthwhile *(defaults to `false`)*
+* `:blacken` — Blacken fully transparent pixels *(defaults to `true`)*
 
 ### :pngout =>
 * `:copy_chunks` — Copy optional chunks *(defaults to `false`)*
 * `:strategy` — Strategy: `0` - xtreme, `1` - intense, `2` - longest Match, `3` - huffman Only, `4` - uncompressed *(defaults to `0`)*
 
 ### :pngquant =>
-* `:quality` — min..max - don't save below min, use less colors below max (both in range `0..100`; in yaml - `!ruby/range 0..100`) *(defaults to `100..100`)*
+* `:quality` — min..max - don't save below min, use less colors below max (both in range `0..100`; in yaml - `!ruby/range 0..100`), ignored in default/lossless mode *(defaults to `100..100`)*
 * `:speed` — speed/quality trade-off: `1` - slow, `3` - default, `11` - fast & rough *(defaults to `3`)*
 
 ### :svgo =>

data/image_optim.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.19.1'
+  s.version     = '0.20.0'
   s.summary     = %q{Optimize (lossless compress, optionally lossy) images (jpeg, png, gif, svg) using external utilities (advpng, gifsicle, jhead, jpeg-recompress, jpegoptim, jpegrescan, jpegtran, optipng, pngcrush, pngout, pngquant, svgo)}
   s.homepage    = "http://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'image_optim_pack', '~> 0.2'
   s.add_development_dependency 'rspec', '~> 3.0'
   if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.3')
-    s.add_development_dependency 'rubocop', '~> 0.26.0'
+    s.add_development_dependency 'rubocop', '~> 0.27'
   end
   s.add_development_dependency 'haml', '~> 4.0'
 end

data/lib/image_optim.rb

@@ -58,23 +58,18 @@ class ImageOptim
   #     ImageOptim.new(:nice => 20)
   def initialize(options = {})
     config = Config.new(options)
-    @nice = config.nice
-    @threads = config.threads
     @verbose = config.verbose
-    @pack = config.pack
-    @skip_missing_workers = config.skip_missing_workers
-    @allow_lossy = config.allow_lossy
-
-    if verbose
-      $stderr << "config:\n"
-      config.to_s.each_line do |line|
-        $stderr << "  #{line}"
-      end
-      $stderr << "nice: #{nice}\n"
-      $stderr << "threads: #{threads}\n"
-      $stderr << "pack: #{pack}\n"
-      $stderr << "skip_missing_workers: #{skip_missing_workers}\n"
-      $stderr << "allow_lossy: #{allow_lossy}\n"
+    $stderr << "config:\n#{config.to_s.gsub(/^/, '  ')}" if verbose
+
+    %w[
+      nice
+      threads
+      pack
+      skip_missing_workers
+      allow_lossy
+    ].each do |name|
+      instance_variable_set(:"@#{name}", config.send(name))
+      $stderr << "#{name}: #{send(name)}\n" if verbose
     end
 
     @bin_resolver = BinResolver.new(self)

data/lib/image_optim/bin_resolver/bin.rb

@@ -33,8 +33,9 @@ class ImageOptim
 
       WARN_CHECKS = [
         [:advpng, is < '1.17', 'does not use zopfli'],
-        [:pngquant, is < '2.1', 'may be lossy even with quality `100-`'],
         [:gifsicle, is < '1.85', 'does not support removing extension blocks'],
+        [:pngcrush, is < '1.7.38', 'does not have blacken flag'],
+        [:pngquant, is < '2.1', 'may be lossy even with quality `100-`'],
       ]
 
       # Fail if version will not work properly

data/lib/image_optim/config.rb

@@ -193,9 +193,9 @@ class ImageOptim
       when /mswin|mingw/
         require 'win32ole'
         WIN32OLE.
-          connect('winmgmts://').
-          ExecQuery('select NumberOfLogicalProcessors from Win32_Processor').
-          to_enum.first.NumberOfLogicalProcessors
+        connect('winmgmts://').
+        ExecQuery('select NumberOfLogicalProcessors from Win32_Processor').
+        to_enum.first.NumberOfLogicalProcessors
       else
         warn "Unknown architecture (#{host_os}) assuming one processor."
         1

data/lib/image_optim/option_definition.rb

@@ -14,5 +14,19 @@ class ImageOptim
       @description = description.to_s
       @default, @type, @proc = default, type, proc
     end
+
+    # Get value for worker from options
+    def value(worker, options)
+      value = options.key?(name) ? options[name] : default
+      if proc
+        if proc.arity == 2
+          worker.instance_exec(value, self, &proc)
+        else
+          worker.instance_exec(value, &proc)
+        end
+      else
+        value
+      end
+    end
   end
 end

data/lib/image_optim/railtie.rb

@@ -14,13 +14,15 @@ class ImageOptim
       app.assets
     end
 
-    def register_preprocessor(app)
-      options = if app.config.assets.image_optim == true
+    def options
+      if app.config.assets.image_optim == true
         {}
       else
         app.config.assets.image_optim || {}
       end
+    end
 
+    def register_preprocessor(app)
       image_optim = ImageOptim.new(options)
 
       processor = proc do |_context, data|

data/lib/image_optim/runner.rb

@@ -46,6 +46,7 @@ class ImageOptim
     def initialize(options)
       options = HashHelpers.deep_symbolise_keys(options)
       @recursive = options.delete(:recursive)
+      @progress = options.delete(:show_progress) != false
       @exclude_dir_globs, @exclude_file_globs = %w[dir file].map do |type|
         glob = options.delete(:"exclude_#{type}_glob") || '.*'
         GlobHelpers.expand_braces(glob)
@@ -71,8 +72,8 @@ class ImageOptim
   private
 
     def optimize_images!(to_optimize, &block)
-      @image_optim.
-        optimize_images!(to_optimize.with_progress('optimizing'), &block)
+      to_optimize = to_optimize.with_progress('optimizing') if @progress
+      @image_optim.optimize_images!(to_optimize, &block)
     end
 
     def find_to_optimize(paths)

data/lib/image_optim/runner/option_parser.rb

@@ -124,6 +124,10 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
 
   op.separator nil
 
+  op.on('--no-progress', 'Disable showing progress') do |show_progress|
+    options[:show_progress] = show_progress
+  end
+
   op.on('--[no-]threads N', Integer, 'Number of threads or disable '\
       '(defaults to number of processors)') do |threads|
     options[:threads] = threads

data/lib/image_optim/worker.rb

@@ -27,18 +27,7 @@ class ImageOptim
       end
       @image_optim = image_optim
       @allow_lossy = !!options.delete(:allow_lossy)
-      self.class.option_definitions.each do |option_definition|
-        value = if options.key?(option_definition.name)
-          options[option_definition.name]
-        else
-          option_definition.default
-        end
-        if option_definition.proc
-          value = option_definition.proc[value]
-        end
-        instance_variable_set("@#{option_definition.name}", value)
-      end
-
+      parse_options(options)
       assert_no_unknown_options!(options)
     end
 
@@ -100,6 +89,13 @@ class ImageOptim
 
   private
 
+    def parse_options(options)
+      self.class.option_definitions.each do |option_definition|
+        value = option_definition.value(self, options)
+        instance_variable_set("@#{option_definition.name}", value)
+      end
+    end
+
     def assert_no_unknown_options!(options)
       known_keys = self.class.option_definitions.map(&:name)
       unknown_options = options.reject{ |key, _value| known_keys.include?(key) }

data/lib/image_optim/worker/class_methods.rb

@@ -21,7 +21,8 @@ class ImageOptim
 
       # Underscored class name symbol
       def bin_sym
-        @underscored_name ||= name.
+        @underscored_name ||=
+          name.
           split('::').last. # get last part
           gsub(/([a-z])([A-Z])/, '\1_\2').downcase. # convert AbcDef to abc_def
           to_sym
@@ -33,8 +34,8 @@ class ImageOptim
 
       def option(name, default, type, description = nil, &proc)
         attr_reader name
-        option_definitions <<
-          OptionDefinition.new(name, default, type, description, &proc)
+        OptionDefinition.new(name, default, type, description, &proc).
+          tap{ |option_definition| option_definitions << option_definition }
       end
 
       # Create hash with format mapped to list of workers sorted by run order

data/lib/image_optim/worker/jpegoptim.rb

@@ -23,8 +23,16 @@ class ImageOptim
 
       MAX_QUALITY_OPTION =
       option(:max_quality, 100, 'Maximum image quality factor '\
-          '`0`..`100`') do |v|
-        OptionHelpers.limit_with_range(v.to_i, 0..100)
+          '`0`..`100`, ignored in default/lossless mode') do |v, opt_def|
+        if allow_lossy
+          OptionHelpers.limit_with_range(v.to_i, 0..100)
+        else
+          if v != opt_def.default
+            warn "#{self.class.bin_sym} #{opt_def.name} #{v} ignored " \
+                'in lossless mode'
+          end
+          opt_def.default
+        end
       end
 
       # Run first [-1] if max_quality < 100 otherwise with normal priority

data/lib/image_optim/worker/pngcrush.rb

@@ -19,25 +19,35 @@ class ImageOptim
       option(:brute, false, 'Brute force try all methods, '\
           'very time-consuming and generally not worthwhile'){ |v| !!v }
 
+      BLACKEN_OPTION =
+      option(:blacken, true, 'Blacken fully transparent pixels'){ |v| !!v }
+
       # Always run first [-1]
       def run_order
         -1
       end
 
       def optimize(src, dst)
-        args = %W[
+        flags = %w[
           -reduce
           -cc
           -q
+        ]
+        chunks.each do |chunk|
+          flags.push '-rem', chunk
+        end
+        flags.push '-fix' if fix
+        flags.push '-brute' if brute
+        if resolve_bin!(:pngcrush).version >= '1.7.38'
+          flags.push '-blacken' if blacken
+        end
+
+        args = flags + %W[
           --
           #{src}
           #{dst}
         ]
-        chunks.each do |chunk|
-          args.unshift '-rem', chunk
-        end
-        args.unshift '-fix' if fix
-        args.unshift '-brute' if brute
+
         execute(:pngcrush, *args) && optimized?(src, dst)
       end
     end

data/lib/image_optim/worker/pngquant.rb

@@ -9,9 +9,18 @@ class ImageOptim
       QUALITY_OPTION =
       option(:quality, 100..100, NonNegativeIntegerRange, 'min..max - don\'t '\
           'save below min, use less colors below max (both in range `0..100`; '\
-          'in yaml - `!ruby/range 0..100`)') do |v|
-        min = OptionHelpers.limit_with_range(v.begin, 0..100)
-        min..OptionHelpers.limit_with_range(v.end, min..100)
+          'in yaml - `!ruby/range 0..100`), ignored in default/lossless '\
+          'mode') do |v, opt_def|
+        if allow_lossy
+          min = OptionHelpers.limit_with_range(v.begin, 0..100)
+          min..OptionHelpers.limit_with_range(v.end, min..100)
+        else
+          if v != opt_def.default
+            warn "#{self.class.bin_sym} #{opt_def.name} #{v} ignored " \
+                'in lossless mode'
+          end
+          opt_def.default
+        end
       end
 
       SPEED_OPTION =

data/script/worker_analysis

@@ -381,13 +381,24 @@ class Analyser
         @avg_ratio = results.sum(&:ratio) / results.length
         @avg_difference = results.sum(&:difference) / results.length
         @max_difference = results.map(&:difference).max
-        @warn_level = case
+        @time = results.sum(&:time)
+
+        @warn_level = calculate_warn_level
+        @speed = calculate_speed
+      end
+
+    private
+
+      def calculate_warn_level
+        case
         when max_difference >= 0.1 then 'high'
         when max_difference >= 0.01 then 'medium'
         when max_difference >= 0.001 then 'low'
         end
-        @time = results.sum(&:time)
-        @speed = case
+      end
+
+      def calculate_speed
+        case
         when time > 0 then (original_size - optimized_size) / time
         when original_size == optimized_size then 0
         else 1.0 / 0.0

data/spec/image_optim/hash_helpers_spec.rb

@@ -73,5 +73,4 @@ describe ImageOptim::HashHelpers do
 
     expect(HashHelpers.deep_merge(merge_a, merge_b)).to eq(merge_result)
   end
-
 end

data/spec/image_optim/worker_spec.rb

@@ -156,4 +156,35 @@ describe ImageOptim::Worker do
       end
     end
   end
+
+  describe :option do
+    it 'runs option block in context of worker' do
+      # don't add Abc to list of wokers
+      allow(ImageOptim::Worker).to receive(:inherited)
+
+      stub_const('Abc', Class.new(Worker) do
+        option(:test, 1, 'Test context') do |_v|
+          some_instance_method
+        end
+      end)
+
+      expect_any_instance_of(Abc).
+        to receive(:some_instance_method).and_return(20)
+      expect(Abc.new(ImageOptim.new).test).to eq(20)
+    end
+
+    it 'returns instance of OptionDefinition' do
+      # don't add Abc to list of wokers
+      allow(ImageOptim::Worker).to receive(:inherited)
+
+      definition = nil
+      Class.new(Worker) do
+        definition = option(:test, 1, 'Test'){ |v| v }
+      end
+
+      expect(definition).to be_an(ImageOptim::OptionDefinition)
+      expect(definition.name).to eq(:test)
+      expect(definition.default).to eq(1)
+    end
+  end
 end

data/spec/image_optim_spec.rb

@@ -75,6 +75,7 @@ describe ImageOptim do
       nrmse_command = %W[
         compare
         -metric RMSE
+        -alpha Background
         #{coalesce_a.to_s.shellescape}
         #{coalesce_b.to_s.shellescape}
         /dev/null

data/spec/images/invisiblepixels/generate

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+Dir.chdir(File.dirname(__FILE__))
+
+require 'shellwords'
+
+side = 64
+
+IO.popen(%W[
+  convert
+  -depth 8
+  -size #{side}x#{side}
+  -strip
+  rgba:-
+  PNG32:image.png
+].shelljoin, 'w') do |f|
+  side.times do |a|
+    side.times do |b|
+      alpha = [0, 1, 0x7f, 0xff][(a / 8 + b / 8) % 4]
+      f << [rand(256), rand(256), rand(256), alpha].pack('C*')
+    end
+  end
+end
+system 'image_optim --pngcrush-blacken=n image.png'

data/spec/spec_helper.rb

@@ -1,3 +1,12 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  begin
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter.start
+  rescue LoadError => e
+    $stderr.puts "Got following while loading codeclimate-test-reporter: #{e}"
+  end
+end
+
 RSpec.configure do |c|
   c.alias_example_to :they
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_optim
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Ivan Kuchin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -126,14 +126,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: '0.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: '0.27'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,8 @@ files:
 - spec/images/decompressed.jpeg
 - spec/images/icecream.gif
 - spec/images/image.jpg
+- spec/images/invisiblepixels/generate
+- spec/images/invisiblepixels/image.png
 - spec/images/lena.jpg
 - spec/images/orient/0.jpg
 - spec/images/orient/1.jpg
@@ -260,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: image_optim
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Optimize (lossless compress, optionally lossy) images (jpeg, png, gif, svg)
@@ -284,6 +286,8 @@ test_files:
 - spec/images/decompressed.jpeg
 - spec/images/icecream.gif
 - spec/images/image.jpg
+- spec/images/invisiblepixels/generate
+- spec/images/invisiblepixels/image.png
 - spec/images/lena.jpg
 - spec/images/orient/0.jpg
 - spec/images/orient/1.jpg
@@ -303,3 +307,4 @@ test_files:
 - spec/images/transparency2.png
 - spec/images/vergroessert.jpg
 - spec/spec_helper.rb
+has_rdoc: