mongoid 3.1.5 → 8.0.2

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Config
+    module Validators
+
+      # Validator for client specific configuration.
+      module Client
+        extend self
+
+        # Standard configuration options.
+        STANDARD = [ :database, :hosts, :username, :password ].freeze
+
+        # Validate the client configuration.
+        #
+        # @example Validate the client config.
+        #   Client.validate({ default: { hosts: [ "localhost:27017" ] }})
+        #
+        # @param [ Hash ] clients The clients config.
+        def validate(clients)
+          unless clients.has_key?(:default)
+            raise Errors::NoDefaultClient.new(clients.keys)
+          end
+          clients.each_pair do |name, config|
+            validate_client_database(name, config)
+            validate_client_hosts(name, config)
+            validate_client_uri(name, config)
+          end
+        end
+
+        private
+
+        # Validate that the client config has database.
+        #
+        # @api private
+        #
+        # @example Validate the client has database.
+        #   validator.validate_client_database(:default, {})
+        #
+        # @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
+        end
+
+        # Validate that the client config has hosts.
+        #
+        # @api private
+        #
+        # @example Validate the client has hosts.
+        #   validator.validate_client_hosts(:default, {})
+        #
+        # @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
+        end
+
+        # Validate that not both a uri and standard options are provided for a
+        # single client.
+        #
+        # @api private
+        #
+        # @example Validate the uri and options.
+        #   validator.validate_client_uri(:default, {})
+        #
+        # @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
+        end
+
+        # Return true if the configuration has no database or uri option
+        # defined.
+        #
+        # @api private
+        #
+        # @example Validate the options.
+        #   validator.no_database_or_uri?(config)
+        #
+        # @param [ Hash ] config The configuration options.
+        #
+        # @return [ true | false ] If no database or uri is defined.
+        def no_database_or_uri?(config)
+          !config.has_key?(:database) && !config.has_key?(:uri)
+        end
+
+        # Return true if the configuration has no hosts or uri option
+        # defined.
+        #
+        # @api private
+        #
+        # @example Validate the options.
+        #   validator.no_hosts_or_uri?(config)
+        #
+        # @param [ Hash ] config The configuration options.
+        #
+        # @return [ true | false ] If no hosts or uri is defined.
+        def no_hosts_or_uri?(config)
+          !config.has_key?(:hosts) && !config.has_key?(:uri)
+        end
+
+        # Return true if the configuration has both standard options and a uri
+        # defined.
+        #
+        # @api private
+        #
+        # @example Validate the options.
+        #   validator.no_database_or_uri?(config)
+        #
+        # @param [ Hash ] config The configuration options.
+        #
+        # @return [ true | false ] If both standard and uri are defined.
+        def both_uri_and_standard?(config)
+          config.has_key?(:uri) && config.keys.any? do |key|
+            STANDARD.include?(key.to_sym)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Config
     module Validators
@@ -9,11 +10,9 @@ module Mongoid
 
         # Validate a configuration option.
         #
-        # @example Validate a configuraiton option.
+        # @example Validate a configuration option.
         #
         # @param [ String ] option The name of the option.
-        #
-        # @since 3.0.0
         def validate(option)
           unless Config.settings.keys.include?(option.to_sym)
             raise Errors::InvalidConfigOption.new(option)

data/lib/mongoid/config/validators.rb

@@ -1,3 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/config/validators/option"
-require "mongoid/config/validators/session"
+require "mongoid/config/validators/client"

data/lib/mongoid/config.rb

@@ -1,50 +1,142 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/config/environment"
-require "mongoid/config/inflections"
 require "mongoid/config/options"
 require "mongoid/config/validators"
 
 module Mongoid
 
-  # This module defines all the configuration options for Mongoid, including the
-  # database connections.
+  # This module defines all the configuration options for Mongoid, including
+  # the database connections.
   module Config
-    extend self
+    extend Forwardable
     extend Options
