mongoid 4.0.2 → 5.0.0.beta

data/lib/mongoid/threaded.rb

@@ -6,10 +6,24 @@ module Mongoid
   # This module contains logic for easy access to objects that have a lifecycle
   # on the current thread.
   module Threaded
+
     DATABASE_OVERRIDE_KEY = "[mongoid]:db-override"
-    SESSIONS_KEY = "[mongoid]:sessions"
-    SESSION_OVERRIDE_KEY = "[mongoid]:session-override"
-    SCOPE_STACK_KEY = "[mongoid]:scope-stack"
+
+    # Constant for the key to store clients.
+    #
+    # @since 5.0.0
+    CLIENTS_KEY = "[mongoid]:clients"
+
+    # The key to override the client.
+    #
+    # @since 5.0.0
+    CLIENT_OVERRIDE_KEY = "[mongoid]:client-override"
+
+    # The key for the current thread's scope stack.
+    #
+    # @since 2.0.0
+    CURRENT_SCOPE_KEY = "[mongoid]:current-scope"
+
     AUTOSAVES_KEY = "[mongoid]:autosaves"
     VALIDATIONS_KEY = "[mongoid]:validations"
 
@@ -17,6 +31,7 @@ module Mongoid
       hash[key] = "[mongoid]:#{key}-stack"
     end
 
+    extend Gem::Deprecate
     extend self
 
     # Begin entry into a named thread local stack.
@@ -59,18 +74,6 @@ module Mongoid
       Thread.current[DATABASE_OVERRIDE_KEY] = name
     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[SESSIONS_KEY] ||= {}
-    end
-
     # Are in the middle of executing the named stack
     #
     # @example Are we in the stack execution?
@@ -161,42 +164,60 @@ module Mongoid
       validations_for(document.class).delete_one(document._id)
     end
 
-    # Get the global session override.
+    # Get the global client override.
     #
-    # @example Get the global session override.
-    #   Threaded.session_override
+    # @example Get the global client override.
+    #   Threaded.client_override
     #
     # @return [ String, Symbol ] The override.
     #
-    # @since 3.0.0
-    def session_override
-      Thread.current[SESSION_OVERRIDE_KEY]
+    # @since 5.0.0
+    def client_override
+      Thread.current[CLIENT_OVERRIDE_KEY]
     end
+    alias :session_override :client_override
+    deprecate :session_override, :client_override, 2015, 12
 
-    # Set the global session override.
+    # Set the global client override.
     #
-    # @example Set the global session override.
-    #   Threaded.session_override = :testing
+    # @example Set the global client override.
+    #   Threaded.client_override = :testing
     #
     # @param [ String, Symbol ] The global override name.
     #
     # @return [ String, Symbol ] The override.
     #
     # @since 3.0.0
-    def session_override=(name)
-      Thread.current[SESSION_OVERRIDE_KEY] = name
+    def client_override=(name)
+      Thread.current[CLIENT_OVERRIDE_KEY] = name
+    end
+    alias :session_override= :client_override=
+    deprecate :session_override=, :client_override=, 2015, 12
+
+    # Get the current Mongoid scope.
+    #
+    # @example Get the scope.
+    #   Threaded.current_scope
+    #
+    # @return [ Criteria ] The scope.
+    #
+    # @since 5.0.0
+    def current_scope
+      Thread.current[CURRENT_SCOPE_KEY]
     end
 
-    # Get the mongoid scope stack for chained criteria.
+    # Set the current Mongoid scope.
+    #
+    # @example Set the scope.
+    #   Threaded.current_scope = scope
     #
-    # @example Get the scope stack.
-    #   Threaded.scope_stack
+    # @param [ Criteria ] scope The current scope.
     #
-    # @return [ Hash ] The scope stack.
+    # @return [ Criteria ] The scope.
     #
-    # @since 2.1.0
-    def scope_stack
-      Thread.current[SCOPE_STACK_KEY] ||= {}
+    # @since 5.0.0
+    def current_scope=(scope)
+      Thread.current[CURRENT_SCOPE_KEY] = scope
     end
 
     # Is the document autosaved on the current thread?

data/lib/mongoid/threaded/lifecycle.rb

