mongoid 8.1.9 → 9.0.0

data/lib/mongoid/changeable.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Mongoid
-
   # Defines behavior for dirty tracking.
   module Changeable
     extend ActiveSupport::Concern
@@ -52,12 +51,10 @@ module Mongoid
     #
     # @return [ Hash<String, Array<Object, Object> ] The changes.
     def changes
-      _changes = {}
-      changed.each do |attr|
+      changed.each_with_object({}) do |attr, changes|
         change = attribute_change(attr)
-        _changes[attr] = change if change
-      end
-      _changes.with_indifferent_access
+        changes[attr] = change if change
+      end.with_indifferent_access
     end
 
     # Call this method after save, so the changes can be properly switched.
@@ -119,15 +116,15 @@ module Mongoid
     def setters
       mods = {}
       changes.each_pair do |name, changes|
-        if changes
-          old, new = changes
-          field = fields[name]
-          key = atomic_attribute_name(name)
-          if field && field.resizable?
-            field.add_atomic_changes(self, name, key, mods, new, old)
-          else
-            mods[key] = new unless atomic_unsets.include?(key)
-          end
+        next unless changes
+
+        old, new = changes
+        field = fields[name]
+        key = atomic_attribute_name(name)
+        if field&.resizable?
+          field.add_atomic_changes(self, name, key, mods, new, old)
+        else
+          mods[key] = new unless atomic_unsets.include?(key)
         end
       end
       mods
@@ -163,24 +160,19 @@ module Mongoid
     #   in an attribute during the save that triggered the callbacks to run.
     #
     # @param [ String ] attr The name of the attribute.
-    # @param **kwargs The optional keyword arguments.
-    #
-    # @option **kwargs [ Object ] :from The object the attribute was changed from.
-    # @option **kwargs [ Object ] :to The object the attribute was changed to.
+    # @param [ Object ] from The object the attribute was changed from (optional).
+    # @param [ Object ] to The object the attribute was changed to (optional).
     #
     # @return [ true | false ] Whether the attribute has changed during the last save.
-    def saved_change_to_attribute?(attr, **kwargs)
+    def saved_change_to_attribute?(attr, from: Utils::PLACEHOLDER, to: Utils::PLACEHOLDER)
       changes = saved_change_to_attribute(attr)
       return false unless changes.is_a?(Array)
-      if kwargs.key?(:from) && kwargs.key?(:to)
-        changes.first == kwargs[:from] && changes.last == kwargs[:to]
-      elsif kwargs.key?(:from)
-        changes.first == kwargs[:from]
-      elsif kwargs.key?(:to)
-        changes.last == kwargs[:to]
-      else
-        true
-      end
+
+      return true if Utils.placeholder?(from) && Utils.placeholder?(to)
+      return changes.first == from if Utils.placeholder?(to)
+      return changes.last == to if Utils.placeholder?(from)
+
+      changes.first == from && changes.last == to
     end
 
     # Returns whether this attribute change the next time we save.
@@ -226,31 +218,48 @@ module Mongoid
     # @return [ Array<Object> ] The old and new values.
     def attribute_change(attr)
       attr = database_field_name(attr)
-      [changed_attributes[attr], attributes[attr]] if attribute_changed?(attr)
+      [ changed_attributes[attr], attributes[attr] ] if attribute_changed?(attr)
+    end
+
+    # A class for representing the default value that an attribute was changed
+    # from or to.
+    #
+    # @api private
+    class Anything
+      # `Anything` objects are always equal to everything. This simplifies
+      # the logic for asking whether an attribute has changed or not. If the
+      # `from` or `to` value is a `Anything` (because it was not
+      # explicitly given), any comparison with it will suggest the value has
+      # not changed.
+      #
+      # @param [ Object ] _other The object being compared with this object.
+      #
+      # @return [ true ] Always returns true.
+      def ==(_other)
+        true
+      end
     end
 
+    # a singleton object to represent an optional `to` or `from` value
+    # that was not explicitly provided to #attribute_changed?
+    ATTRIBUTE_UNCHANGED = Anything.new
+
     # Determine if a specific attribute has changed.
     #
     # @example Has the attribute changed?
     #   model.attribute_changed?("name")
     #
     # @param [ String ] attr The name of the attribute.
-    # @param **kwargs The optional keyword arguments.
-    #
-    # @option **kwargs [ Object ] :from The object the attribute was changed from.
-    # @option **kwargs [ Object ] :to The object the attribute was changed to.
+    # @param [ Object ] from The object the attribute was changed from (optional).
+    # @param [ Object ] to The object the attribute was changed to (optional).
     #
     # @return [ true | false ] Whether the attribute has changed.
-    def attribute_changed?(attr, **kwargs)
+    def attribute_changed?(attr, from: ATTRIBUTE_UNCHANGED, to: ATTRIBUTE_UNCHANGED)
       attr = database_field_name(attr)
       return false unless changed_attributes.key?(attr)
       return false if changed_attributes[attr] == attributes[attr]
-      if kwargs.key?(:from)
-        return false if changed_attributes[attr] != kwargs[:from]
-      end
-      if kwargs.key?(:to)
-        return false if attributes[attr] != kwargs[:to]
-      end
+      return false if from != changed_attributes[attr]
+      return false if to != attributes[attr]
 
       true
     end
@@ -264,8 +273,8 @@ module Mongoid
     #
     # @return [ true | false ] If the attribute differs.
     def attribute_changed_from_default?(attr)
-      field = fields[attr]
-      return false unless field
+      return false unless (field = fields[attr])
+
       attributes[attr] != field.eval_default(self)
     end
 
@@ -308,9 +317,9 @@ module Mongoid
     #
     # @return [ Object ] The old value.
     def attribute_will_change!(attr)
-      unless changed_attributes.key?(attr)
-        changed_attributes[attr] = read_raw_attribute(attr).__deep_copy__
-      end
+      return if changed_attributes.key?(attr)
+
+      changed_attributes[attr] = read_raw_attribute(attr).__deep_copy__
     end
 
     # Set the attribute back to its old value.
@@ -328,7 +337,7 @@ module Mongoid
 
     def reset_attribute_to_default!(attr)
       attr = database_field_name(attr)
-      if field = fields[attr]
+      if (field = fields[attr])
         __send__("#{attr}=", field.eval_default(self))
       else
         __send__("#{attr}=", nil)
@@ -339,8 +348,8 @@ module Mongoid
       @attributes_before_type_cast = @attributes.dup
     end
 
+    # Class-level methods for changeable objects.
     module ClassMethods
-
       private
 
       # Generate all the dirty methods needed for the attribute.
