grosser-smusher 0.3.2 → 0.3.3

data/README.markdown

@@ -7,7 +7,7 @@ Problem
 Solution
 ========
  - *LOSSLESS* size reduction (10-97% size reduction) in the cloud
- - optmizes all images(jpg+png) from a given folder
+ - optmizes all images(jpg+png+[gif]) from a given folder
 
 Install
 =======
@@ -16,15 +16,25 @@ Install
 
 Usage
 =====
-    smusher /apps/x/public/images # optimize all jpg/png images, NOT gifs
-    smusher /apps/x/public/images/x.png # optimize a single image
-    smusher /apps/x/public/images/x.gif # !!optimize to smaller png, rename it yourself!!
+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 singe .gif, it will be converted if it is optimizeable
+
+Usage:
+    smusher /apps/x/public/images [options]
+    smusher /apps/x/public/images/x.png [options]
+
+Options are:
+    -q, --quiet                      no output
+    -c, --convert-gifs               convert all .gif`s in the given folder
+
 
 Protection
 ==========
-Smusher makes .backup copies of any image before optimizing.  
 Any image that returns a failure code, is larger than before,  
-or is empty will be reverted.
+or is empty will not be saved.
 
 Example
 ======
@@ -42,8 +52,9 @@ Example
 
 TODO
 ====
- - use rest-client rather than curl
- - windows support?
+ - only optimize 'new' images -> save time when doing on each deploy
+ - use ruby library rather than curl
+ - support `smusher images/*.png` ?
 
 Author
 ======

data/Rakefile

@@ -9,7 +9,7 @@ end
 #Gemspec
 require 'echoe'
 project_name = 'smusher'
-Echoe.new(project_name , '0.3.2') do |p|
+Echoe.new(project_name , '0.3.3') do |p|
   p.description    = "Automatic Lossless Reduction Of All Your Images"
   p.url            = "http://github.com/grosser/#{project_name}"
   p.author         = "Michael Grosser"

data/bin/smusher

@@ -1,16 +1,32 @@
 #!/usr/bin/env ruby
 require 'rubygems'
+require 'optparse'
 require 'smusher'
 
-path = ARGV[0]
-if ARGV.length != 1 or not File.exist?(path)
-  puts "smusher DIRECTORY_OR_FILE_TO_OPTIMIZE"
-  puts "smusher /apps/x/public/images"
-  exit
+options = {}
+path = ARGV.shift
+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]
+
+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.parse!(ARGV)
+  puts opts if path.to_s.empty? or not File.exist?(path)
 end
 
 if File.directory?(path)
-  Smusher.optimize_images_in_folder(path)
+  Smusher.optimize_images_in_folder(path,options)
 else
-  Smusher.optimize_image(path)
+  Smusher.optimize_image(path,options)
 end

data/lib/smusher.rb

@@ -5,76 +5,81 @@ require 'json'
 module Smusher
   extend self
 
-  # optimize the given image !!coverts gif to png!!
-  def optimize_image(file)
-    if empty?(file)
-      puts "THIS FILE IS EMPTY!!! #{file}"
-      return
+  MINIMUM_IMAGE_SIZE = 20#byte
+
+  # optimize the given image
+  # converts gif to png, if size is lower
+  def optimize_image(file,options={})
+    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
-    with_protection(file) do
-      with_logging(file) do
-        write_optimized_data(file)
-      end
+
+    if success
+      gif = /\.gif$/
+      `mv #{file} #{file.sub(gif,'.png')}` if file =~ gif
     end
   end
 
   # fetch all jpg/png images from  given folder and optimize them
-  def optimize_images_in_folder(folder)
-    images_in_folder(folder).each do |file|
+  def optimize_images_in_folder(folder,options={})
+    check_options(options)
+    images_in_folder(folder,options[:convert_gifs]).each do |file|
       optimize_image(file)
-      puts ''
     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)
-    data = optimized_image_data_for(file)
-    File.open(file,'w') {|f| f.puts data} unless data.nil?
+    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)
+  def images_in_folder(folder,with_gifs=false)
     folder = sanitize_folder(folder)
-    images = %w[png jpg jpeg JPG].map {|ext| "#{folder}/**/*.#{ext}"}
+    images = %w[png jpg jpeg JPG]
+    images << 'gif' if with_gifs
+    images.map! {|ext| "#{folder}/**/*.#{ext}"}
     FileList[*images]
   end
   
