rarity 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spike.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Harrison
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Rarity - a recursive image optimiser
+
+If you understand why you need this there's something wrong with you or you have very strange needs.
+
+This is a tool built for a friend to recursively optimise a directory of images, keeping track of progress to support partial runs and update runs, using optipng, jpegoptim and gifsicle.
+
+## Dependencies
+
+Rarity makes use of:
+
+* optipng
+* jpegoptim
+* gifsicle
+
+You will need to install these prior to running rarity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rarity'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rarity
+
+## Usage
+
+Basic usage:
+
+    rarity optim -d some/path
+
+Spike will then optimise everything under that directory.
+
+You can find more help with:
+
+    rarity -h
+    rarity optim -h
+    rarity tracker -h
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/rarity

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'trollop'
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rarity'
+
+SUB_COMMANDS = %w(optim tracker)
+global_opts = Trollop::options do
+  version "Rarity #{Rarity::VERSION} (c) James Harrison"
+  banner <<-EOS
+Rarity recursively walks a directory and optimises all the images contained therein.
+
+Usage:
+       rarity optim -h
+       rarity tracker -h
+
+Global options:
+EOS
+  stop_on SUB_COMMANDS
+end
+
+cmd = ARGV.shift # get the subcommand
+cmd_opts = case cmd
+  when "optim"
+    Trollop::options do
+      opt :pnglevel, "The argument to -o to use for pngcrush", :default => 3
+      opt :directory, "The top level of the directory tree to optimise", :type => String
+    end
+  when "tracker"  # parse copy options
+    Trollop::options do
+      opt :reset, "Reset the tracker database"
+      opt :import, "Run an import from an old flat-file DB"
+    end
+  else
+    Trollop::die "unknown subcommand #{cmd.inspect}"
+  end
+#puts "Subcommand options: #{cmd_opts.inspect}"
+
+if cmd == "optim"
+  r = Rarity::Runner.new(cmd_opts)
+  r.run
+elsif cmd == "tracker"
+  if cmd_opts[:reset]
+    t = Rarity::Tracker.new
+    t.reset
+  elsif cmd_opts[:import]
+    t = Rarity::Tracker.new
+    t.import_from_old_format
+  else
+    puts "I'm afraid you'll have to provide an option."
+  end
+end

data/lib/rarity/optimiser.rb

@@ -0,0 +1,80 @@
+class Rarity::Optimiser
+  def initialize(tracker, options)
+    @tracker = tracker
+    @options = options
+  end
+  # Optimises a single image
+  def optimise_image(path)
+    # Tweak commands here if you want to. Defaults are needlessly overzealous and will take ages, especially PNG.
+    png_cmd = "optipng -i0 -fix -o#{@options[:png_o_level]} -preserve"
+    gif_cmd = "gifsicle -O3"
+    jpg_cmd = "jpegoptim --max=95 -p"
+    start = Time.now
+    start_size = File.size(path)
+    if @tracker.is_done?(path, @options)
+      puts "Skipping image at #{path}, already done"
+    else
+      puts "Optimising image at #{path}, start filesize #{Rarity::to_human start_size}"
+      # let's figure out what we've got
+      ext = File.extname(path).downcase
+      type = :unknown
+      if ext == ".png"
+        `#{png_cmd} "#{path}"`
+        type = :png
+        @tracker.mark_done(path, @options)
+      elsif ext == ".gif"
+        type = :gif
+        # ooh, okay, so if we're a gif, are we animated?
+        eto = `exiftool "#{path}"`
+        et = eto.split("\n")
+        fc = et.detect{|l|l.include?("Frame Count")}
+        if fc
+          if (fc.split(":")[1].to_i rescue 1) > 0
+            # We have more than one frame! We're animated or strange. gifsicle.
+            `#{gif_cmd} "#{path}"`
+            @tracker.mark_done(path, @options)
+          else
+            # We're single frame, PNG probably does better
+            opo = `#{png_cmd} "#{path}"`
+            pngpath = path.gsub(File.extname(path),".png")
+            if File.size(path) > File.size(pngpath)
+              # We're done! Nuke the old file
+              File.delete(path)
+              # Changed format, so update path
+              path = pngpath
+              @tracker.mark_done(path, @options)
+            else
+              # Clean up the PNG we tried and gifsicle it.
+              File.delete(path.gsub(File.extname(path),".png"))
+              `#{gif_cmd} "#{path}"`
+              @tracker.mark_done(path, @options)
+            end
+          end
+        else
+          # If we have no frame count data, assume not animated
+          opo = `#{png_cmd} "#{path}"`
+          pngpath = path.gsub(File.extname(path),".png")
+          if File.size(path) > File.size(pngpath)
+            # We're done! Nuke the old file
+            File.delete(path)
+            # Changed format, so update path
+            path = pngpath
+            @tracker.mark_done(path, @options)
+          else
+            # Clean up the PNG we tried and gifsicle it.
+            File.delete(path.gsub(File.extname(path),".png"))
+            `#{gif_cmd} "#{path}"`
+            @tracker.mark_done(path, @options)
+          end
+        end
+      elsif ext == ".jpg" or ext == ".jpeg"
+        type = :jpg
+        `#{jpg_cmd} "#{path}"`
+        @tracker.mark_done(path, @options)
+      else
+        puts "Skipped file, not a recognised file type"
+      end
+    end
+    return {:before=>start_size, :after=>File.size(path), :type=>type, :time=>(Time.now-start)}
+  end
+end