@@ -1,7 +1,12 @@
 # encoding: utf-8
 module Mongoid
   module Threaded
-
+    BIND = 'bind'.freeze
+    ASSIGN = 'assign'.freeze
+    BUILD = 'build'.freeze
+    LOAD = 'load'.freeze
+    CREATE = 'create'.freeze
+    
     # This module contains convenience methods for document lifecycle that
     # resides on thread locals.
     module Lifecycle
@@ -22,10 +27,10 @@ module Mongoid
       #
       # @since 2.2.0
       def _assigning
-        Threaded.begin_execution("assign")
+        Threaded.begin_execution(ASSIGN)
         yield
       ensure
-        Threaded.exit_execution("assign")
+        Threaded.exit_execution(ASSIGN)
       end
 
       # Is the current thread in assigning mode?
@@ -37,7 +42,7 @@ module Mongoid
       #
       # @since 2.1.0
       def _assigning?
-        Threaded.executing?("assign")
+        Threaded.executing?(ASSIGN)
       end
 
       # Execute a block in binding mode.
@@ -51,10 +56,10 @@ module Mongoid
       #
       # @since 2.1.0
       def _binding
-        Threaded.begin_execution("bind")
+        Threaded.begin_execution(BIND)
         yield
       ensure
-        Threaded.exit_execution("bind")
+        Threaded.exit_execution(BIND)
       end
 
       # Is the current thread in binding mode?
@@ -66,7 +71,7 @@ module Mongoid
       #
       # @since 2.1.0
       def _binding?
-        Threaded.executing?("bind")
+        Threaded.executing?(BIND)
       end
 
       # Execute a block in building mode.
@@ -80,10 +85,10 @@ module Mongoid
       #
       # @since 2.1.0
       def _building
-        Threaded.begin_execution("build")
+        Threaded.begin_execution(BUILD)
         yield
       ensure
-        Threaded.exit_execution("build")
+        Threaded.exit_execution(BUILD)
       end
 
       # Is the current thread in building mode?
@@ -95,7 +100,7 @@ module Mongoid
       #
       # @since 2.1.0
       def _building?
-        Threaded.executing?("build")
+        Threaded.executing?(BUILD)
       end
 
       # Is the current thread in creating mode?
@@ -107,7 +112,7 @@ module Mongoid
       #
       # @since 2.1.0
       def _creating?
-        Threaded.executing?("create")
+        Threaded.executing?(CREATE)
       end
 
       # Execute a block in loading mode.
@@ -121,10 +126,10 @@ module Mongoid
       #
       # @since 2.3.2
       def _loading
-        Threaded.begin_execution("load")
+        Threaded.begin_execution(LOAD)
         yield
       ensure
-        Threaded.exit_execution("load")
+        Threaded.exit_execution(LOAD)
       end
 
       # Is the current thread in loading mode?
@@ -136,7 +141,7 @@ module Mongoid
       #
       # @since 2.3.2
       def _loading?
-        Threaded.executing?("load")
+        Threaded.executing?(LOAD)
       end
 
       module ClassMethods
@@ -152,10 +157,10 @@ module Mongoid
         #
         # @since 2.1.0
         def _creating
-          Threaded.begin_execution("create")
+          Threaded.begin_execution(CREATE)
           yield
         ensure
-          Threaded.exit_execution("create")
+          Threaded.exit_execution(CREATE)
         end
 
       end

data/lib/mongoid/traversable.rb

@@ -124,6 +124,21 @@ module Mongoid
         child.move_changes
         child.new_record = false
       end
+      _reset_memoized_children!
+    end
+
+    # Resets the memoized children on the object. Called internally when an
+    # embedded array changes size.
+    #
+    # @api semiprivate
+    #
+    # @example Reset the memoized children.
+    #   document._reset_memoized_children!
+    #
+    # @return [ nil ] nil.
+    #
+    # @since 5.0.0
+    def _reset_memoized_children!
       @__children = nil
     end
 
@@ -161,7 +176,7 @@ module Mongoid
       #
       # @return [ true, false ] True if hereditary, false if not.
       def hereditary?
-        Mongoid::Document > superclass
+        !!(Mongoid::Document > superclass)
       end
 
       # When inheriting, we want to copy the fields from the parent class and

