mongoid 6.4.8 → 7.5.4

data/lib/mongoid/clients/factory.rb

@@ -1,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Mongoid
   module Clients
     module Factory
       extend self
+      extend Loggable
 
       # Create a new client given the named configuration. If no name is
       # provided, return a new client with the default configuration. If a
@@ -11,15 +12,13 @@ module Mongoid
       # raised.
       #
       # @example Create the client.
-      #   Factory.create(:secondary)
+      #   Factory.create(:analytics)
       #
-      # @param [ String, Symbol ] name The named client configuration.
+      # @param [ String | Symbol ] name The named client configuration.
       #
       # @raise [ Errors::NoClientConfig ] If no config could be found.
       #
       # @return [ Mongo::Client ] The new client.
-      #
-      # @since 3.0.0
       def create(name = nil)
         return default unless name
         config = Mongoid.clients[name]
@@ -36,8 +35,6 @@ module Mongoid
       #   found.
       #
       # @return [ Mongo::Client ] The default client.
-      #
-      # @since 3.0.0
       def default
         create_client(Mongoid.clients[:default])
       end
@@ -54,26 +51,54 @@ module Mongoid
       # @param [ Hash ] configuration The client config.
       #
       # @return [ Mongo::Client ] The client.
-      #
-      # @since 3.0.0
       def create_client(configuration)
         raise Errors::NoClientsConfig.new unless configuration
-        if configuration[:uri]
-          Mongo::Client.new(configuration[:uri], options(configuration))
+        config = configuration.dup
+        uri = config.delete(:uri)
+        database = config.delete(:database)
+        hosts = config.delete(:hosts)
+        opts = config.delete(:options) || {}
+        unless config.empty?
+          default_logger.warn("Unknown config options detected: #{config}.")
+        end
+        if uri
+          Mongo::Client.new(uri, options(opts))
         else
           Mongo::Client.new(
-            configuration[:hosts],
-            options(configuration).merge(database: configuration[:database])
+            hosts,
+            options(opts).merge(database: database)
           )
         end
       end
 
-      def options(configuration)
-        config = configuration.dup
-        options = config.delete(:options) || {}
+      MONGOID_WRAPPING_LIBRARY = {
+        name: 'Mongoid',
+        version: VERSION,
+      }.freeze
+
+      def driver_version
+        Mongo::VERSION.split('.')[0...2].map(&:to_i)
+      end
+
+      # Prepare options for Mongo::Client based on Mongoid client configuration.
+      #
+      # @param [ Hash ] opts Parameters from options section of Mongoid client configuration.
+      # @return [ Hash ] Options that should be passed to Mongo::Client constructor.
+      #
+      # @api private
+      def options(opts)
+        options = opts.dup
         options[:platform] = PLATFORM_DETAILS
         options[:app_name] = Mongoid::Config.app_name if Mongoid::Config.app_name
-        options.reject{ |k, v| k == :hosts }.to_hash.symbolize_keys!
+        if (driver_version <=> [2, 13]) >= 0
+          wrap_lib = if options[:wrapping_libraries]
+            [MONGOID_WRAPPING_LIBRARY] + options[:wrapping_libraries]
+          else
+            [MONGOID_WRAPPING_LIBRARY]
+          end
+          options[:wrapping_libraries] = wrap_lib
+        end
+        options.reject{ |k, _v| k == :hosts }.to_hash.symbolize_keys!
       end
     end
   end

data/lib/mongoid/clients/options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Clients
     module Options
@@ -7,24 +8,23 @@ module Mongoid
       # Change the persistence context for this object during the block.
       #
       # @example Save the current document to a different collection.
-      #   model.with(collection: "secondary") do |m|
+      #   model.with(collection: "bands") do |m|
       #     m.save
       #   end
       #
       # @param [ Hash, Mongoid::PersistenceContext ] options_or_context
       #   The storage options or a persistence context.
       #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :client The client name.
-      #
-      # @since 6.0.0
+      # @option options [ String | Symbol ] :collection The collection name.
+      # @option options [ String | Symbol ] :database The database name.
+      # @option options [ String | Symbol ] :client The client name.
       def with(options_or_context, &block)
