candy 0.2.6 → 0.2.7

data/HISTORY.markdown

@@ -3,6 +3,14 @@ Candy History
 
 This document aims to provide only an overview.  Further, we've only really been tracking things since **v0.2**.  For obsessive detail, just check out the `git log`.
 
+v0.2.7 - 2010-05-05 (the "yes, you MAY put your peanut butter in my chocolate" release)
+--------------------------------------------------------------------------------------
+Found and fixed a convoluted bug that was preventing embedded Candy objects from being saved properly. (It was treating them as _non_-Candy objects, which makes the world a gray and boring place.) While I was at it, refactored some methods and chipped away at some complexity.
+
+**MODERATELY BREAKING CHANGE ALERT:** I've renamed the `to_mongo` and `from_mongo` methods to `to_candy` and `from_candy`.  The initial reason for the _mongo_ names was for some vague semblance of compatibility with [MongoMapper](http://github.com/jnunemaker/mongomapper), but that doesn't make sense since we're treating serialized Candy objects completely differently and expecting them to unpack themselves. I seriously doubt anyone was using these methods yet, but just in case, now you know.
+
+* Fixed embedding bug on Candy objects
+
 v0.2.6 - 2010-05-03 (the "Spanish Fly" release)
 -----------------------------------------------
 Thanks to [xpaulbettsx](http://github.com/xpaulbettsx) for pointing out in issue \#4 that Candy was attempting to connect to localhost prematurely.  

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

data/candy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{candy}
-  s.version = "0.2.6"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2010-05-03}
+  s.date = %q{2010-05-05}
   s.description = %q{Candy provides simple, transparent object persistence for the MongoDB database.  Classes that 
 include Candy modules save all properties to Mongo automatically, can be recursively embedded,
 and can retrieve records with chainable open-ended class methods, eliminating the need for 

data/lib/candy.rb

@@ -11,13 +11,14 @@ module Candy
   autoload :Wrapper, 'candy/wrapper'
   autoload :Piece, 'candy/piece'
   autoload :Collection, 'candy/collection'
+  
+  # Special keys for Candy metadata in the Mongo store. We try to keep these to a minimum, 
+  # and we're using moderately obscure Unicode symbols to reduce the odds of collisions.
+  # If by some strange happenstance you might have single-character keys in your Mongo 
+  # collections that use the 'CIRCLED LATIN SMALL LETTER' Unicode set, you may need to
+  # change these constants.  Just be consistent about it if you want to use embedded
+  # documents in Candy.
+  CLASS_KEY = 'ⓒ'.to_sym
+  EMBED_KEY = 'ⓔ'.to_sym
 end
 
-# Special keys for Candy metadata in the Mongo store. We try to keep these to a minimum, 
-# and we're using moderately obscure Unicode symbols to reduce the odds of collisions.
-# If by some strange happenstance you might have single-character keys in your Mongo 
-# collections that use the 'CIRCLED LATIN SMALL LETTER' Unicode set, you may need to
-# change these constants.  Just be consistent about it if you want to use embedded
-# documents in Candy.
-CLASS_KEY = 'ⓒ'.to_sym
-EMBED_KEY = 'ⓔ'.to_sym

data/lib/candy/array.rb

@@ -26,7 +26,7 @@ module Candy
     # array in Mongo still matches our current state.  If concurrent updates have happened, you might end up
     # overwriting something other than what you thought.
     def []=(index, val)
-      property = embeddify(val)
+      property = candy_coat(@__candy_parent_key, val)
       @__candy_parent.set embedded(index => property)
       self.candy[index] = property
     end
@@ -38,7 +38,7 @@ module Candy
     
     # Appends a value to our array.  
     def <<(val)
-      property = embeddify(val)
+      property = candy_coat(@__candy_parent_key, val)
       @__candy_parent.operate :push, @__candy_parent_key => property
       self.candy << property
     end
@@ -56,7 +56,7 @@ module Candy
     def candy
       @__candy ||= []
     end
-    alias_method :to_mongo, :candy
+    alias_method :to_candy, :candy
     alias_method :to_ary, :candy
     
     # Array equality.

data/lib/candy/embeddable.rb

@@ -3,9 +3,9 @@ module Candy
   # Shared methods to create associations between top-level objects and embedded objects (hashes, 
   # arrays, or Candy::Pieces).
   module Embeddable
-    # Tells an embedded object whom it belongs to and what attribute it's associated with.  When
-    # its own state changes, it can use this information to update the parent.
-    def adopt(parent, attribute)
+    # Tells an embedded object about its parent.  When its own state changes, it can use this
+    # information to write home and update the parent.
+    def candy_adopt(parent, attribute)
       @__candy_parent = parent
       @__candy_parent_key = attribute
     end
@@ -18,16 +18,18 @@ module Candy
       new_fields
     end
   
-    # Convert hashes and arrays to CandyHashes and CandyArrays.
-    def embeddify(value)
-      case value
-      when CandyHash then value
-      when Hash then CandyHash.embed(value)
-      when CandyArray then value
-      when Array then CandyArray.embed(*value)   # Explode our array into separate arguments
-      else
-        value
-      end
+    # Convert hashes and arrays to CandyHashes and CandyArrays, and set the parent key for any Candy pieces.
+    def candy_coat(key, value)
+      piece = case value
+        when CandyHash then value
+        when Hash then CandyHash.embed(value)
+        when CandyArray then value
+        when Array then CandyArray.embed(*value)   # Explode our array into separate arguments
+        else
+          value
+        end
+      piece.candy_adopt(self, key) if piece.respond_to?(:candy_adopt)
+      piece
     end
   
   end

data/lib/candy/hash.rb

@@ -22,7 +22,7 @@ module Candy
   
     # Overrides the default behavior in Candy::Piece so that we DO NOT add our
     # class name to the saved values.
-    def to_mongo
+    def to_candy
       candy
     end
           

data/lib/candy/piece.rb

@@ -79,7 +79,7 @@ module Candy
       if args[-1].is_a?(Hash)
         data = args.pop
         if @__candy_id = data.delete('_id')  # We're an existing document
-          @__candy = self.from_mongo(Wrapper.unwrap(data))
+          @__candy = self.from_candy(Wrapper.unwrap(data))
         elsif data.delete(EMBED_KEY)  # We're being embedded: take any data, but don't save to Mongo
           @__candy = data
         else
@@ -134,14 +134,9 @@ module Candy
     # Hash-like setter.  Updates the object's internal state, and writes to the database if the state
     # has changed.  Keys should be passed in as symbols for best consistency with the database.
     def []=(key, value)
-      property = embeddify(value)
+      property = candy_coat(key, value) # Transform hashes and arrays, and communicate embedding
       candy[key] = property
-      if property.respond_to?(:to_mongo)
-        property.adopt(self, key)
-        set key => property.to_mongo
-      else
-        set key => property
-      end
+      set key => property
     end
     
     # Clears memoized data so that the next read pulls from the database.
@@ -170,14 +165,14 @@ module Candy
     
     # Converts the object into a hash for MongoDB storage.  Keep in mind that wrapping happens _after_
     # this stage, so it's best to use symbols for keys and leave internal arrays and hashes alone.
-    def to_mongo
+    def to_candy
       candy.merge(CLASS_KEY => self.class.name)
     end
     
     # A hoook for specific object classes to set their internal state using the hash passed in by
     # MongoDB.  If you override this method, delete any hash keys you need for your own purposes
     # and then call 'super' on the remainder.
-    def from_mongo(hash) 
+    def from_candy(hash) 
       hash
     end
     

data/lib/candy/wrapper.rb

@@ -27,6 +27,7 @@ module Candy
     def self.wrap(thing)
       # Pass the simple cases through
       return thing if BSON_SAFE.include?(thing.class)
+      thing = thing.to_candy if thing.respond_to?(:to_candy)  # Make it sweeter if it can be sweetened
       case thing
       when Array
         wrap_array(thing)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Stephen Eley
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-03 00:00:00 -04:00
+date: 2010-05-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency