smusher 0.3.8 → 0.4.2

data/README.markdown

@@ -1,42 +1,26 @@
-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
+*LOSSLESS* image size reduction for jpg, png and gif in the cloud
 
-Solution
-========
- - *LOSSLESS* size reduction (10-97% size reduction) in the cloud
- - optmizes all images(jpg+png+[gif]) from a given folder
+ - no image libraries needed, everything done in the interwebs
+ - less size (up 97% saving) = faster downloads = less bandwidth + happy users 
 
 Install
 =======
     install ruby + rubygems
-    sudo gem install httpclient smusher
+    sudo gem install smusher
 
 Usage
 =====
-Optimize a single image or a whole folder in the cloud.
-
-converting gif-s to png-s:
+Optimize a single image or a whole folder:
 
- - 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:
+Options:
     -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.
+    -c, --convert-gifs               convert gifs to PNGs
+    --service PunyPng                use PunyPng for image optimizing, instead of SmushIt
+    -v, --version                    display current version
 
 Example
 ======
@@ -52,14 +36,18 @@ Example
       reverted!
       ...
 
+Protection
+==========
+Any image that returns a failure code, is larger than before,
+or is empty will not be saved.
+
 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)
+ - only optimize 'new' images -> save time when doing on already optimized folder
 
-ALTERNATIVES
+JS + CSS
 ============
-If you want to lossless reduce images and minify css + js, try [reduce](http://github.com/grosser/reduce).
+reduce images and minify css + js -> try [reduce](http://github.com/grosser/reduce).
 
 Authors
 ======

data/Rakefile

@@ -1,10 +1,6 @@
-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
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color']}
 
 begin
   require 'jeweler'
@@ -16,16 +12,9 @@ begin
     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
+  Jeweler::GemcutterTasks.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

@@ -1 +1 @@
-0.3.8
+0.4.2

data/bin/smusher

@@ -1,35 +1,33 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'optparse'
+require 'smusher'
 
 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:
+Options:
 BANNER
   opts.on("-q", "--quiet","no output") { options[:quiet]=true }
+  opts.on("--service S", String, "use service: PunyPng or default SmushIt") {|x| options[:service]=x }
   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 }
+  opts.on("-h", "--help","Show this.") { puts opts; exit }
+  opts.on('-v', '--version','Show Version'){ puts Smusher::VERSION; exit}
 end.parse!
 
 path = ARGV.first
 if path.to_s.empty? or not File.exist?(path)
-  puts "Usage instructions: autotest --help"
+  puts "Usage instructions: smusher --help"
   exit
 end
 
-require 'smusher'
 if File.directory?(path)
   Smusher.optimize_images_in_folder(path,options)
 else

data/lib/smusher.rb

@@ -4,26 +4,34 @@ require 'json'
 require 'open-uri'
 require 'httpclient'
 
+require 'smusher/smush_it'
+require 'smusher/puny_png'
+
 module Smusher
   extend self
 
   MINIMUM_IMAGE_SIZE = 20#byte
 
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+
   # 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={})
+    service = options[:service] || 'SmushIt'
+    service = eval(service)
+
     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)
+        write_optimized_data(file, service)
         success = true
       end
 
-      if success
+      if success and service.converts_gif_to_png?
         gif = /\.gif$/
         `mv #{file} #{file.sub(gif,'.png')}` if file =~ gif
       end
@@ -31,30 +39,30 @@ module Smusher
   end
 
   # fetch all jpg/png images from  given folder and optimize them
-  def optimize_images_in_folder(folder,options={})
+  def optimize_images_in_folder(folder, options={})
     check_options(options)
-    images_in_folder(folder,options[:convert_gifs]).each do |file|
-      optimize_image(file)
+    images_in_folder(folder, options[:convert_gifs]).each do |file|
+      optimize_image(file, options)
     end
   end
 
-private
+  private
 
   def check_options(options)
-    known_options = [:convert_gifs,:quiet]
+    known_options = [:convert_gifs, :quiet, :service]
     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)
+  def write_optimized_data(file, service)
+    optimized = service.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}
+    File.open(file,'w') {|f| f.write optimized}
   end
 
   def sanitize_folder(folder)
@@ -86,19 +94,4 @@ private
       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
+end

data/lib/smusher/puny_png.rb

@@ -0,0 +1,17 @@
+module Smusher
+  class PunyPng
+    def self.converts_gif_to_png?
+      false
+    end
+
+    def self.optimized_image_data_for(file)
+      url = 'http://www.gracepointafterfive.com/punypng_staging/api/optimize'
+      response = HTTPClient.post url, { 'img' => File.new(file), 'key' => 'd1b72ab4813da6b69e1d6018303ac690c014599d'}
+      response = JSON.parse(response.body.content)
+      raise "puny_png: #{response['error']}" if response['error']
+      image_url = response['optimized_url']
+      raise "no optimized_url found" unless image_url
+      open(image_url) { |source| source.read() }
+    end
+  end
+end

data/lib/smusher/smush_it.rb

@@ -0,0 +1,22 @@
+module Smusher
+  class SmushIt
+    def self.converts_gif_to_png?
+      true
+    end
+
+    def self.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://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
+        url = 'http://ws1.adq.ac4.yahoo.com/ysmush.it/ws.php'
+      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
+end

data/smusher.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{smusher}
-  s.version = "0.3.8"
+  s.version = "0.4.2"
 
   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.date = %q{2009-11-22}
   s.default_executable = %q{smusher}
   s.email = %q{grosser.michael@gmail.com}
   s.executables = ["smusher"]
@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
      "VERSION",
      "bin/smusher",
      "lib/smusher.rb",