@@ -494,7 +503,7 @@ module Mongoid
       def create_dirty_previously_changed?(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_previously_changed?") do
-            previous_changes.keys.include?(name)
+            previous_changes.key?(name)
           end
         end
       end

data/lib/mongoid/clients/factory.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Clients
+
+    # Factory used to create database clients.
     module Factory
       extend self
       extend Loggable
@@ -55,9 +58,12 @@ module Mongoid
         raise Errors::NoClientsConfig.new unless configuration
         config = configuration.dup
         uri = config.delete(:uri)
-        database = config.delete(:database)
+        database = config.delete(:database) || Mongo::URI.get(uri).database
         hosts = config.delete(:hosts)
         opts = config.delete(:options) || {}
+        if opts.key?(:auto_encryption_options)
+          opts[:auto_encryption_options] = build_auto_encryption_options(opts, database)
+        end
         unless config.empty?
           default_logger.warn("Unknown config options detected: #{config}.")
         end
@@ -71,6 +77,36 @@ module Mongoid
         end
       end
 
+      # Build auto encryption options for the client based on the options
+      # provided in the Mongoid client configuration and the encryption
+      # schema map for the database.
+      #
+      # @param [ Hash ] opts Options from the Mongoid client configuration.
+      # @param [ String ] database Database name to use for encryption schema map.
+      #
+      # @return [ Hash | nil ] Auto encryption options for the client.
+      #
+      # @api private
+      def build_auto_encryption_options(opts, database)
+        return nil unless opts[:auto_encryption_options]
+
+        opts[:auto_encryption_options].dup.tap do |auto_encryption_options|
+          if auto_encryption_options.key?(:schema_map)
+            default_logger.warn(
+              'The :schema_map is configured in the :auto_encryption_options for the client;' +
+              ' encryption setting in Mongoid documents will be ignored.'
+            )
+          else
+            auto_encryption_options[:schema_map] = Mongoid.config.encryption_schema_map(database)
+          end
+          if auto_encryption_options.key?(:key_vault_client)
+            auto_encryption_options[:key_vault_client] = Mongoid.client(
+              auto_encryption_options[:key_vault_client]
+            )
+          end
+        end
+      end
+
       MONGOID_WRAPPING_LIBRARY = {
         name: 'Mongoid',
         version: VERSION,

data/lib/mongoid/clients/options.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Clients
+
+    # Mixin module included into Mongoid::Document which gives
+    # the ability to manage the database context for persistence
+    # and query operations. For example, this includes saving
+    # documents to different collections, and reading documents
+    # from secondary instances.
     module Options
       extend ActiveSupport::Concern
 
@@ -27,26 +34,80 @@ module Mongoid
         clear_persistence_context(original_cluster, original_context)
       end
 
+      # Get the collection for the document's current persistence context.
+      #
+      # @example Get the collection for the current persistence context.
+      #   document.collection
+      #
+      # @param [ Object ] parent The parent object whose collection name is used
+      #   instead of the current persistence context's collection name.
+      #
+      # @return [ Mongo::Collection ] The collection for the current persistence
+      #   context.
       def collection(parent = nil)
         persistence_context.collection(parent)
       end
 
+      # Get the collection name for the document's current persistence context.
+      #
+      # @example Get the collection name for the current persistence context.
+      #   document.collection_name
+      #
+      # @return [ String ] The collection name for the current persistence
+      #   context.
       def collection_name
         persistence_context.collection_name
       end
 
+      # Get the database client for the document's current persistence context.
+      #
+      # @example Get the client for the current persistence context.
+      #   document.mongo_client
+      #
+      # @return [ Mongo::Client ] The client for the current persistence
+      #   context.
       def mongo_client
         persistence_context.client
       end
 
+      # Get the document's current persistence context.
+      #
+      # @note For embedded documents, the persistence context of the
+      #   root parent document is returned.
+      #
+      # @example Get the current persistence context.
+      #   document.persistence_context
+      #
+      # @return [ Mongoid::PersistenceContext ] The current persistence
+      #   context.
       def persistence_context
-        PersistenceContext.get(self) ||
+        if embedded? && !_root?
+          _root.persistence_context
+        else
+          PersistenceContext.get(self) ||
             PersistenceContext.get(self.class) ||
-            PersistenceContext.new(self.class)
+            PersistenceContext.new(self.class, storage_options)
+        end
       end
 
+      # Returns whether a persistence context is set for the document
+      # or the document's class.
+      #
+      # @note For embedded documents, the persistence context of the
+      #   root parent document is used.
+      #
+      # @example Get the current persistence context.
+      #   document.persistence_context?
+      #
+      # @return [ true | false ] Whether a persistence context is set.
       def persistence_context?
-        !!(PersistenceContext.get(self) || PersistenceContext.get(self.class))
+        if embedded? && !_root?
+          _root.persistence_context?
+        else
+          remembered_storage_options&.any? ||
+            PersistenceContext.get(self).present? ||
+            PersistenceContext.get(self.class).present?
+        end
       end
 
       private
@@ -61,22 +122,62 @@ module Mongoid
 
       module ClassMethods
 
+        # Get the database client name for the current persistence context
+        # of the document class.
+        #
+        # @example Get the client name for the current persistence context.
+        #   Model.client_name
+        #
+        # @return [ String ] The database client name for the current
+        #   persistence context.
         def client_name
           persistence_context.client_name
         end
 
+        # Get the collection name for the current persistence context of the
+        # document class.
+        #
+        # @example Get the collection name for the current persistence context.
+        #   Model.collection_name
+        #
+        # @return [ String ] The collection name for the current persistence
+        #   context.
         def collection_name
           persistence_context.collection_name
         end
 
+        # Get the database name for the current persistence context of the
+        # document class.
+        #
+        # @example Get the database name for the current persistence context.
+        #   Model.database_name
+        #
+        # @return [ String ] The database name for the current persistence
+        #   context.
         def database_name
           persistence_context.database_name
         end
 
+        # Get the collection for the current persistence context of the
+        # document class.
+        #
+        # @example Get the collection for the current persistence context.
+        #   Model.collection
+        #
+        # @return [ Mongo::Collection ] The collection for the current
+        #   persistence context.
         def collection
           persistence_context.collection
         end
 
+        # Get the client for the current persistence context of the
+        # document class.
+        #
+        # @example Get the client for the current persistence context.
+        #   Model.mongo_client
+        #
+        # @return [ Mongo::Client ] The client for the current persistence
+        #   context.
         def mongo_client
           persistence_context.client
         end
@@ -102,6 +203,15 @@ module Mongoid
           PersistenceContext.clear(self, original_cluster, original_context)
         end
 
+        # Get the current persistence context of the document class.
+        # If a persistence context is not set, a new one will be
+        # initialized and returned.
+        #
+        # @example Get the current persistence context.
+        #   Model.persistence_context
+        #
+        # @return [ Mongoid::PersistenceContent ] The current persistence
+        #   context.
         def persistence_context
           PersistenceContext.get(self) || PersistenceContext.new(self)
         end