mongoid 3.1.5 → 8.0.2

data/lib/mongoid/contextual/geo_near.rb

@@ -1,12 +1,14 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     class GeoNear
+      extend Forwardable
       include Enumerable
       include Command
 
-      delegate :[], to: :results
-      delegate :==, :empty?, to: :entries
+      def_delegator :results, :[]
+      def_delegators :entries, :==, :empty?
 
       # Get the average distance for all documents from the point in the
       # command.
@@ -14,12 +16,10 @@ module Mongoid
       # @example Get the average distance.
       #   geo_near.average_distance
       #
-      # @return [ Float, nil ] The average distance.
-      #
-      # @since 3.1.0
+      # @return [ Float | nil ] The average distance.
       def average_distance
         average = stats["avgDistance"]
-        average.nan? ? nil : average
+        (average.nil? || average.nan?) ? nil : average
       end
 
       # Iterates over each of the documents in the $geoNear, excluding the
@@ -31,8 +31,6 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.1.0
       def each
         if block_given?
           documents.each do |doc|
@@ -48,11 +46,9 @@ module Mongoid
       # @example Provide the distance multiplier.
       #   geo_near.distance_multiplier(13113.1)
       #
-      # @param [ Integer, Float ] value The distance multiplier.
+      # @param [ Integer | Float ] value The distance multiplier.
       #
       # @return [ GeoNear ] The GeoNear wrapper.
-      #
-      # @since 3.1.0
       def distance_multiplier(value)
         command[:distanceMultiplier] = value
         self
@@ -63,11 +59,10 @@ module Mongoid
       # @example Initialize the new map/reduce.
       #   MapReduce.new(criteria, map, reduce)
       #
+      # @param [ Mongo::Collection ] collection The collection to run the
+      #   operation on.
       # @param [ Criteria ] criteria The Mongoid criteria.
-      # @param [ String ] map The map js function.
-      # @param [ String ] reduce The reduce js function.
-      #
-      # @since 3.0.0
+      # @param [ String ] near
       def initialize(collection, criteria, near)
         @collection, @criteria = collection, criteria
         command[:geoNear] = collection.name.to_s
@@ -81,8 +76,6 @@ module Mongoid
       #   geo_near.inspect
       #
       # @return [ String ] The inspection string.
-      #
-      # @since 3.1.0
       def inspect
 %Q{#<Mongoid::Contextual::GeoNear
   selector:   #{criteria.selector.inspect}
@@ -90,6 +83,7 @@ module Mongoid
   near:       #{command[:near]}
   multiplier: #{command[:distanceMultiplier] || "N/A"}
   max:        #{command[:maxDistance] || "N/A"}
+  min:        #{command[:minDistance] || "N/A"}
   unique:     #{command[:unique].nil? ? true : command[:unique]}
   spherical:  #{command[:spherical] || false}>
 }
@@ -104,11 +98,9 @@ module Mongoid
       # @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.
+      # @param [ Integer | Float ] value The maximum distance.
       #
-      # @since 3.1.0
+      # @return [ GeoNear | Float ] The GeoNear command or the value.
       def max_distance(value = nil)
         if value
           command[:maxDistance] = value
@@ -118,29 +110,38 @@ module Mongoid
         end
       end
 
+      # Specify the minimum distance to find documents for.
+      #
+      # @example Set the min distance.
+      #   geo_near.min_distance(0.5)
+      #
+      # @param [ Integer | Float ] value The minimum distance.
+      #
+      # @return [ GeoNear ] The GeoNear command.
+      def min_distance(value)
+        command[:minDistance] = value
+        self
+      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.
+      # Tell the command whether or not the returned results should be unique.
       #
       # @example Set the unique flag.
       #   geo_near.unique(false)
       #
-      # @param [ true, false ] value Whether to return unique documents.
+      # @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
@@ -152,8 +153,6 @@ module Mongoid
       #   geo_near.execute
       #
       # @return [ Hash ] The raw output
-      #
-      # @since 3.1.0
       def execute
         results
       end
@@ -164,8 +163,6 @@ module Mongoid
       #   geo_near.stats
       #
       # @return [ Hash ] The stats from the command run.
-      #
-      # @since 3.1.0
       def stats
         results["stats"]
       end
@@ -176,12 +173,20 @@ module Mongoid
       #   geo_near.time
       #
       # @return [ Float ] The execution time.
-      #
-      # @since 3.1.0
       def time
         stats["time"]
       end
 
