mongo_doc 0.6.5 → 0.6.6

data/README.textile

@@ -1,6 +1,6 @@
 h1. MongoDoc
 
-Version: Hurricane (0.6.5) 2010/07/07
+Version: Hurricane (0.6.6) 2010/07/09
 
 h2. Notes
 

data/VERSION

@@ -1 +1 @@
-0.6.5
+0.6.6

data/features/references.feature

@@ -0,0 +1,18 @@
+Feature: References
+
+  Background:
+    Given an empty Person document collection
+    And a Person document named 'Fry' :
+      | Name          |
+      | Philip J. Fry |
+    And an empty Address document collection
+    And an Address document named 'office' :
+      | City              |
+      | New New York City |
+
+  Scenario: Automatically dereferenced
+    When I save the document 'office'
+    And 'Fry' references 'office' as 'address'
+    And I save the document 'Fry'
+    And the document 'Fry' is reloaded
+    Then 'Fry' refers to 'office' as 'address'

data/features/step_definitions/documents.rb

@@ -43,6 +43,7 @@ class Person
   include MongoDoc::Document
 
   attr_accessor :name
+  references :address
 
   timestamps!
 end

data/features/step_definitions/field_steps.rb

@@ -2,3 +2,15 @@ Then /^the field (\w+) of the document '(\w+)' is not nil$/ do |field, name|
   doc = instance_variable_get("@#{name}")
   doc.send(field).should_not be_nil
 end
+
+When /^'(\w+)' references '(\w+)' as '(\w+)'$/ do |parent, child, field|
+  parent_doc = instance_variable_get("@#{parent}")
+  child_doc = instance_variable_get("@#{child}")
+  parent_doc.send("#{field}=", child_doc)
+end
+
+Then /^'(\w+)' refers to '(\w+)' as '(\w+)'$/ do |name, other, field|
+  doc = instance_variable_get("@#{name}")
+  other_doc = instance_variable_get("@#{other}")
+  doc.send("#{field}").should == other_doc
+end

data/lib/mongo_doc/document.rb

@@ -7,6 +7,7 @@ require 'mongo_doc/finders'
 require 'mongo_doc/index'
 require 'mongo_doc/scope'
 require 'mongo_doc/timestamps'
+require 'mongo_doc/references'
 require 'active_model/naming'
 require 'active_model/translation'
 require 'active_model/deprecated_error_methods'
@@ -33,6 +34,7 @@ module MongoDoc
         extend Index
         extend Scope
         extend Timestamps
+        extend References
         include ::ActiveModel::Validations
         extend ::ActiveModel::Naming
         extend Validations

data/lib/mongo_doc/ext/object_id.rb

@@ -3,5 +3,9 @@ module BSON
     def to_bson(*args)
       self
     end
+
+    def self.cast_from_string(string)
+      ObjectID.from_string(string) unless string.blank?
+    end
   end
 end

data/lib/mongo_doc/references.rb

@@ -0,0 +1,36 @@
+module MongoDoc
+  module References
+    # Declare a reference to another +Document+.
+    #
+    # * 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
+
+      attr_accessor "#{attr_name}_id".to_sym, :type => ::BSON::ObjectID
+
+      module_eval(<<-RUBY, __FILE__, __LINE__)
+        def #{attr_name}_id_with_reference=(value)       # def address_id_with_reference=(value)
+          @#{attr_name} = nil                            #   @address = nil
+          self.#{attr_name}_id_without_reference = value #   self.address_id_without_reference = value
+        end                                              # end
+
+        def #{attr_name}
+          @#{attr_name} ||= if #{attr_name}_id.nil? # @address ||= if address_name_id.nil?
+              nil                                   #     nil
+            else                                    #   else
+              #{klass}.find_one(#{attr_name}_id)    #     Address.find_one(address_name_id)
+            end                                     #   end
+        end
+
+        def #{attr_name}=(value)                              # def address=(value)
+          @#{attr_name} = value                               # @address = value
+          self.#{attr_name}_id = value.nil? ? nil : value._id # self.address_id = value.nil? ? nil : value._id
+        end                                                   # end
+      RUBY
+
+      alias_method_chain "#{attr_name}_id=", :reference
+    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.5'
+  VERSION = '0.6.6'
 end
 
 require 'mongo_doc/connection'

