mongoid 7.4.0 → 8.0.3

data/lib/mongoid/query_cache.rb

@@ -4,28 +4,8 @@ module Mongoid
 
   # A cache of database queries on a per-request basis.
   module QueryCache
-    # @api private
-    LEGACY_WARNING = <<~DOC
-      You are using the legacy Mongoid query cache which has known issues.
-      Please upgrade the `mongo' gem to at least 2.14.0 to use the improved driver query cache.
-      Refer to: https://docs.mongodb.com/mongoid/current/tutorials/mongoid-queries/#the-improved-driver-query-cache
-    DOC
 
     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.
-      # @api private
-      def cache_table
-        if defined?(Mongo::QueryCache)
-          raise NotImplementedError, "Mongoid does not expose driver's query cache table"
-        else
-          Thread.current["[mongoid]:query_cache"] ||= {}
-        end
-      end
 
       # Clear the query cache.
       #
@@ -34,11 +14,7 @@ module Mongoid
       #
       # @return [ nil ] Always nil.
       def clear_cache
-        if defined?(Mongo::QueryCache)
-          Mongo::QueryCache.clear
-        else
-          Thread.current["[mongoid]:query_cache"] = nil
-        end
+        Mongo::QueryCache.clear
       end
 
       # Set whether the cache is enabled.
@@ -46,13 +22,9 @@ module Mongoid
       # @example Set if the cache is enabled.
       #   QueryCache.enabled = true
       #
-      # @param [ true, false ] value The enabled value.
+      # @param [ true | false ] value The enabled value.
       def enabled=(value)
-        if defined?(Mongo::QueryCache)
-          Mongo::QueryCache.enabled = value
-        else
-          Thread.current["[mongoid]:query_cache:enabled"] = value
-        end
+        Mongo::QueryCache.enabled = value
       end
 
       # Is the query cache enabled on the current thread?
@@ -60,13 +32,9 @@ module Mongoid
       # @example Is the query cache enabled?
       #   QueryCache.enabled?
       #
-      # @return [ true, false ] If the cache is enabled.
+      # @return [ true | false ] If the cache is enabled.
       def enabled?
-        if defined?(Mongo::QueryCache)
-          Mongo::QueryCache.enabled?
-        else
-          !!Thread.current["[mongoid]:query_cache:enabled"]
-        end
+        Mongo::QueryCache.enabled?
       end
 
       # Execute the block while using the query cache.
@@ -76,21 +44,7 @@ module Mongoid
       #
       # @return [ Object ] The result of the block.
       def cache(&block)
-        if defined?(Mongo::QueryCache)
-          Mongo::QueryCache.cache(&block)
-        else
-          @legacy_query_cache_warned ||= begin
-            Mongoid.logger.warn(LEGACY_WARNING)
-            true
-          end
-          enabled = QueryCache.enabled?
-          QueryCache.enabled = true
-          begin
-            yield
-          ensure
-            QueryCache.enabled = enabled
-          end
-        end
+        Mongo::QueryCache.cache(&block)
       end
 
       # Execute the block with the query cache disabled.
@@ -100,217 +54,11 @@ module Mongoid
       #
       # @return [ Object ] The result of the block.
       def uncached(&block)
-        if defined?(Mongo::QueryCache)
-          Mongo::QueryCache.uncached(&block)
-        else
-          enabled = QueryCache.enabled?
-          QueryCache.enabled = false
-          begin
-            yield
-          ensure
-            QueryCache.enabled = enabled
-          end
-        end
-      end
-    end
-
-    if defined?(Mongo::QueryCache::Middleware)
-      Middleware = Mongo::QueryCache::Middleware
-    else
-      # The middleware to be added to a rack application in order to activate the
-      # query cache.
-      class Middleware
-
-        # Instantiate the middleware.
-        #
-        # @example Create the new middleware.
-        #   Middleware.new(app)
-        #
-        # @param [ Object ] app The rack application stack.
-        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.
-        def call(env)
-          QueryCache.cache do
-            @app.call(env)
-          end
-        ensure
-          QueryCache.clear_cache
-        end
-      end
-    end
-
-    # A Cursor that attempts to load documents from memory first before hitting
-    # the database if the same query has already been executed.
-    # @deprecated This class is only used with driver versions 2.13 and lower.
-    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
-      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.
-      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 behavior for clearing out the query cache on certain
-    # operations.
-    # @deprecated This module is only used with driver versions 2.13 and lower.
-    module Base
-
-      def alias_query_cache_clear(*method_names)
-        method_names.each do |method_name|
-          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"
-        end
+        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.
-    # @deprecated This module is only used with driver versions 2.13 and lower.
-    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
-      def each
-        if system_collection? || !QueryCache.enabled? || (respond_to?(:write?, true) && write?)
-          super
-        else
-          @cursor = nil
-          unless @cursor = cached_cursor
-            session = client.send(:get_session, @options)
-            read_with_retry(session, server_selector) do |server|
-              result = send_initial_query(server, session)
-              if result.cursor_id == 0 || result.cursor_id.nil?
-                @cursor = CachedCursor.new(view, result, server, session: session)
-                QueryCache.cache_table[cache_key] = @cursor
-              else
-                @cursor = Mongo::Cursor.new(view, result, server, session: session)
-              end
-            end
-          end
-          if block_given?
-            if limit
-              @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 cache_key
-        [ collection.namespace, selector, limit, skip, sort, projection, collation ]
-      end
-
-      def system_collection?
-        collection.name.start_with?('system.')
-      end
-    end
-
-    # Adds behavior to the query cache for collections.
-    # @deprecated This module is only used with driver versions 2.13 and lower.
-    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
 
-unless defined?(Mongo::QueryCache)
-  Mongo::Collection.__send__(:include, Mongoid::QueryCache::Collection)
-  Mongo::Collection::View.__send__(:include, Mongoid::QueryCache::View)
-  Mongoid::Document.__send__(:include, Mongoid::QueryCache::Document)
-end

data/lib/mongoid/railties/controller_runtime.rb

@@ -62,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

data/lib/mongoid/reloadable.rb

@@ -23,11 +23,15 @@ module Mongoid
 
       reloaded = _reload
       if Mongoid.raise_not_found_error && (reloaded.nil? || reloaded.empty?)
-        raise Errors::DocumentNotFound.new(self.class, _id, _id)
+        shard_keys = atomic_selector.with_indifferent_access.slice(*shard_key_fields, :_id)
+        raise Errors::DocumentNotFound.new(self.class, _id, shard_keys)
       end
       @attributes = reloaded
-      @attributes_before_type_cast = {}
-      changed_attributes.clear
+      @attributes_before_type_cast = @attributes.dup
+      @changed_attributes = {}
+      @previous_changes = {}
+      @previous_attributes = {}
+      @previously_new_record = false
       reset_readonly
       apply_defaults
       reload_relations

data/lib/mongoid/scopable.rb

@@ -23,7 +23,7 @@ module Mongoid
     # @example Apply the default scoping.
     #   document.apply_default_scoping
     #
-    # @return [ true, false ] If default scoping was applied.
+    # @return [ true | false ] If default scoping was applied.
     def apply_default_scoping
       if default_scoping
         default_scoping.call.selector.each do |field, value|
@@ -74,7 +74,7 @@ module Mongoid
       #     default_scope ->{ where(active: true) }
       #   end
       #
-      # @param [ Proc, Criteria ] value The default scope.
+      # @param [ Proc | Criteria ] value The default scope.
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a proc or criteria.
       #
@@ -90,7 +90,7 @@ module Mongoid
       # @example Can the default scope be applied?
       #   Band.default_scopable?
       #
-      # @return [ true, false ] If the default scope can be applied.
+      # @return [ true | false ] If the default scope can be applied.
       def default_scopable?
         default_scoping? && !Threaded.without_default_scope?(self)
       end
@@ -168,9 +168,11 @@ module Mongoid
       #     Band.where(name: "Depeche Mode")
       #   end
       #
-      # @note This will force the default scope to be removed.
+      # @note This will force the default scope to be removed, but will not
+      #   remove scopes declared with ``.with_scope``. This will be changed
+      #   in Mongoid 9.
       #
-      # @return [ Criteria, Object ] The unscoped criteria or result of the
+      # @return [ Criteria | Object ] The unscoped criteria or result of the
       #   block.
       def unscoped
         if block_given?
@@ -240,7 +242,7 @@ module Mongoid
       # @example Warn or raise error if name exists.
       #   Model.valid_scope_name?("test")
       #
-      # @param [ String, Symbol ] name The name of the scope.
+      # @param [ String | Symbol ] name The name of the scope.
       #
       # @raise [ Errors::ScopeOverwrite ] If the name exists and configured to
       #   raise the error.
@@ -249,12 +251,12 @@ module Mongoid
           if Mongoid.scope_overwrite_exception
             raise Errors::ScopeOverwrite.new(self.name, name)
           else
-            if Mongoid.logger
-              Mongoid.logger.warn(
-                "Creating scope :#{name}. " +
-                "Overwriting existing method #{self.name}.#{name}."
-              )
-            end
+            Mongoid.logger.warn(
+              "Creating scope :#{name} which conflicts with #{self.name}.#{name}. " +
+              "Calls to `Mongoid::Criteria##{name}` will delegate to " +
+              "`Mongoid::Criteria##{name}` for criteria with klass #{self.name} " +
+              "and will ignore the declared scope."
+            )
           end
         end
       end
