mongoid 7.3.2 → 7.4.0

data/lib/mongoid/contextual/atomic.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Contextual
@@ -13,8 +12,6 @@ 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
@@ -27,8 +24,6 @@ module Mongoid
       # @param [ Hash ] adds The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 7.0.0
       def add_each_to_set(adds)
         view.update_many("$addToSet" => collect_each_operations(adds))
       end
@@ -41,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
@@ -55,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
@@ -72,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
@@ -88,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
@@ -102,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
@@ -116,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
@@ -130,8 +113,6 @@ module Mongoid
       # @param [ Hash ] pushes The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def push_all(pushes)
         view.update_many("$push" => collect_each_operations(pushes))
       end
@@ -144,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
@@ -162,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
@@ -173,13 +150,16 @@ 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
 

data/lib/mongoid/contextual/command.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Contextual
@@ -15,8 +14,6 @@ module Mongoid
       #   command.command
       #
       # @return [ Hash ] The db command.
-      #
-      # @since 3.0.0
       def command
         @command ||= {}
       end
@@ -27,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Contextual
@@ -18,8 +17,6 @@ module Mongoid
       #   geo_near.average_distance
       #
       # @return [ Float, nil ] The average distance.
-      #
-      # @since 3.1.0
       def average_distance
         average = stats["avgDistance"]
         (average.nil? || average.nan?) ? nil : average
@@ -34,8 +31,6 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.1.0
       def each
         if block_given?
           documents.each do |doc|
@@ -54,8 +49,6 @@ module Mongoid
       # @param [ Integer, Float ] value The distance multiplier.
       #
       # @return [ GeoNear ] The GeoNear wrapper.
-      #
-      # @since 3.1.0
       def distance_multiplier(value)
         command[:distanceMultiplier] = value
         self
@@ -70,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
@@ -85,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}
@@ -112,8 +101,6 @@ module Mongoid
       # @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
@@ -131,8 +118,6 @@ module Mongoid
       # @param [ Integer, Float ] value The minimum distance.
       #
       # @return [ GeoNear ] The GeoNear command.
-      #
-      # @since 3.1.0
       def min_distance(value)
         command[:minDistance] = value
         self
@@ -144,14 +129,12 @@ 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)
@@ -159,8 +142,6 @@ module Mongoid
       # @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
@@ -172,8 +153,6 @@ module Mongoid
       #   geo_near.execute
       #
       # @return [ Hash ] The raw output
-      #
-      # @since 3.1.0
       def execute
         results
       end
@@ -184,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
@@ -196,8 +173,6 @@ module Mongoid
       #   geo_near.time
       #
       # @return [ Float ] The execution time.
-      #
-      # @since 3.1.0
       def time
         stats["time"]
       end
@@ -208,8 +183,6 @@ module Mongoid
       #   geo_near.empty_and_chainable?
       #
       # @return [ true ] Always true.
-      #
-      # @since 5.1.0
       def empty_and_chainable?
         true
       end
@@ -224,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]
@@ -241,8 +212,6 @@ module Mongoid
       #   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)
@@ -259,8 +228,6 @@ module Mongoid
       #   geo_near.results
       #
       # @return [ Hash ] The results of the command.
-      #
-      # @since 3.0.0
       def results
         @results ||= client.command(command).first
       end

data/lib/mongoid/contextual/map_reduce.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Contextual
@@ -17,8 +16,6 @@ module Mongoid
       #   map_reduce.counts
       #
       # @return [ Hash ] The counts.
-      #
-      # @since 3.0.0
       def counts
         results["counts"]
       end
@@ -32,8 +29,6 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.0.0
       def each
         validate_out!
         if block_given?
@@ -51,8 +46,6 @@ module Mongoid
       #   map_reduce.emitted
       #
       # @return [ Integer ] The number of emitted documents.
-      #
-      # @since 3.0.0
       def emitted
         counts["emit"]
       end
