mongo_odm 0.2.6 → 0.2.7

data/CONTRIBUTORS

@@ -1,4 +1,5 @@
 Steve Sloan
 
-* Config class, railtie to load config from YAML file
-* Timestamps module
+  * Config class, railtie to load config from YAML file
+  * Timestamps module
+  * BSON::DBRef ideas

data/Gemfile.lock

@@ -1,20 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.4.2)
     activemodel (3.0.4)
       activesupport (= 3.0.4)
       builder (~> 2.1.2)
       i18n (~> 0.4)
     activesupport (3.0.4)
-    archive-tar-minitar (0.5.2)
-    autotest (4.4.6)
-      ZenTest (>= 4.4.1)
     bson (1.2.2)
     bson_ext (1.2.2)
     builder (2.1.2)
-    columnize (0.3.2)
-    database_cleaner (0.6.3)
     diff-lcs (1.1.2)
     git (1.2.5)
     i18n (0.5.0)
@@ -22,8 +16,6 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    linecache19 (0.5.11)
-      ruby_core_source (>= 0.1.4)
     mongo (1.2.2)
       bson (>= 1.2.2)
     rake (0.8.7)
@@ -36,16 +28,6 @@ GEM
     rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.4.0)
-    ruby-debug-base19 (0.11.24)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.4)
-      archive-tar-minitar (>= 0.5.2)
     tzinfo (0.3.24)
     watchr (0.7)
     yard (0.6.4)
@@ -56,14 +38,11 @@ PLATFORMS
 DEPENDENCIES
   activemodel (~> 3.0.4)
   activesupport (~> 3.0.4)
-  autotest
   bson_ext (~> 1.2.2)
-  database_cleaner
   jeweler (~> 1.5.2)
   mongo (~> 1.2.2)
   rcov (~> 0.9.9)
   rspec (= 2.4.0)
-  ruby-debug19
   tzinfo (~> 0.3.24)
   watchr (~> 0.7)
   yard (~> 0.6.4)

data/README.rdoc

@@ -105,6 +105,33 @@ Alternatively, you can pass a MongoODM::Collection instance to set_collection, t
     set_collection MongoODM::Collection.new(MongoODM.connection.db('another_database'), 'my_shapes')
   end
 
+= References
+
+You can use BSON::DBRef as the type of a field. This acts as a pointer to any other document in your database, at any collection. If you assign a MongoODM::Document instance to a BSON::DBRef field, it will be converted to a reference automatically. To instantiate any reference object, just call "dereference" on it. To convert any MongoODM::Document object to a reference, just call "to_dbref" on it.
+
+You can even dereference a full array or hash that contains BSON::DBRef instances! It will dereference them at any level.
+
+  class Node
+    include MongoODM::Document
+    field :name
+    field :parent, BSON::DBRef
+    field :children, Array
+  end
+  
+  root_node = Node.new(:name => 'root')
+  root_node.save
+  children1 = Node.new(:name => 'children1', :parent => root_node)
+  children1.save
+  root_node.children = [children1.to_dbref]
+  root_node.save
+
+  children1.parent   # Returns BSON::DBRef(namespace:"nodes", id: "4d60e8c83f5f19cf08000001")
+  root_node.children # Returns [BSON::DBRef(namespace:"nodes", id: "4d60e8c83f5f19cf08000002")]
+
+  children1.parent.dereference # Returns #<Node _id: BSON::ObjectId('4d60e8c83f5f19cf08000001'), children: [BSON::DBRef(namespace:"nodes", id: "4d60e8c83f5f19cf08000002")], name: "root", parent: nil>
+
+  root_node.children.dereference # Returns [#<Node _id: BSON::ObjectId('4d60e8c83f5f19cf08000002'), children: nil, name: "children1", parent: BSON::DBRef(namespace:"nodes", id: "4d60e8c83f5f19cf08000001")>]
+
 = Associations
 
 To embed just one copy of another class, just define the field type of that class. The class just need to respond to the "type_cast" class method and the "to_mongo" instance method. Example:
@@ -234,7 +261,65 @@ If you want to save a collection of objects, just define the field as an Array.
   # #<Draw objects: [#<Circle x: 1.0, y: 1.0, color: nil, radius: 10.0>, #<Line x: 0.0, y: 0.0, color: nil, dx: 10.0, dy: 5.0>, #<Circle x: 2.0, y: 2.0, color: nil, radius: 20.0>], _id: {"$oid"=>"4bf0775d715dd2725a000001"}>
 
 
-To reference the associated objects instead of embed them, for now you need to define your own methods. Example:
+To reference the associated objects instead of embed them, you can use BSON::DBRef (to reference one), Array (to reference several), and others:
+
+  class Flag
+    include MongoODM::Document
+    field :colors_refs, Array, :default => []
+    
+    def add_color(color)
+      colors_refs << color.to_dbref
+    end
+    
+    def colors
+      colors_refs.dereference
+    end
+  end
+
+  class Color
+    include MongoODM::Document
+    field :name
+  end
+
+  color_red = Color.new(:name => "red")
+  color_red.save
+  color_green = Color.new(:name => "green")
+  color_green.save
+
+  flag = Flag.new
+  flag.add_color(color_red)
+  flag.add_color(color_green)
+  flag.save
+
+  # Saves:
+  # { "_id"         : ObjectId("4be96c15715dd2c4be000003"),
+  #   "_class"      : "Flag",
+  #   "colors_refs" : [ 
+  #                     { "$ns" : "colors",
+  #                       "$id" : { 
+  #                         "$oid" : "4d60ea4e3f5f19cf10000001"
+  #                        }
+  #                     },
+  #                     { "$ns" : "colors",
+  #                       "$id" : {
+  #                         "$oid" : "4d60ea4e3f5f19cf10000002"
+  #                       }
+  #                     } 
+  #                   ]
+  # }
+  
+  flag.colors # Returns [#<Color _id: BSON::ObjectId('4d60ea4e3f5f19cf10000001'), name: "red">, #<Color _id: BSON::ObjectId('4d60ea4e3f5f19cf10000002'), name: "green">]
+  
+  flag.colors
+  
+  # Returns a criteria object that wraps a cursor
+  
+  flag.colors.to_a
+  
+  # Returns:
+  # [#<Color name: "red", _id: {"$oid"=>"4be96bfe715dd2c4be000001"}>, #<Color name: "green", _id: {"$oid"=>"4be96c08715dd2c4be000002"}>]
+
+Or you can build your custon methods. Example:
 
   class Flag
     include MongoODM::Document

data/lib/mongo_odm.rb

@@ -46,5 +46,9 @@ module MongoODM
     end
     value.class.type_cast(value.to_mongo)
   end
+  
+  def self.dereference(value)
+    value.respond_to?(:dereference) ? value.dereference : value
+  end
 
 end

data/lib/mongo_odm/core_ext/conversions.rb

@@ -26,6 +26,27 @@ class BSON::ObjectId
   end
 end
 
+# @private
+class BSON::DBRef
+  def self.type_cast(value)
+    return value if value.is_a?(BSON::DBRef)
+    return value.to_dbref if value.respond_to?(:to_dbref)
+    nil
+  end
+  
+  def to_mongo
+    self
+  end
+  
+  def dereference
+    MongoODM.instanciate(MongoODM.database.dereference(self))
+  end
+  
+  def inspect
+    "BSON::DBRef(namespace:\"#{namespace}\", id: \"#{object_id}\")"
+  end
+end
+
 # @private
 class Array
   def self.type_cast(value)
@@ -36,6 +57,10 @@ class Array
   def to_mongo
     self.map {|elem| elem.to_mongo}
   end
+  
+  def dereference
+    MongoODM.instanciate(self.map{|value| MongoODM.dereference(value)})
+  end
 end
 
 # @private
@@ -219,6 +244,10 @@ class Hash
   def to_mongo
     Hash[self.map{|k,v| [k.to_mongo, v.to_mongo]}]
   end
+  
+  def dereference
+    Hash[self.map{|k,v| [MongoODM.instanciate(MongoODM.dereference(k)), MongoODM.instanciate(MongoODM.dereference(v))]}]
+  end
 end
 
 # @private

data/lib/mongo_odm/document/persistence.rb

@@ -57,6 +57,10 @@ module MongoODM
             attrs
           end
         end
+        
+        def to_dbref
+          BSON::DBRef.new(self.class.collection.name, _id)
+        end
       end
     
       module ClassMethods

data/lib/mongo_odm/version.rb

@@ -2,6 +2,6 @@
 module MongoODM
   VERSION_MAJOR = "0"
   VERSION_MINOR = "2"
-  VERSION_BUILD = "6"
+  VERSION_BUILD = "7"
   VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_BUILD}"
 end

metadata

@@ -2,7 +2,7 @@
 name: mongo_odm
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors: 
 - Carlos Paramio