mongoid 9.0.11 → 9.1.1

data/lib/mongoid/timestamps/created.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/timestamps/created/short"
+require 'mongoid/timestamps/created/short'
 
 module Mongoid
   module Timestamps

data/lib/mongoid/timestamps/short.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Timestamps

data/lib/mongoid/timestamps/timeless.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Timestamps
-
     # This module adds behavior for turning off timestamping in single or
     # multiple calls.
     module Timeless
@@ -16,7 +14,7 @@ module Mongoid
       #
       # @return [ true ] True.
       def clear_timeless_option
-        if self.persisted?
+        if persisted?
           self.class.clear_timeless_option_on_update
         else
           self.class.clear_timeless_option
@@ -24,13 +22,20 @@ module Mongoid
         true
       end
 
-      # Begin an execution that should skip timestamping.
+      # Skip timestamping for the duration of the given block, or (in the
+      # deprecated, block-less form) for the next persistence operation.
+      #
+      # @example Save a document but don't timestamp (block form).
+      #   person.timeless { person.save }
       #
-      # @example Save a document but don't timestamp.
+      # @example Save a document but don't timestamp (deprecated chained form).
       #   person.timeless.save
       #
-      # @return [ Document ] The document this was called on.
-      def timeless
+      # @return [ Object | Document ] The return value of the block, or (in the
+      #   block-less form) the document this was called on.
+      def timeless(&block)
+        return Timeless.with_timeless(&block) if block
+
         self.class.timeless
         self
       end
@@ -46,9 +51,12 @@ module Mongoid
       class << self
         extend Forwardable
 
-        # The key to use to store the timeless table 
+        # The key to use to store the timeless table
         TIMELESS_TABLE_KEY = '[mongoid]:timeless'
 
+        # The key to use to store the block-based timeless flag.
+        TIMELESS_FLAG_KEY = '[mongoid]:timeless-flag'
+
         # Returns the in-memory thread cache of classes
         # for which to skip timestamping.
         #
@@ -56,23 +64,82 @@ module Mongoid
         #
         # @api private
         def timeless_table
-          Threaded.get(TIMELESS_TABLE_KEY) { Hash.new }
+          Threaded.get(TIMELESS_TABLE_KEY) { {} }
         end
 
         def_delegators :timeless_table, :[]=, :[]
-      end
 
-      private
+        # Skip timestamping for the duration of the given block, on the
+        # current thread or fiber. This applies to every document persisted
+        # while the block is executing, regardless of class, including
+        # cascaded embedded children at any nesting depth.
+        #
+        # @example Skip timestamping for a block.
+        #   Mongoid::Timestamps::Timeless.with_timeless do
+        #     person.save
+        #   end
+        #
+        # @return [ Object ] The return value of the block.
+        def with_timeless
+          # Only the outermost block owns the flag: if we are already inside a
+          # timeless scope, we leave the suppression in place when this block
+          # ends. This avoids tracking a nesting depth that could drift out of
+          # sync.
+          already_timeless = suppressing_timestamps?
+          set_suppressing_timestamps(true) unless already_timeless
+          yield
+        ensure
+          set_suppressing_timestamps(false) unless already_timeless
+        end
 
-      module ClassMethods
+        # Whether a block-based timeless scope is currently active on this
+        # thread/fiber.
+        #
+        # @return [ true | false ] Whether timestamps are being suppressed.
+        #
+        # @api private
+        def suppressing_timestamps?
+          !!Threaded.get(TIMELESS_FLAG_KEY) { false }
+        end
 
-        # Begin an execution that should skip timestamping.
+        # Set whether a block-based timeless scope is active on this
+        # thread/fiber.
         #
-        # @example Create a document but don't timestamp.
+        # @param [ true | false ] value Whether to suppress timestamps.
+        #
+        # @api private
+        def set_suppressing_timestamps(value)
+          Threaded.set(TIMELESS_FLAG_KEY, value)
+        end
+      end
+
+      module ClassMethods
+        # Skip timestamping for the duration of the given block, or (in the
+        # deprecated, block-less form) for the next persistence operation.
+        #
+        # @example Create a document but don't timestamp (block form).
+        #   Person.timeless { Person.create(title: "Sir") }
+        #
+        # @example Create a document but don't timestamp (deprecated form).
         #   Person.timeless.create(:title => "Sir")
         #
