mongoid 6.4.4 → 7.3.2

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Config
     module Validators

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Config
     module Validators

data/lib/mongoid/config/validators.rb

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

data/lib/mongoid/config.rb

@@ -1,32 +1,79 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/config/environment"
 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
+    extend self
 
-    delegate :logger=, to: ::Mongoid
-    delegate :logger, to: ::Mongoid
+    def_delegators ::Mongoid, :logger, :logger=
 
     LOCK = Mutex.new
 
+    # 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
+
+    # Create indexes in background by default.
+    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
+
+    # 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
-    option :duplicate_fields_exception, 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
-    option :log_level, default: :info
-    option :belongs_to_required_by_default, default: true
-    option :app_name, default: nil
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.
@@ -173,7 +220,7 @@ module Mongoid
     #
     # @since 2.0.2
     def purge!
-      Clients.default.database.collections.each(&:drop) and true
+      global_client.database.collections.each(&:drop) and true
     end
 
     # Truncate all data in all collections, but not the indexes.
@@ -187,7 +234,7 @@ module Mongoid
     #
     # @since 2.0.2
     def truncate!
-      Clients.default.database.collections.each do |collection|
+      global_client.database.collections.each do |collection|
         collection.find.delete_many
       end and true
     end
@@ -258,5 +305,22 @@ module Mongoid
       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,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     module Aggregable
-      # Contains behaviour for aggregating values in memory.
+      # Contains behavior for aggregating values in memory.
       module Memory
 
         # Get the average value of the provided field.

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

@@ -1,25 +1,29 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     module Aggregable
-      # Contains behaviour for aggregating values in Mongo.
+      # Contains behavior for aggregating values in Mongo.
       module Mongo
 
         # Get all the aggregate values for the provided field.
         #
         # @example Get all the aggregate values.
         #   aggregable.aggregates(:likes)
+        #   # => {
+        #   #   "count" => 2.0,
+        #   #   "max" => 1000.0,
+        #   #   "min" => 500.0,
+        #   #   "sum" => 1500.0,
+        #   #   "avg" => 750.0
+        #   # }
         #
         # @param [ String, Symbol ] field The field name.
         #
-        # @return [ Hash ] count is a number of documents with the provided field. If there're none, then count is 0 and max, min, sum, avg are nil.
-        #   {
-        #     "count" => 2.0,
-        #     "max" => 1000.0,
-        #     "min" => 500.0,
-        #     "sum" => 1500.0,
-        #     "avg" => 750.0
-        #   }
+        # @return [ Hash ] count is a number of documents with the provided
+        #   field. If there're none, then count is 0 and max, min, sum, avg
+        #   are nil.
         #
         # @since 3.0.0
         def aggregates(field)

data/lib/mongoid/contextual/atomic.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     module Atomic
@@ -17,6 +19,20 @@ module Mongoid
         view.update_many("$addToSet" => collect_operations(adds))
       end
 
+      # Perform an atomic $addToSet/$each on the matching documents.
+      #
+      # @example Add the value to the set.
+      #   context.add_each_to_set(members: ["Dave", "Bill"], genres: ["Electro", "Disco"])
+      #
+      # @param [ Hash ] adds The operations.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 7.0.0
+      def add_each_to_set(adds)
+        view.update_many("$addToSet" => collect_each_operations(adds))
+      end
+
       # Perform an atomic $bit operation on the matching documents.
       #
       # @example Perform the bitwise op.
@@ -117,10 +133,7 @@ module Mongoid
       #
       # @since 3.0.0
       def push_all(pushes)
-        push_each_updates = collect_operations(pushes).each.inject({}) do |ops, (field, elements)|
-          ops.merge!(field => {'$each' => elements})
-        end
-        view.update_many("$push" => push_each_updates)
+        view.update_many("$push" => collect_each_operations(pushes))
       end
 
       # Perform an atomic $rename of fields on the matching documents.
@@ -173,9 +186,14 @@ module Mongoid
       private
 
       def collect_operations(ops)
-        ops.inject({}) do |operations, (field, value)|
+        ops.each_with_object({}) do |(field, value), operations|
           operations[database_field_name(field)] = value.mongoize
-          operations
+        end
+      end
+
+      def collect_each_operations(ops)
+        ops.each_with_object({}) do |(field, value), operations|
+          operations[database_field_name(field)] = { "$each" => Array.wrap(value).mongoize }
         end
       end
     end

data/lib/mongoid/contextual/command.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     module Command

data/lib/mongoid/contextual/geo_near.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     class GeoNear
+      extend Forwardable
       include Enumerable
       include Command
 
-      delegate :[], to: :results
-      delegate :==, :empty?, to: :entries
+      def_delegator :results, :[]
+      def_delegators :entries, :==, :empty?
 
       # Get the average distance for all documents from the point in the
       # command.
@@ -242,7 +245,7 @@ module Mongoid
       # @since 3.0.0
       def documents
         results["results"].map do |attributes|
-          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria.options[:fields])
+          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria)
           doc.attributes["geo_near_distance"] = attributes["dis"]
           doc
         end
@@ -264,4 +267,3 @@ module Mongoid
     end
   end
 end
-

data/lib/mongoid/contextual/map_reduce.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     class MapReduce
+      extend Forwardable
       include Enumerable
       include Command
 
