image_optim 0.9.1 → 0.10.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGFiMDdmODY3N2ZkMTgwZWNmMTlhOTFkNmY1NjVjZGRjMmI3ZDQ0MA==
+    NzI5M2M3MWM1OWNiMDM5MGFiMmFkNDYwYzBiZjY5NWFiNDc0NTkyNQ==
   data.tar.gz: !binary |-
-    MmNjYTZlNDFkMGVmM2U1NmUyNDQ3NDIxYWFmNjAzYTUzMGY0YWQ2Mg==
+    YWI3NDcwN2U3ZmIzZGI4NjYxZmJkOTVhYmQ5OGMzNTYyNGFlODI3Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjVkYWZkM2ExYWU2MDAxODU1MGNmNDI2OWNhNGZiNTI2YzU1NWYzN2QyYzRh
-    M2E3Njg0ZjA1MmVlOTc3ZGNkYjdlZTY1NDk1MDJhYzg3NjhkM2I2ZTYxNmNi
-    MmQwMjc4OWJlYTRlMDNiZmE2YzkxMTQ4YWIwMTlmZTM0Zjk4NjM=
+    YjVkYjUwYTEzMzQ2ZWZjNjg3ZWU1ZDJlMGRmY2FjOTc3NzU4YThlYTVmMmE2
+    YWEwODAzMGVkN2QyZDc4MjUyZGQ4ZDAyMTgzMDA3ZjVjNDQ3ODc5NTBlMzI1
+    MDU4ZDRlZTAzNjc2M2IwNWMxZGNjZjY0OWQ0MDQ2NGNhMThlYTE=
   data.tar.gz: !binary |-
-    NDAxMzU2ODRiYzNhZGMwZDM2M2MzYzk0M2VhYTQ2MjZlMGFlZGNiMTM3Yzk0
-    YmRkZDk1MTQ2M2U4ZmJiOThjNzBjN2YxNzAzMDFhOGUxNmZlYmNkMGNkNjk0
-    YjFlMmUzNDM0NTFiMGMyOTQ1MGE1YmRjM2YyYWI0NWM3MWE4Mzk=
+    YjlhYjk1NDIyM2FlMzE4NjZlM2QxOTJjYzk0ZjJlYTI1YTYwMGUxODA3Yzdj
+    NzdjODY2NDBjZDIwODA2YTIzNThjZWJjMTg2ZGRlYjllYjg3NGIxNzU0Y2Fk
+    NWYwNDYwODkwN2FjNmI2ODU5NWNlNjdmMjY5NjdkZjk3ZTY3NDM=

data/.travis.yml

@@ -7,8 +7,6 @@ rvm:
   - 2.0.0
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
   - ree
 script: bundle exec rspec
 before_install:

data/README.markdown

@@ -13,7 +13,10 @@ Optimize (lossless compress) images (jpeg, png, gif) using external utilities:
 
 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)
 
 ## Gem installation
 
@@ -123,10 +126,38 @@ Multiple images:
 
     image_optim.optimize_images!(Dir['*.*'])
 
+### From rails
+
+`ImageOptim::Railtie` will automatically initialize processing of assets if `config.assets.compress` is true.
+
+As image optimization can be time consuming you may prefer to optimize original asset files.
+
+Automatic assets processing can be turned off by setting `config.assets.image_optim = false`.
+
+## Configuration
+
+Configuration in YAML format will be read and prepanded to options from two paths:
+
+* `$XDG_CONFIG_HOME/image_optim.yml` (by default `~/.config/image_optim.yml`)
+* `.image_optim.yml` in current working directory
+
+Example configuration:
+
+    nice: 20
+    pngout: false # disable
+    optipng:
+      level: 5
+
 ## Options
 
+* `:nice` — Nice level *(defaults to 10)*
+* `:threads` — Number of threads or disable *(defaults to number of processors)*
+* `:verbose` — Verbose output *(defaults to false)*
+
 Worker can be disabled by passing false instead of options hash.
 
