mongoid 2.1.9 → 2.2.0

data/lib/mongoid/attributes.rb

@@ -25,6 +25,7 @@ module Mongoid #:nodoc:
       attribute = read_attribute(name)
       ! attribute.blank? || attribute == false
     end
+    alias :has_attribute? :attribute_present?
 
     # Read a value from the document attributes. If the value does not exist
     # it will return nil.
@@ -55,9 +56,11 @@ module Mongoid #:nodoc:
     #
     # @since 1.0.0
     def remove_attribute(name)
-      access = name.to_s
-      attribute_will_change!(access)
-      attributes.delete(access)
+      assigning do
+        access = name.to_s
+        attribute_will_change!(access)
+        attributes.delete(access)
+      end
     end
 
     # Override respond_to? so it responds properly for dynamic attributes.
@@ -92,12 +95,14 @@ module Mongoid #:nodoc:
     #
     # @since 1.0.0
     def write_attribute(name, value)
-      access = name.to_s
-      typed_value_for(access, value).tap do |value|
-        unless attributes[access] == value || attribute_changed?(access)
-          attribute_will_change!(access)
+      assigning do
+        access = name.to_s
+        typed_value_for(access, value).tap do |value|
+          unless attributes[access] == value || attribute_changed?(access)
+            attribute_will_change!(access)
+          end
+          attributes[access] = value
         end
-        attributes[access] = value
       end
     end
     alias :[]= :write_attribute
@@ -117,8 +122,10 @@ module Mongoid #:nodoc:
     #
     # @since 1.0.0
     def write_attributes(attrs = nil, guard_protected_attributes = true)
-      process(attrs, guard_protected_attributes) do |document|
-        document.identify if new? && id.blank?
+      assigning do
+        process(attrs, guard_protected_attributes) do |document|
+          document.identify if new? && id.blank?
+        end
       end
     end
     alias :attributes= :write_attributes
@@ -145,6 +152,27 @@ module Mongoid #:nodoc:
       end
     end
 
+    # Begin the assignment of attributes. While in this block embedded
+    # documents will not autosave themselves in order to allow the document to
+    # be in a valid state.
+    #
+    # @example Execute the assignment.
+    #   assigning do
+    #     person.attributes = { :addresses => [ address ] }
+    #   end
+    #
+    # @return [ Object ] The yielded value.
+    #
+    # @since 2.2.0
+    def assigning
+      begin
+        Threaded.begin_assign
+        yield
+      ensure
+        Threaded.exit_assign
+      end
+    end
+
     # Used for allowing accessor methods for dynamic attributes.
     #
     # @param [ String, Symbol ] name The name of the method.

data/lib/mongoid/collection.rb

@@ -17,6 +17,18 @@ module Mongoid #:nodoc
     #   collection.save({ :name => "Al" })
     delegate *(Collections::Operations::PROXIED.dup << {:to => :master})
 
+    # Get the unwrapped driver collection for this mongoid collection.
+    #
+    # @example Get the driver collection.
+    #   collection.driver
+    #
+    # @return [ Mongo::Collection ] The driver collection.
+    #
+    # @since 2.2.0
+    def driver
+      master.collection
+    end
+
     # Find documents from the database given a selector and options.
     #
     # @example Find documents in the collection.
@@ -56,8 +68,14 @@ module Mongoid #:nodoc
     #
     # @param [ Class ] klass The class the collection is for.
     # @param [ String ] name The name of the collection.
-    def initialize(klass, name)
-      @klass, @name = klass, name
+    # @param [ Hash ] options The collection options.
+    #
+    # @option options [ true, false ] :capped If the collection is capped.
+    # @option options [ Integer ] :size The capped collection size.
+    # @option options [ Integer ] :max The maximum number of docs in the
+    #   capped collection.
+    def initialize(klass, name, options = {})
+      @klass, @name, @options = klass, name, options || {}
     end
 
     # Inserts one or more documents in the collection.
@@ -106,7 +124,7 @@ module Mongoid #:nodoc
     def master(options = {})
       options.delete(:cache)
       db = Mongoid.databases[klass.database] || Mongoid.master
-      @master ||= Collections::Master.new(db, @name)
+      @master ||= Collections::Master.new(db, @name, @options)
     end
 
     # Updates one or more documents in the collection.

data/lib/mongoid/collections.rb

@@ -6,13 +6,41 @@ module Mongoid #:nodoc
   module Collections
     extend ActiveSupport::Concern
 
-    delegate :collection, :db, :to => "self.class"
-
     included do
       cattr_accessor :_collection, :collection_name
       self.collection_name = self.name.collectionize
     end
 
