mongoid 7.0.2 → 8.1.1

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "mongoid/contextual/aggregable"
+
+module Mongoid
+  module Contextual
+    module Aggregable
+      # Contains behavior for aggregating values in null context.
+      module None
+
+        # Get all the aggregate values for the provided field in null context.
+        # Provided for interface consistency with Aggregable::Mongo.
+        #
+        # @param [ String | Symbol ] _field The field name.
+        #
+        # @return [ Hash ] A Hash with count, sum of 0 and max, min, avg of nil.
+        def aggregates(_field)
+          Aggregable::EMPTY_RESULT.dup
+        end
+
+        # Always returns zero.
+        #
+        # @example Get the sum of null context.
+        #
+        # @param [ Symbol ] _field The field to sum.
+        #
+        # @return [ Integer ] Always zero.
+        def sum(_field = nil)
+          0
+        end
+
+        # Always returns nil.
+        #
+        # @example Get the avg of null context.
+        #
+        # @param [ Symbol ] _field The field to avg.
+        #
+        # @return [ nil ] Always nil.
+        def avg(_field)
+          nil
+        end
+
+        # Always returns nil.
+        #
+        # @example Get the min of null context.
+        #
+        # @param [ Symbol ] _field The field to min.
+        #
+        # @return [ nil ] Always nil.
+        def min(_field = nil)
+          nil
+        end
+
+        # Always returns nil.
+        #
+        # @example Get the max of null context.
+        #
+        # @param [ Symbol ] _field The field to max.
+        #
+        # @return [ nil ] Always nil.
+        alias :max :min
+      end
+    end
+  end
+end

data/lib/mongoid/contextual/aggregable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Contextual
+    module Aggregable
+
+      # @api private
+      EMPTY_RESULT = {
+        "count" => 0,
+        "sum" => 0,
+        "avg" => nil,
+        "min" => nil,
+        "max" => nil,
+      }.freeze
+    end
+  end
+end

data/lib/mongoid/contextual/atomic.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     module Atomic
@@ -11,12 +12,22 @@ module Mongoid
       # @param [ Hash ] adds The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def add_to_set(adds)
         view.update_many("$addToSet" => collect_operations(adds))
       end
 
+      # Perform an atomic $addToSet/$each on the matching documents.
+      #
+      # @example Add the value to the set.
+      #   context.add_each_to_set(members: ["Dave", "Bill"], genres: ["Electro", "Disco"])
+      #
+      # @param [ Hash ] adds The operations.
+      #
+      # @return [ nil ] Nil.
+      def add_each_to_set(adds)
+        view.update_many("$addToSet" => collect_each_operations(adds))
+      end
+
       # Perform an atomic $bit operation on the matching documents.
       #
       # @example Perform the bitwise op.
@@ -25,8 +36,6 @@ module Mongoid
       # @param [ Hash ] bits The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def bit(bits)
         view.update_many("$bit" => collect_operations(bits))
       end
@@ -39,8 +48,6 @@ module Mongoid
       # @param [ Hash ] incs The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def inc(incs)
         view.update_many("$inc" => collect_operations(incs))
       end
@@ -56,8 +63,6 @@ module Mongoid
       # @param [ Hash ] pops The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def pop(pops)
         view.update_many("$pop" => collect_operations(pops))
       end
@@ -72,8 +77,6 @@ module Mongoid
       # @param [ Hash ] pulls The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def pull(pulls)
         view.update_many("$pull" => collect_operations(pulls))
       end
@@ -86,8 +89,6 @@ module Mongoid
       # @param [ Hash ] pulls The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def pull_all(pulls)
         view.update_many("$pullAll" => collect_operations(pulls))
       end
@@ -100,8 +101,6 @@ module Mongoid
       # @param [ Hash ] pushes The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def push(pushes)
         view.update_many("$push" => collect_operations(pushes))
       end
@@ -114,13 +113,8 @@ module Mongoid
       # @param [ Hash ] pushes The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def push_all(pushes)
-        push_each_updates = collect_operations(pushes).each.inject({}) do |ops, (field, elements)|
-          ops.merge!(field => { '$each' => elements })
-        end
-        view.update_many("$push" => push_each_updates)
+        view.update_many("$push" => collect_each_operations(pushes))
       end
 
       # Perform an atomic $rename of fields on the matching documents.
@@ -131,8 +125,6 @@ module Mongoid
       # @param [ Hash ] renames The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def rename(renames)
         operations = renames.inject({}) do |ops, (old_name, new_name)|
           ops[old_name] = new_name.to_s
@@ -149,8 +141,6 @@ module Mongoid
       # @param [ Hash ] sets The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def set(sets)
         view.update_many("$set" => collect_operations(sets))
       end
@@ -160,22 +150,30 @@ module Mongoid
       # @example Unset the field on the matches.
       #   context.unset(:name)
       #
-      # @param [ String, Symbol, Array ] args The name of the fields.
+      # @param [ [ String | Symbol | Array<String | Symbol> | Hash ]... ] *args
+      #   The name(s) of the field(s) to unset.
+      #   If a Hash is specified, its keys will be used irrespective of what
+      #   each key's value is, even if the value is nil or false.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def unset(*args)
-        fields = args.__find_args__.collect { |f| [database_field_name(f), true] }
+        fields = args.map { |a| a.is_a?(Hash) ? a.keys : a }
+                     .__find_args__
+                     .map { |f| [database_field_name(f), true] }
         view.update_many("$unset" => Hash[fields])
       end
 
       private
 
       def collect_operations(ops)