-  def with_protection(file)
-    backup = "#{file}.backup"
-    FileUtils.cp(file,backup)
-
-    before = size(file)
-    yield
-
-    if empty?(file) or size(file) >= before
-      FileUtils.mv(backup,file,:force=>true)#revert
-      puts "reverted!"
-    else
-      FileUtils.rm(backup)
-    end
-  end
-  
   def size(file)
     File.exist?(file) ? File.size(file) : 0
   end
 
-  def empty?(file)
-    size(file) <= 4 #empty file = 4kb
-  end
-
-  def with_logging(file)
-    puts "smushing #{file}"
+  def with_logging(file,quiet)
+    puts "smushing #{file}" unless quiet
     
     before = size(file)
-    begin; yield; rescue; puts $!; end
+    begin; yield; rescue; puts $! unless quiet; end
     after = size(file)
     
-    result = "#{(100*after)/before}%"
-    puts "#{before} -> #{after}".ljust(40) + " = #{result}"
+    unless quiet
+      result = "#{(100*after)/before}%"
+      puts "#{before} -> #{after}".ljust(40) + " = #{result}"
+      puts ''
+    end
   end
 
   def optimized_image_data_for(file)

data/smusher.gemspec

@@ -1,42 +1,106 @@
-# -*- encoding: utf-8 -*-
 
-Gem::Specification.new do |s|
-  s.name = %q{smusher}
-  s.version = "0.3.2"
+# Gem::Specification for Smusher-0.3.3
+# Originally generated by Echoe
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michael Grosser"]
-  s.date = %q{2009-01-27}
-  s.default_executable = %q{smusher}
-  s.description = %q{Automatic Lossless Reduction Of All Your Images}
-  s.email = %q{grosser.michael@gmail.com}
-  s.executables = ["smusher"]
-  s.extra_rdoc_files = ["lib/smusher.rb", "bin/smusher", "README.markdown"]
-  s.files = ["Manifest", "lib/smusher.rb", "spec/out/people.jpg", "spec/spec_helper.rb", "spec/smusher_spec.rb", "spec/images/logo.gif", "spec/images/woman.jpeg", "spec/images/add.png", "spec/images/drink_empty.png", "spec/images/people.jpg", "spec/images/water.JPG", "spec/reduced/fam.png", "spec/reduced/add.png", "bin/smusher", "Rakefile", "README.markdown", "smusher.gemspec"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/grosser/smusher}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Smusher", "--main", "README.markdown"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{smusher}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Automatic Lossless Reduction Of All Your Images}
+--- !ruby/object:Gem::Specification 
+name: smusher
+version: !ruby/object:Gem::Version 
+  version: 0.3.3
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+date: 2009-01-30 00:00:00 +01:00
+default_executable: 
+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: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Automatic Lossless Reduction Of All Your Images
+email: grosser.michael@gmail.com
+executables: 
+- smusher
+extensions: []
 
-    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_development_dependency(%q<echoe>, [">= 0"])
-    else
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<echoe>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<echoe>, [">= 0"])
-  end
-end
+extra_rdoc_files: 
+- bin/smusher
+- lib/smusher.rb
+- README.markdown
+files: 
+- bin/smusher
+- lib/smusher.rb
+- README.markdown
+- spec/reduced/fam.png
+- spec/reduced/add.png
+- spec/images/drink_empty.png
+- spec/images/logo.gif
+- spec/images/people.jpg
+- spec/images/add.png
+- spec/images/woman.jpeg
+- spec/images/water.JPG
+- spec/smusher_spec.rb
+- spec/out/people.jpg
+- spec/spec_helper.rb
+- Manifest
+- Rakefile
+- smusher.gemspec
+has_rdoc: true
+homepage: http://github.com/grosser/smusher
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Smusher
+- --main
+- README.markdown
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: smusher
+rubygems_version: 1.3.1
+specification_version: 2
+summary: Automatic Lossless Reduction Of All Your Images
+test_files: []

