mongoid 7.3.5 → 7.5.0

data/lib/mongoid/timestamps/short.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Timestamps

data/lib/mongoid/timestamps/timeless.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Timestamps
@@ -15,8 +14,6 @@ module Mongoid
       #   document.clear_timeless_option
       #
       # @return [ true ] True.
-      #
-      # @since 3.1.4
       def clear_timeless_option
         if self.persisted?
           self.class.clear_timeless_option_on_update
@@ -32,8 +29,6 @@ module Mongoid
       #   person.timeless.save
       #
       # @return [ Document ] The document this was called on.
-      #
-      # @since 2.3.0
       def timeless
         self.class.timeless
         self
@@ -63,8 +58,6 @@ module Mongoid
         #   Person.timeless.create(:title => "Sir")
         #
         # @return [ Class ] The class this was called on.
-        #
-        # @since 2.3.0
         def timeless
           counter = 0
           counter += 1 if self < Mongoid::Timestamps::Created

data/lib/mongoid/timestamps/updated/short.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Timestamps

data/lib/mongoid/timestamps/updated.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/timestamps/updated/short"
 
@@ -37,8 +36,6 @@ module Mongoid
       #   document.able_to_set_updated_at?
       #
       # @return [ true, false ] If the timestamp can be set.
-      #
-      # @since 2.4.0
       def able_to_set_updated_at?
         !frozen? && !timeless? && (new_record? || changed?)
       end

data/lib/mongoid/timestamps.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/timestamps/timeless"
 require "mongoid/timestamps/created"

data/lib/mongoid/touchable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Touchable
@@ -21,8 +20,6 @@ module Mongoid
       # @param [ Symbol ] field The name of an additional field to update.
       #
       # @return [ true/false ] false if record is new_record otherwise true.
-      #
-      # @since 3.0.0
       def touch(field = nil)
         return false if _root.new_record?
         current = Time.now
@@ -80,8 +77,6 @@ module Mongoid
     # @param [ Association ] association The association metadata.
     #
     # @return [ Class ] The model class.
-    #
-    # @since 3.0.0
     def define_touchable!(association)
       name = association.name
       method_name = define_relation_touch_method(name, association)
@@ -106,8 +101,6 @@ module Mongoid
     # @param [ Symbol ] name The name of the association.
     # @param [ Association ] association The association metadata.
     #
-    # @since 3.1.0
-    #
     # @return [ Symbol ] The method name.
     def define_relation_touch_method(name, association)
       relation_classes = if association.polymorphic?

data/lib/mongoid/traversable.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/fields/validators/macro"
 
 module Mongoid
 
   # Provides behavior around traversing the document graph.
-  #
-  # @since 4.0.0
   module Traversable
     extend ActiveSupport::Concern
 
@@ -66,7 +63,7 @@ module Mongoid
     # A separate module was needed because the subclasses of this class
     # need to be manually prepended with the discriminator_value and can't
     # rely on being a class_attribute because the .discriminator_value
-    # method is overriden by every subclass in the inherited method.
+    # method is overridden by every subclass in the inherited method.
     #
     # @api private
     module DiscriminatorRetrieval
@@ -118,53 +115,85 @@ module Mongoid
       end
     end
 
-    # Get all child +Documents+ to this +Document+, going n levels deep if
-    # necessary. This is used when calling update persistence operations from
+    # Get all child +Documents+ to this +Document+
+    #
+    # @return [ Array<Document> ] All child documents in the hierarchy.
+    #
+    # @api private
+    def _children
+      @__children ||= collect_children
+    end
+
+    # Get all descendant +Documents+ of this +Document+ recursively.
+    # This is used when calling update persistence operations from
     # the root document, where changes in the entire tree need to be
     # determined. Note that persistence from the embedded documents will
     # always be preferred, since they are optimized calls... This operation
     # can get expensive in domains with large hierarchies.
     #
-    # @example Get all the document's children.
-    #   person._children
+    # @return [ Array<Document> ] All descendant documents in the hierarchy.
     #
