diff --git a/Rakefile b/Rakefile index 43094b9..8ed5955 100644 --- a/Rakefile +++ b/Rakefile @@ -169,7 +169,7 @@ task :ydoc do require File.join(File.dirname(__FILE__), 'lib', 'mongo') out = File.join('ydoc', Mongo::VERSION) FileUtils.rm_rf('ydoc') - system "yardoc lib/**/*.rb lib/mongo/**/*.rb lib/bson/**/*.rb -e yard/yard_ext.rb -p yard/templates -o #{out} --title MongoRuby-#{Mongo::VERSION} --files docs/TUTORIAL.md,docs/1.0_UPGRADE.md" + system "yardoc lib/**/*.rb lib/mongo/**/*.rb lib/bson/**/*.rb -e yard/yard_ext.rb -p yard/templates -o #{out} --title MongoRuby-#{Mongo::VERSION} --files docs/TUTORIAL.md,docs/HISTORY.md,docs/CREDITS.md,docs/1.0_UPGRADE.md" end namespace :gem do diff --git a/docs/CREDITS.md b/docs/CREDITS.md index 816adea..673457f 100644 --- a/docs/CREDITS.md +++ b/docs/CREDITS.md @@ -1,4 +1,7 @@ +# Credits + Adrian Madrid, aemadrid@gmail.com + * bin/mongo_console * examples/benchmarks.rb * examples/irb.rb @@ -9,88 +12,108 @@ Adrian Madrid, aemadrid@gmail.com * Many other code suggestions and improvements. Aman Gupta, aman@tmm1.net + * Collection#save * Noted bug in returning query batch size. 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 * OrderedHash#update aliases to merge! Cyril Mougel, cyril.mougel@gmail.com + * Initial logging support * Test case -Honlgi Lai (Phusion) -* Significant performance audit. See commits prior to 1.0.9 - 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 + * Modified standard_benchmark to allow profiling -* c ext for faster ObjectID creation +* C ext for faster ObjectID creation Sunny Hirai + * Suggested hashcode fix for Mongo::ObjectID * Noted index ordering bug. * GridFS performance boost Christos Trochalakis + * Added map/reduce helper Blythe Dunham + * Added finalize option to map/reduce Matt Powell (fauxparse) + * Added GridStore#mv Patrick Collison + * Added safe mode for Collection#remove Chuck Remes + * Extraction of BSON into separate gems * Extensions compile on Rubinius * Performance improvements for INT in C extensions * Performance improvements for JRuby BSON encoder and callback classes Dmitrii Golub (Houdini) and Jacques Crocker (railsjedi) + * Support open to exclude fields on query dfitzgibbon + * patch for ensuring bson_ext compatibility with early release of Ruby 1.8.5 Matt Taylor + * Noticed excessive calls to ObjectId#to_s. As a result, stopped creating log messages when no logger was passed to Mongo::Connection. Resulted in a significant performance improvement. Hongli Lai (Phusion) + * Significant performance improvements. See commits. Mislav Marohnić + * Replaced returning with each_with_object diff --git a/docs/HISTORY.md b/docs/HISTORY.md index 93305c3..be1ce7a 100644 --- a/docs/HISTORY.md +++ b/docs/HISTORY.md @@ -1,44 +1,57 @@ -1.1.1 2010-10-14 +# MongoDB Ruby Driver History + +### 1.1.1 +2010-10-14 + * Several critical JRuby bug fixes * Fixes for JRuby in 1.9 mode * Check keys and move id only when necessary for JRuby encoder -1.1 2010-10-4 +## 1.1 +2010-10-4 + * Official JRuby support via Java extensons for BSON (beta) * Connection#lock! and Connection#unlock! for easy fsync lock * Note: BSON::Code is no longer a subclass of String. -1.0.9 2010-9-20 -* Significant performance improvements +### 1.0.9 +2010-9-20 -1.0.8 2010-8-27 +* Significant performance improvements (with a lot of help from Hongli Lai) + +### 1.0.8 +2010-8-27 * Cursor#rewind! and more consistent Cursor Enumberable behavior * Deprecated ObjectID for ObjectId * Numerous minor bug fixes. -1.0.7 2010-8-4 +### 1.0.7 +2010-8-4 * A few minor test/doc fixes. * Better tests for replica sets and replication acknowledgment. * Deprecated DB#error and DB#last_status -1.0.6 2010-7-26 +### 1.0.6 +2010-7-26 * Replica set support. * Collection#map_reduce bug fix. -1.0.5 2010-7-13 +### 1.0.5 +2010-7-13 * Fix for bug introduced in 1.0.4. -1.0.4 2010-7-13 +### 1.0.4 +2010-7-13 * Removed deprecated - - Cursor admin option - - DB#query - - DB#create_index (use Collection#create_index) - - DB#command only takes hash options now + * Cursor admin option + * DB#query + * DB#create_index (use Collection#create_index) + * DB#command only takes hash options now * j2bson executable (neomantra) * Fixed bson_ext compilation on Solaris (slyphon) * System JS helpers (neovintage) @@ -49,12 +62,15 @@ * Fix for broken Socket.send with large payloads (Frédéric De Jaeger) * Lots of minor improvements. See commmits. -1.0.3 2010-6-15 +### 1.0.3 +2010-6-15 * Optimiztion for BSON::OrderedHash * Some important fixes. -1.0.2 2010-6-5 +### 1.0.2 +2010-6-5 + This is a minor release for fixing an incompatibility with MongoDB v1.5.2 * Fix for boolean response on commands for core server v1.5.2 @@ -62,7 +78,8 @@ This is a minor release for fixing an incompatibility with MongoDB v1.5.2 * BSON::ObjectID() shortcut for BSON::ObjectID.from_string (tmm1) * Various bug fixes. -1.0.1 2010-5-7 +### 1.0.1 +2010-5-7 * set Encoding.default_internal * DEPRECATE JavaScript string on Collection#find. You now must specify $where explicitly. @@ -71,7 +88,8 @@ This is a minor release for fixing an incompatibility with MongoDB v1.5.2 * Support for $slice * Namespaced OrderedHash under BSON (sleverbor) -1.0 2010-4-29 +## 1.0 +2010-4-29 Note: if upgrading from versions prior to 0.20, be sure to upgrade to 0.20 before upgrading to 1.0. @@ -83,10 +101,14 @@ to 0.20 before upgrading to 1.0. * Deprecated DB#create_index. Use Collection#create_index index. * Removed deprecated Grid#put syntax; no longer requires a filename. -0.20.1 2010-4-7 - * Added bson gem dependency. +### 0.20.1 +2010-4-7 + +* Added bson gem dependency. + +### 0.20 +2010-4-7 -0.20 2010-4-7 If upgrading from a previous version of the Ruby driver, please read these notes carefully, along with the 0.20_UPGRADE doc. @@ -122,94 +144,6 @@ along with the 0.20_UPGRADE doc. * MinKey and MaxKey * Extensions compile on Rubinius (Chuck Remes). -0.19.3 2010-4-5 -* Minor fix for assert_valid_keys. +## Prior to 0.20 -0.19.2 2010-4-5 -This release fixes a major bug and is the final release -in the 0.19 series. The next release, 0.20.0, will introduce -separate gems for bson and bson_ext and may require small -changes to existing code bases. Expect that release in the next -few days. -* Fix for Grid#delete bug. -* Log messages read like valid ruby driver code. -* Cursor#has_next. -* Tests for MongoDB 1.4 features. -* Flexible index creation method with Mongo::GEO2D constant. - -0.19.1 2010-3-2 -* Fix for HashWithIndifferentAccess in ActiveSupport-3.0 - -0.19 2010-3-1 -* Deprecated GridFS::GridStore. Grid and GridFileSystem classes replace -the GridFS implementation with a simpler API and vastly-improved performance. -See http://www.mongodb.org/display/DOCS/GridFS+in+Ruby for more details. -* Safe mode for Grid and GridFileSystem. -* Grid and GridFileSystem use Mime/Types to detect content type (if available) -* Connection API simplified. Use Connection.paired for pairs and Connection.from_uri to -use MongoDB's connection URI specification. -* Authentication can be saved so that reauthentication happens automatically -on reconnect. -* Raise exception if authentication fails. -* Raise exception if index creation fails. -* Removed a number of deprecated methods and classes. -* Several bug fixes. -* Nearing 1.0! - -0.18.3 2010-1-25 -* Convert docs to YARD -* Support MongoDB extended JSON on ObjectID#to_json -* ObjectID#from_time for performing date range queries on _id (thx., Sunny Hirai) -* GridStore#mv for renaming files (Matt Powell) -* Safe mode for Collection#remove (Patrick Collison) -* Support BSON types MinKey and MaxKey -* DEPRECATED Admin, XMLToRuby, and RegexpOfHolding classes. -* Handle unsupported Numeric types gracefully (Complex, Rational, BigDecimal) -* Handle unsupported Time types gracefully (Date, DateTime, ActiveSupport::TimeWithZone) -* Numerous small bug fixes -* Minor performance improvements - -0.18.2 2009-12-29 -* Significant GridStore performance improvement (thx., Sunny Hirai) -* Enabled support for keyf on group -* Support :query option for Collection#distinct -* Support :finalize option for Collection#group -* (0.18.1) ObjectID#generation_time returns a created_at timestamp. -* Deprecated Command#group running as a JS eval; should now be run as a command. -* Deprecated Cursor#next_object for Cursor#next_document -* Character encoding fixes for C extension -* Enforce 4MB limit on document creation -* Simplified connection pooling code -* Fixes for connection pooling on Ruby 1.8.6/Windows. - -0.18.1 2009-12-05 -* Fixed issue with negative dates in Ruby 1.9 -* Minor refactorings for C extension and BSON classes -* Ensure UTF-8 in Ruby 1.8 -* Fix for connections on non-default port (Delano Mandelbaum) -* More explicit test suite tasks for running with/without C extension. - -0.18 2009-11-25 -* Connections now support connection pooling. See http://api.mongodb.org/ruby/0.18/classes/Mongo/Connection.html#M000158 -* Deprecated :auto_reconnect option on connection; if the driver fails to - connect, it will automatically try to reconnect on the subsequent operation. - See http://www.mongodb.org/display/DOCS/Replica+Pairs+in+Ruby -* Added Collection#map_reduce helper (Christos Trochalakis) -* Deprecated DB#db_command in favor of DB#command. -* Removed deprecated old sort options, :offset, and Connection#clear. -* Lots of internal code restructuring for better maintainability. - -0.17.1 2009-11-17 -* Index ordering fix -* Notice to install mongo_ext - -0.17 2009-11-16 -* Performance improvements - * large document inserts twice as fast as 0.16 - * queries 18% faster than 0.16 on average - * see benchmark comparison: http://gist.github.com/236062 -* Support for multi-update for Mongo >= 1.1.3 (See Collection#update) -* Collection#distinct -* Connection#copy_database (voodootikigod) -* C optimizations for ByteBuffer#to_s and ObjectID#generate (seancribbs) -* Continue code restructuring for performance and simplicity. +See git revisions.