mongoid 3.0.0.rc → 3.0.0

data/lib/mongoid/config/environment.rb

@@ -8,11 +8,13 @@ module Mongoid
 
       # Get the name of the environment that we are running under. This first
       # looks for Rails, then Sinatra, then a RACK_ENV environment variable,
-      # and if none of those are found returns "development".
+      # and if none of those are found raises an error.
       #
       # @example Get the env name.
       #   Environment.env_name
       #
+      # @raise [ Errors::NoEnvironment ] If no environment was set.
+      #
       # @return [ String ] The name of the current environment.
       #
       # @since 2.3.0

data/lib/mongoid/contextual/aggregable/memory.rb

@@ -38,11 +38,7 @@ module Mongoid
         #
         # @since 3.0.0
         def max(field = nil)
-          if block_given?
-            super()
-          else
-            count > 0 ? max_by { |doc| doc.send(field) }.send(field) : nil
-          end
+          block_given? ? super() : aggregate_by(field, :max_by)
         end
 
         # Get the min value of the provided field. If provided a block, will
@@ -64,11 +60,7 @@ module Mongoid
         #
         # @since 3.0.0
         def min(field = nil)
-          if block_given?
-            super()
-          else
-            count > 0 ? min_by { |doc| doc.send(field) }.send(field) : nil
-          end
+          block_given? ? super() : aggregate_by(field, :min_by)
         end
 
         # Get the sum value of the provided field. If provided a block, will
@@ -92,6 +84,25 @@ module Mongoid
             count > 0 ? super(0) { |doc| doc.send(field) } : nil
           end
         end
+
+        private
+
+        # Aggregate by the provided field and method.
+        #
+        # @api private
+        #
+        # @example Aggregate by the field and method.
+        #   aggregable.aggregate_by(:name, :min_by)
+        #
+        # @param [ Symbol ] field The field to aggregate on.
+        # @param [ Symbol ] method The method (min_by or max_by).
+        #
+        # @return [ Integer ] The aggregate.
+        #
+        # @since 3.0.0
+        def aggregate_by(field, method)
+          count > 0 ? send(method) { |doc| doc.send(field) }.send(field) : nil
+        end
       end
     end
   end

data/lib/mongoid/contextual/find_and_modify.rb

@@ -4,6 +4,12 @@ module Mongoid
     class FindAndModify
       include Command
 
+      # @attribute [r] criteria The criteria for the context.
+      # @attribute [r] options The command options.
+      # @attribute [r] update The updates.
+      # @attribute [r] query The Moped query.
+      attr_reader :criteria, :options, :update, :query
+
       # Initialize the find and modify command, used for MongoDB's
       # $findAndModify.
       #
@@ -16,13 +22,12 @@ module Mongoid
       #
       # @option options [ true, false ] :new Return the updated document.
       # @option options [ true, false ] :remove Delete the first document.
+      # @option options [ true, false ] :upsert Create the document if it doesn't exist.
       #
       # @since 3.0.0
       def initialize(criteria, update, options = {})
-        @criteria = criteria
-        command[:findandmodify] = criteria.klass.collection_name.to_s
-        command[:update] = update unless options[:remove]
-        command.merge!(options)
+        @criteria, @options, @update = criteria, options, update
+        @query = criteria.klass.collection.find(criteria.selector)
         apply_criteria_options
       end
 
@@ -35,9 +40,7 @@ module Mongoid
       #
       # @since 3.0.0
       def result
-        session.with(consistency: :strong) do |session|
-          session.command(command)["value"]
-        end
+        query.modify(update, options)
       end
 
       private
@@ -53,12 +56,11 @@ module Mongoid
       #
       # @since 3.0.0
       def apply_criteria_options
-        command[:query] = criteria.selector
-        if sort = criteria.options[:sort]
-          command[:sort] = sort
+        if spec = criteria.options[:sort]
+          query.sort(spec)
         end
-        if fields = criteria.options[:fields]
-          command[:fields] = fields
+        if spec = criteria.options[:fields]
+          query.select(spec)
         end
       end
     end

data/lib/mongoid/contextual/memory.rb

@@ -345,6 +345,27 @@ module Mongoid
         end
       end
 
+      # Compare two values, checking for nil.
+      #
+      # @api private
+      #
+      # @example Compare the two objects.
+      #   context.compare(a, b)
+      #
+      # @param [ Object ] a The first object.
+      # @param [ Object ] b The first object.
+      #
+      # @return [ Integer ] The comparison value.
+      #
+      # @since 3.0.0
+      def compare(a, b)
+        case
+        when a.nil? then b.nil? ? 0 : 1
+        when b.nil? then -1
+        else a <=> b
+        end
+      end
+
       # Sort the documents in place.
       #
       # @example Sort the documents.
