mongoid 4.0.2 → 5.0.0

data/lib/mongoid/{sessions → clients}/storage_options.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
-  module Sessions
+  module Clients
     module StorageOptions
       extend ActiveSupport::Concern
 
@@ -12,6 +12,7 @@ module Mongoid
       end
 
       module ClassMethods
+        extend Gem::Deprecate
 
         # Give this model specific custom default storage options.
         #
@@ -27,10 +28,10 @@ module Mongoid
         #     store_in database: "echo_shard"
         #   end
         #
-        # @example Store this model by default in a different session.
+        # @example Store this model by default in a different client.
         #   class Band
         #     include Mongoid::Document
-        #     store_in session: "secondary"
+        #     store_in client: "secondary"
         #   end
         #
         # @example Store this model with a combination of options.
@@ -43,7 +44,7 @@ module Mongoid
         #
         # @option options [ String, Symbol ] :collection The collection name.
         # @option options [ String, Symbol ] :database The database name.
-        # @option options [ String, Symbol ] :session The session name.
+        # @option options [ String, Symbol ] :client The client name.
         #
         # @return [ Class ] The model class.
         #
@@ -74,8 +75,8 @@ module Mongoid
         def storage_options_defaults
           {
             collection: name.collectionize.to_sym,
-            session: :default,
-            database: -> { Mongoid.sessions[session_name][:database] }
+            client: :default,
+            database: -> { configured_database }
           }
         end
 
@@ -91,24 +92,26 @@ module Mongoid
           __evaluate__(storage_options[:collection])
         end
 
-        # Get the session name for the model.
+        # Get the client name for the model.
         #
-        # @example Get the session name.
-        #   Model.session_name
+        # @example Get the client name.
+        #   Model.client_name
         #
-        # @return [ Symbol ] The name of the session.
+        # @return [ Symbol ] The name of the client.
         #
         # @since 3.0.0
-        def session_name
-          __evaluate__(storage_options[:session])
+        def client_name
+          __evaluate__(storage_options[:client])
         end
+        alias :session_name :client_name
+        deprecate :session_name, :client_name, 2015, 12
 
         # Get the database name for the model.
         #
         # @example Get the database name.
         #   Model.database_name
         #
-        # @return [ Symbol ] The name of the session.
+        # @return [ Symbol ] The name of the client.
         #
         # @since 4.0.0
         def database_name
@@ -134,6 +137,17 @@ module Mongoid
           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.new(uri).database
+          else
+            nil
+          end
+        end
       end
     end
   end

data/lib/mongoid/{sessions → clients}/thread_options.rb

@@ -1,14 +1,17 @@
 # encoding: utf-8
 module Mongoid
-  module Sessions
+  module Clients
     module ThreadOptions
       extend ActiveSupport::Concern
 
       module ClassMethods
+        extend Gem::Deprecate
 
-        def session_name
-          Threaded.session_override || super
+        def client_name
+          Threaded.client_override || super
         end
+        alias :session_name :client_name
+        deprecate :session_name, :client_name, 2015, 12
 
         def database_name
           Threaded.database_override || super

data/lib/mongoid/{sessions → clients}/validators/storage.rb

@@ -1,13 +1,16 @@
 # encoding: utf-8
 module Mongoid
-  module Sessions
+  module Clients
     module Validators
 
       # Validates the options passed to :store_in.
       module Storage
         extend self
 
-        VALID_OPTIONS = [ :collection, :database, :session ]
+        # The valid options for storage.
+        #
+        # @since 3.0.0
+        VALID_OPTIONS = [ :collection, :database, :client ].freeze
 
         # Validate the options provided to :store_in.
         #

data/lib/mongoid/clients/validators.rb

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

