mongoid 5.4.1 → 6.1.1

data/lib/mongoid/clients/options.rb

@@ -4,241 +4,85 @@ module Mongoid
     module Options
       extend ActiveSupport::Concern
 
-      # Tell the next persistence operation to store in a specific collection,
-      # database or client.
+      # Change the persistence context for this object during the block.
       #
       # @example Save the current document to a different collection.
-      #   model.with(collection: "secondary").save
+      #   model.with(collection: "secondary") do |m|
+      #     m.save
+      #   end
       #
-      # @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
-      #
-      # @note This method will instantiate a new client under the covers and
-      #   can be expensive. It is also recommended that the user manually
-      #   closes the extra client after using it, otherwise an excessive amount
-      #   of connections to the server will be eventually opened.
-      #
-      # @param [ Hash ] options The storage options.
+      # @param [ Hash, Mongoid::PersistenceContext ] options_or_context
+      #   The storage options or a persistence context.
       #
       # @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
+      # @since 6.0.0
+      def with(options_or_context, &block)
+        original_cluster = persistence_context.cluster
+        set_persistence_context(options_or_context)
+        yield self
+      ensure
+        clear_persistence_context(original_cluster)
       end
 
-      def persistence_options
-        @persistence_options
-      end
-
-      def mongo_client
-        tmp = persistence_options
-        if (opts = tmp && !tmp.empty? && tmp.dup)
-          if opts[:client]
-            client = Clients.with_name(opts[:client])
-          else
-            client = Clients.with_name(self.class.client_name)
-            client = client.use(self.class.database_name)
-          end
-          client.with(opts.reject{ |k, v| k == :collection || k == :client })
-        end
+      def collection(parent = nil)
+        persistence_context.collection(parent)
       end
 
       def collection_name
-        if persistence_options && v = persistence_options[:collection]
-          return v.to_sym
-        end
+        persistence_context.collection_name
       end
 
-      module Threaded
-
-        # Get the persistence options for the current thread.
-        #
-        # @example Get the persistence options.
-        #   Threaded.persistence_options(Band)
-        #
-        # @param [ Class ] klass The model class.
-        #
-        # @return [ Hash ] The current persistence options.
-        #
-        # @since 4.0.0
-        def persistence_options(klass = self)
-          Thread.current["[mongoid][#{klass}]:persistence-options"]
-        end
-
-        # Get the client with special options for the current thread.
-        #
-        # @example Get the client with options.
-        #   Threaded.client_with_options(Band)
-        #
-        # @param [ Class ] klass The model class.
-        #
-        # @return [ Mongo::Client ] The client.
-        #
-        # @since 5.1.0
-        def client_with_options(klass = self)
-          Thread.current["[mongoid][#{klass}]:mongo-client"]
-        end
-
-        private
-        # Set the persistence options on the current thread.
-        #
-        # @api private
-        #
-        # @example Set the persistence options.
-        #   Threaded.set_persistence_options(Band, { write: { w: 3 }})
-        #
-        # @param [ Class ] klass The model class.
-        # @param [ Hash ] options The persistence options.
-        #
-        # @return [ Hash ] The persistence options.
-        #
-        # @since 4.0.0
-        def set_persistence_options(klass, options)
-          Thread.current["[mongoid][#{klass}]:persistence-options"] = options
-        end
-
-        # Unset the persistence options on the current thread.
-        #
-        # @api private
-        #
-        # @example Unset the persistence options.
-        #   Threaded.unset_persistence_options(Band)
-        #
-        # @param [ Class ] klass The model class.
-        #
-        # @return [ nil ] nil.
-        #
-        # @since 5.1.0
-        def unset_persistence_options(klass)
-          Thread.current["[mongoid][#{klass}]:persistence-options"] = nil
-        end
-
-        # Set the persistence options and client with those options on the current thread.
-        # Note that a client will only be set if its cluster differs from the cluster of the
-        # original client.
-        #
-        # @api private
-        #
-        # @example Set the persistence options and client with those options on the current thread.
-        #   Threaded.set_options(Band, { write: { w: 3 }})
-        #
-        # @param [ Class ] klass The model class.
-        # @param [ Mongo::Client ] options The options.
-        #
-        # @return [ Mongo::Client, nil ] The client or nil if the cluster does not change.
-        #
-        # @since 5.1.0
-        def set_options(klass, options)
-          original_cluster = mongo_client.cluster
-          set_persistence_options(klass, options)
-          m = mongo_client
-          set_client_with_options(klass, m) unless m.cluster.equal?(original_cluster)
-        end
+      def mongo_client
+        persistence_context.client
+      end
+      
+      def persistence_context
+        PersistenceContext.get(self) ||
+            PersistenceContext.get(self.class) ||
+            PersistenceContext.new(self.class)
+      end
 
