image_optim 0.13.3 → 0.14.0

data/lib/image_optim/space.rb

@@ -0,0 +1,29 @@
+class ImageOptim
+  # Present size in readable form as fixed length string
+  module Space
+    SIZE_SYMBOLS = %w[B K M G T P E].freeze
+    BASE = 1024.0
+    PRECISION = 1
+    LENGTH = 4 + PRECISION + 1
+
+    EMPTY_SPACE = ' ' * LENGTH
+
+    def self.space(size)
+      case size
+      when 0, nil
+        EMPTY_SPACE
+      else
+        log_denominator = Math.log(size) / Math.log(BASE)
+        degree = [log_denominator.floor, SIZE_SYMBOLS.length - 1].min
+        number_string = if degree == 0
+          size.to_s
+        else
+          denominator = BASE**degree
+          number = size / denominator
+          format("%.#{PRECISION}f", number)
+        end
+        "#{number_string}#{SIZE_SYMBOLS[degree]}".rjust(LENGTH)
+      end
+    end
+  end
+end

data/lib/image_optim/true_false_nil.rb

@@ -1,3 +1,11 @@
 class ImageOptim
-  class TrueFalseNil; end
+  # Denote ternary value (`true`/`false`/`nil`) for worker option
+  class TrueFalseNil
+    # Add handling of ternary value in OptionParser instance, maps `nil` and
+    # `'nil'` to `nil`
+    def self.add_to_option_parser(option_parser)
+      completing = OptionParser.top.atype[TrueClass][0].merge('nil' => nil)
+      option_parser.accept(self, completing){ |_arg, val| val }
+    end
+  end
 end

data/lib/image_optim/worker.rb

@@ -3,8 +3,10 @@
 require 'image_optim/option_definition'
 require 'image_optim/option_helpers'
 require 'shellwords'
+require 'English'
 
 class ImageOptim
+  # Base class for all workers
   class Worker
     class << self
       # List of available workers
@@ -19,7 +21,10 @@ class ImageOptim
 
       # Underscored class name symbol
       def bin_sym
-        @underscored_name ||= name.split('::').last.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase.to_sym
+        @underscored_name ||= name.
+          split('::').last. # get last part
+          gsub(/([a-z])([A-Z])/, '\1_\2').downcase. # convert AbcDef to abc_def
+          to_sym
       end
 
       def option_definitions
@@ -28,7 +33,8 @@ class ImageOptim
 
       def option(name, default, type, description = nil, &proc)
         attr_reader name
-        option_definitions << OptionDefinition.new(name, default, type, description, &proc)
+        option_definitions <<
+            OptionDefinition.new(name, default, type, description, &proc)
       end
     end
 
@@ -36,7 +42,7 @@ class ImageOptim
     def initialize(image_optim, options = {})
       @image_optim = image_optim
       self.class.option_definitions.each do |option_definition|
-        value = if options.has_key?(option_definition.name)
+        value = if options.key?(option_definition.name)
           options[option_definition.name]
         else
           option_definition.default
@@ -50,14 +56,22 @@ class ImageOptim
       assert_no_unknown_options!(options)
     end
 
+    # Optimize image at src, output at dst, must be overriden in subclass
+    # return true on success
+    def optimize(_src, _dst)
+      fail NotImplementedError, "implement method optimize in #{self.class}"
+    end
+
     # List of formats which worker can optimize
     def image_formats
       format_from_name = self.class.name.downcase[/gif|jpeg|png|svg/]
-      raise "#{self.class}: can't guess applicable format from worker name" unless format_from_name
+      unless format_from_name
+        fail "#{self.class}: can't guess applicable format from worker name"
+      end
       [format_from_name.to_sym]
     end
 
-    # Ordering in list of workers
+    # Ordering in list of workers, 0 by default
     def run_order
       0
     end
@@ -75,10 +89,10 @@ class ImageOptim
 
     def assert_no_unknown_options!(options)
       known_keys = self.class.option_definitions.map(&:name)
