image_optim 0.9.1 → 0.10.0

data/spec/image_optim/config_spec.rb

@@ -0,0 +1,153 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+require 'rspec'
+require 'image_optim/config'
+
+class ImageOptim
+  describe Config do
+    before do
+      Config.stub(:global => {}, :local => {})
+    end
+
+    describe "assert_no_unused_options!" do
+      it "should not raise when no unused options" do
+        config = Config.new({})
+        config.assert_no_unused_options!
+      end
+
+      it "should raise when there are unused options" do
+        config = Config.new({:unused => true})
+        proc {
+          config.assert_no_unused_options!
+        }.should raise_error(ConfigurationError)
+      end
+    end
+
+    describe "nice" do
+      it "should be 10 by default" do
+        config = Config.new({})
+        config.nice.should == 10
+      end
+
+      it "should be 0 if disabled" do
+        config = Config.new({:nice => false})
+        config.nice.should == 0
+      end
+
+      it "should convert value to number" do
+        config = Config.new({:nice => '13'})
+        config.nice.should == 13
+      end
+    end
+
+    describe "threads" do
+      it "should be processor_count by default" do
+        config = Config.new({})
+        config.stub(:processor_count).and_return(13)
+        config.threads.should == 13
+      end
+
+      it "should be 1 if disabled" do
+        config = Config.new({:threads => false})
+        config.threads.should == 1
+      end
+
+      it "should convert value to number and limit to 1..16" do
+        config = Config.new({:threads => '616'})
+        config.threads.should == 16
+      end
+    end
+
+    describe "for_worker" do
+      class Abc < Worker
+        def image_formats; []; end
+      end
+
+      it "should return empty hash by default" do
+        config = Config.new({})
+        config.for_worker(Abc).should == {}
+      end
+
+      it "should return passed hash" do
+        config = Config.new({:abc => {:option => true}})
+        config.for_worker(Abc).should == {:option => true}
+      end
+
+      it "should return passed false" do
+        config = Config.new({:abc => false})
+        config.for_worker(Abc).should == false
+      end
+
+      it "should raise on unknown optino" do
+        config = Config.new({:abc => 13})
+        proc {
+          config.for_worker(Abc)
+        }.should raise_error(ConfigurationError)
+      end
+    end
+
+    describe 'class methods' do
+      before do
+        Config.unstub(:global)
+        Config.unstub(:local)
+      end
+
+      describe 'global' do
+        it "should return empty hash for global config if it does not exists" do
+          File.should_receive(:file?).with(Config::GLOBAL_CONFIG_PATH).and_return(false)
+          Config.should_not_receive(:read)
+
+          Config.global.should == {}
+        end
+
+        it "should read global config if it exists" do
+          File.should_receive(:file?).with(Config::GLOBAL_CONFIG_PATH).and_return(true)
+          Config.should_receive(:read).with(Config::GLOBAL_CONFIG_PATH).and_return({:config => true})
+
+          Config.global.should == {:config => true}
+        end
+      end
+
+      describe 'local' do
+        it "should return empty hash for local config if it does not exists" do
+          File.should_receive(:file?).with(Config::LOCAL_CONFIG_PATH).and_return(false)
+          Config.should_not_receive(:read)
+
+          Config.local.should == {}
+        end
+
+        it "should read local config if it exists" do
+          File.should_receive(:file?).with(Config::LOCAL_CONFIG_PATH).and_return(true)
+          Config.should_receive(:read).with(Config::LOCAL_CONFIG_PATH).and_return({:config => true})
+
+          Config.local.should == {:config => true}
+        end
+      end
+
+      describe 'read' do
+        it "should return hash with deep symbolised keys from yaml file reader" do
+          path = double(:path)
+          YAML.should_receive(:load_file).with(path).and_return({'config' => {'this' => true}})
+
+          Config.instance_eval{ read(path) }.should == {:config => {:this => true}}
+        end
+
+        it "should warn and return an empty hash if yaml file reader returns non hash" do
+          path = double(:path)
+          YAML.should_receive(:load_file).with(path).and_return([:config])
+          Config.should_receive(:warn)
+
+          Config.instance_eval{ read(path) }.should == {}
+        end
+
+        it "should warn and return an empty hash if yaml file reader raises exception" do
+          path = double(:path)
+          YAML.should_receive(:load_file).with(path).and_raise
+          Config.should_receive(:warn)
+
+          Config.instance_eval{ read(path) }.should == {}
+        end
+      end
+    end
+
+  end
+end

data/spec/image_optim/handler_spec.rb

