mongoid 2.8.1 → 3.0.0.rc

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,66 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    class FindAndModify
+      include Command
+
+      # 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.
+      #
+      # @since 3.0.0
+      def initialize(criteria, update, options = {})
+        @criteria = criteria
+        command[:findandmodify] = criteria.klass.collection_name.to_s
+        command[:update] = update unless options[:remove]
+        command.merge!(options)
+        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
+        session.with(consistency: :strong) do |session|
+          session.command(command)["value"]
+        end
+      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
+        command[:query] = criteria.selector
+        if sort = criteria.options[:sort]
+          command[:sort] = sort
+        end
+        if fields = criteria.options[:fields]
+          command[:fields] = fields
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/contextual/map_reduce.rb

@@ -0,0 +1,273 @@
+# encoding: utf-8
+module Mongoid
+  module Contextual
+    class MapReduce
+      include Enumerable
+      include Command
+
+      delegate :[], to: :results
+      delegate :==, :empty?, :inspect, to: :entries
+
+      # Get all the counts returned by the map/reduce.
+      #
+      # @example Get the counts.
+      #   map_reduce.counts
+      #
+      # @return [ Hash ] The counts.
+      #
+      # @since 3.0.0
+      def counts
+        results["counts"]
+      end
+
+      # Iterates over each of the documents in the map/reduce, excluding the
+      # extra information that was passed back from the database.
+      #
+      # @example Iterate over the results.
+      #   map_reduce.each do |doc|
+      #     p doc
+      #   end
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 3.0.0
+      def each
+        if block_given?
+          documents.each do |doc|
+            yield doc
+          end
+        else
+          to_enum
+        end
+      end
+
+      # Get the number of documents emitted by the map/reduce.
+      #
+      # @example Get the emitted document count.
+      #   map_reduce.emitted
+      #
+      # @return [ Integer ] The number of emitted documents.
+      #
+      # @since 3.0.0
+      def emitted
+        counts["emit"]
+      end
+
+      # Provide a finalize js function for the map/reduce.
+      #
+      # @example Provide a finalize function.
+      #   map_reduce.finalize(func)
+      #
+      # @param [ String ] function The finalize function.
+      #
+      # @return [ MapReduce ] The map reduce.
+      #
+      # @since 3.0.0
+      def finalize(function)
+        command[:finalize] = function
+        self
+      end
+
+      # Initialize the new map/reduce directive.
+      #
+      # @example Initialize the new map/reduce.
+      #   MapReduce.new(criteria, map, reduce)
+      #
+      # @param [ Criteria ] criteria The Mongoid criteria.
+      # @param [ String ] map The map js function.
+      # @param [ String ] reduce The reduce js function.
+      #
+      # @since 3.0.0
+      def initialize(criteria, map, reduce)
+        @criteria = criteria
+        command[:mapreduce] = criteria.klass.collection_name.to_s
+        command[:map], command[:reduce] = map, reduce
+        apply_criteria_options
+      end
+
+      # Get the number of documents that were input into the map/reduce.
+      #
+      # @example Get the count of input documents.
+      #   map_reduce.input
+      #
+      # @return [ Integer ] The number of input documents.
+      #
+      # @since 3.0.0
+      def input
+        counts["input"]
+      end
+
+      # Sets the map/reduce to use jsMode.
+      #
+      # @example Set the map/reduce to jsMode.
+      #   map_reduce.js_mode
+      #
+      # @return [ MapReduce ] The map/reduce.
+      #
+      # @since 3.0.0
+      def js_mode
+        command[:jsMode] = true
+        self
+      end
+
+      # Specifies where the map/reduce output is to be stored.
+      #
+      # @example Store output in memory.
+      #   map_reduce.out(inline: 1)
+      #
+      # @example Store output in a collection, replacing existing documents.
+      #   map_reduce.out(replace: "collection_name")
+      #
+      # @example Store output in a collection, merging existing documents.
+      #   map_reduce.out(merge: "collection_name")
+      #
+      # @example Store output in a collection, reducing existing documents.
+      #   map_reduce.out(reduce: "collection_name")
+      #
+      # @param [ Hash ] location The place to store the results.
+      #
+      # @return [ MapReduce ] The map/reduce object.
+      #
+      # @since 3.0.0
+      def out(location)
+        normalized = location.dup
+        normalized.update_values do |value|
+          value.is_a?(::Symbol) ? value.to_s : value
+        end
+        command[:out] = normalized
+        self
+      end
+
+      # Get the number of documents output by the map/reduce.
+      #
+      # @example Get the output document count.
+      #   map_reduce.output
+      #
+      # @return [ Integer ] The number of output documents.
+      #
+      # @since 3.0.0
+      def output
+        counts["output"]
+      end
+
+      # Get the raw output from the map/reduce operation.
+      #
+      # @example Get the raw output.
+      #   map_reduce.raw
+      #
+      # @return [ Hash ] The raw output.
+      #
+      # @since 3.0.0
+      def raw
+        results
+      end
+
+      # Get the number of documents reduced by the map/reduce.
+      #
+      # @example Get the reduced document count.
+      #   map_reduce.reduced
+      #
+      # @return [ Integer ] The number of reduced documents.
+      #
+      # @since 3.0.0
+      def reduced
+        counts["reduce"]
+      end
+
+      # Adds a javascript object to the global scope of the map/reduce.
+      #
+      # @example Add an object to the global scope.
+      #   map_reduce.scope(name: value)
+      #
+      # @param [ Hash ] object A hash of key/values for the global scope.
+      #
+      # @return [ MapReduce ]
+      #
+      # @since 3.0.0
+      def scope(object)
+        command[:scope] = object
+        self
+      end
+
+      # Get the execution time of the map/reduce.
+      #
+      # @example Get the execution time.
+      #   map_reduce.time
+      #
+      # @return [ Float ] The time in milliseconds.
+      #
+      # @since 3.0.0
+      def time
+        results["timeMillis"]
+      end
+
+      private
+
+      # Apply criteria specific options - query, sort, limit.
+      #
+      # @api private
+      #
+      # @example Apply the criteria options
+      #   map_reduce.apply_criteria_options
+      #
+      # @return [ nil ] Nothing.
+      #
+      # @since 3.0.0
+      def apply_criteria_options
+        command[:query] = criteria.selector
+        if sort = criteria.options[:sort]
+          command[:orderby] = sort
+        end
+        if limit = criteria.options[:limit]
+          command[:limit] = limit
+        end
+      end
+
+      # Get the result documents from the map/reduce. If the output was inline
+      # then we grab them from the results key. If the output was a temp
+      # collection then we need to execute a find on that collection.
+      #
+      # @api private
+      #
+      # @example Get the documents.
+      #   map_reduce.documents
+      #
+      # @return [ Array, Cursor ] The documents.
+      #
+      # @since 3.0.0
+      def documents
+        return results["results"] if results.has_key?("results")
+        session[output_collection].find
+      end
+
+      # Get the collection that the map/reduce results were stored in.
+      #
+      # @api private
+      #
+      # @example Get the output collection.
+      #   map_reduce.output_collection
+      #
+      # @return [ Symbol, String ] The output collection.
+      #
+      # @since 3.0.0
+      def output_collection
+        command[:out].values.first
+      end
+
+      # Execute the map/reduce command and get the results.
+      #
+      # @api private
+      #
+      # @example Get the results.
+      #   map_reduce.results
+      #
+      # @return [ Hash ] The results of the command.
+      #
+      # @since 3.0.0
+      def results
+        raise Errors::NoMapReduceOutput.new(command) unless command[:out]
+        @results ||= session.command(command)
+      end
+    end
+  end
+end