-      unknown_options = options.reject{ |key, value| known_keys.include?(key) }
-      unless unknown_options.empty?
-        raise ConfigurationError, "unknown options #{unknown_options.inspect} for #{self}"
-      end
+      unknown_options = options.reject{ |key, _value| known_keys.include?(key) }
+      return if unknown_options.empty?
+      fail ConfigurationError, "unknown options #{unknown_options.inspect} "\
+          "for #{self}"
     end
 
     # Forward bin resolving to image_optim
@@ -94,7 +108,9 @@ class ImageOptim
 
       success = run_command(command)
 
-      $stderr << "#{success ? '✓' : '✗'} #{Time.now - start}s #{command}\n" if @image_optim.verbose?
+      if @image_optim.verbose
+        $stderr << "#{success ? '✓' : '✗'} #{Time.now - start}s #{command}\n"
+      end
 
       success
     end
@@ -106,13 +122,21 @@ class ImageOptim
       [bin, *arguments].map(&:to_s).shelljoin
     end
 
-    # Run command defining environment, setting nice level, removing output and reraising signal exception
+    # Run command defining environment, setting nice level, removing output and
+    # reraising signal exception
     def run_command(command)
-      success = system "env PATH=#{@image_optim.env_path.shellescape} nice -n #{@image_optim.nice} #{command} > /dev/null 2>&1"
-
-      if $?.signaled?
-        unless defined?(JRUBY_VERSION) && $?.exitstatus == $?.termsig # jruby does not differ non zero exit status and signal number
-          raise SignalException.new($?.termsig)
+      full_command = %W[
+        env PATH=#{@image_optim.env_path.shellescape}
+        nice -n #{@image_optim.nice}
+        #{command} > /dev/null 2>&1
+      ].join(' ')
+      success = system full_command
+
+      status = $CHILD_STATUS
+      if status.signaled?
+        # jruby does not differ non zero exit status and signal number
+        unless defined?(JRUBY_VERSION) && status.exitstatus == status.termsig
+          fail SignalException, status.termsig
         end
       end
 

data/lib/image_optim/worker/advpng.rb

@@ -3,8 +3,15 @@ require 'image_optim/option_helpers'
 
 class ImageOptim
   class Worker
+    # http://advancemame.sourceforge.net/doc-advpng.html
     class Advpng < Worker
-      option(:level, 4, 'Compression level: `0` - don\'t compress, `1` - fast, `2` - normal, `3` - extra, `4` - extreme') do |v|
+      LEVEL_OPTION =
+      option(:level, 4, 'Compression level: '\
+          '`0` - don\'t compress, '\
+          '`1` - fast, '\
+          '`2` - normal, '\
+          '`3` - extra, '\
+          '`4` - extreme') do |v|
         OptionHelpers.limit_with_range(v.to_i, 0..4)
       end
 

data/lib/image_optim/worker/gifsicle.rb

@@ -2,11 +2,23 @@ require 'image_optim/worker'
 
 class ImageOptim
   class Worker
+    # http://www.lcdf.org/gifsicle/
     class Gifsicle < Worker
+      INTERLACE_OPTION =
       option(:interlace, false, 'Turn interlacing on'){ |v| !!v }
 
       def optimize(src, dst)
