animehunter-mongo 0.9

data/examples/index_test.rb

@@ -0,0 +1,125 @@
+class Exception
+  def errmsg
+    "%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
+
+host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+
+puts ">> Connecting to #{host}:#{port}"
+db = Mongo.new(host, port).db('ruby-mongo-index_test')
+
+puts ">> Dropping collection test"
+begin
+  res = db.drop_collection('test')
+  puts "dropped : #{res.inspect}" 
+rescue => e
+  puts "Error: #{e.errmsg}"
+end
+
+puts ">> Creating collection test"
+begin
+  coll = db.collection('test')
+  puts "created : #{coll.inspect}" 
+rescue => e
+  puts "Error: #{e.errmsg}"
+end
+
+OBJS_COUNT = 100
+
+puts ">> Generating test data"
+msgs = %w{hola hello aloha ciao}
+arr = (0...OBJS_COUNT).collect {|x| { :number => x, :rndm => (rand(5)+1), :msg => msgs[rand(4)] }}
+puts "generated"
+
+puts ">> Inserting data (#{arr.size})"
+coll.insert(arr)
+puts "inserted"
+
+puts ">> Creating index"
+res = coll.create_index "all", :_id => 1, :number => 1, :rndm => 1, :msg => 1
+# res = coll.create_index "all", '_id' => 1, 'number' => 1, 'rndm' => 1, 'msg' => 1
+puts "created index: #{res.inspect}"
+# ============================ Mongo Log ============================
+# Fri Dec  5 14:45:02 Adding all existing records for ruby-mongo-console.test to new index
+# ***
+# Bad data or size in BSONElement::size()
+# bad type:30
+# totalsize:11 fieldnamesize:4
+# lastrec:
+# Fri Dec  5 14:45:02 ruby-mongo-console.system.indexes Assertion failure false jsobj.cpp a0
+# Fri Dec  5 14:45:02  database: ruby-mongo-console op:7d2 0
+# Fri Dec  5 14:45:02  ns: ruby-mongo-console.system.indexes
+
+puts ">> Gathering index information"
+begin
+  res = coll.index_information     
+  puts "index_information : #{res.inspect}" 
+rescue => e
+  puts "Error: #{e.errmsg}"
+end
+# ============================ Console Output ============================
+# RuntimeError: Keys for index on return from db was nil. Coll = ruby-mongo-console.test
+#         from ./bin/../lib/mongo/db.rb:135:in `index_information'
+#         from (irb):11:in `collect'
+#         from ./bin/../lib/mongo/cursor.rb:47:in `each'
+#         from ./bin/../lib/mongo/db.rb:130:in `collect'
+#         from ./bin/../lib/mongo/db.rb:130:in `index_information'
+#         from ./bin/../lib/mongo/collection.rb:74:in `index_information'
+#         from (irb):11
+
+puts ">> Dropping index"
+begin
+  res = coll.drop_index "all"
+  puts "dropped : #{res.inspect}"
+rescue => e
+  puts "Error: #{e.errmsg}"
+end
+
+# ============================ Console Output ============================
+# => {"nIndexesWas"=>2.0, "ok"=>1.0}
+# ============================ Mongo Log ============================
+# 0x41802a 0x411549 0x42bac6 0x42c1f6 0x42c55b 0x42e6f7 0x41631e 0x41a89d 0x41ade2 0x41b448 0x4650d2 0x4695ad
+#  db/db(_Z12sayDbContextPKc+0x17a) [0x41802a]
+#  db/db(_Z8assertedPKcS0_j+0x9) [0x411549]
+#  db/db(_ZNK11BSONElement4sizeEv+0x1f6) [0x42bac6]
+#  db/db(_ZN7BSONObj8getFieldEPKc+0xa6) [0x42c1f6]
+#  db/db(_ZN7BSONObj14getFieldDottedEPKc+0x11b) [0x42c55b]
+#  db/db(_ZN7BSONObj19extractFieldsDottedES_R14BSONObjBuilder+0x87) [0x42e6f7]
+#  db/db(_ZN12IndexDetails17getKeysFromObjectER7BSONObjRSt3setIS0_St4lessIS0_ESaIS0_EE+0x24e) [0x41631e]
+#  db/db(_Z12_indexRecordR12IndexDetailsR7BSONObj7DiskLoc+0x5d) [0x41a89d]
+#  db/db(_Z18addExistingToIndexPKcR12IndexDetails+0xb2) [0x41ade2]
+#  db/db(_ZN11DataFileMgr6insertEPKcPKvib+0x508) [0x41b448]
+#  db/db(_Z14receivedInsertR7MessageRSt18basic_stringstreamIcSt11char_traitsIcESaIcEE+0x112) [0x4650d2]
+#  db/db(_Z10connThreadv+0xb4d) [0x4695ad]
+# Fri Dec  5 14:45:02 ruby-mongo-console.system.indexes  Caught Assertion insert, continuing
+# Fri Dec  5 14:47:59 CMD: deleteIndexes ruby-mongo-console.test
+#   d->nIndexes was 2
+#   alpha implementation, space not reclaimed
+
+puts ">> Gathering index information"
+begin
+  res = coll.index_information     
+  puts "index_information : #{res.inspect}" 
+rescue => e
+  puts "Error: #{e.errmsg}"
+end
+# ============================ Console Output ============================
+# RuntimeError: Keys for index on return from db was nil. Coll = ruby-mongo-console.test
+#         from ./bin/../lib/mongo/db.rb:135:in `index_information'
+#         from (irb):15:in `collect'
+#         from ./bin/../lib/mongo/cursor.rb:47:in `each'
+#         from ./bin/../lib/mongo/db.rb:130:in `collect'
+#         from ./bin/../lib/mongo/db.rb:130:in `index_information'
+#         from ./bin/../lib/mongo/collection.rb:74:in `index_information'
+#         from (irb):15
+
+puts ">> Closing connection"
+db.close
+puts "closed"

