mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/sessions/factory.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+require "mongoid/sessions/mongo_uri"
+
+module Mongoid
+  module Sessions
+    module Factory
+      extend self
+
+      # Create a new session given the named configuration. If no name is
+      # provided, return a new session with the default configuration. If a
+      # name is provided for which no configuration exists, an error will be
+      # raised.
+      #
+      # @example Create the session.
+      #   Factory.create(:secondary)
+      #
+      # @param [ String, Symbol ] name The named session configuration.
+      #
+      # @raise [ Errors::NoSessionConfig ] If no config could be found.
+      #
+      # @return [ Moped::Session ] The new session.
+      #
+      # @since 3.0.0
+      def create(name = nil)
+        return default unless name
+        config = Mongoid.sessions[name]
+        raise Errors::NoSessionConfig.new(name) unless config
+        create_session(config)
+      end
+
+      # Get the default session.
+      #
+      # @example Get the default session.
+      #   Factory.default
+      #
+      # @raise [ Errors::NoSessionConfig ] If no default configuration is
+      #   found.
+      #
+      # @return [ Moped::Session ] The default session.
+      #
+      # @since 3.0.0
+      def default
+        create_session(Mongoid.sessions[:default])
+      end
+
+      private
+
+      # Create the session for the provided config.
+      #
+      # @api private
+      #
+      # @example Create the session.
+      #   Factory.create_session(config)
+      #
+      # @param [ Hash ] configuration The session config.
+      #
+      # @return [ Moped::Session ] The session.
+      #
+      # @since 3.0.0
+      def create_session(configuration)
+        config, options = parse(configuration)
+        session = Moped::Session.new(config[:hosts], options)
+        session.use(config[:database])
+        if authenticated?(config)
+          session.login(config[:username], config[:password])
+        end
+        session
+      end
+
+      # Are we authenticated with this session config?
+      #
+      # @api private
+      #
+      # @example Is this session authenticated?
+      #   Factory.authenticated?(config)
+      #
+      # @param [ Hash ] config The session config.
+      #
+      # @return [ true, false ] If we are authenticated.
+      #
+      # @since 3.0.0
+      def authenticated?(config)
+        config.has_key?(:username) && config.has_key?(:password)
+      end
+
+      # Parse the configuration. If a uri is provided we need to extract the
+      # elements of it, otherwise the options are left alone.
+      #
+      # @api private
+      #
+      # @example Parse the config.
+      #   Factory.parse(config)
+      #
+      # @param [ Hash ] config The configuration.
+      #
+      # @return [ Array<Hash> ] The configuration, parsed.
+      #
+      # @since 3.0.0
+      def parse(config)
+        options = config[:options].try(:dup) || {}
+        parsed = config.has_key?(:uri) ? MongoUri.new(config[:uri]).to_hash : config
+        [ parsed, options ]
+      end
+    end
+  end
+end

