mongoid 2.4.10 → 3.0.0

data/lib/mongoid/sessions/validators/storage.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module Mongoid
+  module Sessions
+    module Validators
+
+      # Validates the options passed to :store_in.
+      module Storage
+        extend self
+
+        VALID_OPTIONS = [ :collection, :database, :session ]
+
+        # Validate the options provided to :store_in.
+        #
+        # @example Validate the options.
+        #   Storage.validate(:collection_name)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Hash, String, Symbol ] options The provided options.
+        #
+        # @since 3.0.0
+        def validate(klass, options)
+          if !options.is_a?(::Hash) || !valid_keys?(options)
+            raise Errors::InvalidStorageOptions.new(klass, options)
+          end
+        end
+
+        private
+
+        # Determine if all keys in the options hash are valid.
+        #
+        # @api private
+        #
+        # @example Are all keys valid?
+        #   validator.valid_keys?({ collection: "name" })
+        #
+        # @param [ Hash ] options The options hash.
+        #
+        # @return [ true, false ] If all keys are valid.
+        #
+        # @since 3.0.0
+        def valid_keys?(options)
+          options.keys.all? do |key|
+            VALID_OPTIONS.include?(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/sessions/validators.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "mongoid/sessions/validators/storage"

data/lib/mongoid/sessions.rb

@@ -0,0 +1,383 @@
+# encoding: utf-8
+require "mongoid/sessions/factory"
+require "mongoid/sessions/validators"
+
+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
+
+    class << self
+
+      # Clear all sessions from the current thread.
+      #
+      # @example Clear all sessions.
+      #   Mongoid::Sessions.clear
+      #
+      # @return [ Array ] The empty sessions.
+      #
+      # @since 3.0.0
+      def clear
+        Threaded.sessions.clear
+      end
+
+      # Get the default session.
+      #
+      # @example Get the default session.
+      #   Mongoid::Sessions.default
+      #
+      # @return [ Moped::Session ] The default session.
+      #
+      # @since 3.0.0
+      def default
+        Threaded.sessions[:default] ||= Sessions::Factory.default
+      end
+
+      # Get a session with the provided name.
+      #
+      # @example Get a session with the name.
+      #   Mongoid::Sessions.with_name(:replica)
+      #
+      # @param [ Symbol ] name The name of the session.
+      #
+      # @return [ Moped::Session ] The named session.
+      #
+      # @since 3.0.0
+      def with_name(name)
+        Threaded.sessions[name.to_sym] ||= Sessions::Factory.create(name)
+      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
+          coll
+        else
+          mongo_session[collection_name]
+        end
+      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 ||= __collection_name__
+      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 ||= __database_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
+
+      # 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
+        session = __session__
+        session.use(database_override || database_name)
+        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)
+        @collection_name, @database_name = nil, nil
+        self.storage_options = 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]
+          name.to_sym
+        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]
+          name.to_sym
+        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]
+          name.to_sym
+        else
+          :default
+        end
+      end
+
+      # Get the session for this class.
+      #
+      # @example Get the session.
+      #   Model.__session__
+      #
+      # @return [ Moped::Session ] The moped session.
+      #
+      # @since 3.0.0
+      def __session__
+        if name = session_override
+          Sessions.with_name(name)
+        elsif storage_options && name = storage_options[:session]
+          Sessions.with_name(name)
+        else
+          Sessions.default
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/sharding.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc
+module Mongoid
 
   # This module contains behaviour for adding shard key fields to updates.
   module Sharding
@@ -31,14 +31,14 @@ module Mongoid #:nodoc
     #
     # @since 2.0.0
     def shard_key_selector
-      {}.tap do |selector|
-        shard_key_fields.each do |field|
-          selector[field.to_s] = send(field)
-        end
+      selector = {}
+      shard_key_fields.each do |field|
+        selector[field.to_s] = send(field)
       end
+      selector
     end
 
-    module ClassMethods #:nodoc
+    module ClassMethods
 
       # Specifies a shard key with the field(s) specified.
       #

data/lib/mongoid/state.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
 
   # This module contains the behaviour for getting the various states a
   # document can transition through.
@@ -16,9 +16,8 @@ module Mongoid #:nodoc:
     #
     # @return [ true, false ] True if new, false if not.
     def new_record?
-      @new_record == true
+      @new_record ||= false
     end
-    alias :new? :new_record?
 
     # Checks if the document has been saved to the database. Returns false
     # if the document has been destroyed.
