mongoid 9.0.11 → 9.1.0

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

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.
     #
@@ -75,7 +73,7 @@ module Mongoid
           # 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?
+              value.validated? || value.valid?
             else
               true
             end
@@ -85,8 +83,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.
       #

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.
       #

data/lib/mongoid/validatable/uniqueness.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Validatable
-
     # Validates whether or not a field is unique against the documents in the
     # database.
     #
@@ -42,6 +40,7 @@ module Mongoid
         with_query(document) do
           attrib, val = to_validate(document, attribute, value)
           return unless validation_required?(document, attrib)
+
           if document.embedded?
             validate_embedded(document, attrib, val)
           else
@@ -64,7 +63,7 @@ module Mongoid
       # @param [ Object ] value The value of the object.
       def add_error(document, attribute, value)
         document.errors.add(
-          attribute, :taken, **options.except(:case_sensitive, :scope).merge(value: value)
+          attribute, :taken, **options.except(:case_sensitive, :scope), value: value
         )
       end
 
@@ -129,15 +128,13 @@ module Mongoid
         field = document.database_field_name(attribute)
 
         if value && localized?(document, field)
-          conditions = (value || {}).inject([]) { |acc, (k,v)| acc << { "#{field}.#{k}" => filter(v) }}
-          selector = { "$or" => conditions }
+          conditions = (value || {}).inject([]) { |acc, (k, v)| acc << { "#{field}.#{k}" => filter(v) } }
+          selector = { '$or' => conditions }
         else
           selector = { field => filter(value) }
         end
 
-        if document.persisted? && !document.embedded?
-          selector.merge!(_id: { "$ne" => document._id })
-        end
+        selector.merge!(_id: { '$ne' => document._id }) if document.persisted? && !document.embedded?
         selector
       end
 
@@ -152,7 +149,7 @@ module Mongoid
       #
       # @return [ Object | Regexp ] The value, filtered or not.
       def filter(value)
-        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}\z/i : value
+        (!case_sensitive? && value) ? /\A#{Regexp.escape(value.to_s)}\z/i : value
       end
 
       # Scope the criteria to the scope options provided.
@@ -200,7 +197,7 @@ module Mongoid
       # @return [ true | false ] If the scope reference has changed.
       def scope_value_changed?(document)
         Array.wrap(options[:scope]).any? do |item|
-          document.send("attribute_changed?", item.to_s)
+          document.send(:attribute_changed?, item.to_s)
         end
       end
 
@@ -240,6 +237,7 @@ module Mongoid
       # @param [ Object ] value The value.
       def validate_embedded(document, attribute, value)
         return if skip_validation?(document)
