mongoid 7.3.5 → 7.4.0

data/lib/mongoid/atomic/modifiers.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Atomic
@@ -14,8 +13,6 @@ module Mongoid
       #   modifiers.add_to_set({ "preference_ids" => [ "one" ] })
       #
       # @param [ Hash ] modifications The add to set modifiers.
-      #
-      # @since 2.4.0
       def add_to_set(modifications)
         modifications.each_pair do |field, value|
           if add_to_sets.has_key?(field)
@@ -34,8 +31,6 @@ module Mongoid
       #   modifiers.pull_all({ "addresses" => { "street" => "Bond" }})
       #
       # @param [ Hash ] modifications The pull all modifiers.
-      #
-      # @since 3.0.0
       def pull_all(modifications)
         modifications.each_pair do |field, value|
           add_operation(pull_alls, field, value)
@@ -49,8 +44,6 @@ module Mongoid
       #   modifiers.pull({ "addresses" => { "_id" => { "$in" => [ 1, 2, 3 ]}}})
       #
       # @param [ Hash ] modifications The pull all modifiers.
-      #
-      # @since 3.0.0
       def pull(modifications)
         modifications.each_pair do |field, value|
           pulls[field] = value
@@ -64,8 +57,6 @@ module Mongoid
       #   modifiers.push({ "addresses" => { "street" => "Bond" }})
       #
       # @param [ Hash ] modifications The push modifiers.
-      #
-      # @since 2.1.0
       def push(modifications)
         modifications.each_pair do |field, value|
           push_fields[field] = field
@@ -80,8 +71,6 @@ module Mongoid
       #   modifiers.set({ "title" => "sir" })
       #
       # @param [ Hash ] modifications The set modifiers.
-      #
-      # @since 2.1.0
       def set(modifications)
         modifications.each_pair do |field, value|
           next if field == "_id"
@@ -97,8 +86,6 @@ module Mongoid
       #   modifiers.unset([ "addresses" ])
       #
       # @param [ Array<String> ] modifications The unset association names.
-      #
-      # @since 2.2.0
       def unset(modifications)
         modifications.each do |field|
           unsets.update(field => true)
@@ -116,8 +103,6 @@ module Mongoid
       # @param [ Hash ] mods The modifications.
       # @param [ String ] field The field.
       # @param [ Hash ] value The atomic op.
-      #
-      # @since 2.2.0
       def add_operation(mods, field, value)
         if mods.has_key?(field)
           if mods[field].is_a?(Array)
@@ -141,8 +126,6 @@ module Mongoid
       # @param [ Hash ] mods The modifications.
       # @param [ String ] field The field.
       # @param [ Hash ] value The atomic op.
-      #
-      # @since 7.0.0
       def add_each_operation(mods, field, value)
         if mods.has_key?(field)
           value.each do |val|
@@ -153,14 +136,12 @@ module Mongoid
         end
       end
 
-      # Get the $addToSet operations or intialize a new one.
+      # Get the $addToSet operations or initialize a new one.
       #
       # @example Get the $addToSet operations.
       #   modifiers.add_to_sets
       #
       # @return [ Hash ] The $addToSet operations.
-      #
-      # @since 2.4.0
       def add_to_sets
         self["$addToSet"] ||= {}
       end
@@ -173,8 +154,6 @@ module Mongoid
       # @param [ String ] field The field.
       #
       # @return [ true, false ] If this field is a conflict.
-      #
-      # @since 2.2.0
       def set_conflict?(field)
         name = field.split(".", 2)[0]
         pull_fields.has_key?(name) || push_fields.has_key?(name)
@@ -188,8 +167,6 @@ module Mongoid
       # @param [ String ] field The field.
       #
       # @return [ true, false ] If this field is a conflict.
-      #
-      # @since 2.2.0
       def push_conflict?(field)
         name = field.split(".", 2)[0]
         set_fields.has_key?(name) || pull_fields.has_key?(name) ||
@@ -202,8 +179,6 @@ module Mongoid
       #   modifiers.conflicting_pulls
       #
       # @return [ Hash ] The conflicting pull operations.
-      #
-      # @since 2.2.0
       def conflicting_pulls
         conflicts["$pullAll"] ||= {}
       end
@@ -214,8 +189,6 @@ module Mongoid
       #   modifiers.conflicting_pushs
       #
       # @return [ Hash ] The conflicting push operations.
