candy 0.2.8 → 0.2.9

data/HISTORY.markdown

@@ -3,6 +3,17 @@ 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.9 - 2010-05-14 (the "+1" release)
+--------------------------------------
+Moved methods around again, placing more of the database update methods into Candy::Crunch.  Also began support for two flavors of 
+atomic update methods:
+
+1. _Safe_ methods that call the collection in "safe" mode, meaning that it's much slower but the update is verified and exceptions are returned by the Mongo driver.  These methods also return the new values.  So far supported are **set** and **inc**.
+2. _Unsafe_ or _bang!_ methods that call the collection in "unsafe" mode, for maximum speed but without verification or new values returned.  So far supported are **set!** and **inc!**.
+
+* Refactored; added 'bang!' methods for atomic updates
+
+
 v0.2.8 - 2010-05-13 (the "Holy crap, that was ten pomodoros" release)
 ---------------------------------------------------------------------
 Major refactoring to fix a major bug: embedded documents weren't being loaded properly on document retrieval.  This resulted in a lot of code being moved around, and some regrettable circular connascence between Piece and Wrapper that I hope to address later.  Overall, though, it's simpler now.

data/README.markdown

@@ -29,7 +29,7 @@ We got 'em.  Candy pieces can contain each other recursively, to any arbitrary d
                      seafood: 'Maryland blue crabs',
                      scotch: ['Glenmorangie Port Wood Finish',
                               'Balvenie Single Barrel']}
-    me.spouse = Person.embed(first_name: 'Anna', eyes: :blue)
+    me.spouse = Person.piece(first_name: 'Anna', eyes: :blue)
     me.spouse.eyes            # => :blue
     me.favorites.scotch[1]    # => 'Balvenie Single Barrel'
                               

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.2.9

data/candy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{candy}
-  s.version = "0.2.8"
+  s.version = "0.2.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2010-05-13}
+  s.date = %q{2010-05-14}
   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/array.rb

@@ -48,7 +48,7 @@ module Candy
     # (Thus supporting real-time concurrency for queue-like behavior.)
     def shift(n=1)
       doc = @__candy_parent.collection.find_and_modify query: {"_id" => @__candy_parent.id}, update: {'$pop' => {@__candy_parent_key => -1}}, new: false
-      @__candy = doc[@__candy_parent_key.to_s]
+      @__candy = from_candy(doc[@__candy_parent_key.to_s])
       @__candy.shift
     end
     

data/lib/candy/crunch.rb

@@ -212,18 +212,75 @@ module Candy
 
     end
     
+    # HERE BEGINNETH THE MODULE PROPER.
+    # (The above were class methods.)
     
-    # We're implementing FindAndModify on Mongo 1.4 until the Ruby driver gets around to being updated...
-    def findAndModify(query, update, sort={})
-      command = OrderedHash[
-        findandmodify: self.collection.name,
-        query: query,
-        update: update,
-        sort: sort
-      ]
-      result = self.class.db.command(command)
+    # The MongoDB collection object that everything saves to.  Defaults to the class's
+    # collection, which in turn defaults to the classname.
+    def collection
+      @__candy_collection ||= self.class.collection
+    end
+    
+    # This is normally set at the class level (with a default of the classname) but you
+    # can override it on a per-object basis if you need to.
+    def collection=(val)
+      @__candy_collection = val
+    end
+    
+    ### RETRIEVAL METHODS
+    # Returns the listed fields of the document. If no fields are given, returns the whole document.
+    def retrieve(*fields)
+      options = (fields.empty? ? {} : {fields: fields})
+      from_candy(collection.find_one({'_id' => id}, options)) if id
+    end
+    
+    
+    # A generic updater that performs the atomic operation specified on a value nested arbitrarily deeply.
+    # Operates in "unsafe" mode, meaning that no document errors will be returned and results are not 
+    # guaranteed.  The benefit is that it's very, very fast.  Always returns true.
+    def operate!(operator, fields)
+      operate operator, fields, {safe: false} and true
+    end
+    
+    # A generic updater that performs the atomic operation specified on a value nested arbitrarily deeply.
+    # 
+    def operate(operator, fields, options={safe: true})
+      if @__candy_parent
+        @__candy_parent.operate operator, embedded(fields), options
+      else
+        @__candy_id = collection.insert({}) unless id   # Ensure we have something to update
+        collection.update({'_id' => id}, {"$#{operator}" => Wrapper.wrap(fields)}, options)
+      end
+    end
+
+    # Given a hash of property/value pairs, sets those values in Mongo using the atomic $set if
+    # we have a document ID.  Otherwise inserts them and sets the object's ID.  Operates in 
+    # 'unsafe' mode, so database exceptions are not reported but updates are very fast.
+    def set!(fields)
+      operate! :set, fields
     end
 
