mongoid 9.0.12 → 9.1.0

data/lib/mongoid/composable.rb

@@ -1,30 +1,28 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/changeable"
-require "mongoid/collection_configurable"
-require "mongoid/encryptable"
-require "mongoid/findable"
+require 'mongoid/changeable'
+require 'mongoid/collection_configurable'
+require 'mongoid/encryptable'
+require 'mongoid/findable'
 require 'mongoid/identifiable'
-require "mongoid/indexable"
-require "mongoid/inspectable"
-require "mongoid/interceptable"
-require "mongoid/matcher"
-require "mongoid/matchable"
-require "mongoid/persistable"
-require "mongoid/reloadable"
+require 'mongoid/indexable'
+require 'mongoid/inspectable'
+require 'mongoid/interceptable'
+require 'mongoid/matcher'
+require 'mongoid/matchable'
+require 'mongoid/persistable'
+require 'mongoid/reloadable'
 require 'mongoid/search_indexable'
-require "mongoid/selectable"
-require "mongoid/scopable"
-require "mongoid/serializable"
-require "mongoid/shardable"
-require "mongoid/stateful"
-require "mongoid/cacheable"
-require "mongoid/traversable"
-require "mongoid/validatable"
+require 'mongoid/selectable'
+require 'mongoid/scopable'
+require 'mongoid/serializable'
+require 'mongoid/shardable'
+require 'mongoid/stateful'
+require 'mongoid/cacheable'
+require 'mongoid/traversable'
+require 'mongoid/validatable'
 
 module Mongoid
-
   # This module provides inclusions of all behavior in a Mongoid document.
   module Composable
     extend ActiveSupport::Concern
@@ -105,21 +103,19 @@ module Mongoid
     # separately.
     #
     # @return [ Array<Symbol> ] A list of reserved method names.
-    RESERVED_METHOD_NAMES = [ :fields,
-                              :aliased_fields,
-                              :localized_fields,
-                              :index_specifications,
-                              :shard_key_fields,
-                              :nested_attributes,
-                              :readonly_attributes,
-                              :storage_options,
-                              :cascades,
-                              :cyclic,
-                              :cache_timestamp_format
-                            ]
+    RESERVED_METHOD_NAMES = %i[fields
+                               aliased_fields
+                               localized_fields
+                               index_specifications
+                               shard_key_fields
+                               nested_attributes
+                               readonly_attributes
+                               storage_options
+                               cascades
+                               cyclic
+                               cache_timestamp_format]
 
     class << self
-
       # Get a list of methods that would be a bad idea to define as field names
       # or override when including Mongoid::Document.
       #

data/lib/mongoid/config/defaults.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
-
     # Encapsulates logic for loading defaults.
     module Defaults
-
       # Load the defaults for the feature flags in the given Mongoid version.
       # Note that this method will load the *new* functionality introduced in
       # the given Mongoid version.
@@ -33,7 +30,13 @@ module Mongoid
           load_defaults '9.0'
 
         when '9.0'
-          # All flag defaults currently reflect 9.0 behavior.
+          self.allow_reparenting_via_nested_attributes = true
+          self.autosave_saves_unchanged_documents = true
+
+          load_defaults '9.1'
+
+        when '9.1'
+          # All flag defaults currently reflect 9.1 behavior.
 
         else
           raise ArgumentError, "Unknown version: #{version}"

data/lib/mongoid/config/encryption.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/extensions/boolean'
 require 'mongoid/stringified_symbol'
@@ -21,25 +20,18 @@ module Mongoid
       #
       # @return [ Hash ] The encryption schema map.
       def encryption_schema_map(default_database, models = ::Mongoid.models)
+        visited = Set.new
         models.each_with_object({}) do |model, map|
+          next if visited.include?(model)
+
+          visited << model
           next if model.embedded?
-          next unless model.requires_encryption_schema?
+          next unless model.encrypted?
 
           database = model.storage_options.fetch(:database) { default_database }
-          # A callable database name cannot be resolved here: the documented
-          # multi-tenant idiom has no correct value while the client is being
-          # built. Interpolating the callable would produce a key that never
-          # matches any namespace, so leave the model out of the map. Writes
-          # are refused later, by PersistenceContext, rather than silently
-          # going out unencrypted.
-          next if database.respond_to?(:call)
-
           key = "#{database}.#{model.collection_name}"
