image_optim_rake 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84728f800392a61350da662ec41f49e6bec4da69
+  data.tar.gz: df42c824ced1eac1184341b0fcb432161d990403
+SHA512:
+  metadata.gz: 0519fa8492aa4732c0f617379ec510dfb9704a9af91b060e75ecc950e553cdf8c5fae6d831e425ecd9ef0b55292695f549354916a6810519c7e73ba712232d3f
+  data.tar.gz: 3681ca06e36be77f62905249b047183b20aed6c46aa921fa4105b4780ee849f82fa3e8d8bb7cc8019ffa80ddfc22e27da20d8f6c3647e89d5c616ccf0145259c

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,106 @@
+# image_optim_rake
+
+[![Build Status](https://api.travis-ci.org/jnbt/image_optim_rake.png?branch=master)](https://travis-ci.org/jnbt/image_optim_rake)
+
+A simple wrapper around [image_optim](https://github.com/toy/image_optim) to batch minify all images in one or more directories.
+
+Designed to work with Rails and per default recursively looks for JPGs and PNGs in `app\assets\images` and `public`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'image_optim_rake'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install image_optim_rake
+
+
+## Binary installation
+
+As above mentions this gem uses image_optim, which itself relies on some binary tools. These must be present at the system, but `pngout` is disabled here per default.
+
+### Linux - Debian/Ubuntu
+
+    sudo apt-get install -y advancecomp gifsicle jpegoptim libjpeg-progs optipng pngcrush
+
+### Linux - RHEL/Fedora/Centos
+
+    sudo yum install -y advancecomp gifsicle libjpeg optipng
+
+You will also need to install `jpegoptim` and `pngcrush` from source:
+
+#### jpegoptim
+
+    cd /tmp
+    curl -O http://www.kokkonen.net/tjko/src/jpegoptim-1.2.4.tar.gz
+    tar zxf jpegoptim-1.2.4.tar.gz
+    cd jpegoptim-1.2.4
+    ./configure && make && make install
+
+#### pngcrush
+
+    cd /tmp
+    curl -O http://iweb.dl.sourceforge.net/project/pmt/pngcrush/1.7.43/pngcrush-1.7.43.tar.gz
+    tar zxf pngcrush-1.7.43.tar.gz
+    cd pngcrush-1.7.43
+    make && cp -f pngcrush /usr/local/bin
+
+### OS X: Macports
+
+    sudo port install advancecomp gifsicle jpegoptim jpeg optipng pngcrush
+
+### OS X: Brew
+
+    brew install advancecomp gifsicle jpegoptim jpeg optipng pngcrush
+
+### pngout installation (optional)
+
+You can install `pngout` by downloading and installing the [binary versions](http://www.jonof.id.au/kenutils).
+
+_Note: pngout is free to use even in commercial soft, but you can not redistribute, repackage or reuse it without consent and agreement of creator. [license](http://advsys.net/ken/utils.htm#pngoutkziplicense)_
+
+**Copied from:** [https://github.com/toy/image_optim/](https://github.com/toy/image_optim/)
+
+## Usage
+
+Change to your project directory and run:
+
+    $ rake image_optim:minify
+
+You can define the directories where images will be searched **recursively** by setting a `dirs` argument:
+
+    $ rake image_optim:minify dirs=app/assets/images,public,lib/assets/images,vendor/assets/images
+
+## Configuration
+
+You can modify the configuration which is passed to image_optim:
+
+    ImageOptimRake::ImageOptimTask.config = {
+        :threads => true,
+        :pngout  => false
+    }
+
+You can also modify the default paths:
+
+    ImageOptimTask.dirs   = ["app/assets/images", "public"]
+
+A good place would be an initializer in a Rails environment.
+
+## Test
+
+    $ rake test
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+require 'image_optim_rake/image_optim_task'
+ImageOptimRake::ImageOptimTask.new

data/image_optim_rake.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "image_optim_rake/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "image_optim_rake"
+  gem.version     = ImageOptimRake::VERSION
+  gem.authors     = ["Jonas Thiel"]
+  gem.email       = ["jonasthiel@googlemail.com"]
+  gem.homepage    = "https://github.com/jnbt/image_optim_rake"
+  gem.summary     = %q{Provide a little helper command to minify images}
+  gem.description = %q{Provide a little helper command to minify images}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "image_optim", "~> 0.7.3"
+  gem.add_dependency "rake"
+  gem.add_dependency "progressbar", "~> 0.20.0"
+
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "testem"
+end

data/lib/image_optim_rake.rb

@@ -0,0 +1,4 @@
+module ImageOptimRake
+  require "image_optim_rake/image_optim_task"
+  require "image_optim_rake/railtie" if defined?(Rails)
+end

data/lib/image_optim_rake/image.rb

@@ -0,0 +1,16 @@
+module ImageOptimRake
+  class Image < Struct.new(:path, :original_size, :compressed_size)
+    def initialize(path)
+      self.path          = path
+      self.original_size = open(path, "rb").size
+    end
+
+    def reload_size!
+      self.compressed_size = open(path, "rb").size
+    end
+
+    def percentage
+      (original_size - compressed_size) == 0 ? 0.0 : (original_size - compressed_size).to_f / original_size.to_f * 100.0
+    end
+  end
+end

data/lib/image_optim_rake/image_optim_task.rb

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/tasklib'
+require 'image_optim_rake/minifier'
+
+module ImageOptimRake
+  class ImageOptimTask < ::Rake::TaskLib
+    class << self
+      attr_accessor :dirs, :config
+    end
+
+    attr_accessor :name
+
+    def initialize(name = :image_optim)
+      @name = name
+      yield self if block_given?
+      define
+    end
+
+    def define
+      namespace name do
+        desc "Minify all images found under /app/assets/images and /public/images"
+        task :minify do
+          dirs = ENV["dirs"] ? ENV["dirs"].split(",") : self.class.dirs
+          Minifier.new(dirs, self.class.config).process!
+        end
+      end
+    end
+  end
+
+  ImageOptimTask.dirs   = ["app/assets/images", "public"]
+  # Configure with :threads => true leads to auto-detection
+  ImageOptimTask.config = {
+    :threads => true,
+    :pngout  => false
+  }
+end

data/lib/image_optim_rake/minifier.rb

@@ -0,0 +1,69 @@
+require "image_optim_rake/image"
+require "image_optim"
+require "progressbar"
+
+module ImageOptimRake
+  class Minifier
+    attr_reader :dirs, :total_count, :total_size, :config
+
+    def initialize(dirs, config)
+      @dirs        = Hash[dirs.map{|d| [d, []]}]
+      @total_count = 0
+      @total_size  = 0
+      @config      = config
+    end
+
+    def process!
+      collect_images
+      log_images
+      process_images!
+      log_results
+    end
+
+    private
+
+    def collect_images
+      dirs.each do |dir, images|
+        Dir.glob(File.join(dir,"**","*.{jpg,jpeg,png}")) do |image_file|
+          image        = Image.new(image_file)
+          images       << image
+          @total_size  += image.original_size
+          @total_count += 1
+        end
+      end
+    end
+
+    def process_images!
+      progress = ::ProgressBar.new("Miniying", total_size)
+      processor = ::ImageOptim.new(config)
+      dirs.values.flatten.each do |image_file|
+        processor.optimize_image!(image_file.path)
+        image_file.reload_size!
+        progress.inc
+      end
+      progress.finish
+    end
+
+    def log_images
+      puts "Minifying total #{total_count} images at: "
+      dirs.each do |dir, images|
+        puts "- #{dir}: #{images.size} file(s)"
+      end
+      puts ""
+      puts "Grab a coffee now. This may take a while."
+      puts ""
+    end
+
+    def log_results
+      puts ""
+      puts "Finished minifying images of total original size: %.2d KB" % (total_size / 1024)
+      puts ""
+      new_total_size = dirs.values.flatten.map(&:compressed_size).reduce(&:+).to_f
+      percentage     = total_size - new_total_size == 0 ? 0.0 : (total_size - new_total_size).to_f / total_size.to_f * 100.0
+      puts "New total size: %.2d KB (%2.2f%%):" % [new_total_size / 1024, percentage]
+      dirs.values.flatten.each do |image|
+        puts "- #{image.path}: %2.2d%%" % image.percentage
+      end
+    end
+  end
+end

data/lib/image_optim_rake/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module ImageOptimRake
+  class Railtie < ::Rails::Railtie
+    railtie_name :image_optim_rake
+
+    rake_tasks do
+      ImageOptimTask.new
+    end
+  end
+end

data/lib/image_optim_rake/version.rb

@@ -0,0 +1,3 @@
+module ImageOptimRake
+  VERSION = "0.0.2"
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "testem"
+
+require "image_optim_rake"

data/test/units/image_test.rb

@@ -0,0 +1,24 @@
+require "helper"
+
+class ImageTest < Testem
+
+  let(:image){ ImageOptimRake::Image.new("test/fixtures/unprocessed.jpg")}
+
+  test "load from image path" do
+    assert_equal "test/fixtures/unprocessed.jpg", image.path
+    assert_equal 66388, image.original_size
+    assert_equal nil,   image.compressed_size
+  end
+
+  test "reload_size!" do
+    assert_equal nil,   image.compressed_size
+    image.reload_size!
+    assert_equal 66388, image.compressed_size
+  end
+
+  test "percentage" do
+    image.original_size   = 100
+    image.compressed_size = 50
+    assert_equal 50, image.percentage
+  end
+end

data/test/units/minifier_test.rb

@@ -0,0 +1,34 @@
+require "helper"
+
+class MinifierTest < Testem
+  let(:dirs){ ["test/fixtures/"] }
+
+  test "initializes from dirs and config" do
+    minifier = ImageOptimRake::Minifier.new(dirs, :foo => :bar)
+    expected = {"test/fixtures/" => []}
+    assert_equal expected, minifier.dirs
+    expected = {:foo => :bar}
+    assert_equal expected, minifier.config
+    assert_equal 0,        minifier.total_size
+    assert_equal 0,        minifier.total_count
+  end
+
+  test "process!" do
+    sizes = {}
+
+    Dir.mktmpdir("image_optim_rake") do |dir|
+      FileUtils.cp_r dirs[0], dir
+
+      Dir.glob(File.join(dir, "**/*.{jpg,png}")).each do |file|
+        sizes[file] = open(file, "rb").size
+      end
+
+      minifier = ImageOptimRake::Minifier.new([dir], :threads => true)
+      minifier.process!
+
+      Dir.glob(File.join(dir, "**/*.{jpg,png}")).each do |file|
+        assert sizes[file] > open(file, "rb").size, "should have reduced the file size"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: image_optim_rake
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jonas Thiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: image_optim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: testem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide a little helper command to minify images
+email:
+- jonasthiel@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- image_optim_rake.gemspec
+- lib/image_optim_rake.rb
+- lib/image_optim_rake/image.rb
+- lib/image_optim_rake/image_optim_task.rb
+- lib/image_optim_rake/minifier.rb
+- lib/image_optim_rake/railtie.rb
+- lib/image_optim_rake/version.rb
+- test/fixtures/unprocessed.jpg
+- test/fixtures/unprocessed.png
+- test/helper.rb
+- test/units/image_test.rb
+- test/units/minifier_test.rb
+homepage: https://github.com/jnbt/image_optim_rake
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Provide a little helper command to minify images
+test_files:
+- test/fixtures/unprocessed.jpg
+- test/fixtures/unprocessed.png
+- test/helper.rb
+- test/units/image_test.rb
+- test/units/minifier_test.rb