-        # @return [ Class ] The class this was called on.
-        def timeless
+        # @return [ Object | Class ] The return value of the block, or (in the
+        #   block-less form) the class this was called on.
+        def timeless(&block)
+          return Timeless.with_timeless(&block) if block
+
+          locations = caller_locations
+
+          # if this is called from the #timeless instance method, look up one
+          # level higher for the call site
+          locations.shift if locations[0].path == __FILE__
+
+          Mongoid.deprecation_warning(
+            :timeless_sans_block,
+            'Calling #timeless without a block is deprecated; pass a block ' \
+            'instead, e.g. `record.timeless { record.save }`.',
+            locations
+          )
           counter = 0
           counter += 1 if self < Mongoid::Timestamps::Created
           counter += 1 if self < Mongoid::Timestamps::Updated
@@ -96,11 +163,11 @@ module Mongoid
         #
         # @return [ true ] Always true.
         def clear_timeless_option_on_update
-          if counter = Timeless[name]
-            counter -= 1 if self < Mongoid::Timestamps::Created
-            counter -= 1 if self < Mongoid::Timestamps::Updated
-            set_timeless_counter(counter)
-          end
+          return unless counter = Timeless[name]
+
+          counter -= 1 if self < Mongoid::Timestamps::Created
+          counter -= 1 if self < Mongoid::Timestamps::Updated
+          set_timeless_counter(counter)
         end
 
         # Clears the timeless counter for the current class
@@ -114,12 +181,14 @@ module Mongoid
           Timeless[name] = (counter == 0) ? nil : counter
         end
 
-        # Returns whether the current class should skip timestamping.
+        # Returns whether the current class should skip timestamping. This is
+        # true when either a block-based timeless scope is active on the
+        # current thread/fiber, or the deprecated per-class counter is set.
         #
         # @return [ true | false ] Whether the current class should
         #   skip timestamping.
         def timeless?
-          !!Timeless[name]
+          Timeless.suppressing_timestamps? || !!Timeless[name]
         end
       end
     end

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

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Timestamps
     module Updated
-
       # Adds an updated_at timestamp to the document, but it is stored as u_at
       # with an updated_at alias.
       module Short
@@ -12,7 +10,8 @@ module Mongoid
 
         included do
           include Updated
-          fields.delete("updated_at")
+
+          fields.delete('updated_at')
           field :u_at, type: Time, as: :updated_at
         end
       end

data/lib/mongoid/timestamps/updated.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/timestamps/updated/short"
+require 'mongoid/timestamps/updated/short'
 
 module Mongoid
   module Timestamps
@@ -24,9 +23,7 @@ module Mongoid
       # @example Set the updated at time.
       #   person.set_updated_at
       def set_updated_at
-        if able_to_set_updated_at?
-          self.updated_at = Time.current unless updated_at_changed?
-        end
+        self.updated_at = Time.current if able_to_set_updated_at? && !updated_at_changed?
 
         clear_timeless_option
       end

data/lib/mongoid/timestamps.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/timestamps/timeless"
-require "mongoid/timestamps/created"
-require "mongoid/timestamps/updated"
-require "mongoid/timestamps/short"
+require 'mongoid/timestamps/timeless'
+require 'mongoid/timestamps/created'
+require 'mongoid/timestamps/updated'
+require 'mongoid/timestamps/short'
 
 module Mongoid
-
   # This module handles the behavior for setting up document created at and
   # updated at timestamps.
   module Timestamps

data/lib/mongoid/touchable.rb

@@ -1,17 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Mixin module which is included in Mongoid::Document to add "touch"
   # functionality to update a document's timestamp(s) atomically.
   module Touchable
-
     # Used to provide mixin functionality.
     #
     # @todo Refactor using ActiveSupport::Concern
     module InstanceMethods
-
       # Suppresses the invocation of touch callbacks, for the class that
       # includes this module, for the duration of the block.
       #
@@ -19,8 +15,8 @@ module Mongoid
       #   person.suppress_touch_callbacks { ... }
       #
       # @api private
-      def suppress_touch_callbacks
-        Touchable.suppress_touch_callbacks(self.class.name) { yield }
+      def suppress_touch_callbacks(&block)
+        Touchable.suppress_touch_callbacks(self.class.name, &block)
       end
 
       # Queries whether touch callbacks are being suppressed for the class
@@ -77,7 +73,7 @@ module Mongoid
 
         field = database_field_name(field)
 
-        write_attribute(:updated_at, now) if respond_to?("updated_at=")
+        write_attribute(:updated_at, now) if respond_to?(:updated_at=)
         write_attribute(field, now) if field.present?
 
         touches = _extract_touches_from_atomic_sets(field) || {}
