mongoid 4.0.2 → 5.0.0.beta

data/lib/mongoid/changeable.rb

@@ -16,7 +16,7 @@ module Mongoid
     #
     # @since 2.4.0
     def changed
-      changed_attributes.keys
+      changed_attributes.keys.select { |attr| attribute_change(attr) }
     end
 
     # Has the document changed?
@@ -40,9 +40,7 @@ module Mongoid
     #
     # @since 2.4.1
     def children_changed?
-      _children.any? do |child|
-        child.changed?
-      end
+      _children.any?(&:changed?)
     end
 
     # Get the attribute changes.
@@ -184,7 +182,7 @@ module Mongoid
     # @since 2.1.6
     def attribute_changed?(attr)
       attr = database_field_name(attr)
-      return false unless changed_attributes.has_key?(attr)
+      return false unless changed_attributes.key?(attr)
       changed_attributes[attr] != attributes[attr]
     end
 
@@ -228,7 +226,7 @@ module Mongoid
     #
     # @since 2.3.0
     def attribute_will_change!(attr)
-      unless changed_attributes.has_key?(attr)
+      unless changed_attributes.key?(attr)
         changed_attributes[attr] = read_attribute(attr).__deep_copy__
       end
     end

data/lib/mongoid/clients.rb

@@ -0,0 +1,142 @@
+# 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 = client.with(self.persistence_options)
+        Clients.set(name, client)
+      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/clients/factory.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+module Mongoid
+  module Clients
+    module Factory
+      extend self
+
+      # Create a new client given the named configuration. If no name is
+      # provided, return a new client with the default configuration. If a
+      # name is provided for which no configuration exists, an error will be
+      # raised.
+      #
+      # @example Create the client.
+      #   Factory.create(:secondary)
+      #
+      # @param [ String, Symbol ] name The named client configuration.
+      #
+      # @raise [ Errors::NoClientConfig ] If no config could be found.
+      #
+      # @return [ Mongo::Client ] The new client.
+      #
+      # @since 3.0.0
+      def create(name = nil)
+        return default unless name
+        config = Mongoid.clients[name]
+        raise Errors::NoClientConfig.new(name) unless config
+        create_client(config)
+      end
+
+      # Get the default client.
+      #
+      # @example Get the default client.
+      #   Factory.default
+      #
+      # @raise [ Errors::NoClientConfig ] If no default configuration is
+      #   found.
+      #
+      # @return [ Mongo::Client ] The default client.
+      #
+      # @since 3.0.0
+      def default
+        create_client(Mongoid.clients[:default])
+      end
+
+      private
+
+      # Create the client for the provided config.
+      #
+      # @api private
+      #
+      # @example Create the client.
+      #   Factory.create_client(config)
+      #
+      # @param [ Hash ] configuration The client config.
+      #
+      # @return [ Mongo::Client ] The client.
+      #
+      # @since 3.0.0
+      def create_client(configuration)
+        raise Errors::NoClientsConfig.new unless configuration
+        if configuration[:uri]
+          Mongo::Client.new(configuration[:uri], options(configuration))
+        else
+          Mongo::Client.new(
+            configuration[:hosts],
+            options(configuration).merge(database: configuration[:database])
+          )
+        end
+      end
+
+      def options(configuration)
+        config = configuration.dup
+        options = config.delete(:options) || {}
+        options.reject{ |k, v| k == :hosts }.to_hash.symbolize_keys!
+      end
+    end
+  end
+end

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

@@ -1,11 +1,12 @@
 # encoding: utf-8
 module Mongoid
-  module Sessions
+  module Clients
     module Options
       extend ActiveSupport::Concern
+      extend Gem::Deprecate
 
       # Tell the next persistance operation to store in a specific collection,
-      # database or session.
+      # database or client.
       #
       # @example Save the current document to a different collection.
       #   model.with(collection: "secondary").save
@@ -13,17 +14,22 @@ module Mongoid
       # @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 the current document to a different client.
+      #   model.with(client: "replica_set").save
       #
       # @example Save with a combination of options.
-      #   model.with(session: "sharded", database: "secondary").save
+      #   model.with(client: "sharded", database: "secondary").save
+      #
+      # @note This method will instantiate a new client under the covers and
+      #   can be expensive. It is also recommended that the user manually
+      #   closes the extra client after using it, otherwise an excessive amount
+      #   of connections to the server will be eventually opened.
       #
       # @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.
+      # @option options [ String, Symbol ] :client The client name.
       #
       # @return [ Document ] The current document.
       #
@@ -37,17 +43,19 @@ module Mongoid
         @persistence_options
       end
 
-      def mongo_session
+      def mongo_client
         if persistence_options
-          if persistence_options[:session]
-            session = Sessions.with_name(persistence_options[:session])
+          if persistence_options[:client]
+            client = Clients.with_name(persistence_options[:client])
           else
-            session = Sessions.with_name(self.class.session_name)
-            session.use(self.class.database_name)
+            client = Clients.with_name(self.class.client_name)
+            client.use(self.class.database_name)
           end
-          session.with(persistence_options)
+          client.with(persistence_options.reject{ |k, v| k == :collection || k == :client })
         end
       end
+      alias :mongo_session :mongo_client
+      deprecate :mongo_session, :mongo_client, 2015, 12
 
       def collection_name
         if persistence_options && v = persistence_options[:collection]
@@ -91,14 +99,17 @@ module Mongoid
       end
 
       module ClassMethods
+        extend Gem::Deprecate
         include Threaded
 
-        def session_name
-          if persistence_options && v = persistence_options[:session]
+        def client_name
+          if persistence_options && v = persistence_options[:client]
             return v.to_sym
           end
           super
         end
+        alias :session_name :client_name
+        deprecate :session_name, :client_name, 2015, 12
 
         def collection_name
           if persistence_options && v = persistence_options[:collection]
@@ -115,7 +126,7 @@ module Mongoid
         end
 
         # Tell the next persistance operation to store in a specific collection,
-        # database or session.
+        # database or client.
         #
         # @example Create a document in a different collection.
         #   Model.with(collection: "secondary").create(name: "test")
@@ -123,17 +134,17 @@ module Mongoid
         # @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 a document in a different client.
+        #   Model.with(client: "secondary").create(name: "test")
         #
         # @example Create with a combination of options.
-        #   Model.with(session: "sharded", database: "secondary").create
+        #   Model.with(client: "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.
+        # @option options [ String, Symbol ] :client The client name.
         #
         # @return [ Class ] The model class.
         #

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