mongo 0.15.1 → 0.16

data/LICENSE.txt

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+

data/README.rdoc

@@ -12,7 +12,7 @@ many more.
   db = Connection.new('localhost').db('sample-db')
   coll = db.collection('test')
 
-  coll.clear
+  coll.remove
   3.times { |i| coll.insert({'a' => i+1}) }
   puts "There are #{coll.count()} records. Here they are:"
   coll.find().each { |doc| puts doc.inspect }
@@ -82,7 +82,7 @@ Here is some simple example code:
   db = Connection.new.db('my-db-name')
   things = db.collection('things')
 
-  things.clear
+  things.remove
   things.insert('a' => 42)
   things.insert('a' => 99, 'b' => Time.now)
   puts things.count                               # => 2
@@ -118,6 +118,10 @@ Example code:
 
 = Notes
 
+== Thread Safety
+
+mongo-ruby-driver is thread safe.
+
 == Using with Phusion Passenger
 
 When passenger is in smart spawning mode you need to be sure that child
@@ -254,6 +258,12 @@ If you have the source code, you can run the tests.
 
   $ rake test
 
+The tests now require shoulda and mocha.  You can install these gems as
+follows:
+
+  $ gem install shoulda
+  $ gem install mocha
+
 The tests assume that the Mongo database is running on the default port. You
 can override the default host (localhost) and port (Connection::DEFAULT_PORT) by
 using the environment variables MONGO_RUBY_DRIVER_HOST and
@@ -326,6 +336,7 @@ Durran Jordan, durran@gmail.com
 
 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
@@ -342,6 +353,8 @@ Paulo Ahahgon, pahagon on github
 Les Hill, leshill on github
 * OrderedHash#each returns self
 
+Sean Cribbs, seancribbs on github
+* Modify standard_benchmark to allow profiling
 
 = License
 

data/Rakefile

@@ -14,9 +14,23 @@ include Config
 gem_command = "gem"
 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['test/test*.rb']
+# NOTE: the functional tests assume MongoDB is running.
+desc "Test the MongoDB Ruby driver."
+task :test do
+  Rake::Task['test:unit'].invoke
+  Rake::Task['test:functional'].invoke
+end
+
+namespace :test do 
+  Rake::TestTask.new(:unit) do |t|
+    t.test_files = FileList['test/unit/*_test.rb']
+    t.verbose    = true
+  end
+
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = FileList['test/test*.rb']
+    t.verbose    = true
+  end
 end
 
 desc "Generate documentation"

data/bin/autoreconnect.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+
+db = Mongo::Connection.new({:left => ["localhost", 27017], :right => ["localhost", 27018]}, nil, :auto_reconnect => true).db("ruby_test")
+
+db['test'].clear
+10.times do |i|
+  db['test'].save("x" => i)
+end
+
+while true do
+  begin
+    exit() if not db['test'].count() == 10
+
+    x = 0
+    db['test'].find().each do |doc|
+      x += doc['x']
+    end
+    exit() if not x == 45
+    print "."
+    STDOUT.flush
+    sleep 1
+  rescue
+    sleep 1
+  end
+end

data/bin/fail_if_no_c.rb

@@ -0,0 +1,11 @@
+# Fail if the C extension module isn't installed.
+#
+# Only really intended to be used by internal build scripts.
+
+require 'rubygems'
+require 'mongo'
+begin
+  require 'mongo_ext/cbson'
+rescue LoadError
+  Process.exit 1
+end

data/lib/mongo.rb

@@ -1,11 +1,18 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
 require 'mongo/types/binary'
+require 'mongo/types/code'
 require 'mongo/types/dbref'
 require 'mongo/types/objectid'
 require 'mongo/types/regexp_of_holding'
 
+require 'mongo/util/support'
+require 'mongo/util/conversions'
+require 'mongo/util/server_version'
+
 require 'mongo/errors'
+require 'mongo/constants'
 require 'mongo/connection'
-require 'mongo/message'
 require 'mongo/db'
 require 'mongo/cursor'
 require 'mongo/collection'
@@ -15,5 +22,5 @@ module Mongo
   ASCENDING = 1
   DESCENDING = -1
 
-  VERSION = "0.15.1"
+  VERSION = "0.16"
 end

data/lib/mongo/admin.rb

@@ -64,7 +64,7 @@ module Mongo
     # 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
+      Cursor.new(Collection.new(@db, DB::SYSTEM_PROFILE_COLLECTION), :selector => {}).to_a
     end
 
     # Validate a named collection by raising an exception if there is a

data/lib/mongo/collection.rb

@@ -14,16 +14,14 @@
 # limitations under the License.
 # ++
 
-require 'mongo/query'
-
 module Mongo
 
   # A named collection of records in a database.
   class Collection
 
-    attr_reader :db, :name, :hint
+    attr_reader :db, :name, :pk_factory, :hint
 
-    def initialize(db, name)
+    def initialize(db, name, pk_factory=nil)
       case name
       when Symbol, String
       else
@@ -42,7 +40,8 @@ module Mongo
         raise InvalidName, "collection names must not start or end with '.'"
       end
 