-        # Set the client with special options on the current thread.
-        #
-        # @api private
-        #
-        # @example Set the client with options.
-        #   Threaded.set_client_with_options(Band, client)
-        #
-        # @param [ Class ] klass The model class.
-        # @param [ Mongo::Client ] client The client with options.
-        #
-        # @return [ Mongo::Client ] The client.
-        #
-        # @since 5.1.0
-        def set_client_with_options(klass, client)
-          Thread.current["[mongoid][#{klass}]:mongo-client"] = client
-        end
+      private
 
-        # Unset the client with special options on the current thread.
-        #
-        # @api private
-        #
-        # @example Unset the client with options.
-        #   Threaded.unset_client_with_options(Band)
-        #
-        # @param [ Class ] klass The model class.
-        #
-        # @return [ nil ] nil.
-        #
-        # @since 5.1.0
-        def unset_client_with_options(klass)
-          if client = Thread.current["[mongoid][#{klass}]:mongo-client"]
-            client.close
-            Thread.current["[mongoid][#{klass}]:mongo-client"] = nil
-          end
-        end
+      def set_persistence_context(options_or_context)
+        PersistenceContext.set(self, options_or_context)
+      end
 
-        # Unset the persistence options and client with special options on the current thread.
-        #
-        # @api private
-        #
-        # @example Unset the persistence options and client with options.
-        #   Threaded.unset_options(Band)
-        #
-        # @param [ Class ] klass The model class.
-        #
-        # @return [ nil ] nil.
-        #
-        # @since 5.1.0
-        def unset_options(klass)
-          unset_persistence_options(klass)
-          unset_client_with_options(klass)
-        end
+      def clear_persistence_context(original_cluster = nil)
+        PersistenceContext.clear(self, original_cluster)
       end
 
       module ClassMethods
-        include Threaded
 
         def client_name
-          if persistence_options && v = persistence_options[:client]
-            return v.to_sym
-          end
-          super
+          persistence_context.client_name
         end
 
         def collection_name
-          if persistence_options && v = persistence_options[:collection]
-            return v.to_sym
-          end
-          super
+          persistence_context.collection_name
         end
 
         def database_name
-          if persistence_options && v = persistence_options[:database]
-            return v.to_sym
-          end
-          super
+          persistence_context.database_name
         end
 
-        # Tell the next persistence operation to store in a specific collection,
-        # database or client.
-        #
-        # @example Create a document in a different collection.
-        #   Model.with(collection: "secondary").create(name: "test")
-        #
-        # @example Create a document in a different database.
-        #   Model.with(database: "secondary").create(name: "test")
-        #
-        # @example Create a document in a different client.
-        #   Model.with(client: "secondary").create(name: "test")
+        def collection
+          persistence_context.collection
+        end
+
+        def mongo_client
+          persistence_context.client
+        end
+
+        # Change the persistence context for this class during the block.
         #
-        # @example Create with a combination of options.
-        #   Model.with(client: "sharded", database: "secondary").create
+        # @example Save the current document to a different collection.
+        #   Model.with(collection: "secondary") do |m|
+        #     m.create
+        #   end
         #
         # @param [ Hash ] options The storage options.
         #
@@ -246,56 +90,17 @@ module Mongoid
         # @option options [ String, Symbol ] :database The database name.
         # @option options [ String, Symbol ] :client The client name.
         #
-        # @return [ Class ] The model class.
-        #
-        # @since 3.0.0
-        def with(options)
-          if block_given?
-            set_options(self, options)
-            result = yield self
-            unset_options(self)
-            result
-          else
-            Proxy.new(self, (persistence_options || {}).merge(options))
-          end
-        end
-      end
-
-      class Proxy < BasicObject
-        include Threaded
-
-        undef_method :==
-
-        def initialize(target, options)
-          @target = target
-          @options = options
-        end
-
-        def persistence_options
-          @options
-        end
-
-        def respond_to?(*args)
-          @target.respond_to?(*args)
-        end
-
-        def method_missing(name, *args, &block)
-          set_persistence_options(@target, @options)
-          ret = @target.send(name, *args, &block)
-          if Mongoid::Criteria == ret.class
-            ret.with @options
-          end
-          ret
+        # @since 6.0.0
+        def with(options, &block)
+          original_cluster = persistence_context.cluster
+          PersistenceContext.set(self, options)
+          yield self
         ensure