@@ -289,15 +291,17 @@ module Mongoid
       # @return [ Method ] The defined method.
       def define_scope_method(name)
         singleton_class.class_eval do
-          define_method(name) do |*args|
-            scoping = _declared_scopes[name]
-            scope = instance_exec(*args, &scoping[:scope])
-            extension = scoping[:extension]
-            to_merge = scope || queryable
-            criteria = to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
-            criteria.extend(extension)
-            criteria
-          end
+          ruby2_keywords(
+            define_method(name) do |*args|
+              scoping = _declared_scopes[name]
+              scope = instance_exec(*args, &scoping[:scope])
+              extension = scoping[:extension]
+              to_merge = scope || queryable
+              criteria = to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
+              criteria.extend(extension)
+              criteria
+            end
+          )
         end
       end
 
@@ -309,7 +313,7 @@ module Mongoid
       # @example Process the default scope.
       #   Model.process_default_scope(value)
       #
-      # @param [ Criteria, Proc ] value The default scope value.
+      # @param [ Criteria | Proc ] value The default scope value.
       def process_default_scope(value)
         if existing = default_scoping
           ->{ existing.call.merge(value.to_proc.call) }

data/lib/mongoid/selectable.rb

@@ -15,8 +15,7 @@ module Mongoid
     #
     # @return [ Hash ] The document's selector.
     def atomic_selector
