mongoid 2.4.10 → 3.0.0

data/lib/mongoid/config.rb

@@ -1,89 +1,47 @@
 # encoding: utf-8
-require "uri"
-require "mongoid/config/database"
 require "mongoid/config/environment"
-require "mongoid/config/replset_database"
+require "mongoid/config/inflections"
 require "mongoid/config/options"
+require "mongoid/config/validators"
 
-module Mongoid #:nodoc
+module Mongoid
 
   # This module defines all the configuration options for Mongoid, including the
   # database connections.
-  #
-  # @todo Durran: This module needs an overhaul, remove singleton, etc.
   module Config
     extend self
     extend Options
     include ActiveModel::Observing
 
-    # @attribute [rw] master The master database.
-    attr_accessor :master
+    option :allow_dynamic_fields, default: true
+    option :identity_map_enabled, default: false
+    option :include_root_in_json, default: false
+    option :include_type_for_serialization, default: false
+    option :preload_models, default: false
+    option :protect_sensitive_fields, default: true
+    option :raise_not_found_error, default: true
+    option :scope_overwrite_exception, default: false
+    option :skip_version_check, default: false
+    option :use_activesupport_time_zone, default: true
+    option :use_utc, default: false
 
-    option :allow_dynamic_fields, :default => true
-    option :autocreate_indexes, :default => false
-    option :identity_map_enabled, :default => false
-    option :include_root_in_json, :default => false
-    option :include_type_for_serialization, :default => false
-    option :max_retries_on_connection_failure, :default => 0
-    option :parameterize_keys, :default => true
-    option :scope_overwrite_exception, :default => false
-    option :persist_in_safe_mode, :default => false
-    option :preload_models, :default => false
-    option :raise_not_found_error, :default => true
-    option :skip_version_check, :default => false
-    option :time_zone, :default => nil
-    option :use_utc, :default => false
-
-    # Adds a new I18n locale file to the load path.
-    #
-    # @example Add a portuguese locale.
-    #   Mongoid::Config.add_language('pt')
-    #
-    # @example Add all available languages.
-    #   Mongoid::Config.add_language('*')
-    #
-    # @param [ String ] language_code The language to add.
-    def add_language(language_code = nil)
-      Dir[
-        File.join(
-          File.dirname(__FILE__), "..", "config", "locales", "#{language_code}.yml"
-      )
-      ].each do |file|
-        I18n.load_path << File.expand_path(file)
-      end
-    end
-
-    # keys to remove from self to not pass through to Mongo::Connection
-    PRIVATE_OPTIONS =
-      %w(uri host hosts port database databases username
-         password logger use_activesupport_time_zone)
-
-    # Get the blacklisted options from passing through to the driver.
+    # Connect to the provided database name on the default session.
     #
-    # @example Get the blacklisted options.
-    #   Config.blacklisted_options
+    # @note Use only in development or test environments for convenience.
     #
-    # @return [ Array<String> ] The blacklist.
+    # @example Set the database to connect to.
+    #   config.connect_to("mongoid_test")
     #
-    # @since 2.4.7
-    def blacklisted_options
-      PRIVATE_OPTIONS + settings.keys.map(&:to_s)
-    end
-
-    # Get any extra databases that have been configured.
-    #
-    # @example Get the extras.
-    #   config.databases
+    # @param [ String ] name The database name.
     #
-    # @return [ Hash ] A hash of secondary databases.
-    def databases
-      configure_extras(@settings["databases"]) unless @databases || !@settings
-      @databases || {}
-    end
-
-    # @todo Durran: There were no tests around the databases setter, not sure
-    # what the exact expectation was. Set with a hash?
-    def databases=(databases)
+    # @since 3.0.0
+    def connect_to(name)
+      self.sessions = {
+        default: {
+          database: name,
+          hosts: [ "localhost:27017" ]
+        }
+      }
     end
 
     # Return field names that could cause destructive things to happen if
@@ -97,21 +55,6 @@ module Mongoid #:nodoc
       Components.prohibited_methods
     end
 