@@ -65,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
@@ -80,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
@@ -94,8 +83,6 @@ module Mongoid
       #   map_reduce.input
       #
       # @return [ Integer ] The number of input documents.
-      #
-      # @since 3.0.0
       def input
         counts["input"]
       end
@@ -106,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
@@ -134,8 +119,6 @@ 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|
@@ -151,8 +134,6 @@ module Mongoid
       #   map_reduce.output
       #
       # @return [ Integer ] The number of output documents.
-      #
-      # @since 3.0.0
       def output
         counts["output"]
       end
@@ -163,8 +144,6 @@ module Mongoid
       #   map_reduce.raw
       #
       # @return [ Hash ] The raw output.
-      #
-      # @since 3.0.0
       def raw
         validate_out!
         cmd = command
@@ -180,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.
@@ -190,8 +167,6 @@ module Mongoid
       #   map_reduce.reduced
       #
       # @return [ Integer ] The number of reduced documents.
-      #
-      # @since 3.0.0
       def reduced
         counts["reduce"]
       end
@@ -204,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
@@ -217,8 +190,6 @@ module Mongoid
       #   map_reduce.time
       #
       # @return [ Float ] The time in milliseconds.
-      #
-      # @since 3.0.0
       def time
         results["timeMillis"]
       end
@@ -230,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}

data/lib/mongoid/contextual/memory.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/contextual/aggregable/memory"
 require "mongoid/association/eager_loadable"
@@ -27,8 +26,6 @@ module Mongoid
       # @param [ Array ] other The other array.
       #
       # @return [ true, false ] If the objects are equal.
-      #
-      # @since 3.0.0
       def ==(other)
         return false unless other.respond_to?(:entries)
         entries == other.entries
@@ -40,8 +37,6 @@ module Mongoid
       #   context.delete
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def delete
         deleted = count
         removed = map do |doc|
@@ -64,8 +59,6 @@ module Mongoid
       #   context.destroy
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def destroy
         deleted = count
         each do |doc|
@@ -84,8 +77,6 @@ module Mongoid
       # @param [ String, Symbol ] field The name of the field.
       #
       # @return [ Array<Object> ] The distinct values for the field.
-      #
-      # @since 3.0.0
       def distinct(field)
         documents.map{ |doc| doc.send(field) }.uniq
       end
@@ -99,8 +90,6 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.0.0
       def each
         if block_given?
           documents_for_iteration.each do |doc|
@@ -118,8 +107,6 @@ module Mongoid
       #   context.exists?
       #
       # @return [ true, false ] If the count is more than zero.
-      #
-      # @since 3.0.0
       def exists?
         count > 0
       end
@@ -130,8 +117,6 @@ module Mongoid
       #   context.first
       #
       # @return [ Document ] The first document.
-      #
-      # @since 3.0.0
       def first(*args)
         eager_load([documents.first]).first
       end
@@ -144,8 +129,6 @@ module Mongoid
       #   Memory.new(criteria)
       #
       # @param [ Criteria ] criteria The criteria.
-      #
-      # @since 3.0.0
       def initialize(criteria)
         @criteria, @klass = criteria, criteria.klass
         @documents = criteria.documents.select do |doc|
@@ -165,8 +148,6 @@ module Mongoid
       # @param [ Hash ] incs The operations.
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 7.0.0
       def inc(incs)
         each do |document|
           document.inc(incs)
@@ -179,8 +160,6 @@ module Mongoid
       #   context.last
       #
       # @return [ Document ] The last document.
-      #
-      # @since 3.0.0
       def last
         eager_load([documents.last]).first
       end
@@ -191,8 +170,6 @@ module Mongoid
       #   context.length
       #
       # @return [ Integer ] The matching length.
-      #
-      # @since 3.0.0
       def length
         documents.length
       end
@@ -206,8 +183,6 @@ module Mongoid
       # @param [ Integer ] value The number of documents to return.
       #
       # @return [ Mongo ] The context.
-      #
-      # @since 3.0.0
       def limit(value)
         self.limiting = value
         self