-          props = metadata_for(model).merge(properties_for(model, [ model ]))
-          # The root of a collection schema describes the document, so it is
-          # always an object. Saying so matters when a nested schema carries
-          # encryptMetadata: mongocryptd rejects the schema otherwise.
-          map[key] = { 'bsonType' => 'object' }.merge(props) unless props.empty?
+          props = metadata_for(model).merge(properties_for(model, visited))
+          map[key] = props unless props.empty?
         end
       end
 
@@ -108,12 +100,11 @@ module Mongoid
       # are marked as encrypted.
       #
       # @param [ Mongoid::Document ] model The model to generate the properties for.
-      # @param [ Array<Mongoid::Document> ] path The models the walk is already
-      #   inside of, outermost first.
+      # @param [ Set<Mongoid::Document> ] visited The set of models that have already been visited.
       #
       # @return [ Hash ] The encryption properties.
-      def properties_for(model, path)
-        result = properties_for_fields(model).merge(properties_for_relations(model, path))
+      def properties_for(model, visited)
+        result = properties_for_fields(model).merge(properties_for_relations(model, visited))
         if result.empty?
           {}
         else
@@ -150,29 +141,20 @@ module Mongoid
       # are configured to be encrypted.
       #
       # @param [ Mongoid::Document ] model The model to generate the properties for.
-      # @param [ Array<Mongoid::Document> ] path The models the walk is already
-      #   inside of, outermost first.
+      # @param [ Set<Mongoid::Document> ] visited The set of models that have already been visited.
       #
       # @return [ Hash ] The encryption properties.
-      def properties_for_relations(model, path)
+      def properties_for_relations(model, visited)
         model.relations.each_with_object({}) do |(name, relation), props|
-          # relation_class constantizes, and a polymorphic embedded_in has no
-          # class to resolve, so the relation type has to be checked first.
+          next if visited.include?(relation.relation_class)
           next unless relation.is_a?(Association::Embedded::EmbedsOne)
+          next unless relation.relation_class.encrypted?
 
-          klass = relation.try_relation_class
-          # An association target does not have to be a Mongoid document, and
-          # the class it names does not have to exist.
-          next unless klass.respond_to?(:requires_encryption_schema?)
-          # Stop at a model the walk is already inside of, or a self-embedding
-          # model never terminates. The path covers the current branch only:
-          # a model embedded by two parents, or twice by one parent, has to be
-          # emitted at every place it appears.
-          next if path.include?(klass)
-          next unless klass.requires_encryption_schema?
-
-          metadata_for(klass).merge(
-            properties_for(klass, path + [ klass ])
+          visited << relation.relation_class
+          metadata_for(
+            relation.relation_class
+          ).merge(
+            properties_for(relation.relation_class, visited)
           ).tap do |properties|
             props[name] = { 'bsonType' => 'object' }.merge(properties) unless properties.empty?
           end
@@ -200,8 +182,6 @@ module Mongoid
           DETERMINISTIC_ALGORITHM
         when false
           RANDOM_ALGORITHM
-        else
-          nil
         end
       end
 

data/lib/mongoid/config/environment.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
-
     # Encapsulates logic for getting environment information.
     module Environment
       extend self
@@ -25,13 +23,10 @@ module Mongoid
       # @return [ String ] The name of the current environment.
       # @api public
       def env_name
-        if defined?(::Rails)
-          return ::Rails.env
-        end
-        if defined?(::Sinatra)
-          return ::Sinatra::Base.environment.to_s
-        end
-        ENV["RACK_ENV"] || ENV["MONGOID_ENV"] or raise Errors::NoEnvironment
+        return ::Rails.env if defined?(::Rails)
+        return ::Sinatra::Base.environment.to_s if defined?(::Sinatra)
+
+        ENV['RACK_ENV'] || ENV['MONGOID_ENV'] or raise Errors::NoEnvironment
       end
 
       # Load the yaml from the provided path and return the settings for the
@@ -51,9 +46,7 @@ module Mongoid
         env = environment ? environment.to_s : env_name
 
         contents = File.read(path)
-        if contents.empty?
-          raise Mongoid::Errors::EmptyConfigFile.new(path)
-        end
+        raise Mongoid::Errors::EmptyConfigFile.new(path) if contents.empty?
 
         # These are the classes that can be used in a Mongoid
         # configuration file in addition to standard YAML types.
@@ -62,15 +55,13 @@ module Mongoid
           Symbol,
           # BSON::Binary occur as keyId values for FLE (more precisely,
           # the keyIds are UUIDs).
-          BSON::Binary,
+          BSON::Binary
         ]
 
         result = ERB.new(contents).result
         data = YAML.safe_load(result, permitted_classes: permitted_classes, aliases: true)
 
