image_optim 0.6.0 → 0.7.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Ivan Kuchin
+Copyright (c) 2012-2013 Ivan Kuchin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,14 +1,36 @@
 # image_optim
 
-Optimize (lossless compress) images (jpeg, png, gif) using external utilities (advpng, gifsicle, jpegoptim, jpegtran, optipng, pngcrush, pngout).
+Optimize (lossless compress) images (jpeg, png, gif) using external utilities:
 
-Based on [ImageOptim.app](http://imageoptim.pornel.net/).
+* [advpng](http://advancemame.sourceforge.net/doc-advpng.html) from [AdvanceCOMP](http://advancemame.sourceforge.net/comp-readme.html)
+* [gifsicle](http://www.lcdf.org/gifsicle/)
+* [jpegoptim](http://www.kokkonen.net/tjko/projects.html)
+* jpegtran from [Independent JPEG Group's JPEG library](http://www.ijg.org/)
+* [optipng](http://optipng.sourceforge.net/)
+* [pngcrush](http://pmt.sourceforge.net/pngcrush/)
+* [pngout](http://www.advsys.net/ken/util/pngout.htm)
 
-## Gem Installation
+Based on [ImageOptim.app](http://imageoptim.com/).
+
+## Gem installation
 
     gem install image_optim
 
-## Binaries Installation
+## Binaries location
+
+Simplest way for `image_optim` to locate binaries is to install them in common location present in `PATH` (see [Binaries installation](#binaries-installation)).
+
+If you cannot install to common location, then install to custom one and add it to `PATH`.
+
+Specify custom bin location using `XXX_BIN` environment variable (`JPEGOPTIM_BIN`, `OPTIPNG_BIN`, …).
+
+Besides permanently setting environment variables in `~/.profile`, `~/.bash_profile`, `~/.bashrc`, `~/.zshrc`, … they can be set:
+
+* before command: `PATH="/custom/location:$PATH" image_optim *.jpg`
+
+* inside script: `ENV['PATH'] = "/custom/location:#{ENV['PATH']}"; ImageOptim.optimize_images([…])`
+
+## Binaries installation
 
 ### Linux - Debian/Ubuntu
 
@@ -31,20 +53,20 @@ You will also need to install `jpegoptim` and `pngcrush` from source:
 #### pngcrush
 
     cd /tmp
-    curl -O http://iweb.dl.sourceforge.net/project/pmt/pngcrush/1.7.24/pngcrush-1.7.24.tar.bz2
-    tar jxf pngcrush-1.7.24.tar.bz2
-    cd pngcrush-1.7.24
+    curl -O http://iweb.dl.sourceforge.net/project/pmt/pngcrush/1.7.43/pngcrush-1.7.43.tar.gz
+    tar zxf pngcrush-1.7.43.tar.gz
+    cd pngcrush-1.7.43
     make && cp -f pngcrush /usr/local/bin
 
-### OS X - Macports
+### OS X: Macports
 
     sudo port install advancecomp gifsicle jpegoptim jpeg optipng pngcrush
 
-### OS X - Brew
+### OS X: Brew
 
     brew install advancecomp gifsicle jpegoptim jpeg optipng pngcrush
 
-## pngout Installation (optional)
+### pngout installation (optional)
 
 You can install `pngout` by downloading and installing the [binary versions](http://www.jonof.id.au/kenutils).
 
@@ -52,38 +74,40 @@ _Note: pngout is free to use even in commercial soft, but you can not redistribu
 
 ## Usage
 
-In terminal:
+### From shell
 
     image_optim *.{jpg,png,gif}
 
     image_optim -h
 
+### From ruby
+
 Initilize optimizer (options are described in comments for ImageOptim, Worker and all workers):
 
-    io = ImageOptim.new
+    image_optim = ImageOptim.new
 
-    io = ImageOptim.new(:pngout => false)
+    image_optim = ImageOptim.new(:pngout => false)
 
-    io = ImageOptim.new(:nice => 20)
+    image_optim = ImageOptim.new(:nice => 20)
 
 Optimize image getting temp path:
 
-    io.optimize_image('a.png')
+    image_optim.optimize_image('a.png')
 
 Optimize image in place:
 
-    io.optimize_image!('b.jpg')
+    image_optim.optimize_image!('b.jpg')
 
 Multiple images:
 
-    io.optimize_images(Dir['*.png']) do |unoptimized, optimized|
+    image_optim.optimize_images(Dir['*.png']) do |unoptimized, optimized|
       if optimized
         puts "#{unoptimized} => #{optimized}"
       end
     end
 
-    io.optimize_images!(Dir['*.*'])
+    image_optim.optimize_images!(Dir['*.*'])
 
 ## Copyright
 
-Copyright (c) 2012 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2012-2013 Ivan Kuchin. See LICENSE.txt for details.

data/TODO

@@ -1,2 +1,7 @@
-autorotate jpeg based on exif
+leave_color branch
+autorotate jpeg based on exif (jhead -auotrot)
 timeout workers?
+don't fail but warn on bins not present
+better documentation
+preserve time/attrs option?
+jpegrescan

data/bin/image_optim

@@ -10,13 +10,19 @@ options = {}
 
 option_parser = OptionParser.new do |op|
   op.banner = <<-TEXT
-#{op.program_name}, version #{ImageOptim.version}
+#{op.program_name} v#{ImageOptim.version}
 
 Usege:
   #{op.program_name} [options] image_path …
 
   TEXT
 
+  op.on('-r', '-R', '--recursive', 'Recurively scan directories for images') do |recursive|
+    options[:recursive] = recursive
+  end
+
+  op.separator nil
+
   op.on('--[no-]threads NUMBER', Integer, 'Number of threads or disable (defaults to number of processors)') do |threads|
     options[:threads] = threads
   end
@@ -25,16 +31,16 @@ Usege:
     options[:nice] = nice
   end
 
+  op.separator nil
+
   ImageOptim::Worker.klasses.each do |klass|
     bin = klass.underscored_name.to_sym
-    op.on("--[no-]#{bin} PATH", "#{bin} path or disable") do |path|
-      options[bin] = path
+    op.on("--no-#{bin}", "disable #{bin} worker") do |enable|
+      options[bin] = enable
     end
   end
 
-  op.on('-r', '-R', '--recursive', 'Scan directories') do |recursive|
-    options[:recursive] = recursive
-  end
+  op.separator nil
 
   op.on('-v', '--verbose', 'Verbose info') do |verbose|
     options[:verbose] = verbose
@@ -61,16 +67,16 @@ if ARGV.empty?
   abort "specify image paths to optimize\n\n#{option_parser.help}"
 else
   recursive = options.delete(:recursive)
-  io = begin
+  image_optim = begin
     ImageOptim.new(options)
-  rescue ImageOptim::ConfigurationError, ImageOptim::BinaryNotFoundError => e
+  rescue ImageOptim::ConfigurationError => e
     abort e
   end
 
   paths = []
   ARGV.each do |arg|
     if File.file?(arg)
-      if io.optimizable?(arg)
+      if image_optim.optimizable?(arg)
         paths << arg
       else
         warn "#{arg} is not an image or there is no optimizer for it"
@@ -78,7 +84,7 @@ else
     else
       if recursive
         Find.find(arg) do |path|
-          paths << path if File.file?(path) && io.optimizable?(path)
+          paths << path if File.file?(path) && image_optim.optimizable?(path)
         end
       else
         warn "#{arg} is not a file"
@@ -125,7 +131,7 @@ else
     '%5.2f%% %s' % [100 - 100.0 * dst_size / src_size, Space.space(src_size - dst_size)]
   end
 
-  results = io.optimize_images(paths) do |src, dst|
+  results = image_optim.optimize_images(paths) do |src, dst|
     if dst
       src_size, dst_size = src.size, dst.size
       percent = size_percent(src_size, dst_size)

data/image_optim.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.6.0'
+  s.version     = '0.7.0'
   s.summary     = %q{Optimize (lossless compress) images (jpeg, png, gif) using external utilities (advpng, gifsicle, jpegoptim, jpegtran, optipng, pngcrush, pngout)}
   s.homepage    = "http://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']

data/lib/image_optim.rb

@@ -1,35 +1,36 @@
 require 'in_threads'
+require 'shellwords'
 
-class ImageOptim
-  autoload :ImagePath, 'image_optim/image_path'
-  autoload :OptionHelpers, 'image_optim/option_helpers'
-  autoload :Util, 'image_optim/util'
-  autoload :Worker, 'image_optim/worker'
+require 'image_optim/image_path'
+require 'image_optim/option_helpers'
+require 'image_optim/worker'
 
+class ImageOptim
   class ConfigurationError < StandardError; end
-  class BinaryNotFoundError < StandardError; end
+  class BinNotFoundError < StandardError; end
 
   include OptionHelpers
 
-  # Hash of initialized workers by format they apply to
-  attr_reader :workers_by_format
+  # Nice level
+  attr_reader :nice
 
   # Number of threads to run with
   attr_reader :threads
 
+  # Verbose output?
+  def verbose?
+    @verbose
+  end
+
   # Initialize workers, specify options using worker underscored name:
   #
   # pass false to disable worker
   #
   #     ImageOptim.new(:pngcrush => false)
   #
-  # string to set binary
-  #
-  #     ImageOptim.new(:pngout => '/special/path/bin/pngout123')
-  #
-  # or hash with options to worker and :bin specifying binary
+  # or hash with options to worker
   #
-  #     ImageOptim.new(:advpng => {:level => 3}, :optipng => {:level => 2}, :jpegoptim => {:bin => 'jpegoptim345'})
+  #     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)
   #
@@ -37,9 +38,13 @@ class ImageOptim
   #
   # use :nice to specify optimizers nice level (true or nil makes it 10, false makes it 0)
   #
-  #     ImageOptim.new(:threads => 8)
+  #     ImageOptim.new(:nice => 20)
   def initialize(options = {})
-    nice = case nice = options.delete(:nice)
+    @resolved_bins = {}
+    @resolver_lock = Mutex.new
+
+    nice = options.delete(:nice)
+    @nice = case nice
     when true, nil
       10
     when false
@@ -51,7 +56,7 @@ class ImageOptim
     threads = options.delete(:threads)
     threads = case threads
     when true, nil
-      Util.processor_count
+      processor_count
     when false
       1
     else
@@ -59,7 +64,7 @@ class ImageOptim
     end
     @threads = limit_with_range(threads, 1..16)
 
-    verbose = options.delete(:verbose)
+    @verbose = !!options.delete(:verbose)
 
     @workers_by_format = {}
     Worker.klasses.each do |klass|
@@ -69,19 +74,17 @@ class ImageOptim
         worker_options = {}
       when false
         next
-      when String
-        worker_options = {:bin => worker_options}
       else
         raise ConfigurationError, "Got #{worker_options.inspect} for #{klass.name} options"
       end
-      worker = klass.new({:nice => nice, :verbose => verbose}.merge(worker_options))
-      klass.image_formats.each do |format|
+      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.each do |format, workers|
-      workers.replace workers.sort_by(&:run_priority)
+      workers.replace workers.sort_by(&:run_order) # There is no sort_by! in ruby 1.8
     end
 
     assert_options_empty!(options)
@@ -138,23 +141,52 @@ class ImageOptim
 
   # Optimization methods with default options
   def self.method_missing(method, *args, &block)
-    if method.to_s =~ /^optimize/
+    if method.to_s =~ /^optimize_images?\!?$/
       new.send(method, *args, &block)
     else
       super
     end
   end
 
+  # Version of image_optim gem spec loaded
   def self.version
     Gem.loaded_specs['image_optim'].version.to_s rescue nil
   end
 
+  # Are there workers for file at path?
   def optimizable?(path)
     !!workers_for_image(path)
   end
 
+  # Temp directory for symlinks to bins with path coming from ENV
+  attr_reader :resolve_dir
+
+  # 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 = bin.to_sym
+    @resolved_bins.include?(bin) || @resolver_lock.synchronize do
+      @resolved_bins.include?(bin) || begin
+        if path = ENV["#{bin}_bin".upcase]
+          unless @resolve_dir
+            @resolve_dir = FSPath.temp_dir
+            at_exit{ FileUtils.remove_entry_secure @resolve_dir }
+          end
+          symlink = @resolve_dir / bin
+          symlink.make_symlink(File.expand_path(path))
+          at_exit{ symlink.unlink }
+
+          @resolved_bins[bin] = bin_accessible?(symlink)
+        else
+          @resolved_bins[bin] = bin_accessible?(bin)
+        end
+      end
+    end
+    @resolved_bins[bin] or raise BinNotFoundError, "`#{bin}` not found"
+  end
+
 private
 
+  # 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|
       path = ImagePath.new(path)
@@ -167,13 +199,41 @@ private
     end
   end
 
+  # Apply threading if threading is allowed and array is longer than 1
   def apply_threading(array)
-    if threads > 1
+    if threads > 1 && array.length > 1
       array.in_threads(threads)
     else
       array
     end
   end
+
+  # Check if bin can be accessed
+  def bin_accessible?(bin)
+    `which #{bin.to_s.shellescape}` != ''
+  end
+
+  # http://stackoverflow.com/questions/891537/ruby-detect-number-of-cpus-installed
+  def processor_count
+    @processor_count ||= case host_os = RbConfig::CONFIG['host_os']
+    when /darwin9/
+      `hwprefs cpu_count`
+    when /darwin/
+      (`which hwprefs` != '') ? `hwprefs thread_count` : `sysctl -n hw.ncpu`
+    when /linux/
+      `grep -c processor /proc/cpuinfo`
+    when /freebsd/
+      `sysctl -n hw.ncpu`
+    when /mswin|mingw/
+      require 'win32ole'
+      wmi = WIN32OLE.connect('winmgmts://')
+      cpu = wmi.ExecQuery('select NumberOfLogicalProcessors from Win32_Processor')
+      cpu.to_enum.first.NumberOfLogicalProcessors
+    else
+      warn "Unknown architecture (#{host_os}) assuming one processor."
+      1
+    end.to_i
+  end
 end
 
 %w[
@@ -181,5 +241,5 @@ end
   jpegoptim jpegtran
   gifsicle
 ].each do |worker|
-  require "image_optim/workers/#{worker}"
+  require "image_optim/worker/#{worker}"
 end

data/lib/image_optim/image_path.rb

@@ -1,6 +1,8 @@
 require 'fspath'
 require 'image_size'
 
+require 'image_optim'
+
 class ImageOptim
   class ImagePath < FSPath
     # Get temp path for this file with same extension

data/lib/image_optim/option_helpers.rb

@@ -1,3 +1,5 @@
+require 'image_optim'
+
 class ImageOptim
   module OptionHelpers
     # Remove option from hash and run through block or return default
@@ -5,7 +7,9 @@ class ImageOptim
       value = default
       if options.has_key?(name)
         value = options.delete(name)
-        value = yield(value) if block_given?
+      end
+      if block_given?
+        value = yield(value)
       end
       instance_variable_set("@#{name}", value)
     end