-    # Configure mongoid from a hash. This is usually called after parsing a
-    # yaml config file such as mongoid.yml.
-    #
-    # @example Configure Mongoid.
-    #   config.from_hash({})
-    #
-    # @param [ Hash ] options The settings to use.
-    def from_hash(options = {})
-      options.except("database", "slaves", "databases").each_pair do |name, value|
-        send("#{name}=", value) if respond_to?("#{name}=")
-      end
-      @master, @slaves = configure_databases(options)
-      configure_extras(options["databases"])
-    end
-
     # Load the settings from a compliant mongoid.yml file. This can be used for
     # easy setup with frameworks other than Rails.
     #
@@ -119,48 +62,41 @@ module Mongoid #:nodoc
     #   Mongoid.load!("/path/to/mongoid.yml")
     #
     # @param [ String ] path The path to the file.
+    # @param [ String, Symbol ] environment The environment to load.
     #
     # @since 2.0.1
-    def load!(path)
-      Environment.load_yaml(path).tap do |settings|
-        from_hash(settings) if settings.present?
-      end
+    def load!(path, environment = nil)
+      settings = Environment.load_yaml(path, environment)
+      load_configuration(settings) if settings.present?
+      settings
     end
 
-    # Returns the default logger, which is either a Rails logger of stdout logger
+    # Override the database to use globally.
     #
-    # @example Get the default logger
-    #   config.default_logger
+    # @example Override the database globally.
+    #   config.override_database(:optional)
     #
-    # @return [ Logger ] The default Logger instance.
-    def default_logger
-      defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : ::Logger.new($stdout)
-    end
-
-    # Returns the logger, or defaults to Rails logger or stdout logger.
+    # @param [ String, Symbol ] name The name of the database.
     #
-    # @example Get the logger.
-    #   config.logger
+    # @return [ String, Symbol ] The global override.
     #
-    # @return [ Logger ] The configured logger or a default Logger instance.
-    def logger
-      @logger = default_logger unless defined?(@logger)
-      @logger
+    # @since 3.0.0
+    def override_database(name)
+      Threaded.database_override = name
     end
 
-    # Sets the logger for Mongoid to use.
-    #
-    # @example Set the logger.
-    #   config.logger = Logger.new($stdout, :warn)
-    #
-    # @return [ Logger ] The newly set logger.
-    def logger=(logger)
-      case logger
-      when false, nil then @logger = nil
-      when true then @logger = default_logger
-      else
-        @logger = logger if logger.respond_to?(:info)
-      end
+    # Override the session to use globally.
+    #
+    # @example Override the session globally.
+    #   config.override_session(:optional)
+    #
+    # @param [ String, Symbol ] name The name of the session.
+    #
+    # @return [ String, Symbol ] The global override.
+    #
+    # @since 3.0.0
+    def override_session(name)
+      Threaded.session_override = name ? name.to_s : nil
     end
 
     # Purge all data in all collections, including indexes.
@@ -168,143 +104,86 @@ module Mongoid #:nodoc
     # @example Purge all data.
     #   Mongoid::Config.purge!
     #
+    # @return [ true ] true.
+    #
     # @since 2.0.2
     def purge!
-      master.collections.map do |collection|
-        collection.drop if collection.name !~ /system/
-      end
+      Sessions.default.collections.each do |collection|
+        collection.drop
+      end and true
     end
 
-    # Sets whether the times returned from the database use the ruby or
-    # the ActiveSupport time zone.
+    # Set the configuration options. Will validate each one individually.
     #
-    # @note If you omit this setting, then times will use the ruby time zone.
+    # @example Set the options.
+    #   config.options = { raise_not_found_error: true }
     #
-    # @example Set the time zone config.
-    #   Config.use_activesupport_time_zone = true
+    # @param [ Hash ] options The configuration options.
     #
-    # @param [ true, false ] value Whether to use Active Support time zones.
-    #
-    # @return [ true, false ] The supplied value or false if nil.
-    def use_activesupport_time_zone=(value)
-      @use_activesupport_time_zone = value || false
+    # @since 3.0.0
+    def options=(options)
+      if options
+        options.each_pair do |option, value|
+          Validators::Option.validate(option)
+          send("#{option}=", value)
+        end
+      end
     end
