mongoid 6.4.4 → 7.1.7

data/lib/mongoid/persistence_context.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
 
   # Object encapsulating logic for setting/getting a collection and database name
@@ -107,13 +110,22 @@ module Mongoid
     #
     # @since 6.0.0
     def client
-      client_options = send(:client_options)
-      if client_options[:read].is_a?(Symbol)
-        client_options = client_options.merge(read: {mode: client_options[:read]})
+      @client ||= begin
+        client = Clients.with_name(client_name)
+        if database_name_option
+          client = client.use(database_name)
+        end
+        unless client_options.empty?
+          client = client.with(client_options)
+        end
+        client
       end
-      @client ||= (client = Clients.with_name(client_name)
-                    client = client.use(database_name) if database_name_option
-                    client.with(client_options))
+    end
+
+    def client_name
+      @client_name ||= options[:client] ||
+                         Threaded.client_override ||
+                         storage_options && __evaluate__(storage_options[:client])
     end
 
     # Determine if this persistence context is equal to another.
@@ -133,12 +145,6 @@ module Mongoid
 
     private
 
-    def client_name
-      @client_name ||= options[:client] ||
-                         Threaded.client_override ||
-                         storage_options && __evaluate__(storage_options[:client])
-    end
-
     def set_options!(opts)
       @options ||= opts.each.reduce({}) do |_options, (key, value)|
                      unless VALID_OPTIONS.include?(key.to_sym)
@@ -154,9 +160,15 @@ module Mongoid
     end
 
     def client_options
-      @client_options ||= options.select do |k, v|
-                            Mongo::Client::VALID_OPTIONS.include?(k.to_sym)
-                          end
+      @client_options ||= begin
+        opts = options.select do |k, v|
+                              Mongo::Client::VALID_OPTIONS.include?(k.to_sym)
+                            end
+        if opts[:read].is_a?(Symbol)
+          opts[:read] = {mode: opts[:read]}
+        end
+        opts
+      end
     end
 
     def database_name_option
@@ -169,6 +181,9 @@ module Mongoid
 
       # Set the persistence context for a particular class or model instance.
       #
+      # If there already is a persistence context set, options in the existing
+      # context are combined with options given to the set call.
+      #
       # @example Set the persistence context for a class or model instance.
       #  PersistenceContext.set(model)
       #
@@ -180,9 +195,19 @@ module Mongoid
       #
       # @since 6.0.0
       def set(object, options_or_context)
-        context = PersistenceContext.new(object, options_or_context.is_a?(PersistenceContext) ?
-                                                   options_or_context.options : options_or_context)
-        Thread.current["[mongoid][#{object.object_id}]:context"] = context
+        key = "[mongoid][#{object.object_id}]:context"
+        existing_context = Thread.current[key]
+        existing_options = if existing_context
+          existing_context.options
+        else
+          {}
+        end
+        if options_or_context.is_a?(PersistenceContext)
+          options_or_context = options_or_context.options
+        end
+        new_options = existing_options.merge(options_or_context)
+        context = PersistenceContext.new(object, new_options)
+        Thread.current[key] = context
       end
 
       # Get the persistence context for a particular class or model instance.
@@ -206,14 +231,16 @@ module Mongoid
       #
       # @param [ Class, Object ] object The class or model instance.
       # @param [ Mongo::Cluster ] cluster The original cluster before this context was used.
+      # @param [ Mongoid::PersistenceContext ] original_context The original persistence
+      #   context that was set before this context was used.
       #
       # @since 6.0.0
-      def clear(object, cluster = nil)
+      def clear(object, cluster = nil, original_context = nil)
         if context = get(object)
           context.client.close unless (context.cluster.equal?(cluster) || cluster.nil?)
         end
       ensure
-        Thread.current["[mongoid][#{object.object_id}]:context"] = nil
+        Thread.current["[mongoid][#{object.object_id}]:context"] = original_context
       end
     end
   end

