mongoid 3.0.23 → 3.1.0

data/lib/mongoid/contextual.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
-require "mongoid/contextual/memory"
+require "mongoid/contextual/queryable"
 require "mongoid/contextual/mongo"
+require "mongoid/contextual/memory"
 
 module Mongoid
   module Contextual

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

@@ -24,8 +24,12 @@ module Mongoid
         # @since 3.0.0
         def aggregates(field)
           if query.count > 0
-            map_reduce(mapper(field), reducer).
-              out(inline: 1).finalize(finalizer).first["value"]
+            result = collection.aggregate(pipeline(field)).to_a
+            if result.empty?
+              { "count" => query.count, "avg" => 0, "sum" => 0 }
+            else
+              result.first
+            end
           else
             { "count" => 0 }
           end
@@ -109,73 +113,33 @@ module Mongoid
 
         private
 
-        # Get the finalize function.
+        # Get the aggregation pipeline for provided field.
         #
         # @api private
         #
-        # @example Get the finalize function.
-        #   aggregable.finalizer
-        #
-        # @return [ String ] The finalize JS function.
-        #
-        # @since 3.0.0
-        def finalizer
-          %Q{
-          function(key, agg) {
-            agg.avg = agg.sum / agg.count;
-            return agg;
-          }}
-        end
-
-        # Get the map function for the provided field.
-        #
-        # @api private
-        #
-        # @example Get the map function.
-        #   aggregable.mapper(:likes)
+        # @example Get the pipeline.
+        #   aggregable.pipeline(:likes)
         #
         # @param [ String, Symbol ] field The name of the field.
         #
-        # @return [ String ] The map JS function.
-        #
-        # @since 3.0.0
-        def mapper(field)
-          %Q{
-          function() {
-            var agg = {
-              count: 1,
-              max: this.#{field},
-              min: this.#{field},
-              sum: this.#{field}
-            };
-            emit("#{field}", agg);
-          }}
-        end
-
-        # Get the reduce function for the provided field.
-        #
-        # @api private
-        #
-        # @example Get the reduce function.
-        #   aggregable.reducer(:likes)
-        #
-        # @return [ String ] The reduce JS function.
-        #
-        # @since 3.0.0
-        def reducer
-          %Q{
-          function(key, values) {
-            var agg = { count: 0, max: null, min: null, sum: 0 };
-            values.forEach(function(val) {
-              if (val.max !== null) {
-                if (agg.max == null || val.max > agg.max) agg.max = val.max;
-                if (agg.min == null || val.max < agg.min) agg.min = val.max;
-                agg.sum += val.sum;
-              }
-              agg.count += val.count;
-            });
-            return agg;
-          }}
+        # @return [ Array ] The array of pipeline operators.
+        #
+        # @since 3.1.0
+        def pipeline(field)
+          db_field = "$#{database_field_name(field)}"
+          pipeline = []
+          pipeline << { "$match" => criteria.nin(field => nil).selector }
+          pipeline << { "$limit" => criteria.options[:limit] } if criteria.options[:limit]
+          pipeline << {
+            "$group"  => {
+              "_id"   => field.to_s,
+              "count" => { "$sum" => 1 },
+              "max"   => { "$max" => db_field },
+              "min"   => { "$min" => db_field },
+              "sum"   => { "$sum" => db_field },
+              "avg"   => { "$avg" => db_field }
+            }
+          }
         end
       end
     end

data/lib/mongoid/contextual/atomic.rb

@@ -166,13 +166,14 @@ module Mongoid
       # @example Unset the field on the matches.
       #   context.unset(:name)
       #
-      # @param [ String, Symbol ] field The name of the field.
+      # @param [ String, Symbol, Array ] fields The name of the fields.
       #
       # @return [ nil ] Nil.
       #
       # @since 3.0.0
-      def unset(field)
-        query.update_all("$unset" => { database_field_name(field) => true })
+      def unset(*args)
+        fields = args.__find_args__.collect { |f| [database_field_name(f), true] }
+        query.update_all("$unset" => Hash[fields])
       end
     end
   end

data/lib/mongoid/contextual/find_and_modify.rb

@@ -51,7 +51,7 @@ module Mongoid
       # @api private
       #
       # @example Apply the criteria options
-      #   map_reduce.apply_criteria_options
+      #   find_and_modify.apply_criteria_options
       #
       # @return [ nil ] Nothing.
       #

data/lib/mongoid/contextual/geo_near.rb

