image_optim 0.18.0 → 0.19.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDYwZDFmNGU4YjcwY2NmYmY1OTA5MjRmOTQ1NzhkNjM1MjhjYmUwZQ==
+    ZDA2ZTJlMWRhYTk0MmEwNmI1MzI1M2I3NGMxNWFjYjIwYWU4ZTI4Yg==
   data.tar.gz: !binary |-
-    ZTNhOTFlMjYxMGU4MjczMThiNDhiZDlkMDI2MGY4ZGM5OTlkOGFhOQ==
+    ZTA5NWU3OGU1ZTFkMDBhMzBlZGUyZmZkNTI5MGNlOTE3NDgxMDYyNQ==
 SHA512:
   metadata.gz: !binary |-
-    NTkyZDBhMTUxYTAxOTBlNjBjYWIxZWUyZGQwYTJlNDExNmJlMWMxNzc1NmE5
-    MmFlYzE2NjBjNGFkZWI4MzU1NzQwOTA3M2M0MDk3MjIyMTc1ODYyMzA3OWE0
-    NTMwNDEwMWM5ODI1MDlmZDk0NzdiNzBmYWQ2YmVhN2VkYjM4OTg=
+    YTcxM2U5OGQwMTU1NzFmNzA4NGIyNzE2NWZmYjQ4ZDFmZDQ0ZjVlZWVhZGMw
+    OGIwMjFlZDYxMWI2NmJlY2FlNjQ5ZTE3NTE2OTRmOGQ3ODdjMmFlMTBlNGQ2
+    ODgzYjY3Yzc1ODViN2ZlN2I5NTYyYThkNDY5ODQzN2QxN2FhZDM=
   data.tar.gz: !binary |-
-    NjkwMzgyYWNkNmYwYjhkMmJiYzY2NzNkY2QwMmZhNDFhZWFmYjhhMzk5ZmM2
-    YmNjOTQ2MWY5ZDY3ZGEwYzJmNGZiY2I4OTViNzNjYmNkZmE1YmZhNmFkMjM4
-    MzAwZWFlYzBlNTM2OWVjNjRiZjg1MmNlMTJkMTIxMjEzOWNlNDE=
+    Zjg1ZmJkYjQ3MmM0MDRmM2Y2ZWRhNGQwNGJhY2NhZTQ1Njg4YmQ0OWE2N2Zh
+    MTExZTM5MzkyNzZjM2Y4Y2I5ZDZiNWIyNmU0MDQyYzM2NGRkZTJmZDZhZjEx
+    MWJlNGUyYTRjODc4YWE1YzNmZThlYzFiYmM0YzAwODFmMjcxOTE=

data/.travis.yml

@@ -5,29 +5,26 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - ruby-head
   - jruby-18mode
   - jruby-19mode
-  - jruby-head
   - ree
 script:
-  - bundle exec image_optim --info
-  - bundle exec rspec
-  - '! bundle show rubocop || bundle exec rubocop' # run rubocop only if it is bundled
+  if [ -z "$RUBOCOP" ]; then
+    bundle exec image_optim --info
+    && bundle exec rspec
+  ; else
+    bundle exec rubocop
+  ; fi
 before_install:
-  - mkdir ~/bin
-
-  - echo 'Installing svgo:'
-  - npm install -g svgo
-
-  - echo 'Installing pngout:'
-  - PNGOUT_VERSION=20130221
-  - curl -L "http://static.jonof.id.au/dl/kenutils/pngout-$PNGOUT_VERSION-linux.tar.gz" | tar -xz
-  - mv pngout-$PNGOUT_VERSION-linux/x86_64/pngout ~/bin
+  if [ -z "$RUBOCOP" ]; then
+    mkdir ~/bin
+    && npm install -g svgo
+    && 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
 env:
   - PATH=~/bin:$PATH
 matrix:
   fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
+  include:
+    - env: RUBOCOP=true
+      rvm: default

data/CHANGELOG.markdown

@@ -2,6 +2,16 @@
 
 ## unreleased
 