-      #
-      # @since 2.2.0
       def conflicting_pushes
         conflicts["$push"] ||= {}
       end
@@ -226,8 +199,6 @@ module Mongoid
       #   modifiers.conflicting_sets
       #
       # @return [ Hash ] The conflicting set operations.
-      #
-      # @since 2.2.0
       def conflicting_sets
         conflicts["$set"] ||= {}
       end
@@ -238,8 +209,6 @@ module Mongoid
       #   modifiers.conflicts
       #
       # @return [ Hash ] The conflicting modifications.
-      #
-      # @since 2.1.0
       def conflicts
         self[:conflicts] ||= {}
       end
@@ -250,8 +219,6 @@ module Mongoid
       #   modifiers.pull_fields
       #
       # @return [ Array<String> ] The pull fields.
-      #
-      # @since 2.2.0
       def pull_fields
         @pull_fields ||= {}
       end
@@ -262,8 +229,6 @@ module Mongoid
       #   modifiers.push_fields
       #
       # @return [ Array<String> ] The push fields.
-      #
-      # @since 2.2.0
       def push_fields
         @push_fields ||= {}
       end
@@ -274,32 +239,26 @@ module Mongoid
       #   modifiers.set_fields
       #
       # @return [ Array<String> ] The set fields.
-      #
-      # @since 2.2.0
       def set_fields
         @set_fields ||= {}
       end
 
-      # Get the $pullAll operations or intialize a new one.
+      # Get the $pullAll operations or initialize a new one.
       #
       # @example Get the $pullAll operations.
       #   modifiers.pull_alls
       #
       # @return [ Hash ] The $pullAll operations.
-      #
-      # @since 3.0.0
       def pull_alls
         self["$pullAll"] ||= {}
       end
 
-      # Get the $pull operations or intialize a new one.
+      # Get the $pull operations or initialize a new one.
       #
       # @example Get the $pull operations.
       #   modifiers.pulls
       #
       # @return [ Hash ] The $pull operations.
-      #
-      # @since 3.0.0
       def pulls
         self["$pull"] ||= {}
       end
@@ -310,20 +269,16 @@ module Mongoid
       #   modifiers.pushes
       #
       # @return [ Hash ] The $push/$each operations.
-      #
-      # @since 2.1.0
       def pushes
         self["$push"] ||= {}
       end
 
-      # Get the $set operations or intialize a new one.
+      # Get the $set operations or initialize a new one.
       #
       # @example Get the $set operations.
       #   modifiers.sets
       #
       # @return [ Hash ] The $set operations.
-      #
-      # @since 2.1.0
       def sets
         self["$set"] ||= {}
       end
@@ -334,8 +289,6 @@ module Mongoid
       #   modifiers.unsets
       #
       # @return [ Hash ] The $unset operations.
-      #
-      # @since 2.2.0
       def unsets
         self["$unset"] ||= {}
       end

data/lib/mongoid/atomic/paths/embedded/many.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Atomic
@@ -17,8 +16,6 @@ module Mongoid
           #   Many.new(document)
           #
           # @param [ Document ] document The document to generate the paths for.
-          #
-          # @since 2.1.0
           def initialize(document)
             @document, @parent = document, document._parent
             @insert_modifier, @delete_modifier ="$push", "$pull"
@@ -32,32 +29,11 @@ module Mongoid
           #   many.position
           #
           # @return [ String ] The position of the document.
-          #
-          # @since 2.1.0
           def position
             pos = parent.atomic_position
             locator = document.new_record? ? "" : ".#{document._index}"
             "#{pos}#{"." unless pos.blank?}#{document._association.store_as}#{locator}"
           end
-
-          class << self
-
-            # Get the position of where the document would go for the given
-            # association. The use case for this function is when trying to
-            # persist an empty list for an embedded association. All of the
-            # existing functions for getting the position to store a document
-            # require passing in a document to store, which we don't have when
-            # trying to store the empty list.
-            #
-            # @param [ Document ] parent The parent document to store in.
-            # @param [ Association ] association The association.
-            #
-            # @return [ String ] The position string.
-            def position_without_document(parent, association)
-              pos = parent.atomic_position
-              "#{pos}#{"." unless pos.blank?}#{association.store_as}"
-            end
-          end
         end
       end
     end

data/lib/mongoid/atomic/paths/embedded/one.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Atomic
@@ -17,8 +16,6 @@ module Mongoid
           #   One.new(document)
           #
           # @param [ Document ] document The document to generate the paths for.