data/examples/info.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+
+include XGen::Mongo::Driver
+
+host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+
+puts "Connecting to #{host}:#{port}"
+db = Mongo.new(host, port).db('ruby-mongo-examples')
+coll = db.collection('test')
+
+# Erase all records from collection, if any
+coll.clear
+
+# Insert 3 records
+3.times { |i| coll.insert({'a' => i+1}) }
+
+# Collection names in database
+p db.collection_names
+
+# More information about each collection
+p db.collections_info
+
+# Index information
+db.create_index('test', 'a')
+p db.index_information('test')
+
+# Destroy the collection
+coll.drop

data/examples/queries.rb

@@ -0,0 +1,69 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'pp'
+
+include XGen::Mongo::Driver
+
+host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+
+puts "Connecting to #{host}:#{port}"
+db = Mongo.new(host, port).db('ruby-mongo-examples')
+coll = db.collection('test')
+
+# Remove all records, if any
+coll.clear
+
+# Insert three records
+coll.insert('a' => 1)
+coll.insert('a' => 2)
+coll.insert('b' => 3)
+
+# Count.
+puts "There are #{coll.count()} records."
+
+# Find all records. find() returns a Cursor.
+cursor = coll.find()
+
+# Print them. Note that all records have an _id automatically added by the
+# database. See pk.rb for an example of how to use a primary key factory to
+# generate your own values for _id.
+cursor.each { |row| pp row }
+
+# Cursor has a to_a method that slurps all records into memory.
+rows = coll.find().to_a
+rows.each { |row| pp row }
+
+# See Collection#find. From now on in this file, we won't be printing the
+# records we find.
+coll.find('a' => 1)
+
+# Find records sort by 'a', offset 1, limit 2 records.
+# Sort can be single name, array, or hash.
+coll.find({}, {:offset => 1, :limit => 2, :sort => 'a'})
+
+# Find all records with 'a' > 1. There is also $lt, $gte, and $lte.
+coll.find({'a' => {'$gt' => 1}})
+coll.find({'a' => {'$gt' => 1, '$lte' => 3}})
+
+# Find all records with 'a' in a set of values.
+coll.find('a' => {'$in' => [1,2]})
+
+# Find by regexp
+coll.find('a' => /[1|2]/)
+
+# Print query explanation
+pp coll.find('a' => /[1|2]/).explain()
+
+# Use a hint with a query. Need an index. Hints can be stored with the
+# collection, in which case they will be used with all queries, or they can be
+# specified per query, in which case that hint overrides the hint associated
+# with the collection if any.
+coll.create_index('a')
+coll.hint = 'a'
+
+# You will see a different explanation now that the hint is in place
+pp coll.find('a' => /[1|2]/).explain()
+
+# Override hint for single query
+coll.find({'a' => 1}, :hint => 'b')