+<!---<worker-options>-->
+
 ### pngcrush
 * `: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)*
@@ -150,11 +181,13 @@ Worker can be disabled by passing false instead of options hash.
 ### jpegtran
 * `:copy_chunks` — Copy all chunks *(defaults to false)*
 * `:progressive` — Create progressive JPEG file *(defaults to true)*
-* `:jpegrescan` — Use jpegtran through jpegrescan, ignore progressive option *(defaults to true)*
+* `:jpegrescan` — Use jpegtran through jpegrescan, ignore progressive option *(defaults to false)*
 
 ### gifsicle
 * `:interlace` — Turn interlacing on *(defaults to false)*
 
+<!---</worker-options>-->
+
 ## Copyright
 
 Copyright (c) 2012-2013 Ivan Kuchin. See LICENSE.txt for details.

data/bin/image_optim

@@ -1,22 +1,24 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
-require 'image_optim'
-require 'progress'
-require 'optparse'
-require 'find'
+require 'image_optim/runner'
 
+args = ARGV.dup
 options = {}
 
-OptionParser.accept(ImageOptim::TrueFalseNil, OptionParser.top.atype[TrueClass][0].merge('nil' => nil)){ |arg, val| val }
-
 option_parser = OptionParser.new do |op|
-  op.banner = <<-TEXT
-#{op.program_name} v#{ImageOptim.version}
-
-Usege:
-  #{op.program_name} [options] image_path …
-
+  op.accept(ImageOptim::TrueFalseNil, OptionParser.top.atype[TrueClass][0].merge('nil' => nil)){ |arg, val| val }
+
+  op.banner = <<-TEXT.gsub(/^\s*\|/, '')
+    |#{op.program_name} v#{ImageOptim.version}
+    |
+    |Usege:
+    |  #{op.program_name} [options] image_path …
+    |
+    |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)
+    |
   TEXT
 
   op.on('-r', '-R', '--recursive', 'Recurively scan directories for images') do |recursive|
@@ -84,7 +86,7 @@ Usege:
   end
 
   op.on_tail('-h', '--help', 'Show full help') do
-    puts option_parser.help
+    puts op.help
     exit
   end
 
@@ -95,108 +97,14 @@ Usege:
 end
 
 begin
-  option_parser.parse!
+  option_parser.parse!(args)
+  ImageOptim::Runner.run!(args, options) or exit 1
 rescue OptionParser::ParseError => e
   abort "#{e.to_s}\n\n#{option_parser.help}"
-end
-
-if options[:verbose]
-  def print_options(options, level = 1)
-    prefix = '  ' * level
-    options.each do |key, value|
-      if value.is_a?(Hash)
-        puts "#{prefix}#{key}:"
-        print_options(value, level + 1)
-      else
-        puts "#{prefix}#{key}: #{value.inspect}"
-      end
-    end
-  end
-
-  puts 'Options:'
-  print_options(options)
-end
-
-if ARGV.empty?
-  abort "specify image paths to optimize\n\n#{option_parser.help}"
-else
-  recursive = options.delete(:recursive)
-  image_optim = begin
-    ImageOptim.new(options)
-  rescue ImageOptim::ConfigurationError => e
+rescue => e
+  if options[:verbose]
+    abort "#{e.to_s}\n#{e.backtrace.join("\n")}"
+  else
     abort e.to_s
   end
-
-  paths = []
-  ARGV.each do |arg|
-    if File.file?(arg)
-      if image_optim.optimizable?(arg)
-        paths << arg
-      else
-        warn "#{arg} is not an image or there is no optimizer for it"
-      end
-    else
-      if recursive
-        Find.find(arg) do |path|
-          paths << path if File.file?(path) && image_optim.optimizable?(path)
-        end
-      else
-        warn "#{arg} is not a file"
-      end
-    end
-  end
-
-  module Space
-    SIZE_SYMBOLS = %w[B K M G T P E Z Y].freeze
-    PRECISION = 1
-    LENGTH = 4 + PRECISION + 1
-    COEF = 1 / Math.log(10)
-
-    EMPTY_SPACE = ' ' * LENGTH
-    NOT_COUNTED_SPACE = '!' * LENGTH
-
-    class << self
-      attr_writer :base10
-      def denominator
-        @denominator ||= @base10 ? 1000.0 : 1024.0
-      end
-
-      def space(size, options = {})
-        case size
-        when false
-          NOT_COUNTED_SPACE.bold.red
-        when 0, nil
-          EMPTY_SPACE
-        else
-          number, degree = size, 0
-          while number.abs >= 1000 && degree < SIZE_SYMBOLS.length - 1
-            number /= denominator
-            degree += 1
-          end
-
-          "#{degree == 0 ? number.to_s : "%.#{PRECISION}f" % number}#{SIZE_SYMBOLS[degree]}".rjust(LENGTH)
-        end
-      end
-    end
-  end
-
-  def size_percent(src_size, dst_size)
-    '%5.2f%% %s' % [100 - 100.0 * dst_size / src_size, Space.space(src_size - dst_size)]
-  end
-
-  paths = paths.with_progress('optimizing')
-  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)
-      dst.replace(src)
-      ["#{percent}  #{src}", src_size, dst_size]
-    else
-      ["------ #{Space::EMPTY_SPACE}  #{src}", src.size, src.size]
-    end
-  end
-  lines, src_sizes, dst_sizes = results.transpose
-  if lines
-    $stdout.puts lines, "Total: #{size_percent(src_sizes.inject(:+), dst_sizes.inject(:+))}\n"
-  end
 end

data/image_optim.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.9.1'
+  s.version     = '0.10.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']
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = %w[lib]
 
-  s.add_dependency 'fspath', '~> 2.0.5'
+  s.add_dependency 'fspath', '~> 2.1.0'
   s.add_dependency 'image_size', '~> 1.1.2'
   s.add_dependency 'exifr', '~> 1.1.3'
   s.add_dependency 'progress', '~> 3.0.0'

data/lib/image_optim/bin_not_found_error.rb

@@ -0,0 +1,3 @@
+class ImageOptim
+  class BinNotFoundError < StandardError; end
+end

data/lib/image_optim/bin_resolver.rb

@@ -0,0 +1,50 @@
+require 'image_optim/bin_not_found_error'
+require 'thread'
+require 'fspath'
+
+class ImageOptim
+  class BinResolver
+    attr_reader :dir
+    def initialize
+      @bins = {}
+      @lock = Mutex.new
+    end
+
+    def resolve!(bin)
+      bin = bin.to_sym
+      unless @bins.include?(bin)
+        @lock.synchronize do
+          @bins[bin] = resolve?(bin) unless @bins.include?(bin)
+        end
+      end
+      @bins[bin] or raise BinNotFoundError, "`#{bin}` not found"
+    end
+
+    VENDOR_PATH = File.expand_path('../../../vendor', __FILE__)
+
+    def env_path
+      "#{dir}:#{ENV['PATH']}:#{VENDOR_PATH}"
+    end
+
+  private
+
+    def resolve?(bin)
+      if path = ENV["#{bin}_bin".upcase]
+        unless @dir
+          @dir = FSPath.temp_dir
+          at_exit{ FileUtils.remove_entry_secure @dir }
+        end
+        symlink = @dir / bin
+        symlink.make_symlink(File.expand_path(path))
+
+        accessible?(symlink)
+      else
+        accessible?(bin)
+      end
+    end
+
+    def accessible?(bin)
+      `env PATH=#{env_path.shellescape} which #{bin.to_s.shellescape}` != ''
+    end
+  end
+end

data/lib/image_optim/config.rb

@@ -0,0 +1,137 @@
+require 'image_optim/option_helpers'
+require 'image_optim/configuration_error'
+require 'image_optim/hash_helpers'
+require 'image_optim/worker'
+require 'set'
+require 'yaml'
+
+class ImageOptim
+  class Config
+    include OptionHelpers
+
+    GLOBAL_CONFIG_PATH = File.join(File.expand_path(ENV['XDG_CONFIG_HOME'] || '~/.config'), 'image_optim.yml')
+    LOCAL_CONFIG_PATH = '.image_optim.yml'
+
+    class << self
+      def global
+        File.file?(GLOBAL_CONFIG_PATH) ? read(GLOBAL_CONFIG_PATH) : {}
+      end
+
+      def local
+        File.file?(LOCAL_CONFIG_PATH) ? read(LOCAL_CONFIG_PATH) : {}
+      end
+
+    private
+
+      def read(path)
+        config = YAML.load_file(path)
+        unless config.is_a?(Hash)
+          raise "excpected hash, got #{config.inspect}"
+        end
+        HashHelpers.deep_symbolise_keys(config)
+      rescue => e
+        warn "exception when reading #{path}: #{e}"
+        {}
+      end
+    end
+
+    def initialize(options)
+      @options = [
+        Config.global,
+        Config.local,
+        HashHelpers.deep_symbolise_keys(options),
+      ].inject do |memo, hash|
+        HashHelpers.deep_merge(memo, hash)
+      end
+      @used = Set.new
+    end
+
+    def get!(key)
+      key = key.to_sym
+      @used << key
+      @options[key]
+    end
+
+    def assert_no_unused_options!
+      unknown_options = @options.reject{ |key, value| @used.include?(key) }
+      unless unknown_options.empty?
+        raise ConfigurationError, "unknown options #{unknown_options.inspect} for #{self}"
+      end
+    end
+
+    def nice
+      nice = get!(:nice)
+
+      case nice
+      when true, nil
+        10
+      when false
+        0
+      else
+        nice.to_i
+      end
+    end
+
+    def threads
+      threads = get!(:threads)
+
+      threads = case threads
+      when true, nil
+        processor_count
+      when false
+        1
+      else
+        threads.to_i
+      end
+
+      OptionHelpers.limit_with_range(threads, 1..16)
+    end
+
+    def verbose
+      !!get!(:verbose)
+    end
+
+    def for_worker(klass)
+      worker_options = get!(klass.bin_sym)
+
+      case worker_options
+      when Hash
+        worker_options
+      when true, nil
+        {}
+      when false
+        false
+      else
+        raise ConfigurationError, "Got #{worker_options.inspect} for #{klass.name} options"
+      end
+    end
+
+    def to_s
+      YAML.dump(HashHelpers.deep_stringify_keys(@options)).sub(/\A---\n/, '')
+    end
+
+  private
+
+    # 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
+end