+    # Get the collection for the class.
+    #
+    # @note Defining methods instead of delegate to avoid calls to
+    #   Kernel.caller for class load performance reasons.
+    #
+    # @example Get the collection.
+    #   person.collection
+    #
+    # @return [ Collection ] The class collection.
+    #
+    # @since 1.0.0
+    def collection
+      self.class.collection
+    end
+
+    # Get the database for the class.
+    #
+    # @note Defining methods instead of delegate to avoid calls to
+    #   Kernel.caller for class load performance reasons.
+    #
+    # @example Get the database.
+    #   person.db
+    #
+    # @return [ DB ] The class db.
+    #
+    # @since 1.0.0
+    def db
+      self.class.db
+    end
+
     module ClassMethods #:nodoc:
 
       # Returns the collection associated with this +Document+. If the
@@ -53,9 +81,20 @@ module Mongoid #:nodoc
       #
       # @example Store in a separate collection than the default.
       #   Model.store_in :population
-      def store_in(name)
+      #
+      # @example Store in a capped collection.
+      #   Model.store_in :population, :capped => true, :max => 10000
+      #
+      # @param [ Symbol ] name The name of the collection.
+      # @param [ Hash ] options The collection options.
+      #
+      # @option options [ true, false ] :capped If the collection is capped.
+      # @option options [ Integer ] :size The capped collection size.
+      # @option options [ Integer ] :max The maximum number of docs in the
+      #   capped collection.
+      def store_in(name, options = {})
         self.collection_name = name.to_s
-        set_collection
+        set_collection(options)
       end
 
       protected
@@ -65,9 +104,16 @@ module Mongoid #:nodoc
       # @example Set the collection.
       #   Model.set_collection
       #
+      # @param [ Hash ] options The collection options.
+      #
+      # @option options [ true, false ] :capped If the collection is capped.
+      # @option options [ Integer ] :size The capped collection size.
+      # @option options [ Integer ] :max The maximum number of docs in the
+      #   capped collection.
+
       # @return [ Collection ] The Mongoid collection wrapper.
-      def set_collection
-        self._collection = Mongoid::Collection.new(self, self.collection_name)
+      def set_collection(options = {})
+        self._collection = Collection.new(self, self.collection_name, options)
       end
     end
   end

data/lib/mongoid/collections/master.rb

@@ -31,8 +31,14 @@ module Mongoid #:nodoc:
       #
       # @param [ Mongo::DB ] master The master database.
       # @param [ String ] name The name of the database.
-      def initialize(master, name)
-        @collection = master.collection(name)
+      # @param [ Hash ] options The collection options.
+      #
+      # @option options [ true, false ] :capped If the collection is capped.
+      # @option options [ Integer ] :size The capped collection size.
+      # @option options [ Integer ] :max The maximum number of docs in the
+      #   capped collection.
+      def initialize(master, name, options = {})
+        @collection = master.create_collection(name, options)
       end
     end
   end

data/lib/mongoid/collections/operations.rb

@@ -28,6 +28,7 @@ module Mongoid #:nodoc:
         :drop,
         :drop_index,
         :drop_indexes,
+        :find_and_modify,
         :insert,
         :remove,
         :rename,

data/lib/mongoid/config.rb

@@ -166,7 +166,10 @@ module Mongoid #:nodoc
     #
     # @return [ Logger ] The newly set logger.
     def logger=(logger)
-      @logger = logger
+      case logger
+        when Logger then @logger = logger
+        when false, nil then @logger = nil
+      end
     end
 
     # Purge all data in all collections, including indexes.
@@ -202,7 +205,7 @@ module Mongoid #:nodoc
     # set is not a valid +Mongo::DB+, then an error will be raised.
     #
     # @example Set the master database.
-    #   config.master = Mongo::Connection.db("test")
+    #   config.master = Mongo::Connection.new.db("test")
     #
     # @param [ Mongo::DB ] db The master database.
     #

data/lib/mongoid/config/database.rb

@@ -7,7 +7,7 @@ module Mongoid #:nodoc:
     class Database < Hash
 
       # keys to remove from self to not pass through to Mongo::Connection
-      PRIVATE_OPTIONS = %w(uri database username password)
+      PRIVATE_OPTIONS = %w(uri database username password logger)
 
       # Configure the database connections. This will return an array
       # containing the master and an array of slaves.
@@ -108,6 +108,19 @@ module Mongoid #:nodoc:
         end
       end
 
+      # Should we use a logger?
+      #
+      # @example Should we use a logger?
+      #   database.logger?
+      #
+      # @return [ true, false ] Defaults to true, false if specifically
+      #   defined.
+      #
+      # @since 2.2.0
+      def logger?
+        self[:logger].nil? || self[:logger] ? true : false
+      end
+
       # Convenience for accessing the hash via dot notation.
       #
       # @example Access a value in alternate syntax.
@@ -147,7 +160,7 @@ module Mongoid #:nodoc:
       def optional(slave = false)
         ({
           :pool_size => pool_size,
-          :logger => Mongoid::Logger.new,
+          :logger => logger? ? Mongoid::Logger.new : nil,
           :slave_ok => slave
         }).merge(self).reject { |k,v| PRIVATE_OPTIONS.include? k }.
           inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo} # mongo likes symbols