data/lib/rarity/runner.rb

@@ -0,0 +1,74 @@
+class Rarity::Runner
+  def initialize(options)
+    @directory = options[:directory]
+    @tracker = Rarity::Tracker.new
+    @optimiser = Rarity::Optimiser.new(@tracker, {:png_o_level => options[:pnglevel]})
+  end
+  def run
+    recursively_optimise(@directory)
+  end
+  # Recursively optimises a given path
+  def recursively_optimise(path,depth=0)
+    raise ArgumentError, "Argument must be a directory" unless File.directory?(path)
+    puts "Called with #{path}"
+    total_before = 0
+    total_after = 0
+    total_before_types = {}
+    total_after_types = {}
+    total_time_types = {}
+    begin
+      # Call ourself on any directories in this path
+      Dir.foreach(path) do |entry|
+        next if entry == "."
+        next if entry == ".."
+        fullpath = File.join(path, entry)
+        if File.directory?(fullpath)
+          res = self.recursively_optimise(fullpath, (depth+1))
+          total_before += res[:before]
+          total_after += res[:after]
+          #if res[:before_types] and res[:after_types]
+            res[:before_types].each_pair do |k,v|
+              total_before_types[k] = 0 unless total_before_types[k]
+              total_before_types[k] += v
+            end
+            res[:after_types].each_pair do |k,v|
+              total_after_types[k] = 0 unless total_after_types[k]
+              total_after_types[k] += v
+            end
+            res[:time_types].each_pair do |k,v|
+              total_time_types[k] = 0 unless total_time_types[k]
+              total_time_types[k] += v
+            end
+          #end
+        else
+          res = @optimiser.optimise_image(fullpath)
+          total_before += res[:before]
+          total_after += res[:after]
+          total_before_types[res[:type]] = 0 unless total_before_types[res[:type]]
+          total_before_types[res[:type]] += res[:before]
+          total_after_types[res[:type]] = 0 unless total_after_types[res[:type]]
+          total_after_types[res[:type]] += res[:after]
+          total_time_types[res[:type]] = 0 unless total_time_types[res[:type]]
+          total_time_types[res[:type]] += res[:time]
+        end
+      end
+    rescue Exception => e
+      puts "Got exception #{e.inspect} while processing!"
+      puts e.backtrace
+    end
+    if depth == 0
+      puts "\n\nDone optimising everything!"
+      puts "I started with a total size of #{Rarity::to_human total_before}"
+      puts "I finished with a total size of #{Rarity::to_human total_after}, a reduction of #{Rarity::to_human (total_before-total_after).abs}"
+
+      puts"\nType breakdowns:"
+      total_before_types.each_pair do |k,v|
+        a = total_after_types[k]
+        t =  total_time_types[k]
+        puts "#{k.to_s.upcase}: #{Rarity::to_human v} before, #{Rarity::to_human a} after, reduction of #{Rarity::to_human (v-a).abs} or #{Rarity::to_human (((v-a).abs)/t.abs)} per second saved"
+      end
+    end
+    return {:before => total_before, :after => total_after, :before_types => total_before_types, :after_types => total_after_types, :time_types => total_time_types}
+  end
+  
+end

