mongoid 0.10.6 → 0.11.0

data/Rakefile

@@ -9,12 +9,12 @@ begin
     gem.name = "mongoid"
     gem.summary = "ODM framework for MongoDB"
     gem.email = "durran@gmail.com"
-    gem.homepage = "http://github.com/durran/mongoid"
+    gem.homepage = "http://mongoid.org"
     gem.authors = ["Durran Jordan"]
 
     gem.add_dependency("activesupport", ">= 2.2.2")
-    gem.add_dependency("mongo", ">= 0.18.1")
-    gem.add_dependency("mongo_ext", ">= 0.18.1")
+    gem.add_dependency("mongo", ">= 0.18.2")
+    gem.add_dependency("mongo_ext", ">= 0.18.2")
     gem.add_dependency("durran-validatable", ">= 1.8.4")
     gem.add_dependency("leshill-will_paginate", ">= 2.3.11")
 

data/VERSION

@@ -1 +1 @@
-0.10.6
+0.11.0

data/lib/mongoid.rb

@@ -22,8 +22,8 @@
 require "rubygems"
 
 gem "activesupport", ">= 2.2.2"
-gem "mongo", ">= 0.18.1"
-gem "mongo_ext", ">= 0.18.1"
+gem "mongo", ">= 0.18.2"
+gem "mongo_ext", ">= 0.18.2"
 gem "durran-validatable", ">= 1.8.4"
 gem "leshill-will_paginate", ">= 2.3.11"
 

data/lib/mongoid/associations.rb

@@ -60,7 +60,7 @@ module Mongoid # :nodoc:
         unless options.has_key?(:inverse_of)
           raise Errors::InvalidOptions.new("Options for belongs_to association must include :inverse_of")
         end
