mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/config/environment.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc
+module Mongoid
   module Config
 
     # Encapsulates logic for getting environment information.
@@ -8,13 +8,11 @@ module Mongoid #:nodoc
 
       # Get the name of the environment that we are running under. This first
       # looks for Rails, then Sinatra, then a RACK_ENV environment variable,
-      # and if none of those are found raises an error.
+      # and if none of those are found returns "development".
       #
       # @example Get the env name.
       #   Environment.env_name
       #
-      # @raise [ Errors::NoEnvironment ] If no environment was set.
-      #
       # @return [ String ] The name of the current environment.
       #
       # @since 2.3.0
@@ -35,8 +33,9 @@ module Mongoid #:nodoc
       # @return [ Hash ] The settings.
       #
       # @since 2.3.0
-      def load_yaml(path)
-        YAML.load(ERB.new(File.new(path).read).result)[env_name]
+      def load_yaml(path, environment = nil)
+        env = environment ? environment.to_s : env_name
+        YAML.load(ERB.new(File.new(path).read).result)[env]
       end
     end
   end

data/lib/mongoid/config/inflections.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.singular(/address$/, "address")
+  inflect.singular("addresses", "address")
+  inflect.irregular("canvas", "canvases")
+end

data/lib/mongoid/config/options.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc
+module Mongoid
   module Config
 
     # Encapsulates logic for setting options.

