mongo_mapper-unstable 2010.1.27 → 2010.1.28

data/Rakefile

@@ -12,7 +12,7 @@ Jeweler::Tasks.new do |gem|
   gem.authors     = ["John Nunemaker"]
   
   gem.add_dependency('activesupport', '>= 2.3')
-  gem.add_dependency('mongo', '0.18.2')
+  gem.add_dependency('mongo', '0.18.3')
   gem.add_dependency('jnunemaker-validatable', '1.8.1')
   
   gem.add_development_dependency('jnunemaker-matchy', '0.4.0')

data/VERSION

@@ -1 +1 @@
-2010.01.27
+2010.01.28

data/lib/mongo_mapper/document.rb

@@ -7,8 +7,8 @@ module MongoMapper
         include InstanceMethods
         extend  ClassMethods
         extend  Finders
-
         extend Plugins
+
         plugin Plugins::Associations
         plugin Plugins::Clone
         plugin Plugins::Descendants
@@ -18,6 +18,7 @@ module MongoMapper
         plugin Plugins::Dirty # for now dirty needs to be after keys
         plugin Plugins::Logger
         plugin Plugins::Pagination
+        plugin Plugins::Protected
         plugin Plugins::Rails
         plugin Plugins::Serialization
         plugin Plugins::Validations
@@ -69,6 +70,21 @@ module MongoMapper
         end
       end
 
+      def find_or_create(arg)
+        first(arg) || create(arg)
+      end
+
+      def find_each(options={})
+        criteria, options = to_finder_options(options)
+        collection.find(criteria, options).each do |doc|
+          yield load(doc)
+        end
+      end
+
+      def find_by_id(id)
+        find(id)
+      end
+
       def first(options={})
         find_one(options)
       end
@@ -82,21 +98,10 @@ module MongoMapper
         find_many(options)
       end
 
-      def find_by_id(id)
-        find(id)
-      end
-
       def count(options={})
         collection.find(to_criteria(options)).count
       end
 
-      def find_each(options={})
-        criteria, options = to_finder_options(options)
-        collection.find(criteria, options).each do |doc|
-          yield load(doc)
-        end
-      end
-
       def exists?(options={})
         !count(options).zero?
       end

data/lib/mongo_mapper/embedded_document.rb

@@ -1,13 +1,13 @@
 module MongoMapper
   module EmbeddedDocument
     extend DescendantAppends
-    
+
     def self.included(model)
       model.class_eval do
         include InstanceMethods
         extend  ClassMethods
-        
         extend Plugins
+
         plugin Plugins::Associations
         plugin Plugins::Clone
         plugin Plugins::Descendants
@@ -15,13 +15,14 @@ module MongoMapper
         plugin Plugins::Inspect
         plugin Plugins::Keys
         plugin Plugins::Logger
+        plugin Plugins::Protected
         plugin Plugins::Rails
         plugin Plugins::Serialization
         plugin Plugins::Validations
 
-        attr_accessor :_root_document
+        attr_accessor :_root_document, :_parent_document
       end
-      
+
       super
     end
 
@@ -29,6 +30,12 @@ module MongoMapper
       def embeddable?
         true
       end
+
+      def embedded_in(owner_name)
+        define_method(owner_name) do
+          self._parent_document
+        end
+      end
     end
 
     module InstanceMethods
@@ -38,7 +45,7 @@ module MongoMapper
         end
         result
       end
-      
+
       def save!(options={})
         if result = _root_document.try(:save!, options)
           @new = false

data/lib/mongo_mapper/plugins/associations/embedded_collection.rb

@@ -41,6 +41,7 @@ module MongoMapper
           def assign_root_document(*docs)
             docs.each do |doc|
               doc._root_document = _root_document
+              doc._parent_document = owner
             end
           end
       end

data/lib/mongo_mapper/plugins/keys.rb

@@ -122,6 +122,14 @@ module MongoMapper
               validates_format_of(attribute, :with => key.options[:format])
             end
 
+            if key.options[:in]
+              validates_inclusion_of(attribute, :within => key.options[:in])
+            end
+
+            if key.options[:not_in]
+              validates_exclusion_of(attribute, :within => key.options[:not_in])
+            end
+
             if key.options[:length]
               length_options = case key.options[:length]
               when Integer
@@ -289,4 +297,4 @@ module MongoMapper
       end
     end
   end
