mongo_doc 0.6.18 → 0.6.19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongo_doc (0.6.18)
+    mongo_doc (0.6.19)
       activemodel (>= 3.0.0.beta.4)
       activesupport (>= 3.0.0.beta.4)
       bson (>= 1.0.0)

data/README.textile

@@ -1,6 +1,6 @@
 h1. MongoDoc
 
-Version: 0.6.18 2010/08/15
+Version: 0.6.19 2010/08/15
 
 h2. Notes
 

data/VERSION

@@ -1 +1 @@
-0.6.18
+0.6.19

data/features/step_definitions/documents.rb

@@ -57,5 +57,5 @@ class Character
   include MongoDoc::Document
 
   attr_accessor :name
-  db_references :address
+  references :as_ref => :address
 end

data/lib/mongo_doc/references.rb

@@ -1,14 +1,44 @@
 module MongoDoc
   module References
-    # Declare a reference to another +Document+. Use this when you have a
-    # simple reference or a single polymorphic collection.
+
+    # Dereference a DBRef and return the Object
+    def dereference(db_ref)
+      MongoDoc::Collection.new(db_ref.namespace).find_one(db_ref.object_id)
+    end
+
+    # Declare a reference to another +Document+. The reference can either be an
+    # +ObjectID+ reference, or a +BSON::DBRef+
+    #
+    # Use an +ObjectID+ reference when you have a simple reference or will be
+    # referencing a single polymorphic collection. Example:
+    #
+    # +references :address
+    # +references :address, :as => :work_address+
     #
     # * classname:: name of +Document+ type as an +underscore+ symbol or string
-    # * options:: +:as+ specifies the name of the attribute
-    def references(classname, options = {})
-      klass = classname.to_s.camelize
-      attr_name = options[:as] || klass.to_s.demodulize.downcase
+    # * options:: +:as+ specifies the name of the attribute, defaults to
+    # classname
+    #
+    # Use a +BSON::DBRef+ when you need a reference to multiple collections.
+    # Example:
+    #
+    # +references :as_ref => :work_address+
+    #
+    # * options:: +:as_ref+ name of the attribute
+    def references(*args)
+      options = args.extract_options!
 
+      if options.has_key?(:as_ref)
+        references_by_dbref(options[:as_ref])
+      else
+        klass = args[0].to_s.camelize
+        references_by_id(klass, options[:as] || klass.to_s.demodulize.downcase)
+      end
+    end
+
+    private
+
+    def references_by_id(klass, attr_name)
       attr_accessor "#{attr_name}_id".to_sym, :type => ::BSON::ObjectID
 
       module_eval(<<-RUBY, __FILE__, __LINE__)
@@ -34,13 +64,7 @@ module MongoDoc
       alias_method_chain "#{attr_name}_id=", :reference
     end
 
-
-    # Declare a +DBRef+ to another +Document+. A +DBRef+ can be in any
-    # collection and can point to an instance of any class.
-    #
-    # * name:: name of the attribute
-    def db_references(name)
-
+    def references_by_dbref(name)
       attr_accessor "#{name}_ref".to_sym, :type => ::BSON::DBRef
 
       module_eval(<<-RUBY, __FILE__, __LINE__)
@@ -70,9 +94,5 @@ module MongoDoc
 
       alias_method_chain "#{name}_ref=", :reference
     end
-
-    def dereference(db_ref)
-      MongoDoc::Collection.new(db_ref.namespace).find_one(db_ref.object_id)
-    end
   end
 end

data/lib/mongo_doc.rb

@@ -3,7 +3,7 @@ require 'active_support'
 require 'active_support/core_ext'
 
 module MongoDoc
-  VERSION = '0.6.18'
+  VERSION = '0.6.19'
 end
 
 require 'mongo_doc/connection'

data/mongo_doc.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongo_doc}
-  s.version = "0.6.18"
+  s.version = "0.6.19"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Les Hill"]

