mongo_record 0.4.2

data/LICENSE

@@ -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,85 @@
+= Welcome to MongoRecord
+
+MongoRecord is an ActiveRecord-like framework for the 10gen
+Mongo[http://www.mongodb.org/] database.
+
+This document assumes you have read the Mongo documentation.
+
+A quick code sample:
+
+  require 'rubygems'
+  require 'mongo'
+  require 'mongo_record'
+
+  class Track < MongoRecord::Base
+    collection_name :tracks
+    fields :artist, :album, :song, :track
+    index :artist
+
+    def to_s
+      "artist: #{artist}, album: #{album}, song: #@song, track: #{@track ? @track.to_i : nil}"
+    end
+  end
+
+  MongoRecord::Base.connection =
+    Mongo::Connection.new.db('mongorecord-test')
+
+  t = Track.new(:artist => 'Level 42', :album => 'Standing In The Light',
+                :song => 'Micro-Kid', :track => 1)
+  t.save
+  puts "There are #{Track.count()} tracks."
+  t = Track.find(:first, :conditions => {:song => 'Micro-Kid'})
+  Track.find(:all, :sort => 'song').each { |t| puts t.to_s }
+
+== Installation
+
+First set up Gemcutter
+
+  $ gem install gemcutter
+  $ gem tumble
+
+Then install
+
+  $ gem install mongo_record
+
+MongoRecord depends on the Mongo Ruby Driver, version 0.15 or higher.
+Installing the MongoRecord gem will also install the Mongo Ruby Driver if you
+don't have it already.
+
+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
+
+== Getting Started
+
+See the examples, read the MongoRecord::Base and MongoRecord::Cursor
+documentation, and look at tests/test_mongo.rb.
+
+=== Persistence
+
+You can use MongoRecord::Base or talk to the database (stored in the $db
+object) directly.
+
+See MongoRecord::Base and MongoRecord::Cursor.
+
+=== Logger
+
+See MongoRecord::LogDevice. When running outside of the cloud (for example,
+during development), all log messages are echoed to $stderr which is normally
+the console.
+
+== Credits
+Jim Mulholland, jim at squeejee dot com
+* Ability to save custom attributes not declared in the model
+* Save and retrieve custom "_id" fields
+* Find_each functionality
+* Find_last based on the created_at field
+* Assigning created_at and updated_at fields even if they are not declared
+* Alias methods for "first", "last" and "all"
+* Fix for sum method
+
+Clinton R. Nixon, crnixon at gmail dot com
+* Ability to define and query indexes from models

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'fileutils'
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+
+# NOTE: some of the tests assume Mongo is running
+Rake::TestTask.new do |t|
+  t.test_files = FileList['tests/test*.rb']
+end
+
+desc "Generate documentation"
+task :rdoc do
+  FileUtils.rm_rf('html')
+  system "rdoc --main README.rdoc --op html --inline-source --quiet README.rdoc `find lib -name '*.rb'`"
+end
+
+namespace :gem do 
+
+  desc "Install the gem locally"
+  task :install do
+    sh <<EOS
+gem build mongo-activerecord-ruby.gemspec &&
+    sudo gem install mongo_record*.gem &&
+    rm mongo_record-*.gem
+EOS
+  end
+
+end
+
+task :default => :list
+
+task :list do
+  system 'rake -T'
+end

data/examples/tracks.rb

@@ -0,0 +1,109 @@
+# Use the local copy, even if this gem is already installed.
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '../lib')
+
+require 'rubygems'
+require 'mongo'
+require 'mongo_record'
+
+class Track < MongoRecord::Base
+  collection_name :tracks
+  fields :artist, :album, :song, :track
+  def to_s
+    # Uses both accessor methods and ivars themselves
+    "artist: #{artist}, album: #{album}, song: #@song, track: #{@track ? @track.to_i : nil}"
+  end
+end
+
+host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Mongo::Connection::DEFAULT_PORT
+MongoRecord::Base.connection = Mongo::Connection.new(host,port).db('mongorecord-test')
+
+# Create data
+
+puts "Creating 6 records using \"raw\" Mongo access..."
+db = MongoRecord::Base.connection
+coll = db.collection('tracks')
+coll.remove({})
+coll.insert({:_id => Mongo::ObjectID.new, :artist => 'Thomas Dolby', :album => 'Aliens Ate My Buick', :song => 'The Ability to Swing'})
+coll.insert({:_id => Mongo::ObjectID.new, :artist => 'Thomas Dolby', :album => 'Aliens Ate My Buick', :song => 'Budapest by Blimp'})
+coll.insert({:_id => Mongo::ObjectID.new, :artist => 'Thomas Dolby', :album => 'The Golden Age of Wireless', :song => 'Europa and the Pirate Twins'})
+coll.insert({:_id => Mongo::ObjectID.new, :artist => 'XTC', :album => 'Oranges & Lemons', :song => 'Garden Of Earthly Delights', :track => 1})
+coll.insert({:_id => Mongo::ObjectID.new, :artist => 'XTC', :album => 'Oranges & Lemons', :song => 'The Mayor Of Simpleton', :track => 2})
+song_id = Mongo::ObjectID.new
+coll.insert({:_id => song_id, :artist => 'XTC', :album => 'Oranges & Lemons', :song => 'King For A Day', :track => 3})
+puts "Data created. One song_id = #{song_id}."
+puts "There are #{coll.count()} records in the tracks collection."
+
+
+puts "\nSimple find"
+puts Track.find(song_id).to_s
+puts Track.find(song_id, :select => :album).to_s
+puts Track.find_by_id(song_id).to_s
+puts Track.find_by_song("Budapest by Blimp").to_s
+
+puts "\nCount"
+puts "Yup; there are indeed #{Track.count} records in the tracks collection."
+
+puts "\nUpdate"
+x = Track.find_by_track(2)
+x.track = 99
+x.save
+puts Track.find_by_track(99).to_s
+
+puts "\nComplex find"
+puts Track.find_by_song('The Mayor Of Simpleton').to_s
+
+puts "\nFind all"
+Track.find(:all).each { |t| puts t.to_s }
+
+puts "\nFind song /to/"
+Track.find(:all, :conditions => {:song => /to/}).each { |row| puts row.to_s }
+
+puts "\nFind limit 2"
+Track.find(:all, :limit => 2).each { |t| puts t.to_s }
+
+puts "\nFind by album"
+Track.find(:all, :conditions => {:album => 'Aliens Ate My Buick'}).each { |t| puts t.to_s }
+
+puts "\nFind first"
+puts Track.find(:first).to_s
+
+puts "\nFind track 3"
+puts Track.find(:first, :conditions => {:track => 3}).to_s
+
+puts "\nfind_by_album"
+Track.find_all_by_album('Oranges & Lemons').each { |t| puts t.to_s }
+
+puts "\nSorting"
+Track.find(:all, :order => 'album desc').each { |t| puts t.to_s }
+
+puts "\nTrack.new"
+
+puts Track.new.to_s
+
+t = Track.new(:artist => 'Level 42', :album => 'Standing In The Light', :song => 'Micro-Kid', :track => 1)
+puts t.to_s
+puts "save returned #{t.save}"
+
+puts "\nTrack.find_or_create_by_song"
+
+s, a = 'The Ability to Swing', 'ignored because song found'
+puts Track.find_or_create_by_song(s, :artist => a).to_s
+
+s, ar, al = 'New Song', 'New Artist', 'New Album'
+puts Track.find_or_create_by_song(s, :artist => ar, :album => al).to_s
+
+puts "\nTrack.find(:first, :conditions => {:song => 'King For A Day'}).delete"
+t = Track.find(:first, :conditions => {:song => 'King For A Day'}).delete
+Track.find(:all).each { |t| puts t.to_s }
+
+puts "\nTrack.find('bogus_id')"
+puts "I should see an exception here:"
+begin
+  Track.find('bogus_id')
+rescue => ex
+  puts ex.to_s
+end
+
+puts "\nexplain()"
+puts Track.find(:all, :conditions => {:song => 'King For A Day'}).explain().inspect