+        original_context = PersistenceContext.get(self)
         original_cluster = persistence_context.cluster
         set_persistence_context(options_or_context)
         yield self
       ensure
-        clear_persistence_context(original_cluster)
+        clear_persistence_context(original_cluster, original_context)
       end
 
       def collection(parent = nil)
@@ -38,7 +38,7 @@ module Mongoid
       def mongo_client
         persistence_context.client
       end
-      
+
       def persistence_context
         PersistenceContext.get(self) ||
             PersistenceContext.get(self.class) ||
@@ -51,8 +51,8 @@ module Mongoid
         PersistenceContext.set(self, options_or_context)
       end
 
-      def clear_persistence_context(original_cluster = nil)
-        PersistenceContext.clear(self, original_cluster)
+      def clear_persistence_context(original_cluster = nil, context = nil)
+        PersistenceContext.clear(self, original_cluster, context)
       end
 
       module ClassMethods
@@ -80,23 +80,22 @@ module Mongoid
         # Change the persistence context for this class during the block.
         #
         # @example Save the current document to a different collection.
-        #   Model.with(collection: "secondary") do |m|
+        #   Model.with(collection: "bands") do |m|
         #     m.create
         #   end
         #
         # @param [ Hash ] options The storage options.
         #
-        # @option options [ String, Symbol ] :collection The collection name.
-        # @option options [ String, Symbol ] :database The database name.
-        # @option options [ String, Symbol ] :client The client name.
-        #
-        # @since 6.0.0
+        # @option options [ String | Symbol ] :collection The collection name.
+        # @option options [ String | Symbol ] :database The database name.
+        # @option options [ String | Symbol ] :client The client name.
         def with(options, &block)
+          original_context = PersistenceContext.get(self)
           original_cluster = persistence_context.cluster
           PersistenceContext.set(self, options)
           yield self
         ensure
-          PersistenceContext.clear(self, original_cluster)
+          PersistenceContext.clear(self, original_cluster, original_context)
         end
 
         def persistence_context

data/lib/mongoid/clients/sessions.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Clients
 
     # Encapsulates behavior for getting a session from the client of a model class or instance,
     # setting the session on the current thread, and yielding to a block.
     # The session will be closed after the block completes or raises an error.
-    #
-    # @since 6.4.0
     module Sessions
 
       # Execute a block within the context of a session.
@@ -35,15 +35,21 @@ module Mongoid
       # @return [ Object ] The result of calling the block.
       #
       # @yieldparam [ Mongo::Session ] The session being used for the block.
-      #
-      # @since 6.4.0
       def with_session(options = {})
-        raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
+        if Threaded.get_session
+          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting)
+        end
         session = persistence_context.client.start_session(options)
         Threaded.set_session(session)
         yield(session)
       rescue Mongo::Error::InvalidSession => ex
-        if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+        if
+          # Driver 2.13.0+
+          defined?(Mongo::Error::SessionsNotSupported) &&
+            Mongo::Error::SessionsNotSupported === ex ||
+          # Legacy drivers
+          ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+        then
           raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
         end
         raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)
@@ -86,15 +92,21 @@ module Mongoid
         # @return [ Object ] The result of calling the block.
         #
         # @yieldparam [ Mongo::Session ] The session being used for the block.
-        #
-        # @since 6.4.0
         def with_session(options = {})
-          raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting) if Threaded.get_session
+          if Threaded.get_session
+            raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_nesting)
+          end
           session = persistence_context.client.start_session(options)
           Threaded.set_session(session)
           yield(session)
         rescue Mongo::Error::InvalidSession => ex
-          if ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+          if
+            # Driver 2.13.0+
+            defined?(Mongo::Error::SessionsNotSupported) &&
+              Mongo::Error::SessionsNotSupported === ex ||
+            # Legacy drivers
+            ex.message == Mongo::Session::SESSIONS_NOT_SUPPORTED
+          then
             raise Mongoid::Errors::InvalidSessionUse.new(:sessions_not_supported)
           end
           raise Mongoid::Errors::InvalidSessionUse.new(:invalid_session_use)

