mongoid 3.1.7 → 4.0.0.alpha1

data/lib/mongoid/sessions.rb

@@ -1,90 +1,18 @@
 # encoding: utf-8
 require "mongoid/sessions/factory"
 require "mongoid/sessions/validators"
+require "mongoid/sessions/storage_options"
+require "mongoid/sessions/thread_options"
+require "mongoid/sessions/options"
 
 module Mongoid
   module Sessions
     extend ActiveSupport::Concern
-
-    included do
-      cattr_accessor :default_collection_name, :storage_options
-      self.default_collection_name = self.name.collectionize.to_sym
-    end
-
-    # Get the collection for this model from the session. Will check for an
-    # overridden collection name from the store_in macro or the collection
-    # with a pluralized model name.
-    #
-    # @example Get the model's collection.
-    #   Model.collection
-    #
-    # @return [ Moped::Collection ] The collection.
-    #
-    # @since 3.0.0
-    def collection
-      self.class.collection
-    end
-
-    # Get the name of the collection this model persists to. This will be
-    # either the pluralized class name or the option defined in the store_in
-    # macro.
-    #
-    # @example Get the collection name.
-    #   Model.collection_name
-    #
-    # @return [ String ] The name of the collection.
-    #
-    # @since 3.0.0
-    def collection_name
-      self.class.collection_name
-    end
-
-    # Get the session for this model. This is determined in the following order:
-    #
-    #   1. Any custom configuration provided by the 'store_in' macro.
-    #   2. The 'default' session as provided in the mongoid.yml
-    #
-    # @example Get the session.
-    #   model.mongo_session
-    #
-    # @return [ Moped::Session ] The default moped session.
-    #
-    # @since 3.0.0
-    def mongo_session
-      self.class.mongo_session
-    end
-
-    # Tell the next persistance operation to store in a specific collection,
-    # database or session.
-    #
-    # @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 session.
-    #   model.with(session: "replica_set").save
-    #
-    # @example Save with a combination of options.
-    #   model.with(session: "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 ] :session The session name.
-    #
-    # @return [ Document ] The current document.
-    #
-    # @since 3.0.0
-    def with(options)
-      Threaded.set_persistence_options(self.class, options)
-      self
-    end
+    include StorageOptions
+    include ThreadOptions
+    include Options
 
     class << self
-
       # Clear all sessions from the current thread.
       #
       # @example Clear all sessions.
@@ -138,79 +66,29 @@ module Mongoid
       end
     end
 
-    module ClassMethods
-
-      # Clear all persistence options from the current thread.
-      #
-      # @example Clear the persistence options.
-      #   Mongoid::Sessions.clear_persistence_options
-      #
-      # @return [ true ] True.
-      #
-      # @since 3.0.0
-      def clear_persistence_options
-        Threaded.clear_persistence_options(self)
-      end
-
-      # Get the collection for this model from the session. Will check for an
-      # overridden collection name from the store_in macro or the collection
-      # with a pluralized model name.
-      #
-      # @example Get the model's collection.
-      #   Model.collection
-      #
-      # @return [ Moped::Collection ] The collection.
-      #
-      # @since 3.0.0
-      def collection
-        if opts = persistence_options
-          coll = mongo_session.with(opts)[opts[:collection] || collection_name]
-          clear_persistence_options unless validating_with_query? || _loading_revision?
-          coll
-        else
-          mongo_session[collection_name]
-        end
-      end
+    # Get the collection for this model from the session. Will check for an
+    # overridden collection name from the store_in macro or the collection
+    # with a pluralized model name.
+    #
+    # @example Get the model's collection.
+    #   Model.collection
+    #
+    # @return [ Moped::Collection ] The collection.
+    #
+    # @since 3.0.0
+    def collection
+      mongo_session[collection_name]
+    end
 