-end
+end

data/lib/mongo_mapper/plugins/protected.rb

@@ -0,0 +1,41 @@
+module MongoMapper
+  module Plugins
+    module Protected
+      module ClassMethods
+        def attr_protected(*attrs)
+          self.write_inheritable_attribute(:attr_protected, Set.new(attrs) + (protected_attributes || []))
+        end
+
+        def protected_attributes
+          self.read_inheritable_attribute(:attr_protected)
+        end
+
+        def key(*args)
+          key = super
+          attr_protected key.name.to_sym if key.options[:protected]
+          key
+        end
+      end
+
+      module InstanceMethods
+        def update_attributes(attrs={})
+          super(filter_protected_attrs(attrs))
+        end
+
+        def update_attributes!(attrs={})
+          super(filter_protected_attrs(attrs))
+        end
+
+        def protected_attributes
+          self.class.protected_attributes
+        end
+
+        protected
+          def filter_protected_attrs(attrs)
+            return attrs if protected_attributes.blank?
+            attrs.dup.delete_if { |key, val| protected_attributes.include?(key) }
+          end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/support.rb

@@ -205,8 +205,9 @@ class Time
   end
 end
 
-# TODO: Remove when patch accepted into driver
 class Mongo::ObjectID
+  alias_method :original_to_json, :to_json
+  
   def to_json(options = nil)
     %Q("#{to_s}")
   end

data/lib/mongo_mapper.rb

@@ -6,7 +6,7 @@ require 'set'
 # if there is a better way to do this, please enlighten me!
 if self.class.const_defined?(:Gem)
   gem 'activesupport', '>= 2.3'
-  gem 'mongo', '0.18.2'
+  gem 'mongo', '0.18.3'
   gem 'jnunemaker-validatable', '1.8.1'
 end
 
@@ -117,6 +117,7 @@ require 'mongo_mapper/plugins/inspect'
 require 'mongo_mapper/plugins/keys'
 require 'mongo_mapper/plugins/logger'
 require 'mongo_mapper/plugins/pagination'
+require 'mongo_mapper/plugins/protected'
 require 'mongo_mapper/plugins/rails'
 require 'mongo_mapper/plugins/serialization'
 require 'mongo_mapper/plugins/validations'

data/test/functional/associations/test_many_embedded_proxy.rb

@@ -15,6 +15,7 @@ class ManyEmbeddedProxyTest < Test::Unit::TestCase
     @pet_class = EDoc do
       key :name, String
     end
+    @pet_class.embedded_in :person
     @person_class = EDoc do
       key :name, String
     end
@@ -133,6 +134,17 @@ class ManyEmbeddedProxyTest < Test::Unit::TestCase
       doc.people.first._root_document.should == doc
       doc.people.first.pets.first._root_document.should == doc
     end
+    should "create a reference to the owning document for all embedded documents before save" do
+      doc = @klass.new
+      meg = @person_class.new(:name => 'Meg')
+      pet = @pet_class.new(:name => 'Sparky', :species => 'Dog')
+      
+      doc.people << meg
+      meg.pets << pet
+
+      doc.people.first._parent_document.should == doc
+      doc.people.first.pets.first._parent_document.should == doc.people.first
+    end
 
     should "create a reference to the root document for all embedded documents" do
       sparky = @pet_class.new(:name => 'Sparky', :species => 'Dog')
@@ -145,6 +157,32 @@ class ManyEmbeddedProxyTest < Test::Unit::TestCase
       doc.people.first._root_document.should == doc
       doc.people.first.pets.first._root_document.should == doc
     end
+    should "create a reference to the owning document for all embedded documents" do
+      doc = @klass.new
+      meg = @person_class.new(:name => 'Meg')
+      pet = @pet_class.new(:name => 'Sparky', :species => 'Dog')
+      
+      doc.people << meg
+      meg.pets << pet
+      doc.save
+
+      doc.reload
+      doc.people.first._parent_document.should == doc
+      doc.people.first.pets.first._parent_document.should == doc.people.first
+    end
+
+    should "create embedded_in relationship for embedded docs" do
+      doc = @klass.new
+      meg = @person_class.new(:name => 'Meg')
+      pet = @pet_class.new(:name => 'Sparky', :species => 'Dog')
+      
+      doc.people << meg
+      meg.pets << pet
+      doc.save
+
+      doc.reload
+      doc.people.first.pets.first.person.should == doc.people.first
+    end
   end
   
   should "allow finding by id" do

