image_optim 0.12.1 → 0.13.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzhlYjg1NzA0MjUxYmM3MDhjNWVkZDcyYTAyZTM4MTAyMzUyZWU1ZQ==
+    YjI2ZTQxODlhMzRlMzllZjk0YjhiNmU3YWZiNWYzMDA5NTM2Y2VhNw==
   data.tar.gz: !binary |-
-    MjE2MjNkNzk1NDIyY2NjM2VjZjc4OTkwNmQ5MGY4NWU5YmI4NmViZA==
+    MWM1N2Q3ZDlmYzQ1MzczMWQ3NjJhMjBlN2E5NGU0ZGIwODhhMDkwNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Yzg2ZDUyY2E3MTNhMTQzODgxOWU5M2ZkMWYxZDE1ZThkN2Q3ZTQyYTM3MThj
-    OTE0OWQwMDUyYjJlZTFlZjU3YWI1ZmI4NTJlZGU4OTdkZTYyM2YzOTY2NTU0
-    MjM1ZDQyMmQ1NGZhYTJiNGFlY2MyNThhNTdkYTAxMzExODkxYTM=
+    OTM3MDE3NThhYmEzZjI3NTM2NWMxZDZhOWI2YTg0NDk0ZDk1NjM1NzMyMzhj
+    NTJjY2UzODhhZmY5MTRhZjRlYTBlYzYxZTY1NzgyMGFmMjY5ZjBhNWU3NDAx
+    MmJlZTEwYTY5MDMxMGI1MTI3YWU0N2NkMjdmOTNjNzYzNjE0NTE=
   data.tar.gz: !binary |-
-    ZmM1ZDRjNzBkNjNjYmI3MmEwZDRjYWVhYThjMjQ1NjIxMTJjZTgzZDJiMmNl
-    OTQ4NjM2MjU3YTA4M2NlMGZjNDk3YTIyODYzM2RhZWM5YmVjOThjMGM2NjU3
-    YzFhMjJkMWEyNDFhOTllYjNjOWZhNTViMzQ1YWJhNmQ3M2NjYzg=
+    N2IzNzVhNWFjNzFkOWUwYjg1MjUyYmM4YWJhNjgzYTlhMjgwZDQ0NTYwNWE0
+    MGMzYTA3YzMzOWZkMmZlYzk0YzliMWJhMDZkODZiN2JkMzc3MzIwZDQ4ZGE3
+    MDE1MGY4NWI5YTA5YWU5YmNhN2Y4MTc4YmExMjkzNDg0NTFmNDk=

data/README.markdown

@@ -3,6 +3,7 @@
 Optimize (lossless compress) 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)
@@ -218,6 +219,7 @@ optipng:
 Worker can be disabled by passing `false` instead of options hash.
 
 <!---<worker-options>-->
+<!-- worker options markdown is generated by `script/update_worker_options_in_readme` -->
 
 ### :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/bin/image_optim

@@ -9,7 +9,7 @@ option_parser = OptionParser.new do |op|
   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}
+    |#{ImageOptim.full_version}
     |
     |Usege:
     |  #{op.program_name} [options] image_path …
@@ -103,6 +103,7 @@ begin
   end
 
   option_parser.parse!(args)
+  $stderr.puts ImageOptim.full_version if options[:verbose]
   ImageOptim::Runner.run!(args, options) or exit 1
 rescue OptionParser::ParseError => e
   abort "#{e.to_s}\n\n#{option_parser.help}"

data/image_optim.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.12.1'
+  s.version     = '0.13.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']

data/lib/image_optim.rb

@@ -1,6 +1,7 @@
 require 'image_optim/bin_resolver'
 require 'image_optim/config'
 require 'image_optim/handler'
+require 'image_optim/image_meta'
 require 'image_optim/image_path'
 require 'image_optim/worker'
 require 'in_threads'
@@ -97,8 +98,9 @@ class ImageOptim
 
   # Optimize image data, return new data or nil if optimization failed
   def optimize_image_data(original_data)
