image-optimizer 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+   gem "yaop", ">= 0.1.0"
+   gem "jpegtran", ">= 0.1.0"
+   gem "optipng", ">= 0.2.0"
+   gem "jpegoptim", ">= 0.2.0"
+   gem "mini_magick", ">= 3.2.1"
+   gem "unix-whereis", ">= 0.1.0"
+   gem "options-hash", ">= 0.1.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.14"
+  gem "jeweler", "~> 1.6.0"
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    command-builder (0.1.0)
+      hash-utils (>= 0.7.0)
+    git (1.2.5)
+    hash-utils (0.15.0)
+    hashie (1.0.0)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    jpegoptim (0.2.0)
+      command-builder (>= 0.1.0)
+      pipe-run (>= 0.2.0)
+      unix-whereis (>= 0.1.0)
+    jpegtran (0.1.0)
+      command-builder (>= 0.1.0)
+      hash-utils (>= 0.15.0)
+      lookup-hash (>= 0.2.0)
+      pipe-run (>= 0.2.1)
+      unix-whereis (>= 0.1.0)
+    lookup-hash (0.2.0)
+      hash-utils (>= 0.11.0)
+    mini_magick (3.2.1)
+      subexec (~> 0.0.4)
+    multitype-introspection (0.1.2)
+    options-hash (0.1.0)
+      hashie (>= 1.0.0)
+    optipng (0.2.0)
+      command-builder (>= 0.1.0)
+      pipe-run (>= 0.2.0)
+      unix-whereis (>= 0.1.0)
+    pipe-run (0.2.1)
+    rake (0.9.0)
+    subexec (0.0.4)
+    types (0.1.3)
+      abstract (>= 1.0.0)
+      multitype-introspection (>= 0.1.0)
+    unix-whereis (0.1.0)
+      command-builder (>= 0.1.0)
+      hash-utils (>= 0.9.0)
+      pipe-run (>= 0.1.0)
+    yaop (0.1.0)
+      hash-utils (>= 0.1.0)
+      types (>= 0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.14)
+  jeweler (~> 1.6.0)
+  jpegoptim (>= 0.2.0)
+  jpegtran (>= 0.1.0)
+  mini_magick (>= 3.2.1)
+  options-hash (>= 0.1.0)
+  optipng (>= 0.2.0)
+  unix-whereis (>= 0.1.0)
+  yaop (>= 0.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+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,69 @@
+Image Optimizer
+===============
+
+**Image Optimizer** optimizes given JPEG and PNG images or images in 
+given folder. Performs the following for PNG:
+
+1. rewrites PNG file using `convert`,
+2. optimizes it using `optipng`.
+
+And for JPEG:
+
+1. strips all unnecessary metadata using `jpegoptim`,
+2. optimizes using `jpegtran`.
+
+## Usage
+
+Simply both for files or whole directories:
+    
+    ImageOptimizer::optimize("./some-dir", :strip => false, :level => 7) do |file|
+        p file    # prints out target filename
+    end
+
+Where `:strip` option indicates it should strip all metadata from 
+JPEG files. Default is `true`. `:level` indicates level of 
+PNG optimization. Default is `7`.
+
+For *command line* usage see help for the `image-optimizer` command.
+
+## Requirements
+
+Following software for full functionality is necessary:
+
+* [UNIX][2]-like system (*required*),
+* [Ruby][1] (*required*),
+* [whereis][3] (*required*),
+* [ImageMagick][8],
+* [Jpegtran][5],
+* [Jpegoptim][6],
+* [OptiPNG][7].
+
+Steps which requires non-strictly required components will be silently 
+ignored if these components will not be available.
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][9] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright © 2011 [Martin Kozák][10]. See `LICENSE.txt` for
+further details.
+
+[1]: http://www.ruby-lang.org/
+[2]: http://en.wikipedia.org/wiki/Unix
+[3]: http://en.wikipedia.org/wiki/Linux
+[4]: http://linux.die.net/man/1/whereis
+[5]: http://linux.die.net/man/1/jpegtran
+[6]: http://freshmeat.net/projects/jpegoptim/
+[7]: http://optipng.sourceforge.net/
+[8]: http://www.imagemagick.org/
+[9]: http://github.com/martinkozak/image-optimizer/issues
+[10]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  
+  gem.name = "image-optimizer"
+  gem.homepage = "http://github.com/martinkozak/image-optimizer"
+  gem.license = "MIT"
+  gem.summary = "Optimizes given JPEG and PNG images or images in given folder."
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/image-optimizer

@@ -0,0 +1,46 @@
+#!/bin/env ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "image-optimizer"
+require "yaop"
+
+# Parses command line
+opts = YAOP::get do
+    option "--help"
+    type Boolean, false
+    
+    option "--version"
+    type Boolean, false
+    
+    option "--strip"
+    type Boolean, true
+    
+    option "--level"
+    type Integer, 7
+end
+
+# Shows help or version
+if opts.arguments["--help"]
+    puts "Usage: image-optimizer <arguments> [files or folders]*"
+    puts "\t--help     display this help and exit"
+    puts "\t--version  output version information and exit"
+    puts "\t--level    1-7, intensity of PNG optimization"
+    puts "\t--strip    indicates it should strip all JPEG files metadata"
+    exit
+elsif opts.arguments["--version"]
+    puts "image-optimizer 0.1.0"
+    puts "Copyright (C) 2011 Martin Kozák (martinkozak@martinkozak.net)"
+    puts "Optimizes given JPEG and PNG images or all images in given folders."
+    exit
+end
+
+# Optimizes
+args = {
+    :strip => opts.arguments["--strip"],
+    :level => opts.arguments["--level"]
+}
+
+ImageOptimizer::optimize(opts.parameters, args) do |i|
+    puts i << "\n"
+end