data/lib/mongoid/sessions/mongo_uri.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+module Mongoid
+  module Sessions
+    class MongoUri
+
+      SCHEME = /(mongodb:\/\/)/
+      USER = /([-.\w:]+)/
+      PASS = /([^@,]+)/
+      NODES = /((([-.\w]+)(?::(\w+))?,?)+)/
+      DATABASE = /(?:\/([-\w]+))?/
+
+      URI = /#{SCHEME}(#{USER}:#{PASS}@)?#{NODES}#{DATABASE}/
+
+      attr_reader :match
+
+      # Get the database provided in the URI.
+      #
+      # @example Get the database.
+      #   uri.database
+      #
+      # @return [ String ] The database.
+      #
+      # @since 3.0.0
+      def database
+        @database ||= match[9]
+      end
+
+      # Get the hosts provided in the URI.
+      #
+      # @example Get the hosts.
+      #   uri.hosts
+      #
+      # @return [ Array<String> ] The hosts.
+      #
+      # @since 3.0.0
+      def hosts
+        @hosts ||= match[5].split(",")
+      end
+
+      # Create the new uri from the provided string.
+      #
+      # @example Create the new uri.
+      #   MongoUri.new(uri)
+      #
+      # @param [ String ] string The uri string.
+      #
+      # @since 3.0.0
+      def initialize(string)
+        @match = string.match(URI)
+      end
+
+      # Get the password provided in the URI.
+      #
+      # @example Get the password.
+      #   uri.password
+      #
+      # @return [ String ] The password.
+      #
+      # @since 3.0.0
+      def password
+        @password ||= match[4]
+      end
+
+      # Get the uri as a Mongoid friendly configuration hash.
+      #
+      # @example Get the uri as a hash.
+      #   uri.to_hash
+      #
+      # @return [ Hash ] The uri as options.
+      #
+      # @since 3.0.0
+      def to_hash
+        config = { database: database, hosts: hosts }
+        if username && password
+          config.merge!(username: username, password: password)
+        end
+        config
+      end
+
+      # Get the username provided in the URI.
+      #
+      # @example Get the username.
+      #   uri.username
+      #
+      # @return [ String ] The username.
+      #
+      # @since 3.0.0
+      def username
+        @username ||= match[3]
+      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/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/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.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require "mongoid/threaded/lifecycle"
 
-module Mongoid #:nodoc:
+module Mongoid
 
   # This module contains logic for easy access to objects that have a lifecycle
   # on the current thread.
@@ -13,7 +13,7 @@ module Mongoid #:nodoc:
     # @example Begin entry into the stack.
     #   Threaded.begin(:create)
     #
-    # @param [ Symbol ] name The name of the stack
+    # @param [ String ] name The name of the stack
     #
     # @return [ true ] True.
     #
@@ -22,6 +22,18 @@ module Mongoid #:nodoc:
       stack(name).push(true)
     end
 
+    # Get the database sessions from the current thread.
+    #
+    # @example Get the database sessions.
+    #   Threaded.sessions
+    #
+    # @return [ Hash ] The sessions.
+    #
+    # @since 3.0.0
+    def sessions
+      Thread.current["[mongoid]:sessions"] ||= {}
+    end
+
     # Are in the middle of executing the named stack
     #
     # @example Are we in the stack execution?
@@ -61,7 +73,19 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.0
     def stack(name)
-      Thread.current[:"[mongoid]:#{name}-stack"] ||= []
+      Thread.current["[mongoid]:#{name}-stack"] ||= []
+    end
+
+    # Begin autosaving a document on the current thread.
+    #
+    # @example Begin autosave.
+    #   Threaded.begin_autosave(doc)
+    #
+    # @param [ Document ] document The document to autosave.
+    #
+    # @since 3.0.0
+    def begin_autosave(document)
+      autosaves_for(document.class).push(document.id)
     end
 
     # Begin validating a document on the current thread.
@@ -76,16 +100,19 @@ module Mongoid #:nodoc:
       validations_for(document.class).push(document.id)
     end
 
-    # Clear out all the safety options set using the safely proxy.
+    # Clear out all the persistence options.
     #
-    # @example Clear out the options.
-    #   Threaded.clear_safety_options!
+    # @example Clear out the persistence options.
+    #   Threaded.clear_persistence_options(Band)
     #
-    # @return [ nil ] nil
+    # @param [ Class ] klass The model class.
     #
-    # @since 2.1.0
-    def clear_safety_options!
-      Thread.current[:"[mongoid]:safety-options"] = nil
+    # @return [ true ] true.
+    #
+    # @since 2.0.0
+    def clear_persistence_options(klass)
+      Thread.current["[mongoid][#{klass}]:persistence-options"] = nil
+      true
     end
 
     # Clear out all options set on a one-time basis.
@@ -95,10 +122,21 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.0
     def clear_options!
-      clear_safety_options!
       self.timeless = false
     end
 