-    # @return [ Array<Document> ] All child documents in the hierarchy.
-    def _children
-      @__children ||= collect_children
+    # @api private
+    def _descendants
+      @__descendants ||= collect_descendants
     end
 
     # Collect all the children of this document.
     #
-    # @example Collect all the children.
-    #   document.collect_children
-    #
     # @return [ Array<Document> ] The children.
     #
-    # @since 2.4.0
+    # @api private
     def collect_children
       children = []
       embedded_relations.each_pair do |name, association|
         without_autobuild do
           child = send(name)
-          Array.wrap(child).each do |doc|
-            children.push(doc)
-            children.concat(doc._children)
-          end if child
+          if child
+            children += Array.wrap(child)
+          end
         end
       end
       children
     end
 
-    # Marks all children as being persisted.
+    # Collect all the descendants of this document.
     #
-    # @example Flag all the children.
-    #   document.flag_children_persisted
+    # @return [ Array<Document> ] The descendants.
     #
-    # @return [ Array<Document> ] The flagged children.
+    # @api private
+    def collect_descendants
+      children = []
+      to_expand = []
+      expanded = {}
+      embedded_relations.each_pair do |name, association|
+        without_autobuild do
+          child = send(name)
+          if child
+            to_expand += Array.wrap(child)
+          end
+        end
+      end
+      until to_expand.empty?
+        expanding = to_expand
+        to_expand = []
+        expanding.each do |child|
+          next if expanded[child]
+          # Don't mark expanded if _id is nil, since documents are compared by
+          # their _ids, multiple embedded documents with nil ids will compare
+          # equally, and some documents will not be expanded.
+          expanded[child] = true if child._id
+          children << child
+          to_expand += child._children
+        end
+      end
+      children
+    end
+
+    # Marks all descendants as being persisted.
     #
-    # @since 3.0.7
-    def flag_children_persisted
-      _children.each do |child|
+    # @return [ Array<Document> ] The flagged descendants.
+    def flag_descendants_persisted
+      _descendants.each do |child|
         child.new_record = false
       end
     end
@@ -201,8 +230,6 @@ module Mongoid
     #   document.remove_child(child)
     #
     # @param [ Document ] child The child (embedded) document to remove.
-    #
-    # @since 2.0.0.beta.1
     def remove_child(child)
       name = child.association_name
       if child.embedded_one?
@@ -213,37 +240,28 @@ module Mongoid
       end
     end
 
-    # After children are persisted we can call this to move all their changes
-    # and flag them as persisted in one call.
-    #
-    # @example Reset the children.
-    #   document.reset_persisted_children
+    # After descendants are persisted we can call this to move all their
+    # changes and flag them as persisted in one call.
     #
-    # @return [ Array<Document> ] The children.
-    #
-    # @since 2.1.0
-    def reset_persisted_children
-      _children.each do |child|
+    # @return [ Array<Document> ] The descendants.
+    def reset_persisted_descendants
+      _descendants.each do |child|
         child.move_changes
         child.new_record = false
       end
-      _reset_memoized_children!
+      _reset_memoized_descendants!
     end
 
-    # Resets the memoized children on the object. Called internally when an
+    # Resets the memoized descendants on the object. Called internally when an
     # embedded array changes size.
     #
-    # @api semiprivate
-    #
-    # @example Reset the memoized children.
-    #   document._reset_memoized_children!
-    #
     # @return [ nil ] nil.
     #
-    # @since 5.0.0
-    def _reset_memoized_children!
-      _parent._reset_memoized_children! if _parent
+    # @api private
+    def _reset_memoized_descendants!
+      _parent._reset_memoized_descendants! if _parent
       @__children = nil
+      @__descendants = nil
     end
 
     # Return the root document in the object graph. If the current document
@@ -265,8 +283,6 @@ module Mongoid
     #   document._root?
     #
     # @return [ true, false ] If the document is the root.
-    #
-    # @since 3.1.0
     def _root?
       _parent ? false : true
     end