+     "lib/smusher/puny_png.rb",
+     "lib/smusher/smush_it.rb",
      "smusher.gemspec",
      "spec/empty/.gitignore",
      "spec/images/ad.gif",
@@ -35,19 +37,23 @@ Gem::Specification.new do |s|
      "spec/out/ad.gif",
      "spec/out/people.jpg",
      "spec/reduced/add.png",
+     "spec/reduced/add_puny.png",
      "spec/reduced/fam.png",
+     "spec/smusher/puny_png_spec.rb",
+     "spec/smusher/smush_it_spec.rb",
      "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"
+     "spec/smusher_spec.rb",
+     "spec/smusher/puny_png_spec.rb",
+     "spec/smusher/smush_it_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -69,3 +75,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<httpclient>, [">= 0"])
   end
 end
+

data/spec/smusher/puny_png_spec.rb

@@ -0,0 +1,12 @@
+require 'spec/spec_helper'
+
+describe Smusher::PunyPng do
+  describe :optimized_image_data_for do
+    it "loads the reduced image" do
+      original = File.join(ROOT,'images','add.png')
+      reduced = File.read(File.join(ROOT, 'reduced', 'add_puny.png'))
+      received = Smusher::PunyPng.optimized_image_data_for(original)
+      received.should == reduced
+    end
+  end
+end

data/spec/smusher/smush_it_spec.rb

@@ -0,0 +1,12 @@
+require 'spec/spec_helper'
+
+describe Smusher::SmushIt do
+  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::SmushIt.optimized_image_data_for(original)
+      received.should == reduced
+    end
+  end
+end

data/spec/smusher_spec.rb

@@ -1,5 +1,4 @@
-ROOT = File.expand_path(File.dirname(__FILE__))
-require File.join(ROOT,"spec_helper")
+require 'spec/spec_helper'
 
 describe :smusher do
   def copy(image_name)
@@ -28,6 +27,14 @@ describe :smusher do
       size.should < original_size
     end
 
+    it "does not append newline" do
+      copy 'add.png'
+      file = File.join(@out, 'add.png')
+      Smusher.optimize_image file
+      # pure File.read() will omit trailing \n
+      File.readlines(file).last.split('').last.should_not == "\n" 
+    end
+
     it "can be called with an array of files" do
       original_size = size
       Smusher.optimize_image([@file])
@@ -36,21 +43,21 @@ describe :smusher do
 
     it "it does nothing if size stayed the same" do
       original_size = size
-      Smusher.expects(:optimized_image_data_for).returns File.read(@file)
+      Smusher::SmushIt.should_receive(:optimized_image_data_for).and_return 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::SmushIt.should_receive(:optimized_image_data_for).and_return 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::SmushIt.should_receive(:optimized_image_data_for).and_return 'oops...'
       Smusher.optimize_image(@file)
       size.should == original_size
     end
@@ -62,7 +69,8 @@ describe :smusher do
         @file_png = File.join(@out,'logo.png')
       end
 
-      pending_it "converts gifs to png even if they have the same size" do
+      it "converts gifs to png even if they have the same size" do
+        pending
         copy 'ad.gif'
         file = File.join(@out,'ad.gif')
         original_size = size
@@ -77,7 +85,7 @@ describe :smusher do
       end
 
       it "does not rename gifs, if optimizing failed" do
-        Smusher.expects(:optimized_image_data_for).returns File.read(@file)
+        Smusher::SmushIt.should_receive(:optimized_image_data_for).and_return File.read(@file)
         Smusher.optimize_image(@file)
         File.exist?(@file).should == true
         File.exist?(@file_png).should == false
@@ -86,7 +94,7 @@ describe :smusher do
 
     describe 'options' do
       it "does not produce output when :quiet is given" do
-        $stdout.expects(:write).never
+        $stdout.should_receive(:write).never
         Smusher.optimize_image(@file,:quiet=>true)
       end
 
@@ -154,7 +162,7 @@ describe :smusher do
       Smusher.send(:size,@file).should == File.size(@file)
     end
 
-    it "returns 0 for missing file" do
+    it "and_return 0 for missing file" do
       Smusher.send(:size,File.join(ROOT,'xxxx','dssdfsddfs')).should == 0
     end
   end
@@ -167,12 +175,7 @@ describe :smusher do
     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
+  it "has a VERSION" do
+    Smusher::VERSION.should =~ /^\d+\.\d+\.\d+$/
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,19 +1,8 @@
 # ---- requirements
 require 'rubygems'
 require 'spec'
-require 'mocha'
-require 'lib/smusher'
 
+$LOAD_PATH << 'lib'
+require '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
+ROOT = File.expand_path(File.dirname(__FILE__))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smusher
 version: !ruby/object:Gem::Version 
-  version: 0.3.8
+  version: 0.4.2
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-05 00:00:00 +02:00
+date: 2009-11-22 00:00:00 +01:00
 default_executable: smusher
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,8 @@ files:
 - VERSION
 - bin/smusher
 - lib/smusher.rb
+- lib/smusher/puny_png.rb
+- lib/smusher/smush_it.rb
 - smusher.gemspec
 - spec/empty/.gitignore
 - spec/images/ad.gif
@@ -69,7 +71,10 @@ files:
 - spec/out/ad.gif
 - spec/out/people.jpg
 - spec/reduced/add.png
+- spec/reduced/add_puny.png
 - spec/reduced/fam.png
+- spec/smusher/puny_png_spec.rb
+- spec/smusher/smush_it_spec.rb
 - spec/smusher_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -95,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: smusher
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
@@ -103,3 +108,5 @@ summary: Automatic Lossless Reduction Of All Your Images
 test_files: 
 - spec/spec_helper.rb
 - spec/smusher_spec.rb
+- spec/smusher/puny_png_spec.rb
+- spec/smusher/smush_it_spec.rb