candy 0.2.9 → 0.2.10

data/HISTORY.markdown

@@ -3,6 +3,16 @@ 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.10 - 2010-06-10 (the "This is not my beautiful hash" release)
+------------------------------------------------------------------
+Made arrays enumerable finally (thanks to dominikh with issue #13) and added some vital hash methods to Piece that I needed.
+
+**NOTE:** I've been slow on updates the past few weeks. It's because I got a crazy new idea on how to interface with the Mongo parts (the "Candy::Crunch" part of this gem) and I've been spending my free dev time playing with that. It might take a bit longer, but if I can get it to work, the non-driver parts of Candy will be both simpler and more incredible. Ping me if you want to know more about what I'm babbling about.
+
+* Fixed Github issue #13
+* Added Piece#keys and Piece#values
+
+
 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 

data/VERSION

@@ -1 +1 @@
-0.2.9
+0.2.10

data/candy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{candy}
-  s.version = "0.2.9"
+  s.version = "0.2.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2010-05-14}
+  s.date = %q{2010-06-10}
   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 
@@ -33,6 +33,7 @@ method calls like 'save' and 'find.'
      "lib/candy/array.rb",
      "lib/candy/collection.rb",
      "lib/candy/crunch.rb",
+     "lib/candy/crunch/document.rb",
      "lib/candy/embeddable.rb",
      "lib/candy/exceptions.rb",
      "lib/candy/factory.rb",
@@ -56,7 +57,7 @@ method calls like 'save' and 'find.'
   s.homepage = %q{http://github.com/SFEley/candy}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Transparent persistence for MongoDB}
   s.test_files = [
     "spec/candy/array_spec.rb",
@@ -75,7 +76,7 @@ method calls like 'save' and 'find.'
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<bson>, [">= 0.20.1"])
       s.add_runtime_dependency(%q<bson_ext>, [">= 0.20.1"])
       s.add_runtime_dependency(%q<mongo>, [">= 0.20.1"])

data/lib/candy/array.rb

@@ -9,6 +9,7 @@ module Candy
   class CandyArray
     include Crunch
     include Embeddable
+    include Enumerable
     
     # Creates the object with parent and attribute values set properly on the object and any children.
     def self.embed(parent, attribute, *args)
@@ -36,6 +37,11 @@ module Candy
       candy[index]
     end
     
+    # Iterates over each value in turn, so that we can have proper Enumerable support
+    def each(&block)
+      candy.each(&block)
+    end
+    
     # Appends a value to our array.  
     def <<(val)
       property = candy_coat(@__candy_parent_key, val)

data/lib/candy/crunch.rb

@@ -96,6 +96,8 @@ module Candy
   
   # All of the hard crunchy bits that connect us to a collection within a Mongo database.
   module Crunch
+    autoload :Document, 'candy/crunch/document'
+    
     module ClassMethods
             
       # Returns the connection you gave, or uses the application-level Candy collection.
@@ -227,59 +229,6 @@ module Candy
       @__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)

data/lib/candy/crunch/document.rb

@@ -0,0 +1,62 @@
+module Candy
+  module Crunch
+    
+    # MongoDB interface methods specific to the handling of individual documents (as opposed to collections or cursors).
+    module Document
+      ### 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
+      
+    end
+  end
+end

data/lib/candy/hash.rb

@@ -2,7 +2,7 @@ require 'candy/piece'
 
 module Candy
   
-  # A subclass of Hash that behaves like a Candy::Piece.  This class has two major uses:
+  # An untyped hash that behaves like a Candy::Piece.  This class has two major uses:
   #
   # * It's a convenient starting point if you just want to store a bunch of data in Mongo
   #   and don't need to implement any business logic in your own classes; and
@@ -13,13 +13,12 @@ module Candy
   # If you don't tell them otherwise, top-level CandyHash objects store themselves in
   # the 'candy' collection.  You can change that at any time by setting a different
   # collection at the class or object level.
-  class CandyHash < Hash
+  class CandyHash
     include Crunch
     include Piece
     
     self.collection = 'candy'
     
-  
     # Overrides the default behavior in Candy::Piece so that we DO NOT add our
     # class name to the saved values.
     def to_candy

data/lib/candy/piece.rb

@@ -78,6 +78,7 @@ module Candy
     
     # HERE STARTETH THE MODULE PROPER.  (The above are the class methods.)
     include Crunch
+    include Crunch::Document
     include Embeddable
     
     
@@ -148,6 +149,15 @@ module Candy
       self
     end
     
+    # Returns the keys we've stored.
+    def keys
+      candy.keys
+    end
+    
+    # Returns the values we've stored.
+    def values
+      candy.values
+    end
     
     # Convenience method for debugging.  Shows the class, the Mongo ID, and the saved state hash.
     def to_s

data/spec/candy/array_spec.rb

@@ -51,6 +51,14 @@ describe Candy::CandyArray do
       @this.bits[3].should == 'schadenfreude'
     end
 
+    it "is enumerable" do
+      @this.bits.map{|b| b.upcase}.should == ['PEANUT', 'ALMONDS', 'TITANIUM']
+    end
+    
+    it "is sortable" do
+      @this.bits.sort.should == ['almonds', 'peanut', 'titanium']
+    end
+    
     after(:each) do
       Zagnut.collection.remove
     end

data/spec/candy/hash_spec.rb

@@ -17,7 +17,11 @@ describe Candy::CandyHash do
   it "reads the hash" do
     that = Zagnut(@this.id)
     that.filling.taste.should == 'caramel'
-    that.filling.should be_a(Hash)
+  end
+  
+  it "reads the hash with brackets" do
+    that = Zagnut(@this.id)
+    that[:filling][:taste].should == 'caramel'
   end
   
   it "cascades changes" do

data/spec/candy/piece_spec.rb

@@ -229,6 +229,16 @@ describe Candy::Piece do
       @verifier.find_one(ounces: 12)["crunchy"].should == :very
     end
     
+    
+    it "knows its keys" do
+      @this.keys.should == [:ounces, :crunchy]
+    end
+
+    it "knows its values" do
+      @this.values.should == [17, :very]
+    end
+
+    
   end
   
   describe "embedding" do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: candy
 version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 2
-  - 9
-  version: 0.2.9
+  - 10
+  version: 0.2.10
 platform: ruby
 authors: 
 - Stephen Eley
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 -04:00
+date: 2010-06-10 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bson
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 77
         segments: 
         - 0
         - 20
@@ -35,9 +38,11 @@ dependencies:
   name: bson_ext
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 77
         segments: 
         - 0
         - 20
@@ -49,9 +54,11 @@ dependencies:
   name: mongo
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 77
         segments: 
         - 0
         - 20
@@ -63,9 +70,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -77,9 +86,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
@@ -114,6 +125,7 @@ files:
 - lib/candy/array.rb
 - lib/candy/collection.rb
 - lib/candy/crunch.rb
+- lib/candy/crunch/document.rb
 - lib/candy/embeddable.rb
 - lib/candy/exceptions.rb
 - lib/candy/factory.rb
@@ -143,23 +155,27 @@ 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.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Transparent persistence for MongoDB