-        args = %W[-o #{dst} -O3 --no-comments --no-names --same-delay --same-loopcount --no-warnings -- #{src}]
+        args = %W[
+          -o #{dst}
+          -O3
+          --no-comments
+          --no-names
+          --same-delay
+          --same-loopcount
+          --no-warnings
+          --
+          #{src}
+        ]
         args.unshift('-i') if interlace
         execute(:gifsicle, *args) && optimized?(src, dst)
       end

data/lib/image_optim/worker/jhead.rb

@@ -3,11 +3,16 @@ require 'exifr'
 
 class ImageOptim
   class Worker
+    # http://www.sentex.net/~mwandel/jhead/
+    #
+    # Jhead internally uses jpegtran which should be on path
     class Jhead < Worker
+      # Works on jpegs
       def image_formats
         [:jpeg]
       end
 
+      # Run first [-10]
       def run_order
         -10
       end

data/lib/image_optim/worker/jpegoptim.rb

@@ -3,18 +3,31 @@ require 'image_optim/option_helpers'
 
 class ImageOptim
   class Worker
+    # http://www.kokkonen.net/tjko/projects.html
     class Jpegoptim < Worker
-      option(:strip, :all, Array, 'List of extra markers to strip: `:comments`, `:exif`, `:iptc`, `:icc` or `:all`') do |v|
+      STRIP_OPTION =
+      option(:strip, :all, Array, 'List of extra markers to strip: '\
+          '`:comments`, '\
+          '`:exif`, '\
+          '`:iptc`, '\
+          '`:icc` or '\
+          '`:all`') do |v|
         values = Array(v).map(&:to_s)
         known_values = %w[all comments exif iptc icc]
         unknown_values = values - known_values
-        warn "Unknown markers for jpegoptim: #{unknown_values.join(', ')}" unless unknown_values.empty?
+        unless unknown_values.empty?
+          warn "Unknown markers for jpegoptim: #{unknown_values.join(', ')}"
+        end
         values & known_values
       end
 
-      option(:max_quality, 100, 'Maximum image quality factor `0`..`100`'){ |v| OptionHelpers.limit_with_range(v.to_i, 0..100) }
+      MAX_QUALITY_OPTION =
+      option(:max_quality, 100, 'Maximum image quality factor '\
+          '`0`..`100`') do |v|
+        OptionHelpers.limit_with_range(v.to_i, 0..100)
+      end
 
-      # Run first if max_quality < 100
+      # Run first [-1] if max_quality < 100 otherwise with normal priority
       def run_order
         max_quality < 100 ? -1 : 0
       end

data/lib/image_optim/worker/jpegtran.rb

@@ -2,12 +2,20 @@ require 'image_optim/worker'
 
 class ImageOptim
   class Worker
+    # http://www.ijg.org/
+    #
+    # Uses jpegtran through jpegrescan if enabled, jpegrescan is vendored with
+    # this gem
     class Jpegtran < Worker
+      COPY_CHUNKS_OPTION =
       option(:copy_chunks, false, 'Copy all chunks'){ |v| !!v }
 
+      PROGRESSIVE_OPTION =
       option(:progressive, true, 'Create progressive JPEG file'){ |v| !!v }
 
-      option(:jpegrescan, false, 'Use jpegtran through jpegrescan, ignore progressive option'){ |v| !!v }
+      JPEGRESCAN_OPTION =
+      option(:jpegrescan, false, 'Use jpegtran through jpegrescan, '\
+          'ignore progressive option'){ |v| !!v }
 
       def optimize(src, dst)
         if jpegrescan

data/lib/image_optim/worker/optipng.rb

@@ -4,10 +4,21 @@ require 'image_optim/true_false_nil'
 
 class ImageOptim
   class Worker
+    # http://optipng.sourceforge.net/
     class Optipng < Worker
-      option(:level, 6, 'Optimization level preset: `0` is least, `7` is best'){ |v| OptionHelpers.limit_with_range(v.to_i, 0..7) }
+      LEVEL_OPTION =
+      option(:level, 6, 'Optimization level preset: '\
+          '`0` is least, '\
+          '`7` is best') do |v|
+        OptionHelpers.limit_with_range(v.to_i, 0..7)
+      end
 
-      option(:interlace, false, TrueFalseNil, 'Interlace, `true` - interlace on, `false` - interlace off, `nil` - as is in original image') do |v|
+      INTERLACE_OPTION =
+      option(:interlace, false, TrueFalseNil, 'Interlace, '\
+          '`true` - interlace on, '\
+          '`false` - interlace off, '\
+          '`nil` - as is in original image') do |v|
+        # convert everything truthy to `true`, leave `false` and `nil` as is
         v && true
       end
 

data/lib/image_optim/worker/pngcrush.rb

@@ -2,15 +2,24 @@ require 'image_optim/worker'
 
 class ImageOptim
   class Worker
+    # http://pmt.sourceforge.net/pngcrush/
     class Pngcrush < Worker
-      option(:chunks, :alla, Array, 'List of chunks to remove or `:alla` - all except tRNS/transparency or '\
-                                '`:allb` - all except tRNS and gAMA/gamma'){ |v| Array(v).map(&:to_s) }
+      CHUNKS_OPTION =
+      option(:chunks, :alla, Array, 'List of chunks to remove or '\
+          '`:alla` - all except tRNS/transparency or '\
+          '`:allb` - all except tRNS and gAMA/gamma') do |v|
+        Array(v).map(&:to_s)
+      end
 
-      option(:fix, false, 'Fix otherwise fatal conditions such as bad CRCs'){ |v| !!v }
+      FIX_OPTION =
+      option(:fix, false, 'Fix otherwise fatal conditions '\
+          'such as bad CRCs'){ |v| !!v }
 
-      option(:brute, false, 'Brute force try all methods, very time-consuming and generally not worthwhile'){ |v| !!v }
+      BRUTE_OPTION =
+      option(:brute, false, 'Brute force try all methods, '\
+          'very time-consuming and generally not worthwhile'){ |v| !!v }
 
-      # Always run first
+      # Always run first [-1]
       def run_order
         -1
       end

data/lib/image_optim/worker/pngout.rb

@@ -3,14 +3,22 @@ require 'image_optim/option_helpers'
 
 class ImageOptim
   class Worker
+    # http://www.advsys.net/ken/util/pngout.htm
     class Pngout < Worker
+      COPY_CHUNKS_OPTION =
       option(:copy_chunks, false, 'Copy optional chunks'){ |v| !!v }
 
-      option(:strategy, 0, 'Strategy: `0` - xtreme, `1` - intense, `2` - longest Match, `3` - huffman Only, `4` - uncompressed') do |v|
+      STRATEGY_OPTION =
+      option(:strategy, 0, 'Strategy: '\
+          '`0` - xtreme, '\
+          '`1` - intense, '\
+          '`2` - longest Match, '\
+          '`3` - huffman Only, '\
+          '`4` - uncompressed') do |v|
         OptionHelpers.limit_with_range(v.to_i, 0..4)
       end
 
-      # Always run first
+      # Always run first [-1]
       def run_order
         -1
       end

data/lib/image_optim/worker/svgo.rb

@@ -2,6 +2,7 @@ require 'image_optim/worker'
 
 class ImageOptim
   class Worker
+    # https://github.com/svg/svgo
     class Svgo < Worker
       def optimize(src, dst)
         args = %W[-i #{src} -o #{dst}]

data/script/update_worker_options_in_readme

@@ -1,46 +1,61 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
-$:.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 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
-
-      md.puts END_MARKER
-
-      md.string.strip
+GENERATED_NOTE = '<!-- markdown for worker options is generated by '\
+    "`#{$PROGRAM_NAME}` -->"
+
+def write_worker_options(io, klass)
+  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 %W[
+        *
+        `:#{option_definition.name}`
+        — #{option_definition.description}
+        *(defaults to `#{option_definition.default.inspect}`)*
+      ].join(' ')
+    end
+  end
+  io.puts
+end
+
+def write_marked(io)
+  io.puts BEGIN_MARKER
+  io.puts GENERATED_NOTE
+  io.puts
+
+  ImageOptim::Worker.klasses.each do |klass|
+    write_worker_options(io, klass)
+  end
+
+  io.puts END_MARKER
+end
+
+def update_readme(text)
+  marked_reg = /#{Regexp.escape(BEGIN_MARKER)}.*#{Regexp.escape(END_MARKER)}/m
+  text.clone.sub!(marked_reg) do
+    StringIO.open do |io|
+      write_marked(io)
+
+      io.string.strip
     end
   end
 end
 
 readme = File.read(README_FILE)
-if readme = update_worker_options(readme)
+if (readme = update_readme(readme))
   File.open(README_FILE, 'w') do |f|
     f.write readme
   end
 else
-  abort "Did not update worker options"
+  abort 'Did not update worker options'
 end