@@ -41,7 +40,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.2
     def flagged_for_destroy?
-      !!@flagged_for_destroy
+      @flagged_for_destroy ||= false
     end
 
     # Returns true if the +Document+ has been succesfully destroyed, and false
@@ -53,7 +52,7 @@ module Mongoid #:nodoc:
     #
     # @return [ true, false ] True if destroyed, false if not.
     def destroyed?
-      @destroyed == true
+      @destroyed ||= false
     end
     alias :deleted? :destroyed?
 
@@ -64,7 +63,7 @@ module Mongoid #:nodoc:
     #
     # @return [ true, false ] Is the document new and embedded?
     def pushable?
-      new? &&
+      new_record? &&
         embedded_many? &&
         _parent.persisted? &&
         !_parent.delayed_atomic_sets[atomic_path]
@@ -79,7 +78,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def settable?
-      new? && embedded_one? && _parent.persisted?
+      new_record? && embedded_one? && _parent.persisted?
     end
 
     # Is the document updateable?

data/lib/mongoid/threaded/lifecycle.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Threaded #:nodoc:
+module Mongoid
+  module Threaded
 
     # This module contains convenience methods for document lifecycle that
     # resides on thread locals.
@@ -22,10 +22,10 @@ module Mongoid #:nodoc:
       #
       # @since 2.2.0
       def _assigning
-        Threaded.begin(:assign)
+        Threaded.begin("assign")
         yield
       ensure
-        Threaded.exit(:assign)
+        Threaded.exit("assign")
       end
 
       # Is the current thread in assigning mode?
@@ -37,7 +37,7 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def _assigning?
-        Threaded.executing?(:assign)
+        Threaded.executing?("assign")
       end
 
       # Execute a block in binding mode.
@@ -51,10 +51,10 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def _binding
-        Threaded.begin(:bind)
+        Threaded.begin("bind")
         yield
       ensure
-        Threaded.exit(:bind)
+        Threaded.exit("bind")
       end
 
       # Is the current thread in binding mode?
@@ -66,7 +66,7 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def _binding?
-        Threaded.executing?(:bind)
+        Threaded.executing?("bind")
       end
 
       # Execute a block in building mode.
@@ -80,10 +80,10 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def _building
-        Threaded.begin(:build)
+        Threaded.begin("build")
         yield
       ensure
-        Threaded.exit(:build)
+        Threaded.exit("build")
       end
 
       # Is the current thread in building mode?
@@ -95,7 +95,7 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def _building?
-        Threaded.executing?(:build)
+        Threaded.executing?("build")
       end
 
       # Is the current thread in creating mode?
@@ -107,7 +107,7 @@ module Mongoid #:nodoc:
       #
       # @since 2.1.0
       def _creating?
-        Threaded.executing?(:create)
+        Threaded.executing?("create")
       end
 
       # Execute a block in loading mode.
@@ -121,10 +121,10 @@ module Mongoid #:nodoc:
       #
       # @since 2.3.2
       def _loading
-        Threaded.begin(:load)
+        Threaded.begin("load")
         yield
       ensure
-        Threaded.exit(:load)
+        Threaded.exit("load")
       end
 
       # Is the current thread in loading mode?
@@ -136,7 +136,7 @@ module Mongoid #:nodoc:
       #
       # @since 2.3.2
       def _loading?
-        Threaded.executing?(:load)
+        Threaded.executing?("load")
       end
 
       # Execute a block in loading revision mode.
@@ -150,13 +150,13 @@ module Mongoid #:nodoc:
       #
       # @since 2.3.4
       def _loading_revision
-        Threaded.begin(:load_revision)
+        Threaded.begin("load_revision")
         yield
       ensure
-        Threaded.exit(:load_revision)
+        Threaded.exit("load_revision")
       end
 
-      module ClassMethods #:nodoc:
+      module ClassMethods
 
         # Execute a block in creating mode.
         #
@@ -169,10 +169,10 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def _creating
-          Threaded.begin(:create)
+          Threaded.begin("create")
           yield
         ensure
-          Threaded.exit(:create)
+          Threaded.exit("create")
         end
 
         # Is the current thread in loading revision mode?
@@ -184,7 +184,7 @@ module Mongoid #:nodoc:
         #
         # @since 2.3.4
         def _loading_revision?
-          Threaded.executing?(:load_revision)
+          Threaded.executing?("load_revision")
         end
       end
     end