data/lib/mongoid/clients.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+require "mongoid/clients/factory"
+require "mongoid/clients/validators"
+require "mongoid/clients/storage_options"
+require "mongoid/clients/thread_options"
+require "mongoid/clients/options"
+
+module Mongoid
+  module Clients
+    extend ActiveSupport::Concern
+    extend Gem::Deprecate
+    include StorageOptions
+    include ThreadOptions
+    include Options
+
+    class << self
+
+      # Clear all clients from the current thread.
+      #
+      # @example Clear all clients.
+      #   Mongoid::Clients.clear
+      #
+      # @return [ Array ] The empty clients.
+      #
+      # @since 3.0.0
+      def clear
+        clients.clear
+      end
+
+      # Get the default client.
+      #
+      # @example Get the default client.
+      #   Mongoid::Clients.default
+      #
+      # @return [ Mongo::Client ] The default client.
+      #
+      # @since 3.0.0
+      def default
+        clients[:default] ||= Clients::Factory.default
+      end
+
+      # Disconnect all active clients.
+      #
+      # @example Disconnect all active clients.
+      #   Mongoid::Clients.disconnect
+      #
+      # @return [ true ] True.
+      #
+      # @since 3.1.0
+      def disconnect
+        clients.values.each do |client|
+          client.close
+        end
+      end
+
+      # Get a client with the provided name.
+      #
+      # @example Get a client with the name.
+      #   Mongoid::Clients.with_name(:replica)
+      #
+      # @param [ Symbol ] name The name of the client.
+      #
+      # @return [ Mongo::Client ] The named client.
+      #
+      # @since 3.0.0
+      def with_name(name)
+        clients[name.to_sym] ||= Clients::Factory.create(name)
+      end
+
+      def set(name, client)
+        clients[name.to_sym] = client
+      end
+
+      def clients
+        @clients ||= {}
+      end
+    end
+
+    # Get the collection for this model from the client. 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 [ Mongo::Collection ] The collection.
+    #
+    # @since 3.0.0
+    def collection
+      mongo_client[collection_name]
+    end
+
+    def mongo_client
+      super || self.class.mongo_client
+    end
+    alias :mongo_session :mongo_client
+    deprecate :mongo_session, :mongo_client, 2015, 12
+
+    def collection_name
+      super || self.class.collection_name
+    end
+
+    module ClassMethods
+      extend Gem::Deprecate
+
+      # Get the client for this model. This is determined in the following order:
+      #
+      #   1. Any custom configuration provided by the 'store_in' macro.
+      #   2. The 'default' client as provided in the mongoid.yml
+      #
+      # @example Get the client.
+      #   Model.mongo_client
+      #
+      # @return [ Mongo::Client ] The default mongo client.
+      #
+      # @since 3.0.0
+      def mongo_client
+        name = client_name
+        client = Clients.with_name(name)
+        client = client.use(database_name)
+        client.with(self.persistence_options)
+      end
+      alias :mongo_session :mongo_client
+      deprecate :mongo_session, :mongo_client, 2015, 12
+
+      # Get the collection for this model from the client. 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 [ Mongo::Collection ] The collection.
+      #
+      # @since 3.0.0
+      def collection
+        mongo_client[collection_name]
+      end
+    end
+  end
+end

data/lib/mongoid/composable.rb

@@ -35,6 +35,7 @@ module Mongoid
     include ActiveModel::Serializers::Xml
     include Atomic
     include Changeable
+    include Clients
     include Attributes
     include Evolvable
     include Fields
@@ -47,7 +48,6 @@ module Mongoid
     include Scopable
     include Selectable
     include Serializable
-    include Sessions
     include Shardable
     include Stateful
     include Threaded::Lifecycle
@@ -73,7 +73,7 @@ module Mongoid
       Reloadable,
       Scopable,
       Serializable,
-      Sessions,
+      Clients,
       Shardable,
       Stateful,
       Threaded::Lifecycle,
@@ -97,7 +97,7 @@ module Mongoid
       # @since 2.1.8
       def prohibited_methods
         @prohibited_methods ||= MODULES.flat_map do |mod|
-          mod.instance_methods.map{ |m| m.to_sym }
+          mod.instance_methods.map(&:to_sym)
         end
       end
     end

data/lib/mongoid/config/environment.rb

@@ -19,7 +19,7 @@ module Mongoid
       #
       # @since 2.3.0
       def env_name
-        return Rails.env if defined?(Rails)
+        return Rails.env if defined?(Rails) && Rails.respond_to?(:env)
         return Sinatra::Base.environment.to_s if defined?(Sinatra)
         ENV["RACK_ENV"] || ENV["MONGOID_ENV"] || raise(Errors::NoEnvironment.new)
       end

data/lib/mongoid/config/options.rb

@@ -20,7 +20,7 @@ module Mongoid
       # Define a configuration option with a default.
       #
       # @example Define the option.
-      #   Options.option(:persist_in_safe_mode, :default => true)
+      #   Options.option(:logger, :default => Logger.new($stdout, :warn))
       #
       # @param [ Symbol ] name The name of the configuration option.
       # @param [ Hash ] options Extras for the option.

data/lib/mongoid/config/validators/{session.rb → client.rb}

@@ -3,82 +3,85 @@ module Mongoid
   module Config
     module Validators
 
