mongodb-mongo 0.12 → 0.13

data/README.rdoc

@@ -7,9 +7,9 @@ many more.
 
   require 'mongo'
 
-  include XGen::Mongo::Driver
+  include Mongo
 
-  db = Mongo.new('localhost').db('sample-db')
+  db = Connection.new('localhost').db('sample-db')
   coll = db.collection('test')
 
   coll.clear
@@ -70,7 +70,7 @@ Here's how to start mongo and run the "simple.rb" example:
   $ cd path/to/mongo-ruby-driver
   $ ruby examples/simple.rb
 
-See also the test code, especially tests/test_db_api.rb.
+See also the test code, especially test/test_db_api.rb.
 
 = The Driver
 
@@ -79,8 +79,8 @@ Here is some simple example code:
   require 'rubygems'        # not required for Ruby 1.9
   require 'mongo'
 
-  include XGen::Mongo::Driver
-  db = Mongo.new.db('my-db-name')
+  include Mongo
+  db = Connection.new.db('my-db-name')
   things = db.collection('things')
 
   things.clear
@@ -147,10 +147,10 @@ generate _id values. If you want to control _id values or even their types,
 using a PK factory lets you do so.
 
 You can tell the Ruby Mongo driver how to create primary keys by passing in
-the :pk option to the Mongo#db method.
+the :pk option to the Connection#db method.
 
-  include XGen::Mongo::Driver
-  db = Mongo.new.db('dbname', :pk => MyPKFactory.new)
+  include Mongo
+  db = Connection.new.db('dbname', :pk => MyPKFactory.new)
 
 A primary key factory object must respond to :create_pk, which should take a
 hash and return a hash which merges the original hash with any primary key
@@ -164,7 +164,7 @@ Here is a sample primary key factory, taken from the tests:
 
   class TestPKFactory
     def create_pk(row)
-      row['_id'] ||= XGen::Mongo::Driver::ObjectID.new
+      row['_id'] ||= Mongo::ObjectID.new
       row
     end
   end
@@ -178,7 +178,7 @@ ActiveRecord-like framework for non-Rails apps) and the AR Mongo adapter code
     def create_pk(row)
       return row if row[:_id]
       row.delete(:_id)      # in case it exists but the value is nil
-      row['_id'] ||= XGen::Mongo::Driver::ObjectID.new
+      row['_id'] ||= Mongo::ObjectID.new
       row
     end
   end
@@ -205,7 +205,7 @@ completely harmless; strict mode is a programmer convenience only.
 To turn on strict mode, either pass in :strict => true when obtaining a DB
 object or call the :strict= method:
 
-  db = XGen::Mongo::Driver::Mongo.new.db('dbname', :strict => true)
+  db = Connection.new.db('dbname', :strict => true)
   # I'm feeling lax
   db.strict = false
   # No, I'm not!
@@ -233,7 +233,7 @@ If you have the source code, you can run the tests.
   $ rake test
 
 The tests assume that the Mongo database is running on the default port. You
-can override the default host (localhost) and port (Mongo::DEFAULT_PORT) by
+can override the default host (localhost) and port (Connection::DEFAULT_PORT) by
 using the environment variables MONGO_RUBY_DRIVER_HOST and
 MONGO_RUBY_DRIVER_PORT.
 

data/Rakefile

@@ -16,7 +16,7 @@ gem_command = "gem1.9" if $0.match(/1\.9$/) # use gem1.9 if we used rake1.9
 
 # NOTE: some of the tests assume Mongo is running
 Rake::TestTask.new do |t|
-  t.test_files = FileList['tests/test*.rb']
+  t.test_files = FileList['test/test*.rb']
 end
 
 desc "Generate documentation"

data/bin/bson_benchmark.rb

@@ -3,7 +3,7 @@
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 TRIALS = 100000
 

data/bin/mongo_console