+      # Is this context's criteria considered empty?
+      #
+      # @example Is this context's criteria considered empty?
+      #   geo_near.empty_and_chainable?
+      #
+      # @return [ true ] Always true.
+      def empty_and_chainable?
+        true
+      end
+
       private
 
       # Apply criteria specific options - query, limit.
@@ -192,8 +197,6 @@ module Mongoid
       #   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]
@@ -208,12 +211,10 @@ module Mongoid
       # @example Get the documents.
       #   geo_near.documents
       #
-      # @return [ Array, Cursor ] The documents.
-      #
-      # @since 3.0.0
+      # @return [ Array | Cursor ] The documents.
       def documents
         results["results"].map do |attributes|
-          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria.object_id)
+          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria)
           doc.attributes["geo_near_distance"] = attributes["dis"]
           doc
         end
@@ -227,12 +228,9 @@ module Mongoid
       #   geo_near.results
       #
       # @return [ Hash ] The results of the command.
-      #
-      # @since 3.0.0
       def results
-        @results ||= session.command(command)
+        @results ||= client.command(command).first
       end
     end
   end
 end
-

data/lib/mongoid/contextual/map_reduce.rb

@@ -1,12 +1,14 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     class MapReduce
+      extend Forwardable
       include Enumerable
       include Command
 
-      delegate :[], to: :results
-      delegate :==, :empty?, to: :entries
+      def_delegators :results, :[]
+      def_delegators :entries, :==, :empty?
 
       # Get all the counts returned by the map/reduce.
       #
@@ -14,8 +16,6 @@ module Mongoid
       #   map_reduce.counts
       #
       # @return [ Hash ] The counts.
-      #
-      # @since 3.0.0
       def counts
         results["counts"]
       end
@@ -29,15 +29,14 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.0.0
       def each
+        validate_out!
         if block_given?
-          documents.each do |doc|
+          @map_reduce.each do |doc|
             yield doc
           end
         else
-          to_enum
+          @map_reduce.to_enum
         end
       end
 
@@ -47,8 +46,6 @@ module Mongoid
       #   map_reduce.emitted
       #
       # @return [ Integer ] The number of emitted documents.
-      #
-      # @since 3.0.0
       def emitted
         counts["emit"]
       end
@@ -61,10 +58,8 @@ module Mongoid
       # @param [ String ] function The finalize function.
       #
       # @return [ MapReduce ] The map reduce.
-      #
-      # @since 3.0.0
       def finalize(function)
-        command[:finalize] = function
+        @map_reduce = @map_reduce.finalize(function)
         self
       end
 
@@ -76,13 +71,10 @@ module Mongoid
       # @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, map, reduce)
-        @collection, @criteria = collection, criteria
-        command[:mapreduce] = collection.name.to_s
-        command[:map], command[:reduce] = map, reduce
-        apply_criteria_options
+        @collection = collection
+        @criteria = criteria
+        @map_reduce = @criteria.view.map_reduce(map, reduce)
       end
 
       # Get the number of documents that were input into the map/reduce.
@@ -91,8 +83,6 @@ module Mongoid
       #   map_reduce.input
       #
       # @return [ Integer ] The number of input documents.
-      #
-      # @since 3.0.0
       def input
         counts["input"]
       end
@@ -103,14 +93,13 @@ module Mongoid
       #   map_reduce.js_mode
       #
       # @return [ MapReduce ] The map/reduce.
-      #
-      # @since 3.0.0
       def js_mode
-        command[:jsMode] = true
+        @map_reduce = @map_reduce.js_mode(true)
         self
       end
 
       # Specifies where the map/reduce output is to be stored.
+      # Please see MongoDB documentation for supported map reduce options.
       #
       # @example Store output in memory.
       #   map_reduce.out(inline: 1)
@@ -124,17 +113,18 @@ module Mongoid
       # @example Store output in a collection, reducing existing documents.
       #   map_reduce.out(reduce: "collection_name")
       #
+      # @example Return results from map reduce.
+      #   map_reduce.out(inline: 1)
+      #
       # @param [ Hash ] location The place to store the results.
       #
       # @return [ MapReduce ] The map/reduce object.
-      #
-      # @since 3.0.0
       def out(location)
         normalized = location.dup
-        normalized.update_values do |value|
+        normalized.transform_values! do |value|
           value.is_a?(::Symbol) ? value.to_s : value
         end
-        command[:out] = normalized
+        @map_reduce = @map_reduce.out(normalized)
         self
       end
 