-      # Validator for session specific configuration.
-      module Session
+      # Validator for client specific configuration.
+      module Client
         extend self
 
-        STANDARD = [ :database, :hosts, :username, :password ]
+        # Standard configuration options.
+        #
+        # @since 3.0.0
+        STANDARD = [ :database, :hosts, :username, :password ].freeze
 
-        # Validate the session configuration.
+        # Validate the client configuration.
         #
-        # @example Validate the session config.
-        #   Session.validate({ default: { hosts: [ "localhost:27017" ] }})
+        # @example Validate the client config.
+        #   Client.validate({ default: { hosts: [ "localhost:27017" ] }})
         #
-        # @param [ Hash ] sessions The sessions config.
+        # @param [ Hash ] clients The clients config.
         #
         # @since 3.0.0
-        def validate(sessions)
-          unless sessions.has_key?(:default)
-            raise Errors::NoDefaultSession.new(sessions.keys)
+        def validate(clients)
+          unless clients.has_key?(:default)
+            raise Errors::NoDefaultClient.new(clients.keys)
           end
-          sessions.each_pair do |name, config|
-            validate_session_database(name, config)
-            validate_session_hosts(name, config)
-            validate_session_uri(name, config)
+          clients.each_pair do |name, config|
+            validate_client_database(name, config)
+            validate_client_hosts(name, config)
+            validate_client_uri(name, config)
           end
         end
 
         private
 
-        # Validate that the session config has database.
+        # Validate that the client config has database.
         #
         # @api private
         #
-        # @example Validate the session has database.
-        #   validator.validate_session_database(:default, {})
+        # @example Validate the client has database.
+        #   validator.validate_client_database(:default, {})
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         #
         # @since 3.0.0
-        def validate_session_database(name, config)
+        def validate_client_database(name, config)
           if no_database_or_uri?(config)
-            raise Errors::NoSessionDatabase.new(name, config)
+            raise Errors::NoClientDatabase.new(name, config)
           end
         end
 
-        # Validate that the session config has hosts.
+        # Validate that the client config has hosts.
         #
         # @api private
         #
-        # @example Validate the session has hosts.
-        #   validator.validate_session_hosts(:default, {})
+        # @example Validate the client has hosts.
+        #   validator.validate_client_hosts(:default, {})
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         #
         # @since 3.0.0
-        def validate_session_hosts(name, config)
+        def validate_client_hosts(name, config)
           if no_hosts_or_uri?(config)
-            raise Errors::NoSessionHosts.new(name, config)
+            raise Errors::NoClientHosts.new(name, config)
           end
         end
 
         # Validate that not both a uri and standard options are provided for a
-        # single session.
+        # single client.
         #
         # @api private
         #
         # @example Validate the uri and options.
-        #   validator.validate_session_uri(:default, {})
+        #   validator.validate_client_uri(:default, {})
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         #
         # @since 3.0.0
-        def validate_session_uri(name, config)
+        def validate_client_uri(name, config)
           if both_uri_and_standard?(config)
-            raise Errors::MixedSessionConfiguration.new(name, config)
+            raise Errors::MixedClientConfiguration.new(name, config)
           end
         end
 

data/lib/mongoid/config/validators/option.rb

@@ -9,7 +9,7 @@ module Mongoid
 
         # Validate a configuration option.
         #
-        # @example Validate a configuraiton option.
+        # @example Validate a configuration option.
         #
         # @param [ String ] option The name of the option.
         #

data/lib/mongoid/config/validators.rb

@@ -1,3 +1,3 @@
 # encoding: utf-8
 require "mongoid/config/validators/option"
-require "mongoid/config/validators/session"
+require "mongoid/config/validators/client"

data/lib/mongoid/config.rb

@@ -8,6 +8,7 @@ module Mongoid
   # This module defines all the configuration options for Mongoid, including the
   # database connections.
   module Config
+    extend Gem::Deprecate
     extend self
     extend Options
 
@@ -26,7 +27,7 @@ module Mongoid
     option :use_utc, default: false
 
     # Has Mongoid been configured? This is checking that at least a valid
-    # session config exists.
+    # client config exists.
     #
     # @example Is Mongoid configured?
     #   config.configured?
@@ -35,10 +36,10 @@ module Mongoid
     #
     # @since 3.0.9
     def configured?
-      sessions.has_key?(:default)
+      clients.key?(:default)
     end
 
-    # Connect to the provided database name on the default session.
+    # Connect to the provided database name on the default client.
     #
     # @note Use only in development or test environments for convenience.
     #