data/lib/mongoid/contexts/mongo.rb

@@ -140,6 +140,9 @@ module Mongoid #:nodoc:
       #
       # @return [ Cursor ] An enumerable +Cursor+ of results.
       def execute
+        criteria.inclusions.reject! do |metadata|
+          metadata.eager_load(criteria)
+        end
         klass.collection.find(selector, process_options) || []
       end
 

data/lib/mongoid/criteria.rb

@@ -32,7 +32,6 @@ module Mongoid #:nodoc:
     include Criterion::Optional
 
     attr_accessor \
-      :collection,
       :documents,
       :embedded,
       :ids,
@@ -109,6 +108,18 @@ module Mongoid #:nodoc:
       end
     end
 
+    # Get the collection associated with the criteria.
+    #
+    # @example Get the collection.
+    #   criteria.collection
+    #
+    # @return [ Collection ] The collection.
+    #
+    # @since 2.2.0
+    def collection
+      klass.collection
+    end
+
     # Return or create the context in which this criteria should be executed.
     #
     # This will return an Enumerable context if the class is embedded,
@@ -154,7 +165,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.0.0
     def freeze
-      context and super
+      context and inclusions and super
     end
 
     # Merges the supplied argument hash into a single criteria
@@ -298,7 +309,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.0.0
     def raise_invalid
-      raise Errors::InvalidOptions.new(:calling_document_find_with_nil_is_invalid, {})
+      raise Errors::InvalidFind.new
     end
 
     protected
@@ -316,6 +327,18 @@ module Mongoid #:nodoc:
       other.is_a?(Criteria) ? other.entries : other
     end
 
+    # Get the raw driver collection from the criteria.
+    #
+    # @example Get the raw driver collection.
+    #   criteria.driver
+    #
+    # @return [ Mongo::Collection ] The driver collection.
+    #
+    # @since 2.2.0
+    def driver
+      collection.driver
+    end
+
     # Clone or dup the current +Criteria+. This will return a new criteria with
     # the selector, options, klass, embedded options, etc intact.
     #
@@ -331,6 +354,7 @@ module Mongoid #:nodoc:
     def initialize_copy(other)
       @selector = other.selector.dup
       @options = other.options.dup
+      @includes = other.inclusions.dup
       @context = nil
     end
 

data/lib/mongoid/criterion/inclusion.rb

@@ -125,6 +125,64 @@ module Mongoid #:nodoc:
       end
       alias :any_in :in
 
+      # Eager loads all the provided relations. Will load all the documents
+      # into the identity map who's ids match based on the extra query for the
+      # ids.
+      #
+      # @note This will only work if Mongoid's identity map is enabled. To do
+      #   so set identity_map_enabled: true in your mongoid.yml
+      #
+      # @note This will work for embedded relations that reference another
+      #   collection via belongs_to as well.
+      #
+      # @note Eager loading brings all the documents into memory, so there is a
+      #   sweet spot on the performance gains. Internal benchmarks show that
+      #   eager loading becomes slower around 100k documents, but this will
+      #   naturally depend on the specific application.
+      #
+      # @example Eager load the provided relations.
+      #   Person.includes(:posts, :game)
+      #
+      # @param [ Array<Symbol> ] relations The names of the relations to eager
+      #   load.
+      #
+      # @return [ Criteria ] The cloned criteria.
+      #
+      # @since 2.2.0
+      def includes(*relations)
+        relations.each do |name|
+          inclusions.push(klass.reflect_on_association(name))
+        end
+        clone
+      end
+
+      # Get a list of criteria that are to be executed for eager loading.
+      #
+      # @example Get the eager loading inclusions.
+      #   Person.includes(:game).inclusions
+      #
+      # @return [ Array<Metadata> ] The inclusions.
+      #
+      # @since 2.2.0
+      def inclusions
+        @inclusions ||= []
+      end
+
+      # Loads an array of ids only for the current criteria. Used by eager
+      # loading to determine the documents to load.
+      #
+      # @example Load the related ids.
+      #   criteria.load_ids("person_id")
+      #
+      # @param [ String ] key The id or foriegn key string.
+      #
+      # @return [ Array<String, BSON::ObjectId> ] The ids to load.
+      #
+      # @since 2.2.0
+      def load_ids(key)
+        driver.find(selector, { :fields => { key => 1 }}).map { |doc| doc[key] }
+      end
+
       # Adds a criterion to the +Criteria+ that specifies values to do
       # geospacial searches by. The field must be indexed with the "2d" option.
       #

data/lib/mongoid/dirty.rb

@@ -41,6 +41,8 @@ module Mongoid #:nodoc:
       @_children = nil
       @previously_changed = changes
       @validated = false
+      atomic_pulls.clear
+      atomic_unsets.clear
       changed_attributes.clear
     end