-      @atomic_selector ||=
-        (embedded? ? embedded_atomic_selector : root_atomic_selector_in_db)
+      embedded? ? embedded_atomic_selector : root_atomic_selector_in_db
     end
 
     private

data/lib/mongoid/serializable.rb

@@ -33,10 +33,14 @@ module Mongoid
     #
     # @param [ Hash ] options The options to pass.
     #
-    # @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.
+    # @option options [ Symbol | String | Array<Symbol | String> ] :except
+    #   Do not include these field(s).
+    # @option options [ Symbol | String | Array<Symbol | String> ] :include
+    #   Which association(s) to include.
+    # @option options [ Symbol | String | Array<Symbol | String> ] :only
+    #   Limit the field(s) to only these.
+    # @option options [ Symbol | String | Array<Symbol | String> ] :methods
+    #   What methods to include.
     #
     # @return [ Hash ] The document, ready to be serialized.
     def serializable_hash(options = nil)
@@ -137,7 +141,7 @@ module Mongoid
     # @example Get the association names.
     #   document.relation_names(:include => [ :addresses ])
     #
-    # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
+    # @param [ Hash | Symbol | Array<Symbol> ] inclusions The inclusions.
     #
     # @return [ Array<Symbol> ] The names of the included associations.
     def relation_names(inclusions)
@@ -150,7 +154,7 @@ module Mongoid
     # @example Get the association options.
     #   document.relation_names(:include => [ :addresses ])
     #
-    # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
+    # @param [ Hash | Symbol | Array<Symbol> ] inclusions The inclusions.
     # @param [ Hash ] options The options.
     # @param [ Symbol ] name The name of the association.
     #

data/lib/mongoid/stateful.rb

@@ -6,7 +6,15 @@ module Mongoid
   # document can transition through.
   module Stateful
 
-    attr_writer :destroyed, :flagged_for_destroy, :new_record
+    attr_writer :destroyed, :flagged_for_destroy, :previously_new_record
+
+    def new_record=(new_value)
+      @new_record ||= false
+      if @new_record && !new_value
+        @previously_new_record = true
+      end
+      @new_record = new_value
+    end
 
     # Returns true if the +Document+ has not been persisted to the database,
     # false if it has. This is determined by the variable @new_record
@@ -15,29 +23,47 @@ module Mongoid
     # @example Is the document new?
     #   person.new_record?
     #
-    # @return [ true, false ] True if new, false if not.
+    # @return [ true | false ] True if new, false if not.
     def new_record?
       @new_record ||= false
     end
 
+    # Returns true if this document was just created -- that is, prior to the last
+    # save, the object didn't exist in the database and new_record? would have
+    # returned true.
+    #
+    # @return [ true | false ] True if was just created, false if not.
+    def previously_new_record?
+      @previously_new_record ||= false
+    end
+
     # Checks if the document has been saved to the database. Returns false
     # if the document has been destroyed.
     #
     # @example Is the document persisted?
     #   person.persisted?
     #
