mongoid 7.0.13 → 8.0.8

data/lib/mongoid/persistence_context.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Mongoid
 
   # Object encapsulating logic for setting/getting a collection and database name
   # and a client with particular options to use when persisting models.
-  #
-  # @since 6.0.0
   class PersistenceContext
     extend Forwardable
 
@@ -16,8 +16,6 @@ module Mongoid
     # The options defining this persistence context.
     #
     # @return [ Hash ] The persistence context options.
-    #
-    # @since 6.0.0
     attr_reader :options
 
     # Extra options in addition to driver client options that determine the
@@ -25,8 +23,6 @@ module Mongoid
     #
     # @return [ Array<Symbol> ] The list of extra options besides client options
     #   that determine the persistence context.
-    #
-    # @since 6.0.0
     EXTRA_OPTIONS = [ :client,
                       :collection
                     ].freeze
@@ -35,8 +31,6 @@ module Mongoid
     #
     # @return [ Array<Symbol> ] The full list of options defining the persistence
     #   context.
-    #
-    # @since 6.0.0
     VALID_OPTIONS = ( Mongo::Client::VALID_OPTIONS + EXTRA_OPTIONS ).freeze
 
     # Initialize the persistence context object.
@@ -47,8 +41,6 @@ module Mongoid
     # @param [ Object ] object The class or model instance for which a persistence context
     #   should be created.
     # @param [ Hash ] opts The persistence context options.
-    #
-    # @since 6.0.0
     def initialize(object, opts = {})
       @object = object
       set_options!(opts)
@@ -64,10 +56,10 @@ module Mongoid
     #
     # @return [ Mongo::Collection ] The collection for this persistence
     #   context.
-    #
-    # @since 6.0.0
     def collection(parent = nil)
-      parent ? parent.collection.with(client_options) : client[collection_name.to_sym]
+      parent ?
+        parent.collection.with(client_options.except(:database, "database")) :
+        client[collection_name.to_sym]
     end
 
     # Get the collection name for this persistence context.
@@ -77,8 +69,6 @@ module Mongoid
     #
     # @return [ String ] The collection name for this persistence
     #  context.
-    #
-    # @since 6.0.0
     def collection_name
       @collection_name ||= (__evaluate__(options[:collection] ||
                              storage_options[:collection]))
@@ -91,8 +81,6 @@ module Mongoid
     #
     # @return [ String ] The database name for this persistence
     #  context.
-    #
-    # @since 6.0.0
     def database_name
       __evaluate__(database_name_option) || client.database.name
     end
@@ -104,16 +92,17 @@ module Mongoid
     #
     # @return [ Mongo::Client ] The client for this persistence
     #  context.
-    #
-    # @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
@@ -129,14 +118,27 @@ module Mongoid
     #
     # @param [ Object ] other The object to be compared with this one.
     #
-    # @return [ true, false ] Whether the two persistence contexts are equal.
-    #
-    # @since 6.0.0
+    # @return [ true | false ] Whether the two persistence contexts are equal.
     def ==(other)
       return false unless other.is_a?(PersistenceContext)
       options == other.options
     end
 
+    # Whether the client of the context can be reused later, and therefore should
+    # not be closed.
+    #
+    # If the persistence context is requested with :client option only, it means
+    # that the context should use a client configured in mongoid.yml.
+    # Such clients should not be closed when the context is cleared since they
+    # will be reused later.
+    #
+    # @return [ true | false ] True if client can be reused, otherwise false.
+    #
+    # @api private
+    def reusable_client?
+      @options.keys == [:client]
+    end
+
     private
 
     def set_options!(opts)
@@ -154,9 +156,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
@@ -176,15 +184,12 @@ module Mongoid
       #  PersistenceContext.set(model)
       #
       # @param [ Object ] object The class or model instance.
-      # @param [ Hash, Mongoid::PersistenceContext ] options_or_context The persistence
+      # @param [ Hash | Mongoid::PersistenceContext ] options_or_context The persistence
       #   options or a persistence context object.
       #
       # @return [ Mongoid::PersistenceContext ] The persistence context for the object.
-      #
-      # @since 6.0.0
       def set(object, options_or_context)