@@ -0,0 +1,238 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    class GeoNear
+      include Enumerable
+      include Command
+
+      delegate :[], to: :results
+      delegate :==, :empty?, to: :entries
+
+      # Get the average distance for all documents from the point in the
+      # command.
+      #
+      # @example Get the average distance.
+      #   geo_near.average_distance
+      #
+      # @return [ Float, nil ] The average distance.
+      #
+      # @since 3.1.0
+      def average_distance
+        average = stats["avgDistance"]
+        average.nan? ? nil : average
+      end
+
+      # Iterates over each of the documents in the $geoNear, excluding the
+      # extra information that was passed back from the database.
+      #
+      # @example Iterate over the results.
+      #   geo_near.each do |doc|
+      #     p doc
+      #   end
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 3.1.0
+      def each
+        if block_given?
+          documents.each do |doc|
+            yield doc
+          end
+        else
+          to_enum
+        end
+      end
+
+      # Provide a distance multiplier to be used for each returned distance.
+      #
+      # @example Provide the distance multiplier.
+      #   geo_near.distance_multiplier(13113.1)
+      #
+      # @param [ Integer, Float ] value The distance multiplier.
+      #
+      # @return [ GeoNear ] The GeoNear wrapper.
+      #
+      # @since 3.1.0
+      def distance_multiplier(value)
+        command[:distanceMultiplier] = value
+        self
+      end
+
+      # Initialize the new map/reduce directive.
+      #
+      # @example Initialize the new map/reduce.
+      #   MapReduce.new(criteria, map, reduce)
+      #
+      # @param [ Criteria ] criteria The Mongoid criteria.
+      # @param [ String ] map The map js function.
+      # @param [ String ] reduce The reduce js function.
+      #
+      # @since 3.0.0
+      def initialize(collection, criteria, near)
+        @collection, @criteria = collection, criteria
+        command[:geoNear] = collection.name.to_s
+        command[:near] = near
+        apply_criteria_options
+      end
+
+      # Get a pretty string representation of the command.
+      #
+      # @example Inspect the geoNear.
+      #   geo_near.inspect
+      #
+      # @return [ String ] The inspection string.
+      #
+      # @since 3.1.0
+      def inspect
+%Q{#<Mongoid::Contextual::GeoNear
+  selector:   #{criteria.selector.inspect}
+  class:      #{criteria.klass}
+  near:       #{command[:near]}
+  multiplier: #{command[:distanceMultiplier] || "N/A"}
+  max:        #{command[:maxDistance] || "N/A"}
+  unique:     #{command[:unique].nil? ? true : command[:unique]}
+  spherical:  #{command[:spherical] || false}>
+}
+      end
+
+      # Specify the maximum distance to find documents for, or get the value of
+      # the document with the furthest distance.
+      #
+      # @example Set the max distance.
+      #   geo_near.max_distance(0.5)
+      #
+      # @example Get the max distance.
+      #   geo_near.max_distance
+      #
+      # @param [ Integer, Float ] value The maximum distance.
+      #
+      # @return [ GeoNear, Float ] The GeoNear command or the value.
+      #
+      # @since 3.1.0
+      def max_distance(value = nil)
+        if value
+          command[:maxDistance] = value
+          self
+        else
+          stats["maxDistance"]
+        end
+      end
+
+      # Tell the command to calculate based on spherical distances.
+      #
+      # @example Add the spherical flag.
+      #   geo_near.spherical
+      #
+      # @return [ GeoNear ] The command.
+      #
+      # @since 3.1.0
+      def spherical
+        command[:spherical] = true
+        self
+      end
+
+      # Tell the command whether or not the retured results should be unique.
+      #
+      # @example Set the unique flag.
+      #   geo_near.unique(false)
+      #
+      # @param [ true, false ] value Whether to return unique documents.
+      #
+      # @return [ GeoNear ] The command.
+      #
+      # @since 3.1.0
+      def unique(value = true)
+        command[:unique] = value
+        self
+      end
+
+      # Execute the $geoNear, returning the raw output.
+      #
+      # @example Run the $geoNear
+      #   geo_near.execute
+      #
+      # @return [ Hash ] The raw output
+      #
+      # @since 3.1.0
+      def execute
+        results
+      end
+
+      # Get the stats for the command run.
+      #
+      # @example Get the stats.
+      #   geo_near.stats
+      #
+      # @return [ Hash ] The stats from the command run.
+      #
+      # @since 3.1.0
+      def stats
+        results["stats"]
+      end
+
+      # Get the execution time of the command.
+      #
+      # @example Get the execution time.
+      #   geo_near.time
+      #
+      # @return [ Float ] The execution time.
+      #
+      # @since 3.1.0
+      def time
+        stats["time"]
+      end
+
+      private
+
+      # Apply criteria specific options - query, limit.
+      #
+      # @api private
+      #
+      # @example Apply the criteria options
+      #   geo_near.apply_criteria_options
+      #
+      # @return [ nil ] Nothing.
+      #
+      # @since 3.0.0
+      def apply_criteria_options
+        command[:query] = criteria.selector
+        if limit = criteria.options[:limit]
+          command[:num] = limit
+        end
+      end
+
+      # Get the result documents from the $geoNear.
+      #
+      # @api private
+      #
+      # @example Get the documents.
+      #   geo_near.documents
+      #
+      # @return [ Array, Cursor ] The documents.
+      #
+      # @since 3.0.0
+      def documents
+        results["results"].map do |attributes|
+          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria.object_id)
+          doc.attributes["geo_near_distance"] = attributes["dis"]
+          doc
+        end
+      end
+
+      # Execute the $geoNear command and get the results.
+      #
+      # @api private
+      #
+      # @example Get the results.
+      #   geo_near.results
+      #
+      # @return [ Hash ] The results of the command.
+      #
+      # @since 3.0.0
+      def results
+        @results ||= session.command(command)
+      end
+    end
+  end
+end
+