data/lib/mongoid/clients/storage_options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Clients
     module StorageOptions
@@ -30,24 +31,22 @@ module Mongoid
         # @example Store this model by default in a different client.
         #   class Band
         #     include Mongoid::Document
-        #     store_in client: "secondary"
+        #     store_in client: "analytics"
         #   end
         #
         # @example Store this model with a combination of options.
         #   class Band
         #     include Mongoid::Document
-        #     store_in collection: "artists", database: "secondary"
+        #     store_in collection: "artists", database: "music"
         #   end
         #
         # @param [ Hash ] options The storage options.
         #
-        # @option options [ String, Symbol ] :collection The collection name.
-        # @option options [ String, Symbol ] :database The database name.
-        # @option options [ String, Symbol ] :client The client name.
+        # @option options [ String | Symbol ] :collection The collection name.
+        # @option options [ String | Symbol ] :database The database name.
+        # @option options [ String | Symbol ] :client The client name.
         #
         # @return [ Class ] The model class.
-        #
-        # @since 3.0.0
         def store_in(options)
           Validators::Storage.validate(self, options)
           storage_options.merge!(options)
@@ -57,8 +56,6 @@ module Mongoid
         #
         # @example Reset the store_in options
         #   Model.reset_storage_options!
-        #
-        # @since 4.0.0
         def reset_storage_options!
           self.storage_options = storage_options_defaults.dup
           PersistenceContext.clear(self)
@@ -70,8 +67,6 @@ module Mongoid
         #   Model.storage_options_defaults
         #
         # @return [ Hash ] Default storage options.
-        #
-        # @since 4.0.0
         def storage_options_defaults
           {
             collection: name.collectionize.to_sym,

data/lib/mongoid/clients/validators/storage.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Clients
     module Validators
@@ -8,8 +9,6 @@ module Mongoid
         extend self
 
         # The valid options for storage.
-        #
-        # @since 3.0.0
         VALID_OPTIONS = [ :collection, :database, :client ].freeze
 
         # Validate the options provided to :store_in.
@@ -19,8 +18,6 @@ module Mongoid
         #
         # @param [ Class ] klass The model class.
         # @param [ Hash, String, Symbol ] options The provided options.
-        #
-        # @since 3.0.0
         def validate(klass, options)
           valid_keys?(options) or raise Errors::InvalidStorageOptions.new(klass, options)
           valid_parent?(klass) or raise Errors::InvalidStorageParent.new(klass)
@@ -35,8 +32,6 @@ module Mongoid
         # @param [ Class ] klass
         #
         # @return [ true, false ] If the class is valid
-        #
-        # @since 4.0.0
         def valid_parent?(klass)
           !klass.superclass.include?(Mongoid::Document)
         end
@@ -51,8 +46,6 @@ module Mongoid
         # @param [ Hash ] options The options hash.
         #
         # @return [ true, false ] If all keys are valid.
-        #
-        # @since 3.0.0
         def valid_keys?(options)
           return false unless options.is_a?(::Hash)
           options.keys.all? do |key|

data/lib/mongoid/clients/validators.rb

@@ -1,2 +1,3 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/clients/validators/storage"

data/lib/mongoid/clients.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/clients/factory"
 require "mongoid/clients/validators"
 require "mongoid/clients/storage_options"
@@ -20,8 +21,6 @@ module Mongoid
       #   Mongoid::Clients.clear
       #
       # @return [ Array ] The empty clients.
-      #
-      # @since 3.0.0
       def clear
         clients.clear
       end
@@ -32,8 +31,6 @@ module Mongoid
       #   Mongoid::Clients.default
       #
       # @return [ Mongo::Client ] The default client.
-      #
-      # @since 3.0.0
       def default
         with_name(:default)
       end
@@ -44,8 +41,6 @@ module Mongoid
       #   Mongoid::Clients.disconnect
       #
       # @return [ true ] True.
-      #
-      # @since 3.1.0
       def disconnect
         clients.values.each do |client|
           client.close
@@ -57,11 +52,9 @@ module Mongoid
       # @example Get a client with the name.
       #   Mongoid::Clients.with_name(:replica)
       #
-      # @param [ Symbol ] name The name of the client.
+      # @param [ String | Symbol ] name The name of the client.
       #
       # @return [ Mongo::Client ] The named client.
-      #
-      # @since 3.0.0
       def with_name(name)
         name_as_symbol = name.to_sym
         return clients[name_as_symbol] if clients[name_as_symbol]

data/lib/mongoid/composable.rb

@@ -1,9 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/changeable"
 require "mongoid/findable"
 require "mongoid/indexable"
 require "mongoid/inspectable"
 require "mongoid/interceptable"
+require "mongoid/matcher"
 require "mongoid/matchable"
 require "mongoid/persistable"
 require "mongoid/reloadable"
@@ -18,9 +20,7 @@ require "mongoid/validatable"
 
 module Mongoid
 
-  # This module provides inclusions of all behaviour in a Mongoid document.
-  #
-  # @since 4.0.0
+  # This module provides inclusions of all behavior in a Mongoid document.
   module Composable
     extend ActiveSupport::Concern
 
@@ -43,7 +43,7 @@ module Mongoid
     include Inspectable
     include Matchable
     include Persistable
-    include Relations
+    include Association
     include Reloadable
     include Scopable
     include Selectable
@@ -70,7 +70,7 @@ module Mongoid
       Interceptable,
       Matchable,
       Persistable,
-      Relations,
+      Association,
       Reloadable,
       Scopable,
       Serializable,
@@ -83,21 +83,19 @@ module Mongoid
       Traversable,
       Validatable,
       Equality,
-      Relations::Synchronization,
-      Relations::Macros,
+      Association::Referenced::Syncable,
+      Association::Macros,
       ActiveModel::Model,
       ActiveModel::Validations
     ]
 
     # These are methods names defined in included blocks that may conflict