data/test/functional/test_document.rb

@@ -13,7 +13,7 @@ class DocumentTest < Test::Unit::TestCase
     end
   end
   
-  context "Using key with type Array" do
+  context "array key" do
     setup do
       @document.key :tags, Array
     end
@@ -60,7 +60,7 @@ class DocumentTest < Test::Unit::TestCase
     end
   end
 
-  context "Using key with type Hash" do
+  context "hash key" do
     setup do
       @document.key :foo, Hash
     end
@@ -95,7 +95,7 @@ class DocumentTest < Test::Unit::TestCase
     end
   end
 
-  context "Using key with custom type with default" do
+  context "custom type key with default" do
     setup do
       @document.key :window, WindowSize, :default => WindowSize.new(600, 480)
     end
@@ -407,6 +407,24 @@ class DocumentTest < Test::Unit::TestCase
     end
   end
 
+  context "find_or_create" do
+    should "find if exists" do
+      created = @document.create(:first_name => 'John', :last_name => 'Nunemaker')
+      lambda {
+        found = @document.find_or_create(:first_name => 'John', :last_name => 'Nunemaker')
+        found.should == created
+      }.should_not change { @document.count }
+    end
+
+    should "create if not found" do
+      lambda {
+        created = @document.find_or_create(:first_name => 'John', :last_name => 'Nunemaker')
+        created.first_name.should == 'John'
+        created.last_name.should == 'Nunemaker'
+      }.should change { @document.count }.by(1)
+    end
+  end
+
   context "ClassMethods#delete (single document)" do
     setup do
       @doc1 = @document.create({:first_name => 'John', :last_name => 'Nunemaker', :age => '27'})
@@ -568,10 +586,10 @@ class DocumentTest < Test::Unit::TestCase
     @document.new.database.should == @document.database
   end
 
-  context "#save (new document)" do
+  context "#update_attributes (new document)" do
     setup do
       @doc = @document.new(:first_name => 'John', :age => '27')
-      @doc.save
+      @doc.update_attributes(:first_name => 'Johnny', :age => 30)
     end
 
     should "insert document into the collection" do
@@ -583,54 +601,27 @@ class DocumentTest < Test::Unit::TestCase
     end
 
     should "save attributes" do
-      @doc.first_name.should == 'John'
-      @doc.age.should == 27
+      @doc.first_name.should == 'Johnny'
+      @doc.age.should == 30
     end
 
     should "update attributes in the database" do
       doc = @doc.reload
       doc.should == @doc
-      doc.first_name.should == 'John'
-      doc.age.should == 27
-    end
-
-    should "allow to add custom attributes to the document" do
-      @doc = @document.new(:first_name => 'David', :age => '26', :gender => 'male', :tags => [1, "2"])
-      @doc.save
-      doc = @doc.reload
-      doc.gender.should == 'male'
-      doc.tags.should == [1, "2"]
-    end
-
-    should "allow to use custom methods to assign properties" do
-      klass = Doc do
-        key :name, String
-        
-        def realname=(value)
-          self.name = value
-        end
-      end
-      
-      person = klass.new(:realname => 'David')
-      person.save
-      person.reload.name.should == 'David'
+      doc.first_name.should == 'Johnny'
+      doc.age.should == 30
     end
 
-    context "with key of type date" do
-      should "save the date value as a Time object" do
-        doc = @document.new(:first_name => 'John', :age => '27', :date => "12/01/2009")
-        doc.save
-        doc.date.should == Date.new(2009, 12, 1)
-      end
+    should "allow updating custom attributes" do
+      @doc.update_attributes(:gender => 'mALe')
+      @doc.reload.gender.should == 'mALe'
     end
   end
 
-  context "#save (existing document)" do
+  context "#update_attributes (existing document)" do
     setup do
       @doc = @document.create(:first_name => 'John', :age => '27')
-      @doc.first_name = 'Johnny'
-      @doc.age = 30
-      @doc.save
+      @doc.update_attributes(:first_name => 'Johnny', :age => 30)
     end
 
     should "not insert document into collection" do