data/lib/mongoid/config/validators.rb

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

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

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid
+  module Config
+    module Validators
+
+      # Validator for configuration options.
+      module Option
+        extend self
+
+        # Validate a configuration option.
+        #
+        # @example Validate a configuraiton option.
+        #
+        # @param [ String ] option The name of the option.
+        #
+        # @since 3.0.0
+        def validate(option)
+          unless Config.settings.keys.include?(option.to_sym)
+            raise Errors::InvalidConfigOption.new(option)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+# encoding: utf-8
+module Mongoid
+  module Config
+    module Validators
+
+      # Validator for session specific configuration.
+      module Session
+        extend self
+
+        STANDARD = [ :database, :hosts, :username, :password ]
+
+        # Validate the session configuration.
+        #
+        # @example Validate the session config.
+        #   Session.validate({ default: { hosts: [ "localhost:27017" ] }})
+        #
+        # @param [ Hash ] sessions The sessions config.
+        #
+        # @since 3.0.0
+        def validate(sessions)
+          unless sessions.has_key?(:default)
+            raise Errors::NoDefaultSession.new(sessions.keys)
+          end
+          sessions.each_pair do |name, config|
+            validate_session_database(name, config)
+            validate_session_hosts(name, config)
+            validate_session_uri(name, config)
+          end
+        end
+
+        private
+
+        # Validate that the session config has database.
+        #
+        # @api private
+        #
+        # @example Validate the session has database.
+        #   validator.validate_session_database(:default, {})
+        #
+        # @param [ String, Symbol ] name The config key.
+        # @param [ Hash ] config The configuration.
+        #
+        # @since 3.0.0
+        def validate_session_database(name, config)
+          if no_database_or_uri?(config)
+            raise Errors::NoSessionDatabase.new(name, config)
+          end
+        end
+
+        # Validate that the session config has hosts.
+        #
+        # @api private
+        #
+        # @example Validate the session has hosts.
+        #   validator.validate_session_hosts(:default, {})
+        #
+        # @param [ String, Symbol ] name The config key.
+        # @param [ Hash ] config The configuration.
+        #
+        # @since 3.0.0
+        def validate_session_hosts(name, config)
+          if no_hosts_or_uri?(config)
+            raise Errors::NoSessionHosts.new(name, config)
+          end
+        end
+
+        # Validate that not both a uri and standard options are provided for a
+        # single session.
+        #
+        # @api private
+        #
+        # @example Validate the uri and options.
+        #   validator.validate_session_uri(:default, {})
+        #
+        # @param [ String, Symbol ] name The config key.
+        # @param [ Hash ] config The configuration.
+        #
+        # @since 3.0.0
+        def validate_session_uri(name, config)
+          if both_uri_and_standard?(config)
+            raise Errors::MixedSessionConfiguration.new(name, config)
+          end
+        end
+
+        # Return true if the configuration has no database or uri option
+        # defined.
+        #
+        # @api private
+        #
+        # @example Validate the options.
+        #   validator.no_database_or_uri?(config)
+        #
+        # @param [ Hash ] config The configuration options.
+        #
+        # @return [ true, false ] If no database or uri is defined.
+        #
+        # @since 3.0.0
+        def no_database_or_uri?(config)
+          !config.has_key?(:database) && !config.has_key?(:uri)
+        end
+
+        # Return true if the configuration has no hosts or uri option
+        # defined.
+        #
+        # @api private
+        #
+        # @example Validate the options.
+        #   validator.no_hosts_or_uri?(config)
+        #
+        # @param [ Hash ] config The configuration options.
+        #
+        # @return [ true, false ] If no hosts or uri is defined.
+        #
+        # @since 3.0.0
+        def no_hosts_or_uri?(config)
+          !config.has_key?(:hosts) && !config.has_key?(:uri)
+        end
+
+        # Return true if the configuration has both standard options and a uri
+        # defined.
+        #
+        # @api private
+        #
+        # @example Validate the options.
+        #   validator.no_database_or_uri?(config)
+        #
+        # @param [ Hash ] config The configuration options.
+        #
+        # @return [ true, false ] If both standard and uri are defined.
+        #
+        # @since 3.0.0
+        def both_uri_and_standard?(config)
+          config.has_key?(:uri) && config.keys.any? do |key|
+            STANDARD.include?(key.to_sym)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/contextual.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+require "mongoid/contextual/memory"
+require "mongoid/contextual/mongo"
+
+module Mongoid
+  module Contextual
+
+    # The aggregate operations provided in the aggregate module get delegated
+    # through to the context from the criteria.
+    delegate(*Aggregable::Mongo.public_instance_methods(false), to: :context)
+
+    # The atomic operations provided in the atomic context get delegated
+    # through to the context from the criteria.
+    delegate(*Atomic.public_instance_methods(false), to: :context)
+
+    # The methods in the contexts themselves should all get delegated to,
+    # including destructive, modification, and optional methods.
+    delegate(*(Mongo.public_instance_methods(false) - [ :skip, :limit ]), to: :context)
+
+    # Get the context in which criteria queries should execute. This is either
+    # in memory (for embedded documents) or mongo (for root level documents.)
+    #
+    # @example Get the context.
+    #   criteria.context
+    #
+    # @return [ Memory, Mongo ] The context.
+    #
+    # @since 3.0.0
+    def context
+      @context ||= create_context
+    end
+
+    private
+
+    # Create the context for the queries to execute. Will be memory for
+    # embedded documents and mongo for root documents.
+    #
+    # @api private
+    #
+    # @example Create the context.
+    #   contextual.create_context
+    #
+    # @return [ Mongo, Memory ] The context.
+    #
+    # @since 3.0.0
+    def create_context
+      embedded ? Memory.new(self) : Mongo.new(self)
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# 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)
+          if block_given?
+            super()
+          else
+            count > 0 ? max_by { |doc| doc.send(field) }.send(field) : nil
+          end
+        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)
+          if block_given?
+            super()
+          else
+            count > 0 ? min_by { |doc| doc.send(field) }.send(field) : nil
+          end
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,181 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    module Aggregable
+      # Contains behaviour for aggregating values in Mongo.
+      module Mongo
+
+        # Get all the aggregate values for the provided field.
+        #
+        # @example Get all the aggregate values.
+        #   aggregable.aggregates(:likes)
+        #
+        # @param [ String, Symbol ] field The field name.
+        #
+        # @return [ Hash ] The aggregate values in the form:
+        #   {
+        #     "count" => 2.0,
+        #     "max" => 1000.0,
+        #     "min" => 500.0,
+        #     "sum" => 1500.0,
+        #     "avg" => 750.0
+        #   }
+        #
+        # @since 3.0.0
+        def aggregates(field)
+          if query.count > 0
+            map_reduce(mapper(field), reducer).
+              out(inline: 1).finalize(finalizer).first["value"]
+          else
+            { "count" => 0 }
+          end
+        end
+
+        # 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)
+          aggregates(field)["avg"]
+        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() : aggregates(field)["max"]
+        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() : aggregates(field)["min"]
+        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)
+          block_given? ? super() : aggregates(field)["sum"]
+        end
+
+        private
+
+        # Get the finalize function.
+        #
+        # @api private
+        #
+        # @example Get the finalize function.
+        #   aggregable.finalizer
+        #
+        # @return [ String ] The finalize JS function.
+        #
+        # @since 3.0.0
+        def finalizer
+          %Q{
+          function(key, agg) {
+            agg.avg = agg.sum / agg.count;
+            return agg;
+          }}
+        end
+
+        # Get the map function for the provided field.
+        #
+        # @api private
+        #
+        # @example Get the map function.
+        #   aggregable.mapper(:likes)
+        #
+        # @param [ String, Symbol ] field The name of the field.
+        #
+        # @return [ String ] The map JS function.
+        #
+        # @since 3.0.0
+        def mapper(field)
+          %Q{
+          function() {
+            var agg = {
+              count: 1,
+              max: this.#{field},
+              min: this.#{field},
+              sum: this.#{field}
+            };
+            emit("#{field}", agg);
+          }}
+        end
+
+        # Get the reduce function for the provided field.
+        #
+        # @api private
+        #
+        # @example Get the reduce function.
+        #   aggregable.reducer(:likes)
+        #
+        # @return [ String ] The reduce JS function.
+        #
+        # @since 3.0.0
+        def reducer
+          %Q{
+          function(key, values) {
+            var agg = { count: 0, max: null, min: null, sum: 0 };
+            values.forEach(function(val) {
+              if (agg.max == null || val.max > agg.max) agg.max = val.max;
+              if (agg.min == null || val.max < agg.min) agg.min = val.max;
+              agg.count += 1;
+              agg.sum += val.sum;
+            });
+            return agg;
+          }}
+        end
+      end
+    end
+  end
+end