data/spec/references_spec.rb

@@ -8,20 +8,20 @@ describe MongoDoc::References do
   end
 
   context "Simple Reference" do
-    class Person
+    class SimplePerson
       include MongoDoc::Document
 
       references :address
     end
 
-    subject { Person.new }
+    subject { SimplePerson.new }
 
     context "Object accessor" do
       it { should respond_to(:address) }
       it { should respond_to(:address=) }
 
       it "is not part of the persistent key set" do
-        Person._keys.should_not include(:address)
+        SimplePerson._keys.should_not include(:address)
       end
     end
 
@@ -30,43 +30,36 @@ describe MongoDoc::References do
       it { should respond_to(:address_id=) }
 
       it "is part of the persistent key set" do
-        Person._keys.should include(:address_id)
+        SimplePerson._keys.should include(:address_id)
       end
     end
 
     context "setting the id" do
-      class Person
-        include MongoDoc::Document
-
-        references :address
-      end
-
       let(:address) { Address.new(:_id => BSON::ObjectID.new) }
-      let(:person) { Person.new }
 
       it "resets the object to nil" do
-        person.address = address
-        person.address_id = nil
-        person.address.should be_nil
+        subject.address = address
+        subject.address_id = nil
+        subject.address.should be_nil
       end
     end
   end
 
   context "Named Reference" do
-    class Person
+    class NamedPerson
       include MongoDoc::Document
 
       references :address, :as => :work_address
     end
 
-    subject { Person.new }
+    subject { NamedPerson.new }
 
     context "Object accessor" do
       it { should respond_to(:work_address) }
       it { should respond_to(:work_address=) }
 
       it "is not part of the persistent key set" do
-        Person._keys.should_not include(:work_address)
+        NamedPerson._keys.should_not include(:work_address)
       end
     end
 
@@ -75,28 +68,27 @@ describe MongoDoc::References do
       it { should respond_to(:work_address_id=) }
 
       it "is part of the persistent key set" do
-        Person._keys.should include(:work_address_id)
+        NamedPerson._keys.should include(:work_address_id)
       end
     end
   end
 
   context "DBRef Reference" do
-    class Person
+    class DBRefPerson
       include MongoDoc::Document
 
-      db_references :address
+      references :as_ref => :address
     end
 
     let(:address) { Address.new(:_id => BSON::ObjectID.new) }
-    let(:person) { Person.new }
-    subject { person }
+    subject { DBRefPerson.new }
 
     context "Object accessor" do
       it { should respond_to(:address) }
       it { should respond_to(:address=) }
 
       it "is not part of the persistent key set" do
-        Person._keys.should_not include(:address)
+        DBRefPerson._keys.should_not include(:address)
       end
     end
 
@@ -105,24 +97,24 @@ describe MongoDoc::References do
       it { should respond_to(:address_ref=) }
 
       it "is part of the persistent key set" do
-        Person._keys.should include(:address_ref)
+        DBRefPerson._keys.should include(:address_ref)
       end
     end
 
     context "setting the object" do
       it "sets the reference" do
-        person.address = address
-        person.address_ref.namespace.should == Address.collection_name
-        person.address_ref.object_id.should == address._id
+        subject.address = address
+        subject.address_ref.namespace.should == Address.collection_name
+        subject.address_ref.object_id.should == address._id
       end
     end
 
     context "setting the reference" do
 
       it "resets the object to nil" do
-        person.address = address
-        person.address_ref = nil
-        person.address.should be_nil
+        subject.address = address
+        subject.address_ref = nil
+        subject.address.should be_nil
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongo_doc
 version: !ruby/object:Gem::Version 
-  hash: 35
+  hash: 33
   prerelease: false
   segments: 
   - 0
   - 6
-  - 18
-  version: 0.6.18
+  - 19
+  version: 0.6.19
 platform: ruby
 authors: 
 - Les Hill