-    attr_reader :use_activesupport_time_zone
-    alias_method :use_activesupport_time_zone?, :use_activesupport_time_zone
 
-    # Sets the Mongo::DB master database to be used. If the object trying to be
-    # set is not a valid +Mongo::DB+, then an error will be raised.
+    # Get the session configuration or an empty hash.
     #
-    # @example Set the master database.
-    #   config.master = Mongo::Connection.new.db("test")
+    # @example Get the sessions configuration.
+    #   config.sessions
     #
-    # @param [ Mongo::DB ] db The master database.
+    # @return [ Hash ] The sessions configuration.
     #
-    # @raise [ Errors::InvalidDatabase ] If the master isnt a valid object.
-    #
-    # @return [ Mongo::DB ] The master instance.
-    def master=(db)
-      check_database!(db)
-      @master = db
+    # @since 3.0.0
+    def sessions
+      @sessions ||= {}
     end
-    alias :database= :master=
 
-    # Returns the master database, or if none has been set it will raise an
-    # error.
+    # Set the session configuration options.
     #
-    # @example Get the master database.
-    #   config.master
+    # @example Set the session configuration options.
+    #   config.sessions = { default: { hosts: [ "localhost:27017" ] }}
     #
-    # @raise [ Errors::InvalidDatabase ] If the database was not set.
+    # @param [ Hash ] sessions The configuration options.
     #
-    # @return [ Mongo::DB ] The master database.
-    def master
-      unless @master
-        @master, @slaves = configure_databases(@settings) unless @settings.blank?
-        raise Errors::InvalidDatabase.new(nil) unless @master
-      end
-      if @reconnect
-        @reconnect = false
-        reconnect!
-      end
-      @master
+    # @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
     end
-    alias :database :master
-
-    # Convenience method for connecting to the master database after forking a
-    # new process.
-    #
-    # @example Reconnect to the master.
-    #   Mongoid.reconnect!
-    #
-    # @param [ true, false ] now Perform the reconnection immediately?
-    def reconnect!(now = true)
-      if now
-        master.connection.connect
-      else
-        # We set a @reconnect flag so that #master knows to reconnect the next
-        # time the connection is accessed.
-        @reconnect = true
-      end
-    end
-
-    protected
 
-    # Check if the database is valid and the correct version.
+    # Get the time zone to use.
     #
-    # @example Check if the database is valid.
-    #   config.check_database!
+    # @example Get the time zone.
+    #   Config.time_zone
     #
-    # @param [ Mongo::DB ] database The db to check.
+    # @return [ String ] The time zone.
     #
-    # @raise [ Errors::InvalidDatabase ] If the object is not valid.
-    # @raise [ Errors::UnsupportedVersion ] If the db version is too old.
-    def check_database!(database)
-      raise Errors::InvalidDatabase.new(database) unless database.kind_of?(Mongo::DB)
-      unless skip_version_check
-        version = database.connection.server_version
-        raise Errors::UnsupportedVersion.new(version) if version < Mongoid::MONGODB_VERSION
-      end
+    # @since 3.0.0
+    def time_zone
+      use_utc? ? "UTC" : ::Time.zone
     end
 
-    # Get a database from settings.
-    #
-    # @example Configure the master and slave dbs.
-    #   config.configure_databases("database" => "mongoid")
-    #
-    # @param [ Hash ] options The options to use.
-    #
-    # @option options [ String ] :database The database name.
-    # @option options [ String ] :host The database host.
-    # @option options [ String ] :password The password for authentication.
-    # @option options [ Integer ] :port The port for the database.
-    # @option options [ Array<Hash> ] :slaves The slave db options.
-    # @option options [ String ] :uri The uri for the database.
-    # @option options [ String ] :username The user for authentication.
-    #
-    # @since 2.0.0.rc.1
-    def configure_databases(options)
-      if options.has_key?('hosts')
-        ReplsetDatabase.new(options).configure
-      else
-        Database.new(options).configure
-      end
-    end
+    private
 