@@ -48,8 +49,8 @@ module Mongoid
     # @param [ String ] name The database name.
     #
     # @since 3.0.0
-    def connect_to(name, options = { read: :primary })
-      self.sessions = {
+    def connect_to(name, options = { read: { mode: :primary }})
+      self.clients = {
         default: {
           database: name,
           hosts: [ "localhost:27017" ],
@@ -82,8 +83,8 @@ module Mongoid
     def load!(path, environment = nil)
       settings = Environment.load_yaml(path, environment)
       if settings.present?
-        Sessions.disconnect
-        Sessions.clear
+        Clients.disconnect
+        Clients.clear
         load_configuration(settings)
       end
       settings
@@ -127,7 +128,7 @@ module Mongoid
     def load_configuration(settings)
       configuration = settings.with_indifferent_access
       self.options = configuration[:options]
-      self.sessions = configuration[:sessions]
+      self.clients = configuration[:clients]
     end
 
     # Override the database to use globally.
@@ -144,19 +145,21 @@ module Mongoid
       Threaded.database_override = name
     end
 
-    # Override the session to use globally.
+    # Override the client to use globally.
     #
-    # @example Override the session globally.
-    #   config.override_session(:optional)
+    # @example Override the client globally.
+    #   config.override_client(:optional)
     #
-    # @param [ String, Symbol ] name The name of the session.
+    # @param [ String, Symbol ] name The name of the client.
     #
     # @return [ String, Symbol ] The global override.
     #
     # @since 3.0.0
-    def override_session(name)
-      Threaded.session_override = name ? name.to_s : nil
+    def override_client(name)
+      Threaded.client_override = name ? name.to_s : nil
     end
+    alias :override_session :override_client
+    deprecate :override_session, :override_client, 2015, 12
 
     # Purge all data in all collections, including indexes.
     #
@@ -169,9 +172,7 @@ module Mongoid
     #
     # @since 2.0.2
     def purge!
-      Sessions.default.collections.each do |collection|
-        collection.drop
-      end and true
+      Clients.default.database.collections.each(&:drop) and true
     end
 
     # Truncate all data in all collections, but not the indexes.
@@ -185,8 +186,8 @@ module Mongoid
     #
     # @since 2.0.2
     def truncate!
-      Sessions.default.collections.each do |collection|
-        collection.find.remove_all
+      Clients.default.database.collections.each do |collection|
+        collection.find.delete_many
       end and true
     end
 
@@ -207,33 +208,19 @@ module Mongoid
       end
     end
 
-    # Get the session configuration or an empty hash.
-    #
-    # @example Get the sessions configuration.
-    #   config.sessions
-    #
-    # @return [ Hash ] The sessions configuration.
-    #
-    # @since 3.0.0
-    def sessions
-      @sessions ||= {}
-    end
-
-    # Set the session configuration options.
+    # Get the client configuration or an empty hash.
     #
-    # @example Set the session configuration options.
-    #   config.sessions = { default: { hosts: [ "localhost:27017" ] }}
+    # @example Get the clients configuration.
+    #   config.clients
     #
-    # @param [ Hash ] sessions The configuration options.
+    # @return [ Hash ] The clients configuration.
     #
     # @since 3.0.0
-    def sessions=(sessions)
-      raise Errors::NoSessionsConfig.new unless sessions
-      sess = sessions.with_indifferent_access
-      Validators::Session.validate(sess)
-      @sessions = sess
-      sess
+    def clients
+      @clients ||= {}
     end
+    alias :sessions :clients
+    deprecate :sessions, :clients, 2015, 12
 
     # Get the time zone to use.
     #
@@ -258,5 +245,16 @@ module Mongoid
     def running_with_passenger?
       @running_with_passenger ||= defined?(PhusionPassenger)
     end
+
+    private
+
+    def clients=(clients)
+      raise Errors::NoClientsConfig.new unless clients
+      c = clients.with_indifferent_access
+      Validators::Client.validate(c)
+      @clients = c
+    end
+    alias :sessions= :clients=
+    deprecate :sessions=, :clients=, 2015, 12
   end
 end

data/lib/mongoid/contextual/aggregable/mongo.rb

@@ -23,7 +23,7 @@ module Mongoid
         #
         # @since 3.0.0
         def aggregates(field)
-          result = collection.aggregate(pipeline(field)).to_a
+          result = collection.find.aggregate(pipeline(field)).to_a
           if result.empty?
             { "count" => 0, "sum" => nil, "avg" => nil, "min" => nil, "max" => nil }
           else