-    include ActiveModel::Observing
+    extend self
 
-    delegate :logger=, to: ::Mongoid
-    delegate :logger, to: ::Mongoid
+    def_delegators ::Mongoid, :logger, :logger=
 
     LOCK = Mutex.new
 
-    option :allow_dynamic_fields, default: true
-    option :identity_map_enabled, default: false
+    # Application name that is printed to the mongodb logs upon establishing
+    # a connection in server versions >= 3.4. Note that the name cannot
+    # exceed 128 bytes. It is also used as the database name if the
+    # database name is not explicitly defined.
+    option :app_name, default: nil
+
+    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
+    # indexes in the background by default. (default: false)
+    option :background_indexing, default: false
+
+    # Mark belongs_to associations as required by default, so that saving a
+    # model with a missing belongs_to association will trigger a validation
+    # error.
+    option :belongs_to_required_by_default, default: true
+
+    # Set the global discriminator key.
+    option :discriminator_key, default: "_type"
+
+    # Raise an exception when a field is redefined.
+    option :duplicate_fields_exception, default: false
+
+    # Include the root model name in json serialization.
     option :include_root_in_json, default: false
+
+    # # Include the _type field in serialization.
     option :include_type_for_serialization, default: false
+
+    # Whether to join nested persistence contexts for atomic operations
+    # to parent contexts by default.
+    option :join_contexts, default: false
+
+    # The log level.
+    #
+    # It must be set prior to referencing clients or Mongo.logger,
+    # changes to this option are not be propagated to any clients and
+    # loggers that already exist.
+    #
+    # Additionally, only when the clients are configured via the
+    # configuration file is the log level given by this option honored.
+    option :log_level, default: :info
+
+    # Preload all models in development, needed when models use inheritance.
     option :preload_models, default: false
-    option :protect_sensitive_fields, default: true
+
+    # Raise an error when performing a #find and the document is not found.
     option :raise_not_found_error, default: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method.
     option :scope_overwrite_exception, default: false
-    # @todo: Remove at 4.0
-    option :skip_version_check, default: false
+
+    # Use ActiveSupport's time zone in time operations instead of the
+    # Ruby default time zone.
     option :use_activesupport_time_zone, default: true
+
+    # Return stored times as UTC.
     option :use_utc, default: false
 
+    # Store BigDecimals as Decimal128s instead of strings in the db.
+    option :map_big_decimal_to_decimal128, default: true
+
+    # Update embedded documents correctly when setting it, unsetting it
+    # and resetting it. See MONGOID-5206 and MONGOID-5240 for more details.
+    option :broken_updates, default: false
+
+    # Maintain legacy behavior of === on Mongoid documents, which returns
+    # true in a number of cases where Ruby's === implementation would
+    # return false.
+    option :legacy_triple_equals, default: false
+
+    # When exiting a nested `with_scope' block, set the current scope to
+    # nil instead of the parent scope for backwards compatibility.
+    option :broken_scoping, default: false
+
+    # Maintain broken behavior of sum over empty result sets for backwards
+    # compatibility.
+    option :broken_aggregables, default: false
+
+    # Ignore aliased fields in embedded documents when performing pluck and
+    # distinct operations, for backwards compatibility.
+    option :broken_alias_handling, default: false
+
+    # Maintain broken `and' behavior when using the same operator on the same
+    # field multiple times for backwards compatibility.
+    option :broken_and, default: false
+
+    # Use millisecond precision when comparing Time objects with the _matches?
+    # function.
+    option :compare_time_by_ms, default: true
+
+    # Use bson-ruby's implementation of as_json for BSON::ObjectId instead of
+    # the one monkey-patched into Mongoid.
+    option :object_id_as_json_oid, default: false
+
+    # Maintain legacy behavior of pluck and distinct, which does not
+    # demongoize the values on returning them.
+    option :legacy_pluck_distinct, default: false
+
+    # Combine chained operators, which use the same field and operator,
+    # using and's instead of overwriting them.
+    option :overwrite_chained_operators, default: false
+
+    # When this flag is true, the attributes method on a document will return
+    # a BSON::Document when that document is retrieved from the database, and
+    # a Hash otherwise. When this flag is false, the attributes method will
+    # always return a Hash.
+    option :legacy_attributes, default: false
+
     # Has Mongoid been configured? This is checking that at least a valid