-        ops.inject({}) do |operations, (field, value)|
+        ops.each_with_object({}) do |(field, value), operations|
           operations[database_field_name(field)] = value.mongoize
-          operations
+        end
+      end
+
+      def collect_each_operations(ops)
+        ops.each_with_object({}) do |(field, value), operations|
+          operations[database_field_name(field)] = { "$each" => Array.wrap(value).mongoize }
         end
       end
     end

data/lib/mongoid/contextual/command.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     module Command
@@ -13,8 +14,6 @@ module Mongoid
       #   command.command
       #
       # @return [ Hash ] The db command.
-      #
-      # @since 3.0.0
       def command
         @command ||= {}
       end
@@ -25,8 +24,6 @@ module Mongoid
       #   command.client
       #
       # @return [ Mongo::Client ] The Mongo client.
-      #
-      # @since 3.0.0
       def client
         collection.database.client
       end

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,9 +16,7 @@ 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.nil? || average.nan?) ? nil : average
@@ -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
@@ -67,8 +63,6 @@ module Mongoid
       #   operation on.
       # @param [ Criteria ] criteria The Mongoid criteria.
       # @param [ String ] near
-      #
-      # @since 3.0.0
       def initialize(collection, criteria, near)
         @collection, @criteria = collection, criteria
         command[:geoNear] = collection.name.to_s
@@ -82,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}
@@ -106,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
@@ -125,11 +115,9 @@ module Mongoid
       # @example Set the min distance.
       #   geo_near.min_distance(0.5)
       #
-      # @param [ Integer, Float ] value The minimum distance.
+      # @param [ Integer | Float ] value The minimum distance.
       #
       # @return [ GeoNear ] The GeoNear command.
-      #
-      # @since 3.1.0
       def min_distance(value)
         command[:minDistance] = value
         self
@@ -141,23 +129,19 @@ module Mongoid
       #   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
@@ -169,8 +153,6 @@ module Mongoid
       #   geo_near.execute
       #
       # @return [ Hash ] The raw output
-      #
-      # @since 3.1.0
       def execute
         results
       end
@@ -181,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
@@ -193,8 +173,6 @@ module Mongoid
       #   geo_near.time
       #
       # @return [ Float ] The execution time.
-      #
-      # @since 3.1.0
       def time
         stats["time"]
       end
@@ -205,8 +183,6 @@ module Mongoid
       #   geo_near.empty_and_chainable?
       #
       # @return [ true ] Always true.
-      #
-      # @since 5.1.0
       def empty_and_chainable?
         true
       end
@@ -221,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]
@@ -237,9 +211,7 @@ 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)
@@ -256,12 +228,9 @@ module Mongoid
       #   geo_near.results
       #
       # @return [ Hash ] The results of the command.
-      #
-      # @since 3.0.0
       def results
         @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,8 +29,6 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.0.0
       def each
         validate_out!
         if block_given?
@@ -48,8 +46,6 @@ module Mongoid
       #   map_reduce.emitted
       #
       # @return [ Integer ] The number of emitted documents.
-      #
-      # @since 3.0.0
       def emitted
         counts["emit"]
       end
@@ -62,8 +58,6 @@ module Mongoid
       # @param [ String ] function The finalize function.
       #
       # @return [ MapReduce ] The map reduce.
-      #
-      # @since 3.0.0
       def finalize(function)
         @map_reduce = @map_reduce.finalize(function)
         self
@@ -77,8 +71,6 @@ 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 = collection
         @criteria = criteria
@@ -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,8 +93,6 @@ module Mongoid
       #   map_reduce.js_mode
       #
       # @return [ MapReduce ] The map/reduce.
-      #
-      # @since 3.0.0
       def js_mode
         @map_reduce = @map_reduce.js_mode(true)
         self
@@ -131,11 +119,9 @@ module Mongoid
       # @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
         @map_reduce = @map_reduce.out(normalized)
@@ -148,8 +134,6 @@ module Mongoid
       #   map_reduce.output
       #
       # @return [ Integer ] The number of output documents.
-      #
-      # @since 3.0.0
       def output
         counts["output"]
       end
@@ -160,12 +144,10 @@ module Mongoid
       #   map_reduce.raw
       #
       # @return [ Hash ] The raw output.
-      #
-      # @since 3.0.0
       def raw
         validate_out!
         cmd = command
-        opts = { read: cmd.delete(:read) } if cmd[:read]
+        opts = { read: criteria.options.fetch(:read) } if criteria.options[:read]
         @map_reduce.database.command(cmd, (opts || {}).merge(session: _session)).first
       end
       alias :results :raw
@@ -177,8 +159,6 @@ module Mongoid
       #   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.
@@ -187,8 +167,6 @@ module Mongoid
       #   map_reduce.reduced
       #
       # @return [ Integer ] The number of reduced documents.
-      #
-      # @since 3.0.0
       def reduced
         counts["reduce"]
       end
@@ -201,8 +179,6 @@ module Mongoid
       # @param [ Hash ] object A hash of key/values for the global scope.
       #
       # @return [ MapReduce ]
-      #
-      # @since 3.0.0
       def scope(object)
         @map_reduce = @map_reduce.scope(object)
         self
@@ -214,8 +190,6 @@ module Mongoid
       #   map_reduce.time
       #
       # @return [ Float ] The time in milliseconds.
-      #
-      # @since 3.0.0
       def time
         results["timeMillis"]
       end
@@ -227,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}