data/lib/mongoid/positional.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # This module is responsible for taking update selectors and switching out
@@ -64,7 +66,7 @@ module Mongoid
       matches = position.scan(/\.\d+\./)
       if matches.size == 1
         keys.each do |kk|
-          if position =~ /^#{kk}\.\d+\.(.*)/
+          if position =~ /\A#{kk}\.\d+\.(.*)\z/
             return "#{kk}.$.#{$1}"
           end
         end

data/lib/mongoid/query_cache.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # A cache of database queries on a per-request basis.
@@ -138,7 +140,9 @@ module Mongoid
       # @since 5.0.0
       def each
         if @cached_documents
-          @cached_documents.each{ |doc| yield doc }
+          @cached_documents.each do |doc|
+            yield doc
+          end
         else
           super
         end
@@ -159,16 +163,19 @@ module Mongoid
       private
 
       def process(result)
-        @remaining -= result.returned_count if limited?
-        @cursor_id = result.cursor_id
-        @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
-        documents = result.documents
-        (@cached_documents ||= []).concat(documents)
+        documents = super
+
+        if @cursor_id.zero? && !@after_first_batch
+          @cached_documents ||= []
+          @cached_documents.concat(documents)
+        end
+
+        @after_first_batch = true
         documents
       end
     end
 
-    # Included to add behaviour for clearing out the query cache on certain
+    # Included to add behavior for clearing out the query cache on certain
     # operations.
     #
     # @since 4.0.0
@@ -176,12 +183,10 @@ module Mongoid
 
       def alias_query_cache_clear(*method_names)
         method_names.each do |method_name|
-          class_eval <<-CODE, __FILE__, __LINE__ + 1
-              def #{method_name}_with_clear_cache(*args)
-                QueryCache.clear_cache
-                #{method_name}_without_clear_cache(*args)
-              end
-            CODE
+          define_method("#{method_name}_with_clear_cache") do |*args|
+            QueryCache.clear_cache
+            send("#{method_name}_without_clear_cache", *args)
+          end
 
           alias_method "#{method_name}_without_clear_cache", method_name
           alias_method method_name, "#{method_name}_with_clear_cache"
@@ -218,20 +223,40 @@ module Mongoid
       #
       # @since 5.0.0
       def each
-        if system_collection? || !QueryCache.enabled?
+        if system_collection? || !QueryCache.enabled? || (respond_to?(:write?, true) && write?)
           super
         else
-          unless cursor = cached_cursor
-            read_with_retry do
-              server = server_selector.select_server(cluster)
-              cursor = CachedCursor.new(view, send_initial_query(server), server)
-              QueryCache.cache_table[cache_key] = cursor
+          @cursor = nil
+          unless @cursor = cached_cursor
+
+            if driver_supports_cursor_sessions?
+              session = client.send(:get_session, @options)
+              read_with_retry(session, server_selector) do |server|
+                result = send_initial_query(server, session)
+                @cursor = get_cursor(result, server, session)
+              end
+            else
+              read_with_retry do
+                server = server_selector.select_server(cluster)
+                result = send_initial_query(server)
+                @cursor = get_cursor(result, server)
+              end
             end
           end
-          cursor.each do |doc|
-            yield doc
-          end if block_given?
-          cursor
+
+          if block_given?
+            if limit && limit != -1
+              @cursor.to_a[0...limit].each do |doc|
+                yield doc
+              end
+            else
+              @cursor.each do |doc|
+                yield doc
+              end
+            end
+          else
+            @cursor.to_enum
+          end
         end
       end
 
@@ -241,24 +266,46 @@ module Mongoid
         if limit
           key = [ collection.namespace, selector, nil, skip, sort, projection, collation  ]
           cursor = QueryCache.cache_table[key]
-          if cursor
-            limited_docs = cursor.to_a[0...limit.abs]
-            cursor.instance_variable_set(:@cached_documents, limited_docs)
-          end
         end
         cursor || QueryCache.cache_table[cache_key]
       end
 
