mongoid 5.4.0 → 6.4.8

data/lib/mongoid/relations/proxy.rb

@@ -12,7 +12,7 @@ module Mongoid
       # We undefine most methods to get them sent through to the target.
       instance_methods.each do |method|
         undef_method(method) unless
-          method =~ /(^__|^send|^object_id|^respond_to|^tap|^public_send|extend_proxy|extend_proxies)/
+          method =~ /^(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)$/
       end
 
       include Threaded::Lifecycle
@@ -84,35 +84,6 @@ module Mongoid
         target
       end
 
-      # Tell the next persistence operation to store in a specific collection,
-      # database or client.
-      #
-      # @example Save the current document to a different collection.
-      #   model.with(collection: "secondary").save
-      #
-      # @example Save the current document to a different database.
-      #   model.with(database: "secondary").save
-      #
-      # @example Save the current document to a different client.
-      #   model.with(client: "replica_set").save
-      #
-      # @example Save with a combination of options.
-      #   model.with(client: "sharded", database: "secondary").save
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :client The client name.
-      #
-      # @return [ Document ] The current document.
-      #
-      # @since 3.0.0
-      def with(options)
-        @persistence_options = options
-        self
-      end
-
       protected
 
       # Get the collection from the root of the hierarchy.
@@ -125,7 +96,6 @@ module Mongoid
       # @since 2.0.0
       def collection
         root = base._root
-        root.with(@persistence_options)
         root.collection unless root.embedded?
       end
 

data/lib/mongoid/relations/referenced/in.rb

@@ -10,6 +10,24 @@ module Mongoid
       class In < Relations::One
         include Evolvable
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :autobuild,
+          :autosave,
+          :dependent,
+          :foreign_key,
+          :index,
+          :polymorphic,
+          :primary_key,
+          :touch,
+          :optional,
+          :required
+        ].freeze
+
         # Instantiate a new referenced_in relation.
         #
         # @example Create the new relation.
@@ -264,16 +282,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [
-              :autobuild,
-              :autosave,
-              :dependent,
-              :foreign_key,
-              :index,
-              :polymorphic,
-              :primary_key,
-              :touch
-            ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/referenced/many.rb

@@ -10,6 +10,24 @@ module Mongoid
         delegate :count, to: :criteria
         delegate :first, :in_memory, :last, :reset, :uniq, to: :target
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :after_add,
+          :after_remove,
+          :as,
+          :autosave,
+          :before_add,
+          :before_remove,
+          :dependent,
+          :foreign_key,
+          :order,
+          :primary_key
+        ].freeze
+
         # Appends a document or array of documents to the relation. Will set
         # the parent and update the index in the process.
         #
@@ -320,7 +338,6 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def append(document)
-          document.with(@persistence_options) if @persistence_options
           with_add_callbacks(document, already_related?(document)) do
             target.push(document)
             characterize_one(document)
@@ -460,7 +477,7 @@ module Mongoid
         # @since 3.0.0
         def persist_delayed(docs, inserts)
           unless docs.empty?
-            collection.insert_many(inserts)
+            collection.insert_many(inserts, session: _session)
             docs.each do |doc|
               doc.new_record = false
               doc.run_after_callbacks(:create, :save)
@@ -500,7 +517,7 @@ module Mongoid
           selector = conditions || {}
           removed = klass.send(method, selector.merge!(criteria.selector))
           target.delete_if do |doc|
-            if doc.matches?(selector)
+            if doc._matches?(selector)
               unbind_one(doc) and true
             end
           end
@@ -550,7 +567,7 @@ module Mongoid
           if doc.new_record? && doc.valid?(:create)
             doc.run_before_callbacks(:save, :create)
             docs.push(doc)
-            inserts.push(doc.as_document)
+            inserts.push(doc.send(:as_attributes))
           else
             doc.save
           end
