couch_photo 0.0.1

data/README.markdown

@@ -0,0 +1,80 @@
+#Introduction
+
+A mixin for auto-generating image variations on Image documents with CouchDB.
+
+##Installation
+
+    $ gem install couch_photo
+
+## Documentation
+
+Browse the documentation on rdoc.info: http://rdoc.info/github/moonmaster9000/couch_photo
+
+##How does it work?
+
+Just "include CouchPhoto" in your "CouchRest::Model::Base" classes and define some variations.
+
+###Simple Variations
+
+Let's imagine we want to auto-generate small, medium, and large variations of our image everytime it gets updated.
+
+First, define an Image document and set the versions on it:
+
+    class Image < CouchRest::Model::Base
+      use_database IMAGE_DB
+      include CouchPhoto
+
+      override_id! # the id of the document will be the basename of the original image file
+
+      variations do
+        small "20x20"
+        medium "100x100"
+        large "500x500"
+      end
+    end
+
+Next, create an instance of the image document and set the "original" image on it.
+
+    i = Image.new
+    i.original "avatar.jpg"
+    i.save
+
+By calling the original method with a string, CouchPhoto will attempt to open a file with the same name and use that as the original image. If you don't have
+an actual file (e.g., maybe this was a form upload), then simply pass a blob as the second parameter. For example, 
+
+    blob = File.read "avatar.jpg"
+    i.original "avatar.jpg", blob
+
+Now, if you look in your image document in CouchDB, you'd see the following attachments:
+
+    http://your_couch_server/your_image_database/avatar.jpg/original.jpg
+    http://your_couch_server/your_image_database/avatar.jpg/variations/small.jpg
+    http://your_couch_server/your_image_database/avatar.jpg/variations/medium.jpg
+    http://your_couch_server/your_image_database/avatar.jpg/variations/large.jpg
+
+Notice that, because we called the `override_id!` method, `CouchPhoto` set the ID of your image document to the basename of your original image.
+
+###Complex Variations
+
+The previous variations were all simple image resizings. What if we wanted to do something a little more complex? Like grayscale the original image? Or create a watermark? No prob!
+
+    class Image < CouchRest::Model::Base
+      use_database IMAGE_DB
+      include CouchPhoto
+
+      override_id! # the id of the document will be the basename of the original image file
+
+      variations do
+        grayscale do |original_image|
+          original_image.monochrome
+        end
+
+        watermark do |original_image|
+          original_image.composite(MiniMagick::Image.open("watermark.png", "jpg") do |c|
+            c.gravity "center"
+          end
+        end
+      end
+    end
+
+The `original_image` variable in the blocks is simply the MiniMagick::Image instance of your original image.

data/lib/couch_photo.rb

@@ -0,0 +1,5 @@
+require 'mini_magick'
+require 'couchrest_model'
+require 'couch_photo/variations'
+require 'couch_photo/attachment'
+require 'couch_photo/couch_photo'

data/lib/couch_photo/attachment.rb

@@ -0,0 +1,9 @@
+module CouchPhoto
+  class Attachment #:nodoc:
+    attr_reader :read, :path
+    def initialize(data, path=nil)
+      @read = data
+      @path = nil
+    end
+  end
+end

data/lib/couch_photo/couch_photo.rb

@@ -0,0 +1,44 @@
+module CouchPhoto
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def original(filepath, blob=nil)
+    self["_id"] = File.basename filepath if self.class.override_id?
+    blob ||= File.read filepath
+    image_format = filepath.match(/^.*\.([^\.]*)$/)[1]
+    attachment_name = "original.#{image_format}"
+    attachment = {:name => attachment_name, :file => Attachment.new(blob, attachment_name)}
+    update_or_create_attachment attachment
+    self.class.variation_definitions.run_variations(blob).each do |variation_name, variation_blob|
+      update_or_create_attachment :name => "variations/#{variation_name}.#{image_format}", :file => Attachment.new(variation_blob, attachment_name) 
+    end
+  end
+  
+  def update_or_create_attachment(attachment)
+    if self.has_attachment? attachment[:name]
+      self.update_attachment attachment
+    else
+      self.create_attachment attachment
+    end
+  end
+
+  module ClassMethods
+    def variations(&block)
+      raise "You must pass a block to the `variations' method." unless block
+      variation_definitions.instance_eval(&block)
+    end
+
+    def variation_definitions
+      @variation_definitions ||= Variations.new
+    end
+    
+    def override_id!
+      @override_id = true
+    end
+
+    def override_id?
+      @override_id
+    end
+  end
+end

data/lib/couch_photo/variations.rb

@@ -0,0 +1,39 @@
+module CouchPhoto
+  class Variations
+    def initialize
+      @variations = {}
+    end
+
+    def method_missing(method_name, *args, &block)
+      if block
+        @variations[method_name.to_sym] = Variation.new method_name, *args, &block
+      else
+        @variations[method_name.to_sym] = Variation.new method_name, *args
+      end
+    end
+
+    def run_variations(blob)
+      results = {}
+      @variations.each do |variation_name, variation|
+        results[variation_name] = variation.create_variation blob
+      end
+      results
+    end
+  end
+
+  class Variation
+    def initialize(name, format=nil, &block)
+      raise "A variation can not have both a format and a block. Choose one." if format and block
+      raise "A variation must have either a format (e.g., '20x20>') or a block." if !format and !block
+      @name = name
+      @format = format
+      @block = block
+    end
+
+    def create_variation(blob)
+      image = MiniMagick::Image.read(blob)
+      @format ? image.resize(@format) : @block.call(image)
+      image.to_blob
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: couch_photo
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: couchrest_model
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -1848230057
+        segments: 
+        - 1
+        - 0
+        - 0
+        - beta7
+        version: 1.0.0.beta7
+  type: :runtime
+  version_requirements: *id001
+description: Automatically create image variations on your CouchDB image documents.
+email: moonmaster9000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- lib/couch_photo.rb
+- lib/couch_photo/attachment.rb
+- lib/couch_photo/couch_photo.rb
+- lib/couch_photo/variations.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/moonmaster9000/couch_photo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mixin for CouchDB/couchrest_model image models.
+test_files: []
+