-    # with user-defined relation or field names.
+    # with user-defined association or field names.
     # They won't be in the list of Module.instance_methods on which the
     # #prohibited_methods code below is dependent so we must track them
     # separately.
     #
     # @return [ Array<Symbol> ] A list of reserved method names.
-    #
-    # @since 6.0.0
     RESERVED_METHOD_NAMES = [ :fields,
                               :aliased_fields,
                               :localized_fields,
@@ -120,8 +118,6 @@ module Mongoid
       #   Mongoid::Components.prohibited_methods
       #
       # @return [ Array<Symbol> ]
-      #
-      # @since 2.1.8
       def prohibited_methods
         @prohibited_methods ||= MODULES.flat_map do |mod|
           mod.instance_methods.map(&:to_sym)

data/lib/mongoid/config/environment.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Config
 
@@ -6,38 +7,75 @@ module Mongoid
     module Environment
       extend self
 
-      # Get the name of the environment that we are running under. This first
-      # looks for Rails, then Sinatra, then a RACK_ENV environment variable,
-      # and if none of those are found raises an error.
+      # Get the name of the environment that Mongoid is running under.
+      #
+      # Uses the following sources in order:
+      # - If +::Rails+ is defined, +Rails.env+.
+      # - If +::Sinatra+ is defined, +Sinatra::Base.environment+.
+      # - +RACK_ENV+
+      # - +MONGOID_ENV*
       #
       # @example Get the env name.
       #   Environment.env_name
       #
-      # @raise [ Errors::NoEnvironment ] If no environment was set.
+      # @raise [ Errors::NoEnvironment ] If environment name cannot be
+      #   determined because none of the sources was set.
       #
       # @return [ String ] The name of the current environment.
-      #
-      # @since 2.3.0
+      # @api public
       def env_name
-        return Rails.env if defined?(Rails) && Rails.respond_to?(:env)
-        return Sinatra::Base.environment.to_s if defined?(Sinatra)
-        ENV["RACK_ENV"] || ENV["MONGOID_ENV"] || raise(Errors::NoEnvironment.new)
+        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
       end
 
       # Load the yaml from the provided path and return the settings for the
-      # current environment.
+      # specified environment, or for the current Mongoid environment.
       #
       # @example Load the yaml.
       #   Environment.load_yaml("/work/mongoid.yml")
       #
       # @param [ String ] path The location of the file.
+      # @param [ String | Symbol ] environment Optional environment name to
+      #   override the current Mongoid environment.
       #
       # @return [ Hash ] The settings.
       #
-      # @since 2.3.0
+      # @api private
       def load_yaml(path, environment = nil)
         env = environment ? environment.to_s : env_name
-        YAML.load(ERB.new(File.new(path).read).result)[env]
+
+        contents = File.read(path)
+        if contents.empty?
+          raise Mongoid::Errors::EmptyConfigFile.new(path)
+        end
+
+        # These are the classes that can be used in a Mongoid
+        # configuration file in addition to standard YAML types.
+        permitted_classes = [
+          # Symbols occur as values for read preference, for example.
+          Symbol,
+          # BSON::Binary occur as keyId values for FLE (more precisely,
+          # the keyIds are UUIDs).
+          BSON::Binary,
+        ]
+
+        result = ERB.new(contents).result
+        data = if RUBY_VERSION < '2.6'
+          YAML.safe_load(result, permitted_classes, [], true)
+        else
+          YAML.safe_load(result, permitted_classes: permitted_classes, aliases: true)
+        end
+
+        unless data.is_a?(Hash)
+          raise Mongoid::Errors::InvalidConfigFile.new(path)
+        end
+
+        data[env]
       end
     end
   end

data/lib/mongoid/config/options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Config
 
@@ -11,8 +12,6 @@ module Mongoid
       #   options.defaults
       #
       # @return [ Hash ] The default options.
-      #
-      # @since 2.3.0
       def defaults
         @defaults ||= {}
       end
@@ -20,30 +19,31 @@ module Mongoid
       # Define a configuration option with a default.
       #
       # @example Define the option.
-      #   Options.option(:logger, :default => Logger.new($stdout, :warn))
+      #   Options.option(:logger, :default => Logger.new(STDERR, :warn))
       #
       # @param [ Symbol ] name The name of the configuration option.
       # @param [ Hash ] options Extras for the option.
       #
       # @option options [ Object ] :default The default value.
-      #
-      # @since 2.0.0.rc.1
       def option(name, options = {})
         defaults[name] = settings[name] = options[:default]
 
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{name}
-            settings[#{name.inspect}]
+        class_eval do
+          # log_level accessor is defined specially below
+          unless name.to_sym == :log_level
+            define_method(name) do
+              settings[name]
+            end
           end
 
-          def #{name}=(value)
-            settings[#{name.inspect}] = value
+          define_method("#{name}=") do |value|
+            settings[name] = value
           end
 
-          def #{name}?
-            #{name}
+          define_method("#{name}?") do
+            !!send(name)
           end
-        RUBY
+        end
       end
 
       # Reset the configuration options to the defaults.
@@ -52,8 +52,6 @@ module Mongoid
       #   config.reset
       #
       # @return [ Hash ] The defaults.
-      #
-      # @since 2.3.0
       def reset
         settings.replace(defaults)
       end
@@ -64,8 +62,6 @@ module Mongoid
       #   options.settings
       #
       # @return [ Hash ] The setting options.
-      #
-      # @since 2.3.0
       def settings
         @settings ||= {}
       end
@@ -76,12 +72,13 @@ module Mongoid
       #   config.log_level
       #
       # @return [ Integer ] The log level.
-      #
-      # @since 5.1.0
       def log_level
-        if settings[:log_level]
-          level = settings[:log_level].upcase.to_s
-          "Logger::#{level}".constantize
+        if level = settings[:log_level]
+          unless level.is_a?(Integer)
+            level = level.upcase.to_s
+            level = "Logger::#{level}".constantize
+          end
+          level
         end
       end
     end