-          #
-          # @since 2.1.0
           def initialize(document)
             @document, @parent = document, document._parent
             @insert_modifier, @delete_modifier ="$set", "$unset"
@@ -32,8 +29,6 @@ module Mongoid
           #   one.position
           #
           # @return [ String ] The position of the document.
-          #
-          # @since 2.1.0
           def position
             pos = parent.atomic_position
             "#{pos}#{"." unless pos.blank?}#{document._association.store_as}"

data/lib/mongoid/atomic/paths/embedded.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/atomic/paths/embedded/one"
 require "mongoid/atomic/paths/embedded/many"
@@ -19,8 +18,6 @@ module Mongoid
         #   many.path
         #
         # @return [ String ] The path to the document.
-        #
-        # @since 2.1.0
         def path
           @path ||= position.sub(/\.\d+\z/, "")
         end

data/lib/mongoid/atomic/paths/root.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Atomic
@@ -17,8 +16,6 @@ module Mongoid
         #   Root.new(document)
         #
         # @param [ Document ] document The document to generate the paths for.
-        #
-        # @since 2.1.0
         def initialize(document)
           @document, @path, @position = document, "", ""
         end
@@ -30,8 +27,6 @@ module Mongoid
         #   root.insert_modifier
         #
         # @raise [ Errors::InvalidPath ] The error for the attempt.
-        #
-        # @since 3.0.14
         def insert_modifier
           raise Errors::InvalidPath.new(document.class)
         end

data/lib/mongoid/atomic/paths.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/atomic/paths/embedded"
 require "mongoid/atomic/paths/root"

data/lib/mongoid/atomic.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/atomic/modifiers"
 require "mongoid/atomic/paths"
@@ -34,8 +33,6 @@ module Mongoid
     #   person.add_atomic_pull(address)
     #
     # @param [ Document ] document The embedded document to pull.
-    #
-    # @since 2.2.0
     def add_atomic_pull(document)
       document.flagged_for_destroy = true
       key = document.association_name.to_s
@@ -51,8 +48,6 @@ module Mongoid
     # @param [ Document ] document The child document.
     #
     # @return [ Array<Document> ] The children.
-    #
-    # @since 3.0.0
     def add_atomic_unset(document)
       document.flagged_for_destroy = true
       key = document.association_name.to_s
@@ -66,8 +61,6 @@ module Mongoid
     #   address.atomic_attribute_name(:city)
     #
     # @return [ String ] The path to the document attribute in the database
-    #
-    # @since 3.0.0
     def atomic_attribute_name(name)
       embedded? ? "#{atomic_position}.#{name}" : name
     end
@@ -78,8 +71,6 @@ module Mongoid
     #   person.atomic_array_pushes
     #
     # @return [ Hash ] The array pushes.
-    #
-    # @since 2.4.0
     def atomic_array_pushes
       @atomic_array_pushes ||= {}
     end
@@ -90,8 +81,6 @@ module Mongoid
     #   person.atomic_array_pulls
     #
     # @return [ Hash ] The array pulls.
-    #
-    # @since 2.4.0
     def atomic_array_pulls
       @atomic_array_pulls ||= {}
     end
@@ -102,8 +91,6 @@ module Mongoid
     #   person.atomic_array_add_to_sets
     #
     # @return [ Hash ] The array add_to_sets.
-    #
-    # @since 2.4.0
     def atomic_array_add_to_sets
       @atomic_array_add_to_sets ||= {}
     end
@@ -129,13 +116,11 @@ module Mongoid
     #   person.atomic_updates(children)
     #
     # @return [ Hash ] The updates and their modifiers.
-    #
-    # @since 2.1.0
     def atomic_updates(_use_indexes = false)
       process_flagged_destroys
       mods = Modifiers.new
       generate_atomic_updates(mods, self)
-      _children.each do |child|
+      _descendants.each do |child|
         child.process_flagged_destroys
         generate_atomic_updates(mods, child)
       end
@@ -192,8 +177,6 @@ module Mongoid
     #   document.atomic_paths
     #
     # @return [ Object ] The associated path.
-    #
-    # @since 2.1.0
     def atomic_paths
       @atomic_paths ||= begin
         if _association
@@ -210,8 +193,6 @@ module Mongoid
     #   person.atomic_pulls
     #
     # @return [ Array<Hash> ] The $pullAll operations.
