couch_photo 0.0.5 → 0.0.6

data/README.markdown

@@ -116,13 +116,19 @@ Let's go back to our original image example:
     i.save
 
 We can access our variations in one of three ways: 
-- the `variations` method, which returns an array of all of our variations
+- the `variations` method, which will allow you to iterate over the variation_name/variation pairs via the `each` method
 - the `variation.<variation_name>` method, which returns a specific variation
 - the `variation("<variation_name>")`, which also returns a specific variation
 
 For example: 
   
-    i.variations
+    i.variations.each do |variation_name, variation_image|
+      puts variation_name
+      puts variation.name
+      puts variation.filename
+      # etc...
+    end
+    
     i.variation.small
     i.variation "large"
 
@@ -135,3 +141,41 @@ Once you've got a variation, you can call several methods on it:
     i.variation.small.filetype # ==> "jpg"
     i.variation.small.mimetype # ==> "image/jpg"
     i.variation.small.data # ==> BINARY BLOB
+
+## Creating Custom Variations
+
+If you'd like to add a variation to your image document that's not predefined / autogenerated, you can use the add_variation method:
+
+    i = Image.new
+    i.original = "somefile.jpg"
+    i.add_variation "variation_name.jpg", :file => "filename.jpg"
+    i.add_variation "variation/name.jpg", :blob => File.read("filename.jpg")
+
+These images would be accessible via the following urls :
+
+    http://your_couch_server/your_image_database/somefile.jpg/original.jpg
+    http://your_couch_server/your_image_database/somefile.jpg/variations/variation_name.jpg
+    http://your_couch_server/your_image_database/somefile.jpg/variations/variation/name.jpg
+    
+## XMP Metadata
+Need to access XMP Metadata?  It's as simple as adding xmp_metadata! into your document definition.
+
+    class Image < CouchRest::Model::Base
+      use_database IMAGE_DB
+      include CouchPhoto
+
+      xmp_metadata!
+      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
+  
+    i = Image.new
+    i.original = "avatar.jpg"
+    i.save
+  
+Now you can access your image's XMP metadata by calling i.metadata.

data/VERSION

@@ -0,0 +1 @@
+0.0.6

data/couch_photo.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = "couch_photo"
+  s.version     = File.read "VERSION"
+  s.authors     = "Matt Parker"
+  s.homepage    = "http://github.com/moonmaster9000/couch_photo"
+  s.summary     = "A handy Ruby mixin for managing images in CouchDB / couchrest_model"
+  s.description = "Manage an image and all of its variations and xmp metadata in a single document."
+  s.email       = "moonmaster9000@gmail.com"
+  s.files       = Dir["lib/**/*"] << "VERSION" << "README.markdown" << "couch_photo.gemspec"
+  s.test_files  = Dir["feature/**/*"]
+
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "couchrest_model_config"
+  
+  s.add_dependency             "couchrest",       "1.0.1"
+  s.add_dependency             "mini_magick"
+  s.add_dependency             "couchrest_model", "~> 1.0.0"
+end

data/lib/couch_photo/couch_photo.rb

@@ -13,8 +13,7 @@ module CouchPhoto
   end
 
   def variations
-    @variations ||= Variations.new self 
-    @variations.variations.values
+    @variations = Variations.new self 
   end
 
   def original
@@ -27,15 +26,30 @@ module CouchPhoto
   end
 
   def variation(variation_name=nil)
-    variation_name ? @variations.send(variation_name) : @variations
+    variation_name ? variations.send(variation_name) : variations
   end
 
   def original=(*args)#filepath, blob=nil
-    filepath, blob = args[0], args[1]
-    self["_id"] = File.basename filepath if self.class.override_id?
-    self.original_filename = File.basename filepath
+    if args[0].kind_of?(Array)
+      filepath, blob = args[0].first, args[0].last
+    else
+      filepath = args[0]
+      blob = nil
+    end
+    image_format = filetype(filepath)
+    filename = File.basename filepath
+    basename = File.basename(filepath, "." + "#{image_format}")
+
+    if self.class.xmp_metadata?
+      File.open(filepath, 'w') { |f| f.write blob } if !blob.nil?
+      `convert #{filepath} /tmp/#{basename}.xmp`
+      self.metadata = Hash.from_xml File.read("/tmp/#{basename}.xmp")
+      File.delete("/tmp/#{basename}.xmp")
+    end
+
+    self["_id"] = filename if self.class.override_id?
+    self.original_filename = filename
     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
@@ -43,6 +57,20 @@ module CouchPhoto
       update_or_create_attachment :name => "variations/#{variation_name}.#{image_format}", :file => Attachment.new(variation_blob, attachment_name) 
     end
   end