+    # Exit autosaving a document on the current thread.
+    #
+    # @example Exit autosave.
+    #   Threaded.exit_autosave(doc)
+    #
+    # @param [ Document ] document The document to autosave.
+    #
+    # @since 3.0.0
+    def exit_autosave(document)
+      autosaves_for(document.class).delete_one(document.id)
+    end
+
     # Exit validating a document on the current thread.
     #
     # @example Exit validation.
@@ -120,7 +158,61 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def identity_map
-      Thread.current[:"[mongoid]:identity-map"] ||= IdentityMap.new
+      Thread.current["[mongoid]:identity-map"] ||= IdentityMap.new
+    end
+
+    # Is the identity map enabled on the current thread?
+    #
+    # @example Is the identity map enabled?
+    #   Threaded.identity_map_enabled?
+    #
+    # @return [ true, false ] If the identity map is enabled.
+    #
+    # @since 3.0.0
+    def identity_map_enabled?
+      Thread.current["[mongoid]:identity-map-enabled"] != false
+    end
+
+    # Disable the identity map on either the current thread or all threads.
+    #
+    # @example Disable the identity map on all threads.
+    #   Threaded.disable_identity_map(:all)
+    #
+    # @example Disable the identity map on the current thread.
+    #   Threaded.disable_identity_map(:current)
+    #
+    # @param [ Symbol ] option The disabling option.
+    #
+    # @since 3.0.0
+    def disable_identity_map(option)
+      if option == :all
+        Thread.list.each do |thread|
+          thread["[mongoid]:identity-map-enabled"] = false
+        end
+      else
+        Thread.current["[mongoid]:identity-map-enabled"] = false
+      end
+    end
+
+    # Enable the identity map on either the current thread or all threads.
+    #
+    # @example Enable the identity map on all threads.
+    #   Threaded.enable_identity_map(:all)
+    #
+    # @example Enable the identity map on the current thread.
+    #   Threaded.enable_identity_map(:current)
+    #
+    # @param [ Symbol ] option The disabling option.
+    #
+    # @since 3.0.0
+    def enable_identity_map(option)
+      if option == :all
+        Thread.list.each do |thread|
+          thread["[mongoid]:identity-map-enabled"] = true
+        end
+      else
+        Thread.current["[mongoid]:identity-map-enabled"] = true
+      end
     end
 
     # Get the insert consumer from the current thread.
@@ -132,7 +224,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def insert(name)
-      Thread.current[:"[mongoid][#{name}]:insert-consumer"]
+      Thread.current["[mongoid][#{name}]:insert-consumer"]
     end
 
     # Set the insert consumer on the current thread.
@@ -146,33 +238,36 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def set_insert(name, consumer)
-      Thread.current[:"[mongoid][#{name}]:insert-consumer"] = consumer
+      Thread.current["[mongoid][#{name}]:insert-consumer"] = consumer
     end
 
-    # Get the safety options for the current thread.
+    # Get the persistence options for the current thread.
+    #
+    # @example Get the persistence options.
+    #   Threaded.persistence_options(Band)
     #
-    # @example Get the safety options.
-    #   Threaded.safety_options
+    # @param [ Class ] klass The model class.
     #
-    # @return [ Hash ] The current safety options.
+    # @return [ Hash ] The current persistence options.
     #
     # @since 2.1.0
-    def safety_options
-      Thread.current[:"[mongoid]:safety-options"]
+    def persistence_options(klass)
+      Thread.current["[mongoid][#{klass}]:persistence-options"]
     end
 
-    # Set the safety options on the current thread.
+    # Set the persistence options on the current thread.
     #
-    # @example Set the safety options.
-    #   Threaded.safety_options = { :fsync => true }
+    # @example Set the persistence options.
+    #   Threaded.set_persistence_options(Band, { safe: { fsync: true }})
     #
-    # @param [ Hash ] options The safety options.
+    # @param [ Class ] klass The model class.
+    # @param [ Hash ] options The persistence options.
     #
-    # @return [ Hash ] The safety options.
+    # @return [ Hash ] The persistence options.
     #
     # @since 2.1.0