+
         relation = document._parent.send(document.association_name)
         criteria = create_criteria(relation, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
@@ -266,9 +264,9 @@ module Mongoid
         criteria = create_criteria(klass, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
 
-        if criteria.read(mode: :primary).exists?
-          add_error(document, attribute, value)
-        end
+        return unless criteria.read(mode: :primary).exists?
+
+        add_error(document, attribute, value)
       end
 
       # Are we required to validate the document?
@@ -282,7 +280,7 @@ module Mongoid
       # @return [ true | false ] If we need to validate.
       def validation_required?(document, attribute)
         document.new_record? ||
-          document.send("attribute_changed?", attribute.to_s) ||
+          document.send(:attribute_changed?, attribute.to_s) ||
           scope_value_changed?(document)
       end
 

data/lib/mongoid/validatable.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/validatable/macros"
-require "mongoid/validatable/localizable"
-require "mongoid/validatable/associated"
-require "mongoid/validatable/format"
-require "mongoid/validatable/length"
-require "mongoid/validatable/numericality"
-require "mongoid/validatable/queryable"
-require "mongoid/validatable/presence"
-require "mongoid/validatable/uniqueness"
+require 'mongoid/validatable/macros'
+require 'mongoid/validatable/localizable'
+require 'mongoid/validatable/associated'
+require 'mongoid/validatable/format'
+require 'mongoid/validatable/length'
+require 'mongoid/validatable/numericality'
+require 'mongoid/validatable/queryable'
+require 'mongoid/validatable/presence'
+require 'mongoid/validatable/uniqueness'
 
 module Mongoid
-
   # This module provides additional validations that ActiveModel does not
   # provide: validates_associated and validates_uniqueness_of.
   module Validatable
@@ -58,7 +56,7 @@ module Mongoid
     #
     # @return [ true | false ] If we are validating.
     def performing_validations?(options = {})
-      options[:validate].nil? ? true : options[:validate]
+      options[:validate].nil? || options[:validate]
     end
 
     # Overrides the default ActiveModel behavior since we need to handle
@@ -97,7 +95,7 @@ module Mongoid
     #
     # @return [ true | false ] True if valid, false if not.
     def valid?(context = nil)
-      super context ? context : (new_record? ? :create : :update)
+      super(context || (new_record? ? :create : :update))
     end
 
     # Used to prevent infinite loops in associated validations.
@@ -121,7 +119,6 @@ module Mongoid
     end
 
     module ClassMethods
-
       # Adds an associated validator for the association if the validate option
       # was not provided or set to true.
       #
@@ -130,9 +127,9 @@ module Mongoid
       #
       # @param [ Mongoid::Association::Relatable ] association The association metadata.
       def validates_relation(association)
-        if association.validate?
-          validates_associated(association.name)
-        end
+        return unless association.validate?
+
+        validates_associated(association.name)
       end
 
       # Add validation with the supplied validators for the provided fields
@@ -151,9 +148,7 @@ module Mongoid
         if args.first == PresenceValidator
           args.last[:attributes].each do |name|
             association = relations[name.to_s]
-            if association && association.autosave?
-              Association::Referenced::AutoSave.define_autosave!(association)
-            end
+            Association::Referenced::AutoSave.define_autosave!(association) if association && association.autosave?
           end
         end
         super

data/lib/mongoid/version.rb

@@ -5,5 +5,5 @@ module Mongoid
   #
   # Note that this file is automatically updated via `rake candidate:create`.
   # Manual changes to this file will be overwritten by that rake task.
-  VERSION = '9.0.11'
+  VERSION = '9.1.0'
 end

data/lib/mongoid/warnings.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Encapsulates behavior around logging and caching warnings so they are only
   # logged once.
   #
   # @api private
   module Warnings
-
     class << self
-
       # Define a warning message method for the given id.
       #
       # @param [ Symbol ] id The warning identifier.
@@ -20,19 +16,22 @@ module Mongoid
       def warning(id, message)
         singleton_class.class_eval do
           define_method("warn_#{id}") do
-            unless instance_variable_get("@#{id}")
-              Mongoid.logger.warn(message)
-              instance_variable_set("@#{id}", true)
-            end
+            return if instance_variable_get("@#{id}")
+
+            Mongoid.logger.warn(message)
+            instance_variable_set("@#{id}", true)
           end
         end
       end
     end
 
     warning :geo_haystack_deprecated, 'The geoHaystack type is deprecated.'
-    warning :symbol_type_deprecated, 'The BSON Symbol type is deprecated by MongoDB. Please use String or StringifiedSymbol field types instead of the Symbol field type.'
-    warning :legacy_readonly, 'The readonly! method will only mark the document readonly when the legacy_readonly feature flag is switched off.'
-    warning :mutable_ids, 'Ignoring updates to immutable attribute `_id`. Please set Mongoid::Config.immutable_ids to true and update your code so that `_id` is never updated.'
+    warning :symbol_type_deprecated,
+            'The BSON Symbol type is deprecated by MongoDB. Please use String or StringifiedSymbol field types instead of the Symbol field type.'
+    warning :legacy_readonly,
+            'The readonly! method will only mark the document readonly when the legacy_readonly feature flag is switched off.'
+    warning :mutable_ids,
+            'Ignoring updates to immutable attribute `_id`. Please set Mongoid::Config.immutable_ids to true and update your code so that `_id` is never updated.'
     warning :reparenting_via_nested_attributes, 'Reparenting documents via nested attributes is insecure and is deprecated. Set Mongoid.allow_reparenting_via_nested_attributes to false and update your code to avoid reparenting documents via nested attributes.'
     warning :autosave_saves_unchanged_documents, "Autosave associations are currently configured to save documents even if they haven't changed. " \
                                                  'This legacy behavior is deprecated. Set Mongoid.autosave_saves_unchanged_documents to false to ' \

data/lib/mongoid.rb

@@ -1,43 +1,40 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "forwardable"
-require "time"
-require "set"
+require 'forwardable'
+require 'time'
+require 'set'
 
-require "active_support"
-require "active_support/core_ext"
-require "active_support/json"
-require "active_support/inflector"
-require "active_support/time_with_zone"
-require "active_model"
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/json'
+require 'active_support/inflector'
+require 'active_support/time_with_zone'
+require 'active_model'
 
 require 'concurrent-ruby'
 
-require "mongo"
-require "mongo/active_support"
-
-require "mongoid/version"
-require "mongoid/deprecable"
-require "mongoid/config"
-require "mongoid/persistence_context"
-require "mongoid/loadable"
-require "mongoid/loggable"
-require "mongoid/clients"
-require "mongoid/document"
-require "mongoid/tasks/database"
-require "mongoid/tasks/encryption"
-require "mongoid/warnings"
-require "mongoid/utils"
+require 'mongo'
+require 'mongo/active_support'
+
+require 'mongoid/version'
+require 'mongoid/deprecable'
+require 'mongoid/config'
+require 'mongoid/persistence_context'
+require 'mongoid/loadable'
+require 'mongoid/loggable'
+require 'mongoid/clients'
+require 'mongoid/document'
+require 'mongoid/tasks/database'
+require 'mongoid/tasks/encryption'
+require 'mongoid/warnings'
+require 'mongoid/utils'
 
 # If we are using Rails then we will include the Mongoid railtie.
 # This configures initializers required to integrate Mongoid with Rails.
-if defined?(Rails)
-  require "mongoid/railtie"
-end
+require 'mongoid/railtie' if defined?(Rails)
 
 # Add English locale config to load path by default.
-I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
+I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
 
 # Top-level module for project.
 module Mongoid
@@ -48,10 +45,10 @@ module Mongoid
   extend Clients::Sessions::ClassMethods
 
   # A string added to the platform details of Ruby driver client handshake documents.
-  PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
+  PLATFORM_DETAILS = "mongoid-#{VERSION}"
 
   # The minimum MongoDB version supported.
-  MONGODB_VERSION = "2.6.0"
+  MONGODB_VERSION = '2.6.0'
 
   # Sets the Mongoid configuration options. Best used by passing a block.
   #
@@ -77,7 +74,7 @@ module Mongoid
   def configure(&block)
     return Config unless block_given?
 
-    block.arity == 0 ? Config.instance_exec(&block) : yield(Config)
+    (block.arity == 0) ? Config.instance_exec(&block) : yield(Config)
   end
 
   # Convenience method for getting the default client.
@@ -125,7 +122,7 @@ module Mongoid
   #
   # @example Delegate the configuration methods.
   #   Mongoid.database = Mongo::Connection.new.db("test")
-  def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
+  def_delegators Config, *(Config.public_instance_methods(false) - %i[logger= logger])
 
   # Define persistence context that is used when a transaction method is called
   # on Mongoid module.
@@ -148,7 +145,6 @@ module Mongoid
   #
   # @api private
   module GlobalDiscriminatorKeyAssignment
-
     # This class is used for obtaining the method definition location for
     # Mongoid methods.
     class InvalidFieldHost

data/lib/rails/generators/mongoid/config/config_generator.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'rails/generators/mongoid_generator'
 
 module Mongoid
   module Generators
-
     # Generator class for Mongoid configuration files.
     class ConfigGenerator < Rails::Generators::Base
-      desc "Creates Mongoid configuration files"
+      desc 'Creates Mongoid configuration files'
 
       argument :database_name, type: :string, optional: true
 
@@ -16,7 +14,7 @@ module Mongoid
       #
       # @return [ String ] The path.
       def self.source_root
-        @_mongoid_source_root ||= File.expand_path("../templates", __FILE__)
+        @_mongoid_source_root ||= File.expand_path('templates', __dir__)
       end
 
       # Returns the underscored name of the Rails application.