@@ -103,6 +99,7 @@ module Mongoid
       # @api private
       def _run_touch_callbacks_from_root
         return if touch_callbacks_suppressed?
+
         _parent._run_touch_callbacks_from_root if _touchable_parent?
         run_callbacks(:touch)
       end
@@ -132,9 +129,7 @@ module Mongoid
         touchable_keys << field.to_s if field.present?
 
         updates.keys.each_with_object({}) do |key, touches|
-          if touchable_keys.include?(key.split('.').last)
-            touches[key] = updates.delete(key)
-          end
+          touches[key] = updates.delete(key) if touchable_keys.include?(key.split('.').last)
         end
       end
     end
@@ -187,7 +182,7 @@ module Mongoid
     private
 
     # The key to use to store the active touch callback suppression statuses
-    SUPPRESS_TOUCH_CALLBACKS_KEY = "[mongoid]:suppress-touch-callbacks"
+    SUPPRESS_TOUCH_CALLBACKS_KEY = '[mongoid]:suppress-touch-callbacks'
 
     # Returns a hash to be used to store and query the various touch callback
     # suppression statuses for different classes.
@@ -216,6 +211,19 @@ module Mongoid
       association.inverse_class.class_eval do
         define_method(method_name) do
           without_autobuild do
+            # If the touch updates were already merged into an atomic
+            # insert (see Persistable::Creatable#insert_as_embedded),
+            # skip the redundant persistence but still run :touch
+            # callbacks and clean up dirty tracking.
+            if Threaded.touch_merged?(self)
+              Threaded.exit_touch_merged(self)
+              if relation = __send__(name)
+                relation._run_touch_callbacks_from_root
+                relation._clear_touch_updates(association.touch_field)
+              end
+              next
+            end
+
             if !touch_callbacks_suppressed? && relation = __send__(name)
               # This looks up touch_field at runtime, rather than at method definition time.
               # If touch_field is nil, it will only touch the default field (updated_at).

data/lib/mongoid/traversable.rb

@@ -8,6 +8,7 @@ module Mongoid
   # around traversing the document graph.
   module Traversable
     extend ActiveSupport::Concern
+
     # This code is extracted from ActiveSupport so that we do not depend on
     # their private API that may change at any time.
     # This code should be reviewed and maybe removed when implementing
@@ -65,7 +66,6 @@ module Mongoid
       #
       # @param [ Class ] subclass The inheriting class.
       #
-      # rubocop:disable Metrics/AbcSize
       def inherited(subclass)
         super
 
@@ -189,8 +189,9 @@ module Mongoid
 
     included do
       class_attribute :discriminator_key, instance_accessor: false
-
       class << self
+        # The class attribute declaration above creates a default getter which we override with our custom method.
+        remove_method :discriminator_key
         delegate :discriminator_key, to: ::Mongoid
         prepend DiscriminatorAssignment
         include DiscriminatorRetrieval
@@ -210,7 +211,7 @@ module Mongoid
       # @api private
       def self.add_discriminator_mapping(value, klass = self)
         self.discriminator_mapping ||= {}
-        self.discriminator_mapping[value] = klass
+        discriminator_mapping[value] = klass
         superclass.add_discriminator_mapping(value, klass) if hereditary?
       end
 
@@ -224,7 +225,7 @@ module Mongoid
       #
       # @api private
       def self.get_discriminator_mapping(value)
-        self.discriminator_mapping[value] if self.discriminator_mapping
+        discriminator_mapping[value] if discriminator_mapping
       end
     end
 

data/lib/mongoid/validatable/associated.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Validates whether or not an association is valid or not. Will correctly
     # handle has one and has many associations.
     #
@@ -69,13 +67,14 @@ module Mongoid
         valid = document.validating do
           # Now, treating the target as an array, look at each element
           # and see if it is valid, but only if it has already been
-          # persisted, or changed, and hasn't been flagged for destroy.
+          # persisted, or changed, and hasn't been flagged for destroy
+          # or already destroyed.
           #
           # use map.all? instead of just all?, because all? will do short-circuit
           # evaluation and terminate on the first failed validation.
           list.map do |value|
-            if value && !value.flagged_for_destroy? && (!value.persisted? || value.changed?)
-              value.validated? ? true : value.valid?
+            if needs_validation?(value)
+              value.validated? || value.valid?
             else
               true
             end
@@ -85,8 +84,6 @@ module Mongoid
         document.errors.add(attribute, :invalid) unless valid
       end
 
