mongoid 0.9.8 → 0.9.9

data/README.textile

@@ -44,11 +44,11 @@ Example of a simple domain model:
     field :title
     field :age, :type => Integer, :default => 0
 
-    has_many :addresses
     has_one :name
+    has_many :addresses
 
-    relates_to_one :game
-    relates_to_many :posts
+    has_one_related :game
+    has_many_related :posts
   end
 
   class Address < Mongoid::Document
@@ -71,10 +71,11 @@ Example of a simple domain model:
     field :title
     field :text
     field :tags, :type => Array
-    relates_to_one :person
+    belongs_to_related :person
   end
 
   class Game < ActiveRecord::Base
+    belongs_to_related :person
   end
 </pre>
 

data/VERSION

@@ -1 +1 @@
-0.9.8
+0.9.9

data/lib/mongoid.rb

@@ -43,6 +43,7 @@ require "mongoid/commands"
 require "mongoid/criteria"
 require "mongoid/dynamic_finder"
 require "mongoid/extensions"
+require "mongoid/errors"
 require "mongoid/field"
 require "mongoid/finders"
 require "mongoid/timestamps"
@@ -51,41 +52,15 @@ require "mongoid/document"
 
 module Mongoid
 
-  # Raised when the database connection has not been set up.
-  class InvalidDatabaseError < RuntimeError; end
-
-  # Raised when invalid options are passed into a constructor.
-  class InvalidOptionsError < RuntimeError; end
-
-  # Raised when an association is defined on the class, but the
-  # attribute in the hash is not an Array or Hash, or when
-  # checking equality on objects of different types.
-  class TypeMismatchError < RuntimeError; end
-
-  # Raised when a persisence method ending in ! fails validation.
-  class ValidationsError < RuntimeError; end
-
-  # A common case of errors is to instantiate a child document without a
-  # reference to a parent, which will result in trying to save on a nil
-  # collection. This error is raised to help debug the issue.
-  class MissingParentError < RuntimeError
-    def initialize(doc)
-      @document = doc
-    end
-    def message
-      "Attempted to save embedded document #{@document.class.name}, but there was no associated parent"
-    end
-  end
-
   # Sets the Mongo::DB to be used.
   def self.database=(db)
-    raise InvalidDatabaseError.new("Database should be a Mongo::DB, not #{db.class.name}") unless db.kind_of?(Mongo::DB)
+    raise Errors::InvalidDatabase.new("Database should be a Mongo::DB, not #{db.class.name}") unless db.kind_of?(Mongo::DB)
     @database = db
   end
 
   # Returns the Mongo::DB to use or raise an error if none was set.
   def self.database
-    @database || (raise InvalidDatabaseError.new("No database has been set"))
+    @database || (raise Errors::InvalidDatabase.new("No database has been set, please use Mongoid.database="))
   end
 
 end

data/lib/mongoid/associations.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
 require "mongoid/associations/belongs_to"
+require "mongoid/associations/belongs_to_related"
 require "mongoid/associations/has_many"
+require "mongoid/associations/has_many_related"
 require "mongoid/associations/has_one"
-require "mongoid/associations/relates_to_many"
-require "mongoid/associations/relates_to_one"
+require "mongoid/associations/has_one_related"
 
 module Mongoid # :nodoc:
   module Associations #:nodoc:
@@ -22,13 +23,13 @@ module Mongoid # :nodoc:
 
       # Updates all the one-to-many relational associations for the name.
       def update_associations(name)
-        send(name).each { |doc| doc.quick_save }
+        send(name).each { |doc| doc.save }
       end
 
       # Update the one-to-one relational association for the name.
       def update_association(name)
         association = send(name)
-        association.quick_save if association
+        association.save unless association.nil?
       end
     end
 
@@ -56,7 +57,7 @@ module Mongoid # :nodoc:
       #   end
       def belongs_to(name, options = {})
         unless options.has_key?(:inverse_of)
-          raise InvalidOptionsError.new("Options for belongs_to association must include :inverse_of")
+          raise Errors::InvalidOptions.new("Options for belongs_to association must include :inverse_of")
         end
         @embedded = true
         add_association(
@@ -65,6 +66,27 @@ module Mongoid # :nodoc:
         )
       end
 
