mongoid 7.1.1 → 8.1.0

data/lib/mongoid/touchable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Touchable
@@ -20,21 +19,47 @@ 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
+      # @return [ true/false ] false if document is new_record otherwise true.
       def touch(field = nil)
         return false if _root.new_record?
-        current = Time.now
+        current = Time.configured.now
         field = database_field_name(field)
         write_attribute(:updated_at, current) if respond_to?("updated_at=")
         write_attribute(field, current) if field
 
-        touches = touch_atomic_updates(field)
-        unless touches["$set"].blank?
-          selector = atomic_selector
-          _root.collection.find(selector).update_one(positionally(selector, touches), session: _session)
+        # If the document being touched is embedded, touch its parents
+        # all the way through the composition hierarchy to the root object,
+        # because when an embedded document is changed the write is actually
+        # performed by the composition root. See MONGOID-3468.
+        if _parent
+          # This will persist updated_at on this document as well as parents.
+          # TODO support passing the field name to the parent's touch method;
+          # I believe it should be read out of
+          # _association.inverse_association.options but inverse_association
+          # seems to not always/ever be set here. See MONGOID-5014.
+          _parent.touch
+
+          if field
+            # If we are told to also touch a field, perform a separate write
+            # for that field. See MONGOID-5136.
+            # In theory we should combine the writes, which would require
+            # passing the fields to be updated to the parents - MONGOID-5142.
+            sets = set_field_atomic_updates(field)
+            selector = atomic_selector
+            _root.collection.find(selector).update_one(positionally(selector, sets), session: _session)
+          end
+        else
+          # If the current document is not embedded, it is composition root
+          # and we need to persist the write here.
+          touches = touch_atomic_updates(field)
+          unless touches["$set"].blank?
+            selector = atomic_selector
+            _root.collection.find(selector).update_one(positionally(selector, touches), session: _session)
+          end
         end
+
+        # Callbacks are invoked on the composition root first and on the
+        # leaf-most embedded document last.
         run_callbacks(:touch)
         true
       end
@@ -51,8 +76,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)
@@ -77,8 +100,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,11 +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
 
@@ -17,53 +16,184 @@ module Mongoid
       @__parent = p
     end
 
-    # Get all child +Documents+ to this +Document+, going n levels deep if
-    # necessary. This is used when calling update persistence operations from
+    # Module used for prepending to the various discriminator_*= methods
+    #
+    # @api private
+    module DiscriminatorAssignment
+      def discriminator_key=(value)
+        if hereditary?
+          raise Errors::InvalidDiscriminatorKeyTarget.new(self, self.superclass)
+        end
+
+        _mongoid_clear_types
+
+        if value
+          Mongoid::Fields::Validators::Macro.validate_field_name(self, value)
+          value = value.to_s
+          super
+        else
+          # When discriminator key is set to nil, replace the class's definition
+          # of the discriminator key reader (provided by class_attribute earlier)
+          # and re-delegate to Mongoid.
+          class << self
+            delegate :discriminator_key, to: ::Mongoid
+          end
+        end
+
+        # This condition checks if the new discriminator key would overwrite
+        # an existing field.
+        # This condition also checks if the class has any descendants, because
+        # if it doesn't then it doesn't need a discriminator key.
+        if !fields.has_key?(self.discriminator_key) && !descendants.empty?
+          default_proc = lambda { self.class.discriminator_value }
+          field(self.discriminator_key, default: default_proc, type: String)
+        end
+      end
+
+      def discriminator_value=(value)
+        value ||= self.name
+        _mongoid_clear_types
+        add_discriminator_mapping(value)
+        @discriminator_value = value
+      end
+    end
+
+    # Module used for prepending the discriminator_value method.
+    #
+    # 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 overridden by every subclass in the inherited method.
+    #
+    # @api private
+    module DiscriminatorRetrieval
+
+      # Get the name on the reading side if the discriminator_value is nil
+      def discriminator_value
+        @discriminator_value || self.name
+      end
+    end
+
+    included do
+      class_attribute :discriminator_key, instance_accessor: false
+
+      class << self
+        delegate :discriminator_key, to: ::Mongoid
+        prepend DiscriminatorAssignment
+        include DiscriminatorRetrieval
+
+        # @api private
+        #
+        # @return [ Hash<String, Class> ] The current mapping of discriminator_values to classes
+        attr_accessor :discriminator_mapping
+      end
+
+      # Add a discriminator mapping to the parent class. This mapping is used when
+      # receiving a document to identify its class.
+      #
+      # @param [ String ] value The discriminator_value that was just set
+      # @param [ Class ] The class the discriminator_value was set on
+      #
+      # @api private
+      def self.add_discriminator_mapping(value, klass=self)
+        self.discriminator_mapping ||= {}
+        self.discriminator_mapping[value] = klass
+        superclass.add_discriminator_mapping(value, klass) if hereditary?
+      end
+
+      # Get the discriminator mapping from the parent class. This method returns nil if there
+      # is no mapping for the given value.
+      #
+      # @param [ String ] value The discriminator_value to retrieve
+      #
+      # @return [ Class | nil ] klass The class corresponding to the given discriminator_value. If
+      #                               the value is not in the mapping, this method returns nil.
+      #
+      # @api private
+      def self.get_discriminator_mapping(value)
+        self.discriminator_mapping[value] if self.discriminator_mapping
+      end
+    end
+
+    # 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
@@ -73,7 +203,7 @@ module Mongoid
     # @example Check if the document is a subclass
     #   Square.new.hereditary?
     #