-    format = ImageSize.new(original_data).format
-    ImagePath.temp_file %W[image_optim .#{format}] do |temp|
+    image_meta = ImageMeta.for_data(original_data)
+    return unless image_meta && image_meta.format
+    ImagePath.temp_file %W[image_optim .#{image_meta.format}] do |temp|
       temp.binmode
       temp.write(original_data)
       temp.close
@@ -144,6 +146,11 @@ class ImageOptim
     Gem.loaded_specs['image_optim'].version.to_s rescue 'DEV'
   end
 
+  # Full version of image_optim
+  def self.full_version
+    "image_optim v#{version}"
+  end
+
   # Are there workers for file at path?
   def optimizable?(path)
     !!workers_for_image(path)

data/lib/image_optim/bin_resolver.rb

@@ -1,5 +1,7 @@
 require 'thread'
 require 'fspath'
+require 'image_optim/bin_resolver/simple_version'
+require 'image_optim/bin_resolver/comparable_condition'
 
 class ImageOptim
   class BinNotFoundError < StandardError; end
@@ -9,7 +11,8 @@ class ImageOptim
     class Bin
       attr_reader :name, :version
       def initialize(name, version)
-        @name, @version = name, version
+        @name = name
+        @version = version && SimpleVersion.new(version)
       end
 
       def to_s
@@ -94,11 +97,17 @@ class ImageOptim
     end
 
     def check!(bin)
+      is = ComparableCondition.is
       case bin.name
       when :pngcrush
         case bin.version
-        when '1.7.60'..'1.7.65'
-          raise BadBinVersion, "`#{bin}` is known to produce broken pngs"
+        when c = is.between?('1.7.60', '1.7.65')
+          raise BadBinVersion, "`#{bin}` (#{c}) is known to produce broken pngs"
+        end
+      when :advpng
+        case bin.version
+        when c = is < '1.17'
+          warn "Note that `#{bin}` (#{c}) does not use zopfli"
         end
       end
     end

data/lib/image_optim/bin_resolver/comparable_condition.rb

@@ -0,0 +1,44 @@
+class ImageOptim
+  class BinResolver
+    class ComparableCondition
+      class Builder
+        Comparable.instance_methods.each do |method|
+          define_method method do |*args|
+            ComparableCondition.new(method, *args)
+          end
+        end
+      end
+
+      def self.is
+        Builder.new
+      end
+
+      attr_reader :method, :args
+      def initialize(method, *args)
+        @method = method.to_sym
+        @args = args
+
+        case @method
+        when :between?
+          raise ArgumentError, "`between?' expects 2 arguments" unless args.length == 2
+        when :<, :<=, :==, :>, :>=
+          raise ArgumentError, "`#{method}' expects 1 argument" unless args.length == 1
+        else
+          raise ArgumentError, "Unknown method `#{method}'"
+        end
+      end
+
+      def ===(to_compare)
+        to_compare.send(@method, *@args)
+      end
+
+      def to_s
+        if @method == :between?
+          @args.join('..')
+        else
+          "#{@method} #{@args.first}"
+        end
+      end
+    end
+  end
+end

data/lib/image_optim/bin_resolver/simple_version.rb

@@ -0,0 +1,22 @@
+class ImageOptim
+  class BinResolver
+    class SimpleVersion
+      include Comparable
+
+      attr_reader :parts
+      def initialize(str)
+        @str = String(str)
+        @parts = @str.split('.').map(&:to_i).reverse.drop_while(&:zero?).reverse
+      end
+
+      def to_s
+        @str
+      end
+
+      def <=>(other)
+        other = self.class.new(other) unless other.is_a?(self.class)
+        parts <=> other.parts
+      end
+    end
+  end
+end

data/lib/image_optim/image_meta.rb

@@ -0,0 +1,24 @@
+require 'image_size'
+
+class ImageOptim
+  class ImageMeta
+    def self.for_path(path)
+      is = ImageSize.path(path)
+      new(is.format)
+    rescue => e
+      warn "#{e} (detecting format of image at #{path})"
+    end
+
+    def self.for_data(data)
+      is = ImageSize.new(data)
+      new(is.format)
+    rescue => e
+      warn "#{e} (detecting format of image data)"
+    end
+
+    attr_reader :format
+    def initialize(format)
+      @format = format
+    end
+  end
+end

data/lib/image_optim/image_path.rb

@@ -1,5 +1,5 @@
 require 'fspath'
-require 'image_size'
+require 'image_optim/image_meta'
 
 class ImageOptim
   class ImagePath < FSPath
@@ -49,7 +49,9 @@ class ImageOptim
 
     # Get format using ImageSize
     def format
-      open{ |f| ImageSize.new(f) }.format
+      if image_meta = ImageMeta.for_path(self)
+        image_meta.format
+      end
     end
 
     # Returns path if it is already an instance of this class otherwise new instance

data/script/update_worker_options_in_readme

@@ -8,28 +8,36 @@ require 'image_optim'
 README_FILE = File.expand_path('../../README.markdown', __FILE__)
 BEGIN_MARKER = '<!---<worker-options>-->'
 END_MARKER = '<!---</worker-options>-->'
+GENERATED_NOTE = "<!-- markdown for worker options is generated by `#{$0}` -->"
+
+def update_worker_options(text)
+  text.clone.sub!(/#{Regexp.escape(BEGIN_MARKER)}.*#{Regexp.escape(END_MARKER)}/m) do
+    StringIO.open do |md|
+      md.puts BEGIN_MARKER
+      md.puts GENERATED_NOTE
+      md.puts
+
+      ImageOptim::Worker.klasses.each_with_index do |klass, i|
+        md.puts "### :#{klass.bin_sym} =>"
+        if klass.option_definitions.empty?
+          md.puts 'Worker has no options'
+        else
+          klass.option_definitions.each do |option_definition|
+            md.puts "* `:#{option_definition.name}` — #{option_definition.description} *(defaults to `#{option_definition.default.inspect}`)*"
+          end
+        end
+        md.puts
+      end
 
-def worker_options
-  io = StringIO.new
+      md.puts END_MARKER
 
-  ImageOptim::Worker.klasses.each_with_index do |klass, i|
-    io.puts "### :#{klass.bin_sym} =>"
-    if klass.option_definitions.empty?
-      io.puts 'Worker has no options'
-    else
-      klass.option_definitions.each do |option_definition|
-        io.puts "* `:#{option_definition.name}` — #{option_definition.description} *(defaults to `#{option_definition.default.inspect}`)*"
-      end
+      md.string.strip
     end
-    io.puts
   end
-
-  io.string
 end
 
 readme = File.read(README_FILE)
-
-if readme.sub!(/#{Regexp.escape(BEGIN_MARKER)}.*#{Regexp.escape(END_MARKER)}/m, "#{BEGIN_MARKER}\n\n#{worker_options.strip}\n\n#{END_MARKER}")
+if readme = update_worker_options(readme)
   File.open(README_FILE, 'w') do |f|
     f.write readme
   end

data/spec/image_optim/bin_resolver/comparable_condition_spec.rb

@@ -0,0 +1,38 @@
+$:.unshift File.expand_path('../../../../lib', __FILE__)
+require 'rspec'
+require 'image_optim/bin_resolver/comparable_condition'
+
+describe ImageOptim::BinResolver::ComparableCondition do
+  is = ImageOptim::BinResolver::ComparableCondition.is
+
+  it "should build conditions" do
+    expect(is.between?(10, 20).method).to eq(:between?)
+    expect(is.between?(10, 20).args).to eq([10, 20])
+
+    expect((is >= 15).method).to eq(:>=)
+    expect((is >= 15).args).to eq([15])
+
+    expect((is < 30).method).to eq(:<)
+    expect((is < 30).args).to eq([30])
+  end
+
+  it "should stringify conditions" do
+    expect(is.between?(10, 20).to_s).to eq('10..20')
+    expect((is >= 15).to_s).to eq('>= 15')
+    expect((is < 30).to_s).to eq('< 30')
+  end
+
+  it "should match conditions" do
+    expect(is.between?(10, 20)).not_to be === 9
+    expect(is.between?(10, 20)).to be === 15
+    expect(is.between?(10, 20)).not_to be === 21
+
+    expect(is >= 15).not_to be === 14
+    expect(is >= 15).to be === 15
+    expect(is >= 15).to be === 16
+
+    expect(is < 30).to be === 29
+    expect(is < 30).not_to be === 30
+    expect(is < 30).not_to be === 31
+  end
+end

data/spec/image_optim/bin_resolver/simple_version_spec.rb

@@ -0,0 +1,34 @@
+$:.unshift File.expand_path('../../../../lib', __FILE__)
+require 'rspec'
+require 'image_optim/bin_resolver/simple_version'
+
+describe ImageOptim::BinResolver::SimpleVersion do
+  def v(str)
+    ImageOptim::BinResolver::SimpleVersion.new(str)
+  end
+
+  it "should compare versions" do
+    expect(v '1.17').to be > '0'
+    expect(v '1.17').to be > '0.1'
+    expect(v '1.17').to be > '0.9'
+    expect(v '1.17').to be > '1.9'
+    expect(v '1.17').to be < '1.17.1'
+    expect(v '1.17').to be < '1.99'
+    expect(v '1.17').to be < '2.1'
+  end
+
+  it "should normalize versions" do
+    variations = %w[1 01 1.0 1.00 1.0.0 1.0.0.0]
+    variations.each do |a|
+      variations.each do |b|
+        expect(v a).to eq(b)
+      end
+    end
+  end
+
+  it "should convert objects" do
+    expect(v 1.17).to eq('1.17')
+    expect(v '1.17').to eq('1.17')
+    expect(v(v 1.17)).to eq('1.17')
+  end
+end

data/spec/image_optim_spec.rb

@@ -44,6 +44,18 @@ describe ImageOptim do
     ImageOptim::Config.stub(:global => {}, :local => {})
   end
 
+  describe "worker" do
+    options = Hash[ImageOptim::Worker.klasses.map{ |klass| [klass.bin_sym, false] }]
+    ImageOptim::Worker.klasses.reject{ |k| k.new({}).image_formats.empty? }.each do |worker_klass|
+      describe worker_klass.bin_sym do
+        it "should optimize at least one test image" do
+          image_optim = ImageOptim.new(options.merge(worker_klass.bin_sym => true))
+          expect(TEST_IMAGES.any?{ |original| image_optim.optimize_image(original.temp_copy) }).to be_true
+        end
+      end
+    end
+  end
+
   describe "isolated" do
     describe "optimize" do
       TEST_IMAGES.each do |original|
@@ -92,6 +104,7 @@ describe ImageOptim do
         it "should optimize #{original}" do
           image_optim = ImageOptim.new
           optimized_data = image_optim.optimize_image_data(original.read)
+          optimized_data.should_not be_nil
           optimized_data.should == image_optim.optimize_image(original.temp_copy).open('rb', &:read)
 
           image_optim.optimize_image_data(optimized_data).should be_nil
@@ -139,6 +152,7 @@ describe ImageOptim do
     it "should optimize datas" do
       optimized_images_datas = ImageOptim.optimize_images_data(TEST_IMAGES.map(&:read))
       TEST_IMAGES.zip(optimized_images_datas).each do |original, optimized_image_data|
+        optimized_image_data.should_not be_nil
         optimized_image_data.should == ImageOptim.optimize_image(original.temp_copy).open('rb', &:read)
       end
     end
@@ -165,6 +179,27 @@ describe ImageOptim do
       Tempfile.init_count.should == 0
       copy.read.should == original.read
     end
+
+    {
+      :png => "\211PNG\r\n\032\n",
+      :jpeg => "\377\330",
+    }.each do |type, data|
+      describe "broken #{type}" do
+        before do
+          ImageOptim::ImageMeta.should_receive(:warn)
+        end
+
+        it "should ignore path" do
+          path = FSPath.temp_file_path
+          path.write(data)
+          ImageOptim.optimize_image(path).should be_nil
+        end
+
+        it "should ignore data" do
+          ImageOptim.optimize_image_data(data).should be_nil
+        end
+      end
+    end
   end
 
   describe "optimize multiple" do
@@ -202,15 +237,38 @@ describe ImageOptim do
     end
   end
 
-  describe "auto orienting" do
-    original = ImageOptim::ImagePath.new(__FILE__).dirname / 'images/orient/original.jpg'
-    ImageOptim::ImagePath.new(__FILE__).dirname.glob('images/orient/?.jpg').each do |jpg|
-      it "should rotate #{jpg}" do
-        image_optim = ImageOptim.new
-        oriented = image_optim.optimize_image(jpg)
-        nrmse = `compare -metric RMSE #{original.to_s.shellescape} #{oriented.to_s.shellescape} /dev/null 2>&1`[/\((\d+(\.\d+)?)\)/, 1]
-        nrmse.should_not be_nil
-        nrmse.to_f.should be < 0.005
+  describe "losslessness" do
+    rotated = ImageOptim::ImagePath.new(__FILE__).dirname / 'images/orient/original.jpg'
+    rotate_images = ImageOptim::ImagePath.new(__FILE__).dirname.glob('images/orient/?.jpg')
+
+    def flatten_animation(image)
+      if image.format == :gif
+        flattened = image.temp_path
+        system("convert #{image.to_s.shellescape} -coalesce -append #{flattened.to_s.shellescape}").should be_true
+        flattened
+      else
+        image
+      end
+    end
+
+    def check_lossless_optimization(original, optimized)
+      optimized.should_not be_nil
+      original = flatten_animation(original)
+      optimized = flatten_animation(optimized)
+      nrmse = `compare -metric RMSE #{original.to_s.shellescape} #{optimized.to_s.shellescape} /dev/null 2>&1`[/\((\d+(\.\d+)?)\)/, 1]
+      nrmse.should_not be_nil
+      nrmse.to_f.should == 0
+    end
+
+    rotate_images.each do |image|
+      it "should rotate and optimize #{image} losslessly" do
+        check_lossless_optimization(rotated, ImageOptim.optimize_image(image))
+      end
+    end
+
+    (TEST_IMAGES - rotate_images).each do |image|
+      it "should optimize #{image} losslessly" do
+        check_lossless_optimization(image, ImageOptim.optimize_image(image))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_optim
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Ivan Kuchin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -110,10 +110,13 @@ files:
 - image_optim.gemspec
 - lib/image_optim.rb
 - lib/image_optim/bin_resolver.rb
+- lib/image_optim/bin_resolver/comparable_condition.rb
+- lib/image_optim/bin_resolver/simple_version.rb
 - lib/image_optim/config.rb
 - lib/image_optim/configuration_error.rb
 - lib/image_optim/handler.rb
 - lib/image_optim/hash_helpers.rb
+- lib/image_optim/image_meta.rb
 - lib/image_optim/image_path.rb
 - lib/image_optim/option_definition.rb
 - lib/image_optim/option_helpers.rb
@@ -131,6 +134,8 @@ files:
 - lib/image_optim/worker/pngout.rb
 - lib/image_optim/worker/svgo.rb
 - script/update_worker_options_in_readme
+- spec/image_optim/bin_resolver/comparable_condition_spec.rb
+- spec/image_optim/bin_resolver/simple_version_spec.rb
 - spec/image_optim/bin_resolver_spec.rb
 - spec/image_optim/config_spec.rb
 - spec/image_optim/handler_spec.rb
@@ -184,6 +189,8 @@ specification_version: 4
 summary: Optimize (lossless compress) images (jpeg, png, gif, svg) using external
   utilities (advpng, gifsicle, jpegoptim, jpegtran, optipng, pngcrush, pngout, svgo)
 test_files:
+- spec/image_optim/bin_resolver/comparable_condition_spec.rb
+- spec/image_optim/bin_resolver/simple_version_spec.rb
 - spec/image_optim/bin_resolver_spec.rb
 - spec/image_optim/config_spec.rb
 - spec/image_optim/handler_spec.rb