jpegoptim 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "depq", ">= 0.4"
+#   gem "hash-utils", ">= 0.9.0"
+   gem "pipe-run", ">= 0.1.0"
+   gem "command-builder", ">= 0.1.0"
+   gem "unix-whereis", ">= 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.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    command-builder (0.1.0)
+      hash-utils (>= 0.7.0)
+    git (1.2.5)
+    hash-utils (0.9.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    pipe-run (0.1.0)
+    rake (0.8.7)
+    unix-whereis (0.1.0)
+      command-builder (>= 0.1.0)
+      hash-utils (>= 0.9.0)
+      pipe-run (>= 0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  command-builder (>= 0.1.0)
+  jeweler (~> 1.5.2)
+  pipe-run (>= 0.1.0)
+  unix-whereis (>= 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,61 @@
+Jpegoptim
+=========
+
+**Jpegoptim** provides Ruby interface to the `jpegoptim` tool. 
+Some examples follow: (for details, see module documentation)
+
+    require "jpegoptim"
+    
+    Jpegoptim.available?    # will return true (or false)
+    
+    Jpegoptim.optimize(["foo.jpg", "empty.jpg", "nonexist.jpg"], { :preserve => true, :strip => :all })
+    
+    # will run 'jpegoptim --strip-all --preserve foo.jpg bar.jpgug empty.jpg'
+    # and then will return for example: 
+    #   '#<struct Jpegoptim::Result succeed={"foo.jpg => -22.1}}, errors=[["empty.jpg", "ERROR"]]>
+    
+### Call Result
+
+Result contains members `:success` and `:errors`. Sucess member contains 
+hash of successfully optimized files with ratio as value. Zero or 
+positive percent ratio means the same as file has been `skipped`. It's 
+negative number against the number reported by `jpegoptim` so it means 
+new size against the old size.
+
+Errors contains array with pairs where first member of the pair is 
+filename and second the message. First one can be null if message isn't
+strictly associated with file. As unassociated messages are considered 
+all errors beginning by the `jpegoptim:` string although these are 
+usually written to the error output so generaly unhandled and written 
+out to error output of the application instead.
+
+Be warn, unassociated message is `can't open` error too, so double 
+check, file exists if desired result is critical.
+
+### Unsupported Options
+
+Destination directory option isn't supported, so you are purely 
+responsible for optimizing files on the right place. Use Ruby methods 
+for it.
+
+
+    
+    
+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][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright &copy; 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[2]: http://github.com/martinkozak/qrpc/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# 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 = "jpegoptim"
+  gem.homepage = "https://github.com/martinkozak/jpegoptim"
+  gem.license = "MIT"
+  gem.summary = "Ruby interface to 'jpegoptim' tool."
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "qrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/jpegoptim.gemspec

@@ -0,0 +1,60 @@
+# 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{jpegoptim}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-02-21}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "jpegoptim.gemspec",
+    "lib/jpegoptim.rb",
+    "test"
+  ]
+  s.homepage = %q{https://github.com/martinkozak/jpegoptim}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Ruby interface to 'jpegoptim' tool.}
+
+  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<pipe-run>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<command-builder>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<unix-whereis>, [">= 0.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<pipe-run>, [">= 0.1.0"])
+      s.add_dependency(%q<command-builder>, [">= 0.1.0"])
+      s.add_dependency(%q<unix-whereis>, [">= 0.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<pipe-run>, [">= 0.1.0"])
+    s.add_dependency(%q<command-builder>, [">= 0.1.0"])
+    s.add_dependency(%q<unix-whereis>, [">= 0.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/jpegoptim.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "command-builder"
+require "pipe-run"
+require "unix/whereis"
+
+##
+# The +jpegoptim+ tool command frontend.
+# @see
+#
+
+module Jpegoptim
+
+    ##
+    # Holds +jpegoptim+ command.
+    #
+    
+    COMMAND = :jpegoptim
+    
+    ##
+    # Result structure.
+    #
+    # Contains members +:success+ and +:errors+. Sucess member contains 
+    # hash of successfully optimized files with ratio as value. Zero 
+    # or positive percent ratio means the same as file has been 
+    # +skipped+. It's negative number against the number reported by
+    # +jpegoptim+ so it means new size against the old size.
+    #
+    # Errors contains array with pairs where first member of the pair is
+    # filename and second the message. First one can be null if message
+    # isn't strictly associated with file. As unassociated messages are 
+    # considered all errors beginning by the +jpegoptim:+ string althoug 
+    # these are usually written to the error output so generaly 
+    # unhandled and written out to error output of the application 
+    # instead.
+    #
+    # Be warn, unassociated message is +can't open+ error too, so double
+    # check, file exists if desired result is critical.
+    # 
+    
+    Result = Struct::new(:succeed, :errors)
+    
+    ##
+    # Holds output matchers.
+    #
+    
+    MATCHERS = [
+        /(.*)\[(ERROR)\]/,
+        /jpegoptim:\s*(.*)/,
+        /(.*)\s+\d+x\d+.*\((\-?\d+\.\d+)%\)/
+    ]
+
+    ##
+    # Checks if +jpegoptim+ is available.
+    # @return [Boolean] +true+ if it is, +false+ in otherwise
+    #
+    
+    def self.available?
+        return Whereis.available? self::COMMAND 
+    end
+    
+    ##
+    # Performs optimizations above file or set of files.
+    #
+    # Destination directory option isn't supported, so you are purely 
+    # responsible for optimizing files on the right place. Use Ruby 
+    # methods for it.
+    #
+    # @param [String, Array] paths file path or array of paths for optimizing
+    # @param [Hash] options options 
+    # @option options [Boolean, Symbol] :strip says what informations strip, see +jpegoptim+ documentation, default is +:all+
+    # @option options [Boolean] :preserve turns on preserving the timestamps
+    # @option options [Integer] :max set maximum image quality factor
+    # @option options [Boolean] :debug turn on debugging mode, so command will be put out to the +STDERR+
+    # @return [Struct] see {Result}
+    #
+    
+    def self.optimize(paths, options = { })
+    
+        # Command
+        cmd = CommandBuilder::new(self::COMMAND)
+        
+        # Strip definition
+        strip = options[:strip]
+        if strip.nil? or (strip == true)
+            strip == :all
+        end
+        if strip
+            cmd << ("strip-" << strip.to_s).to_sym
+        end
+        
+        # Preserve
+        if options[:preserve]
+            cmd << :preserve
+        end
+        
+        # Max
+        if options[:max].kind_of? Integer
+            cmd.arg(:max, options[:max].to_i)
+        end
+        
+        # Files
+        if paths.kind_of? String
+            paths = [paths]
+        end
+        
+        # Runs the command
+        cmd << paths
+        
+        if options[:debug] == true
+            STDERR.write cmd.to_s + "\n"
+        end
+        
+        output = Pipe.run(cmd.to_s)
+        
+        # Parses output
+        succeed, errors = __parse_output(output)
+        return self::Result::new(succeed, errors)
+        
+    end
+    
+    
+    private
+    
+    ##
+    # Parses output.
+    #
+    
+    def self.__parse_output(output)
+        errors = [ ]
+        succeed = { }
+        
+        output.each_line do |line|
+            if m = line.match(self::MATCHERS[0])
+                errors << [m[1].strip, m[2]]
+            elsif m = line.match(self::MATCHERS[1])
+                errors << [nil, m[1]]
+            elsif m = line.match(self::MATCHERS[2])
+                succeed[m[1]] = m[2].to_f * -1
+            end
+        end
+        
+        return [succeed, errors]
+    end
+end

data/test

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+
+$:.push("./lib")
+require "jpegoptim"
+
+puts Jpegoptim.available?.inspect
+puts Jpegoptim.optimize(["foo.jpg", "bar.jpg", "empty.jpg"], { :preserve => true, :strip => :all, :debug => true })

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: jpegoptim
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pipe-run
+  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: command-builder
+  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: unix-whereis
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- jpegoptim.gemspec
+- lib/jpegoptim.rb
+- test
+has_rdoc: true
+homepage: https://github.com/martinkozak/jpegoptim
+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: -392424592510368295
+      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.5.2
+signing_key: 
+specification_version: 3
+summary: Ruby interface to 'jpegoptim' tool.
+test_files: []
+