photile 0.1.0.pre

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+doc/
+tmp/

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) photile 2012 Nitin Dhar
+
+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,62 @@
+# photile**
+
+* * *
+*A ruby gem/library to chop a photo into tiles, watermark them, etc*
+* * *
+
+`photile` can be used to power a web widget like [turnandzoom](https://github.com/nitindhar7/turnandzoom) or just about any simple image processing workflow. With `photile` you can run simple tasks like compression, watermarking and tiling images manually or in an automated fashion. These tasks can be combined to formulate a custom flow. For example, you can `compress an image` → `watermark it` → `break it up into tiles`.
+
+One scenario where this is really useful is image processing for product images. Most product images are shot on white background, which means that there is a big opportunity to reduce image size and improve rendering speed on the web page. Here's what you can do with `photile`: `basic quality reduction` → `watermark your product images` → `break it up into tiles (certain tiles will be all white)` → `compress individual tiles`.
+
+### Functions
+
+* Quality manipulation
+* Loss-less compression
+* Watermarking
+* Tiling
+
+### Piping
+
+The four main functions of `photile` can be used in all combinations possible because of their 'piping' properties (i.e., the Builder Pattern). Each function takes in an image and spits out an image or an array of images. When an array of images is returned any function thereafter is applied to all items in the array. When piping functions the order is relevant as the output of a function becomes the input of another. For example: `tile` → `watermark` (tiles images and then applies a watermark to the smaller, chopped images) is not the same as `watermark` → `tile` (watermarks an image and then creates tiles).
+
+Here are the piping scenarios available
+
+* `IMAGE` → `Quality Modifier` → `IMAGE`
+* `IMAGE` → `Compressor` → `IMAGE`
+* `IMAGE` + `WATERMARK IMAGE`  → `Watermarker` → `IMAGE`
+* `IMAGE` → `Tiler` → `[IMAGE...IMAGE]`
+
+### Examples
+
+```bash
+# Basic Examples
+$ photile -quality 80 image-in image-out
+$ photile -compress image-in image-out
+$ photile -watermark image-in image-watermark image-out
+$ photile -tile WIDTHxHEIGHT image-in [image-out-0...image-out-n]
+
+# Advanced Examples
+
+# 1. Reduce quality and then loss less compression for 'image-in' to produce 'image-out'
+$ photile -quality 80 -compress image-in image-out
+
+# 2. Watermark 'image-in' with 'image-watermark' and then tile it with size 'WIDTHxHEIGHT' to produce '[image-out-0...image-out-n]'
+$ photile -watermark -tile WIDTHxHEIGHT image-in image-watermark image-out
+
+# 3. Reduce quality of 'image-in', then compress it and watermark it with 'image-watermark'. Finally, tile the watermarked image to produce '[image-out-0...image-out-n]'
+$ photile -quality 80 -compress -watermark -tile WIDTHxHEIGHT image-in image-watermark [image-out-0...image-out-n]
+```
+
+### Dependencies
+
+* **Imagemagick** - Follow the installation instructions [here](http://imagemagick.org) (on Linux you can install it using: `sudo apt-get install imagemagick imagemagick-common`).
+* **Jpegtran** - Follow the installation instructions [here](http://jpegclub.org/jpegtran) (on Linux you can install it using: `sudo apt-get install libjpeg-turbo-progs`).
+
+### More
+
+Photile uses the amazing [Imagemagick](http://www.imagemagick.org/script/index.php) and [Jpegtran](http://jpegclub.org/jpegtran/) libraries. Imagemagick provides quality, watermarking and tiling properties. Jpegtran provides the loss-less compression. In other words, `photile` is just a layer on top of existing libraries to make certain image processing tasks dead simple. Additionally since `photile` is a gem it can be used directly in Rails to create dynamic workflows.
+
+** `photile` is in a pre-release α state at the moment.
+
+* * *
+Copyright (c) 2012 Nitin Dhar. See [MIT-LICENSE](MIT-LICENSE) for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run unit tests"
+task :default => :test
+
+desc "Build photile for testing"
+task :build do
+  system 'gem build photile.gemspec && gem install ./*.gem --pre && rm *.gem'
+end
+
+desc "Build docs"
+task :docs do
+  `rdoc`
+end
+
+desc "Uninstalls the gem"
+task :uninstall do
+  system 'gem uninstall photile'
+end

data/bin/photile

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'photile'
+require 'optparse'
+
+options = []
+
+optparse = OptionParser.new do|opts|
+  opts.banner = "Usage: photile [options] infile outfile"
+
+  opts.on('-q', '--quality VALUE', Integer, 'Modify image quality') do |value|
+    options << {:quality => value}
+  end
+
+  opts.on('-c', '--compress', 'Loss-less compress image') do
+    options << {:compress => true}
+  end
+
+  opts.on('-w', '--watermark FILE', String, 'Watermark with given file') do |file|
+    options << {:watermark => file}
+  end
+
+  opts.on('-t', '--tile WIDTHxHEIGHT', Regexp.new(/\d+x\d+/), 'Tile to the given dimensions') do |dimensions|
+    dim = dimensions.split('x')
+    options << {:tile => {:width => dim.first.to_i, :height => dim.last.to_i}}
+  end
+
+  opts.on('-h', '--help', 'Display options help') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+
+  if options.empty?
+    puts optparse
+    exit
+  end
+
+  puts options
+rescue OptionParser::InvalidArgument => ia
+  puts ia
+  exit
+end

data/lib/photile.rb

@@ -0,0 +1,63 @@
+=begin
+namespace :image do
+
+  desc "Displays the size of an image"
+  task :size do
+    size = `identify tmp/original.jpeg`.split(" ")[6]
+    puts "Image size: #{size}"
+  end
+
+  desc "Changes the quality of an image"
+  task :quality do
+    `convert tmp/original.jpeg -quality 70 tmp/quality70.jpeg`
+    size = `identify tmp/quality70.jpeg`.split(" ")[6]
+    puts "Image size: #{size}"
+  end
+
+  desc "Changes the quality of an image with 2 compressions"
+  task :quality_advanced do
+    `convert tmp/original.jpeg -quality 70 tmp/quality70.jpeg`
+    `jpegtran -copy none -optimize -perfect -outfile tmp/quality70.jpeg tmp/quality70.jpeg`
+    size = `identify tmp/quality70.jpeg`.split(" ")[6]
+    puts "Image size: #{size}"
+  end
+
+  desc "Applies a watermark to an image"
+  task :watermark do
+    `composite -gravity center tmp/watermark.png tmp/original.jpeg tmp/watermarked.jpeg`
+    size = `identify tmp/watermarked.jpeg`.split(" ")[6]
+    puts "Watermarked image. Image size: #{size}"
+  end
+
+  desc "Tiles an image by chopping it up into fragments"
+  task :tile do
+    `convert tmp/original.jpeg -crop 300x300 +repage +adjoin tmp/tile_%02d.jpeg`
+  end
+
+  desc "Cleans up temporary files generated"
+  task :clean do
+    `rm tmp/quality70.jpeg 2>&1`
+    `rm tmp/watermarked.jpeg 2>&1`
+    `rm tmp/tile_*.jpeg 2>&1`
+  end
+
+end
+=end
+# The main Photile driver
+class Photile
+
+  # Say hi to the world!
+  #
+  # Example:
+  #   >> Photile.hi("spanish")
+  #   => hola mundo
+  #
+  # Arguments:
+  #   language: (String)
+  def self.hi(language = "english")
+    translator = Translator.new(language)
+    puts translator.hi
+  end
+end
+
+require 'photile/translator'

data/lib/photile/translator.rb

@@ -0,0 +1,14 @@
+class Photile::Translator
+  def initialize(language)
+    @language = language
+  end
+
+  def hi
+    case @language
+    when "spanish"
+      "hola mundo"
+    else
+      "hello world"
+    end
+  end
+end

data/photile.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name                        = 'photile'
+  s.version                     = '0.1.0.pre'
+  s.date                        = '2012-11-02'
+  s.summary                     = 'A ruby gem to chop a photo into tiles, watermark them, etc.'
+  s.description                 = 'Photile is just a layer on top of Imagemagick and Jpegtran to make certain image processing tasks dead simple.'
+  s.author                      = 'Nitin Dhar'
+  s.email                       = 'nitindhar7@yahoo.com'
+  s.files                       = `git ls-files`.split("\n")
+  s.executables                 = ['photile']
+  s.bindir                      = 'bin'
+  s.license                     = 'MIT'
+  s.homepage                    = 'https://github.com/nitindhar7/photile'
+  s.add_development_dependency  'rake', ['>= 0.9.2']
+  s.required_ruby_version       = '>= 1.8.7'
+  s.requirements                << 'imagemagick' << 'imagemagick-common' << 'libjpeg-turbo-progs'
+end

data/test/test_photile.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require 'photile'
+
+class PhotileTest < Test::Unit::TestCase
+  def test_english_hello
+    assert_equal "hello world", Photile.hi("english")
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: photile
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Nitin Dhar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Photile is just a layer on top of Imagemagick and Jpegtran to make certain
+  image processing tasks dead simple.
+email: nitindhar7@yahoo.com
+executables:
+- photile
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/photile
+- lib/photile.rb
+- lib/photile/translator.rb
+- photile.gemspec
+- test/test_photile.rb
+homepage: https://github.com/nitindhar7/photile
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- imagemagick
+- imagemagick-common
+- libjpeg-turbo-progs
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A ruby gem to chop a photo into tiles, watermark them, etc.
+test_files: []