data/lib/image_optim/configuration_error.rb

@@ -0,0 +1,3 @@
+class ImageOptim
+  class ConfigurationError < StandardError; end
+end

data/lib/image_optim/handler.rb

@@ -0,0 +1,27 @@
+require 'image_optim/image_path'
+
+class ImageOptim
+  class Handler
+    attr_reader :result
+    def initialize(original)
+      raise ArgumentError, 'original should respond to temp_path' unless original.respond_to?(:temp_path)
+
+      @original = original
+      @result = nil
+    end
+
+    def process
+      @src ||= @original
+      @dst ||= @original.temp_path
+
+      if yield @src, @dst
+        @result = @dst
+        if @src == @original
+          @src, @dst = @dst, nil
+        else
+          @src, @dst = @dst, @src
+        end
+      end
+    end
+  end
+end

data/lib/image_optim/hash_helpers.rb

@@ -0,0 +1,35 @@
+class ImageOptim
+  module HashHelpers
+    class << self
+      def deep_transform_keys(hash, &block)
+        new_hash = {}
+        hash.each do |k, v|
+          new_hash[block.call(k)] = if v.is_a?(Hash)
+            deep_transform_keys(v, &block)
+          else
+            v
+          end
+        end
+        new_hash
+      end
+
+      def deep_stringify_keys(hash)
+        deep_transform_keys(hash, &:to_s)
+      end
+
+      def deep_symbolise_keys(hash)
+        deep_transform_keys(hash, &:to_sym)
+      end
+
+      def deep_merge(a, b)
+        a.merge(b) do |k, v_a, v_b|
+          if v_a.is_a?(Hash) && v_b.is_a?(Hash)
+            deep_merge(v_a, v_b)
+          else
+            v_b
+          end
+        end
+      end
+    end
+  end
+end

data/lib/image_optim/image_path.rb

@@ -1,10 +1,30 @@
 require 'fspath'
 require 'image_size'
 
-require 'image_optim'
-
 class ImageOptim
   class ImagePath < FSPath
+    class Optimized < DelegateClass(self)
+      def initialize(path, original_or_size = nil)
+        path = ImagePath.convert(path)
+        __setobj__(path)
+        if original_or_size
+          if original_or_size.is_a?(Integer)
+            @original = path
+            @original_size = original_or_size
+          else
+            @original = ImagePath.convert(original_or_size)
+            @original_size = @original.size
+          end
+        end
+      end
+
+      # Original path, use original_size to get its size as original can be overwritten
+      attr_reader :original
+
+      # Stored size of original
+      attr_reader :original_size
+    end
+
     # Get temp path for this file with same extension
     def temp_path(*args, &block)
       ext = extname
@@ -30,5 +50,10 @@ class ImageOptim
     def format
       open{ |f| ImageSize.new(f) }.format
     end
+
+    # Returns path if it is already an instance of this class otherwise new instance
+    def self.convert(path)
+      path.is_a?(self) ? path : new(path)
+    end
   end
 end

data/lib/image_optim/option_helpers.rb

@@ -1,19 +1,7 @@
-require 'image_optim'
+require 'image_optim/configuration_error'
 
 class ImageOptim
   module OptionHelpers
-    # Remove option from hash and run through block or return default
-    def get_option!(options, name, default)
-      value = default
-      if options.has_key?(name)
-        value = options.delete(name)
-      end
-      if block_given?
-        value = yield(value)
-      end
-      instance_variable_set("@#{name}", value)
-    end
-
     # Ensure number is in range
     def self.limit_with_range(number, range)
       if range.include?(number)
@@ -26,12 +14,5 @@ class ImageOptim
         range.last
       end
     end
-
-    # Raise unless all options are deleted
-    def assert_options_empty!(options)
-      unless options.empty?
-        raise ConfigurationError, "unknown options #{options.inspect} for #{self}"
-      end
-    end
   end
 end

data/lib/image_optim/railtie.rb

@@ -0,0 +1,19 @@
+require 'image_optim'
+
+class ImageOptim
+  class Railtie < Rails::Railtie
+    initializer 'image_optim.initializer' do |app|
+      if app.config.assets.compress && app.config.assets.image_optim != false
+        image_optim = ImageOptim.new
+
+        processor = proc do |context, data|
+          image_optim.optimize_image_data(data) || data
+        end
+
+        app.assets.register_preprocessor 'image/gif', :image_optim, &processor
+        app.assets.register_preprocessor 'image/jpeg', :image_optim, &processor
+        app.assets.register_preprocessor 'image/png', :image_optim, &processor
+      end
+    end
+  end
+end