@@ -0,0 +1,44 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+require 'rspec'
+require 'image_optim/handler'
+
+describe ImageOptim::Handler do
+  it "should use original as source for first conversion and two temp files for further conversions" do
+    original = double(:original)
+    original.stub(:temp_path){ raise 'temp_path called unexpectedly' }
+
+    handler = ImageOptim::Handler.new(original)
+
+    original.should_receive(:temp_path).once.and_return(temp_a = double(:temp_a))
+    handler.process do |src, dst|
+      [src, dst].should == [original, temp_a]; false
+    end
+    handler.result.should == nil
+
+    handler.process do |src, dst|
+      [src, dst].should == [original, temp_a]; true
+    end
+    handler.result.should == temp_a
+
+    original.should_receive(:temp_path).once.and_return(temp_b = double(:temp_b))
+    handler.process do |src, dst|
+      [src, dst].should == [temp_a, temp_b]; false
+    end
+    handler.result.should == temp_a
+
+    handler.process do |src, dst|
+      [src, dst].should == [temp_a, temp_b]; true
+    end
+    handler.result.should == temp_b
+
+    handler.process do |src, dst|
+      [src, dst].should == [temp_b, temp_a]; true
+    end
+    handler.result.should == temp_a
+
+    handler.process do |src, dst|
+      [src, dst].should == [temp_a, temp_b]; true
+    end
+    handler.result.should == temp_b
+  end
+end

data/spec/image_optim/hash_helpers_spec.rb

@@ -0,0 +1,74 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+require 'rspec'
+require 'image_optim/hash_helpers'
+
+describe ImageOptim::HashHelpers do
+  HH = ImageOptim::HashHelpers
+
+  it "should deep stringify hash keys" do
+    HH.deep_stringify_keys({
+      :a => 1,
+      :b => {
+        :c => :a,
+        :d => {},
+      },
+    }).should == {
+      'a' => 1,
+      'b' => {
+        'c' => :a,
+        'd' => {},
+      },
+    }
+  end
+
+  it "should deep symbolise hash keys" do
+    HH.deep_symbolise_keys({
+      'a' => 1,
+      'b' => {
+        'c' => 'a',
+        'd' => {},
+      },
+    }).should == {
+      :a => 1,
+      :b => {
+        :c => 'a',
+        :d => {},
+      },
+    }
+  end
+
+  it "should deep merge hashes" do
+    HH.deep_merge({
+      :a => {
+        :b => 1,
+        :c => {
+          :d => 2,
+          :e => {
+            :f => true
+          },
+        },
+      },
+      :y => 10,
+    }, {
+      :a => {
+        :b => 2,
+        :c => {
+          :d => 3,
+          :e => false,
+        },
+      },
+      :z => 20,
+    }).should == {
+      :a => {
+        :b => 2,
+        :c => {
+          :d => 3,
+          :e => false,
+        },
+      },
+      :y => 10,
+      :z => 20,
+    }
+  end
+
+end

data/spec/image_optim/image_path_spec.rb

@@ -0,0 +1,39 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+require 'rspec'
+require 'image_optim/image_path'
+
+describe ImageOptim::ImagePath do
+  ImagePath = ImageOptim::ImagePath
+
+  describe "convert" do
+    it "should return ImagePath for string" do
+      path = 'a'
+
+      ImagePath.convert(path).should be_a(ImageOptim::ImagePath)
+      ImagePath.convert(path).should eq(ImageOptim::ImagePath.new(path))
+
+      ImagePath.convert(path).should_not eq(path)
+      ImagePath.convert(path).should_not be(path)
+    end
+
+    it "should return ImagePath for Pathname" do
+      pathname = Pathname.new('a')
+
+      ImagePath.convert(pathname).should be_a(ImageOptim::ImagePath)
+      ImagePath.convert(pathname).should eq(ImageOptim::ImagePath.new(pathname))
+
+      ImagePath.convert(pathname).should eq(pathname)
+      ImagePath.convert(pathname).should_not be(pathname)
+    end
+
+    it "should return same instance for ImagePath" do
+      image_path = ImageOptim::ImagePath.new('a')
+
+      ImagePath.convert(image_path).should be_a(ImageOptim::ImagePath)
+      ImagePath.convert(image_path).should eq(ImageOptim::ImagePath.new(image_path))
+
+      ImagePath.convert(image_path).should eq(image_path)
+      ImagePath.convert(image_path).should be(image_path)
+    end
+  end
+end

data/spec/image_optim_spec.rb