+      def get_cursor(result, server, session = nil)
+        if result.cursor_id == 0 || result.cursor_id.nil?
+          cursor = if session
+            CachedCursor.new(view, result, server, session: session)
+          else
+            CachedCursor.new(view, result, server)
+          end
+
+          QueryCache.cache_table[cache_key] = cursor
+        else
+          cursor = if session
+            Mongo::Cursor.new(view, result, server, session: session)
+          else
+            Mongo::Cursor.new(view, result, server)
+          end
+        end
+
+        cursor
+      end
+
       def cache_key
         [ collection.namespace, selector, limit, skip, sort, projection, collation ]
       end
 
       def system_collection?
-        collection.namespace =~ /^system./
+        collection.namespace =~ /\Asystem./
+      end
+
+      def driver_supports_cursor_sessions?
+        # Driver versions 2.9 and newer support passing in a session to the
+        # cursor object.
+        (Mongo::VERSION.split('.').map(&:to_i) <=> [2, 9, 0]) > 0
       end
     end
 
-    # Adds behaviour to the query cache for collections.
+    # Adds behavior to the query cache for collections.
     #
     # @since 5.0.0
     module Collection

data/lib/mongoid/railtie.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "rails"
 require "rails/mongoid"
 
@@ -40,7 +42,7 @@ module Rails
       # @example Set up configuration in the Rails app.
       #   module MyApplication
       #     class Application < Rails::Application
-      #       config.mongoid.logger = Logger.new($stdout, :warn)
+      #       config.mongoid.logger = Logger.new(STDERR, :warn)
       #     end
       #   end
       #

data/lib/mongoid/railties/controller_runtime.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Railties
     module ControllerRuntime
@@ -83,4 +86,4 @@ module Mongoid
 
     end
   end
-end
+end

data/lib/mongoid/railties/database.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 load 'mongoid/tasks/database.rake'
 
 namespace :db do
@@ -58,13 +60,20 @@ namespace :db do
   end
 
   unless Rake::Task.task_defined?("db:create_indexes")
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => "mongoid:create_indexes"
   end
 
   unless Rake::Task.task_defined?("db:remove_indexes")
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => "mongoid:remove_indexes"
   end
 
+  unless Rake::Task.task_defined?("db:shard_collections")
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => "mongoid:shard_collections"
+  end
+
   namespace :mongoid do
     task :load_models do
       ::Rails.application.eager_load! if defined?(::Rails)

data/lib/mongoid/reloadable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module handles reloading behaviour of documents.
+  # This module handles reloading behavior of documents.
   #
   # @since 4.0.0
   module Reloadable
@@ -37,7 +39,7 @@ module Mongoid
     private
 
     # Reload the document, determining if it's embedded or not and what
-    # behaviour to use.
+    # behavior to use.
     #
     # @example Reload the document.
     #   document._reload

data/lib/mongoid/scopable.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
 
 module Mongoid
 
-  # This module contains behaviour for all Mongoid scoping - named scopes,
+  # This module contains behavior for all Mongoid scoping - named scopes,
   # default scopes, and criteria accessors via scoped and unscoped.
   #
   # @since 4.0.0

data/lib/mongoid/selectable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Provides behaviour for generating the selector for a specific document.
+  # Provides behavior for generating the selector for a specific document.
   #
   # @since 4.0.0
   module Selectable

data/lib/mongoid/serializable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module provides the extra behaviour for including relations in JSON
+  # This module provides the extra behavior for including associations in JSON
   # and XML serialization.
   #
   # @since 4.0.0
@@ -11,8 +13,16 @@ module Mongoid
     # We need to redefine where the JSON configuration is getting defined,
     # similar to +ActiveRecord+.
     included do
