image_optim 0.22.1 → 0.23.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDRiNGJkYTQ0MDcxZGIyODc5YWJkMGZkNGVkYmQzNzRmYTk4N2Y4OQ==
+    MzcwOTc4MmMxMjI0YWM4YmQ2NzcyZTE0NTRkNjM4YjNlMmMwZGExMA==
   data.tar.gz: !binary |-
-    NDMyODhiNzkyZGIxZmVmNDdmODY3MWFkOTE0NWFkMTM5ZWY0YWY5OQ==
+    ZmFmOWZhY2U5MTMyNjIwM2U3N2M0Y2U1NjVkNTJkNmNjYTk4NzQ0Yg==
 SHA512:
   metadata.gz: !binary |-
-    NzdkYmVmNDRmYmYwODFmZjAyOWJhODBlZGE3NWEwZmJhNjllNjE5ZmJjM2Y2
-    ZTk1NDZiOWViNTZjMTI2MDE3YjgwNWQ3N2Y0Y2ZjNWQ0ODJjMGU1MjQ3NDkx
-    NTZjZjA4NjQ4MGM4YzNhMDkyYTQ3OTI3ZGYwZGMzMGRjNWU5ODQ=
+    NDMyNWI3ODA2ZTg5NTFjN2Y3YTJjMzU5MjAzZGM4ZDg3NzU4Y2IzYjU3NGZl
+    NmJkN2JiMTg3YmMyNmJjZjFkMDRlOGVlYWIzYjg2MmVhYzMxYTY5YjE0NDc5
+    N2ZlMmU2ZTQxNTU4NGMyYzcxMjU3MDM2MTllZGMxZjhiYjc0Y2E=
   data.tar.gz: !binary |-
-    MDMwNzg5MDM4NWRmNzM5ZjI0MDJmZTgwNzRiMjBlZDI1ZTNmOTMzZWUwNGE0
-    ZTc0ZGIyNWVkMjExNTIyZGFkNTk1YWQ2MjU1NzU1ZjY3ZmZkNGUyNGVmZTk2
-    ZGMyMDZjNGVlY2M1NmRmY2EyNWRjNTY5ZTBjNGRiMmI5YWYxOTE=
+    OWU2NjI5YjMyOWJmNmEzMGJjNGNmMjA0NmNlYWYyNzMxMDA0MTgyNDhjNmQz
+    NGU2NGY1Yzg4YzI3NTVkMjI4NTFiOGY1MzY0ZDlkYmI2MWFjNThmOTI3NGM0
+    M2ZmMjQ3OGIyZDc3YzY1NDI1MjU2N2U5ZDUyMDg3MDcwMzBkYTE=

data/.appveyor.yml