-        unless data.is_a?(Hash)
-          raise Mongoid::Errors::InvalidConfigFile.new(path)
-        end
+        raise Mongoid::Errors::InvalidConfigFile.new(path) unless data.is_a?(Hash)
 
         data[env]
       end

data/lib/mongoid/config/introspection.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
-
     # This module provides a way to inspect not only the defined configuration
     # settings and their defaults (which are available via
     # `Mongoid::Config.settings`), but also the documentation about them. It
@@ -69,7 +67,7 @@ module Mongoid
         #
         # @return [ String ] the reformatted comment
         def indented_comment(indent: 2, indent_first_line: false)
-          comment.gsub(/^/, " " * indent).tap do |result|
+          comment.gsub(/^/, ' ' * indent).tap do |result|
             result.strip! unless indent_first_line
           end
         end
@@ -79,17 +77,17 @@ module Mongoid
         #
         # @return [ true | false ] whether the option is deprecated or not.
         def deprecated?
-          comment.include?("(Deprecated)")
+          comment.include?('(Deprecated)')
         end
 
         # Compare self with the given option.
         #
         # @return [ true | false ] If name, default, and comment are all the
         #   same, return true. Otherwise, false.
-        def ==(option)
-          name == option.name &&
-            default == option.default &&
-            comment == option.comment
+        def ==(other)
+          name == other.name &&
+            default == other.default &&
+            comment == other.comment
         end
 
         private
@@ -101,7 +99,7 @@ module Mongoid
         #
         # @return [ String ] the unindented text.
         def unindent(text)
-          text.strip.gsub(/^\s+/, "")
+          text.strip.gsub(/^\s+/, '')
         end
       end
 
@@ -117,7 +115,7 @@ module Mongoid
       #   1: the (potentially multiline) comment
       #   2: the option's name
       #   3: the option's default value
-      OPTION_PATTERN = %r{
+      OPTION_PATTERN = /
         (
           ((?:^\s*\#.*\n)+)  # match one or more lines of comments
           ^\s+option\s+      # followed immediately by a line declaring an option
@@ -125,11 +123,12 @@ module Mongoid
           default:\s+(.*?)   # match the default value for the option
           (?:,.*?)?          # skip any other configuration
         \n)                  # end with a newline
-      }x
+      /x
 
       # The full path to the source file of the Mongoid::Config module.
       CONFIG_RB_PATH = File.absolute_path(File.join(
-        File.dirname(__FILE__), "../config.rb"))
+                                            File.dirname(__FILE__), '../config.rb'
+                                          ))
 
       # Extracts the available configuration options from the Mongoid::Config
       # source file, and returns them as an array of hashes.
@@ -142,11 +141,10 @@ module Mongoid
       def options(include_deprecated: false)
         src = File.read(CONFIG_RB_PATH)
         src.scan(OPTION_PATTERN)
-          .map { |opt| Option.from_captures(opt) }
-          .reject { |opt| !include_deprecated && opt.deprecated? }
-          .sort_by { |opt| opt.name }
+           .map { |opt| Option.from_captures(opt) }
+           .reject { |opt| !include_deprecated && opt.deprecated? }
+           .sort_by { |opt| opt.name }
       end
     end
-
   end
 end

data/lib/mongoid/config/options.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
-
     # Encapsulates logic for setting options.
     module Options
-
       # Get the defaults or initialize a new empty hash.
       #
       # @example Get the defaults.
@@ -40,8 +37,17 @@ module Mongoid
           end
 
           define_method("#{name}=") do |value|