-    # @return [ true, false ] True if hereditary, false if not.
+    # @return [ true | false ] True if hereditary, false if not.
     def hereditary?
       self.class.hereditary?
     end
@@ -100,49 +230,39 @@ 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?
+        self.attributes.delete(child._association.store_as)
         remove_ivar(name)
       else
         relation = send(name)
-        relation.send(:delete_one, child)
+        relation._remove(child)
       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
@@ -163,9 +283,7 @@ module Mongoid
     # @example Is the document the root?
     #   document._root?
     #
-    # @return [ true, false ] If the document is the root.
-    #
-    # @since 3.1.0
+    # @return [ true | false ] If the document is the root.
     def _root?
       _parent ? false : true
     end
@@ -177,7 +295,7 @@ module Mongoid
       # @example Check if the document is a subclass.
       #   Square.hereditary?
       #
-      # @return [ true, false ] True if hereditary, false if not.
+      # @return [ true | false ] True if hereditary, false if not.
       def hereditary?
         !!(Mongoid::Document > superclass)
       end
@@ -190,8 +308,6 @@ module Mongoid
       #   Person.inherited(Doctor)
       #
       # @param [ Class ] subclass The inheriting class.
-      #
-      # @since 2.0.0.rc.6
       def inherited(subclass)
         super
         @_type = nil
@@ -201,14 +317,20 @@ module Mongoid
         subclass.pre_processed_defaults = pre_processed_defaults.dup
         subclass.post_processed_defaults = post_processed_defaults.dup
         subclass._declared_scopes = Hash.new { |hash,key| self._declared_scopes[key] }
+        subclass.discriminator_value = subclass.name
+
+        # We need to do this here because the discriminator_value method is
+        # overridden in the subclass above.
+        class << subclass
+          include DiscriminatorRetrieval
+        end
 
         # We only need the _type field if inheritance is in play, but need to
         # add to the root class as well for backwards compatibility.
-        unless fields.has_key?("_type")
-          field(:_type, default: self.name, type: String)
+        unless fields.has_key?(self.discriminator_key)
+          default_proc = lambda { self.class.discriminator_value }
+          field(self.discriminator_key, default: default_proc, type: String)
         end
