mongoid 2.4.10 → 3.0.0

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

data/lib/mongoid/contextual/atomic.rb

@@ -0,0 +1,179 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    module Atomic
+
+      # Execute an atomic $addToSet on the matching documents.
+      #
+      # @example Add the value to the set.
+      #   context.add_to_set(:members, "Dave")
+      #
+      # @param [ String, Symbol ] field The name of the field to add to.
+      # @param [ Object ] value The single value to add.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def add_to_set(field, value)
+        query.update_all("$addToSet" => { field => value })
+      end
+
+      # Perform an atomic $bit operation on the matching documents.
+      #
+      # @example Perform the bitwise op.
+      #   context.bit(:likes, { and: 14, or: 4 })
+      #
+      # @param [ String, Symbol ] field The name of the field to operate on.
+      # @param [ Hash ] value The bitwise operations to perform. Keys may be
+      #   "and" or "or" and must have numeric values.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def bit(field, value)
+        query.update_all("$bit" => { field => value })
+      end
+
+      # Perform an atomic $inc operation on the matching documents.
+      #
+      # @example Perform the atomic increment.
+      #   context.inc(:likes, 10)
+      #
+      # @param [ String, Symbol ] field The field to increment.
+      # @param [ Integer ] value The amount to increment by.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def inc(field, value)
+        query.update_all("$inc" => { field => value })
+      end
+
+      # Perform an atomic $pop operation on the matching documents.
+      #
+      # @example Pop the first value on the matches.
+      #   context.pop(:members, -1)
+      #
+      # @example Pop the last value on the matches.
+      #   context.pop(:members, 1)
+      #
+      # @param [ String, Symbol ] field The name of the array field to pop
+      #   from.
+      # @param [ Integer ] value 1 to pop from the end, -1 to pop from the
+      #   front.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def pop(field, value)
+        query.update_all("$pop" => { field => value })
+      end
+
+      # Perform an atomic $pull operation on the matching documents.
+      #
+      # @example Pull the value from the matches.
+      #   context.pull(:members, "Dave")
+      #
+      # @note Expression pulling is not yet supported.
+      #
+      # @param [ String, Symbol ] field The field to pull from.
+      # @param [ Object ] value The single value to pull.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def pull(field, value)
+        query.update_all("$pull" => { field => value })
+      end
+
+      # Perform an atomic $pullAll operation on the matching documents.
+      #
+      # @example Pull all the matching values from the matches.
+      #   context.pull_all(:members, [ "Alan", "Vince" ])
+      #
+      # @param [ String, Symbol ] field The field to pull from.
+      # @param [ Array<Object> ] values The values to pull.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def pull_all(field, values)
+        query.update_all("$pullAll" => { field => values })
+      end
+
+      # Perform an atomic $push operation on the matching documents.
+      #
+      # @example Push the value to the matching docs.
+      #   context.push(:members, "Alan")
+      #
+      # @param [ String, Symbol ] field The field to push to.
+      # @param [ Object ] value The value to push.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def push(field, value)
+        query.update_all("$push" => { field => value })
+      end
+
+      # Perform an atomic $pushAll operation on the matching documents.
+      #
+      # @example Push the values to the matching docs.
+      #   context.push(:members, [ "Alan", "Fletch" ])
+      #
+      # @param [ String, Symbol ] field The field to push to.
+      # @param [ Array<Object> ] values The values to push.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def push_all(field, values)
+        query.update_all("$pushAll" => { field => values })
+      end
+
+      # Perform an atomic $rename of fields on the matching documents.
+      #
+      # @example Rename the fields on the matching documents.
+      #   context.rename(:members, :artists)
+      #
+      # @param [ String, Symbol ] old_name The old field name.
+      # @param [ String, Symbol ] new_name The new field name.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def rename(old_name, new_name)
+        query.update_all("$rename" => { old_name.to_s => new_name.to_s })
+      end
+
+      # Perform an atomic $set of fields on the matching documents.
+      #
+      # @example Set the field value on the matches.
+      #   context.set(:name, "Depeche Mode")
+      #
+      # @param [ String, Symbol ] field The name of the field.
+      # @param [ Object ] value The value to set.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def set(field, value)
+        query.update_all("$set" => { field => value })
+      end
+
+      # Perform an atomic $unset of a field on the matching documents.
+      #
+      # @example Unset the field on the matches.
+      #   context.unset(:name)
+      #
+      # @param [ String, Symbol ] field The name of the field.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 3.0.0
+      def unset(field)
+        query.update_all("$unset" => { field => true })
+      end
+    end
+  end
+end

data/lib/mongoid/contextual/command.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    module Command
+
+      # The database command that is being built to send to the db.
+      #
+      # @example Get the command.
+      #   command.command
+      #
+      # @return [ Hash ] The db command.
+      #
+      # @since 3.0.0
+      def command
+        @command ||= {}
+      end
+
+      # Get the criteria for the command.
+      #
+      # @example Get the criteria.
+      #   command.criteria
+      #
+      # @return [ Criteria ] The criteria.
+      #
+      # @since 3.0.0
+      def criteria
+        @criteria
+      end
+
+      # Get the database session.
+      #
+      # @example Get the session.
+      #   command.session
+      #
+      # @return [ Session ] The Moped session.
+      #
+      # @since 3.0.0
+      def session
+        criteria.klass.mongo_session
+      end
+    end
+  end
+end

data/lib/mongoid/contextual/find_and_modify.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    class FindAndModify
+      include Command
+
+      # @attribute [r] criteria The criteria for the context.
+      # @attribute [r] options The command options.
+      # @attribute [r] update The updates.
+      # @attribute [r] query The Moped query.
+      attr_reader :criteria, :options, :update, :query
+
+      # Initialize the find and modify command, used for MongoDB's
+      # $findAndModify.
+      #
+      # @example Initialize the command.
+      #   FindAndModify.new(criteria, { "$set" => { likes: 1 }})
+      #
+      # @param [ Criteria ] criteria The criteria.
+      # @param [ Hash ] update The updates.
+      # @param [ Hash ] options The command options.
+      #
+      # @option options [ true, false ] :new Return the updated document.
+      # @option options [ true, false ] :remove Delete the first document.
+      # @option options [ true, false ] :upsert Create the document if it doesn't exist.
+      #
+      # @since 3.0.0
+      def initialize(criteria, update, options = {})
+        @criteria, @options, @update = criteria, options, update
+        @query = criteria.klass.collection.find(criteria.selector)
+        apply_criteria_options
+      end
+
+      # Get the result of the $findAndModify.
+      #
+      # @example Get the result.
+      #   find_and_modify.result
+      #
+      # @return [ Hash ] The result of the command.
+      #
+      # @since 3.0.0
+      def result
+        query.modify(update, options)
+      end
+
+      private
+
+      # Apply criteria specific options - query, sort, fields.
+      #
+      # @api private
+      #
+      # @example Apply the criteria options
+      #   map_reduce.apply_criteria_options
+      #
+      # @return [ nil ] Nothing.
+      #
+      # @since 3.0.0
+      def apply_criteria_options
+        if spec = criteria.options[:sort]
+          query.sort(spec)
+        end
+        if spec = criteria.options[:fields]
+          query.select(spec)
+        end
+      end
+    end
+  end
+end