-    def safety_options=(options)
-      Thread.current[:"[mongoid]:safety-options"] = options
+    def set_persistence_options(klass, options)
+      Thread.current["[mongoid][#{klass}]:persistence-options"] = options
     end
 
     # Get the field selection options from the current thread.
@@ -184,7 +279,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.4
     def selection
-      Thread.current[:"[mongoid]:selection"]
+      Thread.current["[mongoid]:selection"]
     end
 
     # Set the field selection on the current thread.
@@ -198,7 +293,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.4
     def selection=(value)
-      Thread.current[:"[mongoid]:selection"] = value
+      Thread.current["[mongoid]:selection"] = value
     end
 
     # Get the mongoid scope stack for chained criteria.
@@ -210,7 +305,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def scope_stack
-      Thread.current[:"[mongoid]:scope-stack"] ||= {}
+      Thread.current["[mongoid]:scope-stack"] ||= {}
     end
 
     # Get the value of the one-off timeless call.
@@ -222,7 +317,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.0
     def timeless
-      !!Thread.current[:"[mongoid]:timeless"]
+      !!Thread.current["[mongoid]:timeless"]
     end
 
     # Set the value of the one-off timeless call.
@@ -234,33 +329,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.0
     def timeless=(value)
-      Thread.current[:"[mongoid]:timeless"] = value
-    end
-
-    # Get the update consumer from the current thread.
-    #
-    # @example Get the update consumer.
-    #   Threaded.update
-    #
-    # @return [ Object ] The atomic update consumer.
-    #
-    # @since 2.1.0
-    def update_consumer(klass)
-      Thread.current[:"[mongoid][#{klass}]:update-consumer"]
-    end
-
-    # Set the update consumer on the current thread.
-    #
-    # @example Set the update consumer.
-    #   Threaded.update = consumer
-    #
-    # @param [ Object ] consumer The update consumer.
-    #
-    # @return [ Object ] The update consumer.
-    #
-    # @since 2.1.0
-    def set_update_consumer(klass, consumer)
-      Thread.current[:"[mongoid][#{klass}]:update-consumer"] = consumer
+      Thread.current["[mongoid]:timeless"] = value
     end
 
     # Is the current thread setting timestamps?
@@ -275,6 +344,20 @@ module Mongoid #:nodoc:
       !timeless
     end
 
+    # Is the document autosaved on the current thread?
+    #
+    # @example Is the document autosaved?
+    #   Threaded.autosaved?(doc)
+    #
+    # @param [ Document ] document The document to check.
+    #
+    # @return [ true, false ] If the document is autosaved.
+    #
+    # @since 2.1.9
+    def autosaved?(document)
+      autosaves_for(document.class).include?(document.id)
+    end
+
     # Is the document validated on the current thread?
     #
     # @example Is the document validated?
@@ -289,6 +372,18 @@ module Mongoid #:nodoc:
       validations_for(document.class).include?(document.id)
     end
 
+    # Get all autosaves on the current thread.
+    #
+    # @example Get all autosaves.
+    #   Threaded.autosaves
+    #
+    # @return [ Hash ] The current autosaves.
+    #
+    # @since 3.0.0
+    def autosaves
+      Thread.current["[mongoid]:autosaves"] ||= {}
+    end
+
     # Get all validations on the current thread.
     #
     # @example Get all validations.
@@ -298,9 +393,22 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.9
     def validations
-      Thread.current[:"[mongoid]:validations"] ||= {}
+      Thread.current["[mongoid]:validations"] ||= {}
     end
 
+    # Get all autosaves on the current thread for the class.
+    #
+    # @example Get all autosaves.
+    #   Threaded.autosaves_for(Person)
+    #
+    # @param [ Class ] The class to check.
+    #
+    # @return [ Array ] The current autosaves.
+    #
+    # @since 3.0.0
+    def autosaves_for(klass)
+      autosaves[klass] ||= []
+    end
     # Get all validations on the current thread for the class.
     #
     # @example Get all validations.