image_optim 0.17.1 → 0.18.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTM0NDFkYmE3MDIyOTgyMGNkMzEzNDk4NTk1NWI3MjM0ODU1NTJkYQ==
+    ZDYwZDFmNGU4YjcwY2NmYmY1OTA5MjRmOTQ1NzhkNjM1MjhjYmUwZQ==
   data.tar.gz: !binary |-
-    N2FlNDFjZmNhMDRhOTliOTdkYzA3MjcxMTE0Y2NiMjNiNTdiYWUxYQ==
+    ZTNhOTFlMjYxMGU4MjczMThiNDhiZDlkMDI2MGY4ZGM5OTlkOGFhOQ==
 SHA512:
   metadata.gz: !binary |-
-    OTBlZDI2NjQwMTkyMjNlYzg3YWUwNjI0NzgxMjgzY2M5ZjI1ZjdjZTg1MDlk
-    NjQ0MWExMzI1MGM2YjNkYjkwMDVmMjNhNTc5NWQ3MTk5YzY4ZGU5YTM0YTUy
-    YjhmOWUzMjg1Yzg0YWIxZGJjMzcxODY5NWYyMDRhMDQ2YzFiN2Y=
+    NTkyZDBhMTUxYTAxOTBlNjBjYWIxZWUyZGQwYTJlNDExNmJlMWMxNzc1NmE5
+    MmFlYzE2NjBjNGFkZWI4MzU1NzQwOTA3M2M0MDk3MjIyMTc1ODYyMzA3OWE0
+    NTMwNDEwMWM5ODI1MDlmZDk0NzdiNzBmYWQ2YmVhN2VkYjM4OTg=
   data.tar.gz: !binary |-
-    OGI2OWRiNzAxZjhjMzM4N2QyZGFkMDc2N2U1NDM1N2YwNGM2NGJjYTE1MDg4
-    YmNkMTE1MGNlZTk3ODk5MWMwODVlY2UyYWUwYWIyNzllOTViMDA2NWYxNjI2
-    MjIxMDUzNmVlZTg4YTQxYWE1MWQ2NGMwNjYwMGQ5NDU5NzM3YmE=
+    NjkwMzgyYWNkNmYwYjhkMmJiYzY2NzNkY2QwMmZhNDFhZWFmYjhhMzk5ZmM2
+    YmNjOTQ2MWY5ZDY3ZGEwYzJmNGZiY2I4OTViNzNjYmNkZmE1YmZhNmFkMjM4
+    MzAwZWFlYzBlNTM2OWVjNjRiZjg1MmNlMTJkMTIxMjEzOWNlNDE=

data/.gitignore

@@ -13,3 +13,4 @@ Makefile
 /tmp/
 
 /analysis/
+/.analysis_variants.yml

data/.travis.yml

@@ -1,5 +1,4 @@
-language:
-  - ruby
+language: ruby
 rvm:
   - 1.8.7
   - 1.9.2
@@ -12,30 +11,18 @@ rvm:
   - 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
 before_install:
-  - sudo apt-get update -qq
-  - sudo apt-get install -qq gifsicle jhead jpegoptim libjpeg-progs optipng pngcrush
-  - npm install -g svgo
   - mkdir ~/bin
 
-  - echo 'Installing advancecomp(advpng):'
-  - ADVANCECOMP_VERSION=1.19
-  - wget http://downloads.sourceforge.net/project/advancemame/advancecomp/$ADVANCECOMP_VERSION/advancecomp-$ADVANCECOMP_VERSION.tar.gz
-  - tar -xzf advancecomp-$ADVANCECOMP_VERSION.tar.gz
-  - (cd advancecomp-$ADVANCECOMP_VERSION && ./configure && make)
-  - mv advancecomp-$ADVANCECOMP_VERSION/advpng ~/bin
-
-  - echo 'Installing pngquant:'
-  - git clone git://github.com/pornel/pngquant.git
-  - (cd pngquant && git checkout $(git describe --tags --abbrev=0) && make)
-  - mv pngquant/pngquant ~/bin
+  - echo 'Installing svgo:'
+  - npm install -g svgo
 
   - echo 'Installing pngout:'
   - PNGOUT_VERSION=20130221
-  - wget http://static.jonof.id.au/dl/kenutils/pngout-$PNGOUT_VERSION-linux.tar.gz
-  - tar -xzf pngout-$PNGOUT_VERSION-linux.tar.gz
+  - 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
 env:
   - PATH=~/bin:$PATH

data/CHANGELOG.markdown

@@ -2,6 +2,16 @@
 
 ## unreleased
 
+## v0.18.0 (2014-11-01)
+
+* Add interface to `image_optim_pack` [@toy](https://github.com/toy)
+* Use `in_threads ~> 1.3` [@toy](https://github.com/toy)
+* Added options to Gifsicle, specifically --careful (for compatibility) and --optimize for granularity [#51](https://github.com/toy/image_optim/issues/51) [@kaspergrubbe](https://github.com/kaspergrubbe)
+* `:skip_missing_workers` option to skip workers with missing or problematic binaries [#66](https://github.com/toy/image_optim/issues/66) [@toy](https://github.com/toy)
+* Speedup specs (~8x) [#60](https://github.com/toy/image_optim/issues/60) [@toy](https://github.com/toy)
+* `script/worker_analysis` to compare worker chains by optimization, time and losslessness [@toy](https://github.com/toy)
+* `Cmd` module to ensure interrupted commands can't go unnoticed [@toy](https://github.com/toy)
+
 ## v0.17.1 (2014-10-06)
 
 * Fix bin path resolving method missing vendor directory [@toy](https://github.com/toy)

data/README.markdown

@@ -3,7 +3,6 @@
 [![Code Climate](https://img.shields.io/codeclimate/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)
-[![Gittip](https://img.shields.io/gittip/toy.svg?style=flat)](https://www.gittip.com/toy/)
 
 # image_optim
 
@@ -31,6 +30,12 @@ Documentation for [latest version](http://rubydoc.info/gems/image_optim/frames)
 gem install image_optim
 ```
 
+You may also want to install [`image_optim_pack`](https://github.com/toy/image_optim_pack) (see [Binaries pack](#binaries-pack)).
+
+```sh
+gem install image_optim_pack
+```
+
 ### Bundler
 
 Add to your `Gemfile`:
@@ -39,6 +44,13 @@ Add to your `Gemfile`:
 gem 'image_optim'
 ```
 
+With `image_optim_pack`:
+
+```ruby
+gem 'image_optim'
+gem 'image_optim_pack'
+```
+
 With version:
 
 ```ruby
@@ -79,6 +91,14 @@ Besides permanently setting environment variables in `~/.profile`, `~/.bash_prof
 
 ## Binaries installation
 
+### Binaries pack
+
+Easiest way to get latest versions of most binaries for `image_optim` for Linux and Mac OS X is by installing [`image_optim_pack`](https://github.com/toy/image_optim_pack) gem.
+
+Check installation instructions in [Gem installation](#gem-installation) section.
+
+Pack doesn't include `pngout` and `svgo` binaries, their installation instructions are provided below.
+
 ### Linux - Debian/Ubuntu
 
 ```bash
@@ -241,6 +261,8 @@ optipng:
 * `:nice` — Nice level *(defaults to `10`)*
 * `:threads` — Number of threads or disable *(defaults to number of processors)*
 * `: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`)*
 
 Worker can be disabled by passing `false` instead of options hash.
 
@@ -252,6 +274,8 @@ Worker can be disabled by passing `false` instead of options hash.
 
 ### :gifsicle =>
 * `:interlace` — Turn interlacing on *(defaults to `false`)*
+* `:level` — Compression level: `1` - light and fast, `2` - normal, `3` - heavy (slower) *(defaults to `3`)*
+* `:careful` — Avoid bugs with some software *(defaults to `false`)*
 
 ### :jhead =>
 Worker has no options
@@ -289,8 +313,14 @@ Worker has no options
 
 ## Contributing
 
+[List](https://github.com/toy/image_optim/graphs/contributors) of contributors to `image_optim`.
+
 If you would like to contribute - that is great and you are very welcome. Please check few notes in file [CONTRIBUTING.markdown](CONTRIBUTING.markdown).
 
+Financial contributions can be made via [gratipay](https://gratipay.com/toy/).
+
+[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.1.2/dist/gratipay.png)](https://gratipay.com/toy/)
+
 ## ChangeLog
 
 In separate file [CHANGELOG.markdown](CHANGELOG.markdown).

data/bin/image_optim

@@ -2,145 +2,13 @@
 # encoding: UTF-8
 
 require 'image_optim/runner'
-require 'image_optim/true_false_nil'
-require 'image_optim/non_negative_integer_range'
+require 'image_optim/runner/option_parser'
 
-options = {}
+args = ARGV.dup
 
-option_parser = OptionParser.new do |op|
-  ImageOptim::TrueFalseNil.add_to_option_parser(op)
-  ImageOptim::NonNegativeIntegerRange.add_to_option_parser(op)
-
-  op.banner = <<-TEXT.gsub(/^\s*\|/, '')
-    |#{ImageOptim.full_version}
-    |
-    |Usege:
-    |  #{op.program_name} [options] image_path …
-    |
-    |Configuration will be read and prepanded to options from two paths:
-    |  #{ImageOptim::Config::GLOBAL_PATH}
-    |  #{ImageOptim::Config::LOCAL_PATH}
-    |
-  TEXT
-
-  op.on('--config-paths PATH1,PATH2', Array, 'Config paths to use instead of '\
-      'default ones') do |paths|
-    options[:config_paths] = paths
-  end
-
-  op.separator nil
-
-  op.on('-r', '-R', '--recursive', 'Recursively scan directories '\
-      'for images') do |recursive|
-    options[:recursive] = recursive
-  end
-
-  op.on("--exclude-dir 'GLOB'", 'Glob for excluding directories '\
-      '(defaults to .*)') do |glob|
-    options[:exclude_dir_glob] = glob
-  end
-
-  op.on("--exclude-file 'GLOB'", 'Glob for excluding files '\
-      '(defaults to .*)') do |glob|
-    options[:exclude_file_glob] = glob
-  end
-
-  op.on("--exclude 'GLOB'", 'Set glob for excluding both directories and '\
-      'files') do |glob|
-    options[:exclude_file_glob] = options[:exclude_dir_glob] = glob
-  end
-
-  op.separator nil
-
-  op.on('--[no-]threads N', Integer, 'Number of threads or disable '\
-      '(defaults to number of processors)') do |threads|
-    options[:threads] = threads
-  end
-
-  op.on('--[no-]nice N', Integer, 'Nice level (defaults to 10)') do |nice|
-    options[:nice] = nice
-  end
-
-  op.separator nil
-  op.separator '  Disabling workers:'
-
-  ImageOptim::Worker.klasses.each do |klass|
-    bin = klass.bin_sym
-    op.on("--no-#{bin}", "disable #{bin} worker") do |enable|
-      options[bin] = enable
-    end
-  end
-
-  op.separator nil
-  op.separator '  Worker options:'
-
-  ImageOptim::Worker.klasses.each_with_index do |klass, i|
-    op.separator nil unless i.zero?
-
-    bin = klass.bin_sym
-    klass.option_definitions.each do |option_definition|
-      name = option_definition.name.to_s.gsub('_', '-')
-      default = option_definition.default
-      type = option_definition.type
-
-      type, marking = case
-      when [TrueClass, FalseClass, ImageOptim::TrueFalseNil].include?(type)
-        [type, 'B']
-      when Integer >= type
-        [Integer, 'N']
-      when Array >= type
-        [Array, 'a,b,c']
-      when ImageOptim::NonNegativeIntegerRange == type
-        [type, 'M-N']
-      else
-        fail "Unknown type #{type}"
-      end
-
-      description_lines = %W[
-        #{option_definition.description.gsub(' - ', ' - ')}
-        (defaults to #{default})
-      ].join(' ').
-        scan(/.*?.{1,60}(?:\s|\z)/).
-        join("\n  ").
-        split("\n")
-
-      op.on("--#{bin}-#{name} #{marking}", type, *description_lines) do |value|
-        options[bin] = {} unless options[bin].is_a?(Hash)
-        options[bin][option_definition.name.to_sym] = value
-      end
-    end
-  end
-
-  op.separator nil
-  op.separator '  Common options:'
-
-  op.on('-v', '--verbose', 'Verbose output') do
-    options[:verbose] = true
-  end
-
-  op.on_tail('-h', '--help', 'Show help and exit') do
-    puts op.help
-    exit
-  end
-
-  op.on_tail('--version', 'Show version and exit') do
-    puts ImageOptim.version
-    exit
-  end
-
-  op.on_tail('--info', 'Show environment info and exit') do
-    options[:verbose] = true
-    options[:only_info] = true
-  end
-end
+options = ImageOptim::Runner::OptionParser.parse!(args)
 
 begin
-  args = ARGV.dup
-
-  # assume -v to be a request to print version if it is the only argument
-  args = %w[--version] if args == %w[-v]
-
-  option_parser.parse!(args)
   if options[:verbose]
     $stderr.puts ImageOptim.full_version
   end
@@ -151,8 +19,6 @@ begin
     abort 'specify paths to optimize' if args.empty?
     abort unless runner.run!(args)
   end
-rescue OptionParser::ParseError => e
-  abort "#{e}\n\n#{option_parser.help}"
 rescue => e
   if options[:verbose]
     abort "#{e}\n#{e.backtrace.join("\n")}"

data/image_optim.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.17.1'
-  s.summary     = %q{Optimize (lossless compress) images (jpeg, png, gif, svg) using external utilities (advpng, gifsicle, jpegoptim, jpegtran, optipng, pngcrush, pngout, pngquant, svgo)}
+  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.homepage    = "http://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
   s.license     = 'MIT'
@@ -19,9 +19,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'image_size', '~> 1.3'
   s.add_dependency 'exifr', '~> 1.1', '>= 1.1.3'
   s.add_dependency 'progress', '~> 3.0', '>= 3.0.1'
-  s.add_dependency 'in_threads', '~> 1.2', '>= 1.2.2'
+  s.add_dependency 'in_threads', '~> 1.3'
+
+  s.add_development_dependency 'image_optim_pack', '~> 0.1'
   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'
   end
+  s.add_development_dependency 'haml', '~> 4.0'
 end

data/lib/image_optim.rb

@@ -18,6 +18,12 @@ class ImageOptim
   # Verbose output?
   attr_reader :verbose
 
+  # Use image_optim_pack
+  attr_reader :pack
+
+  # Skip workers with missing or problematic binaries
+  attr_reader :skip_missing_workers
+
   # Initialize workers, specify options using worker underscored name:
   #
   # pass false to disable worker
@@ -42,11 +48,18 @@ class ImageOptim
     @nice = config.nice
     @threads = config.threads
     @verbose = config.verbose
+    @pack = config.pack
+    @skip_missing_workers = config.skip_missing_workers
 
     if verbose
-      $stderr << config
+      $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"
     end
 
     @bin_resolver = BinResolver.new(self)
@@ -100,7 +113,7 @@ class ImageOptim
       temp.close
 
       if (result = optimize_image(temp.path))
-        result.open('rb', &:read)
+        result.binread
       end
     end
   end
@@ -183,7 +196,11 @@ private
   def create_workers_by_format(&options_proc)
     by_format = {}
     workers = Worker.create_all(self, &options_proc)
-    Worker.resolve_all!(workers)
+    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|

data/lib/image_optim/bin_resolver.rb

@@ -15,14 +15,19 @@ class ImageOptim
     # Directory for symlinks to bins if XXX_BIN was used
     attr_reader :dir
 
+    # Path to pack from image_optim_pack if used
+    attr_reader :pack_path
+
     def initialize(image_optim)
       @image_optim = image_optim
       @bins = {}
       @lock = Mutex.new
+      init_pack
     end
 
     # Binary resolving: create symlink if there is XXX_BIN environment variable,
     # build Bin with full path, check binary version
+    # Return Bin instance
     def resolve!(name)
       name = name.to_sym
 
@@ -42,6 +47,8 @@ class ImageOptim
       else
         fail BinNotFound, "`#{name}` not found"
       end
+
+      @bins[name]
     end
 
     # Path to vendor at root of image_optim
@@ -49,7 +56,12 @@ class ImageOptim
 
     # Prepand `dir` and append `VENDOR_PATH` to `PATH` from environment
     def env_path
-      [dir, ENV['PATH'], VENDOR_PATH].compact.join(File::PATH_SEPARATOR)
+      [
+        dir,
+        pack_path,
+        ENV['PATH'],
+        VENDOR_PATH,
+      ].compact.join(File::PATH_SEPARATOR)
     end
 
     # Collect resolving errors when running block over items of enumerable
@@ -67,6 +79,21 @@ class ImageOptim
 
   private
 
+    def init_pack
+      return unless @image_optim.pack
+
+      @pack_path = if @image_optim.verbose
+        Pack.path do |message|
+          $stderr << "#{message}\n"
+        end
+      else
+        Pack.path
+      end
+      return if @pack_path
+
+      warn 'No pack for this OS and/or ARCH, check verbose output'
+    end
+
     # Double-checked locking
     def resolving(name)
       return if @bins.include?(name)