-      private
-
       # Examine the given target object and return an array of
       # documents (possibly empty) that the target represents.
       #
@@ -124,6 +121,21 @@ module Mongoid
       def get_target_documents_for_other(target)
         Array.wrap(target)
       end
+
+      # Returns true if the given value should be validated as part of
+      # an associated validation. Destroyed and flagged-for-destroy
+      # documents are skipped, as are persisted documents that haven't
+      # changed.
+      #
+      # @param [ Mongoid::Document | nil ] value The value to check.
+      #
+      # @return [ true | false ] Whether the value needs validation.
+      def needs_validation?(value)
+        value &&
+          !value.flagged_for_destroy? &&
+          !value.destroyed? &&
+          (!value.persisted? || value.changed?)
+      end
     end
   end
 end

data/lib/mongoid/validatable/format.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Validates that the specified attributes do or do not match a certain
     # regular expression.
     #

data/lib/mongoid/validatable/length.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Validates that the specified attributes do or do not match a certain
     # length.
     #

data/lib/mongoid/validatable/localizable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Adds localization support to validations.
     module Localizable
-
       # Validates each for localized fields.
       #
       # @example Validate localized fields.

data/lib/mongoid/validatable/macros.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Mixin module included in Mongoid::Document which adds various
     # validation macro methods, such as +validates_presence_of+ and
     # +validates_uniqueness_of+.

data/lib/mongoid/validatable/numericality.rb

@@ -5,14 +5,35 @@ module Mongoid
     # A specialization of the ActiveModel numericality validator, which adds
     # logic to recognize and accept BSON::Decimal128 as a number.
     class NumericalityValidator < ActiveModel::Validations::NumericalityValidator
+      # Reimplements EachValidator#validate in order to work around Mongoid's
+      # nonstandard type-casting of String values.
+      #
+      # @param [ Document ] record The document to validate.
+      def validate(record)
+        attributes.each do |attribute|
+          value = raw_value_for_validation(record, attribute)
+          next if (value.nil? && options[:allow_nil]) || (value.blank? && options[:allow_blank])
+
+          value = prepare_value_for_validation(value, record, attribute)
+          validate_each(record, attribute, value)
+        end
+      end
+
       private
 
       # Ensure that BSON::Decimal128 is treated as a BigDecimal during the
       # validation step.
-      def prepare_value_for_validation(value, record, attr_name)
-        result = super
+      def prepare_value_for_validation(value, _record, _attr_name)
+        value.is_a?(BSON::Decimal128) ? value.to_big_decimal : value
+      end
+
+      # Fetches the raw value from the record, prior to any typecasting being
+      # applied.
+      def raw_value_for_validation(record, attr)
+        attribute = record.database_field_name(attr)
+        return nil if record.relations.key?(attribute)
 
-        result.is_a?(BSON::Decimal128) ? result.to_big_decimal : result
+        record.read_attribute_before_type_cast(attribute)
       end
     end
   end

data/lib/mongoid/validatable/presence.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Validates that the specified attributes are not blank (as defined by
     # Object#blank?).
     #
@@ -16,7 +14,6 @@ module Mongoid
     #     validates_presence_of :title
     #   end
     class PresenceValidator < ActiveModel::EachValidator
-
       # Validate the document for the attribute and value.
       #
       # @example Validate the document.
@@ -29,18 +26,18 @@ module Mongoid
         field = document.fields[document.database_field_name(attribute)]
         if field.try(:localized?) && !value.blank?
           value.each_pair do |_locale, _value|
+            next unless not_present?(_value)
+
             document.errors.add(
               attribute,
               :blank_in_locale,
-              **options.merge(location: _locale)
-            ) if not_present?(_value)
+              **options, location: _locale
+            )
           end
         elsif document.relations.has_key?(attribute.to_s)
-          if relation_or_fk_missing?(document, attribute, value)
-            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 relation_or_fk_missing?(document, attribute, value)
+        elsif not_present?(value)
+          document.errors.add(attribute, :blank, **options)
         end
       end
 
@@ -60,6 +57,7 @@ module Mongoid
       # @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]
         association.stores_foreign_key? && doc.send(association.foreign_key).blank?
       end

data/lib/mongoid/validatable/queryable.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Mixin module included in Mongoid::Validatable::Uniqueness class
     # when ensures that the persistence context is cleared when
     # executing uniqueness queries.
@@ -12,7 +10,6 @@ module Mongoid
     #
     # @api private
     module Queryable
-
       # Wrap the validation inside the an execution block that alert's the
       # client not to clear its persistence options.
       #