+    # Given a hash of property/value pairs, sets those values in Mongo using the atomic $set if
+    # we have a document ID.  Otherwise inserts them and sets the object's ID.  Returns the 
+    # values passed to it.
+    def set(fields)
+      operate :set, fields
+      fields
+    end
+    
+    # Increments the specified field by the specified amount (defaults to 1). Does not return the 
+    # new value or any document errors.
+    def inc!(field, value=1)
+      operate! :inc, field: value
+    end
+
+    # Increments the specified field by the specified amount (defaults to 1) and returns the 
+    # new value.
+    def inc(field, value=1)
+      operate :inc, field => value
+      retrieve(field)[field]
+    end
+    
     
     def self.included(receiver)
       receiver.extend         ClassMethods

data/lib/candy/piece.rb

@@ -101,16 +101,11 @@ module Candy
     def id
       @__candy_id
     end
-    
-    # Pull our document from the database if we know our ID.
-    def retrieve_document
-      from_candy(collection.find_one({'_id' => id})) if id
-    end
-    
+        
     
     # Returns the hash of memoized values.
     def candy
-      @__candy ||= retrieve_document || {}
+      @__candy ||= retrieve || {}
     end
     
     # Objects are equal if they point to the same MongoDB record (unless both have IDs of nil, in which case 
@@ -153,17 +148,6 @@ module Candy
       self
     end
     
-    # The MongoDB collection object that everything saves to.  Defaults to the class's
-    # collection, which in turn defaults to the classname.
-    def collection
-      @__candy_collection ||= self.class.collection
-    end
-    
-    # This is normally set at the class level (with a default of the classname) but you
-    # can override it on a per-object basis if you need to.
-    def collection=(val)
-      @__candy_collection = val
-    end
     
     # Convenience method for debugging.  Shows the class, the Mongo ID, and the saved state hash.
     def to_s
@@ -189,22 +173,6 @@ module Candy
     end
     
     
-    # Given a hash of property/value pairs, sets those values in Mongo using the atomic $set if
-    # we have a document ID.  Otherwise inserts them and sets the object's ID. 
-    def set(fields)
-      operate :set, fields
-    end
-    
-    # A generic updater that performs the atomic operation specified on a value nested arbitrarily deeply.
-    # 
-    def operate(operator, fields)
-      if @__candy_parent
-        @__candy_parent.operate operator, embedded(fields)
-      else
-        @__candy_id = collection.insert({}) unless id   # Ensure we have something to update
-        collection.update({'_id' => id}, {"$#{operator}" => Wrapper.wrap(fields)})
-      end
-    end
   
   private
         

data/spec/candy/piece_spec.rb

@@ -141,6 +141,14 @@ describe Candy::Piece do
       that.intensity.should == :Yowza
     end
     
+    it "can get particular attributes" do
+      @this.smell = "fruity"
+      @this.feel = "rough"
+      that = Zagnut(@this.id)
+      that.retrieve(:smell)[:smell].should == "fruity" 
+      that.retrieve(:smell).should_not have_key(:feel)
+    end
+    
     # Test class for scoped magic method generation
     class BabyRuth
       include Candy::Piece
@@ -205,6 +213,22 @@ describe Candy::Piece do
       @verifier.count.should == 3
       Zagnut.crunchy(:not_quite).color.should == 'brown'
     end
+    
+    it "can increment a value simply" do
+      @this.inc(:ounces).should == 18
+      @verifier.find_one(ounces: 18)["crunchy"].should == :very
+    end
+    
+    it "can increment a value by a specified positive amount" do
+      @this.inc(:ounces, 5).should == 22
+      @verifier.find_one(ounces: 22)["crunchy"].should == :very
+    end
+    
+    it "can increment a value by a specified negative amount" do
+      @this.inc(:ounces, -5).should == 12
+      @verifier.find_one(ounces: 12)["crunchy"].should == :very
+    end
+    
   end
   
   describe "embedding" do

data/spec/candy/wrapper_spec.rb

@@ -175,7 +175,6 @@ module Candy
         hash = {"foo" => :bar, "'missile'" => @wrapped}
         unwrapped = Wrapper.unwrap(hash)
         unwrapped[:foo].should == :bar
-        puts unwrapped
         unwrapped["missile"].should be_a(Missile)
       end
     

metadata

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