@@ -7,14 +7,14 @@ require 'irb'
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = org_argv[0] || ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = org_argv[1] || ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = org_argv[1] || ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 dbnm = org_argv[2] || ENV['MONGO_RUBY_DRIVER_DB']   || 'ruby-mongo-console'
 
 puts "Connecting to #{host}:#{port} (CONN) on with database #{dbnm} (DB)"
-CONN = Mongo.new(host, port)
+CONN = Connection.new(host, port)
 DB = CONN.db(dbnm)
 
 puts "Starting IRB session..."

data/bin/run_test_script

@@ -5,12 +5,12 @@
 
 HERE=`dirname $0`
 
-if [ ! -f $HERE/../tests/mongo-qa/$1 ] ; then
+if [ ! -f $HERE/../test/mongo-qa/$1 ] ; then
     exit 0
 fi
 
 begintime=`date`
-ruby $HERE/../tests/mongo-qa/$1 $3 $4 >> $2
+ruby $HERE/../test/mongo-qa/$1 $3 $4 >> $2
 exitval=$?
 endtime=`date`
 

data/bin/standard_benchmark

@@ -5,7 +5,7 @@
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 TRIALS = 2
 PER_TRIAL = 5000
@@ -50,9 +50,9 @@ def benchmark(str, proc, n, db, coll_name, object, setup=nil)
 end
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
-connection = Mongo.new(host, port)
+connection = Connection.new(host, port)
 connection.drop_database("benchmark")
 db = connection.db('benchmark')
 

data/examples/admin.rb

@@ -2,13 +2,13 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 require 'pp'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 coll = db.create_collection('test')
 
 # Erase all records from collection, if any

data/examples/benchmarks.rb

@@ -4,10 +4,10 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Mongo::Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = XGen::Mongo::Driver::Mongo.new(host, port).db('ruby-mongo-examples')
+db = Mongo::Connection.new(host, port).db('ruby-mongo-examples')
 coll = db.collection('test')
 coll.clear
 

data/examples/blog.rb

@@ -5,17 +5,17 @@ class Exception
     "%s: %s\n%s" % [self.class, message, (backtrace || []).join("\n") << "\n"]
   end
 end
-  
+
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts ">> Connecting to #{host}:#{port}"
-DB = Mongo.new(host, port).db('ruby-mongo-blog')
+DB = Connection.new(host, port).db('ruby-mongo-blog')
 
 LINE_SIZE = 120
 puts "=" * LINE_SIZE

data/examples/capped.rb

@@ -1,13 +1,13 @@
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 db.drop_collection('test')
 
 # A capped collection has a max size and optionally a max number of records.

data/examples/cursor.rb

@@ -2,13 +2,13 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 require 'pp'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Erase all records from collection, if any

data/examples/gridfs.rb

@@ -2,14 +2,14 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 require 'mongo/gridfs'
 
-include XGen::Mongo::Driver
-include XGen::Mongo::GridFS
+include Mongo
+include GridFS
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 
 def dump(db, fname)
   GridStore.open(db, fname, 'r') { |f| puts f.read }

data/examples/index_test.rb

@@ -3,22 +3,22 @@ class Exception
     "%s: %s\n%s" % [self.class, message, (backtrace || []).join("\n") << "\n"]
   end
 end
-  
+
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts ">> Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-index_test')
+db = Connection.new(host, port).db('ruby-mongo-index_test')
 
 puts ">> Dropping collection test"
 begin
   res = db.drop_collection('test')
-  puts "dropped : #{res.inspect}" 
+  puts "dropped : #{res.inspect}"
 rescue => e
   puts "Error: #{e.errmsg}"
 end
@@ -26,7 +26,7 @@ end
 puts ">> Creating collection test"
 begin
   coll = db.collection('test')
-  puts "created : #{coll.inspect}" 
+  puts "created : #{coll.inspect}"
 rescue => e
   puts "Error: #{e.errmsg}"
 end
