photile 0.1.5 → 0.1.6

data/README.md

@@ -1,9 +1,5 @@
 # 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`.
@@ -31,44 +27,43 @@ Usage: photile [options] infile outfile
     -h, --help                       Display options help
 
 # 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
+$ 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
 
 # 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
+$ 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
+$ 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
+# 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 QUALITY --compress --watermark image-watermark --tile WIDTHxHEIGHT image-in image-out
 ```
 
 ### Features
 
-* 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]`
+* Quality manipulation: `IMAGE` → `Quality Modifier` → `IMAGE`
+* Loss-less compression: `IMAGE` → `Compressor` → `IMAGE`
+* Watermarking: `IMAGE` + `WATERMARK IMAGE`  → `Watermarker` → `IMAGE`
+* Tiling: `IMAGE` → `Tiler` → `[IMAGE...IMAGE]`
 
-### More
+### Moreoe
 
 Photile uses the amazing [Imagemagick](http://www.imagemagick.org/script/index.php) 6.6.9-7 and [Jpegtran](http://jpegclub.org/jpegtran/) 1.2.0 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.
 
+### TODO
+
+- CLI option to show version
+- File validation for infile/outfile
+- More unit tests to ensure that all pipe permutations work
+
 * * *
 Copyright (c) 2013 Nitin Dhar. See [MIT-LICENSE](MIT-LICENSE) for details.

data/Rakefile

@@ -30,5 +30,5 @@ end
 
 desc "Cleans generated files"
 task :clean do
-  `rm tmp/test*.jpeg 2>&1`
+  `rm tmp/test*.jpg 2>&1`
 end

data/lib/photile.rb

@@ -1,4 +1,5 @@
 class Photile
+  VERSION = "0.1.6"
 end
 
 require 'photile/cli'

data/lib/photile/cli.rb

@@ -24,8 +24,13 @@ class Photile::Cli
         options << {:tile => {:width => dim.first.to_i, :height => dim.last.to_i}}
       end
 
+      opts.on('-v', '--[no-]verbose', 'Run verbosely') do |value|
+        options << {:verbose => value}
+      end
+
       opts.on('-h', '--help', 'Display options help') do
         puts opts
+        puts 'photile requires the following libraries to be installed: imagemagick, imagemagick-common and libjpeg-turbo-progs'
         exit
       end
     end
@@ -35,12 +40,17 @@ class Photile::Cli
 
       if options.empty? || ARGV.size != 2
         puts optparse
+        puts 'photile requires the following libraries to be installed: imagemagick, imagemagick-common and libjpeg-turbo-progs'
         exit
       end
 
       {:options => options, :infile => ARGV.first, :outfile => ARGV.last}
     rescue OptionParser::InvalidArgument => ia
-      puts ia
+      puts 'Invalid argument'
+      puts optparse
+      exit
+    rescue OptionParser::InvalidOption => io
+      puts 'Invalid option'
       puts optparse
       exit
     end

data/photile.gemspec

@@ -1,6 +1,9 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "photile"
+
 Gem::Specification.new do |s|
   s.name                        = 'photile'
-  s.version                     = `git describe`
+  s.version                     = Photile::VERSION
   s.date                        = Time.now.strftime("%Y-%m-%d")
   s.summary                     = 'A ruby gem to compress a photo, chop it into tiles, watermark it, etc.'
   s.description                 = 'Photile is just a layer on top of Imagemagick and Jpegtran to make certain image processing tasks dead simple.'
@@ -14,4 +17,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency  'rake', ['>= 0.8.7']
   s.required_ruby_version       = '>= 1.8.7'
   s.requirements                << 'imagemagick' << 'imagemagick-common' << 'libjpeg-turbo-progs'
-end
+end

data/test/{test_photile.rb → test_requirements.rb}

@@ -1,7 +1,7 @@
 require 'test/unit'
 require 'photile'
 
-class PhotileTest < Test::Unit::TestCase
+class RequirementsTest < Test::Unit::TestCase
   def test_requirements
     assert_not_nil `which convert`
     assert_not_nil `which composite`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: photile
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -43,7 +43,7 @@ files:
 - lib/photile.rb
 - lib/photile/cli.rb
 - photile.gemspec
-- test/test_photile.rb
+- test/test_requirements.rb
 homepage: https://github.com/nitindhar7/photile
 licenses:
 - MIT