-      @db, @name = db, name
+      @db, @name  = db, name
+      @pk_factory = pk_factory || ObjectID
       @hint = nil
     end
 
@@ -100,6 +99,13 @@ 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. 
+    #             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 
+    #             block code finishes.
     def find(selector={}, options={})
       fields = options.delete(:fields)
       fields = ["_id"] if fields && fields.empty?
@@ -112,6 +118,10 @@ module Mongo
       sort = options.delete(:sort)
       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." 
+      end
+      timeout = block_given? ? (options.delete(:timeout) || true) : true
       if hint
         hint = normalize_hint_fields(hint)
       else
@@ -119,7 +129,8 @@ module Mongo
       end
       raise RuntimeError, "Unknown options [#{options.inspect}]" unless options.empty?
 
-      cursor = @db.query(self, Query.new(selector, fields, skip, limit, sort, hint, snapshot))
+      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
         cursor.close()
@@ -189,25 +200,41 @@ module Mongo
     #   will be raised on an error. Checking for safety requires an extra
     #   round-trip to the database
     def insert(doc_or_docs, options={})
-      doc_or_docs = [doc_or_docs] if !doc_or_docs.is_a?(Array)
-      res = @db.insert_into_db(@name, doc_or_docs)
+      doc_or_docs = [doc_or_docs] unless doc_or_docs.is_a?(Array)
+      doc_or_docs.collect! { |doc| @pk_factory.create_pk(doc) }
+      result = insert_documents(doc_or_docs)
       if options.delete(:safe)
         error = @db.error
         if error
           raise OperationFailure, error
         end
       end
-      res.size > 1 ? res : res.first
+      result.size > 1 ? result : result.first
     end
     alias_method :<<, :insert
 
-    # Remove the records that match +selector+.
+    # 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: 
+    #   @collection.remove({:expire => {'$lte' => Time.now}})
     def remove(selector={})
-      @db.remove_from_db(@name, selector)
+      message = ByteBuffer.new
+      message.put_int(0)
+      BSON.serialize_cstr(message, "#{@db.name}.#{@name}")
+      message.put_int(0)
+      message.put_array(BSON.new.serialize(selector, false).to_a)
+      @db.send_message_with_operation(Mongo::Constants::OP_DELETE, message)
     end
 
     # Remove all records.
+    # DEPRECATED: please use Collection#remove instead.
     def clear
+      warn "Collection#clear is deprecated. Please use Collection#remove instead."
       remove({})
     end
 
@@ -225,19 +252,16 @@ module Mongo
     #   will be raised on an error. Checking for safety requires an extra
     #   round-trip to the database
     def update(spec, document, options={})
-      upsert = options.delete(:upsert)
-      safe = options.delete(:safe)
-
-      if upsert
-        @db.repsert_in_db(@name, spec, document)
-      else
-        @db.replace_in_db(@name, spec, document)
-      end
-      if safe
-        error = @db.error
-        if error
-          raise OperationFailure, error
-        end
+      message = ByteBuffer.new
+      message.put_int(0)
+      BSON.serialize_cstr(message, "#{@db.name}.#{@name}")
+      message.put_int(options[:upsert] ? 1 : 0) # 1 if a repsert operation (upsert)
+      message.put_array(BSON.new.serialize(spec, false).to_a)
+      message.put_array(BSON.new.serialize(document, false).to_a)
+      @db.send_message_with_operation(Mongo::Constants::OP_UPDATE, message)
+
+      if options[:safe] && error=@db.error
+        raise OperationFailure, error
       end
     end
 
@@ -248,7 +272,20 @@ module Mongo
     # +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)
+      field_h = OrderedHash.new
+      if field_or_spec.is_a?(String) || field_or_spec.is_a?(Symbol)
+        field_h[field_or_spec.to_s] = 1
+      else
+        field_or_spec.each { |f| field_h[f[0].to_s] = f[1] }
+      end
+      name = generate_index_names(field_h)
+      sel  = {
+        :name   => name,
+        :ns     => "#{@db.name}.#{@name}",
+        :key    => field_h,
+        :unique => unique }
+      insert_documents([sel], Mongo::DB::SYSTEM_INDEX_COLLECTION, false)
+      name
     end
 
     # Drop index +name+.
@@ -395,6 +432,8 @@ EOS
       find().count()
     end
 
+    alias :size :count
+
     protected
 
     def normalize_hint_fields(hint)
@@ -411,5 +450,27 @@ EOS
         h
       end
     end
+
+    private
+
+    # Sends an 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)
+      message = ByteBuffer.new
+      message.put_int(0)
+      BSON.serialize_cstr(message, "#{@db.name}.#{collection_name}")
+      documents.each { |doc| message.put_array(BSON.new.serialize(doc, check_keys).to_a) }
+      @db.send_message_with_operation(Mongo::Constants::OP_INSERT, message)
+      documents.collect { |o| o[:_id] || o['_id'] }
+    end
+
+    def generate_index_names(spec)
+      indexes = []
+      spec.each_pair do |field, direction|
+        indexes.push("#{field}_#{direction}")
+      end 
+      indexes.join("_")
+    end
   end
 end