smusher 0.3.8

data/.gitignore

@@ -0,0 +1,2 @@
+Manifest
+pkg

data/README.markdown

@@ -0,0 +1,71 @@
+Problem
+=======
+ - Images are too large because they are not optimized
+ - Users & your bandwidth is wasted for useless metadata
+ - local image optimization requires tons of programs / libaries / knowledge
+
+Solution
+========
+ - *LOSSLESS* size reduction (10-97% size reduction) in the cloud
+ - optmizes all images(jpg+png+[gif]) from a given folder
+
+Install
+=======
+    install ruby + rubygems
+    sudo gem install httpclient smusher
+
+Usage
+=====
+Optimize a single image or a whole folder in the cloud.
+
+converting gif-s to png-s:
+
+ - called with a folder gif-s will not be converted
+ - called on a single .gif or wildcard, image(s) will be converted if optimizeable
+
+Usage:
+    smusher /apps/x/public/images [options]
+    smusher /apps/x/public/images/x.png [options]
+    smusher /apps/x/public/images/*.png [options]
+
+Options are:
+    -q, --quiet                      no output
+    -c, --convert-gifs               convert all .gif`s in the given folder
+
+
+Protection
+==========
+Any image that returns a failure code, is larger than before,
+or is empty will not be saved.
+
+Example
+======
+    smusher /apps/ts/public/images
+      smushing /apps/rs/public/images/social/facebook_icon.png
+      2887 -> 132                              = 4%
+
+      smushing /apps/rs/public/images/social/myspace_icon.png
+      3136 -> 282                              = 8%
+
+      smushing /apps/rs/public/images/dvd/dvd_1.png
+      5045 -> 4                                = 0%
+      reverted!
+      ...
+
+TODO
+====
+ - only optimize 'new' images -> save time when doing on each deploy
+ - convert gifs to png, even if the new size is the same, for consistency (atm only those which get smaller are converted)
+
+ALTERNATIVES
+============
+If you want to lossless reduce images and minify css + js, try [reduce](http://github.com/grosser/reduce).
+
+Authors
+======
+###Contributors
+ - [retr0h](http://geminstallthat.wordpress.com/)
+
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile

@@ -0,0 +1,31 @@
+desc "Run all specs in spec directory"
+task :default do |t|
+  require 'spec'
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+begin
+  require 'jeweler'
+  project_name = 'smusher'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Automatic Lossless Reduction Of All Your Images"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    %w[rake json httpclient].each{|d| gem.add_dependency d}
+    gem.rubyforge_project = 'smusher'
+  end
+
+  # fake task so that rubyforge:release works
+  task :rdoc do
+    `mkdir rdoc`
+    `echo documentation is at http://github.com/grosser/#{project_name} > rdoc/README.rdoc`
+  end
+
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.8

data/bin/smusher

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Optimize a single image or a whole folder in the cloud.
+
+gif`s:
+ - called with a folder gif`s will not be optimized
+ - called on a singe .gif, it will be optimized if it is optimizeable
+
+Usage:
+    smusher /apps/x/public/images [options]
+    smusher /apps/x/public/images/x.png [options]
+    smusher /apps/x/public/images/*.png [options]
+
+Options are:
+BANNER
+  opts.on("-q", "--quiet","no output") { options[:quiet]=true }
+  opts.on("-c", "--convert-gifs","convert all .gif`s in the given folder") { options[:convert_gifs]=true }
+  opts.on("-h", "--help","Show this.") { puts opts;exit }
+end.parse!
+
+path = ARGV.first
+if path.to_s.empty? or not File.exist?(path)
+  puts "Usage instructions: autotest --help"
+  exit
+end
+
+require 'smusher'
+if File.directory?(path)
+  Smusher.optimize_images_in_folder(path,options)
+else
+  Smusher.optimize_image(ARGV,options)
+end

data/lib/smusher.rb

@@ -0,0 +1,104 @@
+require 'rubygems'
+require 'rake'
+require 'json'
+require 'open-uri'
+require 'httpclient'
+
+module Smusher
+  extend self
+
+  MINIMUM_IMAGE_SIZE = 20#byte
+
+  # optimize the given image
+  # converts gif to png, if size is lower
+  # can be called with a file-path or an array of files-paths
+  def optimize_image(files,options={})
+    files.each do |file|
+      check_options(options)
+      puts "THIS FILE IS EMPTY!!! #{file}" and return if size(file).zero?
+      success = false
+
+      with_logging(file,options[:quiet]) do
+        write_optimized_data(file)
+        success = true
+      end
+
+      if success
+        gif = /\.gif$/
+        `mv #{file} #{file.sub(gif,'.png')}` if file =~ gif
+      end
+    end
+  end
+
+  # fetch all jpg/png images from  given folder and optimize them
+  def optimize_images_in_folder(folder,options={})
+    check_options(options)
+    images_in_folder(folder,options[:convert_gifs]).each do |file|
+      optimize_image(file)
+    end
+  end
+
+private
+
+  def check_options(options)
+    known_options = [:convert_gifs,:quiet]
+    if options.detect{|k,v| not known_options.include?(k)}
+      raise "Known options: #{known_options*' '}"
+    end
+  end
+
+  def write_optimized_data(file)
+    optimized = optimized_image_data_for(file)
+
+    raise "Error: got larger" if size(file) < optimized.size
+    raise "Error: empty file downloaded" if optimized.size < MINIMUM_IMAGE_SIZE
+    raise "cannot be optimized further" if size(file) == optimized.size
+
+    File.open(file,'w') {|f| f.puts optimized}
+  end
+
+  def sanitize_folder(folder)
+    folder.sub(%r[/$],'')#remove tailing slash
+  end
+
+  def images_in_folder(folder,with_gifs=false)
+    folder = sanitize_folder(folder)
+    images = %w[png jpg jpeg JPG]
+    images << 'gif' if with_gifs
+    images.map! {|ext| "#{folder}/**/*.#{ext}"}
+    FileList[*images]
+  end
+
+  def size(file)
+    File.exist?(file) ? File.size(file) : 0
+  end
+
+  def with_logging(file,quiet)
+    puts "smushing #{file}" unless quiet
+
+    before = size(file)
+    begin; yield; rescue; puts $! unless quiet; end
+    after = size(file)
+
+    unless quiet
+      result = "#{(100*after)/before}%"
+      puts "#{before} -> #{after}".ljust(40) + " = #{result}"
+      puts ''
+    end
+  end
+
+  def optimized_image_data_for(file)
+    #I leave these urls here, just in case it stops working again...
+#    url = "http://smush.it/ws.php" # original, redirects to somewhere else..
+    url = 'http://ws1.adq.ac4.yahoo.com/ysmush.it/ws.php'
+#    url = "http://developer.yahoo.com/yslow/smushit/ws.php" # official but does not work
+#    url = "http://smushit.com/ysmush.it/ws.php" # used at the new page but does not hande uploads
+#    url = "http://smushit.eperf.vip.ac4.yahoo.com/ysmush.it/ws.php" # used at the new page but does not hande uploads
+    response = HTTPClient.post url, { 'files[]' => File.new(file) }
+    response = JSON.parse(response.body.content)
+    raise "smush.it: #{response['error']}" if response['error']
+    image_url = response['dest']
+    raise "no dest path found" unless image_url
+    open(image_url) { |source| source.read() }
+  end
+end