-        key = "[mongoid][#{object.object_id}]:context"
-        existing_context = Thread.current[key]
+        existing_context = get_context(object)
         existing_options = if existing_context
           existing_context.options
         else
@@ -195,7 +200,7 @@ module Mongoid
         end
         new_options = existing_options.merge(options_or_context)
         context = PersistenceContext.new(object, new_options)
-        Thread.current[key] = context
+        store_context(object, context)
       end
 
       # Get the persistence context for a particular class or model instance.
@@ -206,10 +211,8 @@ module Mongoid
       # @param [ Object ] object The class or model instance.
       #
       # @return [ Mongoid::PersistenceContext ] The persistence context for the object.
-      #
-      # @since 6.0.0
       def get(object)
-        Thread.current["[mongoid][#{object.object_id}]:context"]
+        get_context(object)
       end
 
       # Clear the persistence context for a particular class or model instance.
@@ -217,18 +220,55 @@ module Mongoid
       # @example Clear the persistence context for a class or model instance.
       #  PersistenceContext.clear(model)
       #
-      # @param [ Class, Object ] object The class or model instance.
+      # @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, original_context = nil)
         if context = get(object)
-          context.client.close unless (context.cluster.equal?(cluster) || cluster.nil?)
+          unless cluster.nil? || context.cluster.equal?(cluster)
+            context.client.close unless context.reusable_client?
+          end
         end
       ensure
-        Thread.current["[mongoid][#{object.object_id}]:context"] = original_context
+        store_context(object, original_context)
+      end
+
+      private
+
+      # Key to store persistence contexts in the thread local storage.
+      #
+      # @api private
+      PERSISTENCE_CONTEXT_KEY = :"[mongoid]:persistence_context"
+
+      # Get the persistence context for a given object from the thread local
+      #   storage.
+      #
+      # @param [ Object ] object Object to get the persistance context for.
+      #
+      # @return [ Mongoid::PersistenceContext | nil ] The persistence context
+      #   for the object if previously stored, otherwise nil.
+      #
+      # @api private
+      def get_context(object)
+        Thread.current[PERSISTENCE_CONTEXT_KEY] ||= {}
+        Thread.current[PERSISTENCE_CONTEXT_KEY][object.object_id]
+      end
+
+      # Store persistence context for a given object in the thread local
+      #   storage.
+      #
+      # @param [ Object ] object Object to store the persistance context for.
+      # @param [ Mongoid::PersistenceContext ] context Context to store
+      #
+      # @api private
+      def store_context(object, context)
+        if context.nil?
+          Thread.current[PERSISTENCE_CONTEXT_KEY]&.delete(object.object_id)
+        else
+          Thread.current[PERSISTENCE_CONTEXT_KEY] ||= {}
+          Thread.current[PERSISTENCE_CONTEXT_KEY][object.object_id] = context
+        end
       end
     end
   end

data/lib/mongoid/positional.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
   # This module is responsible for taking update selectors and switching out
   # the indexes for the $ positional operator where appropriate.
-  #
-  # @since 4.0.0
   module Positional
 
     # Takes the provided selector and atomic operations and replaces the
@@ -31,8 +30,6 @@ module Mongoid
     # @param [ Hash ] processed The processed update operations.
     #
     # @return [ Hash ] The new operations.
-    #
-    # @since 3.1.0
     def positionally(selector, operations, processed = {})
       if selector.size == 1 || selector.values.any? { |val| val.nil? }
         return operations

data/lib/mongoid/query_cache.rb

@@ -1,23 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
   # A cache of database queries on a per-request basis.
-  #
-  # @since 4.0.0
   module QueryCache
-    class << self
 
-      # Get the cached queries.
-      #
-      # @example Get the cached queries from the current thread.
-      #   QueryCache.cache_table
-      #
-      # @return [ Hash ] The hash of cached queries.
-      #
-      # @since 4.0.0
-      def cache_table
-        Thread.current["[mongoid]:query_cache"] ||= {}
-      end
+    class << self
 
       # Clear the query cache.
       #
@@ -25,10 +13,8 @@ module Mongoid
       #   QueryCache.clear_cache
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 4.0.0
       def clear_cache
-        Thread.current["[mongoid]:query_cache"] = nil
+        Mongo::QueryCache.clear
       end
 
       # Set whether the cache is enabled.
