ryankshaw-image_crush 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Shaw
+
+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.rdoc

@@ -0,0 +1,18 @@
+= image_crush
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Ryan Shaw. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "image_crush"
+    gem.summary = %Q{crush your images}
+    gem.description = %Q{crush your images}
+    gem.email = "ryankshaw@gmail.com"
+    gem.homepage = "http://github.com/ryankshaw/image_crush"
+    gem.authors = ["Ryan Shaw"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "image_crush #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/image_crush

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'image_crush'
+
+if ( ARGV.empty? || (%w(--help -h).include? ARGV.first) )
+  puts "Usage: image_crush [directory_or_file_name] \n"
+  puts "ex: \n"
+  puts "image_crush bloatedimage.png \n"
+  puts "image_crush public/images <-- for a rails app, at the RAILS_ROOT directory"
+  exit(0)
+end
+# if 1 then just image crush that thing, it could be a directory or a file
+if ARGV.length == 1
+  ic = ImageCrush::Base.new
+  ic.extend ImageCrush::Messages
+  ic.crush(ARGV[0])
+elsif
+  puts "Sorry, something went wrong"
+end

data/image_crush.gemspec

@@ -0,0 +1,67 @@
+# 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{image_crush}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Shaw"]
+  s.date = %q{2009-08-06}
+  s.default_executable = %q{image_crush}
+  s.description = %q{crush your images}
+  s.email = %q{ryankshaw@gmail.com}
+  s.executables = ["image_crush"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/image_crush",
+     "image_crush.gemspec",
+     "lib/image_crush.rb",
+     "lib/image_crush/base.rb",
+     "lib/image_crush/jpegtran.rb",
+     "lib/image_crush/messages.rb",
+     "lib/image_crush/pngcrush.rb",
+     "spec/fixtures/README.txt",
+     "spec/fixtures/dice.png",
+     "spec/fixtures/happy-mailman.jpg",
+     "spec/fixtures/subdir/cc-by-icon.png",
+     "spec/image_crush/messages_spec.rb",
+     "spec/image_crush_spec.rb",
+     "spec/spec_helper.rb",
+     "tasks/image_crush.rake"
+  ]
+  s.homepage = %q{http://github.com/ryankshaw/image_crush}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{crush your images}
+  s.test_files = [
+    "spec/image_crush/messages_spec.rb",
+     "spec/image_crush_spec.rb",
+     "spec/spec_helper.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_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/image_crush/base.rb

@@ -0,0 +1,61 @@
+module ImageCrush
+
+  class Base
+
+    def crush(path)
+      raise ImageCrush::InputFileNotFound unless File.exist?(path)
+
+      if File.file?(path)
+        crush_file(path)
+      elsif File.directory?(path)
+        crush_dir(path)
+      else
+        raise "I don't know what to do with #{path}"
+      end
+    end
+
+    def crush_file(path)
+      processor = select_processor(path) or return nil
+      source_path = copy_to_tempdir(path)
+      crushed_path = source_path + '.crushed'
+      processor.crush(source_path, crushed_path)
+      FileUtils.cp(crushed_path, path) if File.exist?(crushed_path)
+    end
+
+    def crush_dir(path)
+      Dir.foreach(path) do |entry|
+        next if %w{. ..}.include?(entry)
+        crush(File.join(path, entry))
+      end
+    end
+
+    def select_processor(path)
+      case path
+      when /\.png$/i
+        Pngcrush
+      when /\.jpe?g$/i
+        Jpegtran
+      end
+    end
+
+    def copy_to_tempdir(path)
+      wdir = tmpdir
+      FileUtils.cp_r path, wdir
+      File.join(wdir, File.basename(path))
+    end
+
+    def tmpdir
+      ret = File.join(Dir.tmpdir, 'image_crush')
+      FileUtils.mkdir_p(ret)
+      ret
+    end
+
+  end # Base
+
+  class CrushToolNotAvailable < StandardError
+  end
+
+  class InputFileNotFound < StandardError
+  end
+
+end

data/lib/image_crush/jpegtran.rb

@@ -0,0 +1,15 @@
+module ImageCrush
+
+  module Jpegtran
+    def self.available?
+      @@available ||= ! %x{which jpegtran}.empty?
+    end
+
+    def self.crush(inpath, outpath)
+      raise ImageCrush::CrushToolNotAvailable unless available?
+      %x{jpegtran -copy none -optimize #{inpath} > #{outpath}}
+    end
+
+  end
+
+end

data/lib/image_crush/messages.rb

@@ -0,0 +1,33 @@
+module ImageCrush
+
+  module Messages
+
+    def self.extended(base)
+      class << base
+        def crush_file_with_messages(path)
+          size_before = File.open(path){|f| f.stat.size}
+          print "#{path}: #{human_size size_before}"
+          crush_file_without_messages(path)
+          size_after = File.open(path){|f| f.stat.size}
+          ratio = sprintf('%0.2f', size_after.to_f*100/size_before)
+          puts " -> #{human_size size_after} (#{ratio}%)"
+        end
+        alias :crush_file_without_messages :crush_file
+        alias :crush_file :crush_file_with_messages
+        
+        
+        private
+        
+        def human_size(bytes)
+          if bytes < 1024
+            bytes.to_s + 'B'
+          else
+            sprintf("%0.1fK", bytes.to_f/1024).gsub('.0K', 'K')
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/image_crush/pngcrush.rb

@@ -0,0 +1,15 @@
+module ImageCrush
+
+  module Pngcrush
+    def self.available?
+      @@available ||= ! %x{which pngcrush}.empty?
+    end
+
+    def self.crush(inpath, outpath)
+      raise ImageCrush::CrushToolNotAvailable unless available?
+      %x{pngcrush -rem alla -brute -reduce #{inpath} #{outpath}}
+    end
+
+  end
+
+end

data/lib/image_crush.rb

@@ -0,0 +1,14 @@
+module ImageCrush
+  LIB_ROOT = File.dirname(__FILE__)
+end
+
+base_dir = File.join(ImageCrush::LIB_ROOT, 'image_crush')
+require File.join(base_dir, 'base')
+require File.join(base_dir, 'pngcrush')
+require File.join(base_dir, 'jpegtran')
+require File.join(base_dir, 'messages')
+load File.join(File.dirname(ImageCrush::LIB_ROOT), 'tasks', 'image_crush.rake')
+
+def ImageCrush(path)
+  ImageCrush::Base.new.crush(path)
+end

data/spec/fixtures/README.txt

@@ -0,0 +1,16 @@
+*** dice.png ***
+retrieved from http://en.wikipedia.org/wiki/File:PNG_transparency_demonstration_1.png
+on 27-07-2009
+licensed under CC-BY-SA (http://creativecommons.org/licenses/by-sa/3.0)
+
+*** subdir/cc-by-icon.png ***
+retrieved from http://commons.wikimedia.org/wiki/File:Cc-by-icon.png
+on 28-07-2009
+licensed under CC-BY (http://creativecommons.org/licenses/by/3.0)
+
+*** happy-mailman.jpg ***
+original title: http://www.eastmanhouse.org/flickr/statement.php
+by Nickolas Muray
+retrieved from http://www.flickr.com/photos/george_eastman_house/3122865907/
+on 05-07-2009
+no known copyright restrictions, see http://www.eastmanhouse.org/flickr/statement.php

data/spec/image_crush/messages_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(File.dirname(__FILE__)), 'spec_helper')
+
+require 'tmpdir'
+require 'fileutils'
+
+describe ImageCrush::Messages do
+
+  it 'prints a message to stdout after crushing a file' do
+    mock_stdout = ''
+    ic = ImageCrush::Base.new
+    ic.extend ImageCrush::Messages
+    ic.stub!(:print).and_return{|str| mock_stdout << str }
+    ic.stub!(:puts).and_return{|str| mock_stdout << str << "\n" }
+    path = copy_file_to_tmpdir(DICE_PATH)
+    ic.crush(path)
+    mock_stdout.should == "#{path}: 9K -> 8.9K (98.88%)\n"
+  end
+
+end
+

data/spec/image_crush_spec.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'tmpdir'
+require 'fileutils'
+
+describe "ImageCrush" do
+
+  before :each do
+    remove_any_work_dirs
+  end
+
+  after :all do
+    remove_any_work_dirs
+  end
+
+  describe 'exception conditions' do
+    it 'should fail when the input file does not exist' do
+      lambda{ImageCrush('/path/to/nowhere/fast')}.should raise_error(ImageCrush::InputFileNotFound)
+    end
+
+    it 'should fail when the crush tool is not available' do
+      ImageCrush::Pngcrush.should_receive(:available?).and_return(false)
+      lambda{ImageCrush(DICE_PATH)}.should raise_error(ImageCrush::CrushToolNotAvailable)
+    end
+  end
+
+  describe 'individual files' do
+    it 'should crush PNG files' do
+      image_path = copy_file_to_tmpdir(DICE_PATH)
+      should_reduce_size_of_image(image_path)
+    end
+
+    it 'should crush JPEG files' do
+      image_path = copy_file_to_tmpdir(MMAN_PATH)
+      should_reduce_size_of_image(image_path)
+    end
+
+    it 'should ignore other files' do
+      path = copy_file_to_tmpdir(README_PATH)
+      ImageCrush(path)
+      File.exist?('/tmp/image_crush/README.txt').should == false
+    end
+
+
+    private
+
+    def should_reduce_size_of_image(path)
+      f = File.open(path)
+      size_before = f.stat.size
+      f.close
+      ImageCrush(path)
+      f = File.open(path)
+      size_after = f.stat.size
+      f.close
+      size_after.should < size_before
+    end
+  end
+
+
+  describe 'recursive crush' do
+    before do
+      create_work_dir
+      FileUtils.cp_r Dir.glob(File.join(FIXTURES_ROOT, '**')), @work_dir
+      @dice_path = File.join(@work_dir, File.basename(DICE_PATH))
+      @ccby_path = File.join(@work_dir, 'subdir', File.basename(CCBY_PATH))
+    end
+
+    it 'should recursively crush all images in a directory' do
+      f1 = File.open(@dice_path)
+      size1_before = f1.stat.size
+      f1.close
+      f2 = File.open(@ccby_path)
+      size2_before = f2.stat.size
+      f2.close
+      
+      ImageCrush(@work_dir)
+      
+      f1 = File.open(@dice_path)
+      size1_after = f1.stat.size
+      f1.close
+      f2 = File.open(@ccby_path)
+      size2_after = f2.stat.size
+      f2.close
+      
+      size1_after.should < size1_before
+      size2_after.should < size2_before
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'image_crush'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+FIXTURES_ROOT = File.join(File.dirname(__FILE__), 'fixtures')
+DICE_PATH = File.join(FIXTURES_ROOT, 'dice.png')
+CCBY_PATH = File.join(FIXTURES_ROOT, 'subdir', 'cc-by-icon.png')
+MMAN_PATH = File.join(FIXTURES_ROOT, 'happy-mailman.jpg')
+README_PATH = File.join(FIXTURES_ROOT, 'README.txt')
+
+def copy_file_to_tmpdir(path)
+  create_work_dir
+  FileUtils.cp path, @work_dir
+  File.join(@work_dir, path.gsub(FIXTURES_ROOT, ''))
+end
+
+def remove_any_work_dirs
+  Dir.glob(File.join(Dir.tmpdir, 'image_crush.spec.*')).each{|path| FileUtils.rm_rf(path)}
+end
+
+def create_work_dir
+  @work_dir = File.join(Dir.tmpdir, 'image_crush.spec.' + $$.to_s)
+  FileUtils.mkdir_p(@work_dir)
+end

data/tasks/image_crush.rake

@@ -0,0 +1,16 @@
+require 'rake'
+require 'tmpdir'
+
+desc 'Reduce the size of PNG and JPEG files where possible'
+task :crush => 'crush:all'
+
+namespace :crush do
+  task :all do
+    require File.join(File.dirname(__FILE__), "lib/image_crush.rb")
+    ic = ImageCrush::Base.new
+    ic.extend ImageCrush::Messages
+    ic.crush(File.join(RAILS_ROOT, 'public', 'images'))
+  end
+
+  task :default => :all
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: ryankshaw-image_crush
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Shaw
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-06 00:00:00 -07:00
+default_executable: image_crush
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: crush your images
+email: ryankshaw@gmail.com
+executables: 
+- image_crush
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/image_crush
+- image_crush.gemspec
+- lib/image_crush.rb
+- lib/image_crush/base.rb
+- lib/image_crush/jpegtran.rb
+- lib/image_crush/messages.rb
+- lib/image_crush/pngcrush.rb
+- spec/fixtures/README.txt
+- spec/fixtures/dice.png
+- spec/fixtures/happy-mailman.jpg
+- spec/fixtures/subdir/cc-by-icon.png
+- spec/image_crush/messages_spec.rb
+- spec/image_crush_spec.rb
+- spec/spec_helper.rb
+- tasks/image_crush.rake
+has_rdoc: false
+homepage: http://github.com/ryankshaw/image_crush
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: crush your images
+test_files: 
+- spec/image_crush/messages_spec.rb
+- spec/image_crush_spec.rb
+- spec/spec_helper.rb