@@ -590,14 +607,12 @@ module Mongoid
           # @since 2.1.0
           def criteria(metadata, object, type = nil)
             apply_ordering(
-              with_inverse_field_criterion(
-                with_polymorphic_criterion(
-                  metadata.klass.where(metadata.foreign_key => object),
-                  metadata,
-                  type
-                ),
-                metadata
-              ), metadata
+              with_polymorphic_criterion(
+                metadata.klass.where(metadata.foreign_key => object),
+                 metadata,
+                 type
+              ),
+              metadata
             )
           end
 
@@ -729,18 +744,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [
-              :after_add,
-              :after_remove,
-              :as,
-              :autosave,
-              :before_add,
-              :before_remove,
-              :dependent,
-              :foreign_key,
-              :order,
-              :primary_key
-            ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if
@@ -795,8 +799,8 @@ module Mongoid
           # @since 3.0.0
           def with_inverse_field_criterion(criteria, metadata)
             inverse_metadata = metadata.inverse_metadata(metadata.klass)
-            if inverse_metadata.try(:inverse_of_field)
-              criteria.any_in(inverse_metadata.inverse_of_field => [ metadata.name, nil ])
+            if inverse_metadata.try(:inverse_of)
+              criteria.any_in(inverse_metadata.inverse_of => [ metadata.name, nil ])
             else
               criteria
             end

data/lib/mongoid/relations/referenced/many_to_many.rb

@@ -7,6 +7,24 @@ module Mongoid
       # many-to-many between documents in different collections.
       class ManyToMany < Many
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :after_add,
+          :after_remove,
+          :autosave,
+          :before_add,
+          :before_remove,
+          :dependent,
+          :foreign_key,
+          :index,
+          :order,
+          :primary_key
+        ].freeze
+
         # Appends a document or array of documents to the relation. Will set
         # the parent and update the index in the process.
         #
@@ -266,7 +284,7 @@ module Mongoid
         #
         # @since 3.0.0
         def unsynced(doc, key)
-          doc.synced[key] = false
+          doc._synced[key] = false
           true
         end
 
@@ -439,18 +457,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [
-              :after_add,
-              :after_remove,
-              :autosave,
-              :before_add,
-              :before_remove,
-              :dependent,
-              :foreign_key,
-              :index,
-              :order,
-              :primary_key
-            ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/referenced/one.rb

@@ -7,6 +7,20 @@ module Mongoid
       # one-to-one between documents in different collections.
       class One < Relations::One
 
+        # The allowed options when defining this relation.
+        #
+        # @return [ Array<Symbol> ] The allowed options when defining this relation.
+        #
+        # @since 6.0.0
+        VALID_OPTIONS = [
+          :as,
+          :autobuild,
+          :autosave,
+          :dependent,
+          :foreign_key,
+          :primary_key
+        ].freeze
+
         # Instantiate a new references_one relation. Will set the foreign key
         # and the base on the inverse object.
         #
@@ -254,7 +268,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :as, :autobuild, :autosave, :dependent, :foreign_key, :primary_key ]
+            VALID_OPTIONS
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/synchronization.rb

@@ -11,41 +11,41 @@ module Mongoid
       # the key has changed and the relation bindings have not been run.
       #
       # @example Are the foreign keys syncable?
-      #   document.syncable?(metadata)
+      #   document._syncable??(metadata)
       #
       # @param [ Metadata ] metadata The relation metadata.
       #
       # @return [ true, false ] If we can sync.
       #
       # @since 2.1.0
-      def syncable?(metadata)
-        !synced?(metadata.foreign_key) && send(metadata.foreign_key_check)
+      def _syncable?(metadata)
+        !_synced?(metadata.foreign_key) && send(metadata.foreign_key_check)
       end
 
       # Get the synced foreign keys.
       #
       # @example Get the synced foreign keys.
-      #   document.synced
+      #   document._synced
       #
       # @return [ Hash ] The synced foreign keys.
       #
       # @since 2.1.0
-      def synced
-        @synced ||= {}
+      def _synced
+        @_synced ||= {}
       end
 
       # Has the document been synced for the foreign key?
       #
       # @example Has the document been synced?