@@ -144,8 +134,6 @@ module Mongoid
       #   map_reduce.output
       #
       # @return [ Integer ] The number of output documents.
-      #
-      # @since 3.0.0
       def output
         counts["output"]
       end
@@ -156,21 +144,21 @@ module Mongoid
       #   map_reduce.raw
       #
       # @return [ Hash ] The raw output.
-      #
-      # @since 3.0.0
       def raw
-        results
+        validate_out!
+        cmd = command
+        opts = { read: criteria.options.fetch(:read) } if criteria.options[:read]
+        @map_reduce.database.command(cmd, (opts || {}).merge(session: _session)).first
       end
+      alias :results :raw
 
       # Execute the map/reduce, returning the raw output.
-      # Useful when you don't care about map/reduce's ouptut.
+      # Useful when you don't care about map/reduce's output.
       #
       # @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.
@@ -179,8 +167,6 @@ module Mongoid
       #   map_reduce.reduced
       #
       # @return [ Integer ] The number of reduced documents.
-      #
-      # @since 3.0.0
       def reduced
         counts["reduce"]
       end
@@ -193,10 +179,8 @@ module Mongoid
       # @param [ Hash ] object A hash of key/values for the global scope.
       #
       # @return [ MapReduce ]
-      #
-      # @since 3.0.0
       def scope(object)
-        command[:scope] = object
+        @map_reduce = @map_reduce.scope(object)
         self
       end
 
@@ -206,8 +190,6 @@ module Mongoid
       #   map_reduce.time
       #
       # @return [ Float ] The time in milliseconds.
-      #
-      # @since 3.0.0
       def time
         results["timeMillis"]
       end
@@ -219,8 +201,6 @@ module Mongoid
       #   map_reduce.inspect
       #
       # @return [ String ] The inspection string.
-      #
-      # @since 3.1.0
       def inspect
 %Q{#<Mongoid::Contextual::MapReduce
   selector: #{criteria.selector.inspect}
@@ -232,92 +212,18 @@ module Mongoid
 }
       end
 
-      private
-
-      # Apply criteria specific options - query, sort, limit.
-      #
-      # @api private
-      #
-      # @example Apply the criteria options
-      #   map_reduce.apply_criteria_options
-      #
-      # @return [ nil ] Nothing.
-      #
-      # @since 3.0.0
-      def apply_criteria_options
-        command[:query] = criteria.selector
-        if sort = criteria.options[:sort]
-          command[:sort] = sort
-        end
-        if limit = criteria.options[:limit]
-          command[:limit] = limit
-        end
-      end
-
-      # Get the result documents from the map/reduce. If the output was inline
-      # then we grab them from the results key. If the output was a temp
-      # collection then we need to execute a find on that collection.
-      #
-      # @api private
-      #
-      # @example Get the documents.
-      #   map_reduce.documents
-      #
-      # @return [ Array, Cursor ] The documents.
-      #
-      # @since 3.0.0
-      def documents
-        return results["results"] if results.has_key?("results")
-        session[output_collection].find
+      def command
+        @map_reduce.send(:map_reduce_spec)[:selector]
       end
 
-      # Get the collection that the map/reduce results were stored in.
-      #
-      # @api private
-      #
-      # @example Get the output collection.
-      #   map_reduce.output_collection
-      #
-      # @return [ Symbol, String ] The output collection.
-      #
-      # @since 3.0.0
-      def output_collection
-        command[:out].values.first
-      end
+      private
 
-      # Execute the map/reduce command and get the results.
-      #
-      # @api private
-      #
-      # @example Get the results.
-      #   map_reduce.results
-      #
-      # @return [ Hash ] The results of the command.
-      #
-      # @since 3.0.0
-      def results
-        raise Errors::NoMapReduceOutput.new(command) unless command[:out]
-        @results ||= __session__.command(command)
+      def validate_out!
+        raise Errors::NoMapReduceOutput.new({}) unless @map_reduce.out
       end
 
-      # Get the session with the proper consistency.
-      #
-      # @api private
-      #
-      # @note We can use eventual if the output is set to inline.
-      #
-      # @example Get the session.
-      #   map_reduce.__session__
-      #
-      # @return [ Session ] The session with consistency set.
-      #
-      # @since 3.0.15
-      def __session__
-        if command[:out][:inline] != 1
-          session.with(consistency: :strong)
-        else
-          session
-        end
+      def _session
+        criteria.send(:_session)
       end
     end
   end