+  
+  def add_variation(variation_name, opt={})
+    if opt[:file]
+      blob = File.read("#{opt[:file]}")
+    elsif opt[:blob]
+      blob = opt[:blob]
+    end
+    update_or_create_attachment :name => "variations/#{variation_name}", :file => Attachment.new(blob, variation_name)
+    variations.add_variation variation_name
+  end
+  
+  def filetype(filename)
+    filename.match(/^.*\.([^\.]*)$/)[1]
+  end
 
   module ClassMethods
     def variations(&block)
@@ -53,6 +81,15 @@ module CouchPhoto
     def override_id!
       @override_id = true
     end
+    
+    def xmp_metadata!
+      @xmp_metadata = true
+      self.property :metadata, Hash
+    end
+    
+    def xmp_metadata?
+      @xmp_metadata
+    end
 
     def override_id?
       @override_id
@@ -62,4 +99,17 @@ module CouchPhoto
       @variation_definitions ||= VariationDefinitions.new
     end
   end
+  
+  module_function
+  def variation_short_name(variation_path)
+    variation_path.gsub(/(?:variations\/)?(.+)\.[^\.]+/) {$1}
+  end
+  
+  def variation_short_name_from_path(variation_path)
+    variation_path.gsub(/(?:variations\/)?(.+)/) {$1}
+  end
+  
+  def variation_file_extension(variation_path)
+    variation_path.gsub(/(?:variations\/)?.+\.([^\.]+)/) {$1}
+  end
 end

data/lib/couch_photo/variations.rb

@@ -1,5 +1,9 @@
 module CouchPhoto
+
+  
   class VariationDefinitions
+    attr_reader :variations
+    
     def initialize
       @variations = {}
     end
@@ -38,21 +42,39 @@ module CouchPhoto
   end
 
   class Variations
-    attr_reader :variations
+    attr_reader :variations, :document
 
     def initialize(document)
+      @document = document
       @variations = {}
       attachments = document["_attachments"] || {}
       attachments.keys.select {|name| name.match /variations\//}.each do |variation_name|
-        variation_short_name = variation_name.gsub(/variations\/(.+)\.[^\.]+/) {$1}
-        @variations[variation_short_name] = Variation.new document, variation_name
+        if document.class.variation_definitions.variations.keys.include?(CouchPhoto.variation_short_name(variation_name).to_sym)
+          variation_key = CouchPhoto.variation_short_name(variation_name)
+        else
+          variation_key = CouchPhoto.variation_short_name_from_path(variation_name)
+        end
+        @variations[variation_key] = Variation.new document, variation_name
       end
     end
+    
+    def each(&block)
+      @variations.each &block
+    end
+    
+    def count
+      attachments = self.document["_attachments"] || {}
+      attachments.keys.count {|name| name.match /variations\//}
+    end
 
     def method_missing(method_name, *args, &block)
       raise "Unknown variation '#{method_name}'" unless @variations[method_name.to_s]
       @variations[method_name.to_s]
     end
+    
+    def add_variation(variation_name)
+      @variations[variation_name] = Variation.new document, "variations/#{variation_name}"
+    end
   end
 
   class Variation
@@ -62,11 +84,11 @@ module CouchPhoto
       @path = "/" + [document.database.name, document.id, attachment_name].join("/")
       @url = [document.database.to_s, document.id, attachment_name].join "/"
       @attachment_name = attachment_name
-      @name = attachment_name.gsub(/(?:variations\/)?(.+)\.[^\.]+/) {$1}
+      @name = CouchPhoto.variation_short_name attachment_name
       @filename = attachment_name
       @basename = File.basename attachment_name 
       @document = document
-      @filetype = attachment_name.gsub(/(?:variations\/)?.+\.([^\.]+)/) {$1}
+      @filetype = CouchPhoto.variation_file_extension attachment_name
       @mimetype = document["_attachments"][attachment_name]["content_type"]
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couch_photo
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,55 +15,112 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-18 00:00:00 -05:00
-default_executable: 
+date: 2011-09-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: couchrest_model
+  name: cucumber
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
-        - 1
         - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: couchrest_model_config
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
         - 0
-        version: 1.0.0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: couchrest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: mini_magick
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: couchrest_model
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 23
         segments: 
-        - 3
         - 1
-        version: "3.1"
+        - 0
+        - 0
+        version: 1.0.0
   type: :runtime
-  version_requirements: *id002
-description: Automatically create image variations on your CouchDB image documents.
+  version_requirements: *id006
+description: Manage an image and all of its variations and xmp metadata in a single document.
 email: moonmaster9000@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- lib/couch_photo.rb
 - lib/couch_photo/attachment.rb
 - lib/couch_photo/couch_photo.rb
 - lib/couch_photo/variations.rb
+- lib/couch_photo.rb
+- VERSION
 - README.markdown
-has_rdoc: true
+- couch_photo.gemspec
 homepage: http://github.com/moonmaster9000/couch_photo
 licenses: []
 
@@ -93,9 +150,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Mixin for CouchDB/couchrest_model image models.
+summary: A handy Ruby mixin for managing images in CouchDB / couchrest_model
 test_files: []