data/spec/smusher_spec.rb

@@ -2,6 +2,10 @@ 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
@@ -11,7 +15,7 @@ describe :smusher do
     @out = File.join(ROOT,'out')
     FileUtils.rm_r @out, :force=>true
     FileUtils.mkdir @out
-    FileUtils.cp(File.join(ROOT,'images','people.jpg'), @out)
+    copy 'people.jpg'
     
     @file = File.join(@out,'people.jpg')
   end
@@ -22,26 +26,87 @@ describe :smusher do
       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
+      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 |name|
-        file = File.join(ROOT,'images',name)
-        @files << File.join(@out,name) 
-        FileUtils.cp file, @out
+      %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 "smushes all images" do
+    it "optimizes all images" do
       Smusher.optimize_images_in_folder(@out)
       new_sizes = @files.map {|f|File.size(f)}
-      puts new_sizes * ' x '
       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
@@ -67,37 +132,6 @@ describe :smusher do
     end
   end
   
-  describe :with_protection do
-    def failure_data 
-      'x' * (Smusher::SMUSHIT_FAILURE_SIZE-1)
-    end
-    
-    def write(data)
-      File.open(@file,'w') {|f|f.puts data}
-    end
-    
-    def copy
-      FileUtils.cp(File.join(ROOT,'images','people.jpg'),@file)
-    end
-    
-    before do
-      @before = size
-      @before.should_not == 0
-    end
-    
-    it "reverts a file that got larger" do
-      Smusher.send(:with_protection,@file) do
-        write(File.open(@file).read + 'x')
-      end
-      @before.should == size
-    end
-    
-    it "reverts a file that got empty" do
-      Smusher.send(:with_protection,@file){write nil}
-      size.should == @before
-    end
-  end
-  
   describe :size do
     it "find the size of a file" do
       Smusher.send(:size,@file).should == File.size(@file)
@@ -111,7 +145,7 @@ describe :smusher do
   describe :logging do
     it "yields" do
       val = 0
-      Smusher.send(:with_logging,@file) {val = 1}
+      Smusher.send(:with_logging,@file,false) {val = 1}
       val.should == 1
     end
   end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-smusher
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Michael Grosser
 autorequire: 
 bindir: bin
-cert_chain: []
-
-date: 2009-01-27 00:00:00 -08:00
-default_executable: smusher
+cert_chain: 
+date: 2009-01-29 15:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,6 +23,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: json
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -32,6 +33,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: echoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -46,26 +48,26 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- lib/smusher.rb
 - bin/smusher
+- lib/smusher.rb
 - README.markdown
 files: 
-- Manifest
+- bin/smusher
 - lib/smusher.rb
-- spec/out/people.jpg
-- spec/spec_helper.rb
-- spec/smusher_spec.rb
-- spec/images/logo.gif
-- spec/images/woman.jpeg
-- spec/images/add.png
+- README.markdown
+- spec/reduced/fam.png
+- spec/reduced/add.png
 - spec/images/drink_empty.png
+- spec/images/logo.gif
 - spec/images/people.jpg
+- spec/images/add.png
+- spec/images/woman.jpeg
 - spec/images/water.JPG
-- spec/reduced/fam.png
-- spec/reduced/add.png
-- bin/smusher
+- spec/smusher_spec.rb
+- spec/out/people.jpg
+- spec/spec_helper.rb
+- Manifest
 - Rakefile
-- README.markdown
 - smusher.gemspec
 has_rdoc: true
 homepage: http://github.com/grosser/smusher