@@ -36,11 +22,9 @@ module Mongoid
       # @example Set if the cache is enabled.
       #   QueryCache.enabled = true
       #
-      # @param [ true, false ] value The enabled value.
-      #
-      # @since 4.0.0
+      # @param [ true | false ] value The enabled value.
       def enabled=(value)
-        Thread.current["[mongoid]:query_cache:enabled"] = value
+        Mongo::QueryCache.enabled = value
       end
 
       # Is the query cache enabled on the current thread?
@@ -48,11 +32,9 @@ module Mongoid
       # @example Is the query cache enabled?
       #   QueryCache.enabled?
       #
-      # @return [ true, false ] If the cache is enabled.
-      #
-      # @since 4.0.0
+      # @return [ true | false ] If the cache is enabled.
       def enabled?
-        !!Thread.current["[mongoid]:query_cache:enabled"]
+        Mongo::QueryCache.enabled?
       end
 
       # Execute the block while using the query cache.
@@ -61,14 +43,8 @@ module Mongoid
       #   QueryCache.cache { collection.find }
       #
       # @return [ Object ] The result of the block.
-      #
-      # @since 4.0.0
-      def cache
-        enabled = QueryCache.enabled?
-        QueryCache.enabled = true
-        yield
-      ensure
-        QueryCache.enabled = enabled
+      def cache(&block)
+        Mongo::QueryCache.cache(&block)
       end
 
       # Execute the block with the query cache disabled.
@@ -77,255 +53,12 @@ module Mongoid
       #   QueryCache.uncached { collection.find }
       #
       # @return [ Object ] The result of the block.
-      def uncached
-        enabled = QueryCache.enabled?
-        QueryCache.enabled = false
-        yield
-      ensure
-        QueryCache.enabled = enabled
-      end
-    end
-
-    # The middleware to be added to a rack application in order to activate the
-    # query cache.
-    #
-    # @since 4.0.0
-    class Middleware
-
-      # Instantiate the middleware.
-      #
-      # @example Create the new middleware.
-      #   Middleware.new(app)
-      #
-      # @param [ Object ] app The rack applciation stack.
-      #
-      # @since 4.0.0
-      def initialize(app)
-        @app = app
-      end
-
-      # Execute the request, wrapping in a query cache.
-      #
-      # @example Execute the request.
-      #   middleware.call(env)
-      #
-      # @param [ Object ] env The environment.
-      #
-      # @return [ Object ] The result of the call.
-      #
-      # @since 4.0.0
-      def call(env)
-        QueryCache.cache { @app.call(env) }
-      ensure
-        QueryCache.clear_cache
-      end
-    end
-
-    # A Cursor that attempts to load documents from memory first before hitting
-    # the database if the same query has already been executed.
-    #
-    # @since 5.0.0
-    class CachedCursor < Mongo::Cursor
-
-      # We iterate over the cached documents if they exist already in the
-      # cursor otherwise proceed as normal.
-      #
-      # @example Iterate over the documents.
-      #   cursor.each do |doc|
-      #     # ...
-      #   end
-      #
-      # @since 5.0.0
-      def each
-        if @cached_documents
-          @cached_documents.each do |doc|
-            yield doc
-          end
-        else
-          super
-        end
-      end
-
-      # Get a human-readable string representation of +Cursor+.
-      #
-      # @example Inspect the cursor.
-      #   cursor.inspect
-      #
-      # @return [ String ] A string representation of a +Cursor+ instance.
-      #
-      # @since 2.0.0
-      def inspect
-        "#<Mongoid::QueryCache::CachedCursor:0x#{object_id} @view=#{@view.inspect}>"
-      end
-
-      private
-
-      def process(result)
-        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
-    # operations.
-    #
-    # @since 4.0.0
-    module Base
-
-      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
-
-          alias_method "#{method_name}_without_clear_cache", method_name
-          alias_method method_name, "#{method_name}_with_clear_cache"
-        end
+      def uncached(&block)
+        Mongo::QueryCache.uncached(&block)
       end
     end
 