@@ -647,19 +638,26 @@ class DocumentTest < Test::Unit::TestCase
       doc.first_name.should == 'Johnny'
       doc.age.should == 30
     end
+  end
 
-    should "allow updating custom attributes" do
-      @doc = @document.new(:first_name => 'David', :age => '26', :gender => 'male')
-      @doc.gender = 'Male'
-      @doc.save
-      @doc.reload.gender.should == 'Male'
+  context "#update_attributes (return value)" do
+    setup do
+      @document.key :foo, String, :required => true
     end
-  end
 
-  context "#update_attributes (new document)" do
+    should "be true if document valid" do
+      @document.new.update_attributes(:foo => 'bar').should be_true
+    end
+
+    should "be false if document not valid" do
+      @document.new.update_attributes({}).should be_false
+    end
+  end
+  
+  context "#save (new document)" do
     setup do
       @doc = @document.new(:first_name => 'John', :age => '27')
-      @doc.update_attributes(:first_name => 'Johnny', :age => 30)
+      @doc.save
     end
 
     should "insert document into the collection" do
@@ -671,27 +669,54 @@ class DocumentTest < Test::Unit::TestCase
     end
 
     should "save attributes" do
-      @doc.first_name.should == 'Johnny'
-      @doc.age.should == 30
+      @doc.first_name.should == 'John'
+      @doc.age.should == 27
     end
 
     should "update attributes in the database" do
       doc = @doc.reload
       doc.should == @doc
-      doc.first_name.should == 'Johnny'
-      doc.age.should == 30
+      doc.first_name.should == 'John'
+      doc.age.should == 27
     end
 
-    should "allow updating custom attributes" do
-      @doc.update_attributes(:gender => 'mALe')
-      @doc.reload.gender.should == 'mALe'
+    should "allow to add custom attributes to the document" do
+      @doc = @document.new(:first_name => 'David', :age => '26', :gender => 'male', :tags => [1, "2"])
+      @doc.save
+      doc = @doc.reload
+      doc.gender.should == 'male'
+      doc.tags.should == [1, "2"]
+    end
+
+    should "allow to use custom methods to assign properties" do
+      klass = Doc do
+        key :name, String
+        
+        def realname=(value)
+          self.name = value
+        end
+      end
+      
+      person = klass.new(:realname => 'David')
+      person.save
+      person.reload.name.should == 'David'
+    end
+
+    context "with key of type date" do
+      should "save the date value as a Time object" do
+        doc = @document.new(:first_name => 'John', :age => '27', :date => "12/01/2009")
+        doc.save
+        doc.date.should == Date.new(2009, 12, 1)
+      end
     end
   end
 
-  context "#update_attributes (existing document)" do
+  context "#save (existing document)" do
     setup do
       @doc = @document.create(:first_name => 'John', :age => '27')
-      @doc.update_attributes(:first_name => 'Johnny', :age => 30)
+      @doc.first_name = 'Johnny'
+      @doc.age = 30
+      @doc.save
     end
 
     should "not insert document into collection" do
@@ -708,22 +733,15 @@ class DocumentTest < Test::Unit::TestCase
       doc.first_name.should == 'Johnny'
       doc.age.should == 30
     end
-  end
-
-  context "#update_attributes" do
-    setup do
-      @document.key :foo, String, :required => true
-    end
-
-    should "return true if document valid" do
-      @document.new.update_attributes(:foo => 'bar').should be_true
-    end
 
-    should "return false if document not valid" do
-      @document.new.update_attributes({}).should be_false
+    should "allow updating custom attributes" do
+      @doc = @document.new(:first_name => 'David', :age => '26', :gender => 'male')
+      @doc.gender = 'Male'
+      @doc.save
+      @doc.reload.gender.should == 'Male'
     end
   end
-  
+
   context "#save (with validations off)" do
     setup do
       @document = Doc do
@@ -1091,7 +1109,7 @@ class DocumentTest < Test::Unit::TestCase
     end
   end
 
-  context "#exist?" do
+  context "#exists?" do
     setup do
       @doc = @document.create(:first_name => "James", :age => 27)
     end
@@ -1162,7 +1180,7 @@ class DocumentTest < Test::Unit::TestCase
     end
   end
 
-  context "Loading a document from the database with keys that are not defined" do
+  context "database has keys not defined in model" do
     setup do
       @id = Mongo::ObjectID.new
       @document.collection.insert({