-          unset_persistence_options(@target)
-        end
-
-        def send(symbol, *args)
-          __send__(symbol, *args)
+          PersistenceContext.clear(self, original_cluster)
         end
 
-        def self.const_missing(name)
-          ::Object.const_get(name)
+        def persistence_context
+          PersistenceContext.get(self) || PersistenceContext.new(self)
         end
       end
     end

data/lib/mongoid/clients/storage_options.rb

@@ -74,77 +74,9 @@ module Mongoid
         def storage_options_defaults
           {
             collection: name.collectionize.to_sym,
-            client: :default,
-            database: -> { configured_database }
+            client: :default
           }
         end
-
-        # Get the name of the collection this model persists to.
-        #
-        # @example Get the collection name.
-        #   Model.collection_name
-        #
-        # @return [ Symbol ] The name of the collection.
-        #
-        # @since 3.0.0
-        def collection_name
-          __evaluate__(storage_options[:collection])
-        end
-
-        # Get the client name for the model.
-        #
-        # @example Get the client name.
-        #   Model.client_name
-        #
-        # @return [ Symbol ] The name of the client.
-        #
-        # @since 3.0.0
-        def client_name
-          __evaluate__(storage_options[:client])
-        end
-
-        # Get the database name for the model.
-        #
-        # @example Get the database name.
-        #   Model.database_name
-        #
-        # @return [ Symbol ] The name of the client.
-        #
-        # @since 4.0.0
-        def database_name
-          __evaluate__(storage_options[:database])
-        end
-
-        private
-
-        # Eval the provided value, either byt calling it if it responds to call
-        # or returning the value itself.
-        #
-        # @api private
-        #
-        # @example Evaluate the name.
-        #   Model.__evaluate__(:name)
-        #
-        # @param [ String, Symbol, Proc ] name The name.
-        #
-        # @return [ Symbol ] The value as a symbol.
-        #
-        # @since 3.1.0
-        def __evaluate__(name)
-          return nil unless name
-          name.respond_to?(:call) ? name.call.to_sym : name.to_sym
-        end
-
-        def configured_database
-          client = Mongoid.clients[client_name]
-          if db = client[:database]
-            db
-          elsif uri = client[:uri]
-            client[:database] = Mongo::URI.get(uri).database
-          else
-            nil
-          end
-        end
       end
     end
   end

data/lib/mongoid/composable.rb

@@ -12,6 +12,7 @@ require "mongoid/scopable"
 require "mongoid/serializable"
 require "mongoid/shardable"
 require "mongoid/stateful"
+require "mongoid/cacheable"
 require "mongoid/traversable"
 require "mongoid/validatable"
 
@@ -32,7 +33,6 @@ module Mongoid
     include ActiveModel::Model
     include ActiveModel::ForbiddenAttributesProtection
     include ActiveModel::Serializers::JSON
-    include ActiveModel::Serializers::Xml
     include Atomic
     include Changeable
     include Clients
@@ -50,6 +50,7 @@ module Mongoid
     include Serializable
     include Shardable
     include Stateful
+    include Cacheable
     include Threaded::Lifecycle
     include Traversable
     include Validatable
@@ -76,14 +77,39 @@ module Mongoid
       Clients,
       Shardable,
       Stateful,
+      Cacheable,
       Threaded::Lifecycle,
       Traversable,
       Validatable,
       Equality,
+      Relations::Synchronization,
       ActiveModel::Model,
-      ActiveModel::Validations
+      ActiveModel::Validations,
+      PersistenceContext
     ]
 
+    # These are methods names defined in included blocks that may conflict
+    # with user-defined relation or field names.
+    # They won't be in the list of Module.instance_methods on which the
+    # #prohibited_methods code below is dependent so we must track them
+    # separately.
+    #
+    # @return [ Array<Symbol> ] A list of reserved method names.
+    #
+    # @since 6.0.0
+    RESERVED_METHOD_NAMES = [ :fields,
+                              :aliased_fields,
+                              :localized_fields,
+                              :index_specifications,
+                              :shard_key_fields,
+                              :nested_attributes,
+                              :readonly_attributes,
+                              :storage_options,
+                              :cascades,
+                              :cyclic,
+                              :cache_timestamp_format
+                            ]
+
     class << self
 
       # Get a list of methods that would be a bad idea to define as field names
@@ -98,7 +124,7 @@ module Mongoid
       def prohibited_methods
         @prohibited_methods ||= MODULES.flat_map do |mod|
           mod.instance_methods.map(&:to_sym)
-        end
+        end + RESERVED_METHOD_NAMES
       end
     end
   end