+      # Adds a relational association from the child Document to a Document in
+      # another database or collection.
+      #
+      # Options:
+      #
+      # name: A +Symbol+ that is the related class name.
+      #
+      # Example:
+      #
+      #   class Game < Mongoid::Document
+      #     belongs_to_related :person
+      #   end
+      #
+      def belongs_to_related(name, options = {})
+        field "#{name.to_s}_id"
+        add_association(
+          Associations::BelongsToRelated,
+          Associations::Options.new(options.merge(:name => name))
+        )
+      end
+
       # Adds the association from a parent document to its children. The name
       # of the association needs to be a pluralized form of the child class
       # name.
@@ -89,6 +111,29 @@ module Mongoid # :nodoc:
         )
       end
 
+      # Adds a relational association from the Document to many Documents in
+      # another database or collection.
+      #
+      # Options:
+      #
+      # name: A +Symbol+ that is the related class name pluralized.
+      #
+      # Example:
+      #
+      #   class Person < Mongoid::Document
+      #     has_many_related :posts
+      #   end
+      #
+      def has_many_related(name, options = {})
+        add_association(
+          Associations::HasManyRelated,
+          Associations::Options.new(options.merge(:name => name, :parent_key => self.name.foreign_key))
+        )
+        before_save do |document|
+          document.update_associations(name)
+        end
+      end
+
       # Adds the association from a parent document to its child. The name
       # of the association needs to be a singular form of the child class
       # name.
@@ -113,67 +158,41 @@ module Mongoid # :nodoc:
         )
       end
 
-      # Returns the macro associated with the supplied association name. This
-      # will return has_one, has_many, belongs_to or nil.
-      #
-      # Options:
-      #
-      # name: The association name.
-      #
-      # Example:
-      #
-      # <tt>Person.reflect_on_association(:addresses)</tt>
-      def reflect_on_association(name)
-        association = associations[name]
-        association ? association.macro : nil
-      end
-
-      # Adds a relational association from the Document to a Document in
+      # Adds a relational association from the Document to one Document in
       # another database or collection.
       #
       # Options:
       #
-      # name: A +Symbol+ that is the related class name.
+      # name: A +Symbol+ that is the related class name pluralized.
       #
       # Example:
       #
       #   class Person < Mongoid::Document
-      #     relates_to_one :game
+      #     has_one_related :game
       #   end
-      #
-      def relates_to_one(name, options = {})
-        key = name.to_s
-        field "#{key}_id"
+      def has_one_related(name, options = {})
         add_association(
-          Associations::RelatesToOne,
-          Associations::Options.new(options.merge(:name => name))
+          Associations::HasOneRelated,
+          Associations::Options.new(options.merge(:name => name, :parent_key => self.name.foreign_key))
         )
         before_save do |document|
           document.update_association(name)
         end
       end
 
-      # Adds a relational association from the Document to many Documents in
-      # another database or collection.
+      # Returns the macro associated with the supplied association name. This
+      # will return has_one, has_many, belongs_to or nil.
       #
       # Options:
       #
-      # name: A +Symbol+ that is the related class name pluralized.
+      # name: The association name.
       #
       # Example:
       #
-      #   class Person < Mongoid::Document
-      #     relates_to_many :posts
-      #   end
-      #
-      def relates_to_many(name, options = {})
-        add_association(
-          Associations::RelatesToMany,
-          Associations::Options.new(options.merge(:name => name, :parent_key => self.name.foreign_key))
-        )
-        before_save do |document|
-          document.update_associations(name)
-        end
+      # <tt>Person.reflect_on_association(:addresses)</tt>
+      def reflect_on_association(name)
+        association = associations[name]
+        association ? association.macro : nil
       end
 
       protected