-    #
-    # @since 2.2.0
     def atomic_pulls
       pulls = {}
       delayed_atomic_pulls.each_pair do |_, docs|
@@ -231,8 +212,6 @@ module Mongoid
     #   person.atomic_pushes
     #
     # @return [ Hash ] The $push and $each operations.
-    #
-    # @since 2.1.0
     def atomic_pushes
       pushable? ? { atomic_position => as_attributes } : {}
     end
@@ -243,8 +222,6 @@ module Mongoid
     #   person.atomic_sets
     #
     # @return [ Hash ] The $set operations.
-    #
-    # @since 2.1.0
     def atomic_sets
       updateable? ? setters : settable? ? { atomic_path => as_attributes } : {}
     end
@@ -255,8 +232,6 @@ module Mongoid
     #   person.atomic_unsets
     #
     # @return [ Array<Hash> ] The $unset operations.
-    #
-    # @since 2.2.0
     def atomic_unsets
       unsets = []
       delayed_atomic_unsets.each_pair do |name, docs|
@@ -275,8 +250,6 @@ module Mongoid
     #   person.delayed_atomic_sets
     #
     # @return [ Hash ] The delayed $sets.
-    #
-    # @since 2.3.0
     def delayed_atomic_sets
       @delayed_atomic_sets ||= {}
     end
@@ -287,8 +260,6 @@ module Mongoid
     #   document.delayed_atomic_pulls
     #
     # @return [ Hash ] name/document pairs.
-    #
-    # @since 2.3.2
     def delayed_atomic_pulls
       @delayed_atomic_pulls ||= {}
     end
@@ -299,8 +270,6 @@ module Mongoid
     #   document.delayed_atomic_unsets
     #
     # @return [ Hash ] The atomic unsets
-    #
-    # @since 3.0.0
     def delayed_atomic_unsets
       @delayed_atomic_unsets ||= {}
     end
@@ -311,8 +280,6 @@ module Mongoid
     #   document.flag_as_destroyed
     #
     # @return [ String ] The atomic path.
-    #
-    # @since 3.0.0
     def flag_as_destroyed
       self.destroyed = true
       self.flagged_for_destroy = false
@@ -325,8 +292,6 @@ module Mongoid
     #   document.flagged_destroys
     #
     # @return [ Array<Proc> ] The flagged destroys.
-    #
-    # @since 3.0.10
     def flagged_destroys
       @flagged_destroys ||= []
     end
@@ -337,8 +302,6 @@ module Mongoid
     #   document.process_flagged_destroys
     #
     # @return [ Array ] The cleared array.
-    #
-    # @since 3.0.10
     def process_flagged_destroys
       _assigning do
         flagged_destroys.each(&:call)
@@ -355,8 +318,6 @@ module Mongoid
     #
     # @param [ Modifiers ] mods The atomic modifications.
     # @param [ Document ] doc The document to update for.
-    #
-    # @since 2.2.0
     def generate_atomic_updates(mods, doc)
       mods.unset(doc.atomic_unsets)
       mods.pull(doc.atomic_pulls)
@@ -379,8 +340,6 @@ module Mongoid
     # @param [ Symbol ] field The optional field.
     #
     # @return [ Hash ] The atomic updates.
-    #
-    # @since 3.0.6
     def touch_atomic_updates(field = nil)
       updates = atomic_updates
       return {} unless atomic_updates.key?("$set")

data/lib/mongoid/attributes/dynamic.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Attributes
 
     # This module contains the behavior for dynamic attributes.
-    #
-    # @since 4.0.0
     module Dynamic
       extend ActiveSupport::Concern
 
@@ -19,8 +16,6 @@ module Mongoid
       # @param [ true, false ] include_private
       #
       # @return [ true, false ] True if it does, false if not.
-      #
-      # @since 4.0.0
       def respond_to?(name, include_private = false)
         super || (
           attributes &&
@@ -36,8 +31,6 @@ module Mongoid
       #   model.define_dynamic_reader(:field)
       #
       # @param [ String ] name The name of the field.
-      #
-      # @since 4.0.0
       def define_dynamic_reader(name)
         return unless name.valid_method_name?
 
@@ -57,8 +50,6 @@ module Mongoid
       #   model.define_dynamic_before_type_cast_reader(:field)
       #
       # @param [ String ] name The name of the field.
-      #
-      # @since 4.0.0
       def define_dynamic_before_type_cast_reader(name)
         class_eval do
           define_method("#{name}_before_type_cast") do
@@ -76,8 +67,6 @@ module Mongoid
       #   model.define_dynamic_writer(:field)
       #
       # @param [ String ] name The name of the field.
-      #
-      # @since 4.0.0
       def define_dynamic_writer(name)
         return unless name.valid_method_name?
 
@@ -96,8 +85,6 @@ module Mongoid
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Object ] value The value of the field.
-      #
-      # @since 4.0.0
       def process_attribute(name, value)
         responds = respond_to?("#{name}=")
         if !responds