data/mongo_doc.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongo_doc}
-  s.version = "0.6.5"
+  s.version = "0.6.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Les Hill"]
-  s.date = %q{2010-07-07}
+  s.date = %q{2010-07-09}
   s.description = %q{ODM for MongoDB}
   s.email = %q{leshill@gmail.com}
   s.extra_rdoc_files = [
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
      "features/mongodoc_base.feature",
      "features/new_record.feature",
      "features/partial_updates.feature",
+     "features/references.feature",
      "features/removing_documents.feature",
      "features/saving_an_object.feature",
      "features/scopes.feature",
@@ -55,6 +56,7 @@ Gem::Specification.new do |s|
      "features/step_definitions/objects.rb",
      "features/step_definitions/partial_update_steps.rb",
      "features/step_definitions/query_steps.rb",
+     "features/step_definitions/reference_steps.rb",
      "features/step_definitions/removing_documents_steps.rb",
      "features/step_definitions/scope_steps.rb",
      "features/step_definitions/string_casting_steps.rb",
@@ -103,6 +105,7 @@ Gem::Specification.new do |s|
      "lib/mongo_doc/railtie.rb",
      "lib/mongo_doc/railties/config.rb",
      "lib/mongo_doc/railties/db_prepare.task",
+     "lib/mongo_doc/references.rb",
      "lib/mongo_doc/root.rb",
      "lib/mongo_doc/scope.rb",
      "lib/mongo_doc/timestamps.rb",
@@ -163,6 +166,7 @@ Gem::Specification.new do |s|
      "spec/mongodb.yml",
      "spec/mongodb_pairs.yml",
      "spec/new_record_spec.rb",
+     "spec/references_spec.rb",
      "spec/root_spec.rb",
      "spec/scope_spec.rb",
      "spec/spec_helper.rb",
@@ -203,6 +207,7 @@ Gem::Specification.new do |s|
      "spec/index_spec.rb",
      "spec/matchers_spec.rb",
      "spec/new_record_spec.rb",
+     "spec/references_spec.rb",
      "spec/root_spec.rb",
      "spec/scope_spec.rb",
      "spec/spec_helper.rb",

data/spec/ext_spec.rb

@@ -75,6 +75,17 @@ describe "Ruby Object Extensions" do
       end
     end
 
+    context "ObjectID" do
+      it "returns nil for a blank string" do
+        BSON::ObjectID.cast_from_string('').should be_nil
+      end
+
+      it "converts from a string to an ObjectID" do
+        obj = BSON::ObjectID.new
+        BSON::ObjectID.cast_from_string(obj.to_s).should == obj
+      end
+    end
+
     context "Time" do
       it "returns nil for a blank string" do
         Time.cast_from_string('').should be_nil

data/spec/references_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe MongoDoc::References do
+  class Address
+    include MongoDoc::Document
+
+    attr_accessor :state
+  end
+
+  context "Simple Reference" do
+    class Person
+      include MongoDoc::Document
+
+      references :address
+    end
+
+    subject { Person.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)
+      end
+    end
+
+    context "Object Id accessor" do
+      it { should respond_to(:address_id) }
+      it { should respond_to(:address_id=) }
+
+      it "is part of the persistent key set" do
+        Person._keys.should include(:address_id)
+      end
+    end
+  end
+
+  context "Named Reference" do
+    class Person
+      include MongoDoc::Document
+
+      references :address, :as => :work_address
+    end
+
+    subject { Person.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)
+      end
+    end
+
+    context "Object Id accessor" do
+      it { should respond_to(:work_address_id) }
+      it { should respond_to(:work_address_id=) }
+
+      it "is part of the persistent key set" do
+        Person._keys.should include(:work_address_id)
+      end
+    end
+  end
+
+  describe "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
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongo_doc
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 6
-  - 5
-  version: 0.6.5
+  - 6
+  version: 0.6.6
 platform: ruby
 authors: 
 - Les Hill
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-07 00:00:00 -04:00
+date: 2010-07-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -169,6 +169,7 @@ files:
 - features/mongodoc_base.feature
 - features/new_record.feature
 - features/partial_updates.feature
+- features/references.feature
 - features/removing_documents.feature
 - features/saving_an_object.feature
 - features/scopes.feature
@@ -184,6 +185,7 @@ files:
 - features/step_definitions/objects.rb
 - features/step_definitions/partial_update_steps.rb
 - features/step_definitions/query_steps.rb
+- features/step_definitions/reference_steps.rb
 - features/step_definitions/removing_documents_steps.rb
 - features/step_definitions/scope_steps.rb
 - features/step_definitions/string_casting_steps.rb
@@ -232,6 +234,7 @@ files:
 - lib/mongo_doc/railtie.rb
 - lib/mongo_doc/railties/config.rb
 - lib/mongo_doc/railties/db_prepare.task
+- lib/mongo_doc/references.rb
 - lib/mongo_doc/root.rb
 - lib/mongo_doc/scope.rb
 - lib/mongo_doc/timestamps.rb
@@ -292,6 +295,7 @@ files:
 - spec/mongodb.yml
 - spec/mongodb_pairs.yml
 - spec/new_record_spec.rb
+- spec/references_spec.rb
 - spec/root_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb
@@ -360,6 +364,7 @@ test_files:
 - spec/index_spec.rb
 - spec/matchers_spec.rb
 - spec/new_record_spec.rb
+- spec/references_spec.rb
 - spec/root_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb