mongo 0.18.1 → 0.18.2

data/README.rdoc

@@ -13,7 +13,7 @@ Here is a quick code sample. See the MongoDB Ruby Tutorial
   @coll = db.collection('test')
 
   @coll.remove
-  3.times do |i| 
+  3.times do |i|
     @coll.insert({'a' => i+1})
   end
   puts "There are #{@coll.count()} records. Here they are:"
@@ -254,7 +254,7 @@ Random cursor fun facts:
 
 = Testing
 
-If you have the source code, you can run the tests. There's a separate rake task for testing with 
+If you have the source code, you can run the tests. There's a separate rake task for testing with
 the mongo_ext c extension enabled.
 
   $ rake test:c
@@ -329,63 +329,7 @@ See HISTORY.
 
 = Credits
 
-Adrian Madrid, aemadrid@gmail.com
-* bin/mongo_console
-* examples/benchmarks.rb
-* examples/irb.rb
-* Modifications to examples/simple.rb
-* Found plenty of bugs and missing features.
-* Ruby 1.9 support.
-* Gem support.
-* Many other code suggestions and improvements.
-
-Aman Gupta, aman@tmm1.net
-* Collection#save
-
-Jon Crosby, jon@joncrosby.me
-* Some code clean-up
-
-John Nunemaker, http://railstips.org
-* Collection#create_index takes symbols as well as strings
-* Fix for Collection#save
-* Add logger convenience methods to connection and database
-
-David James, djames@sunlightfoundation.com
-* Fix dates to return as UTC
-
-Paul Dlug, paul.dlug@gmail.com
-* Generate _id on the client side if not provided
-* Collection#insert and Collection#save return _id
-
-Durran Jordan, durran@gmail.com
-* DB#collections
-* Support for specifying sort order as array of [key, direction] pairs
-
-Cyril Mougel, cyril.mougel@gmail.com
-* Initial logging support
-* Test case
-
-Jack Chen, chendo on github
-* Test case + fix for deserializing pre-epoch Time instances
-
-Michael Bernstein, mrb on github
-* #sort method for Cursor instances
-
-Paulo Ahahgon, pahagon on github
-* removed hard limit
-
-Les Hill, leshill on github
-* OrderedHash#each returns self
-
-Sean Cribbs, seancribbs on github
-* Modify standard_benchmark to allow profiling
-
-Sunny Hirai
-* Suggested hashcode fix for Mongo::ObjectID
-* Noted index ordering bug.
-
-Christos Trochalakis
-* Added map/reduce helper
+See CREDITS.
 
 = License
 

data/Rakefile

@@ -1,3 +1,4 @@
+# -*- mode: ruby; -*-
 require 'rubygems'
 require 'rubygems/specification'
 require 'fileutils'
@@ -12,9 +13,6 @@ require 'rbconfig'
 include Config
 ENV['TEST_MODE'] = 'TRUE'
 
-gem_command = "gem"
-gem_command = "gem1.9" if $0.match(/1\.9$/) # use gem1.9 if we used rake1.9
-
 desc "Test the MongoDB Ruby driver."
 task :test do
   puts "\nThis option has changed."
@@ -95,20 +93,16 @@ namespace :gem do
 
   desc "Install the gem locally"
   task :install do
-    sh <<EOS
-#{gem_command} build mongo-ruby-driver.gemspec &&
-    #{gem_command} install mongo-*.gem &&
-    rm mongo-*.gem
-EOS
+    sh "gem build mongo-ruby-driver.gemspec"
+    sh "gem install mongo-*.gem"
+    sh "rm mongo-*.gem"
   end
 
   desc "Install the optional c extensions"
   task :install_extensions do
-    sh <<EOS
-#{gem_command} build mongo-extensions.gemspec &&
-    #{gem_command} install mongo_ext-*.gem &&
-    rm mongo_ext-*.gem
-EOS
+    sh "gem build mongo-extensions.gemspec"
+    sh "gem install mongo_ext-*.gem"
+    sh "rm mongo_ext-*.gem"
   end
 
 end

data/bin/perf.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'mongo'
+require 'benchmark'
+require 'socket'
+require 'digest/md5'
+require 'thread'
+
+include Mongo
+
+c  = Mongo::Connection.new('localhost', 27017, :pool_size => 10)
+coll = c['perf']['docs']
+coll.remove
+
+doc = {'name' => 'kyle', 
+       'languages' => ['ruby', 'javascript', 'c'],
+       'date'      => Time.now}
+
+TRIES = 5000
+@threads = []
+100.times do |n|
+  @threads << Thread.new do
+    50.times do |n|
+    doc['n'] = n*n
+    coll.insert(doc)
+    doc.delete(:_id)
+    end
+  end
+end
+@threads.join

data/examples/cursor.rb

@@ -33,14 +33,14 @@ array = cursor.to_a
 cursor.each { |row| pp row }
 
 # You can get the next object
-first_object = coll.find().next_object
+first_object = coll.find().next_document
 
-# next_object returns nil if there are no more objects that match
+# next_document returns nil if there are no more objects that match
 cursor = coll.find()
-obj = cursor.next_object
+obj = cursor.next_document
 while obj
   pp obj
-  obj = cursor.next_object
+  obj = cursor.next_document
 end
 
 # Destroy the collection

data/examples/types.rb

@@ -30,6 +30,6 @@ coll.insert('array' => [1, 2, 3],
             'null' => nil,
             'symbol' => :zildjian)
 
-pp coll.find().next_object
+pp coll.find().next_document
 
 coll.clear

data/lib/mongo.rb

@@ -4,7 +4,7 @@ module Mongo
   ASCENDING = 1
   DESCENDING = -1
 
-  VERSION = "0.18.1"
+  VERSION = "0.18.2"
 end
 
 begin
@@ -21,7 +21,7 @@ begin
     warn "  You can install the extension as follows:\n  gem install mongo_ext\n"
     warn "  If you continue to receive this message after installing, make sure that the"
     warn "  mongo_ext gem is in your load path and that the mongo_ext and mongo gems are of the same version.\n"
-end 
+end
 
 require 'mongo/types/binary'
 require 'mongo/types/code'

data/lib/mongo/admin.rb

@@ -59,8 +59,7 @@ module Mongo
       raise "Error with profile command: #{doc.inspect}" unless @db.ok?(doc)
     end
 
-    # Return an array contining current profiling information from the
-    # database.
+    # Returns an array containing current profiling information.
     def profiling_info
       Cursor.new(Collection.new(@db, DB::SYSTEM_PROFILE_COLLECTION), :selector => {}).to_a
     end

data/lib/mongo/collection.rb

@@ -100,12 +100,12 @@ module Mongo
     #              objects missed, which were preset at both the start and
     #              end of the query's execution. For details see
     #              http://www.mongodb.org/display/DOCS/How+to+do+Snapshotting+in+the+Mongo+Database
-    # :timeout :: When +true+ (default), the returned cursor will be subject to 
-    #             the normal cursor timeout behavior of the mongod process. 
+    # :timeout :: When +true+ (default), the returned cursor will be subject to
+    #             the normal cursor timeout behavior of the mongod process.
     #             When +false+, the returned cursor will never timeout. Note
     #             that disabling timeout will only work when #find is invoked
     #             with a block. This is to prevent any inadvertant failure to
-    #             close the cursor, as the cursor is explicitly closed when 
+    #             close the cursor, as the cursor is explicitly closed when
     #             block code finishes.
     def find(selector={}, options={})
       fields = options.delete(:fields)
@@ -116,7 +116,7 @@ module Mongo
       hint   = options.delete(:hint)
       snapshot = options.delete(:snapshot)
       if options[:timeout] == false && !block_given?
-        raise ArgumentError, "Timeout can be set to false only when #find is invoked with a block." 
+        raise ArgumentError, "Timeout can be set to false only when #find is invoked with a block."
       end
       timeout = block_given? ? (options.delete(:timeout) || true) : true
       if hint
@@ -126,7 +126,7 @@ module Mongo
       end
       raise RuntimeError, "Unknown options [#{options.inspect}]" unless options.empty?
 
-      cursor = Cursor.new(self, :selector => selector, :fields => fields, :skip => skip, :limit => limit, 
+      cursor = Cursor.new(self, :selector => selector, :fields => fields, :skip => skip, :limit => limit,
                           :order => sort, :hint => hint, :snapshot => snapshot, :timeout => timeout)
       if block_given?
         yield cursor
@@ -158,7 +158,7 @@ module Mongo
              else
                raise TypeError, "spec_or_object_id must be an instance of ObjectID or Hash, or nil"
              end
-      find(spec, options.merge(:limit => -1)).next_object
+      find(spec, options.merge(:limit => -1)).next_document
     end
 
     # Save a document in this collection.
@@ -175,7 +175,8 @@ module Mongo
     #   will be raised on an error. Checking for safety requires an extra
     #   round-trip to the database
     def save(to_save, options={})
-      if id = to_save[:_id] || to_save['_id']
+      if to_save.has_key?(:_id) || to_save.has_key?('_id')
+        id = to_save[:_id] || to_save['_id']
         update({:_id => id}, to_save, :upsert => true, :safe => options.delete(:safe))
         id
       else
@@ -204,14 +205,14 @@ module Mongo
     end
     alias_method :<<, :insert
 
-    # Remove all records from this collection. 
+    # Remove all records from this collection.
     # If +selector+ is specified, only matching documents will be removed.
-    # 
+    #
     # Remove all records from the collection:
     #   @collection.remove
     #   @collection.remove({})
     #
-    # Remove only records that have expired: 
+    # Remove only records that have expired:
     #   @collection.remove({:expire => {'$lte' => Time.now}})
     def remove(selector={})
       message = ByteBuffer.new
@@ -225,7 +226,7 @@ module Mongo
 
     # Update a single document in this collection.
     #
-    # :selector :: a hash specifying elements which must be present for a document to be updated. Note: 
+    # :selector :: a hash specifying elements which must be present for a document to be updated. Note:
     # the update command currently updates only the first document matching the
     # given selector. If you want all matching documents to be updated, be sure
     # to specify :multi => true.
@@ -254,7 +255,7 @@ module Mongo
         @connection.send_message_with_safe_check(Mongo::Constants::OP_UPDATE, message, @db.name,
           "db.#{@name}.update(#{selector.inspect}, #{document.inspect})")
       else
-        @connection.send_message(Mongo::Constants::OP_UPDATE, message, 
+        @connection.send_message(Mongo::Constants::OP_UPDATE, message,
           "db.#{@name}.update(#{selector.inspect}, #{document.inspect})")
       end
     end
@@ -329,7 +330,7 @@ module Mongo
 
       result = @db.command(hash)
       unless result["ok"] == 1
-        raise Mongo::OperationFailure, "map-reduce failed: #{result['errmsg']}" 
+        raise Mongo::OperationFailure, "map-reduce failed: #{result['errmsg']}"
       end
       @db[result["result"]]
     end
@@ -338,48 +339,80 @@ module Mongo
     # Performs a group query, similar to the 'SQL GROUP BY' operation.
     # Returns an array of grouped items.
     #
-    # :keys :: Array of fields to group by
-    # :condition :: specification of rows to be considered (as a 'find'
-    #               query specification)
+    # :key :: either 1) an array of fields to group by, 2) a javascript function to generate
+    #         the key object, or 3) nil.
+    # :condition :: an optional document specifying a query to limit the documents over which group is run.
     # :initial :: initial value of the aggregation counter object
     # :reduce :: aggregation function as a JavaScript string
+    # :finalize :: optional. a JavaScript function that receives and modifies
+    #              each of the resultant grouped objects. Available only when group is run
+    #              with command set to true.
     # :command :: if true, run the group as a command instead of in an
     #             eval - it is likely that this option will eventually be
     #             deprecated and all groups will be run as commands
-    def group(keys, condition, initial, reduce, command=false)
+    def group(key, condition, initial, reduce, command=false, finalize=nil)
+
       if command
-        hash = {}
-        keys.each do |k|
-          hash[k] = 1
-        end
 
         reduce = Code.new(reduce) unless reduce.is_a?(Code)
 
-        result = @db.command({"group" =>
-                                  {
-                                    "ns" => @name,
-                                    "$reduce" => reduce,
-                                    "key" => hash,
-                                    "cond" => condition,
-                                    "initial" => initial}})
+        group_command = {
+          "group" => {
+            "ns"      => @name,
+            "$reduce" => reduce,
+            "cond"    => condition,
+            "initial" => initial
+          }
+        }
+
+        unless key.nil?
+          if key.is_a? Array
+            key_type = "key"
+            key_value = {}
+            key.each { |k| key_value[k] = 1 }
+          else
+            key_type  = "$keyf"
+            key_value = key.is_a?(Code) ? key : Code.new(key)
+          end
+
+          group_command["group"][key_type] = key_value
+        end
+
+        # only add finalize if specified
+        if finalize
+          finalize = Code.new(finalize) unless finalize.is_a?(Code)
+          group_command['group']['finalize'] = finalize
+        end
+
+        result = @db.command group_command
+
         if result["ok"] == 1
           return result["retval"]
         else
           raise OperationFailure, "group command failed: #{result['errmsg']}"
         end
-      end
 
-      case reduce
-      when Code
-        scope = reduce.scope
       else
-        scope = {}
-      end
-      scope.merge!({
-                     "ns" => @name,
-                     "keys" => keys,
-                     "condition" => condition,
-                     "initial" => initial })
+
+        warn "Collection#group must now be run as a command; you can do this by passing 'true' as the command argument."
+
+        raise OperationFailure, ":finalize can be specified only when " +
+          "group is run as a command (set command param to true)" if finalize
+
+        raise OperationFailure, "key must be an array of fields to group by. If you want to pass a key function, 
+          run group as a command by passing 'true' as the command argument." unless key.is_a? Array || key.nil?
+
+        case reduce
+        when Code
+          scope = reduce.scope
+        else
+          scope = {}
+        end
+        scope.merge!({
+                       "ns" => @name,
+                       "keys" => key,
+                       "condition" => condition,
+                       "initial" => initial })
 
       group_function = <<EOS
 function () {
@@ -406,7 +439,8 @@ function () {
     return {"result": map.values()};
 }
 EOS
-      @db.eval(Code.new(group_function, scope))["result"]
+        @db.eval(Code.new(group_function, scope))["result"]
+      end
     end
 
     # Returns a list of distinct values for +key+ across all
@@ -422,11 +456,17 @@ EOS
     #     [10010, 94108, 99701]
     #   @collection.distinct("name.age")
     #     [27, 24]
-    def distinct(key)
+    #
+    # You may also pass a document selector as the second parameter
+    # to limit the documents over which distinct is run:
+    #   @collection.distinct("name.age", {"name.age" => {"$gt" => 24}})
+    #     [27]
+    def distinct(key, query=nil)
       raise MongoArgumentError unless [String, Symbol].include?(key.class)
       command = OrderedHash.new
       command[:distinct] = @name
-      command[:key]        = key.to_s
+      command[:key]      = key.to_s
+      command[:query]    = query
 
       @db.command(command)["values"]
     end
@@ -472,7 +512,7 @@ EOS
     # 'create' will be the collection name. For the other possible keys
     # and values, see DB#create_collection.
     def options
-      @db.collections_info(@name).next_object()['options']
+      @db.collections_info(@name).next_document['options']
     end
 
     # Get the number of documents in this collection.
@@ -501,7 +541,7 @@ EOS
 
     private
 
-    # Sends an Mongo::Constants::OP_INSERT message to the database.
+    # Sends a Mongo::Constants::OP_INSERT message to the database.
     # Takes an array of +documents+, an optional +collection_name+, and a
     # +check_keys+ setting.
     def insert_documents(documents, collection_name=@name, check_keys=true, safe=false)
@@ -523,7 +563,7 @@ EOS
       indexes = []
       spec.each_pair do |field, direction|
         indexes.push("#{field}_#{direction}")
-      end 
+      end
       indexes.join("_")
     end
   end