@@ -59,8 +59,8 @@ puts "created index: #{res.inspect}"
 
 puts ">> Gathering index information"
 begin
-  res = coll.index_information     
-  puts "index_information : #{res.inspect}" 
+  res = coll.index_information
+  puts "index_information : #{res.inspect}"
 rescue => e
   puts "Error: #{e.errmsg}"
 end
@@ -76,7 +76,7 @@ end
 
 puts ">> Dropping index"
 begin
-  res = coll.drop_index "all"
+  res = coll.drop_index "all_1"
   puts "dropped : #{res.inspect}"
 rescue => e
   puts "Error: #{e.errmsg}"
@@ -105,8 +105,8 @@ end
 
 puts ">> Gathering index information"
 begin
-  res = coll.index_information     
-  puts "index_information : #{res.inspect}" 
+  res = coll.index_information
+  puts "index_information : #{res.inspect}"
 rescue => e
   puts "Error: #{e.errmsg}"
 end

data/examples/info.rb

@@ -1,13 +1,13 @@
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Erase all records from collection, if any

data/examples/queries.rb

@@ -2,13 +2,13 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 require 'pp'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Remove all records, if any

data/examples/simple.rb

@@ -1,13 +1,13 @@
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Erase all records from collection, if any

data/examples/strict.rb

@@ -1,13 +1,13 @@
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 
 db.drop_collection('does-not-exist')
 db.create_collection('test')

data/examples/types.rb

@@ -2,13 +2,13 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 require 'pp'
 
-include XGen::Mongo::Driver
+include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Mongo.new(host, port).db('ruby-mongo-examples')
+db = Connection.new(host, port).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Remove all records, if any
@@ -25,13 +25,8 @@ coll.insert('array' => [1, 2, 3],
             'float' => 33.33333,
             'regex' => /foobar/i,
             'boolean' => true,
-            '$where' => Code.new('this.x == 3'),
+            'where' => Code.new('this.x == 3'),
             'dbref' => DBRef.new(coll.name, ObjectID.new),
-
-# NOTE: the undefined type is not saved to the database properly. This is a
-# Mongo bug. However, the undefined type may go away completely.
-#             'undef' => Undefined.new,
-
             'null' => nil,
             'symbol' => :zildjian)
 

data/lib/mongo.rb

@@ -5,16 +5,48 @@ require 'mongo/types/regexp_of_holding'
 require 'mongo/types/undefined'
 
 require 'mongo/errors'
-require 'mongo/mongo'
+require 'mongo/connection'
 require 'mongo/message'
 require 'mongo/db'
 require 'mongo/cursor'
 require 'mongo/collection'
 require 'mongo/admin'
 
+module Mongo
+  ASCENDING = 1
+  DESCENDING = -1
+end
+
+# DEPRECATED - the XGen namespace is deprecated and will be removed - use Mongo or GridFS instead
+MongoCopy = Mongo
 module XGen
+  require 'mongo/gridfs'
+  GridFSCopy = GridFS
+
+  def self.included(other_module)
+    warn "the XGen module is deprecated and will be removed - use Mongo or GridFS instead (included from: #{other_module})"
+  end
+
   module Mongo
-    ASCENDING = 1
-    DESCENDING = -1
+    include MongoCopy
+
+    def self.included(other_module)
+      warn "the XGen::Mongo module is deprecated and will be removed - use Mongo instead (included from: #{other_module})"
+    end
+
+    module Driver
+      include MongoCopy
+
+      def self.included(other_module)
+        warn "the XGen::Mongo::Driver module is deprecated and will be removed - use Mongo instead (included from: #{other_module})"
+      end
+    end
+    module GridFS
+      include GridFSCopy
+
+      def self.included(other_module)
+        warn "the XGen::Mongo::GridFS module is deprecated and will be removed - use GridFS instead (included from: #{other_module})"
+      end
+    end
   end
 end