mongo-find_replace 0.18.3

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

@@ -0,0 +1,358 @@
+= Introduction
+
+This is the 10gen-supported Ruby driver for MongoDB[http://www.mongodb.org].
+
+Here's a quick code sample. See the MongoDB Ruby Tutorial
+(http://www.mongodb.org/display/DOCS/Ruby+Tutorial) for much more.
+
+  require 'rubygems'
+  require 'mongo'
+  include Mongo
+
+  @db   = Connection.new.db('sample-db')
+  @coll = db.collection('test')
+
+  @coll.remove
+  3.times do |i|
+    @coll.insert({'a' => i+1})
+  end
+  puts "There are #{@coll.count()} records. Here they are:"
+  @coll.find().each { |doc| puts doc.inspect }
+
+= Installation
+
+The driver's gems are hosted on Gemcutter[http://gemcutter.org]. If you haven't
+installed a gem from Gemcutter before, you'll need to set up Gemcutter first:
+
+  $ gem install gemcutter
+  $ gem tumble
+
+Once you've installed Gemcutter, install the mongo gem as follows:
+
+  $ gem install mongo
+
+For a significant performance boost, you should also install the driver's C
+extensions:
+
+  $ gem install mongo_ext
+
+=== From the GitHub source
+
+The source code is available at http://github.com/mongodb/mongo-ruby-driver.
+You can either clone the git repository or download a tarball or zip file.
+Once you have the source, you can use it from wherever you downloaded it or
+you can install it as a gem from the source by typing
+
+  $ rake gem:install
+
+To install the C extensions from source, type this instead:
+
+  $ rake gem:install_extensions
+
+That's all there is to it!
+
+= Examples
+
+For extensive examples, see the MongoDB Ruby Tutorial
+(http://www.mongodb.org/display/DOCS/Ruby+Tutorial).
+
+Bundled with the driver are many examples, located in the "examples" subdirectory. Samples include using
+the driver and using the GridFS class GridStore. MongoDB must be running for
+these examples to work, of course.
+
+Here's how to start MongoDB and run the "simple.rb" example:
+
+  $ cd path/to/mongo
+  $ ./mongod run
+  ... then in another window ...
+  $ cd path/to/mongo-ruby-driver
+  $ ruby examples/simple.rb
+
+See also the test code, especially test/test_db_api.rb.
+
+= GridStore
+
+The GridStore class is a Ruby implementation of MongoDB's GridFS file storage
+system. An instance of GridStore is like an IO object. See the RDocs for
+details, and see examples/gridfs.rb for code that uses many of the GridStore
+features (metadata, content type, rewind/seek/tell, etc).
+
+Note that the GridStore class is not automatically required when you require
+'mongo'. You also need to require 'mongo/gridfs'
+
+Example code:
+
+  include GridFS
+
+  # Store the text "Hello, world!" in the grid store.
+  GridStore.open(database, 'filename', 'w') do |f|
+    f.puts "Hello, world!"
+  end
+
+  # Output "Hello, world!"
+  GridStore.open(database, 'filename', 'r') do |f|
+    puts f.read
+  end
+
+  # Add text to the grid store.
+  GridStore.open(database, 'filename', 'w+') do |f|
+    f.puts "But wait, there's more!"
+  end
+
+  # Retrieve everything, outputting  "Hello, world!\nBut wait, there's more!\n"
+  GridStore.open(database, 'filename', 'r') do |f|
+    puts f.read
+  end
+
+
+= Notes
+
+== Thread Safety
+
+The driver is thread-safe.
+
+== Connection Pooling
+
+As of 0.18, the driver implements connection pooling. By default, only one
+socket connection will be opened to MongoDB. However, if you're running a
+multi-threaded application, you can specify a maximum pool size and a maximum
+timeout for waiting for old connections to be released to the pool.
+
+To set up a pooled connection to a single MongoDB instance:
+
+  @conn = Connection.new("localhost", 27017, :pool_size => 5, :timeout => 5)
+
+A pooled connection to a paired instance would look like this:
+
+  @conn = Connection.new({:left  => ["db1.example.com", 27017],
+                    :right => ["db2.example.com", 27017]}, nil,
+                    :pool_size => 20, :timeout => 5)
+
+Though the pooling architecture will undoubtedly evolve, it currently owes much credit
+to the connection pooling implementations in ActiveRecord and PyMongo.
+
+== Using with Phusion Passenger
+
+When passenger is in smart spawning mode you need to be sure that child
+processes forked by passenger will create a new connection to the database.
+activerecord-mongo-adapter handles this for you, so if you are using that
+you shouldn't need to worry about it. Otherwise you'll either need to use
+conservative spawning[http://www.modrails.org/documentation/Users%20guide.html#RailsSpawnMethod]
+or handle reconnecting when passenger forks a new process:
+
+  if defined?(PhusionPassenger)
+    PhusionPassenger.on_event(:starting_worker_process) do |forked|
+      if forked
+        # Call db.connect_to_master to reconnect here
+      end
+    end
+  end
+
+The above code should be put in _environment.rb_ or in an initialization
+script.
+
+See this thread[http://groups.google.com/group/mongodb-user/browse_thread/thread/f31e2d23de38136a]
+for more details on this issue.
+
+== String Encoding
+
+The BSON ("Binary JSON") format used to communicate with Mongo requires that
+strings be UTF-8 (http://en.wikipedia.org/wiki/UTF-8).
+
+Ruby 1.9 has built-in character encoding support. All strings sent to Mongo
+and received from Mongo are converted to UTF-8 when necessary, and strings
+read from Mongo will have their character encodings set to UTF-8.
+
+When used with Ruby 1.8, the bytes in each string are written to and read from
+Mongo as-is. If the string is ASCII all is well, because ASCII is a subset of
+UTF-8. If the string is not ASCII, it may not be a well-formed UTF-8
+string.
+
+== Primary Keys
+
+The field _id is a primary key. It is treated specially by the database, and
+its use makes many operations more efficient. The value of an _id may be of
+any type. The database itself inserts an _id value if none is specified when
+a record is inserted.
+
+=== Primary Key Factories
+
+A primary key factory is a class you supply to a DB object that knows how to
+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_factory option to the Connection#db method.
+
+  db = Mongo::Connection.new.db('dbname', :pk_factory => 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
+fields the factory wishes to inject. 
+
+NOTE: if the object already has a primary key, the factory should not inject
+a new key; this means that the object may already exist in the database.
+The idea here is that whenever a record is inserted,
+the :pk_factory object's +create_pk+ method will be called and
+the new hash returned will be inserted.
+
+Here is a sample primary key factory, taken from the tests:
+
+  class TestPKFactory
+    def create_pk(row)
+      row['_id'] ||= Mongo::ObjectID.new
+      row
+    end
+  end
+
+Here's a slightly more sophisticated one that handles both symbol and string
+keys. This is the PKFactory that comes with the MongoRecord code (an
+ActiveRecord-like framework for non-Rails apps) and the AR Mongo adapter code
+(for Rails):
+
+  class PKFactory
+    def create_pk(row)
+      return row if row[:_id]
+      row.delete(:_id)      # in case it exists but the value is nil
+      row['_id'] ||= Mongo::ObjectID.new
+      row
+    end
+  end
+
+A database's PK factory object may be set either when a DB object is created
+or immediately after you obtain it, but only once. The only reason it is
+changeable at all is so that libraries such as MongoRecord that use this
+driver can set the PK factory after obtaining the database but before using it
+for the first time.
+
+== The DB Class
+
+=== Primary Key factories
+
+See the section on "Primary Keys" above.
+
+=== Strict mode
+
+Each database has an optional strict mode. If strict mode is on, then asking
+for a collection that does not exist will raise an error, as will asking to
+create a collection that already exists. Note that both these operations are
+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 = Connection.new.db('dbname', :strict => true)
+  # I'm feeling lax
+  db.strict = false
+  # No, I'm not!
+  db.strict = true
+
+The method DB#strict? returns the current value of that flag.
+
+== Cursors
+
+Random cursor fun facts:
+
+- Cursors are enumerable.
+
+- The query doesn't get run until you actually attempt to retrieve data from a
+  cursor.
+
+- Cursors have a to_a method.
+
+
+= Testing
+
+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
+
+Or, to test without the extension:
+
+  $ rake test:ruby
+
+These will run both unit and functional tests. To run these tests alone:
+
+  $ rake test:unit
+  $ rake test:functional
+
+To run any individual rake tasks with the C extension enabled, just pass C_EXT=true to the task:
+
+  $ rake test:unit C_EXT=true
+
+If you want to test replica pairs, you can run the following tests
+individually:
+
+  $ rake test:pair_count
+  $ rake test:pair_insert
+  $ rake test:pair_query
+
+It's also possible to test replica pairs with connection pooling:
+
+  $ rake test:pooled_pair_insert
+
+===Shoulda and Mocha
+
+All 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
+MONGO_RUBY_DRIVER_PORT.
+
+The project mongo-qa (http://github.com/mongodb/mongo-qa) contains many more
+Mongo driver tests that are language independent. To run thoses tests as part
+of the "rake test" task, download the code "next to" this directory. So, after
+installing the mongo-qa code you would have these two directories next to each
+other:
+
+  $ ls
+  mongo-qa
+  mongo-ruby-driver
+  $ rake test
+
+The tests run just fine if the mongo-qa directory is not there.
+
+Additionally, the script bin/validate is used by the mongo-qa project's
+validator script.
+
+
+= Documentation
+
+This documentation is available online at http://api.mongodb.org/ruby. You can
+generate the documentation if you have the source by typing
+
+  $ rake ydoc
+
+Then open the file +ydoc/index.html+.
+
+
+= Release Notes
+
+See HISTORY.
+
+= Credits
+
+See CREDITS.
+
+= License
+
+ Copyright 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.
+