-    # Get the secondary databases from settings.
+    # From a hash of settings, load all the configuration.
     #
-    # @example Configure the master and slave dbs.
-    #   config.configure_extras("databases" => settings)
+    # @example Load the configuration.
+    #   config.load_configuration(settings)
     #
-    # @param [ Hash ] options The options to use.
+    # @param [ Hash ] settings The configuration settings.
     #
-    # @since 2.0.0.rc.1
-    def configure_extras(extras)
-      @databases = (extras || []).inject({}) do |dbs, (name, options)|
-        dbs.tap do |extra|
-        dbs[name], dbs["#{name}_slaves"] = configure_databases(options)
-        end
-      end
+    # @since 3.0.0
+    def load_configuration(settings)
+      configuration = settings.with_indifferent_access
+      self.options = configuration[:options]
+      self.sessions = configuration[:sessions]
     end
   end
 end

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

@@ -0,0 +1,109 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    module Aggregable
+      # Contains behaviour for aggregating values in memory.
+      module Memory
+
+        # Get the average value of the provided field.
+        #
+        # @example Get the average of a single field.
+        #   aggregable.avg(:likes)
+        #
+        # @param [ Symbol ] field The field to average.
+        #
+        # @return [ Float ] The average.
+        #
+        # @since 3.0.0
+        def avg(field)
+          count > 0 ? sum(field).to_f / count.to_f : nil
+        end
+
+        # Get the max value of the provided field. If provided a block, will
+        # return the Document with the greatest value for the field, in
+        # accordance with Ruby's enumerable API.
+        #
+        # @example Get the max of a single field.
+        #   aggregable.max(:likes)
+        #
+        # @example Get the document with the max value.
+        #   aggregable.max do |a, b|
+        #     a.likes <=> b.likes
+        #   end
+        #
+        # @param [ Symbol ] field The field to max.
+        #
+        # @return [ Float, Document ] The max value or document with the max
+        #   value.
+        #
+        # @since 3.0.0
+        def max(field = nil)
+          block_given? ? super() : aggregate_by(field, :max_by)
+        end
+
+        # Get the min value of the provided field. If provided a block, will
+        # return the Document with the smallest value for the field, in
+        # accordance with Ruby's enumerable API.
+        #
+        # @example Get the min of a single field.
+        #   aggregable.min(:likes)
+        #
+        # @example Get the document with the min value.
+        #   aggregable.min do |a, b|
+        #     a.likes <=> b.likes
+        #   end
+        #
+        # @param [ Symbol ] field The field to min.
+        #
+        # @return [ Float, Document ] The min value or document with the min
+        #   value.
+        #
+        # @since 3.0.0
+        def min(field = nil)
+          block_given? ? super() : aggregate_by(field, :min_by)
+        end
+
+        # Get the sum value of the provided field. If provided a block, will
+        # return the sum in accordance with Ruby's enumerable API.
+        #
+        # @example Get the sum of a single field.
+        #   aggregable.sum(:likes)
+        #
+        # @example Get the sum for the provided block.
+        #   aggregable.sum(&:likes)
+        #
+        # @param [ Symbol ] field The field to sum.
+        #
+        # @return [ Float ] The sum value.
+        #
+        # @since 3.0.0
+        def sum(field = nil)
+          if block_given?
+            super()
+          else
+            count > 0 ? super(0) { |doc| doc.send(field) } : nil
+          end
+        end
+
+        private
+
+        # Aggregate by the provided field and method.
+        #
+        # @api private
+        #
+        # @example Aggregate by the field and method.
+        #   aggregable.aggregate_by(:name, :min_by)
+        #
+        # @param [ Symbol ] field The field to aggregate on.
+        # @param [ Symbol ] method The method (min_by or max_by).
+        #
+        # @return [ Integer ] The aggregate.
+        #
+        # @since 3.0.0
+        def aggregate_by(field, method)
+          count > 0 ? send(method) { |doc| doc.send(field) }.send(field) : nil
+        end
+      end
+    end
+  end
+end