@@ -1,4 +1,4 @@
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$:.unshift File.expand_path('../../lib', __FILE__)
 require 'rspec'
 require 'image_optim'
 require 'tempfile'
@@ -39,14 +39,11 @@ ImageOptim::ImagePath.class_eval do
   end
 end
 
-def with_env(key, value)
-  saved, ENV[key] = ENV[key], value
-  yield
-ensure
-  ENV[key] = saved
-end
-
 describe ImageOptim do
+  before do
+    ImageOptim::Config.stub(:global => {}, :local => {})
+  end
+
   describe "isolated" do
     describe "optimize" do
       TEST_IMAGES.each do |original|
@@ -56,7 +53,7 @@ describe ImageOptim do
           Tempfile.reset_init_count
           image_optim = ImageOptim.new
           optimized_image = image_optim.optimize_image(copy)
-          optimized_image.should be_a(ImageOptim::ImagePath)
+          expect(optimized_image).to be_a(ImageOptim::ImagePath::Optimized)
           optimized_image.size.should be_in_range(1...original.size)
           optimized_image.read.should_not == original.read
           copy.read.should == original.read
@@ -90,6 +87,18 @@ describe ImageOptim do
       end
     end
 
+    describe "optimize image data" do
+      TEST_IMAGES.each do |original|
+        it "should optimize #{original}" do
+          image_optim = ImageOptim.new
+          optimized_data = image_optim.optimize_image_data(original.read)
+          optimized_data.should == image_optim.optimize_image(original.temp_copy).read
+
+          image_optim.optimize_image_data(optimized_data).should be_nil
+        end
+      end
+    end
+
     describe "stop optimizing" do
       TEST_IMAGES.each do |original|
         it "should stop optimizing #{original}" do
@@ -111,7 +120,7 @@ describe ImageOptim do
       copies = TEST_IMAGES.map(&:temp_copy)
       optimized_images = ImageOptim.optimize_images(copies)
       TEST_IMAGES.zip(copies, optimized_images).each do |original, copy, optimized_image|
-        optimized_image.should be_a(ImageOptim::ImagePath)
+        expect(optimized_image).to be_a(ImageOptim::ImagePath::Optimized)
         optimized_image.size.should be_in_range(1...original.size)
         optimized_image.read.should_not == original.read
         copy.read.should == original.read
@@ -126,6 +135,13 @@ describe ImageOptim do
         copy.read.should_not == original.read
       end
     end
+
+    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 == ImageOptim.optimize_image(original.temp_copy).read
+      end
+    end
   end
 
   describe "unsupported" do
@@ -192,90 +208,6 @@ describe ImageOptim do
     end
   end
 
-  describe "resolve bin" do
-    it "should resolve bin in path" do
-      with_env 'LS_BIN', nil do
-        image_optim = ImageOptim.new
-        image_optim.should_receive(:bin_accessible?).with(:ls).once.and_return(true)
-        FSPath.should_not_receive(:temp_dir)
-
-        5.times do
-          image_optim.resolve_bin!(:ls).should be_true
-        end
-      end
-    end
-
-    it "should resolve bin specified in ENV" do
-      path = (FSPath(__FILE__).dirname / '../bin/image_optim').relative_path_from(Dir.pwd).to_s
-      with_env 'IMAGE_OPTIM_BIN', path do
-        tmpdir = double(:tmpdir)
-        symlink = double(:symlink)
-
-        image_optim = ImageOptim.new
-        image_optim.should_receive(:bin_accessible?).with(symlink).once.and_return(true)
-        FSPath.should_receive(:temp_dir).once.and_return(tmpdir)
-        tmpdir.should_receive(:/).with(:image_optim).once.and_return(symlink)
-        symlink.should_receive(:make_symlink).with(File.expand_path(path)).once
-
-        at_exit_blocks = []
-        image_optim.should_receive(:at_exit).twice do |&block|
-          at_exit_blocks.unshift(block)
-        end
-
-        5.times do
-          image_optim.resolve_bin!(:image_optim).should be_true
-        end
-
-        FileUtils.should_receive(:remove_entry_secure).with(tmpdir)
-        symlink.should_receive(:unlink)
-        at_exit_blocks.each(&:call)
-      end
-    end
-
-    it "should raise on failure to resolve bin" do
-      with_env 'SHOULD_NOT_EXIST_BIN', nil do
-        image_optim = ImageOptim.new
-        image_optim.should_receive(:bin_accessible?).with(:should_not_exist).once.and_return(false)
-        FSPath.should_not_receive(:temp_dir)
-
-        5.times do
-          expect do
-            image_optim.resolve_bin!(:should_not_exist)
-          end.to raise_error ImageOptim::BinNotFoundError
-        end
-      end
-    end
-
-    it "should raise on failure to resolve bin specified in ENV" do
-      path = (FSPath(__FILE__).dirname / '../bin/should_not_exist_bin').relative_path_from(Dir.pwd).to_s
-      with_env 'SHOULD_NOT_EXIST_BIN', path do
-        tmpdir = double(:tmpdir)
-        symlink = double(:symlink)
-
-        image_optim = ImageOptim.new
-        image_optim.should_receive(:bin_accessible?).with(symlink).once.and_return(false)
-        FSPath.should_receive(:temp_dir).once.and_return(tmpdir)
-        tmpdir.should_receive(:/).with(:should_not_exist).once.and_return(symlink)
-        symlink.should_receive(:make_symlink).with(File.expand_path(path)).once
-
-        at_exit_blocks = []
-        image_optim.should_receive(:at_exit).twice do |&block|
-          at_exit_blocks.unshift(block)
-        end
-
-        5.times do
-          expect do
-            image_optim.resolve_bin!(:should_not_exist)
-          end.to raise_error ImageOptim::BinNotFoundError
-        end
-
-        FileUtils.should_receive(:remove_entry_secure).with(tmpdir)
-        symlink.should_receive(:unlink)
-        at_exit_blocks.each(&:call)
-      end
-    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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_optim
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Ivan Kuchin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-20 00:00:00.000000000 Z
+date: 2013-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fspath
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: image_size
   requirement: !ruby/object:Gem::Requirement