@@ -113,8 +100,6 @@ module Mongoid
       #   document.inspect_dynamic_fields
       #
       # @return [ String ] An array of pretty printed dynamic field values.
-      #
-      # @since 4.0.0
       def inspect_dynamic_fields
         keys = attributes.keys - fields.keys - relations.keys - ["_id", self.class.discriminator_key]
         return keys.map do |name|
@@ -133,8 +118,6 @@ module Mongoid
       # @param [ Array ] args The arguments to the method.
       #
       # @return [ Object ] The result of the method call.
-      #
-      # @since 4.0.0
       def method_missing(name, *args)
         attr = name.to_s
         return super unless attributes.has_key?(attr.reader)

data/lib/mongoid/attributes/nested.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Attributes
 
     # Defines behavior around that lovel Rails feature nested attributes.
-    #
-    # @since 1.0.0
     module Nested
       extend ActiveSupport::Concern
 
@@ -80,8 +77,6 @@ module Mongoid
         #   Person.autosave_nested_attributes(metadata)
         #
         # @param [ Association ] association The existing association metadata.
-        #
-        # @since 3.1.4
         def autosave_nested_attributes(association)
           # In order for the autosave functionality to work properly, the association needs to be
           # marked as autosave despite the fact that the option isn't present. Because the method

data/lib/mongoid/attributes/processing.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Attributes
@@ -9,15 +8,13 @@ module Mongoid
 
       # Process the provided attributes casting them to their proper values if a
       # field exists for them on the document. This will be limited to only the
-      # attributes provided in the suppied +Hash+ so that no extra nil values get
+      # attributes provided in the supplied +Hash+ so that no extra nil values get
       # put into the document's attributes.
       #
       # @example Process the attributes.
       #   person.process_attributes(:title => "sir", :age => 40)
       #
       # @param [ Hash ] attrs The attributes to set.
-      #
-      # @since 2.0.0.rc.7
       def process_attributes(attrs = nil)
         attrs ||= {}
         if !attrs.empty?
@@ -44,8 +41,6 @@ module Mongoid
       # @param [ Object ] value The value of the attribute.
       #
       # @return [ true, false ] True if pending, false if not.
-      #
-      # @since 2.0.0.rc.7
       def pending_attribute?(key, value)
         name = key.to_s
         if relations.has_key?(name)
@@ -65,8 +60,6 @@ module Mongoid
       #   document.pending_relations
       #
       # @return [ Hash ] The pending associations in key/value pairs.
-      #
-      # @since 2.0.0.rc.7
       def pending_relations
         @pending_relations ||= {}
       end
@@ -77,8 +70,6 @@ module Mongoid
       #   document.pending_nested
       #
       # @return [ Hash ] The pending nested attributes in key/value pairs.
-      #
-      # @since 2.0.0.rc.7
       def pending_nested
         @pending_nested ||= {}
       end
@@ -91,8 +82,6 @@ module Mongoid
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Object ] value The value of the field.
-      #
-      # @since 2.0.0.rc.7
       def process_attribute(name, value)
         if !respond_to?("#{name}=", true) && store_as = aliased_fields.invert[name.to_s]
           name = store_as
@@ -107,8 +96,6 @@ module Mongoid
       #
       # @example Process the nested attributes.
       #   document.process_nested
-      #
-      # @since 2.0.0.rc.7
       def process_nested
         pending_nested.each_pair do |name, value|
           send("#{name}=", value)
@@ -119,8 +106,6 @@ module Mongoid
       #
       # @example Process the pending items.
       #   document.process_pending
-      #
-      # @since 2.0.0.rc.7
       def process_pending
         process_nested and process_relations
         pending_nested.clear and pending_relations.clear
@@ -131,8 +116,6 @@ module Mongoid
       #
       # @example Process the associations.
       #   document.process_relations
-      #
-      # @since 2.0.0.rc.7
       def process_relations
         pending_relations.each_pair do |name, value|
           association = relations[name]