-        subclass_default = subclass.name || ->{ self.class.name }
-        subclass.field(:_type, default: subclass_default, type: String, overwrite: true)
       end
     end
   end

data/lib/mongoid/utils.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mongoid
+
+  # @api private
+  module Utils
+
+    # This function should be used if you need to measure time.
+    # @example Calculate elapsed time.
+    #   starting = Utils.monotonic_time
+    #   # do something time consuming
+    #   ending = Utils.monotonic_time
+    #   puts "It took #{(ending - starting).to_i} seconds"
+    #
+    # @see https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/
+    #
+    # @return [Float] seconds according to monotonic clock
+    module_function def monotonic_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+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
@@ -43,7 +40,7 @@ module Mongoid
         ensure
           document.exit_validate
         end
-        document.errors.add(attribute, :invalid, options) unless valid
+        document.errors.add(attribute, :invalid, **options) unless valid
       end
     end
   end

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
@@ -13,10 +12,8 @@ module Mongoid
       #   validator.validate_each(model, :name, "value")
       #
       # @param [ Document ] document The document.
-      # @param [ Symbol, String ] attribute The attribute to validate.
+      # @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
@@ -19,8 +18,7 @@ module Mongoid
       #     validates_associated :name, :addresses
       #   end
       #
-      # @param [ Array ] args The arguments to pass to the validator.
-      #
+      # @param [ Object... ] *args The arguments to pass to the validator.
       def validates_associated(*args)
         validates_with(AssociatedValidator, _merge_attributes(args))
       end
@@ -37,8 +35,7 @@ module Mongoid
       #     validates_uniqueness_of :title
       #   end
       #
-      # @param [ Array ] args The arguments to pass to the validator.
-      #
+      # @param [ Object... ] *args The arguments to pass to the validator.
       def validates_uniqueness_of(*args)
         validates_with(UniquenessValidator, _merge_attributes(args))
       end
@@ -53,9 +50,7 @@ module Mongoid
       #     validates_format_of :title, with: /\A[a-z0-9 \-_]*\z/i
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
-      #
-      # @since 2.4.0
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_format_of(*args)
         validates_with(FormatValidator, _merge_attributes(args))
       end
@@ -70,9 +65,7 @@ module Mongoid
       #     validates_length_of :title, minimum: 100
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
-      #
-      # @since 2.4.0
+      # @param [ Object... ] *args The names of the field(s) to validate.
       def validates_length_of(*args)
         validates_with(LengthValidator, _merge_attributes(args))
       end
@@ -87,9 +80,7 @@ module Mongoid
       #     validates_presence_of :title
       #   end
       #
-      # @param [ Array ] args The names of the fields to validate.
-      #
-      # @since 2.4.0
+      # @param [ Object... ] *args The names of the field(s) to validate.
       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?
@@ -34,15 +31,15 @@ module Mongoid
             document.errors.add(
               attribute,
               :blank_in_locale,
-              options.merge(location: _locale)
+              **options.merge(location: _locale)
             ) if not_present?(_value)
           end
         elsif document.relations.has_key?(attribute.to_s)
           if relation_or_fk_missing?(document, attribute, value)
-            document.errors.add(attribute, :blank, options)
+            document.errors.add(attribute, :blank, **options)
           end
         else
-          document.errors.add(attribute, :blank, options) if not_present?(value)
+          document.errors.add(attribute, :blank, **options) if not_present?(value)
         end
       end
 
@@ -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
+      # @return [ true | false ] If the doc is missing.
       def relation_or_fk_missing?(doc, attr, value)
         return true if value.blank? && doc.send(attr).blank?
         association = doc.relations[attr.to_s]
@@ -77,9 +72,7 @@ module Mongoid
       #
       # @param [ Object ] value The value.
       #
-      # @return [ true, false ] If the value is not present.
-      #
-      # @since 3.0.5
+      # @return [ true | false ] If the value is not present.
       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