-      delegate :[], to: :results
-      delegate :==, :empty?, to: :entries
+      def_delegators :results, :[]
+      def_delegators :entries, :==, :empty?
 
       # Get all the counts returned by the map/reduce.
       #

data/lib/mongoid/contextual/memory.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/contextual/aggregable/memory"
-require "mongoid/relations/eager"
+require "mongoid/association/eager_loadable"
 
 module Mongoid
   module Contextual
     class Memory
       include Enumerable
       include Aggregable::Memory
-      include Relations::Eager
+      include Association::EagerLoadable
       include Queryable
       include Positional
 
@@ -130,7 +132,7 @@ module Mongoid
       # @return [ Document ] The first document.
       #
       # @since 3.0.0
-      def first
+      def first(*args)
         eager_load([documents.first]).first
       end
       alias :one :first
@@ -155,6 +157,22 @@ module Mongoid
         apply_options
       end
 
+      # Increment a value on all documents.
+      #
+      # @example Perform the increment.
+      #   context.inc(likes: 10)
+      #
+      # @param [ Hash ] incs The operations.
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 7.0.0
+      def inc(incs)
+        each do |document|
+          document.inc(incs)
+        end
+      end
+
       # Get the last document in the database for the criteria's selector.
       #
       # @example Get the last document.
@@ -446,6 +464,8 @@ module Mongoid
         doc.destroyed = true
       end
 
+      private
+
       def _session
         @criteria.send(:_session)
       end

data/lib/mongoid/contextual/mongo.rb

@@ -1,18 +1,21 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/contextual/atomic"
 require "mongoid/contextual/aggregable/mongo"
 require "mongoid/contextual/command"
 require "mongoid/contextual/geo_near"
 require "mongoid/contextual/map_reduce"
-require "mongoid/relations/eager"
+require "mongoid/association/eager_loadable"
 
 module Mongoid
   module Contextual
     class Mongo
+      extend Forwardable
       include Enumerable
       include Aggregable::Mongo
       include Atomic
-      include Relations::Eager
+      include Association::EagerLoadable
       include Queryable
 
       # Options constant.
@@ -68,7 +71,26 @@ module Mongoid
       # @since 3.0.0
       def count(options = {}, &block)
         return super(&block) if block_given?
-        try_cache(:count) { view.count(options) }
+        try_cache(:count) { view.count_documents(options) }
+      end
+
+      # Get the estimated number of documents matching the query.
+      #
+      # Unlike count, estimated_count does not take a block because it is not
+      # traditionally defined (with a block) on Enumarable like count is.
+      #
+      # @example Get the estimated number of matching documents.
+      #   context.estimated_count
+      #
+      # @param [ Hash ] options The options, such as maxTimeMS to be factored
+      #   into the count.
+      #
+      # @return [ Integer ] The number of matches.
+      def estimated_count(options = {})
+        unless self.criteria.selector.empty?
+          raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass)
+        end
+        try_cache(:estimated_count) { view.estimated_document_count(options) }
       end
 
       # Delete all documents in the database that match the selector.
@@ -255,13 +277,13 @@ module Mongoid
         return documents.first if cached? && cache_loaded?
         try_cache(:first) do
           if sort = view.sort || ({ _id: 1 } unless opts[:id_sort] == :none)
-            if raw_doc = view.sort(sort).limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+            if raw_doc = view.sort(sort).limit(1).first
+              doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           else
-            if raw_doc = view.limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+            if raw_doc = view.limit(1).first
+              doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           end
@@ -277,7 +299,7 @@ module Mongoid
       def find_first
         return documents.first if cached? && cache_loaded?
         if raw_doc = view.first
-          doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+          doc = Factory.from_db(klass, raw_doc, criteria)
           eager_load([doc]).first
         end
       end
@@ -300,6 +322,8 @@ module Mongoid
       #
       # @return [ GeoNear ] The GeoNear command.
       #
+      # @deprecated
+      #
       # @since 3.1.0
       def geo_near(coordinates)
         GeoNear.new(collection, criteria, coordinates)
@@ -345,7 +369,7 @@ module Mongoid
         apply_options
       end
 
-      delegate(:database_field_name, to: :@klass)
+      def_delegator :@klass, :database_field_name
 
       # Get the last document in the database for the criteria's selector.
       #
@@ -367,8 +391,8 @@ module Mongoid
       def last(opts = {})
         try_cache(:last) do
           with_inverse_sorting(opts) do
-            if raw_doc = view.limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+            if raw_doc = view.limit(1).first
+              doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           end
@@ -683,7 +707,7 @@ module Mongoid
       def documents_for_iteration
         return documents if cached? && !documents.empty?
         return view unless eager_loadable?
-        docs = view.map{ |doc| Factory.from_db(klass, doc, criteria.options[:fields]) }
+        docs = view.map{ |doc| Factory.from_db(klass, doc, criteria) }
         eager_load(docs)
       end
 
@@ -701,11 +725,13 @@ module Mongoid
       # @since 3.0.0
       def yield_document(document, &block)
         doc = document.respond_to?(:_id) ?
-            document : Factory.from_db(klass, document, criteria.options[:fields])
+            document : Factory.from_db(klass, document, criteria)
         yield(doc)
         documents.push(doc) if cacheable?
       end
 
+      private
+
       def _session
         @criteria.send(:_session)
       end