-    # Contains enhancements to the Mongo::Collection::View in order to get a
-    # cached cursor or a regular cursor on iteration.
-    #
-    # @since 5.0.0
-    module View
-      extend ActiveSupport::Concern
-
-      included do
-        extend QueryCache::Base
-        alias_query_cache_clear :delete_one,
-                                :delete_many,
-                                :update_one,
-                                :update_many,
-                                :replace_one,
-                                :find_one_and_delete,
-                                :find_one_and_replace,
-                                :find_one_and_update
-      end
-
-      # Override the default enumeration to handle if the cursor can be cached
-      # or not.
-      #
-      # @example Iterate over the view.
-      #   view.each do |doc|
-      #     # ...
-      #   end
-      #
-      # @since 5.0.0
-      def each
-        if system_collection? || !QueryCache.enabled? || (respond_to?(:write?, true) && write?)
-          super
-        else
-          @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
-
-          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
-
-      private
-
-      def cached_cursor
-        if limit
-          key = [ collection.namespace, selector, nil, skip, sort, projection, collation  ]
-          cursor = QueryCache.cache_table[key]
-        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 =~ /\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.
-    #
-    # @since 5.0.0
-    module Collection
-      extend ActiveSupport::Concern
-
-      included do
-        extend QueryCache::Base
-        alias_query_cache_clear :insert_one, :insert_many
-      end
-    end
-
-    # Bypass the query cache when reloading a document.
-    module Document
-      def reload
-        QueryCache.uncached { super }
-      end
-    end
+    Middleware = Mongo::QueryCache::Middleware
   end
 end
 
-Mongo::Collection.__send__(:include, Mongoid::QueryCache::Collection)
-Mongo::Collection::View.__send__(:include, Mongoid::QueryCache::View)
-Mongoid::Document.__send__(:include, Mongoid::QueryCache::Document)

data/lib/mongoid/railtie.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "rails"
 require "rails/mongoid"
 
@@ -6,8 +7,6 @@ module Rails
   module Mongoid
 
     # Hooks Mongoid into Rails 3 and higher.
-    #
-    # @since 2.0.0
     class Railtie < Rails::Railtie
 
       # Mapping of rescued exceptions to HTTP responses
@@ -16,8 +15,6 @@ module Rails
       #   railtie.rescue_responses
       #
       # @ return [Hash] rescued responses
-      #
-      # @since 2.4.3
       def self.rescue_responses
         {
           "Mongoid::Errors::DocumentNotFound" => :not_found,
@@ -40,17 +37,13 @@ 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
-      #
-      # @since 2.0.0
       config.mongoid = ::Mongoid::Config
 
       # Initialize Mongoid. This will look for a mongoid.yml in the config
       # directory and configure mongoid appropriately.
-      #
-      # @since 2.0.0
       initializer "mongoid.load-config" do
         config_file = Rails.root.join("config", "mongoid.yml")
         if config_file.file?
@@ -70,8 +63,6 @@ module Rails
 
       # Set the proper error types for Rails. DocumentNotFound errors should be
       # 404s and not 500s, validation errors are 422s.
-      #
-      # @since 2.0.0
       config.after_initialize do
         unless config.action_dispatch.rescue_responses
           ActionDispatch::ShowExceptions.rescue_responses.update(Railtie.rescue_responses)
@@ -84,8 +75,6 @@ module Rails
       #
       # This will happen for every request in development, once in other
       # environments.
-      #
-      # @since 2.0.0
       initializer "mongoid.preload-models" do |app|
         config.to_prepare do
           ::Rails::Mongoid.preload_models(app)
@@ -96,8 +85,6 @@ module Rails
       # code, so we have no way in the intitializer to know if we are
       # generating a mongoid.yml. So instead of failing, we catch all the
       # errors and print them out.
-      #
-      # @since 3.0.0
       def handle_configuration_error(e)
         puts "There is a configuration error with the current mongoid.yml."
         puts e.message

data/lib/mongoid/railties/controller_runtime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Railties
     module ControllerRuntime
@@ -60,7 +62,7 @@ module Mongoid
         def started _; end
 
         def _completed e
-          Collector.runtime += e.duration
+          Collector.runtime += e.duration * 1000
         end
         alias :succeeded :_completed
         alias :failed :_completed
@@ -83,4 +85,4 @@ module Mongoid
 
     end
   end
-end
+end