+            old_value = settings[name]
             settings[name] = value
-            options[:on_change]&.call(value)
+
+            begin
+              options[:on_change]&.call(value)
+            rescue StandardError
+              # If the on_change callback raises an error, we need to roll
+              # the change back.
+              settings[name] = old_value
+              raise
+            end
           end
 
           define_method("#{name}?") do
@@ -81,13 +87,13 @@ module Mongoid
       #
       # @return [ Integer ] The log level.
       def log_level
-        if level = settings[:log_level]
-          unless level.is_a?(Integer)
-            # JRuby String#constantize does not work here.
-            level = Logger.const_get(level.upcase.to_s)
-          end
-          level
+        return unless level = settings[:log_level]
+
+        unless level.is_a?(Integer)
+          # JRuby String#constantize does not work here.
+          level = Logger.const_get(level.upcase.to_s)
         end
+        level
       end
     end
   end

data/lib/mongoid/config/validators/async_query_executor.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validates the async query executor options in the Mongoid
       # configuration. Used during application bootstrapping.
       #
@@ -22,10 +20,9 @@ module Mongoid
         #
         # @api private
         def validate(options)
-          if options.key?(:async_query_executor)
-            if options[:async_query_executor].to_sym == :immediate && !options[:global_executor_concurrency].nil?
-              raise Errors::InvalidGlobalExecutorConcurrency
-            end
+          return unless options.key?(:async_query_executor)
+          if options[:async_query_executor].to_sym == :immediate && !options[:global_executor_concurrency].nil?
+            raise Errors::InvalidGlobalExecutorConcurrency
           end
         end
       end

data/lib/mongoid/config/validators/client.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validator for client specific configuration.
       module Client
         extend self
 
         # Standard configuration options.
-        STANDARD = [ :database, :hosts, :username, :password ].freeze
+        STANDARD = %i[database hosts username password].freeze
 
         # Validate the client configuration.
         #
@@ -19,9 +17,8 @@ module Mongoid
         #
         # @param [ Hash ] clients The clients config.
         def validate(clients)
-          unless clients.has_key?(:default)
-            raise Errors::NoDefaultClient.new(clients.keys)
-          end
+          raise Errors::NoDefaultClient.new(clients.keys) unless clients.has_key?(:default)
+
           clients.each_pair do |name, config|
             validate_client_database(name, config)
             validate_client_hosts(name, config)
@@ -41,9 +38,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_database(name, config)
-          if no_database_or_uri?(config)
-            raise Errors::NoClientDatabase.new(name, config)
-          end
+          return unless no_database_or_uri?(config)
+
+          raise Errors::NoClientDatabase.new(name, config)
         end
 
         # Validate that the client config has hosts.
@@ -56,9 +53,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_hosts(name, config)
-          if no_hosts_or_uri?(config)
-            raise Errors::NoClientHosts.new(name, config)
-          end
+          return unless no_hosts_or_uri?(config)
+
+          raise Errors::NoClientHosts.new(name, config)
         end
 
         # Validate that not both a uri and standard options are provided for a
@@ -72,9 +69,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_uri(name, config)
-          if both_uri_and_standard?(config)
-            raise Errors::MixedClientConfiguration.new(name, config)
-          end
+          return unless both_uri_and_standard?(config)
+
+          raise Errors::MixedClientConfiguration.new(name, config)
         end
 
         # Return true if the configuration has no database or uri option

data/lib/mongoid/config/validators/option.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validator for configuration options.
       module Option
         extend self
@@ -15,9 +13,9 @@ module Mongoid
         #
         # @param [ String ] option The name of the option.
         def validate(option)
-          unless Config.settings.keys.include?(option.to_sym)
-            raise Errors::InvalidConfigOption.new(option)
-          end
+          return if Config.settings.keys.include?(option.to_sym)
+
+          raise Errors::InvalidConfigOption.new(option)
         end
       end
     end

data/lib/mongoid/config/validators.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/config/validators/async_query_executor"
-require "mongoid/config/validators/option"
-require "mongoid/config/validators/client"
+require 'mongoid/config/validators/async_query_executor'
+require 'mongoid/config/validators/option'
+require 'mongoid/config/validators/client'