-        @embedded = true
+        self.embedded = true
         add_association(
           Associations::BelongsTo,
           Associations::Options.new(options.merge(:name => name))

data/lib/mongoid/associations/belongs_to.rb

@@ -43,7 +43,7 @@ module Mongoid #:nodoc:
         # document: The parent +Document+
         # options: The association options
         def instantiate(document, options)
-          parent = document.parent
+          parent = document._parent
           parent.nil? ? nil : new(parent, options)
         end
 

data/lib/mongoid/associations/has_many.rb

@@ -37,8 +37,8 @@ module Mongoid #:nodoc:
       # association, and the attributes will be passed into the constructor.
       #
       # Returns the newly created object.
-      def build(attributes = {})
-        object = @klass.instantiate(attributes)
+      def build(attrs = {}, type = nil)
+        object = type ? type.instantiate(attrs) : @klass.instantiate(attrs)
         push(object)
         object
       end
@@ -49,9 +49,10 @@ module Mongoid #:nodoc:
       # the new object will then be saved.
       #
       # Returns the newly created object.
-      def create(attributes)
-        object = build(attributes)
+      def create(attrs = {}, type = nil)
+        object = build(attrs, type)
         object.save
+        object
       end
 
       # Finds a document in this association.
@@ -72,8 +73,9 @@ module Mongoid #:nodoc:
       def initialize(document, options)
         @parent, @association_name, @klass, @options = document, options.name, options.klass, options
         attributes = document.attributes[@association_name]
-        @documents = attributes ? attributes.collect do |attribute|
-          child = @klass.instantiate(attribute)
+        @documents = attributes ? attributes.collect do |attrs|
+          type = attrs[:_type]
+          child = type ? type.constantize.instantiate(attrs) : @klass.instantiate(attrs)
           child.parentize(@parent, @association_name)
           child
         end : []

data/lib/mongoid/associations/has_one.rb

@@ -7,14 +7,14 @@ module Mongoid #:nodoc:
       attr_reader :association_name, :document, :parent, :options
 
       # Build a new object for the association.
-      def build(attributes = {})
-        @document = attributes.assimilate(@parent, @options)
+      def build(attrs = {}, type = nil)
+        @document = attrs.assimilate(@parent, @options, type)
         self
       end
 
       # Create a new object for the association and save it.
-      def create(attributes)
-        build(attributes)
+      def create(attrs = {}, type = nil)
+        build(attrs, type)
         @document.save
         self
       end
@@ -34,7 +34,8 @@ module Mongoid #:nodoc:
       def initialize(document, attributes, options)
         @parent, @options, @association_name = document, options, options.name
         unless attributes.nil?
-          @document = attributes.assimilate(@parent, @options)
+          klass = attributes[:_type] ? attributes[:_type].constantize : nil
+          @document = attributes.assimilate(@parent, @options, klass)
         end
       end
 

data/lib/mongoid/commands.rb

@@ -10,21 +10,7 @@ require "mongoid/commands/save"
 module Mongoid #:nodoc:
 
   # This module is included in the +Document+ to provide all the persistence
-  # methods required on the +Document+ object and class. The following methods
-  # are provided:
-  #
-  # <tt>create</tt>,
-  # <tt>create!</tt>,
-  # <tt>delete</tt>,
-  # <tt>delete_all</tt>,
-  # <tt>destroy</tt>,
-  # <tt>destroy_all</tt>,
-  # <tt>save</tt>,
-  # <tt>save!</tt>,
-  # <tt>update_attributes</tt>,
-  # <tt>update_attributes!</tt>
-  #
-  # These methods will delegate to their respective commands.
+  # methods required on the +Document+ object and class.
   module Commands
     def self.included(base)
       base.class_eval do
@@ -35,41 +21,79 @@ module Mongoid #:nodoc:
 
     module InstanceMethods
 
-      # Delete the +Document+ from the database. Delegates to the Delete
-      # command.
+      # Delete the +Document+ from the database. This method is an optimized
+      # delete that does not force any callbacks.
+      #
+      # Example:
+      #
+      # <tt>document.delete</tt>
+      #
+      # Returns: true unless an error occurs.
       def delete
         Delete.execute(self)
       end
 
-      # Destroy the +Document+. Delegates to the Destroy command.
+      # Destroy the +Document+. This will delete the document from the database
+      # and run the before and after destroy callbacks.
+      #
+      # Example:
+      #
+      # <tt>document.destroy</tt>
+      #
+      # Returns: true unless an error occurs.
       def destroy
         Destroy.execute(self)
       end
 
-      # Save the +Document+. Delegates to the Save command.
+      # Save the +Document+. If the document is new, then the before and after
+      # create callbacks will get executed as well as the save callbacks.
+      # Otherwise only the save callbacks will run.
+      #
+      # Options:
+      #
+      # validate: Run validations or not. Defaults to true.
+      #
+      # Example:
+      #
+      # <tt>document.save # save with validations</tt>
+      # <tt>document.save(false) # save without validations</tt>
+      #
+      # Returns: true if validation passes, false if not.
       def save(validate = true)
-        new_record? ? Create.execute(self, validate) : Save.execute(self, validate)
+        run_callbacks(:before_create) if new_record?
+        saved = Save.execute(self, validate)
+        run_callbacks(:after_create) if new_record?
+        saved
       end
 
-      # Save the +Document+. Delegates to the Save command. If the command
-      # returns false then a +ValidationError+ will be raised.
+      # Save the +Document+, dangerously. Before and after save callbacks will
+      # get run. If validation fails an error will get raised.
+      #
+      # Example:
+      #
+      # <tt>document.save!</tt>
+      #
+      # Returns: true if validation passes
       def save!
-        if new_record?
-          return Create.execute(self, true) || (raise Errors::Validations.new(self.errors))
-        else
-          return Save.execute(self, true) || (raise Errors::Validations.new(self.errors))
-        end
+        return Save.execute(self, true) || (raise Errors::Validations.new(self.errors))
       end
 
-      # Update the attributes of the +Document+. Will call save after the
-      # attributes have been updated.
+      # Update the document attributes and persist the document to the
+      # database. Will delegate to save with all callbacks.
+      #
+      # Example:
+      #
+      # <tt>document.update_attributes(:title => "Test")</tt>
       def update_attributes(attrs = {})
         write_attributes(attrs); save
       end
 
-      # Update the attributes of the +Document+. Will call save! after the
-      # attributes have been updated, causing a +ValidationError+ if the
-      # +Document+ failed validation.
+      # Update the document attributes and persist the document to the
+      # database. Will delegate to save!
+      #
+      # Example:
+      #
+      # <tt>document.update_attributes!(:title => "Test")</tt>
       def update_attributes!(attrs = {})
         write_attributes(attrs); save!
       end
@@ -78,29 +102,58 @@ module Mongoid #:nodoc:
 
     module ClassMethods
 
-      # Create a new +Document+ with the supplied attributes. Will delegate to
-      # the Create command.
+      # Create a new +Document+. This will instantiate a new document and save
+      # it in a single call. Will always return the document whether save
+      # passed or not.
+      #
+      # Example:
+      #
+      # <tt>Person.create(:title => "Mr")</tt>
+      #
+      # Returns: the +Document+.
       def create(attributes = {})
         Create.execute(new(attributes))
       end
 
-      # Create a new +Document+ with the supplied attributes. Will delegate to
-      # the Create command or raise +ValidationError+ if the save failed
-      # validation.
+      # Create a new +Document+. This will instantiate a new document and save
+      # it in a single call. Will always return the document whether save
+      # passed or not. Will raise an error if validation fails.
+      #
+      # Example:
+      #
+      # <tt>Person.create!(:title => "Mr")</tt>
+      #
+      # Returns: the +Document+.
       def create!(attributes = {})
         document = Create.execute(new(attributes))
         raise Errors::Validations.new(self.errors) unless document.errors.empty?
         return document
       end
 
-      # Delete all the +Documents+ in the database given the supplied
-      # conditions.
+      # Delete all documents given the supplied conditions. If no conditions
+      # are passed, the entire collection will be dropped for performance
+      # benefits. Does not fire any callbacks.
+      #
+      # Example:
+      #
+      # <tt>Person.delete_all(:conditions => { :title => "Sir" })</tt>
+      # <tt>Person.delete_all</tt>
+      #
+      # Returns: true or raises an error.
       def delete_all(conditions = {})
         DeleteAll.execute(self, conditions)
       end
 
-      # Destroy all the +Documents+ in the database given the supplied
-      # conditions.
+      # Delete all documents given the supplied conditions. If no conditions
+      # are passed, the entire collection will be dropped for performance
+      # benefits. Fires the destroy callbacks if conditions were passed.
+      #
+      # Example:
+      #
+      # <tt>Person.destroy_all(:conditions => { :title => "Sir" })</tt>
+      # <tt>Person.destroy_all</tt>
+      #
+      # Returns: true or raises an error.
       def destroy_all(conditions = {})
         DestroyAll.execute(self, conditions)
       end

data/lib/mongoid/commands/delete_all.rb

@@ -14,9 +14,8 @@ module Mongoid #:nodoc:
       #
       # <tt>DeleteAll.execute(Person, :conditions => { :field => "value" })</tt>
       def self.execute(klass, params = {})
-        params.any? ? klass.find(:all, params).each do
-          |doc| Delete.execute(doc)
-        end : klass.collection.drop
+        collection = klass.collection
+        params.any? ? collection.remove(params[:conditions].merge(:_type => klass.name)) : collection.drop
       end
     end
   end

data/lib/mongoid/commands/deletion.rb

@@ -5,7 +5,7 @@ module Mongoid #:nodoc
       # If the +Document+ has a parent, delete it from the parent's attributes,
       # otherwise delete it from it's collection.
       def delete(doc)
-        parent = doc.parent
+        parent = doc._parent
         parent ? parent.remove(doc) : doc.collection.remove(:_id => doc.id)
       end
     end

data/lib/mongoid/commands/destroy_all.rb

@@ -14,6 +14,8 @@ module Mongoid #:nodoc:
       #
       # <tt>DestroyAll.execute(Person, :conditions => { :field => "value" })</tt>
       def self.execute(klass, params)
+        conditions = params[:conditions] || {}
+        params[:conditions] = conditions.merge(:_type => klass.name)
         klass.find(:all, params).each { |doc| Destroy.execute(doc) }
       end
     end

data/lib/mongoid/commands/save.rb

@@ -13,7 +13,7 @@ module Mongoid #:nodoc:
       def self.execute(doc, validate = true)
         return false if validate && !doc.valid?
         doc.run_callbacks :before_save
-        parent = doc.parent
+        parent = doc._parent
         doc.new_record = false
         parent ? Save.execute(parent) : doc.collection.save(doc.attributes)
         doc.run_callbacks :after_save

data/lib/mongoid/criteria.rb

@@ -214,7 +214,7 @@ module Mongoid #:nodoc:
     # type: One of :all, :first:, or :last
     # klass: The class to execute on.
     def initialize(klass)
-      @selector, @options, @klass = {}, {}, klass
+      @selector, @options, @klass = { :_type => klass.name }, {}, klass
     end
 
     # Return the last result for the +Criteria+. Essentially does a find_one on

data/lib/mongoid/document.rb

@@ -10,11 +10,26 @@ module Mongoid #:nodoc:
         extend ClassMethods
         extend Finders
 
-        attr_accessor :association_name, :parent
+        # Set up the class attributes that must be available to all subclasses.
+        # These include defaults, fields
+        class_inheritable_accessor :defaults, :fields
+
+        # The same collection is used for the entire class hierarchy.
+        cattr_accessor :_collection, :collection_name, :embedded, :primary_key
+
+        # Set the initial values. Defaults and fields get set to a
+        # +HashWithIndifferentAccess+ while the collection name will get set to
+        # the demodulized class.
+        self.defaults = {}.with_indifferent_access
+        self.fields = {}.with_indifferent_access
+        self.collection_name ||= self.to_s.demodulize.tableize
+
+        attr_accessor :association_name, :_parent
         attr_reader :attributes, :new_record
 
         delegate :collection, :defaults, :embedded?, :fields, :primary_key, :to => :klass
 
+        # Define all the callbacks that are accepted by the document.
         define_callbacks :before_create, :before_destroy, :before_save, :before_update, :before_validation
         define_callbacks :after_create, :after_destroy, :after_save, :after_update, :after_validation
       end
@@ -28,23 +43,12 @@ module Mongoid #:nodoc:
       # Returns: <tt>Mongo::Collection</tt>
       def collection
         raise Errors::InvalidCollection.new(self) if embedded?
-        @collection_name ||= self.to_s.demodulize.tableize
-        @collection ||= Mongoid.database.collection(@collection_name)
-      end
-
-      # Set the collection name for the +Document+.
-      def collection_name(name)
-        @collection_name = name
-      end
-
-      # Returns a hash of all the default values
-      def defaults
-        @defaults
+        self._collection ||= Mongoid.database.collection(self.collection_name)
       end
 
       # return true if the +Document+ is embedded in another +Documnet+.
       def embedded?
-        @embedded == true
+        self.embedded == true
       end
 
       # Defines all the fields that are accessable on the Document
@@ -64,11 +68,6 @@ module Mongoid #:nodoc:
         set_default(name, options)
       end
 
-      # Returns all the fields for the Document as a +Hash+ with names as keys.
-      def fields
-        @fields
-      end
-
       # Returns a human readable version of the class.
       def human_name
         name.underscore.humanize
@@ -98,13 +97,13 @@ module Mongoid #:nodoc:
       # web applications and *MUST* be defined on documents that are embedded
       # in order for proper updates in has_may associations.
       def key(*fields)
-        @primary_key = fields
+        self.primary_key = fields
         before_save :generate_key
       end
 
-      # Returns the primary key field of the +Document+
-      def primary_key
-        @primary_key
+      # Macro for setting the collection name to store in.
+      def store_in(name)
+        self.collection_name = name.to_s
       end
 
       protected
@@ -112,8 +111,7 @@ module Mongoid #:nodoc:
       # Define a field attribute for the +Document+.
       def set_field(name, options = {})
         meth = options.delete(:as) || name
-        @fields ||= {}.with_indifferent_access
-        @fields[name] = Field.new(name.to_s, options)
+        fields[name] = Field.new(name.to_s, options)
         create_accessors(name, meth, options)
       end
 
@@ -127,8 +125,7 @@ module Mongoid #:nodoc:
       # Set up a default value for a field.
       def set_default(name, options = {})
         value = options[:default]
-        @defaults ||= {}.with_indifferent_access
-        @defaults[name] = value if value
+        defaults[name] = value if value
       end
 
     end
@@ -199,7 +196,7 @@ module Mongoid #:nodoc:
         process(defaults.merge(attrs))
         @new_record = true if id.nil?
         document = yield self if block_given?
-        generate_key; document
+        generate_key; generate_type; document
       end
 
       # Returns the class name plus its attributes.
@@ -209,7 +206,7 @@ module Mongoid #:nodoc:
       end
 
       # Returns true is the +Document+ has not been persisted to the database,
-      # false if it has. This is determined by the instance variable @new_record
+      # false if it has. This is determined by the variable @new_record
       # and NOT if the object has an id.
       def new_record?
         @new_record == true
@@ -243,7 +240,7 @@ module Mongoid #:nodoc:
       #
       # <tt>address.parentize(person, :addresses)</tt>
       def parentize(object, association_name)
-        self.parent = object
+        self._parent = object
         self.association_name = association_name
         add_observer(object)
       end
@@ -264,9 +261,9 @@ module Mongoid #:nodoc:
 
       # Return the root +Document+ in the object graph. If the current +Document+
       # is the root object in the graph it will return self.
-      def root
+      def _root
         object = self
-        while (object.parent) do object = object.parent; end
+        while (object._parent) do object = object._parent; end
         object || self
       end
 
@@ -280,6 +277,16 @@ module Mongoid #:nodoc:
         id
       end
 
+      # Returns the object type.
+      def _type
+        @attributes[:_type]
+      end
+
+      # Set the type.
+      def _type=(new_type)
+        @attributes[:_type] = new_type
+      end
+
       # Observe a notify call from a child +Document+. This will either update
       # existing attributes on the +Document+ or clear them out for the child if
       # the clear boolean is provided.
@@ -320,6 +327,10 @@ module Mongoid #:nodoc:
         end
       end
 
+      def generate_type
+        @attributes[:_type] = self.class.name unless @attributes[:_type]
+      end
+
       # Convenience method to get the document's class
       def klass
         self.class