-      # Get the name of the collection this model persists to. This will be
-      # either the pluralized class name or the option defined in the store_in
-      # macro.
-      #
-      # @example Get the collection name.
-      #   Model.collection_name
-      #
-      # @return [ Symbol ] The name of the collection.
-      #
-      # @since 3.0.0
-      def collection_name
-        __collection_name__
-      end
+    def mongo_session
+      super || self.class.mongo_session
+    end
 
-      # Get the default database name for this model.
-      #
-      # @example Get the default database name.
-      #   Model.database_name
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def database_name
-        __database_name__
-      end
+    def collection_name
+      super || self.class.collection_name
+    end
 
-      # Get the overridden database name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_database(:name)+.
-      #
-      # @example Get the overridden database name.
-      #   Model.database_override
-      #
-      # @return [ String, Symbol ] The overridden database name.
-      #
-      # @since 3.0.0
-      def database_override
-        persistence_options.try { |opts| opts[:database] } || Threaded.database_override
-      end
+    module ClassMethods
 
       # Get the session for this model. This is determined in the following order:
       #
@@ -224,209 +102,23 @@ module Mongoid
       #
       # @since 3.0.0
       def mongo_session
-        session = __session__
-        session.use(database_override || current_database_name(session))
-        session
+        session = Sessions.with_name(session_name)
+        session.use(database_name)
+        self.persistence_options ? session.with(self.persistence_options) : session
       end
 
-      # Get the persistence options from the current thread.
-      #
-      # @example Get the persistence options.
-      #   Model.persistence_options
-      #
-      # @return [ Hash ] The persistence options.
-      #
-      # @since 3.0.0
-      def persistence_options
-        Threaded.persistence_options(self)
-      end
-
-      # Get the overridden session name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_session(:name)+.
-      #
-      # @example Get the overridden session name.
-      #   Model.session_override
-      #
-      # @return [ String, Symbol ] The overridden session name.
-      #
-      # @since 3.0.0
-      def session_override
-        persistence_options.try { |opts| opts[:session] } || Threaded.session_override
-      end
-
-      # Give this model specific custom default storage options.
-      #
-      # @example Store this model by default in "artists"
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists"
-      #   end
-      #
-      # @example Store this model by default in the sharded db.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in database: "echo_shard"
-      #   end
-      #
-      # @example Store this model by default in a different session.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in session: "secondary"
-      #   end
-      #
-      # @example Store this model with a combination of options.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists", database: "secondary"
-      #   end
-      #
-      # @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 ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def store_in(options)
-        Validators::Storage.validate(self, options)
-        self.storage_options ||= {}
-        self.storage_options.merge!(options)
-      end
-
-      # Tell the next persistance operation to store in a specific collection,
-      # database or session.
-      #
-      # @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 session.
-      #   Model.with(session: "secondary").create(name: "test")
-      #
-      # @example Create with a combination of options.
-      #   Model.with(session: "sharded", database: "secondary").create
-      #
-      # @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 ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def with(options)
-        Threaded.set_persistence_options(self, options)
-        self
-      end
-
-      private
-
-      # 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__
-        if storage_options && name = storage_options[:collection]
-          __evaluate__(name)
-        else
-          default_collection_name
-        end
-      end
-
-      # Get the database name for the model.
-      #
-      # @example Get the database name.
-      #   Model.__database_name__
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def __database_name__
-        if storage_options && name = storage_options[:database]
-          __evaluate__(name)
-        else
-          Mongoid.sessions[__session_name__][:database]
-        end
-      end
-
-      # Get the session name for the model.
-      #
-      # @example Get the session name.
-      #   Model.__session_name__
-      #
-      # @return [ Symbol ] The name of the session.
-      #
-      # @since 3.0.0
-      def __session_name__
-        if storage_options && name = storage_options[:session]
-          __evaluate__(name)
-        else
-          :default
-        end
-      end
-
-      # Get the session for this class.
+      # Get the collection for this model from the session. Will check for an
+      # overridden collection name from the store_in macro or the collection
+      # with a pluralized model name.
       #
-      # @example Get the session.
-      #   Model.__session__
+      # @example Get the model's collection.
+      #   Model.collection
       #