@@ -106,13 +106,21 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.markdown
-- TODO
 - bin/image_optim
 - image_optim.gemspec
 - lib/image_optim.rb
+- lib/image_optim/bin_not_found_error.rb
+- lib/image_optim/bin_resolver.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_path.rb
 - lib/image_optim/option_definition.rb
 - lib/image_optim/option_helpers.rb
+- lib/image_optim/railtie.rb
+- lib/image_optim/runner.rb
+- lib/image_optim/true_false_nil.rb
 - lib/image_optim/worker.rb
 - lib/image_optim/worker/advpng.rb
 - lib/image_optim/worker/gifsicle.rb
@@ -122,7 +130,12 @@ files:
 - lib/image_optim/worker/optipng.rb
 - lib/image_optim/worker/pngcrush.rb
 - lib/image_optim/worker/pngout.rb
-- script/options_for_readme
+- script/update_worker_options_in_readme
+- spec/image_optim/bin_resolver_spec.rb
+- spec/image_optim/config_spec.rb
+- spec/image_optim/handler_spec.rb
+- spec/image_optim/hash_helpers_spec.rb
+- spec/image_optim/image_path_spec.rb
 - spec/image_optim_spec.rb
 - spec/images/comparison.png
 - spec/images/decompressed.jpeg
@@ -170,6 +183,11 @@ specification_version: 4
 summary: Optimize (lossless compress) images (jpeg, png, gif) using external utilities
   (advpng, gifsicle, jpegoptim, jpegtran, optipng, pngcrush, pngout)
 test_files:
+- spec/image_optim/bin_resolver_spec.rb
+- spec/image_optim/config_spec.rb
+- spec/image_optim/handler_spec.rb
+- spec/image_optim/hash_helpers_spec.rb
+- spec/image_optim/image_path_spec.rb
 - spec/image_optim_spec.rb
 - spec/images/comparison.png
 - spec/images/decompressed.jpeg

data/TODO

@@ -1,12 +0,0 @@
-preserve color (leave_color branch)
-preserve all extra stuff
-global level of optimization #10
-timeout workers?
-  based on file size?
-fail worker instead of process on bin not present?
-preserve time/attrs option?
-file based config
-  http://www.erickcantwell.com/code/config.rb
-  https://github.com/derks/ruby-parseconfig
-  http://stick.gk2.sk/2009/03/the-ugly-duckling-called-xdg_config_home/
-http://css-ig.net/png-tools-overview

data/script/options_for_readme

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-$: << File.expand_path('../../lib', __FILE__)
-
-require 'image_optim'
-
-ImageOptim::Worker.klasses.each_with_index do |klass, i|
-  puts "### #{klass.bin_sym}"
-  klass.option_definitions.each do |option_definition|
-    puts "* `:#{option_definition.name}` — #{option_definition.description} *(defaults to #{option_definition.default})*"
-  end
-  puts
-end