-    # @return [ true, false ] True if persisted, false if not.
+    # @return [ true | false ] True if persisted, false if not.
     def persisted?
       !new_record? && !destroyed?
     end
 
+    # Checks if the document was previously saved to the database
+    # but now it has been deleted.
+    #
+    # @return [ true | false ] True if was persisted but now destroyed,
+    #   otherwise false.
+    def previously_persisted?
+      !new_record? && destroyed?
+    end
+
     # Returns whether or not the document has been flagged for deletion, but
     # not destroyed yet. Used for atomic pulls of child documents.
     #
     # @example Is the document flagged?
     #   document.flagged_for_destroy?
     #
-    # @return [ true, false ] If the document is flagged.
+    # @return [ true | false ] If the document is flagged.
     def flagged_for_destroy?
       @flagged_for_destroy ||= false
     end
@@ -51,7 +77,7 @@ module Mongoid
     # @example Is the document destroyed?
     #   person.destroyed?
     #
-    # @return [ true, false ] True if destroyed, false if not.
+    # @return [ true | false ] True if destroyed, false if not.
     def destroyed?
       @destroyed ||= false
     end
@@ -61,7 +87,7 @@ module Mongoid
     # @example Is this pushable?
     #   person.pushable?
     #
-    # @return [ true, false ] Is the document new and embedded?
+    # @return [ true | false ] Is the document new and embedded?
     def pushable?
       new_record? &&
         embedded_many? &&
@@ -74,7 +100,7 @@ module Mongoid
     # @example Is the document readonly?
     #   document.readonly?
     #
-    # @return [ true, false ] If the document is readonly.
+    # @return [ true | false ] If the document is readonly.
     def readonly?
       __selected_fields != nil
     end
@@ -84,7 +110,7 @@ module Mongoid
     # @example Is this settable?
     #   person.settable?
     #
-    # @return [ true, false ] Is this document a new embeds one?
+    # @return [ true | false ] Is this document a new embeds one?
     def settable?
       new_record? && embedded_one? && _parent.persisted?
     end
@@ -94,7 +120,7 @@ module Mongoid
     # @example Is the document updateable?
     #   person.updateable?
     #
-    # @return [ true, false ] If the document is changed and persisted.
+    # @return [ true | false ] If the document is changed and persisted.
     def updateable?
       persisted? && changed?
     end

data/lib/mongoid/tasks/database.rb

@@ -36,7 +36,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.undefined_indexes
       #
       # @return [ Array<Hash> ] The list of undefined indexes by model.
-      #
       def undefined_indexes(models = ::Mongoid.models)
         undefined_by_model = {}
 
@@ -90,7 +89,6 @@ module Mongoid
       #   Mongoid::Tasks::Database.remove_indexes
       #
       # @return [ Array<Class> ] The un-indexed models.
-      #
       def remove_indexes(models = ::Mongoid.models)
         models.each do |model|
           next if model.embedded?

data/lib/mongoid/threaded/lifecycle.rb

@@ -37,7 +37,7 @@ module Mongoid
       # @example Is the current thread in assigning mode?
       #   proxy._assigning?
       #
-      # @return [ true, false ] If the thread is assigning.
+      # @return [ true | false ] If the thread is assigning.
       def _assigning?
         Threaded.executing?(ASSIGN)
       end
@@ -62,7 +62,7 @@ module Mongoid
       # @example Is the current thread in binding mode?
       #   proxy.binding?
       #
-      # @return [ true, false ] If the thread is binding.
+      # @return [ true | false ] If the thread is binding.
       def _binding?
         Threaded.executing?(BIND)
       end
@@ -87,7 +87,7 @@ module Mongoid
       # @example Is the current thread in building mode?
       #   proxy._building?
       #
-      # @return [ true, false ] If the thread is building.
+      # @return [ true | false ] If the thread is building.
       def _building?
         Threaded.executing?(BUILD)
       end
@@ -97,7 +97,7 @@ module Mongoid
       # @example Is the current thread in creating mode?
       #   proxy.creating?
       #
-      # @return [ true, false ] If the thread is creating.
+      # @return [ true | false ] If the thread is creating.
       def _creating?
         Threaded.executing?(CREATE)
       end
@@ -122,7 +122,7 @@ module Mongoid
       # @example Is the current thread in loading mode?
       #   proxy._loading?
       #
-      # @return [ true, false ] If the thread is loading.
+      # @return [ true | false ] If the thread is loading.
       def _loading?
         Threaded.executing?(LOAD)
       end