data/lib/mongoid/validatable.rb

@@ -68,7 +68,7 @@ module Mongoid
     # @since 2.0.0.rc.1
     def read_attribute_for_validation(attr)
       attribute = database_field_name(attr)
-      if relations.has_key?(attribute)
+      if relations.key?(attribute)
         begin_validate
         relation = without_autobuild { send(attr) }
         exit_validate

data/lib/mongoid/validatable/queryable.rb

@@ -4,7 +4,7 @@ module Mongoid
     module Queryable
 
       # Wrap the validation inside the an execution block that alert's the
-      # session not to clear its persistence options.
+      # client not to clear its persistence options.
       #
       # @example Execute the validation with a query.
       #   with_query(document) do

data/lib/mongoid/validatable/uniqueness.rb

@@ -122,8 +122,8 @@ module Mongoid
       def criterion(document, attribute, value)
         field = document.database_field_name(attribute)
 
-        if localized?(document, field)
-          conditions = value.inject([]) { |acc, (k,v)| acc << { "#{field}.#{k}" => filter(v) } }
+        if value && localized?(document, field)
+          conditions = (value || {}).inject([]) { |acc, (k,v)| acc << { "#{field}.#{k}" => filter(v) }}
           selector = { "$or" => conditions }
         else
           selector = { field => filter(value) }
@@ -274,7 +274,7 @@ module Mongoid
         criteria = create_criteria(klass, document, attribute, value)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
 
-        if criteria.with(persistence_options(criteria)).exists?
+        if criteria.with(criteria.persistence_options).read(mode: :primary).exists?
           add_error(document, attribute, value)
         end
       end
@@ -296,23 +296,6 @@ module Mongoid
           scope_value_changed?(document)
       end
 
-      # Get the persistence options to perform to check, merging with any
-      # existing.
-      #
-      # @api private
-      #
-      # @example Get the persistence options.
-      #   validator.persistence_options(criteria)
-      #
-      # @param [ Criteria ] criteria The criteria.
-      #
-      # @return [ Hash ] The persistence options.
-      #
-      # @since 3.0.23
-      def persistence_options(criteria)
-        (criteria.persistence_options || {}).merge!(read: :primary)
-      end
-
       # Is the attribute localized?
       #
       # @api private

data/lib/mongoid/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Mongoid
-  VERSION = "4.0.2"
+  VERSION = "5.0.0.beta"
 end

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -1,62 +1,101 @@
 development:
-  # Configure available database sessions. (required)
-  sessions:
-    # Defines the default session. (required)
+  # Configure available database clients. (required)
+  clients:
+    # Defines the default client. (required)
     default:
       # Defines the name of the default database that Mongoid can connect to.
       # (required).
       database: <%= database_name || app_name %>_development
-      # Provides the hosts the default session can connect to. Must be an array
+      # Provides the hosts the default client can connect to. Must be an array
       # of host:port pairs. (required)
       hosts:
         - localhost:27017
       options:
         # Change the default write concern. (default = { w: 1 })
         # write:
-        # w: 1
-
-        # Change the default consistency model to primary, secondary.
-        # 'secondary' will send reads to secondaries, 'primary' sends everything
-        # to master. (default: primary)
-        # read: secondary_preferred
-
-        # How many times Moped should attempt to retry an operation after
-        # failure. (default: The number of nodes in the cluster)
-        # max_retries: 20
-
-        # The time in seconds that Moped should wait before retrying an
-        # operation on failure. (default: 0.25)
-        # retry_interval: 0.25
-        
-        # The connection pool size per-node.  This should match or exceed the
-        # number of threads for a multi-threaded application. (default: 5)
-        # pool_size: 5
-        
-        # The time in seconds that Moped should wait for the pool to provide
-        # an available connection.  This number should probably remain at the 
-        # default, unless for some reason you absolutely need to limit the
-        # pool_size, as this wait is only used when the pool is saturated.
-        # (default: 0.5)
-        # pool_timeout: 0.5
-
-        # The time in seconds before Moped will timeout connection and node
-        # operations. (default: 5)
-        # timeout: 5
-        
-        # The amount of time in seconds between forced refreshes of node 
-        # information including the discovery of new peers. (default: 300)
-        # refresh_interval: 300
-        
-        # The amount of time in seconds that a node will be flagged as down.
-        # (default: 30) 
-        # down_interval: 30
-        
-        # Whether connections should use SSL. (default: nil/false)
-        # ssl: false
-        
-        # Whether Moped will use the existing seeds/nodes to find other peers.
-        # (default: true)
-        # auto_discover: true
+        #   w: 1
+
+        # Change the default read preference. Valid options for mode are: :secondary,
+        # :secondary_preferred, :primary, :primary_preferred, :nearest
+        # (default: primary)
+        # read:
+        #   mode: :secondary_preferred
+
+        # The name of the user for authentication.
+        # user: 'user'
+
+        # The password of the user for authentication.
+        # password: 'password'
+
+        # The user's database roles.
+        # roles:
+        #   - 'dbOwner'
+
+        # Change the default authentication mechanism. Valid options are: :scram,
+        # :mongodb_cr, :mongodb_x509, and :plain. (default on 3.0 is :scram, default
+        # on 2.4 and 2.6 is :plain)
+        # auth_mech: :scram
+
+        # The database or source to authenticate the user against. (default: admin)
+        # auth_source: admin
+
+        # Force a the driver cluster to behave in a certain manner instead of auto-
+        # discovering. Can be one of: :direct, :replica_set, :sharded. Set to :direct
+        # when connecting to hidden members of a replica set.
+        # connect: :direct
+
+        # Changes the default time in seconds the server monitors refresh their status
+        # via ismaster commands. (default: 10)
+        # heartbeat_frequency: 10
+
+        # The time in seconds for selecting servers for a near read preference. (default: 5)
+        # local_threshold: 5
+
+        # The timeout in seconds for selecting a server for an operation. (default: 30)
+        # server_selection_timeout: 30
+
+        # The maximum number of connections in the connection pool. (default: 5)
+        # max_pool_size: 5
+
+        # The minimum number of connections in the connection pool. (default: 1)
+        # min_pool_size: 1
+
+        # The time to wait, in seconds, in the connection pool for a connection
+        # to be checked in before timing out. (default: 5)
+        # wait_queue_timeout: 5
+
+        # The time to wait to establish a connection before timing out, in seconds.
+        # (default: 5)
+        # connect_timeout: 5
+
+        # The timeout to wait to execute operations on a socket before raising an error.
+        # (default: 5)
+        # socket_timeout: 5
+
+        # The name of the replica set to connect to. Servers provided as seeds that do
+        # not belong to this replica set will be ignored.
+        # replica_set: name
+
+        # Whether to connect to the servers via ssl. (default: false)
+        # ssl: true
+
+        # The certificate file used to identify the connection against MongoDB.
+        # ssl_cert: /path/to/my.cert
+
+        # The private keyfile used to identify the connection against MongoDB.
+        # Note that even if the key is stored in the same file as the certificate,
+        # both need to be explicitly specified.
+        # ssl_key: /path/to/my.key
+
+        # A passphrase for the private key.
+        # ssl_key_pass_phrase: password
+
+        # Whether or not to do peer certification validation. (default: false)
+        # ssl_verify: true
+
+        # The file containing a set of concatenated certification authority certifications
+        # used to validate certs passed from the other end of the connection.
+        # ssl_ca_cert: /path/to/ca.cert
 
 
   # Configure Mongoid specific options. (optional)
@@ -71,9 +110,6 @@ development:
     # inheritance. (default: false)
     # preload_models: false
 
-    # Protect id and type from mass assignment. (default: true)
-    # protect_sensitive_fields: true
-
     # Raise an error when performing a #find and the document is not found.
     # (default: true)
     # raise_not_found_error: true
@@ -88,14 +124,12 @@ development:
     # Ensure all times are UTC in the app side. (default: false)
     # use_utc: false
 test:
-  sessions:
+  clients:
     default:
       database: <%= database_name || app_name %>_test
       hosts:
         - localhost:27017
       options:
-        read: primary
-        # In the test environment we lower the retries and retry interval to
-        # low amounts for fast failures.
-        max_retries: 1
-        retry_interval: 0
+        read:
+          mode: primary
+        max_pool_size: 1