data/image-optimizer.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{image-optimizer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Martin Kozák}]
+  s.date = %q{2011-05-29}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.executables = [%q{image-optimizer}]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/image-optimizer",
+    "image-optimizer.gemspec",
+    "lib/image-optimizer.rb"
+  ]
+  s.homepage = %q{http://github.com/martinkozak/image-optimizer}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.4}
+  s.summary = %q{Optimizes given JPEG and PNG images or images in given folder.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yaop>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<jpegtran>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<optipng>, [">= 0.2.0"])
+      s.add_runtime_dependency(%q<jpegoptim>, [">= 0.2.0"])
+      s.add_runtime_dependency(%q<mini_magick>, [">= 3.2.1"])
+      s.add_runtime_dependency(%q<unix-whereis>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<options-hash>, [">= 0.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.14"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+    else
+      s.add_dependency(%q<yaop>, [">= 0.1.0"])
+      s.add_dependency(%q<jpegtran>, [">= 0.1.0"])
+      s.add_dependency(%q<optipng>, [">= 0.2.0"])
+      s.add_dependency(%q<jpegoptim>, [">= 0.2.0"])
+      s.add_dependency(%q<mini_magick>, [">= 3.2.1"])
+      s.add_dependency(%q<unix-whereis>, [">= 0.1.0"])
+      s.add_dependency(%q<options-hash>, [">= 0.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.14"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    end
+  else
+    s.add_dependency(%q<yaop>, [">= 0.1.0"])
+    s.add_dependency(%q<jpegtran>, [">= 0.1.0"])
+    s.add_dependency(%q<optipng>, [">= 0.2.0"])
+    s.add_dependency(%q<jpegoptim>, [">= 0.2.0"])
+    s.add_dependency(%q<mini_magick>, [">= 3.2.1"])
+    s.add_dependency(%q<unix-whereis>, [">= 0.1.0"])
+    s.add_dependency(%q<options-hash>, [">= 0.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.14"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+  end
+end
+

data/lib/image-optimizer.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "jpegtran"
+require "optipng"
+require "jpegoptim"
+
+require "mini_magick"
+require "unix/whereis"
+require "options-hash" 
+
+module ImageOptimizer
+    
+    ##
+    # Optimizes given file or folder.
+    #
+    # If array given, go recursively deep to it. Yields paths to 
+    # optimized files.
+    #
+    # @param [String, Array] item path or paths to files or directories
+    # @param [Hash] options options for optimizing
+    # @param [Proc] block block for giving back the results
+    # @option options [Boolean] :strip indicates it should strip metadata from JPEG files
+    # @option options [Integer] :level indicates level of PNG optimizations
+    #
+    
+    def self.optimize(item, options = { }, &block)
+        if item.kind_of? Array
+            item.each do |i|
+                self::optimize(i, options, &block)
+            end
+        else
+            if File.file? item
+                self::optimize_file(item, options, &block)
+            elsif File.directory? item
+                self::optimize_directory(item, options, &block)
+            end
+        end
+    end
+    
+    ##
+    # Optimizes given folder. 
+    # Yields paths to optimized files.
+    #
+    # @param [String] item path to directory
+    # @param [Hash] options options for optimizing
+    # @param [Proc] block block for giving back the results
+    # @option options [Boolean] :strip indicates it should strip metadata from JPEG files
+    # @option options [Integer] :level indicates level of PNG optimizations
+    #
+    
+    def self.optimize_directory(item, options = { }, &block)
+        Dir.open(item) do |dir|
+            dir.each do |i|
+                if i[0].chr != ?.
+                    self::optimize(item + "/" + i, options, &block)
+                end
+            end
+        end
+    end
+    
+    ##
+    # Optimizes given file.
+    # Yields paths to optimized files.
+    #
+    # @param [String] item path to file
+    # @param [Hash] options options for optimizing
+    # @param [Proc] block block for giving back the results
+    # @option options [Boolean] :strip indicates it should strip metadata from JPEG files
+    # @option options [Integer] :level indicates level of PNG optimizations
+    #
+    
+    def self.optimize_file(path, options = { }, &block)
+        ext = File.extname(path)
+        
+        # Loads options
+        opts = OptionsHash::get(options) [
+            :strip => true,
+            :level => 7
+        ]
+        
+        case ext
+            when ".png"
+                if Whereis.available? :convert
+                    begin
+                        image = MiniMagick::Image.open(path)
+                        image.write(path)
+                    rescue MiniMagick::Error
+                        # skips
+                    end
+                end
+                
+                if Optipng.available?
+                    Optipng.optimize(path, { :level => opts[:level] })
+                end
+                
+                block.call(path)
+            when ".jpg"
+                if Jpegoptim.available?
+                    Jpegoptim.optimize(path, opts[:strip].true? ? { :strip => :all } : { })
+                end
+                
+                if Jpegtran.available?
+                    Jpegtran.optimize(path, { :optimize => true, :progressive => true })
+                end
+                
+                block.call(path)
+        end
+    end
+
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification 
+name: image-optimizer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yaop
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jpegtran
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: optipng
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jpegoptim
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mini_magick
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: unix-whereis
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: options-hash
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.14
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+description: 
+email: martinkozak@martinkozak.net
+executables: 
+- image-optimizer
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/image-optimizer
+- image-optimizer.gemspec
+- lib/image-optimizer.rb
+homepage: http://github.com/martinkozak/image-optimizer
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1503019227960848104
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Optimizes given JPEG and PNG images or images in given folder.
+test_files: []
+