@@ -291,8 +307,6 @@ module Mongoid
       #   Person.inherited(Doctor)
       #
       # @param [ Class ] subclass The inheriting class.
-      #
-      # @since 2.0.0.rc.6
       def inherited(subclass)
         super
         @_type = nil
@@ -305,7 +319,7 @@ module Mongoid
         subclass.discriminator_value = subclass.name
 
         # We need to do this here because the discriminator_value method is
-        # overriden in the subclass above.
+        # overridden in the subclass above.
         class << subclass
           include DiscriminatorRetrieval
         end

data/lib/mongoid/validatable/associated.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable
@@ -28,8 +27,6 @@ module Mongoid
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The association to validate.
       # @param [ Object ] value The value of the association.
-      #
-      # @since 2.0.0
       def validate_each(document, attribute, value)
         begin
           document.begin_validate

data/lib/mongoid/validatable/format.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable

data/lib/mongoid/validatable/length.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable

data/lib/mongoid/validatable/localizable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable
@@ -15,8 +14,6 @@ module Mongoid
       # @param [ Document ] document The document.
       # @param [ Symbol, String ] attribute The attribute to validate.
       # @param [ Object ] value The attribute value.
-      #
-      # @since 2.4.2
       def validate_each(document, attribute, value)
         field = document.fields[document.database_field_name(attribute)]
         if field.try(:localized?) && !value.blank?

data/lib/mongoid/validatable/macros.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable
@@ -54,8 +53,6 @@ module Mongoid
       #   end
       #
       # @param [ Array ] args The names of the fields to validate.
-      #
-      # @since 2.4.0
       def validates_format_of(*args)
         validates_with(FormatValidator, _merge_attributes(args))
       end
@@ -71,8 +68,6 @@ module Mongoid
       #   end
       #
       # @param [ Array ] args The names of the fields to validate.
-      #
-      # @since 2.4.0
       def validates_length_of(*args)
         validates_with(LengthValidator, _merge_attributes(args))
       end
@@ -88,8 +83,6 @@ module Mongoid
       #   end
       #
       # @param [ Array ] args The names of the fields to validate.
-      #
-      # @since 2.4.0
       def validates_presence_of(*args)
         validates_with(PresenceValidator, _merge_attributes(args))
       end

data/lib/mongoid/validatable/presence.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable
@@ -25,8 +24,6 @@ module Mongoid
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The attribute name.
       # @param [ Object ] value The current value of the field.
-      #
-      # @since 2.4.0
       def validate_each(document, attribute, value)
         field = document.fields[document.database_field_name(attribute)]
         if field.try(:localized?) && !value.blank?
@@ -53,15 +50,13 @@ module Mongoid
       # @api private
       #
       # @example Check is the association or fk is blank.
-      #   validator.relation_or_fk_mising(doc, :name, "")
+      #   validator.relation_or_fk_missing(doc, :name, "")
       #
       # @param [ Document ] doc The document.
       # @param [ Symbol ] attr The attribute.
       # @param [ Object ] value The value.
       #
       # @return [ true, false ] If the doc is missing.
-      #
-      # @since 3.0.0
       def relation_or_fk_missing?(doc, attr, value)
         return true if value.blank? && doc.send(attr).blank?
         association = doc.relations[attr.to_s]
@@ -78,8 +73,6 @@ module Mongoid
       # @param [ Object ] value The value.
       #
       # @return [ true, false ] If the value is not present.
-      #
-      # @since 3.0.5
       def not_present?(value)
         value.blank? && value != false
       end

data/lib/mongoid/validatable/queryable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable
@@ -16,8 +15,6 @@ module Mongoid
       # @param [ Document ] document The document being validated.
       #
       # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.2
       def with_query(document)
         klass = document.class
         begin

data/lib/mongoid/validatable/uniqueness.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Validatable
@@ -38,8 +37,6 @@ module Mongoid
       # @param [ Object ] value The value of the field.
       #
       # @return [ Errors ] The errors.
-      #
-      # @since 1.0.0
       def validate_each(document, attribute, value)
         with_query(document) do
           attrib, val = to_validate(document, attribute, value)
