image_optim 0.22.1 → 0.23.0

data/lib/image_optim/cache.rb

@@ -0,0 +1,71 @@
+require 'digest/sha1'
+require 'fspath'
+require 'image_optim/cache_path'
+
+class ImageOptim
+  # Handles image cache
+  class Cache
+    def initialize(image_optim, workers_by_format)
+      return unless image_optim.cache_dir
+      @cache_dir = FSPath.new(image_optim.cache_dir)
+      @cache_worker_digests = image_optim.cache_worker_digests
+      @options_by_format = Hash[workers_by_format.map do |format, workers|
+        [format, workers.map(&:inspect).sort.join(', ')]
+      end]
+      @bins_by_format = Hash[workers_by_format.map do |format, workers|
+        [format, workers.map(&:used_bins).flatten!.map! do |sym|
+          bin = image_optim.resolve_bin!(sym)
+          "#{bin.name}[#{bin.digest}]"
+        end.sort!.uniq.join(', ')]
+      end]
+    end
+
+    def fetch(original)
+      return yield unless @cache_dir
+
+      digest = digest(original, original.image_format)
+      cached = @cache_dir / digest
+      return cached.size? && CachePath.convert(cached) if cached.file?
+
+      optimized = yield
+
+      cached.dirname.mkpath
+
+      if optimized
+        tmp = FSPath.temp_file_path(digest, @cache_dir)
+        FileUtils.mv(optimized, tmp)
+        tmp.rename(cached)
+        cached_path = CachePath.convert(cached)
+
+        # mark cached image as already optimized
+        cached = @cache_dir / digest(cached, original.image_format)
+        cached.dirname.mkpath
+        FileUtils.touch(cached)
+
+        cached_path
+      else
+        # mark image as already optimized
+        FileUtils.touch(cached)
+        nil
+      end
+    end
+
+  private
+
+    def options_by_format(format)
+      @options_by_format[format]
+    end
+
+    def bins_by_format(format)
+      @bins_by_format[format]
+    end
+
+    def digest(path, format)
+      digest = Digest::SHA1.file(path)
+      digest.update options_by_format(format)
+      digest.update bins_by_format(format) if @cache_worker_digests
+      s = digest.hexdigest
+      "#{s[0..1]}/#{s[2..-1]}"
+    end
+  end
+end

data/lib/image_optim/cache_path.rb

@@ -0,0 +1,16 @@
+require 'image_optim/path'
+
+class ImageOptim
+  # ImageOptiom::Path with a non self destructing #replace method
+  class CachePath < Path
+    # Atomic replace dst with self
+    def replace(dst)
+      dst = self.class.new(dst)
+      dst.temp_path(dst.dirname) do |temp|
+        copy(temp)
+        dst.copy_metadata(temp)
+        temp.rename(dst.to_s)
+      end
+    end
+  end
+end

data/lib/image_optim/config.rb

@@ -22,7 +22,8 @@ class ImageOptim
 
     class << self
       # Read options at path: expand path (warn on failure), return {} if file
-      # does not exist, read yaml, check if it is a Hash, deep symbolise keys
+      # does not exist or is empty, read yaml, check if it is a Hash, deep
+      # symbolise keys
       def read_options(path)
         begin
           full_path = File.expand_path(path)
@@ -30,7 +31,7 @@ class ImageOptim
           warn "Can't expand path #{path}: #{e}"
           return {}
         end
-        return {} unless File.file?(full_path)
+        return {} unless File.size?(full_path)
         config = YAML.load_file(full_path)
         unless config.is_a?(Hash)
           fail "expected hash, got #{config.inspect}"
@@ -147,6 +148,15 @@ class ImageOptim
       !!get!(:allow_lossy)
     end
 
+    def cache_dir
+      dir = get!(:cache_dir)
+      dir unless dir.nil? || dir.empty?
+    end
+
+    def cache_worker_digests
+      !!get!(:cache_worker_digests)
+    end
+
     # Options for worker class by its `bin_sym`:
     # * `Hash` passed as is
     # * `{}` for `true` or `nil`

data/lib/image_optim/handler.rb

@@ -1,4 +1,4 @@
-require 'image_optim/image_path'
+require 'image_optim/path'
 
 class ImageOptim
   # Handles processing of original to result using upto two temp files

data/lib/image_optim/image_meta.rb

@@ -2,24 +2,19 @@ require 'image_size'
 
 class ImageOptim
   # Getting format of image at path or as data
-  class ImageMeta
-    def self.for_path(path)
+  module ImageMeta
+    def self.format_for_path(path)
       is = ImageSize.path(path)
-      new(is.format)
+      is.format if is
     rescue ImageSize::FormatError => e
       warn "#{e} (detecting format of image at #{path})"
     end
 
-    def self.for_data(data)
+    def self.format_for_data(data)
       is = ImageSize.new(data)
-      new(is.format)
+      is.format if is
     rescue ImageSize::FormatError => e
       warn "#{e} (detecting format of image data)"
     end
-
-    attr_reader :format
-    def initialize(format)
-      @format = format
-    end
   end
 end