data/lib/rarity/tracker.rb

@@ -0,0 +1,46 @@
+require 'sequel'
+class Rarity::Tracker
+
+  def initialize
+    @db_path = File.expand_path("~/.spike.sqlite")
+    @first_run = !File.exists?(@db_path)
+    @db = Sequel.sqlite(@db_path)
+    if @first_run
+      @db.create_table :images do
+        primary_key :id
+        String :path
+        Integer :png_o_level
+      end
+    end
+  end
+  def import_from_old_format
+    @path = File.expand_path("~/.optimdone.dat")
+    @done = []
+    File.open(@path,'r'){|f|@done = f.read.split("\n")} rescue nil
+    for r in @done
+      @db[:images].insert(:path=>r, :png_o_level=>3)
+    end
+    puts "Imported #{@done.size} entries that we have already optimised from the old land, you can now delete ~/.optimdone.dat"
+  end
+  def mark_done(path, options)
+    cleanpath = path.gsub("\n","").gsub("\r","").chomp
+    if !is_done?(path, options)
+      if @db[:images][:path=>cleanpath]
+        @db[:images][:path=>cleanpath] = {:png_o_level => options[:png_o_level]}
+      else
+        @db[:images].insert(:path=>cleanpath, :png_o_level=>options[:png_o_level])
+      end
+    end
+  end
+  def is_done?(path, options)
+    cleanpath = path.gsub("\n","").gsub("\r","").chomp
+    if @db[:images].select(:id, :png_o_level).where(:path=>cleanpath).filter('png_o_level >= ?',options[:png_o_level]).count > 0
+      return true
+    end
+    return false
+  end
+  def reset
+    @db[:images].delete
+  end
+
+end

data/lib/rarity/version.rb

@@ -0,0 +1,3 @@
+module Rarity
+  VERSION = "0.1.0"
+end

data/lib/rarity.rb

@@ -0,0 +1,17 @@
+require "rarity/version"
+
+module Rarity
+  def self.to_human(number)
+    units = %w{B KB MB GB TB}
+    if number > 0
+      e = (Math.log(number)/Math.log(1024)).floor
+      s = "%.3f" % (number.to_f / 1024**e)
+      return s.sub(/\.?0*$/, units[e])
+    else
+      return "0 B"
+    end
+  end
+end
+require "rarity/tracker"
+require "rarity/optimiser"
+require "rarity/runner"

data/rarity.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rarity/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["James Harrison"]
+  gem.email         = ["james@talkunafraid.co.uk"]
+  gem.description   = %q{A tool for recursively optimising directories of images}
+  gem.summary       = %q{This tool uses optipng, jpegoptim and gifsicle to optimise image file sizes for a directory tree.}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rarity"
+  gem.require_paths = ["lib"]
+  gem.version       = Rarity::VERSION
+  gem.add_dependency("sqlite3", ">= 1.3.6")
+  gem.add_dependency("sequel", ">= 3.36.0")
+  gem.add_dependency("trollop", ">= 1.16.2")
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: rarity
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 6
+        version: 1.3.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 36
+        - 0
+        version: 3.36.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id003
+description: A tool for recursively optimising directories of images
+email: 
+- james@talkunafraid.co.uk
+executables: 
+- rarity
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rarity
+- lib/rarity.rb
+- lib/rarity/optimiser.rb
+- lib/rarity/runner.rb
+- lib/rarity/tracker.rb
+- lib/rarity/version.rb
+- rarity.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This tool uses optipng, jpegoptim and gifsicle to optimise image file sizes for a directory tree.
+test_files: []
+