-      #   document.synced?
+      #   document._synced??
       #
       # @param [ String ] foreign_key The foreign key.
       #
       # @return [ true, false ] If we can sync.
       #
       # @since 2.1.0
-      def synced?(foreign_key)
-        !!synced[foreign_key]
+      def _synced?(foreign_key)
+        !!_synced[foreign_key]
       end
 
       # Update the inverse keys on destroy.
@@ -81,7 +81,7 @@ module Mongoid
           adds, subs = new - (old || []), (old || []) - new
 
           # If we are autosaving we don't want a duplicate to get added - the
-          # $addToSet would run previously and then the $pushAll from the
+          # $addToSet would run previously and then the $push and $each from the
           # inverse on the autosave would cause this. We delete each id from
           # what's in memory in case a mix of id addition and object addition
           # had occurred.
@@ -110,7 +110,7 @@ module Mongoid
         # @param [ Metadata ] metadata The relation metadata.
         #
         # @since 2.1.0
-        def synced(metadata)
+        def _synced(metadata)
           unless metadata.forced_nil_inverse?
             synced_save(metadata)
             synced_destroy(metadata)
@@ -137,7 +137,7 @@ module Mongoid
           set_callback(
             :save,
             :after,
-            if: ->(doc){ doc.syncable?(metadata) }
+            if: ->(doc){ doc._syncable?(metadata) }
           ) do |doc|
             doc.update_inverse_keys(metadata)
           end

data/lib/mongoid/relations/targets/enumerable.rb

@@ -214,12 +214,22 @@ module Mongoid
         # @example Get the first document.
         #   enumerable.first
         #
+        # @note Automatically adding a sort on _id when no other sort is
+        #   defined on the criteria has the potential to cause bad performance issues.
+        #   If you experience unexpected poor performance when using #first or #last,
+        #   use the option { id_sort: :none }.
+        #   Be aware that #first/#last won't guarantee order in this case.
+        #
+        # @param [ Hash ] opts The options for the query returning the first document.
+        #
+        # @option opts [ :none ] :id_sort Don't apply a sort on _id.
+        #
         # @return [ Document ] The first document found.
         #
         # @since 2.1.0
-        def first
+        def first(opts = {})
           _loaded.try(:values).try(:first) ||
-            _added[(ul = _unloaded.try(:first)).try(:id)] ||
+            _added[(ul = _unloaded.try(:first, opts)).try(:id)] ||
             ul ||
             _added.values.try(:first)
         end
@@ -298,13 +308,23 @@ module Mongoid
         # @example Get the last document.
         #   enumerable.last
         #
+        # @note Automatically adding a sort on _id when no other sort is
+        #   defined on the criteria has the potential to cause bad performance issues.
+        #   If you experience unexpected poor performance when using #first or #last,
+        #   use the option { id_sort: :none }.
+        #   Be aware that #first/#last won't guarantee order in this case.
+        #
+        # @param [ Hash ] opts The options for the query returning the first document.
+        #
+        # @option opts [ :none ] :id_sort Don't apply a sort on _id.
+        #
         # @return [ Document ] The last document found.
         #
         # @since 2.1.0
-        def last
+        def last(opts = {})
           _added.values.try(:last) ||
             _loaded.try(:values).try(:last) ||
-            _added[(ul = _unloaded.try(:last)).try(:id)] ||
+            _added[(ul = _unloaded.try(:last, opts)).try(:id)] ||
             ul
         end
 

data/lib/mongoid/relations/touchable.rb

@@ -31,7 +31,7 @@ module Mongoid
         touches = touch_atomic_updates(field)
         unless touches["$set"].blank?
           selector = atomic_selector
-          _root.collection.find(selector).update_one(positionally(selector, touches))
+          _root.collection.find(selector).update_one(positionally(selector, touches), session: _session)
         end
         run_callbacks(:touch)
         true
@@ -53,7 +53,8 @@ module Mongoid
         def touchable(metadata)
           if metadata.touchable?
             name = metadata.name