data/lib/image_optim/optimized_path.rb

@@ -0,0 +1,25 @@
+require 'image_optim/path'
+
+class ImageOptim
+  # Holds optimized image with reference to original and its size
+  class OptimizedPath < DelegateClass(Path)
+    def initialize(path, original_or_size = nil)
+      path = Path.convert(path)
+      __setobj__(path)
+      if original_or_size.is_a?(Integer)
+        @original = path
+        @original_size = original_or_size
+      elsif original_or_size
+        @original = Path.convert(original_or_size)
+        @original_size = @original.size
+      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
+end

data/lib/image_optim/path.rb

@@ -0,0 +1,70 @@
+require 'fspath'
+require 'image_optim/image_meta'
+
+class ImageOptim
+  # FSPath with additional helpful methods
+  class Path < FSPath
+    NULL = if defined?(IO::NULL)
+      IO::NULL
+    else
+      %w[/dev/null NUL: NUL nul NIL: NL:].find{ |dev| File.exist?(dev) }
+    end
+
+    # Get temp path for this file with same extension
+    def temp_path(*args, &block)
+      ext = extname
+      self.class.temp_file_path([basename(ext).to_s, ext], *args, &block)
+    end
+
+    # Copy file to dst, optionally preserving attributes
+    #
+    # See FileUtils.copy_file
+    def copy(dst, preserve = false)
+      FileUtils.copy_file(self, dst, preserve)
+    end
+
+    # Move file to dst: rename on same device, copy and unlink original
+    # otherwise
+    #
+    # See FileUtils.mv
+    def move(dst)
+      FileUtils.move(self, dst)
+    end
+
+    # Copy metadata: uid, gid, mode, optionally atime and mtime
+    #
+    # Adapted from FileUtils::Entry_#copy_metadata by Minero Aoki
+    def copy_metadata(dst, time = false)
+      stat = lstat
+      dst.utime(stat.atime, stat.mtime) if time
+      begin
+        dst.chown(stat.uid, stat.gid)
+      rescue Errno::EPERM
+        dst.chmod(stat.mode & 0o1777)
+      else
+        dst.chmod(stat.mode)
+      end
+    end
+
+    # Atomic replace dst with self
+    def replace(dst)
+      dst = self.class.new(dst)
+      dst.temp_path(dst.dirname) do |temp|
+        move(temp)
+        dst.copy_metadata(temp)
+        temp.rename(dst.to_s)
+      end
+    end
+
+    # Get format using ImageSize
+    def image_format
+      ImageMeta.format_for_path(self)
+    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/runner/option_parser.rb

@@ -143,6 +143,19 @@ ImageOptim::Runner::OptionParser::DEFINE = proc do |op, options|
     options[:pack] = pack
   end
 
+  op.separator nil
+  op.separator '  Caching:'
+
+  op.on('--cache-dir DIR', 'Cache optimized images '\
+        'into the specified directory') do |cache_dir|
+    options[:cache_dir] = cache_dir
+  end
+
+  op.on('--cache-worker-digests', 'Cache worker digests '\
+        '(updating workers invalidates cache)') do |cache_worker_digests|
+    options[:cache_worker_digests] = cache_worker_digests
+  end
+
   op.separator nil
   op.separator '  Disabling workers:'
 

data/lib/image_optim/worker.rb

@@ -2,6 +2,7 @@
 
 require 'image_optim/cmd'
 require 'image_optim/configuration_error'
+require 'image_optim/path'
 require 'image_optim/worker/class_methods'
 require 'shellwords'
 require 'English'
@@ -17,16 +18,12 @@ class ImageOptim
       alias_method :init, :new
     end
 
-    # Allow lossy optimizations
-    attr_reader :allow_lossy
-
     # Configure (raises on extra options)
     def initialize(image_optim, options = {})
       unless image_optim.is_a?(ImageOptim)
         fail ArgumentError, 'first parameter should be an ImageOptim instance'
       end
       @image_optim = image_optim
-      @allow_lossy = !!options.delete(:allow_lossy)
       parse_options(options)
       assert_no_unknown_options!(options)
     end
@@ -81,8 +78,8 @@ class ImageOptim
 
     # Short inspect
     def inspect
-      options_string = options.map do |name, value|
-        " @#{name}=#{value.inspect}"
+      options_string = self.class.option_definitions.map do |option|
+        " @#{option.name}=#{send(option.name).inspect}"
       end.join(',')
       "#<#{self.class}#{options_string}>"
     end
@@ -143,14 +140,14 @@ class ImageOptim
         %W[
           env PATH=#{@image_optim.env_path.shellescape}
           nice -n #{@image_optim.nice}
-          #{cmd_args.shelljoin} > /dev/null 2>&1
+          #{cmd_args.shelljoin} > #{Path::NULL} 2>&1
         ].join(' ')
       else
         [
           {'PATH' => @image_optim.env_path},
           %W[nice -n #{@image_optim.nice}],
           cmd_args,
-          {:out => '/dev/null', :err => '/dev/null'},
+          {:out => Path::NULL, :err => Path::NULL},
         ].flatten
       end
       Cmd.run(*args)

data/lib/image_optim/worker/class_methods.rb

@@ -82,7 +82,9 @@ class ImageOptim
         klasses.map do |klass|
           options = options_proc[klass]
           next if options[:disable]
-          options = options.merge(:allow_lossy => image_optim.allow_lossy)
+          if !options.key?(:allow_lossy) && klass.method_defined?(:allow_lossy)
+            options[:allow_lossy] = image_optim.allow_lossy
+          end
           klass.init(image_optim, options)
         end.compact.flatten
       end

data/lib/image_optim/worker/jpegoptim.rb

@@ -5,6 +5,9 @@ class ImageOptim
   class Worker
     # http://www.kokkonen.net/tjko/projects.html
     class Jpegoptim < Worker
+      ALLOW_LOSSY_OPTION =
+      option(:allow_lossy, false, 'Allow limiting maximum quality'){ |v| !!v }
+
       STRIP_OPTION =
       option(:strip, :all, Array, 'List of extra markers to strip: '\
           '`:comments`, '\

data/lib/image_optim/worker/jpegrecompress.rb

@@ -5,6 +5,9 @@ class ImageOptim
   class Worker
     # https://github.com/danielgtaylor/jpeg-archive#jpeg-recompress
     class Jpegrecompress < Worker
+      ALLOW_LOSSY_OPTION =
+      option(:allow_lossy, false, 'Allow worker, it is always lossy'){ |v| !!v }
+
       # Initialize only if allow_lossy
       def self.init(image_optim, options = {})
         super if options[:allow_lossy]

data/lib/image_optim/worker/pngquant.rb

@@ -6,6 +6,9 @@ class ImageOptim
   class Worker
     # http://pngquant.org/
     class Pngquant < Worker
+      ALLOW_LOSSY_OPTION =
+      option(:allow_lossy, false, 'Allow quality option'){ |v| !!v }
+
       QUALITY_OPTION =
       option(:quality, '`100..100`, `0..100` in lossy mode',
              NonNegativeIntegerRange, 'min..max - don\'t '\

data/script/worker_analysis

@@ -80,7 +80,7 @@ Process.times.class.class_eval do
   end
 end
 
-ImageOptim::ImagePath.class_eval do
+ImageOptim::Path.class_eval do
   def shellescape
     to_s.shellescape
   end
@@ -192,7 +192,8 @@ class Analyser
       time = Process.times.sum - start
 
       dst_size = success ? dst.size : nil
-      cache = (success ? dst : src).digest.sub(/../, '\0/') + ".#{src.format}"
+      digest = (success ? dst : src).digest
+      cache = digest.sub(/../, '\0/') + ".#{src.image_format}"
       result = new(worker.id, success, time, src.size, dst_size, cache)
       if success
         path = result.path
@@ -209,7 +210,7 @@ class Analyser
     end
 
     def path
-      ImageOptim::ImagePath.convert("#{DIR}/worker-analysis/#{cache}")
+      ImageOptim::Path.convert("#{DIR}/worker-analysis/#{cache}")
     end
 
     def inspect
@@ -251,7 +252,7 @@ class Analyser
   # Run all possible worker chains
   class WorkerRunner
     def initialize(path, workers)
-      @path = ImageOptim::ImagePath.convert(path)
+      @path = ImageOptim::Path.convert(path)
       @workers = workers
     end
 
@@ -281,7 +282,7 @@ class Analyser
         worker_result, result_image = run_worker(src, worker)
 
         steps = (last_result ? last_result.steps : []) + [worker_result]
-        chain_result = ChainResult.new(src.format, steps)
+        chain_result = ChainResult.new(src.image_format, steps)
         chain_result.difference = difference_with(result_image)
 
         yield chain_result
@@ -337,7 +338,7 @@ class Analyser
 
     def flatten_animation(image)
       run_cache[:flatten][image.digest] ||= begin
-        if image.format == :gif
+        if image.image_format == :gif
           flattened = image.temp_path
           Cmd.run(*%W[
             convert
@@ -535,10 +536,10 @@ private
   end
 
   def process_paths(paths)
-    paths = paths.map{ |path| ImageOptim::ImagePath.convert(path) }
+    paths = paths.map{ |path| ImageOptim::Path.convert(path) }
     paths.select!{ |path| path.exist? || warn("#{path} doesn't exits") }
     paths.select!{ |path| path.file? || warn("#{path} is not a file") }
-    paths.select!{ |path| path.format || warn("#{path} is not an image") }
+    paths.select!{ |path| path.image_format || warn("#{path} is not an image") }
     paths.select! do |path|
       workers_for_image(path) || warn("#{path} can't be handled by any worker")
     end
@@ -546,7 +547,7 @@ private
   end
 
   def workers_for_image(path)
-    @workers_by_format[ImageOptim::ImagePath.convert(path).format]
+    @workers_by_format[ImageOptim::Path.convert(path).image_format]
   end
 
   def log_workers_by_format