@@ -64,8 +61,6 @@ module Mongoid
       # @param [ Document ] document The document to validate.
       # @param [ Symbol ] attribute The name of the attribute.
       # @param [ Object ] value The value of the object.
-      #
-      # @since 2.4.10
       def add_error(document, attribute, value)
         document.errors.add(
           attribute, :taken, **options.except(:case_sensitive, :scope).merge(value: value)
@@ -80,8 +75,6 @@ module Mongoid
       #   validator.case_sensitive?
       #
       # @return [ true, false ] If the validation is case sensitive.
-      #
-      # @since 2.3.0
       def case_sensitive?
         !(options[:case_sensitive] == false)
       end
@@ -99,11 +92,23 @@ module Mongoid
       # @param [ Object ] value The value of the object.
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 2.4.10
       def create_criteria(base, document, attribute, value)
         criteria = scope(base.unscoped, document, attribute)
-        criteria.selector.update(criterion(document, attribute, value.mongoize))
+        field = document.fields[document.database_field_name(attribute)]
+
+        # In the past, we were calling value.mongoize in all cases, which
+        # would call Object's mongoize method. This is a problem for StringifiedSymbol,
+        # because a Symbol should mongoize to a String, but calling .mongoize
+        # on a Symbol mongoizes it to a Symbol.
+        # Therefore, we call the field's mongoize in all cases except when the
+        # field is localized, because by the time we arrive at this code, the
+        # value is already in the form of { lang => translation } and calling
+        # the field's mongoize will nest that further into { lang =>
+        # "\{ lang => translation \}"} (assuming the field type is a string).
+        # Therefore, we call Object's mongoize method so it returns the hash as
+        # it is.
+        mongoized = field.try(:localized?) ? value.mongoize : field.mongoize(value)
+        criteria.selector.update(criterion(document, attribute, mongoized))
         criteria
       end
 
@@ -119,8 +124,6 @@ module Mongoid
       # @param [ Object ] value The value of the object.
       #
       # @return [ Criteria ] The uniqueness criteria.
-      #
-      # @since 2.3.0
       def criterion(document, attribute, value)
         field = document.database_field_name(attribute)
 
@@ -147,8 +150,6 @@ module Mongoid
       # @param [ Object ] value The value to filter.
       #
       # @return [ Object, Regexp ] The value, filtered or not.
-      #
-      # @since 2.3.0
       def filter(value)
         !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}\z/i : value
       end
@@ -164,8 +165,6 @@ module Mongoid
       # @param [ Document ] document The document being validated.
       #
       # @return [ Criteria ] The scoped criteria.
-      #
-      # @since 2.3.0
       def scope(criteria, document, _attribute)
         Array.wrap(options[:scope]).each do |item|
           name = document.database_field_name(item)
@@ -184,8 +183,6 @@ module Mongoid
       # @param [ Document ] document The embedded document.
       #
       # @return [ true, false ] If the validation should be skipped.
-      #
-      # @since 2.3.0
       def skip_validation?(document)
         !document._parent || document.embedded_one?
       end
@@ -200,8 +197,6 @@ module Mongoid
       # @param [ Document ] document The embedded document.
       #
       # @return [ true, false ] If the scope reference has changed.
-      #
-      # @since
       def scope_value_changed?(document)
         Array.wrap(options[:scope]).any? do |item|
           document.send("attribute_changed?", item.to_s)
@@ -223,8 +218,6 @@ module Mongoid
       # @param [ Object ] value The value of the attribute.
       #
       # @return [ Array<Object, Object> ] The field and value.
-      #
-      # @since 2.4.4
       def to_validate(document, attribute, value)
         association = document.relations[attribute.to_s]
         if association && association.stores_foreign_key?
@@ -244,8 +237,6 @@ module Mongoid
       # @param [ Document ] document The document.
       # @param [ Symbol ] attribute The attribute name.
       # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
       def validate_embedded(document, attribute, value)
         return if skip_validation?(document)
         relation = document._parent.send(document.association_name)