data/examples/simple.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+
+include XGen::Mongo::Driver
+
+host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+
+puts "Connecting to #{host}:#{port}"
+db = Mongo.new(host, port).db('ruby-mongo-examples')
+coll = db.collection('test')
+
+# Erase all records from collection, if any
+coll.clear
+
+# Insert 3 records
+3.times { |i| coll.insert({'a' => i+1}) }
+
+puts "There are #{coll.count()} records in the test collection. Here they are:"
+coll.find().each { |doc| puts doc.inspect }
+
+# Destroy the collection
+coll.drop

data/examples/strict.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+
+include XGen::Mongo::Driver
+
+host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+
+puts "Connecting to #{host}:#{port}"
+db = Mongo.new(host, port).db('ruby-mongo-examples')
+
+db.drop_collection('does-not-exist')
+db.create_collection('test')
+
+db.strict = true
+
+begin
+  # Can't reference collection that does not exist
+  db.collection('does-not-exist')
+  puts "error: expected exception"
+rescue => ex
+  puts "expected exception: #{ex}"
+end
+
+begin
+  # Can't create collection that already exists
+  db.create_collection('test')
+  puts "error: expected exception"
+rescue => ex
+  puts "expected exception: #{ex}"
+end
+
+db.strict = false
+db.drop_collection('test')