data/lib/mongoid/associations/{relates_to_one.rb → belongs_to_related.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Mongoid #:nodoc:
   module Associations #:nodoc:
-    class RelatesToOne #:nodoc:
+    class BelongsToRelated #:nodoc:
 
       delegate :==, :to => :document
       attr_reader :document
@@ -23,7 +23,7 @@ module Mongoid #:nodoc:
       end
 
       class << self
-        # Instantiate a new +RelatesToOne+ or return nil if the foreign key is
+        # Instantiate a new +BelongsToRelated+ or return nil if the foreign key is
         # nil. It is preferrable to use this method over the traditional call
         # to new.
         #
@@ -38,7 +38,7 @@ module Mongoid #:nodoc:
 
         # Returns the macro used to create the association.
         def macro
-          :relates_to_one
+          :belongs_to_related
         end
 
         # Perform an update of the relationship of the parent and child. This
@@ -52,7 +52,7 @@ module Mongoid #:nodoc:
         #
         # Example:
         #
-        # <tt>RelatesToOne.update(game, person, options)</tt>
+        # <tt>BelongsToRelated.update(game, person, options)</tt>
         def update(related, parent, options)
           parent.send("#{options.foreign_key}=", related.id); related
         end

data/lib/mongoid/associations/has_many.rb

@@ -7,10 +7,12 @@ module Mongoid #:nodoc:
 
       # Appends the object to the +Array+, setting its parent in
       # the process.
-      def <<(object)
-        object.parentize(@parent, @association_name)
-        @documents << object
-        object.is_a?(Array) ? object.each(&:notify) : object.notify
+      def <<(*objects)
+        objects.flatten.each do |object|
+          object.parentize(@parent, @association_name)
+          @documents << object
+          object.notify
+        end
       end
 
       # Clears the association, and notifies the parents of the removal.
@@ -23,14 +25,8 @@ module Mongoid #:nodoc:
 
       # Appends the object to the +Array+, setting its parent in
       # the process.
-      def push(object)
-        self << object
-      end
-
-      # Appends the object to the +Array+, setting its parent in
-      # the process.
-      def concat(object)
-        self << object
+      def concat(*objects)
+        self << objects
       end
 
       # Builds a new Document and adds it to the association collection. The
@@ -82,6 +78,24 @@ module Mongoid #:nodoc:
         super(@documents)
       end
 
+      # Used for setting associations via a nested attributes setter from the
+      # parent +Document+.
+      #
+      # Options:
+      #
+      # attributes: A +Hash+ of integer keys and +Hash+ values.
+      def nested_build(attributes)
+        attributes.values.each do |attrs|
+          build(attrs)
+        end
+      end
+
+      # Appends the object to the +Array+, setting its parent in
+      # the process.
+      def push(*objects)
+        self << objects
+      end
+
       class << self
 
         # Preferred method of creating a new +HasMany+ association. It will

data/lib/mongoid/associations/has_many_related.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Associations #:nodoc:
+    class HasManyRelated < DelegateClass(Array) #:nodoc:
+
+      attr_reader :klass
+
+      # Appends the object to the +Array+, setting its parent in
+      # the process.
+      def <<(*objects)
+        objects.flatten.each do |object|
+          object.send("#{@foreign_key}=", @parent.id)
+          @documents << object
+          object.save unless @parent.new_record?
+        end
+      end
+
+      # Builds a new Document and adds it to the association collection. The
+      # document created will be of the same class as the others in the
+      # association, and the attributes will be passed into the constructor.
+      #
+      # Returns the newly created object.
+      def build(attributes)
+        object = @klass.instantiate(attributes.merge(@foreign_key => @parent.id))
+        @documents << object
+        object
+      end
+
+      # Delegates to <<
+      def concat(*objects)
+        self << objects
+      end
+
+      # Creates a new Document and adds it to the association collection. The
+      # document created will be of the same class as the others in the
+      # association, and the attributes will be passed into the constructor and
+      # the new object will then be saved.
+      #
+      # Returns the newly created object.
+      def create(attributes)
+        object = build(attributes)
+        object.save
+      end
+
+      # Initializing a related association only requires looking up the objects
+      # by their ids.
+      #
+      # Options:
+      #
+      # document: The +Document+ that contains the relationship.
+      # options: The association +Options+.
+      def initialize(document, options)
+        @parent, @klass = document, options.klass
+        @foreign_key = document.class.to_s.foreign_key
+        @documents = @klass.all(:conditions => { @foreign_key => document.id })
+        super(@documents)
+      end
+
+      # Delegates to <<
+      def push(*objects)
+        self << objects
+      end
+
+      class << self
+        # Preferred method for creating the new +HasManyRelated+ association.
+        #
+        # Options:
+        #
+        # document: The +Document+ that contains the relationship.
+        # options: The association +Options+.
+        def instantiate(document, options)
+          new(document, options)
+        end
+
+        # Returns the macro used to create the association.
+        def macro
+          :has_many_related
+        end
+
+        # Perform an update of the relationship of the parent and child. This
+        # will assimilate the child +Document+ into the parent's object graph.
+        #
+        # Options:
+        #
+        # related: The related object
+        # parent: The parent +Document+ to update.
+        # options: The association +Options+
+        #
+        # Example:
+        #
+        # <tt>RelatesToOne.update(game, person, options)</tt>
+        def update(related, document, options)
+          name = document.class.to_s.underscore
+          related.each { |child| child.send("#{name}=", document) }
+        end
+      end
+
+    end
+  end
+end