image_optim 0.13.3 → 0.14.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTMzMWQ1ZjgyYzJkMmM5NzJmZmU2MDc2YTVhMmUxYTU0MTY2MWY1NA==
+    MDYzNDg2MTY5NjdlNGIyY2U3NzY0Mzc5MTc1YzA3N2I3MGRmNDQ0Yw==
   data.tar.gz: !binary |-
-    NGYzYjFlY2IyOTBjNjI1OTRkNWY2Y2EyMDg2NzYwMWRhODRkNDBhZQ==
+    OTcyM2IxMWJjOTA4NDYyYTVkMjcwNTI4MDI5NzE0OTVmYjI5MzE0NQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NDU2NmJlMzZkYjE5YjRiMjNlN2EzNGVmNjJjMmZjNjkyMGRhZDMzYjM3ZmJl
-    YWNlY2ZmZWU0YTY3YmJhZThiMmI1NjU5YTM1OTA4Yzk4YWQyOWNjNjVjMThk
-    M2ZhNmQ0MTI3ZDkwMjc4OGU5YzJiMTkxYzM0ZThlN2Q1ZTQ1NWE=
+    N2ViYzljYTU3OGVkMzQ5OTNmNmYyM2RmZjdmZDZmN2E4MDA0MmJmNGI5MjFk
+    Yzc1NDFjYWM0NjgxZTU0ZWQwMjc0MmVjNGM1MjEyYmQ3MzhmNTlmYWNkZjU3
+    Mzc1Mjc2Y2M0NWNkZGM3OTFlN2ZjZDNiM2EwOGRmNjY0MmIxM2M=
   data.tar.gz: !binary |-
-    OWEzOTM2ZmY5ODIwMmUzNjg3NmEzYjFmZmJmODQ5Nzc2MTA1MmE0YTcxMzdl
-    MTY5YWI5Nzc4MDYwMTFlODZjOWI4NDM5MzFjZjA4ZTY1NzRlY2VkYzAyN2Mx
-    ZTZiNzUyNzQ4ODNiODZjM2RlYjAxZmUzYWVlNjcxNzEzMGMzY2Y=
+    Y2M4Y2I4ZTNiYjZhYThmYThhNTQxYjQ4N2UxZDhhNmU4NjQ1MmI2NmY1YTdh
+    MGI3YTI1YjRiZmIyYmQ5NGE4MDI2NmVjNGY1YWNmNmRkMDM3MzZhMGY3ZjQ5
+    MjYwZmJhOWNkYTM3YWU3NTc4OTQwMThiZjhmY2RkY2Y5ZTc3ZmY=

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/ClassLength:
+  Max: 120
+
+Style/CyclomaticComplexity:
+  Max: 8
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IfUnlessModifier:
+  MaxLineLength: 40
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/MethodLength:
+  Max: 20
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -11,7 +11,9 @@ rvm:
   - jruby-19mode
   - jruby-head
   - ree
-script: bundle exec rspec
+script:
+  - 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 advancecomp gifsicle jhead jpegoptim libjpeg-progs optipng pngcrush

data/README.markdown

@@ -1,3 +1,10 @@
+[![Gem Version](https://img.shields.io/gem/v/image_optim.svg)](https://rubygems.org/gems/image_optim)
+[![Build Status](https://img.shields.io/travis/toy/image_optim/master.svg)](https://travis-ci.org/toy/image_optim)
+[![Code Climate](https://img.shields.io/codeclimate/github/toy/image_optim.svg)](https://codeclimate.com/github/toy/image_optim)
+[![Dependency Status](https://img.shields.io/gemnasium/toy/image_optim.svg)](https://gemnasium.com/toy/image_optim)
+[![Inch CI](http://inch-ci.org/github/toy/image_optim.svg?branch=master)](http://inch-ci.org/github/toy/image_optim)
+[![Gittip](https://img.shields.io/gittip/toy.svg)](https://www.gittip.com/toy/)
+
 # image_optim
 
 Optimize (lossless compress) images (jpeg, png, gif, svg) using external utilities:
@@ -15,10 +22,7 @@ Optimize (lossless compress) images (jpeg, png, gif, svg) using external utiliti
 
 Based on [ImageOptim.app](http://imageoptim.com/).
 
-[![Gem Version](https://badge.fury.io/rb/image_optim.png)](http://badge.fury.io/rb/image_optim)
-[![Build Status](https://travis-ci.org/toy/image_optim.png?branch=master)](https://travis-ci.org/toy/image_optim)
-[![Code Climate](https://codeclimate.com/github/toy/image_optim.png)](https://codeclimate.com/github/toy/image_optim)
-[![Dependency Status](https://gemnasium.com/toy/image_optim.png)](https://gemnasium.com/toy/image_optim)
+Documentation for [latest version](http://rubydoc.info/gems/image_optim/frames) and [master](http://rubydoc.info/github/toy/image_optim/master/frames).
 
 ## Gem installation
 
@@ -29,16 +33,19 @@ gem install image_optim
 ### Bundler
 
 Add to your `Gemfile`:
+
 ```ruby
 gem 'image_optim'
 ```
 
 With version:
+
 ```ruby
 gem 'image_optim', '~> 0.11'
 ```
 
 If you want to check latest changes:
+
 ```ruby
 gem 'image_optim', :git => 'git://github.com/toy/image_optim.git'
 ```
@@ -93,21 +100,27 @@ You will also need to install `jpegoptim` and `pngcrush` from source:
 
 #### jpegoptim
 
+Replace `X.Y.Z` with latest version number from http://www.kokkonen.net/tjko/projects.html#jpegoptim.
+
 ```bash
+JPEGOPTIM_VERSION=X.Y.Z
 cd /tmp
-curl -O http://www.kokkonen.net/tjko/src/jpegoptim-1.4.0.tar.gz
-tar zxf jpegoptim-1.4.0.tar.gz
-cd jpegoptim-1.4.0
+curl -O http://www.kokkonen.net/tjko/src/jpegoptim-$JPEGOPTIM_VERSION.tar.gz
+tar zxf jpegoptim-$JPEGOPTIM_VERSION.tar.gz
+cd jpegoptim-$JPEGOPTIM_VERSION
 ./configure && make && make install
 ```
 
 #### pngcrush
 
+Replace `X.Y.Z` with latest version number from http://sourceforge.net/projects/pmt/files/pngcrush/.
+
 ```bash
+PNGCRUSH_VERSION=X.Y.Z
 cd /tmp
-curl -O http://iweb.dl.sourceforge.net/project/pmt/pngcrush/1.7.70/pngcrush-1.7.73.tar.gz
-tar zxf pngcrush-1.7.73.tar.gz
-cd pngcrush-1.7.73
+curl -O http://iweb.dl.sourceforge.net/project/pmt/pngcrush/$PNGCRUSH_VERSION/pngcrush-$PNGCRUSH_VERSION.tar.gz
+tar zxf pngcrush-$PNGCRUSH_VERSION.tar.gz
+cd pngcrush-$PNGCRUSH_VERSION
 make && cp -f pngcrush /usr/local/bin
 ```
 

data/bin/image_optim

@@ -6,7 +6,7 @@ require 'image_optim/runner'
 options = {}
 
 option_parser = OptionParser.new do |op|
-  op.accept(ImageOptim::TrueFalseNil, OptionParser.top.atype[TrueClass][0].merge('nil' => nil)){ |arg, val| val }
+  ImageOptim::TrueFalseNil.add_to_option_parser(op)
 
   op.banner = <<-TEXT.gsub(/^\s*\|/, '')
     |#{ImageOptim.full_version}
@@ -16,17 +16,19 @@ option_parser = OptionParser.new do |op|
     |
     |Configuration will be read and prepanded to options from two paths:
     |  #{ImageOptim::Config::GLOBAL_CONFIG_PATH}
-    |  #{ImageOptim::Config::LOCAL_CONFIG_PATH} (in current working directory)
+    |  #{ImageOptim::Config::LOCAL_CONFIG_PATH}
     |
   TEXT
 
-  op.on('-r', '-R', '--recursive', 'Recurively scan directories for images') do |recursive|
+  op.on('-r', '-R', '--recursive', 'Recurively scan directories '\
+      'for images') do |recursive|
     options[:recursive] = recursive
   end
 
   op.separator nil
 
-  op.on('--[no-]threads N', Integer, 'Number of threads or disable (defaults to number of processors)') do |threads|
+  op.on('--[no-]threads N', Integer, 'Number of threads or disable '\
+      '(defaults to number of processors)') do |threads|
     options[:threads] = threads
   end
 
@@ -64,13 +66,18 @@ option_parser = OptionParser.new do |op|
       when Array >= type
         [Array, 'a,b,c']
       else
-        raise "Unknown type #{type}"
+        fail "Unknown type #{type}"
       end
 
-      description = "#{option_definition.description.gsub(' - ', ' - ')} (defaults to #{default})"
-      description = description.scan(/(.*?.{1,60})(?:\s|\z)/).flatten.join("\n  ").split("\n")
+      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) do |value|
+      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
@@ -98,18 +105,21 @@ end
 begin
   args = ARGV.dup
 
-  if args == %w[-v]
-    args = %w[--version]
-  end
+  # assume -v to be request to print version if it is the only argument
+  args = %w[--version] if args == %w[-v]
 
   option_parser.parse!(args)
-  $stderr.puts ImageOptim.full_version if options[:verbose]
-  ImageOptim::Runner.run!(args, options) or exit 1
+  if options[:verbose]
+    $stderr.puts ImageOptim.full_version
+  end
+  unless ImageOptim::Runner.run!(args, options)
+    abort
+  end
 rescue OptionParser::ParseError => e
-  abort "#{e.to_s}\n\n#{option_parser.help}"
+  abort "#{e}\n\n#{option_parser.help}"
 rescue => e
   if options[:verbose]
-    abort "#{e.to_s}\n#{e.backtrace.join("\n")}"
+    abort "#{e}\n#{e.backtrace.join("\n")}"
   else
     abort e.to_s
   end

data/image_optim.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.13.3'
+  s.version     = '0.14.0'
   s.summary     = %q{Optimize (lossless compress) images (jpeg, png, gif, svg) using external utilities (advpng, gifsicle, jpegoptim, jpegtran, optipng, pngcrush, pngout, svgo)}
   s.homepage    = "http://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
@@ -20,5 +20,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'exifr', '~> 1.1.3'
   s.add_dependency 'progress', '~> 3.0.0'
   s.add_dependency 'in_threads', '~> 1.2.0'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.2')
+    s.add_development_dependency 'rubocop', '~> 0.24.1'
+  end
 end

data/lib/image_optim.rb

@@ -7,6 +7,7 @@ require 'image_optim/worker'
 require 'in_threads'
 require 'shellwords'
 
+# Main interface
 class ImageOptim
   # Nice level
   attr_reader :nice
@@ -15,9 +16,7 @@ class ImageOptim
   attr_reader :threads
 
   # Verbose output?
-  def verbose?
-    @verbose
-  end
+  attr_reader :verbose
 
   # Initialize workers, specify options using worker underscored name:
   #
@@ -29,11 +28,13 @@ class ImageOptim
   #
   #     ImageOptim.new(:advpng => {:level => 3}, :optipng => {:level => 2})
   #
-  # use :threads to set number of parallel optimizers to run (passing true or nil determines number of processors, false disables parallel processing)
+  # use :threads to set number of parallel optimizers to run (passing true or
+  # nil determines number of processors, false disables parallel processing)
   #
   #     ImageOptim.new(:threads => 8)
   #
-  # use :nice to specify optimizers nice level (true or nil makes it 10, false makes it 0)
+  # use :nice to specify optimizers nice level (true or nil makes it 10, false
+  # makes it 0)
   #
   #     ImageOptim.new(:nice => 20)
   def initialize(options = {})
@@ -42,7 +43,7 @@ class ImageOptim
     @threads = config.threads
     @verbose = config.verbose
 
-    if verbose?
+    if verbose
       $stderr << config
       $stderr << "Nice level: #{nice}\n"
       $stderr << "Using threads: #{threads}\n"
@@ -50,17 +51,9 @@ class ImageOptim
 
     @bin_resolver = BinResolver.new(self)
 
-    @workers_by_format = {}
-    Worker.klasses.each do |klass|
-      if worker_options = config.for_worker(klass)
-        worker = klass.new(self, worker_options)
-        worker.image_formats.each do |format|
-          @workers_by_format[format] ||= []
-          @workers_by_format[format] << worker
-        end
-      end
+    @workers_by_format = create_workers_by_format do |klass|
+      config.for_worker(klass)
     end
-    @workers_by_format.values.each(&:sort!)
 
     config.assert_no_unused_options!
   end
@@ -70,30 +63,29 @@ class ImageOptim
     @workers_by_format[ImagePath.convert(path).format]
   end
 
-  # Optimize one file, return new path as OptimizedImagePath or nil if optimization failed
+  # Optimize one file, return new path as OptimizedImagePath or nil if
+  # optimization failed
   def optimize_image(original)
     original = ImagePath.convert(original)
-    if workers = workers_for_image(original)
-      handler = Handler.new(original)
-      workers.each do |worker|
-        handler.process do |src, dst|
-          worker.optimize(src, dst)
-        end
-      end
-      handler.cleanup
-      if handler.result
-        ImagePath::Optimized.new(handler.result, original)
+    return unless (workers = workers_for_image(original))
+    handler = Handler.new(original)
+    workers.each do |worker|
+      handler.process do |src, dst|
+        worker.optimize(src, dst)
       end
     end
+    handler.cleanup
+    return unless handler.result
+    ImagePath::Optimized.new(handler.result, original)
   end
 
-  # Optimize one file in place, return original as OptimizedImagePath or nil if optimization failed
+  # Optimize one file in place, return original as OptimizedImagePath or nil if
+  # optimization failed
   def optimize_image!(original)
     original = ImagePath.convert(original)
-    if result = optimize_image(original)
-      result.replace(original)
-      ImagePath::Optimized.new(original, result.original_size)
-    end
+    return unless (result = optimize_image(original))
+    result.replace(original)
+    ImagePath::Optimized.new(original, result.original_size)
   end
 
   # Optimize image data, return new data or nil if optimization failed
@@ -105,28 +97,31 @@ class ImageOptim
       temp.write(original_data)
       temp.close
 
-      if result = optimize_image(temp.path)
+      if (result = optimize_image(temp.path))
         result.open('rb', &:read)
       end
     end
   end
 
   # Optimize multiple images
-  # if block given yields path and result for each image and returns array of yield results
+  # if block given yields path and result for each image and returns array of
+  # yield results
   # else return array of results
   def optimize_images(paths, &block)
     run_method_for(paths, :optimize_image, &block)
   end
 
   # Optimize multiple images in place
-  # if block given yields path and result for each image and returns array of yield results
+  # if block given yields path and result for each image and returns array of
+  # yield results
   # else return array of results
   def optimize_images!(paths, &block)
     run_method_for(paths, :optimize_image!, &block)
   end
 
   # Optimize multiple image datas
-  # if block given yields original and result for each image data and returns array of yield results
+  # if block given yields original and result for each image data and returns
+  # array of yield results
   # else return array of results
   def optimize_images_data(datas, &block)
     run_method_for(datas, :optimize_image_data, &block)
@@ -156,7 +151,8 @@ class ImageOptim
     !!workers_for_image(path)
   end
 
-  # Check existance of binary, create symlink if ENV contains path for key XXX_BIN where XXX is upper case bin name
+  # Check existance of binary, create symlink if ENV contains path for key
+  # XXX_BIN where XXX is upper case bin name
   def resolve_bin!(bin)
     @bin_resolver.resolve!(bin)
   end
@@ -168,6 +164,20 @@ class ImageOptim
 
 private
 
+  # Create hash with format mapped to list of workers sorted by run order
+  def create_workers_by_format(&options_proc)
+    by_format = {}
+    Worker.klasses.each do |klass|
+      next unless (options = options_proc[klass])
+      worker = klass.new(self, options)
+      worker.image_formats.each do |format|
+        by_format[format] ||= []
+        by_format[format] << worker
+      end
+    end
+    by_format.each{ |_format, workers| workers.sort! }
+  end
+
   # Run method for each path and yield each path and result if block given
   def run_method_for(paths, method_name, &block)
     apply_threading(paths).map do |path|

data/lib/image_optim/bin_resolver.rb

@@ -7,7 +7,13 @@ class ImageOptim
   class BinNotFoundError < StandardError; end
   class BadBinVersion < StandardError; end
 
+  # Handles resolving binaries and checking versions
+  #
+  # If there is an environment variable XXX_BIN when resolbing xxx, then a
+  # symlink to binary will be created in a temporary directory which will be
+  # added to PATH
   class BinResolver
+    # Holds name and version of an executable
     class Bin
       attr_reader :name, :version
       def initialize(name, version)
@@ -31,8 +37,9 @@ class ImageOptim
       name = name.to_sym
 
       resolving(name) do
-        if bin = resolve?(name) && Bin.new(name, version(name))
-          $stderr << "Resolved #{bin}\n" if @image_optim.verbose?
+        bin = Bin.new(name, version(name)) if resolve?(name)
+        if bin && @image_optim.verbose
+          $stderr << "Resolved #{bin}\n"
         end
         @bins[name] = bin
       end
@@ -40,7 +47,7 @@ class ImageOptim
       if @bins[name]
         check!(@bins[name])
       else
-        raise BinNotFoundError, "`#{name}` not found"
+        fail BinNotFoundError, "`#{name}` not found"
       end
     end
 
@@ -53,17 +60,14 @@ class ImageOptim
   private
 
     def resolving(name)
-      unless @bins.include?(name)
-        @lock.synchronize do
-          unless @bins.include?(name)
-            yield
-          end
-        end
+      return if @bins.include?(name)
+      @lock.synchronize do
+        yield unless @bins.include?(name)
       end
     end
 
     def resolve?(name)
-      if path = ENV["#{name}_bin".upcase]
+      if (path = ENV["#{name}_bin".upcase])
         unless @dir
           @dir = FSPath.temp_dir
           at_exit{ FileUtils.remove_entry_secure @dir }
@@ -91,7 +95,8 @@ class ImageOptim
       when :pngcrush
         capture_output("#{name} -version 2>&1")[/\d+(\.\d+){1,}/]
       when :pngout
-        date_str = capture_output("#{name} 2>&1")[/[A-Z][a-z]{2} (?: |\d)\d \d{4}/]
+        date_regexp = /[A-Z][a-z]{2} (?: |\d)\d \d{4}/
+        date_str = capture_output("#{name} 2>&1")[date_regexp]
         Date.parse(date_str).strftime('%Y%m%d')
       end
     end
@@ -102,7 +107,7 @@ class ImageOptim
       when :pngcrush
         case bin.version
         when c = is.between?('1.7.60', '1.7.65')
-          raise BadBinVersion, "`#{bin}` (#{c}) is known to produce broken pngs"
+          fail BadBinVersion, "`#{bin}` (#{c}) is known to produce broken pngs"
         end
       when :advpng
         case bin.version