data/smusher.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{smusher}
+  s.version = "0.3.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-10-05}
+  s.default_executable = %q{smusher}
+  s.email = %q{grosser.michael@gmail.com}
+  s.executables = ["smusher"]
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "bin/smusher",
+     "lib/smusher.rb",
+     "smusher.gemspec",
+     "spec/empty/.gitignore",
+     "spec/images/ad.gif",
+     "spec/images/add.png",
+     "spec/images/drink_empty.png",
+     "spec/images/logo.gif",
+     "spec/images/people.jpg",
+     "spec/images/water.JPG",
+     "spec/images/woman.jpeg",
+     "spec/out/ad.gif",
+     "spec/out/people.jpg",
+     "spec/reduced/add.png",
+     "spec/reduced/fam.png",
+     "spec/smusher_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/smusher}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{smusher}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Automatic Lossless Reduction Of All Your Images}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/smusher_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<httpclient>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<httpclient>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<httpclient>, [">= 0"])
+  end
+end

data/spec/smusher_spec.rb

@@ -0,0 +1,178 @@
+ROOT = File.expand_path(File.dirname(__FILE__))
+require File.join(ROOT,"spec_helper")
+
+describe :smusher do
+  def copy(image_name)
+    FileUtils.cp(File.join(ROOT,'images',image_name), @out)
+  end
+
+  def size
+    File.size(@file)
+  end
+
+  before do
+    #prepare output folder
+    @out = File.join(ROOT,'out')
+    FileUtils.rm_r @out, :force=>true
+    FileUtils.mkdir @out
+    copy 'people.jpg'
+    copy 'ad.gif'
+
+    @file = File.join(@out,'people.jpg')
+  end
+
+  describe :optimize_image do
+    it "stores the image in an reduced size" do
+      original_size = size
+      Smusher.optimize_image(@file)
+      size.should < original_size
+    end
+
+    it "can be called with an array of files" do
+      original_size = size
+      Smusher.optimize_image([@file])
+      size.should < original_size
+    end
+
+    it "it does nothing if size stayed the same" do
+      original_size = size
+      Smusher.expects(:optimized_image_data_for).returns File.read(@file)
+      Smusher.optimize_image(@file)
+      size.should == original_size
+    end
+
+    it "does not save images whoes size got larger" do
+      original_size = size
+      Smusher.expects(:optimized_image_data_for).returns File.read(@file)*2
+      Smusher.optimize_image(@file)
+      size.should == original_size
+    end
+
+    it "does not save images if their size is error-sugesting-small" do
+      original_size = size
+      Smusher.expects(:optimized_image_data_for).returns 'oops...'
+      Smusher.optimize_image(@file)
+      size.should == original_size
+    end
+
+    describe "gif handling" do
+      before do
+        copy 'logo.gif'
+        @file = File.join(@out,'logo.gif')
+        @file_png = File.join(@out,'logo.png')
+      end
+
+      pending_it "converts gifs to png even if they have the same size" do
+        copy 'ad.gif'
+        file = File.join(@out,'ad.gif')
+        original_size = size
+        Smusher.optimize_image(file)
+        File.size(File.join(@out,'ad.png')).should == original_size
+      end
+
+      it "stores converted .gifs in .png files" do
+        Smusher.optimize_image(@file)
+        File.exist?(@file).should == false
+        File.exist?(@file_png).should == true
+      end
+
+      it "does not rename gifs, if optimizing failed" do
+        Smusher.expects(:optimized_image_data_for).returns File.read(@file)
+        Smusher.optimize_image(@file)
+        File.exist?(@file).should == true
+        File.exist?(@file_png).should == false
+      end
+    end
+
+    describe 'options' do
+      it "does not produce output when :quiet is given" do
+        $stdout.expects(:write).never
+        Smusher.optimize_image(@file,:quiet=>true)
+      end
+
+      it "raises when an unknown option was given" do
+        lambda{Smusher.optimize_image(@file,:q=>true)}.should raise_error
+      end
+    end
+  end
+
+  describe :optimize_images_in_folder do
+    before do
+      FileUtils.rm @file
+      @files = []
+      %w[add.png drink_empty.png].each do |image_name|
+        copy image_name
+        @files << File.join(@out,image_name)
+      end
+      @before = @files.map {|f|File.size(f)}
+    end
+
+    it "optimizes all images" do
+      Smusher.optimize_images_in_folder(@out)
+      new_sizes = @files.map {|f|File.size(f)}
+      new_sizes.size.times {|i| new_sizes[i].should < @before[i]}
+    end
+
+    it "does not convert gifs" do
+      copy 'logo.gif'
+      Smusher.optimize_images_in_folder(@out)
+      File.exist?(File.join(@out,'logo.png')).should == false
+    end
+
+    it "converts gifs to png when option was given" do
+      copy 'logo.gif'
+      Smusher.optimize_images_in_folder(@out,:convert_gifs=>true)
+      File.exist?(File.join(@out,'logo.png')).should == true
+    end
+  end
+
+  describe :sanitize_folder do
+    it "cleans a folders trailing slash" do
+      Smusher.send(:sanitize_folder,"xx/").should == 'xx'
+    end
+
+    it "does not clean if there is no trailing slash" do
+      Smusher.send(:sanitize_folder,"/x/ccx").should == '/x/ccx'
+    end
+  end
+
+  describe :images_in_folder do
+    it "finds all non-gif images" do
+      folder = File.join(ROOT,'images')
+      all = %w[add.png drink_empty.png people.jpg water.JPG woman.jpeg].map{|name|"#{folder}/#{name}"}
+      result = Smusher.send(:images_in_folder,folder)
+      (all+result).uniq.size.should == all.size
+    end
+
+    it "finds nothing if folder is empty" do
+      Smusher.send(:images_in_folder,File.join(ROOT,'empty')).should == []
+    end
+  end
+
+  describe :size do
+    it "find the size of a file" do
+      Smusher.send(:size,@file).should == File.size(@file)
+    end
+
+    it "returns 0 for missing file" do
+      Smusher.send(:size,File.join(ROOT,'xxxx','dssdfsddfs')).should == 0
+    end
+  end
+
+  describe :logging do
+    it "yields" do
+      val = 0
+      Smusher.send(:with_logging,@file,false) {val = 1}
+      val.should == 1
+    end
+  end
+
+  describe :optimized_image_data_for do
+    it "loads the reduced image" do
+      original = File.join(ROOT,'images','add.png')
+      reduced = File.open(File.join(ROOT,'reduced','add.png')).read
+      received = (Smusher.send(:optimized_image_data_for,original))
+      received.should == reduced
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+require 'mocha'
+require 'lib/smusher'
+
+
+# ---- rspec
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+
+# ---- Helpers
+def pending_it(text,&block)
+  it text do
+    pending(&block)
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: smusher
+version: !ruby/object:Gem::Version 
+  version: 0.3.8
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +02:00
+default_executable: smusher
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: grosser.michael@gmail.com
+executables: 
+- smusher
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- VERSION
+- bin/smusher
+- lib/smusher.rb
+- smusher.gemspec
+- spec/empty/.gitignore
+- spec/images/ad.gif
+- spec/images/add.png
+- spec/images/drink_empty.png
+- spec/images/logo.gif
+- spec/images/people.jpg
+- spec/images/water.JPG
+- spec/images/woman.jpeg
+- spec/out/ad.gif
+- spec/out/people.jpg
+- spec/reduced/add.png
+- spec/reduced/fam.png
+- spec/smusher_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/smusher
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: smusher
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Automatic Lossless Reduction Of All Your Images
+test_files: 
+- spec/spec_helper.rb
+- spec/smusher_spec.rb