@@ -356,7 +377,9 @@ module Mongoid
       def in_place_sort(values)
         values.each_pair do |field, dir|
           documents.sort! do |a, b|
-            dir > 0 ? a[field] <=> b[field] : b[field] <=> a[field]
+            a_value, b_value = a[field], b[field]
+            value = compare(a_value.__sortable__, b_value.__sortable__)
+            dir < 0 ? value * -1 : value
           end
         end
       end

data/lib/mongoid/contextual/mongo.rb

@@ -33,6 +33,18 @@ module Mongoid
       end
       alias :empty? :blank?
 
+      # Is the context cached?
+      #
+      # @example Is the context cached?
+      #   context.cached?
+      #
+      # @return [ true, false ] If the context is cached.
+      #
+      # @since 3.0.0
+      def cached?
+        !!@cache
+      end
+
       # Get the number of documents matching the query.
       #
       # @example Get the number of matching documents.
@@ -114,25 +126,15 @@ module Mongoid
       # @return [ Enumerator ] The enumerator.
       #
       # @since 3.0.0
-      def each
+      def each(&block)
         if block_given?
           reset_length
           selecting do
-            if eager_loadable?
-              docs = query.map{ |doc| Factory.from_db(klass, doc) }
-              eager_load(docs)
-              docs.each do |doc|
-                yield doc
-                increment_length
-              end
-              docs
-            else
-              query.each do |doc|
-                yield Factory.from_db(klass, doc)
-                increment_length
-              end
-              self
+            documents_for_iteration.each do |doc|
+              yield_and_increment(doc, &block)
             end
+            @cache_loaded = true
+            eager_loadable? ? docs : self
           end
         else
           to_enum
@@ -174,6 +176,7 @@ module Mongoid
       #
       # @option options [ true, false ] :new Return the updated document.
       # @option options [ true, false ] :remove Delete the first document.
+      # @option options [ true, false ] :upsert Create the document if it doesn't exist.
       #
       # @return [ Document ] The result of the command.
       #
@@ -207,7 +210,7 @@ module Mongoid
       #
       # @since 3.0.0
       def initialize(criteria)
-        @criteria, @klass = criteria, criteria.klass
+        @criteria, @klass, @cache = criteria, criteria.klass, criteria.options[:cache]
         add_type_selection
         @query = klass.collection.find(criteria.selector)
         apply_options
@@ -304,7 +307,7 @@ module Mongoid
       # Update all the matching documents atomically.
       #
       # @example Update all the matching documents.
-      #   context.update(name: "Smiths")
+      #   context.update({ "$set" => { name: "Smiths" }})
       #
       # @param [ Hash ] attributes The new attributes for each document.
       #
@@ -313,7 +316,7 @@ module Mongoid
       # @since 3.0.0
       def update(attributes = nil)
         return false unless attributes
-        query.update_all({ "$set" => attributes })
+        query.update_all(attributes.__consolidate__)
       end
       alias :update_all :update
 
@@ -388,6 +391,18 @@ module Mongoid
         end
       end
 
+      # Apply the hint option
+      #
+      # @example Apply the hint params.
+      #   context.apply_hint
+      #
+      # @since 3.0.0
+      def apply_hint
+        if spec = criteria.options[:hint]
+          query.hint(spec)
+        end
+      end
+
       # Map the inverse sort symbols to the correct MongoDB values.
       #
       # @example Apply the inverse sorting params.
@@ -402,6 +417,77 @@ module Mongoid
         end
       end
 
+      # Is the cache able to be added to?
+      #
+      # @api private
+      #
+      # @example Is the context cacheable?
+      #   context.cacheable?
+      #
+      # @return [ true, false ] If caching, and the cache isn't loaded.
+      #
+      # @since 3.0.0
+      def cacheable?
+        cached? && !cache_loaded?
+      end
+
+      # Is the cache fully loaded? Will be true if caching after one full
+      # iteration.
+      #
+      # @api private
+      #
+      # @example Is the cache loaded?
+      #   context.cache_loaded?
+      #
+      # @return [ true, false ] If the cache is loaded.
+      #
+      # @since 3.0.0
+      def cache_loaded?
+        !!@cache_loaded
+      end
+
+      # Get the documents for cached queries.
+      #
+      # @api private
+      #
+      # @example Get the cached documents.
+      #   context.documents
+      #
+      # @return [ Array<Document> ] The documents.
+      #
+      # @since 3.0.0
+      def documents
+        @documents ||= []
+      end
+
+      # Get the documents the context should iterate. This follows 3 rules:
+      #
+      # 1. If the query is cached, and we already have documents loaded, use
+      #   them.
+      # 2. If we are eager loading, then eager load the documents and use
+      #   those.
+      # 3. Use the query.
+      #
+      # @api private
+      #
+      # @example Get the documents for iteration.
+      #   context.documents_for_iteration
+      #
+      # @return [ Array<Document>, Moped::Query ] The docs to iterate.
+      #
+      # @since 3.0.0
+      def documents_for_iteration
+        if cached? && !documents.empty?
+          documents
+        elsif eager_loadable?
+          docs = query.map{ |doc| Factory.from_db(klass, doc) }
+          eager_load(docs)
+          docs
+        else
+          query
+        end
+      end
+
       # Eager load the inclusions for the provided documents.
       #
       # @example Eager load the inclusions.