-      undef_method :include_root_in_json
-      delegate :include_root_in_json, to: ::Mongoid
+
+      class << self
+        # Note that this intentionally only delegates :include_root_in_json
+        # and not :include_root_in_json? - delegating the latter produces
+        # wrong behavior.
+        # Also note that this intentionally uses the ActiveSupport delegation
+        # functionality and not the Ruby standard library one.
+        # See https://jira.mongodb.org/browse/MONGOID-4849.
+        delegate :include_root_in_json, to: ::Mongoid
+      end
     end
 
     # Gets the document as a serializable hash, used by ActiveModel's JSON
@@ -26,7 +36,7 @@ module Mongoid
     #
     # @param [ Hash ] options The options to pass.
     #
-    # @option options [ Symbol ] :include What relations to include.
+    # @option options [ Symbol ] :include What associations to include.
     # @option options [ Symbol ] :only Limit the fields to only these.
     # @option options [ Symbol ] :except Dont include these fields.
     # @option options [ Symbol ] :methods What methods to include.
@@ -80,7 +90,7 @@ module Mongoid
       names
     end
 
-    # Serialize a single attribute. Handles relations, fields, and dynamic
+    # Serialize a single attribute. Handles associations, fields, and dynamic
     # attributes.
     #
     # @api private
@@ -101,22 +111,22 @@ module Mongoid
         value = send(name)
         attrs[name] = value ? value.serializable_hash(options) : nil
       elsif names.include?(name) && !fields.key?(name)
-        attrs[name] = read_attribute(name)
+        attrs[name] = read_raw_attribute(name)
       elsif !attribute_missing?(name)
         attrs[name] = send(name)
       end
     end
 
-    # For each of the provided include options, get the relation needed and
+    # For each of the provided include options, get the association needed and
     # provide it in the hash.
     #
-    # @example Serialize the included relations.
+    # @example Serialize the included associations.
     #   document.serialize_relations({}, :include => :addresses)
     #
     # @param [ Hash ] attributes The attributes to serialize.
     # @param [ Hash ] options The serialization options.
     #
-    # @option options [ Symbol ] :include What relations to include
+    # @option options [ Symbol ] :include What associations to include
     # @option options [ Symbol ] :only Limit the fields to only these.
     # @option options [ Symbol ] :except Dont include these fields.
     #
@@ -124,9 +134,9 @@ module Mongoid
     def serialize_relations(attributes = {}, options = {})
       inclusions = options[:include]
       relation_names(inclusions).each do |name|
-        metadata = relations[name.to_s]
-        if metadata && relation = send(metadata.name)
-          attributes[metadata.name.to_s] =
+        association = relations[name.to_s]
+        if association && relation = send(association.name)
+          attributes[association.name.to_s] =
             relation.serializable_hash(relation_options(inclusions, options, name))
         end
       end
@@ -135,12 +145,12 @@ module Mongoid
     # Since the inclusions can be a hash, symbol, or array of symbols, this is
     # provided as a convenience to parse out the names.
     #
-    # @example Get the relation names.
+    # @example Get the association names.
     #   document.relation_names(:include => [ :addresses ])
     #
     # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     #
-    # @return [ Array<Symbol> ] The names of the included relations.
+    # @return [ Array<Symbol> ] The names of the included associations.
     #
     # @since 2.0.0.rc.6
     def relation_names(inclusions)
@@ -150,14 +160,14 @@ module Mongoid
     # Since the inclusions can be a hash, symbol, or array of symbols, this is
     # provided as a convenience to parse out the options.
     #
-    # @example Get the relation options.
+    # @example Get the association options.
     #   document.relation_names(:include => [ :addresses ])
     #
     # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     # @param [ Hash ] options The options.
-    # @param [ Symbol ] name The name of the relation.
+    # @param [ Symbol ] name The name of the association.
     #
-    # @return [ Hash ] The options for the relation.
+    # @return [ Hash ] The options for the association.
     #
     # @since 2.0.0.rc.6
     def relation_options(inclusions, options, name)