-    # session config exists.
+    # client config exists.
     #
     # @example Is Mongoid configured?
     #   config.configured?
     #
-    # @return [ true, false ] If Mongoid is configured.
-    #
-    # @since 3.0.9
+    # @return [ true | false ] If Mongoid is configured.
     def configured?
-      sessions.has_key?(:default)
+      clients.key?(:default)
     end
 
-    # Connect to the provided database name on the default session.
+    # Connect to the provided database name on the default client.
     #
     # @note Use only in development or test environments for convenience.
     #
@@ -52,10 +144,8 @@ module Mongoid
     #   config.connect_to("mongoid_test")
     #
     # @param [ String ] name The database name.
-    #
-    # @since 3.0.0
-    def connect_to(name, options = { consistency: :eventual })
-      self.sessions = {
+    def connect_to(name, options = { read: { mode: :primary }})
+      self.clients = {
         default: {
           database: name,
           hosts: [ "localhost:27017" ],
@@ -72,7 +162,7 @@ module Mongoid
     #
     # @return [ Array<String> ] An array of bad field names.
     def destructive_fields
-      Components.prohibited_methods
+      Composable.prohibited_methods
     end
 
     # Load the settings from a compliant mongoid.yml file. This can be used for
@@ -82,14 +172,12 @@ module Mongoid
     #   Mongoid.load!("/path/to/mongoid.yml")
     #
     # @param [ String ] path The path to the file.
-    # @param [ String, Symbol ] environment The environment to load.
-    #
-    # @since 2.0.1
+    # @param [ String | Symbol ] environment The environment to load.
     def load!(path, environment = nil)
       settings = Environment.load_yaml(path, environment)
       if settings.present?
-        Sessions.disconnect
-        Sessions.clear
+        Clients.disconnect
+        Clients.clear
         load_configuration(settings)
       end
       settings
@@ -102,8 +190,6 @@ module Mongoid
     #   config.models
     #
     # @return [ Array<Class> ] All the models in the application.
-    #
-    # @since 3.1.0
     def models
       @models ||= []
     end
@@ -114,8 +200,6 @@ module Mongoid
     #   config.register_model(Band)
     #
     # @param [ Class ] klass The model to register.
-    #
-    # @since 3.1.0
     def register_model(klass)
       LOCK.synchronize do
         models.push(klass) unless models.include?(klass)
@@ -128,12 +212,12 @@ module Mongoid
     #   config.load_configuration(settings)
     #
     # @param [ Hash ] settings The configuration settings.
-    #
-    # @since 3.1.0
     def load_configuration(settings)
       configuration = settings.with_indifferent_access
       self.options = configuration[:options]
-      self.sessions = configuration[:sessions]
+      self.clients = configuration[:clients]
+      Mongo.options = configuration[:driver_options] || {}
+      set_log_levels
     end
 
     # Override the database to use globally.
@@ -141,27 +225,23 @@ module Mongoid
     # @example Override the database globally.
     #   config.override_database(:optional)
     #
-    # @param [ String, Symbol ] name The name of the database.
-    #
-    # @return [ String, Symbol ] The global override.
+    # @param [ String | Symbol ] name The name of the database.
     #
-    # @since 3.0.0
+    # @return [ String | Symbol ] The global override.
     def override_database(name)
       Threaded.database_override = name
     end
 
-    # Override the session to use globally.
+    # Override the client to use globally.
     #
-    # @example Override the session globally.
-    #   config.override_session(:optional)
+    # @example Override the client globally.
+    #   config.override_client(:optional)
     #
-    # @param [ String, Symbol ] name The name of the session.
+    # @param [ String | Symbol ] name The name of the client.
     #
-    # @return [ String, Symbol ] The global override.
-    #
-    # @since 3.0.0
-    def override_session(name)
-      Threaded.session_override = name ? name.to_s : nil
+    # @return [ String | Symbol ] The global override.
+    def override_client(name)
+      Threaded.client_override = name ? name.to_s : nil
     end
 
     # Purge all data in all collections, including indexes.
@@ -172,12 +252,8 @@ module Mongoid
     # @note This is the fastest way to drop all data.
     #
     # @return [ true ] true.
-    #
-    # @since 2.0.2
     def purge!
-      Sessions.default.collections.each do |collection|
-        collection.drop
-      end and true
+      global_client.database.collections.each(&:drop) and true
     end
 
     # Truncate all data in all collections, but not the indexes.
@@ -188,11 +264,9 @@ module Mongoid
     # @note This will be slower than purge!
     #
     # @return [ true ] true.
-    #
-    # @since 2.0.2
     def truncate!
-      Sessions.default.collections.each do |collection|
-        collection.find.remove_all
+      global_client.database.collections.each do |collection|
+        collection.find.delete_many
       end and true
     end
 
@@ -202,8 +276,6 @@ module Mongoid
     #   config.options = { raise_not_found_error: true }
     #
     # @param [ Hash ] options The configuration options.
-    #
-    # @since 3.0.0
     def options=(options)
       if options
         options.each_pair do |option, value|
@@ -213,32 +285,14 @@ module Mongoid
       end
     end
 
-    # Get the session configuration or an empty hash.
-    #
-    # @example Get the sessions configuration.
-    #   config.sessions
+    # Get the client configuration or an empty hash.
     #
-    # @return [ Hash ] The sessions configuration.
+    # @example Get the clients configuration.
+    #   config.clients
     #
-    # @since 3.0.0
-    def sessions
-      @sessions ||= {}
-    end
-
-    # Set the session configuration options.
-    #
-    # @example Set the session configuration options.
-    #   config.sessions = { default: { hosts: [ "localhost:27017" ] }}
-    #
-    # @param [ Hash ] sessions The configuration options.
-    #
-    # @since 3.0.0
-    def sessions=(sessions)
-      raise Errors::NoSessionsConfig.new unless sessions
-      sess = sessions.with_indifferent_access
-      Validators::Session.validate(sess)
-      @sessions = sess
-      sess
+    # @return [ Hash ] The clients configuration.
+    def clients
+      @clients ||= {}
     end
 
     # Get the time zone to use.
@@ -247,8 +301,6 @@ module Mongoid
     #   Config.time_zone
     #
     # @return [ String ] The time zone.
-    #
-    # @since 3.0.0
     def time_zone
       use_utc? ? "UTC" : ::Time.zone
     end
@@ -258,11 +310,40 @@ module Mongoid
     # @example Is the application using passenger?
     #   config.running_with_passenger?
     #
-    # @return [ true, false ] If the app is deployed on Passenger.
-    #
-    # @since 3.0.11
+    # @return [ true | false ] If the app is deployed on Passenger.
     def running_with_passenger?
       @running_with_passenger ||= defined?(PhusionPassenger)
     end
+
+    private
+
+    def set_log_levels
+      Mongoid.logger.level = Mongoid::Config.log_level unless defined?(::Rails)
+      Mongo::Logger.logger.level = Mongoid.logger.level
+    end
+
+    def clients=(clients)
+      raise Errors::NoClientsConfig.new unless clients
+      c = clients.with_indifferent_access
+      Validators::Client.validate(c)
+      @clients = c
+    end
+
+    # Get database client that respects global overrides
+    # Config.override_database and Config.override_client.
+    #
+    # @return [Mongo::Client] Client according to global overrides.
+    def global_client
+      client =  if Threaded.client_override
+                  Clients.with_name(Threaded.client_override)
+                else
+                  Clients.default
+                end
+      if Threaded.database_override
+        client.use(Threaded.database_override)
+      else
+        client
+      end
+    end
   end
 end

data/lib/mongoid/contextual/aggregable/memory.rb

@@ -1,10 +1,25 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     module Aggregable
-      # Contains behaviour for aggregating values in memory.
+      # Contains behavior for aggregating values in memory.
       module Memory
 
+        # Get all the aggregate values for the provided field.
+        # Provided for interface consistency with Aggregable::Mongo.
+        #
+        # @param [ String | Symbol ] field The field name.
+        #
+        # @return [ Hash ] A Hash containing the aggregate values.
+        #   If no documents are present, then returned Hash will have
+        #   count, sum of 0 and max, min, avg of nil.
+        def aggregates(field)
+          %w(count sum avg min max).each_with_object({}) do |method, hash|
+            hash[method] = send(method, field)
+          end
+        end
+
         # Get the average value of the provided field.
         #
         # @example Get the average of a single field.
@@ -12,11 +27,13 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to average.
         #
-        # @return [ Float ] The average.
-        #
-        # @since 3.0.0
+        # @return [ Numeric ] The average.
         def avg(field)
-          count > 0 ? sum(field).to_f / count.to_f : nil
+          total = count { |doc| !doc.send(field).nil? }
+          return nil unless total > 0
+
+          total = total.to_f if total.is_a?(Integer)
+          sum(field) / total
         end
 
         # Get the max value of the provided field. If provided a block, will
@@ -33,12 +50,12 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to max.
         #
-        # @return [ Float, Document ] The max value or document with the max
+        # @return [ Numeric | Document ] The max value or document with the max
         #   value.
-        #
-        # @since 3.0.0
         def max(field = nil)
-          block_given? ? super() : aggregate_by(field, :max_by)
+          return super() if block_given?
+
+          aggregate_by(field, :max)
         end
 
         # Get the min value of the provided field. If provided a block, will
@@ -55,12 +72,12 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to min.
         #
-        # @return [ Float, Document ] The min value or document with the min
+        # @return [ Numeric | Document ] The min value or document with the min
         #   value.
-        #
-        # @since 3.0.0
         def min(field = nil)
-          block_given? ? super() : aggregate_by(field, :min_by)
+          return super() if block_given?
+
+          aggregate_by(field, :min)
         end
 
         # Get the sum value of the provided field. If provided a block, will
@@ -74,15 +91,11 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to sum.
         #
-        # @return [ Float ] The sum value.
-        #
-        # @since 3.0.0
+        # @return [ Numeric ] The sum value.
         def sum(field = nil)
-          if block_given?
-            super()
-          else
-            count > 0 ? super(0) { |doc| doc.send(field) } : 0
-          end
+          return super() if block_given?
+
+          aggregate_by(field, :sum) || 0
         end
 
         private
@@ -92,16 +105,16 @@ module Mongoid
         # @api private
         #
         # @example Aggregate by the field and method.
-        #   aggregable.aggregate_by(:name, :min_by)
+        #   aggregable.aggregate_by(:likes, :min_by)
         #
         # @param [ Symbol ] field The field to aggregate on.
         # @param [ Symbol ] method The method (min_by or max_by).
         #
-        # @return [ Integer ] The aggregate.
-        #
-        # @since 3.0.0
+        # @return [ Numeric | nil ] The aggregate.
         def aggregate_by(field, method)
-          count > 0 ? send(method) { |doc| doc.send(field) }.send(field) : nil
+          return nil unless any?
+
+          map { |doc| doc.public_send(field) }.compact.public_send(method)
         end
       end
     end