-            method_name = define_relation_touch_method(name)
+            field = metadata[:touch].is_a?(Symbol) ? metadata[:touch] : nil
+            method_name = define_relation_touch_method(name, field)
             after_save method_name
             after_destroy method_name
             after_touch method_name
@@ -70,19 +71,21 @@ module Mongoid
         #
         # @example Define the touch relation.
         #   Model.define_relation_touch_method(:band)
+        #   Model.define_relation_touch_method(:band, :band_updated_at)
         #
         # @param [ Symbol ] name The name of the relation.
+        # @param [ Symbol ] extra_field Additional timestamp field to update.
         #
         # @since 3.1.0
         #
         # @return [ Symbol ] The method name.
-        def define_relation_touch_method(name)
+        def define_relation_touch_method(name, extra_field = nil)
           method_name = "touch_#{name}_after_create_or_destroy"
           class_eval <<-TOUCH, __FILE__, __LINE__ + 1
             def #{method_name}
               without_autobuild do
                 relation = __send__(:#{name})
-                relation.touch if relation
+                relation.touch #{":#{extra_field}" if extra_field} if relation
               end
             end
           TOUCH

data/lib/mongoid/reloadable.rb

@@ -58,7 +58,7 @@ module Mongoid
     #
     # @since 2.3.2
     def reload_root_document
-      {}.merge(collection.find(_id: _id).read(mode: :primary).first || {})
+      {}.merge(collection.find({ _id: _id }, session: _session).read(mode: :primary).first || {})
     end
 
     # Reload the embedded document.
@@ -71,7 +71,7 @@ module Mongoid
     # @since 2.3.2
     def reload_embedded_document
       extract_embedded_attributes({}.merge(
-        _root.collection.find(_id: _root._id).read(mode: :primary).first
+        collection(_root).find(_id: _root._id).read(mode: :primary).first
       ))
     end
 

data/lib/mongoid/scopable.rb

@@ -102,7 +102,7 @@ module Mongoid
       #
       # @since 3.0.0
       def default_scopable?
-        default_scoping? && !Threaded.executing?(:without_default_scope)
+        default_scoping? && !Threaded.without_default_scope?(self)
       end
 
       # Get a queryable, either the last one on the scope stack or a fresh one.
@@ -244,10 +244,10 @@ module Mongoid
       #
       # @since 3.0.0
       def without_default_scope
-        Threaded.begin_execution("without_default_scope")
+        Threaded.begin_without_default_scope(self)
         yield
       ensure
-        Threaded.exit_execution("without_default_scope")
+        Threaded.exit_without_default_scope(self)
       end
 
       private

data/lib/mongoid/serializable.rb

@@ -66,7 +66,7 @@ module Mongoid
     #
     # @since 3.0.0
     def field_names(options)
-      names = (as_document.keys + attribute_names).uniq.sort
+      names = (as_attributes.keys + attribute_names).uniq.sort
 
       only = Array.wrap(options[:only]).map(&:to_s)
       except = Array.wrap(options[:except]).map(&:to_s)

data/lib/mongoid/stateful.rb

@@ -43,6 +43,7 @@ module Mongoid
       @flagged_for_destroy ||= false
     end
     alias :marked_for_destruction? :flagged_for_destroy?
+    alias :_destroy :flagged_for_destroy?
 
     # Returns true if the +Document+ has been succesfully destroyed, and false
     # if it hasn't. This is determined by the variable @destroyed and NOT

data/lib/mongoid/tasks/database.rb

@@ -44,7 +44,7 @@ module Mongoid
         models.each do |model|
           unless model.embedded?
             begin
-              model.collection.indexes.each do |index|
+              model.collection.indexes(session: model.send(:_session)).each do |index|
                 # ignore default index
                 unless index['name'] == '_id_'
                   key = index['key'].symbolize_keys
@@ -77,7 +77,7 @@ module Mongoid
           indexes.each do |index|
             key = index['key'].symbolize_keys
             collection = model.collection
-            collection.indexes.drop_one(key)
+            collection.indexes(session: model.send(:_session)).drop_one(key)
             logger.info(
               "MONGOID: Removed index '#{index['name']}' on collection " +
               "'#{collection.name}' in database '#{collection.database.name}'."
@@ -107,6 +107,7 @@ module Mongoid
       end
 
       private
+
       def logger
         Mongoid.logger
       end

data/lib/mongoid/threaded.rb

@@ -163,6 +163,30 @@ module Mongoid
       validations_for(document.class).delete_one(document._id)
     end
 
+    # Begin suppressing default scopes for given model on the current thread.
+    #
+    # @example Begin without default scope stack.
+    #   Threaded.begin_without_default_scope(klass)
+    #
+    # @param [ Class ] klass The model to suppress default scoping on.
+    #
+    # @api private
+    def begin_without_default_scope(klass)
+      stack(:without_default_scope).push(klass)
+    end
+
+    # Exit suppressing default scopes for given model on the current thread.
+    #
+    # @example Exit without default scope stack.
+    #   Threaded.exit_without_default_scope(klass)
+    #
+    # @param [ Class ] klass The model to unsuppress default scoping on.
+    #
+    # @api private
+    def exit_without_default_scope(klass)
+      stack(:without_default_scope).delete(klass)
+    end
+
     # Get the global client override.
     #
     # @example Get the global client override.
@@ -247,6 +271,18 @@ module Mongoid
       end
     end
 
+    # Is the given klass' default scope suppressed on the current thread?
+    #
+    # @example Is the given klass' default scope suppressed?
+    #   Threaded.without_default_scope?(klass)
+    #
+    # @param [ Class ] klass The model to check for default scope suppression.
+    #
+    # @api private
+    def without_default_scope?(klass)
+      stack(:without_default_scope).include?(klass)
+    end
+
     # Is the document autosaved on the current thread?
     #
     # @example Is the document autosaved?
@@ -325,5 +361,43 @@ module Mongoid
     def validations_for(klass)
       validations[klass] ||= []
     end
+
+    # Cache a session for this thread.
+    #
+    # @example Save a session for this thread.
+    #   Threaded.set_session(session)
+    #
+    # @param [ Mongo::Session ] session The session to save.
+    #
+    # @since 6.4.0
+    def set_session(session)
+      Thread.current[:session] = session
+    end
+
+    # Get the cached session for this thread.
+    #
+    # @example Get the session for this thread.
+    #   Threaded.get_session
+    #
+    # @return [ Mongo::Session, nil ] The session cached on this thread or nil.
+    #
+    # @since 6.4.0
+    def get_session
+      Thread.current[:session]
+    end
+
+    # Clear the cached session for this thread.
+    #
+    # @example Clear this thread's session.
+    #   Threaded.clear_session
+    #
+    # @return [ nil ]
+    #
+    # @since 6.4.0
+    def clear_session
+      session = get_session
+      session.end_session if session
+      Thread.current[:session] = nil
+    end
   end
 end

data/lib/mongoid/traversable.rb

@@ -153,7 +153,7 @@ module Mongoid
     def _root
       object = self
       while (object._parent) do object = object._parent; end
-      object.with(@persistence_options) || self
+      object
     end
 
     # Is this document the root document of the hierarchy?

data/lib/mongoid/validatable/uniqueness.rb

@@ -169,7 +169,6 @@ module Mongoid
           name = document.database_field_name(item)
           criteria = criteria.where(item => document.attributes[name])
         end
-        criteria = criteria.with(document.persistence_options)
         criteria
       end
 
@@ -274,7 +273,7 @@ module Mongoid
         criteria = create_criteria(klass, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
 
-        if criteria.with(criteria.persistence_options).read(mode: :primary).exists?
+        if criteria.read(mode: :primary).exists?
           add_error(document, attribute, value)
         end
       end

data/lib/mongoid/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Mongoid
-  VERSION = "5.4.0"
+  VERSION = "6.4.8"
 end