data/examples/types.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'pp'
+
+include XGen::Mongo::Driver
+
+host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || XGen::Mongo::Driver::Mongo::DEFAULT_PORT
+
+puts "Connecting to #{host}:#{port}"
+db = Mongo.new(host, port).db('ruby-mongo-examples')
+coll = db.collection('test')
+
+# Remove all records, if any
+coll.clear
+
+# Insert record with all sorts of values
+coll.insert('array' => [1, 2, 3],
+            'string' => 'hello',
+            'hash' => {'a' => 1, 'b' => 2},
+            'date' => Time.now, # milliseconds only; microseconds are not stored
+            'oid' => ObjectID.new,
+            'binary' => Binary.new([1, 2, 3]),
+            'int' => 42,
+            'float' => 33.33333,
+            'regex' => /foobar/i,
+            'boolean' => true,
+            '$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)
+
+pp coll.find().next_object
+
+coll.clear

data/lib/mongo.rb

@@ -0,0 +1,19 @@
+require 'mongo/types/binary'
+require 'mongo/types/dbref'
+require 'mongo/types/objectid'
+require 'mongo/types/regexp_of_holding'
+require 'mongo/types/undefined'
+
+require 'mongo/mongo'
+require 'mongo/message'
+require 'mongo/db'
+require 'mongo/cursor'
+require 'mongo/collection'
+require 'mongo/admin'
+
+module XGen
+  module Mongo
+    ASCENDING = 1
+    DESCENDING = -1
+  end
+end

data/lib/mongo/admin.rb

@@ -0,0 +1,87 @@
+# --
+# Copyright (C) 2008-2009 10gen Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ++
+
+require 'mongo/util/ordered_hash'
+
+module XGen
+  module Mongo
+    module Driver
+
+      # Provide administrative database methods: those having to do with
+      # profiling and validation.
+      class Admin
+
+        def initialize(db)
+          @db = db
+        end
+
+        # Return the current database profiling level.
+        def profiling_level
+          oh = OrderedHash.new
+          oh[:profile] = -1
+          doc = @db.db_command(oh)
+          raise "Error with profile command: #{doc.inspect}" unless @db.ok?(doc) && doc['was'].kind_of?(Numeric)
+          case doc['was'].to_i
+          when 0
+            :off
+          when 1
+            :slow_only
+          when 2
+            :all
+          else
+            raise "Error: illegal profiling level value #{doc['was']}"
+          end
+        end
+
+        # Set database profiling level to :off, :slow_only, or :all.
+        def profiling_level=(level)
+          oh = OrderedHash.new
+          oh[:profile] = case level
+                         when :off
+                           0
+                         when :slow_only
+                           1
+                         when :all
+                           2
+                         else
+                           raise "Error: illegal profiling level value #{level}"
+                         end
+          doc = @db.db_command(oh)
+          raise "Error with profile command: #{doc.inspect}" unless @db.ok?(doc)
+        end
+
+        # Return an array contining current profiling information from the
+        # database.
+        def profiling_info
+          @db.query(Collection.new(@db, DB::SYSTEM_PROFILE_COLLECTION), Query.new({})).to_a
+        end
+
+        # Validate a named collection by raising an exception if there is a
+        # problem or returning an interesting hash (see especially the
+        # 'result' string value) if all is well.
+        def validate_collection(name)
+          doc = @db.db_command(:validate => name)
+          raise "Error with validate command: #{doc.inspect}" unless @db.ok?(doc)
+          result = doc['result']
+          raise "Error with validation data: #{doc.inspect}" unless result.kind_of?(String)
+          raise "Error: invalid collection #{name}: #{doc.inspect}" if result =~ /\b(exception|corrupt)\b/i
+          doc
+        end
+
+      end
+    end
+  end
+end

data/lib/mongo/collection.rb

@@ -0,0 +1,235 @@
+# --
+# Copyright (C) 2008-2009 10gen Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ++
+
+require 'mongo/query'
+
+module XGen
+  module Mongo
+    module Driver
+
+      # A named collection of records in a database.
+      class Collection
+
+        attr_reader :db, :name, :hint
+
+        def initialize(db, name)
+          @db, @name = db, name
+          @hint = nil
+        end
+
+        # Set hint fields to use and return +self+. hint may be a single field
+        # name, array of field names, or a hash (preferably an OrderedHash).
+        # May be +nil+.
+        def hint=(hint)
+          @hint = normalize_hint_fields(hint)
+          self
+        end
+
+        # Return records that match a +selector+ hash. See Mongo docs for
+        # details.
+        #
+        # Options:
+        # :fields :: Array of collection field names; only those will be returned (plus _id if defined)
+        # :offset :: Start at this record when returning records
+        # :limit :: Maximum number of records to return
+        # :sort :: Either hash of field names as keys and 1/-1 as values; 1 ==
+        #          ascending, -1 == descending, or array of field names (all
+        #          assumed to be sorted in ascending order).
+        # :hint :: See #hint. This option overrides the collection-wide value.
+        def find(selector={}, options={})
+          fields = options.delete(:fields)
+          fields = nil if fields && fields.empty?
+          offset = options.delete(:offset) || 0
+          limit = options.delete(:limit) || 0
+          sort = options.delete(:sort)
+          hint = options.delete(:hint)
+          if hint
+            hint = normalize_hint_fields(hint)
+          else
+            hint = @hint        # assumed to be normalized already
+          end
+          raise RuntimeError, "Unknown options [#{options.inspect}]" unless options.empty?
+          @db.query(self, Query.new(selector, fields, offset, limit, sort, hint))
+        end
+
+        # Find the first record that matches +selector+. See #find.
+        def find_first(selector={}, options={})
+          h = options.dup
+          h[:limit] = 1
+          cursor = find(selector, h)
+          cursor.next_object    # don't need to explicitly close b/c of limit
+        end
+
+        # Save an updated +object+ to the collection, or insert it if it doesn't exist already.
+        def save(object)
+          if id = object[:_id] || object['_id']
+            repsert({:_id => id}, object)
+          else
+            insert(object)
+          end
+        end
+
+        # Insert +objects+, which are hashes. "<<" is aliased to this method.
+        # Returns either the single inserted object or a new array containing
+        # +objects+. The object(s) may have been modified by the database's PK
+        # factory, if it has one.
+        def insert(*objects)
+          objects = objects.first if objects.size == 1 && objects.first.is_a?(Array)
+          res = @db.insert_into_db(@name, objects)
+          res.size > 1 ? res : res.first
+        end
+        alias_method :<<, :insert
+
+        # Remove the records that match +selector+.
+        def remove(selector={})
+          @db.remove_from_db(@name, selector)
+        end
+
+        # Remove all records.
+        def clear
+          remove({})
+        end
+
+        # Update records that match +selector+ by applying +obj+ as an update.
+        # If no match, inserts (???).
+        def repsert(selector, obj)
+          @db.repsert_in_db(@name, selector, obj)
+        end
+
+        # Update records that match +selector+ by applying +obj+ as an update.
+        def replace(selector, obj)
+          @db.replace_in_db(@name, selector, obj)
+        end
+
+        # Update records that match +selector+ by applying +obj+ as an update.
+        # Both +selector+ and +modifier_obj+ are required.
+        def modify(selector, modifier_obj)
+          raise "no object" unless modifier_obj
+          raise "no selector" unless selector
+          @db.modify_in_db(@name, selector, modifier_obj)
+        end
+
+        # Create a new index. +field_or_spec+
+        # should be either a single field name or a Array of [field name,
+        # direction] pairs. Directions should be specified as
+        # XGen::Mongo::ASCENDING or XGen::Mongo::DESCENDING.
+        # +unique+ is an optional boolean indicating whether this index
+        # should enforce a uniqueness constraint.
+        def create_index(field_or_spec, unique=false)
+          @db.create_index(@name, field_or_spec, unique)
+        end
+
+        # Drop index +name+.
+        def drop_index(name)
+          @db.drop_index(@name, name)
+        end
+
+        # Drop all indexes.
+        def drop_indexes
+          # just need to call drop indexes with no args; will drop them all
+          @db.drop_index(@name, '*')
+        end
+
+        # Drop the entire collection. USE WITH CAUTION.
+        def drop
+          @db.drop_collection(@name)
+        end
+
+        # Perform a query similar to an SQL group by operation.
+        #
+        # Returns an array of grouped items.
+        #
+        # :keys :: list of fields to group by
+        # :condition :: specification of rows to be considered (as a 'find'
+        #               query specification)
+        # :initial :: initial value of the aggregation counter object
+        # :reduce :: aggregation function as a JavaScript string
+        def group(keys, condition, initial, reduce)
+          group_function = <<EOS
+function () {
+    var c = db[ns].find(condition);
+    var map = new Map();
+    var reduce_function = #{reduce};
+    while (c.hasNext()) {
+        var obj = c.next();
+
+        var key = {};
+        for (var i in keys) {
+            key[keys[i]] = obj[keys[i]];
+        }
+
+        var aggObj = map.get(key);
+        if (aggObj == null) {
+            var newObj = Object.extend({}, key);
+            aggObj = Object.extend(newObj, initial);
+            map.put(key, aggObj);
+        }
+        reduce_function(obj, aggObj);
+    }
+    return {"result": map.values()};
+}
+EOS
+          return @db.eval(Code.new(group_function,
+                                   {
+                                     "ns" => @name,
+                                     "keys" => keys,
+                                     "condition" => condition,
+                                     "initial" => initial
+                                   }))["result"]
+        end
+
+        # Get information on the indexes for the collection +collection_name+.
+        # Returns a hash where the keys are index names (as returned by
+        # Collection#create_index and the values are lists of [key, direction]
+        # pairs specifying the index (as passed to Collection#create_index).
+        def index_information
+          @db.index_information(@name)
+        end
+
+        # Return a hash containing options that apply to this collection.
+        # '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']
+        end
+
+        # Return the number of records that match +selector+. If +selector+ is
+        # +nil+ or an empty hash, returns the count of all records.
+        def count(selector={})
+          @db.count(@name, selector || {})
+        end
+
+        protected
+
+        def normalize_hint_fields(hint)
+          case hint
+          when String
+            {hint => 1}
+          when Hash
+            hint
+          when nil
+            nil
+          else
+            h = OrderedHash.new
+            hint.to_a.each { |k| h[k] = 1 }
+            h
+          end
+        end
+      end
+    end
+  end
+end
+