-      # @return [ Moped::Session ] The moped session.
+      # @return [ Moped::Collection ] The collection.
       #
       # @since 3.0.0
-      def __session__
-        if !(name = session_override).nil?
-          Sessions.with_name(name)
-        else
-          Sessions.with_name(__session_name__)
-        end
-      end
-
-      # 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)
-        name.respond_to?(:call) ? name.call.to_sym : name.to_sym
-      end
-
-      # Get the name of the current database to use. Will check for a session
-      # override with a database first, then database name.
-      #
-      # @api private
-      #
-      # @example Get the current database name.
-      #   Model.current_database_name
-      #
-      # @param [ Moped::Session ] session The current session.
-      #
-      # @return [ Symbol ] The current database name.
-      #
-      # @since 3.1.0
-      def current_database_name(session)
-        if session_override && name = session.options[:database]
-          name
-        else
-          database_name
-        end
+      def collection
+        mongo_session[collection_name]
       end
     end
   end

data/lib/mongoid/sessions/factory.rb

@@ -61,6 +61,8 @@ module Mongoid
         raise Errors::NoSessionsConfig.new unless configuration
         config, options = parse(configuration)
         configuration.merge!(config) if configuration.delete(:uri)
+
+        options[:instrumenter] = ActiveSupport::Notifications
         session = Moped::Session.new(config[:hosts], options)
         session.use(config[:database])
         if authenticated?(config)

data/lib/mongoid/sessions/options.rb

@@ -0,0 +1,176 @@
+# encoding: utf-8
+module Mongoid
+  module Sessions
+    module Options
+      extend ActiveSupport::Concern
+
+      # Tell the next persistance operation to store in a specific collection,
+      # database or session.
+      #
+      # @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 session.
+      #   model.with(session: "replica_set").save
+      #
+      # @example Save with a combination of options.
+      #   model.with(session: "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 ] :session The session name.
+      #
+      # @return [ Document ] The current document.
+      #
+      # @since 3.0.0
+      def with(options)
+        @persistence_options = options
+        self
+      end
+
+      def persistence_options
+        @persistence_options
+      end
+
+      def mongo_session
+        if persistence_options
+          session_name = persistence_options[:session] || self.class.session_name
+          Sessions.with_name(session_name).with(persistence_options)
+        end
+      end
+
+      def collection_name
+        if persistence_options && v = persistence_options[:collection]
+          return v.to_sym
+        end
+      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
+
+        private
+        # Set the persistence options on the current thread.
+        #
+        # @api private
+        #
+        # @example Set the persistence options.
+        #   Threaded.set_persistence_options(Band, { safe: { fsync: true }})
+        #
+        # @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
+      end
+
+      module ClassMethods
+        include Threaded
+
+        def session_name
+          if persistence_options && v = persistence_options[:session]
+            return v.to_sym
+          end
+          super
+        end
+
+        def collection_name
+          if persistence_options && v = persistence_options[:collection]
+            return v.to_sym
+          end
+          super
+        end
+
+        def database_name
+          if persistence_options && v = persistence_options[:database]
+            return v.to_sym
+          end
+          super
+        end
+
+        # Tell the next persistance operation to store in a specific collection,
+        # database or session.
+        #
+        # @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 session.
+        #   Model.with(session: "secondary").create(name: "test")
+        #
+        # @example Create with a combination of options.
+        #   Model.with(session: "sharded", database: "secondary").create
+        #
+        # @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 ] :session The session name.
+        #
+        # @return [ Class ] The model class.
+        #
+        # @since 3.0.0
+        def with(options)
+          Proxy.new(self, (persistence_options || {}).merge(options))
+        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)
+          @target.send(name, *args, &block)
+        ensure
+          set_persistence_options(@target, nil)
+         end
+
+        def send(symbol, *args)
+          __send__(symbol, *args)
+        end
+
+        def self.const_missing(name)
+          ::Object.const_get(name)
+        end
+      end
+    end
+  end
+end