data/lib/mongoid/contextual/map_reduce.rb

@@ -6,7 +6,7 @@ module Mongoid
       include Command
 
       delegate :[], to: :results
-      delegate :==, :empty?, :inspect, to: :entries
+      delegate :==, :empty?, to: :entries
 
       # Get all the counts returned by the map/reduce.
       #
@@ -162,6 +162,17 @@ module Mongoid
         results
       end
 
+      # Execute the map/reduce, returning the raw output.
+      # Useful when you don't care about map/reduce's ouptut.
+      #
+      # @example Run the map reduce
+      #   map_reduce.execute
+      #
+      # @return [ Hash ] The raw output
+      #
+      # @since 3.1.0
+      alias :execute :raw
+
       # Get the number of documents reduced by the map/reduce.
       #
       # @example Get the reduced document count.

data/lib/mongoid/contextual/memory.rb

@@ -6,22 +6,15 @@ module Mongoid
     class Memory
       include Enumerable
       include Aggregable::Memory
+      include Eager
+      include Queryable
+      include Mongoid::Atomic::Positionable
 
-      # @attribute [r] collection The root collection.
-      # @attribute [r] criteria The criteria for the context.
-      # @attribute [r] klass The criteria class.
       # @attribute [r] root The root document.
       # @attribute [r] path The atomic path.
       # @attribute [r] selector The root document selector.
       # @attribute [r] matching The in memory documents that match the selector.
-      attr_reader \
-        :collection,
-        :criteria,
-        :documents,
-        :klass,
-        :path,
-        :root,
-        :selector
+      attr_reader :documents, :path, :root, :selector
 
       # Check if the context is equal to the other object.
       #
@@ -38,19 +31,6 @@ module Mongoid
         entries == other.entries
       end
 
-      # Is the enumerable of matching documents empty?
-      #
-      # @example Is the context empty?
-      #   context.blank?
-      #
-      # @return [ true, false ] If the context is empty.
-      #
-      # @since 3.0.0
-      def blank?
-        count == 0
-      end
-      alias :empty? :blank?
-
       # Delete all documents in the database that match the selector.
       #
       # @example Delete all the documents.
@@ -66,7 +46,9 @@ module Mongoid
           doc.as_document
         end
         unless removed.empty?
-          collection.find(selector).update("$pullAll" => { path => removed })
+          collection.find(selector).update(
+            positionally(selector, "$pullAll" => { path => removed })
+          )
         end
         deleted
       end
@@ -117,9 +99,10 @@ module Mongoid
       # @since 3.0.0
       def each
         if block_given?
-          (documents[skipping || 0, limiting || documents.length] || []).each do |doc|
-            yield doc
+          documents_for_iteration.each do |doc|
+            yield(doc)
           end
+          # eager_loadable? ? docs : self
         else
           to_enum
         end
@@ -146,7 +129,9 @@ module Mongoid
       #
       # @since 3.0.0
       def first
-        documents.first
+        doc = documents.first
+        eager_load_one(doc) if eager_loadable?(doc)
+        doc
       end
       alias :one :first
 
@@ -178,7 +163,9 @@ module Mongoid
       #
       # @since 3.0.0
       def last
-        documents.last
+        doc = documents.last
+        eager_load_one(doc) if eager_loadable?(doc)
+        doc
       end
 
       # Get the length of matching documents in the context.
@@ -269,6 +256,24 @@ module Mongoid
 
       private
 
+      # Get the documents the context should iterate. This follows 3 rules:
+      #
+      # @api private
+      #
+      # @example Get the documents for iteration.
+      #   context.documents_for_iteration
+      #
+      # @return [ Array<Document> ] The docs to iterate.
+      #
+      # @since 3.1.0
+      def documents_for_iteration
+        docs = documents[skipping || 0, limiting || documents.length] || []
+        if eager_loadable?
+          eager_load(docs)
+        end
+        docs
+      end
+
       # Update the provided documents with the attributes.
       #
       # @api private
@@ -404,11 +409,11 @@ module Mongoid
       #
       # @since 3.0.0
       def in_place_sort(values)
-        values.each_pair do |field, dir|
+        values.keys.reverse.each do |field|
           documents.sort! do |a, b|
             a_value, b_value = a[field], b[field]
             value = compare(a_value.__sortable__, b_value.__sortable__)
-            dir < 0 ? value * -1 : value
+            values[field] < 0 ? value * -1 : value
           end
         end
       end