@@ -264,8 +255,6 @@ module Mongoid
       # @param [ Document ] document The document.
       # @param [ Symbol ] attribute The attribute name.
       # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
       def validate_root(document, attribute, value)
         klass = document.class
 
@@ -289,8 +278,6 @@ module Mongoid
       # @param [ Symbol ] attribute The attribute to validate.
       #
       # @return [ true, false ] If we need to validate.
-      #
-      # @since 2.4.4
       def validation_required?(document, attribute)
         document.new_record? ||
           document.send("attribute_changed?", attribute.to_s) ||
@@ -308,8 +295,6 @@ module Mongoid
       # @param [ Symbol ] attribute The attribute to validate.
       #
       # @return [ true, false ] If the attribute is localized.
-      #
-      # @since 4.0.0
       def localized?(document, attribute)
         document.fields[document.database_field_name(attribute)].try(:localized?)
       end

data/lib/mongoid/validatable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/validatable/macros"
 require "mongoid/validatable/localizable"
@@ -26,8 +25,6 @@ module Mongoid
     #
     # @example Begin validation.
     #   document.begin_validate
-    #
-    # @since 2.1.9
     def begin_validate
       Threaded.begin_validate(self)
     end
@@ -36,8 +33,6 @@ module Mongoid
     #
     # @example Exit validation.
     #   document.exit_validate
-    #
-    # @since 2.1.9
     def exit_validate
       Threaded.exit_validate(self)
     end
@@ -50,8 +45,6 @@ module Mongoid
     # @param [ Hash ] options The options to check.
     #
     # @return [ true, false ] If we are validating.
-    #
-    # @since 4.0.0
     def performing_validations?(options = {})
       options[:validate].nil? ? true : options[:validate]
     end
@@ -66,8 +59,6 @@ module Mongoid
     # @param [ Symbol ] attr The name of the field or association.
     #
     # @return [ Object ] The value of the field or the association.
-    #
-    # @since 2.0.0.rc.1
     def read_attribute_for_validation(attr)
       attribute = database_field_name(attr)
       if relations.key?(attribute)
@@ -93,8 +84,6 @@ module Mongoid
     # @param [ Symbol ] context The optional validation context.
     #
     # @return [ true, false ] True if valid, false if not.
-    #
-    # @since 2.0.0.rc.6
     def valid?(context = nil)
       super context ? context : (new_record? ? :create : :update)
     end
@@ -105,8 +94,6 @@ module Mongoid
     #   document.validated?
     #
     # @return [ true, false ] Has the document already been validated?
-    #
-    # @since 2.0.0.rc.2
     def validated?
       Threaded.validated?(self)
     end
@@ -117,8 +104,6 @@ module Mongoid
     #   document.validating_with_query?
     #
     # @return [ true, false ] If we are validating with a query.
-    #
-    # @since 3.0.2
     def validating_with_query?
       self.class.validating_with_query?
     end
@@ -132,15 +117,13 @@ module Mongoid
       #   Person.validates_relation(association)
       #
       # @param [ Association ] association The association metadata.
-      #
-      # @since 2.0.0.rc.1
       def validates_relation(association)
         if association.validate?
           validates_associated(association.name)
         end
       end
 
-      # Add validation with the supplied validators forthe provided fields
+      # Add validation with the supplied validators for the provided fields
       # with options.
       #
       # @example Validate with a specific validator.
@@ -151,8 +134,6 @@ module Mongoid
       # @note See ActiveModel::Validations::With for full options. This is
       #   overridden to add autosave functionality when presence validation is
       #   added.
-      #
-      # @since 3.0.0
       def validates_with(*args, &block)
         if args.first == PresenceValidator
           args.last[:attributes].each do |name|
@@ -171,8 +152,6 @@ module Mongoid
       #   Model.validating_with_query?
       #
       # @return [ true, false ] If we are validating with a query.
-      #
-      # @since 3.0.2
       def validating_with_query?
         Threaded.executing?("#{name}-validate-with-query")
       end