@@ -232,8 +207,6 @@ module Mongoid
       # @param [ Integer ] value The number of documents to skip.
       #
       # @return [ Mongo ] The context.
-      #
-      # @since 3.0.0
       def skip(value)
         self.skipping = value
         self
@@ -248,8 +221,6 @@ module Mongoid
       #   pairs.
       #
       # @return [ Mongo ] The context.
-      #
-      # @since 3.0.0
       def sort(values)
         in_place_sort(values) and self
       end
@@ -262,8 +233,6 @@ module Mongoid
       # @param [ Hash ] attributes The new attributes for the document.
       #
       # @return [ nil, false ] False if no attributes were provided.
-      #
-      # @since 3.0.0
       def update(attributes = nil)
         update_documents(attributes, [ first ])
       end
@@ -276,8 +245,6 @@ module Mongoid
       # @param [ Hash ] attributes The new attributes for each document.
       #
       # @return [ nil, false ] False if no attributes were provided.
-      #
-      # @since 3.0.0
       def update_all(attributes = nil)
         update_documents(attributes, entries)
       end
@@ -292,8 +259,6 @@ module Mongoid
       #   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?
@@ -311,8 +276,6 @@ module Mongoid
       #
       # @param [ Hash ] attributes The attributes.
       # @param [ Array<Document> ] docs The docs to update.
-      #
-      # @since 3.0.4
       def update_documents(attributes, docs)
         return false if !attributes || docs.empty?
         updates = { "$set" => {}}
@@ -332,8 +295,6 @@ module Mongoid
       # @example Get the limiting value.
       #
       # @return [ Integer ] The limit.
-      #
-      # @since 3.0.0
       def limiting
         defined?(@limiting) ? @limiting : nil
       end
@@ -347,36 +308,30 @@ module Mongoid
       # @param [ Integer ] value The limit.
       #
       # @return [ Integer ] The limit.
-      #
-      # @since 3.0.0
       def limiting=(value)
         @limiting = value
       end
 
-      # Get the skiping value.
+      # Get the skipping value.
       #
       # @api private
       #
-      # @example Get the skiping value.
+      # @example Get the skipping value.
       #
       # @return [ Integer ] The skip.
-      #
-      # @since 3.0.0
       def skipping
         defined?(@skipping) ? @skipping : nil
       end
 
-      # Set the skiping value.
+      # Set the skipping value.
       #
       # @api private
       #
-      # @example Set the skiping value.
+      # @example Set the skipping value.
       #
       # @param [ Integer ] value The skip.
       #
       # @return [ Integer ] The skip.
-      #
-      # @since 3.0.0
       def skipping=(value)
         @skipping = value
       end
@@ -389,8 +344,6 @@ module Mongoid
       #   context.apply_options
       #
       # @return [ Memory ] self.
-      #
-      # @since 3.0.0
       def apply_options
         raise Errors::InMemoryCollationNotSupported.new if criteria.options[:collation]
         skip(criteria.options[:skip]).limit(criteria.options[:limit])
@@ -400,8 +353,6 @@ module Mongoid
       #
       # @example Apply the sorting params.
       #   context.apply_sorting
-      #
-      # @since 3.0.0
       def apply_sorting
         if spec = criteria.options[:sort]
           in_place_sort(spec)
@@ -419,8 +370,6 @@ module Mongoid
       # @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
@@ -435,8 +384,6 @@ module Mongoid
       #   context.in_place_sort(name: 1)
       #
       # @param [ Hash ] values The field/direction sorting pairs.
-      #
-      # @since 3.0.0
       def in_place_sort(values)
         documents.sort! do |a, b|
           values.map do |field, direction|
@@ -454,8 +401,6 @@ module Mongoid
       #   context.prepare_remove(doc)
       #
       # @param [ Document ] doc The document.
-      #
-      # @since 3.0.0
       def prepare_remove(doc)
         @selector ||= root.atomic_selector
         @path ||= doc.atomic_path