+## v0.19.0 (2014-11-08)
+
+* Added lossy worker `jpegrecompress` (uses [`jpeg-recompress`](https://github.com/danielgtaylor/jpeg-archive#jpeg-recompress)), disabled unless `:allow_lossy` is true [#65](https://github.com/toy/image_optim/issues/65) [@wjordan](https://github.com/wjordan) [@toy](https://github.com/toy)
+* `:allow_lossy` option to allow lossy workers and optimizations [@toy](https://github.com/toy)
+* Don't warn multiple times about problematic binary [#69](https://github.com/toy/image_optim/issues/69) [@toy](https://github.com/toy)
+* Run gisicle two times (with interlace off then with on) if interlace is not set explicitly [#70](https://github.com/toy/image_optim/issues/70) [@toy](https://github.com/toy)
+* Remove app and other extensions from gif images [@toy](https://github.com/toy)
+* Change behaviour of gifsicle interlace option to deinterlace for `false`, pass `nil` to leave as is [@toy](https://github.com/toy)
+* Worker can change its initialization by overriding `init` and can initialize multiple instances [#70](https://github.com/toy/image_optim/issues/70) [@toy](https://github.com/toy)
+
 ## v0.18.0 (2014-11-01)
 
 * Add interface to `image_optim_pack` [@toy](https://github.com/toy)

data/README.markdown

@@ -6,13 +6,14 @@
 
 # image_optim
 
-Optimize (lossless compress) images (jpeg, png, gif, svg) using external utilities:
+Optimize (lossless compress, optionally lossy) images (jpeg, png, gif, svg) using external utilities:
 
 * [advpng](http://advancemame.sourceforge.net/doc-advpng.html) from [AdvanceCOMP](http://advancemame.sourceforge.net/comp-readme.html)
 (will use [zopfli](https://code.google.com/p/zopfli/) on default/maximum level 4)
 * [gifsicle](http://www.lcdf.org/gifsicle/)
 * [jhead](http://www.sentex.net/~mwandel/jhead/)
 * [jpegoptim](http://www.kokkonen.net/tjko/projects.html)
+* [jpeg-recompress](https://github.com/danielgtaylor/jpeg-archive#jpeg-recompress)
 * jpegtran from [Independent JPEG Group's JPEG library](http://www.ijg.org/)
 * [optipng](http://optipng.sourceforge.net/)
 * [pngcrush](http://pmt.sourceforge.net/pngcrush/)
@@ -173,6 +174,11 @@ _Note: pngout is free to use even in commercial soft, but you can not redistribu
 npm install -g svgo
 ```
 
+### jpeg-recompress installation (optional)
+
+Download and install the `jpeg-recompress` binary from the [JPEG-Archive Releases](https://github.com/danielgtaylor/jpeg-archive/releases) page,
+or follow the instructions to [build from source](https://github.com/danielgtaylor/jpeg-archive#building).
+
 ## Usage
 
 ### From shell
@@ -263,6 +269,7 @@ optipng:
 * `:verbose` — Verbose output *(defaults to `false`)*
 * `:pack` — Require image\_optim\_pack or disable it, by default image\_optim\_pack will be used if available, will turn on `:skip-missing-workers` unless explicitly disabled *(defaults to `nil`)*
 * `:skip_missing_workers` — Skip workers with missing or problematic binaries *(defaults to `false`)*
+* `:allow_lossy` — Allow lossy workers and optimizations *(defaults to `false`)*
 
 Worker can be disabled by passing `false` instead of options hash.
 
@@ -273,7 +280,7 @@ Worker can be disabled by passing `false` instead of options hash.
 * `:level` — Compression level: `0` - don't compress, `1` - fast, `2` - normal, `3` - extra, `4` - extreme *(defaults to `4`)*
 
 ### :gifsicle =>
-* `:interlace` — Turn interlacing on *(defaults to `false`)*
+* `:interlace` — Interlace: `true` - interlace on, `false` - interlace off, `nil` - as is in original image (defaults to running two instances, one with interlace off and one with on)
 * `:level` — Compression level: `1` - light and fast, `2` - normal, `3` - heavy (slower) *(defaults to `3`)*
 * `:careful` — Avoid bugs with some software *(defaults to `false`)*
 
@@ -284,6 +291,9 @@ Worker has no options
 * `: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`)*
 
+### :jpegrecompress =>
+* `:quality` — JPEG quality preset: `0` - low, `1` - medium, `2` - high, `3` - veryhigh *(defaults to `3`)*
+
 ### :jpegtran =>
 * `:copy_chunks` — Copy all chunks *(defaults to `false`)*
 * `:progressive` — Create progressive JPEG file *(defaults to `true`)*
@@ -291,7 +301,7 @@ Worker has no options
 
 ### :optipng =>
 * `:level` — Optimization level preset: `0` is least, `7` is best *(defaults to `6`)*
-* `:interlace` — Interlace, `true` - interlace on, `false` - interlace off, `nil` - as is in original image *(defaults to `false`)*
+* `:interlace` — Interlace: `true` - interlace on, `false` - interlace off, `nil` - as is in original image *(defaults to `false`)*
 
 ### :pngcrush =>
 * `:chunks` — List of chunks to remove or `:alla` - all except tRNS/transparency or `:allb` - all except tRNS and gAMA/gamma *(defaults to `:alla`)*

data/image_optim.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.18.0'
-  s.summary     = %q{Optimize (lossless compress) images (jpeg, png, gif, svg) using external utilities (advpng, gifsicle, jhead, jpegoptim, jpegrescan, jpegtran, optipng, pngcrush, pngout, pngquant, svgo)}
+  s.version     = '0.19.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']
   s.license     = 'MIT'
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'progress', '~> 3.0', '>= 3.0.1'
   s.add_dependency 'in_threads', '~> 1.3'
 
-  s.add_development_dependency 'image_optim_pack', '~> 0.1'
+  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'

data/lib/image_optim.rb

@@ -3,10 +3,20 @@ require 'image_optim/config'
 require 'image_optim/handler'
 require 'image_optim/image_meta'
 require 'image_optim/image_path'
+require 'image_optim/railtie' if defined?(Rails)
 require 'image_optim/worker'
 require 'in_threads'
 require 'shellwords'
 
+%w[
+  pngcrush pngout advpng optipng pngquant
+  jhead jpegoptim jpegrecompress jpegtran
+  gifsicle
+  svgo
+].each do |worker|
+  require "image_optim/worker/#{worker}"
+end
+
 # Main interface
 class ImageOptim
   # Nice level
@@ -24,6 +34,9 @@ class ImageOptim
   # Skip workers with missing or problematic binaries
   attr_reader :skip_missing_workers
 
+  # Allow lossy workers and optimizations
+  attr_reader :allow_lossy
+
   # Initialize workers, specify options using worker underscored name:
   #
   # pass false to disable worker
@@ -50,6 +63,7 @@ class ImageOptim
     @verbose = config.verbose
     @pack = config.pack
     @skip_missing_workers = config.skip_missing_workers
+    @allow_lossy = config.allow_lossy
 
     if verbose
       $stderr << "config:\n"
@@ -60,11 +74,12 @@ class ImageOptim
       $stderr << "threads: #{threads}\n"
       $stderr << "pack: #{pack}\n"
       $stderr << "skip_missing_workers: #{skip_missing_workers}\n"
+      $stderr << "allow_lossy: #{allow_lossy}\n"
     end
 
     @bin_resolver = BinResolver.new(self)
 
-    @workers_by_format = create_workers_by_format do |klass|
+    @workers_by_format = Worker.create_all_by_format(self) do |klass|
       config.for_worker(klass)
     end
 
@@ -192,25 +207,6 @@ private
     end
   end
 
-  # Create hash with format mapped to list of workers sorted by run order
-  def create_workers_by_format(&options_proc)
-    by_format = {}
-    workers = Worker.create_all(self, &options_proc)
-    if skip_missing_workers
-      workers = Worker.reject_missing(workers)
-    else
-      Worker.resolve_all!(workers)
-    end
-    sorted = workers.sort_by.with_index{ |worker, i| [worker.run_order, i] }
-    sorted.each do |worker|
-      worker.image_formats.each do |format|
-        by_format[format] ||= []
-        by_format[format] << worker
-      end
-    end
-    by_format
-  end
-
   # Run method for each item in list
   # if block given yields item and result for item and returns array of yield
   # results
@@ -235,14 +231,3 @@ private
     end
   end
 end
-
-%w[
-  pngcrush pngout advpng optipng pngquant
-  jhead jpegoptim jpegtran
-  gifsicle
-  svgo
-].each do |worker|
-  require "image_optim/worker/#{worker}"
-end
-
-require 'image_optim/railtie' if defined?(Rails)

data/lib/image_optim/bin_resolver.rb

@@ -40,10 +40,12 @@ class ImageOptim
         end
 
         @bins[name] = bin
+
+        bin.check! if bin
       end
 
       if @bins[name]
-        @bins[name].check!
+        @bins[name].check_fail!
       else
         fail BinNotFound, "`#{name}` not found"
       end

data/lib/image_optim/bin_resolver/bin.rb

@@ -8,6 +8,7 @@ class ImageOptim
   class BinResolver
     # Holds bin name and path, gets version
     class Bin
+      class UnknownVersion < Error; end
       class BadVersion < Error; end
 
       attr_reader :name, :path, :version
@@ -21,31 +22,39 @@ class ImageOptim
         "#{name} #{version || '?'} at #{path}"
       end
 
-      # Fail or warn if version is known to misbehave depending on severity
-      def check!
-        unless version
-          fail BadVersion, "didn't get version of #{name} at #{path}"
+      is = ComparableCondition.is
+
+      FAIL_CHECKS = [
+        [:pngcrush, is.between?('1.7.60', '1.7.65'), 'is known to produce '\
+              'broken pngs'],
+        [:pngquant, is < '2.0', 'is not supported'],
+      ]
+
+      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'],
+      ]
+
+      # Fail if version will not work properly
+      def check_fail!
+        fail UnknownVersion, "didn't get version of #{self}" unless version
+
+        FAIL_CHECKS.each do |bin_name, matcher, message|
+          next unless bin_name == name
+          next unless matcher.match(version)
+          fail BadVersion, "#{self} (#{matcher}) #{message}"
         end
+      end
 
-        is = ComparableCondition.is
-        case name
-        when :pngcrush
-          case version
-          when c = is.between?('1.7.60', '1.7.65')
-            fail BadVersion, "#{self} (#{c}) is known to produce broken pngs"
-          end
-        when :advpng
-          case version
-          when c = is < '1.17'
-            warn "WARN: #{self} (#{c}) does not use zopfli"
-          end
-        when :pngquant
-          case version
-          when c = is < '2.0'
-            fail BadVersion, "#{self} (#{c}) is not supported"
-          when c = is < '2.1'
-            warn "WARN: #{self} (#{c}) may be lossy even with quality `100-`"
-          end
+      # Run check_fail!, otherwise warn if version is known to misbehave
+      def check!
+        check_fail!
+
+        WARN_CHECKS.each do |bin_name, matcher, message|
+          next unless bin_name == name
+          next unless matcher.match(version)
+          warn "WARN: #{self} (#{matcher}) #{message}"
         end
       end
 
@@ -64,7 +73,7 @@ class ImageOptim
           capture("#{escaped_path} --version 2> /dev/null")[/\d+(\.\d+){1,}/]
         when :svgo
           capture("#{escaped_path} --version 2>&1")[/\d+(\.\d+){1,}/]
-        when :jhead
+        when :jhead, :'jpeg-recompress'
           capture("#{escaped_path} -V 2> /dev/null")[/\d+(\.\d+){1,}/]
         when :jpegtran
           capture("#{escaped_path} -v - 2>&1")[/version (\d+\S*)/, 1]

data/lib/image_optim/config.rb

@@ -142,6 +142,11 @@ class ImageOptim
       end
     end
 
+    # Allow lossy workers and optimizations, converted to boolean
+    def allow_lossy
+      !!get!(:allow_lossy)
+    end
+
     # Options for worker class by its `bin_sym`:
     # * `Hash` passed as is
     # * `{}` for `true` or `nil`

data/lib/image_optim/runner/option_parser.rb

@@ -157,6 +157,13 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
   op.separator nil
   op.separator '  Worker options:'
 
+  op.on('--allow-lossy', 'Allow lossy workers and '\
+      'optimizations') do |allow_lossy|
+    options[:allow_lossy] = allow_lossy
+  end
+
+  op.separator nil
+
   ImageOptim::Worker.klasses.each_with_index do |klass, i|
     next if klass.option_definitions.empty?
     op.separator nil unless i.zero?
@@ -180,12 +187,12 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
         fail "Unknown type #{type}"
       end
 
-      description_lines = %W[
-        #{option_definition.description.gsub(' - ', ' - ')}
-        (defaults to #{default})
-      ].join(' ')
+      description = option_definition.description.gsub(' - ', ' - ')
+      unless description['(defaults']
+        description << " (defaults to #{default})"
+      end
 
-      op.on("--#{bin}-#{name} #{marking}", type, *description_lines) do |value|
+      op.on("--#{bin}-#{name} #{marking}", type, description) do |value|
         options[bin] = {} unless options[bin].is_a?(Hash)
         options[bin][option_definition.name.to_sym] = value
       end

data/lib/image_optim/worker.rb

@@ -1,84 +1,32 @@
 # encoding: UTF-8
 
-require 'image_optim/bin_resolver/error'
-require 'image_optim/configuration_error'
-require 'image_optim/option_definition'
-require 'image_optim/option_helpers'
 require 'image_optim/cmd'
+require 'image_optim/configuration_error'
+require 'image_optim/worker/class_methods'
 require 'shellwords'
 require 'English'
 
 class ImageOptim
   # Base class for all workers
   class Worker
-    @klasses = []
+    extend ClassMethods
 
     class << self
-      # List of available workers
-      def klasses
-        @klasses.to_enum
-      end
-
-      # Remember all classes inheriting from this one
-      def inherited(base)
-        @klasses << base
-      end
-
-      # Underscored class name symbol
-      def bin_sym
-        @underscored_name ||= name.
-          split('::').last. # get last part
-          gsub(/([a-z])([A-Z])/, '\1_\2').downcase. # convert AbcDef to abc_def
-          to_sym
-      end
-
-      def option_definitions
-        @option_definitions ||= []
-      end
-
-      def option(name, default, type, description = nil, &proc)
-        attr_reader name
-        option_definitions <<
-          OptionDefinition.new(name, default, type, description, &proc)
-      end
-
-      # Initialize all workers using options from calling options_proc with
-      # klass
-      def create_all(image_optim, &options_proc)
-        Worker.klasses.map do |klass|
-          next unless (options = options_proc[klass])
-          klass.new(image_optim, options)
-        end.compact
-      end
-
-      # Resolve all bins of all workers failing with one joint exception
-      def resolve_all!(workers)
-        errors = BinResolver.collect_errors(workers) do |worker|
-          worker.resolve_used_bins!
-        end
-        return if errors.empty?
-        fail BinResolver::Error, ['Bin resolving errors:', *errors].join("\n")
-      end
-
-      # Resolve all bins of all workers showing warning for missing ones and
-      # returning others
-      def reject_missing(workers)
-        resolved = []
-        errors = BinResolver.collect_errors(workers) do |worker|
-          worker.resolve_used_bins!
-          resolved << worker
-        end
-        errors.each{ |error| warn error }
-        resolved
-      end
+      # Default init for worker is new
+      # Check example of override in gifsicle worker
+      alias_method :init, :new
     end
 
+    # Allow lossy optimizations
+    attr_reader :allow_lossy
+
     # Configure (raises on extra options)
     def initialize(image_optim, options = {})
       unless image_optim.is_a?(ImageOptim)
         fail ArgumentError, 'first parameter should be an ImageOptim instance'
       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]