@@ -0,0 +1,95 @@
+version: '{build}-{branch}'
+install:
+  - mkdir tmp\bin || exit 0
+  - set PATH=%cd%\tmp\bin;%PATH%
+  - ruby --version
+  - bundle package --all
+  - echo curl.exe -fsSL --max-time 15 --retry 5 -o %%%%1 %%%%2 > tmp\bin\download.bat
+
+  - ps: | # advpng
+      if (-not (test-path tmp/bin/advpng.exe)) {
+        download.bat tmp/advancecomp.zip https://github.com/amadvance/advancecomp/releases/download/v1.20/advancecomp-1.20-windows-x86.zip
+        7z e tmp/advancecomp.zip -otmp/bin advpng.exe
+      }
+
+  - ps: | # gifsicle
+      if (-not (test-path tmp/bin/gifsicle.exe)) {
+        download.bat tmp/gifsicle.zip https://eternallybored.org/misc/gifsicle/releases/gifsicle-1.88-win64.zip
+        7z e tmp/gifsicle.zip -otmp/bin */gifsicle.exe
+      }
+
+  - ps: | # jhead
+      if (-not (test-path tmp/bin/jhead.exe)) {
+        download.bat tmp/bin/jhead.exe http://www.sentex.net/~mwandel/jhead/jhead.exe
+      }
+
+  - ps: | # jpeg-recompress
+      if (-not (test-path tmp/bin/jpeg-recompress.exe)) {
+        download.bat tmp/jpeg-archive.zip https://ci.appveyor.com/api/buildjobs/8t8vga27t8vn1js2/artifacts/jpeg-archive.zip
+        7z e tmp/jpeg-archive.zip -otmp/bin jpeg-recompress.exe
+      }
+
+  - ps: | # jpegoptim
+      if (-not (test-path tmp/bin/jpegoptim.exe)) {
+        download.bat tmp/jpegoptim.zip https://bitbucket.org/rorgoroth/jpegoptim-for-windows/downloads/jpegoptim-1.4.3-Win32.zip
+        7z e tmp/jpegoptim.zip -otmp/bin */jpegoptim.exe
+      }
+
+  - ps: | # jpegtran
+      if (-not (test-path tmp/bin/jpegtran.exe)) {
+        download.bat tmp/bin/jpegtran.exe http://jpegclub.org/jpegtran.exe
+      }
+
+  - ps: | # optipng
+      if (-not (test-path tmp/bin/optipng.exe)) {
+        download.bat tmp/optipng.zip https://sourceforge.net/projects/optipng/files/OptiPNG/optipng-0.7.6/optipng-0.7.6-win32.zip/download
+        7z e tmp/optipng.zip -otmp/bin */optipng.exe
+      }
+
+  - ps: | # pngcrush
+      if (-not (test-path tmp/bin/pngcrush.exe)) {
+        download.bat tmp/bin/pngcrush.exe https://sourceforge.net/projects/pmt/files/pngcrush-executables/1.8.1/pngcrush_1_8.1_w32.exe/download
+      }
+
+  - ps: | # pngout
+      if (-not (test-path tmp/bin/pngout.exe)) {
+        download.bat tmp/bin/pngout.exe http://advsys.net/ken/util/pngout.exe
+      }
+
+  - ps: | # pngquant
+      if (-not (test-path tmp/bin/pngquant.exe)) {
+        download.bat tmp/pngquant.zip https://pngquant.org/pngquant-windows.zip
+        7z e tmp/pngquant.zip -otmp/bin */pngquant.exe
+      }
+
+  - ps: | # svgo
+      npm install -g svgo
+
+  - ps: | # ImageMagick
+      if ((-not (test-path tmp/bin/convert.exe)) -or (-not (test-path tmp/bin/compare.exe)) -or (-not (test-path tmp/bin/magic.xml))) {
+        choco install -y imagemagick.tool
+        cp C:\ProgramData\chocolatey\lib\imagemagick.tool\tools\convert.exe tmp\bin
+        cp C:\ProgramData\chocolatey\lib\imagemagick.tool\tools\compare.exe tmp\bin
+        cp C:\ProgramData\chocolatey\lib\imagemagick.tool\tools\magic.xml tmp\bin
+      }
+
+  - bundle exec image_optim --info --allow-lossy --no-pack
+cache:
+  - tmp/bin
+build: off
+test_script:
+  - ps: |
+      $path = $env:Path
+      $rubypaths = ls -Path C:\Ruby*\bin
+      foreach ($rubypath in $rubypaths[0, -2, -1]) {
+        echo "################################################################################"
+        $env:Path = "$rubypath;" + $path
+        ruby --version
+        bundle install --local -j4
+        bundle exec rspec
+        if ($LASTEXITCODE -gt 0) {
+          exit 1
+        }
+      }
+      $env:Path = $path
+  - bundle exec image_optim --allow-lossy -r spec/images

data/.rubocop.yml

@@ -36,6 +36,9 @@ Style/DotPosition:
 Style/DoubleNegation:
   Enabled: false
 
+Style/EmptyCaseCondition:
+  Enabled: false
+
 Style/Encoding:
   EnforcedStyle: when_needed
 

data/.travis.yml

@@ -13,25 +13,30 @@ rvm:
   - '2.2'
   - jruby-19mode
   - ree
-script:
-  if [ -n "$RUBOCOP" ]; then
-    bundle exec rubocop
-  ; elif [ -n "$RAILS_VERSION" ]; then
-    bundle exec image_optim --info
-    && bundle exec rspec spec/image_optim/railtie_spec.rb
-  ; else
-    bundle exec image_optim --info
-    && bundle exec rspec
-  ; fi
-before_install:
-  if [ -z "$RUBOCOP" ]; then
-    command -v svgo || npm install svgo
-    ;
-    command -v pngout || (
-      mkdir -p ~/bin
-      && curl -L "http://static.jonof.id.au/dl/kenutils/pngout-20130221-linux.tar.gz" | tar -xz -C ~/bin --strip-components 2 --wildcards '*/x86_64/pngout'
-    )
-  ; fi
+script: |
+  (
+    set -ex
+    if [ -n "$RUBOCOP" ]; then
+      bundle exec rubocop
+    elif [ -n "$RAILS_VERSION" ] && [ -z "$CODECLIMATE" ]; then
+      bundle exec image_optim --info
+      bundle exec rspec spec/image_optim/railtie_spec.rb
+    else
+      bundle exec image_optim --info
+      bundle exec rspec
+    fi
+  )
+before_install: |
+  (
+    set -ex
+    if [ -z "$RUBOCOP" ]; then
+      command -v svgo || npm install svgo
+      command -v pngout || {
+        mkdir -p ~/bin
+        curl -L "http://static.jonof.id.au/dl/kenutils/pngout-20130221-linux.tar.gz" | tar -xz -C ~/bin --strip-components 2 --wildcards '*/x86_64/pngout'
+      }
+    fi
+  )
 matrix:
   fast_finish: true
   include:
@@ -40,9 +45,9 @@ matrix:
     - env: RAILS_VERSION='~> 3.2'
       rvm: default
     - env: RAILS_VERSION='~> 4.0' SPROCKETS_RAILS_VERSION='~> 2.0'
-      rvm: default
-    - env: RAILS_VERSION='~> 4.0'
-      rvm: default
+      rvm: '2'
+    - env: RAILS_VERSION='~> 4.0' CODECLIMATE=1
+      rvm: '2'
     - env: RUBOCOP=true
       rvm: default
   allow_failures:

data/CHANGELOG.markdown

@@ -2,6 +2,16 @@
 
 ## unreleased
 
+## v0.23.0 (2016-07-17)
+
+* Added `cache_dir` and `cache_worker_digests` options to cache results [#83](https://github.com/toy/image_optim/issues/83) [@gpakosz](https://github.com/gpakosz)
+* Should work on windows [#24](https://github.com/toy/image_optim/issues/24) [@toy](https://github.com/toy)
+* Rename `ImageOptim::ImagePath` to `ImageOptim::Path` and its method `#format` to `#image_format` [@toy](https://github.com/toy)
+* Ignore empty config files [#133](https://github.com/toy/image_optim/issues/133) [@toy](https://github.com/toy)
+* Use `FileUtils.move` in `ImagePath#replace` to rename file instead of copying on same device, don't preserve mtime and atime [#134](https://github.com/toy/image_optim/issues/134) [@toy](https://github.com/toy)
+* Make `:allow_lossy` an individual option for workers that can use it, so it will be in the list of worker options [#130](https://github.com/toy/image_optim/issues/130) [@toy](https://github.com/toy)
+* Use first 8 characters of sha1 hex for jpegrescan version [#131](https://github.com/toy/image_optim/issues/131) [@toy](https://github.com/toy)
+
 ## v0.22.1 (2016-02-21)
 
 * Fix missing old (1.x) `pngquant` version as it was output to stderr [#123](https://github.com/toy/image_optim/issues/123) [@toy](https://github.com/toy)

data/CONTRIBUTING.markdown

@@ -2,9 +2,10 @@
 
 * Create topic/feature branch: `git checkout -b awesome-changes`
 * Commit…
-* Add entry to [ChangeLog](CHANGELOG.markdown)
+* Add entry at the top of [ChangeLog](CHANGELOG.markdown)
 * Run tests: `bundle exec rspec`
 * Check code style: `bundle exec rubocop`
+* Rebase on master and squash commits to logical units
 * Push your branch: `git push origin awesome-changes`
 * Create pull request
 * Check if [travis is happy](https://travis-ci.org/toy/image_optim/pull_requests)

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9')
+if ENV['CODECLIMATE']
   gem 'codeclimate-test-reporter', :group => :test, :require => nil
 end
 

data/README.markdown

@@ -1,9 +1,10 @@
 [![Gem Version](https://img.shields.io/gem/v/image_optim.svg?style=flat)](https://rubygems.org/gems/image_optim)
 [![Build Status](https://img.shields.io/travis/toy/image_optim/master.svg?style=flat)](https://travis-ci.org/toy/image_optim)
+[![AppVeyor Status](https://img.shields.io/appveyor/ci/toy/image-optim/master.svg?style=flat&label=windows)](https://ci.appveyor.com/project/toy/image-optim)
 [![Code Climate](https://img.shields.io/codeclimate/github/toy/image_optim.svg?style=flat)](https://codeclimate.com/github/toy/image_optim)
 [![Code Climate Coverage](https://img.shields.io/codeclimate/coverage/github/toy/image_optim.svg?style=flat)](https://codeclimate.com/github/toy/image_optim)
 [![Dependency Status](https://img.shields.io/gemnasium/toy/image_optim.svg?style=flat)](https://gemnasium.com/toy/image_optim)
-[![Inch CI](http://inch-ci.org/github/toy/image_optim.svg?branch=master&style=flat)](http://inch-ci.org/github/toy/image_optim)
+[![Inch CI](https://inch-ci.org/github/toy/image_optim.svg?branch=master&style=flat)](https://inch-ci.org/github/toy/image_optim)
 
 # image_optim
 
@@ -55,9 +56,11 @@ gem 'image_optim_pack'
 
 With version:
 
+<!---<update-version>-->
 ```ruby
-gem 'image_optim', '~> 0.11'
+gem 'image_optim', '~> 0.23'
 ```
+<!---</update-version>-->
 
 If you want to check latest changes:
 
@@ -271,6 +274,8 @@ optipng:
 * `:pack` — Require image\_optim\_pack or disable it, by default image\_optim\_pack will be used if available, will turn on `:skip-missing-workers` unless explicitly disabled *(defaults to `nil`)*
 * `:skip_missing_workers` — Skip workers with missing or problematic binaries *(defaults to `false`)*
 * `:allow_lossy` — Allow lossy workers and optimizations *(defaults to `false`)*
+* `:cache_dir` — Configure cache directory
+* `:cache_worker_digests` - Also cache worker digests along with original file digest and worker options: updating workers invalidates cache
 
 Worker can be disabled by passing `false` instead of options hash or by setting option `:disable` to `true`.
 
@@ -289,10 +294,12 @@ Worker can be disabled by passing `false` instead of options hash or by setting
 Worker has no options
 
 ### jpegoptim:
+* `:allow_lossy` — Allow limiting maximum quality *(defaults to `false`)*
 * `:strip` — List of extra markers to strip: `:comments`, `:exif`, `:iptc`, `:icc` or `:all` *(defaults to `:all`)*
 * `:max_quality` — Maximum image quality factor `0`..`100`, ignored in default/lossless mode *(defaults to `100`)*
 
 ### jpegrecompress:
+* `:allow_lossy` — Allow worker, it is always lossy *(defaults to `false`)*
 * `:quality` — JPEG quality preset: `0` - low, `1` - medium, `2` - high, `3` - veryhigh *(defaults to `3`)*
 
 ### jpegtran:
@@ -316,6 +323,7 @@ Worker has no options
 * `:strategy` — Strategy: `0` - xtreme, `1` - intense, `2` - longest Match, `3` - huffman Only, `4` - uncompressed *(defaults to `0`)*
 
 ### pngquant:
+* `:allow_lossy` — Allow quality option *(defaults to `false`)*
 * `:quality` — min..max - don't save below min, use less colors below max (both in range `0..100`; in yaml - `!ruby/range 0..100`), ignored in default/lossless mode *(defaults to `100..100`, `0..100` in lossy mode)*
 * `:speed` — speed/quality trade-off: `1` - slow, `3` - default, `11` - fast & rough *(defaults to `3`)*
 

data/image_optim.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'image_optim'
-  s.version     = '0.22.1'
+  s.version     = '0.23.0'
   s.summary     = %q{Optimize (lossless compress, optionally lossy) images (jpeg, png, gif, svg) using external utilities (advpng, gifsicle, jhead, jpeg-recompress, jpegoptim, jpegrescan, jpegtran, optipng, pngcrush, pngout, pngquant, svgo)}
   s.homepage    = "http://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
@@ -15,15 +15,15 @@ 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.1'
+  s.add_dependency 'fspath', '~> 3.0'
   s.add_dependency 'image_size', '~> 1.3'
   s.add_dependency 'exifr', '~> 1.2', '>= 1.2.2'
   s.add_dependency 'progress', '~> 3.0', '>= 3.0.1'
   s.add_dependency 'in_threads', '~> 1.3'
 
-  s.add_development_dependency 'image_optim_pack', '~> 0.2'
+  s.add_development_dependency 'image_optim_pack', '~> 0.2', '>= 0.2.2'
   s.add_development_dependency 'rspec', '~> 3.0'
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.3')
+  if RUBY_VERSION >= '1.9.3'
     s.add_development_dependency 'rubocop', '~> 0.37'
   end
 end

data/lib/image_optim.rb

@@ -1,8 +1,10 @@
 require 'image_optim/bin_resolver'
+require 'image_optim/cache'
 require 'image_optim/config'
 require 'image_optim/handler'
 require 'image_optim/image_meta'
-require 'image_optim/image_path'
+require 'image_optim/optimized_path'
+require 'image_optim/path'
 require 'image_optim/railtie' if defined?(Rails)
 require 'image_optim/worker'
 require 'in_threads'
@@ -37,6 +39,12 @@ class ImageOptim
   # Allow lossy workers and optimizations
   attr_reader :allow_lossy
 
+  # Cache directory
+  attr_reader :cache_dir
+
+  # Cache worker digests
+  attr_reader :cache_worker_digests
+
   # Initialize workers, specify options using worker underscored name:
   #
   # pass false to disable worker
@@ -67,6 +75,8 @@ class ImageOptim
       pack
       skip_missing_workers
       allow_lossy
+      cache_dir
+      cache_worker_digests
     ].each do |name|
       instance_variable_set(:"@#{name}", config.send(name))
       $stderr << "#{name}: #{send(name)}\n" if verbose
@@ -78,6 +88,8 @@ class ImageOptim
       config.for_worker(klass)
     end
 
+    @cache = Cache.new(self, @workers_by_format)
+
     log_workers_by_format if verbose
 
     config.assert_no_unused_options!
@@ -85,39 +97,43 @@ class ImageOptim
 
   # Get workers for image
   def workers_for_image(path)
-    @workers_by_format[ImagePath.convert(path).format]
+    @workers_by_format[Path.convert(path).image_format]
   end
 
-  # Optimize one file, return new path as OptimizedImagePath or nil if
+  # Optimize one file, return new path as OptimizedPath or nil if
   # optimization failed
   def optimize_image(original)
-    original = ImagePath.convert(original)
+    original = Path.convert(original)
     return unless (workers = workers_for_image(original))
-    result = Handler.for(original) do |handler|
-      workers.each do |worker|
-        handler.process do |src, dst|
-          worker.optimize(src, dst)
+
+    optimized = @cache.fetch(original) do
+      Handler.for(original) do |handler|
+        workers.each do |worker|
+          handler.process do |src, dst|
+            worker.optimize(src, dst)
+          end
         end
       end
     end
-    return unless result
-    ImagePath::Optimized.new(result, original)
+
+    return unless optimized
+    OptimizedPath.new(optimized, original)
   end
 
-  # Optimize one file in place, return original as OptimizedImagePath or nil if
+  # Optimize one file in place, return original as OptimizedPath or nil if
   # optimization failed
   def optimize_image!(original)
-    original = ImagePath.convert(original)
+    original = Path.convert(original)
     return unless (result = optimize_image(original))
     result.replace(original)
-    ImagePath::Optimized.new(original, result.original_size)
+    OptimizedPath.new(original, result.original_size)
   end
 
   # Optimize image data, return new data or nil if optimization failed
   def optimize_image_data(original_data)
-    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|
+    format = ImageMeta.format_for_data(original_data)
+    return unless format
+    Path.temp_file %W[image_optim .#{format}] do |temp|
       temp.binmode
       temp.write(original_data)
       temp.close

data/lib/image_optim/bin_resolver/bin.rb

@@ -2,7 +2,9 @@ require 'image_optim/bin_resolver/error'
 require 'image_optim/bin_resolver/simple_version'
 require 'image_optim/bin_resolver/comparable_condition'
 require 'image_optim/cmd'
+require 'image_optim/path'
 require 'shellwords'
+require 'digest/sha1'
 
 class ImageOptim
   class BinResolver
@@ -18,6 +20,11 @@ class ImageOptim
         @version = detect_version
       end
 
+      def digest
+        return @digest if defined?(@digest)
+        @digest = File.exist?(@path) && Digest::SHA1.file(@path).hexdigest
+      end
+
       def to_s
         "#{name} #{version || '?'} at #{path}"
       end
@@ -73,11 +80,11 @@ class ImageOptim
       def version_string
         case name
         when :advpng, :gifsicle, :jpegoptim, :optipng
-          capture("#{escaped_path} --version 2> /dev/null")[/\d+(\.\d+)+/]
+          capture("#{escaped_path} --version 2> #{Path::NULL}")[/\d+(\.\d+)+/]
         when :svgo, :pngquant
           capture("#{escaped_path} --version 2>&1")[/\d+(\.\d+)+/]
         when :jhead, :'jpeg-recompress'
-          capture("#{escaped_path} -V 2> /dev/null")[/\d+(\.\d+)+/]
+          capture("#{escaped_path} -V 2> #{Path::NULL}")[/\d+(\.\d+)+/]
         when :jpegtran
           capture("#{escaped_path} -v - 2>&1")[/version (\d+\S*)/, 1]
         when :pngcrush
@@ -87,8 +94,8 @@ class ImageOptim
           date_str = capture("#{escaped_path} 2>&1")[date_regexp]
           Date.parse(date_str).strftime('%Y%m%d') if date_str
         when :jpegrescan
-          # jpegrescan has no version so just check presence
-          path && '-'
+          # jpegrescan has no version so use first 8 characters of sha1 hex
+          Digest::SHA1.file(path).hexdigest[0, 8] if path
         else
           fail "getting `#{name}` version is not defined"
         end