@@ -414,19 +500,32 @@ module Mongoid
       # @since 3.0.0
       def eager_load(docs)
         criteria.inclusions.reject! do |metadata|
-          unless docs.empty?
-            if metadata.stores_foreign_key?
-              child_ids = load_ids(metadata.foreign_key).flatten
-              metadata.eager_load(child_ids)
-            else
-              parent_ids = docs.map(&:id)
-              metadata.eager_load(parent_ids)
-            end
-          end
+          metadata.eager_load(eager_loaded_ids(docs, metadata)) if !docs.empty?
         end
         self.eager_loaded = true
       end
 
+      # Get the ids that to be used to eager load documents.
+      #
+      # @api private
+      #
+      # @example Get the ids.
+      #   context.eager_load(docs, metadata)
+      #
+      # @param [ Array<Document> ] docs The pre-loaded documents.
+      # @param [ Metadata ] metadata The relation metadata.
+      #
+      # @return [ Array<Object> ] The ids.
+      #
+      # @since 3.0.0
+      def eager_loaded_ids(docs, metadata)
+        if metadata.stores_foreign_key?
+          load_ids(metadata.foreign_key).flatten
+        else
+          docs.map(&:id)
+        end
+      end
+
       # Is this context able to be eager loaded?
       #
       # @example Is the context eager loadable?
@@ -436,7 +535,7 @@ module Mongoid
       #
       # @since 3.0.0
       def eager_loadable?
-        !eager_loaded && criteria.inclusions.any?
+        !eager_loaded && !criteria.inclusions.empty?
       end
 
       # Increment the length of the results.
@@ -475,7 +574,7 @@ module Mongoid
       #
       # @param [ String ] key The id or foriegn key string.
       #
-      # @return [ Array<String, BSON::ObjectId> ] The ids to load.
+      # @return [ Array<String, Moped::BSON::ObjectId> ] The ids to load.
       #
       # @since 3.0.0
       def load_ids(key)
@@ -495,6 +594,7 @@ module Mongoid
         apply_limit
         apply_skip
         apply_sorting
+        apply_hint
       end
 
       # If we are limiting results, we need to set the field limitations on a
@@ -538,6 +638,25 @@ module Mongoid
           doc
         end
       end
+
+      # Yield to the document and increment the length.
+      #
+      # @api private
+      #
+      # @example Yield and increment.
+      #   context.yield_and_increment(doc) do |doc|
+      #     ...
+      #   end
+      #
+      # @param [ Document ] document The document to yield to.
+      #
+      # @since 3.0.0
+      def yield_and_increment(document, &block)
+        doc = document.respond_to?(:_id) ? document : Factory.from_db(klass, document)
+        yield(doc)
+        increment_length
+        documents.push(doc) if cacheable?
+      end
     end
   end
 end

data/lib/mongoid/copyable.rb

@@ -5,15 +5,6 @@ module Mongoid
   module Copyable
     extend ActiveSupport::Concern
 
-    COPYABLES = [
-      :attributes,
-      :metadata,
-      :changed_attributes,
-      :previous_changes
-    ]
-
-    protected
-
     # Clone or dup the current +Document+. This will return all attributes with
     # the exception of the document's id and versions, and will reset all the
     # instance variables.
@@ -23,25 +14,16 @@ module Mongoid
     # @example Clone the document.
     #   document.clone
     #
-    # @example Dup the document.
-    #   document.dup
-    #
     # @param [ Document ] other The document getting cloned.
     #
     # @return [ Document ] The new document.
-    def initialize_copy(other)
-      other.as_document
-      instance_variables.each { |name| remove_instance_variable(name) }
-      COPYABLES.each do |name|
-        value = other.send(name)
-        instance_variable_set(:"@#{name}", value ? value.dup : nil)
-      end
-      attributes.delete("_id")
-      if attributes.delete("versions")
-        attributes["version"] = 1
+    def clone
+      attrs = as_document.except("_id")
+      if attrs.delete("versions")
+        attrs["version"] = 1
       end
-      @new_record = true
-      apply_defaults
+      self.class.new(attrs)
     end
+    alias :dup :clone
   end
 end