mongo_doc 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+mongod.yml
+nohup.out

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Les Hill
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,174 @@
+h1. MongoDoc
+
+Version: 0.2.4 2/23/10
+
+2010-02-23 API is *changing* significantly
+2010-01-23 Tracking MongoDoc with @git@? *READ THIS NOTE*[1]
+
+h2. Introduction
+
+MongoDoc is a simple and easy to use ActiveRecord-like object mapper for "mongoDB":http://www.mongodb.org in Ruby.
+
+MongoDoc is _also_ an extension of the "Mongo Ruby Driver":http://github.com/mongodb/mongo-ruby-driver making it a snap to get Ruby in and out of mongoDB.
+
+MongoDoc is *not* ActiveRecord for mongoDB.  We do not have callbacks, nor do we have dynamic finders.  We do have associations, named scopes, and other features.
+
+MongoDoc *is* simple, easy-to-use, and fast. And it works with Rails (2.3.x at the moment, 3 soonish?).
+
+MongoDoc is designed to work with document data, if you are looking to map relational data in mongoDB, you will have to look elsewhere.
+
+h2. Ruby objects in mongoDB
+
+Lets just get right into it and save some Ruby objects in mongoDB!
+
+bc.. class Contact
+  attr_accessor :name, :addresses, :interests
+end
+
+class Address
+  attr_accessor :street, :city, :state, :zip, :phone_number
+end
+
+p. With MongoDoc, instead of saving JSON[2], we can save an object directly:
+
+bc.. contact = Contact.new
+contact.name = 'Hashrocket'
+contact.interests = ['ruby', 'rails', 'agile']
+
+address = Address.new
+address.street = '320 First Street North, #712'
+address.city = 'Jacksonville Beach'
+address.state = 'FL'
+address.zip = '32250'
+address.phone_number = '877 885 8846'
+contact.addresses = [address]
+
+collection.save(contact)
+
+p. We can query using the powerful mongoDB query syntax, and have it return Ruby objects:
+
+bc.. results = collection.find('addresses.state' => 'FL')
+hashrocket = results.to_a.find {|contact| contact.name == 'Hashrocket'}
+puts hashrocket.addresses.first.phone_number
+
+p. Take a look in the examples directory for more code.
+
+h2. Mapping Documents
+
+MongoDoc provides ActiveRecord-like persistence, associations, named scopes, and validations (from "Validatable":http://github.com/durran/validatable) as well as a mongoDB query language (from "Mongoid":http://mongoid.org/home). MongoDoc also plays nicely with Rails.
+
+@MongoDoc::Document@ provides all these features as a mixin.  A @MongoDoc::Document@ can either be a top-level mongoDB document, or an embedded document contained within a top-level document. Top-level documents are stored in collections named after their class: @Contact@ objects are stored in the 'contacts' collection (much like ActiveRecord).
+
+Lets define a @Contact@ document with an @Address@ embedded document:
+
+bc.. class Address
+  include MongoDoc::Document
+
+  key :street
+  key :city
+  key :state
+  key :zip_code
+  key :phone_number
+end
+
+class Contact
+  include MongoDoc::Document
+
+  key :name
+  key :interests
+  has_many :addresses
+
+  named_scope :in_state, lambda {|state| {:where => {'addresses.state' => state}}}
+end
+
+p. Since a mongoDB document has no fixed schema, we define the composition of a document directly in our classes. Please note we do not specify types! We can also specify @has_one@ or @has_many@ associations.
+
+Building and saving a document is easy:
+
+bc.. contact = Contact.new(:name => 'Hashrocket', :interests => ['ruby', 'rails', 'agile'])
+contact.addresses << Address.new(:street => '320 1st Street North, #712',
+  :city => 'Jacksonville Beach',
+  :state => 'FL',
+  :zip_code => '32250',
+  :phone_number => '877 885 8846')
+contact.save
+
+p. Now that we have some data, we can query using our named scope:
+
+bc. hashrocket = Contact.in_state('FL').find {|contact| contact.name == 'Hashrocket'}
+
+p. And we can even perform partial updates:
+
+bc. hashrocket.addresses.first.update_attributes(:street => '320 First Street North, #712')
+
+h2. Installation
+
+MongoDoc *requires* mongoDB v1.3.2 or later.
+
+bc. sudo gem install mongodoc
+
+h2. Connecting
+
+By default, MongoDoc will read its configuration from @./mongodb.yml@. If that file does not exist, it will attempt to connect to a standard MongoDB local server setup and use a database name of @"mongodoc"@.
+
+h3. With Rails
+
+If you are using Rails, MongoDoc will look for its configuration in @config/mongodb.yml@. If that file does not exist, it will attempt to connect to a standard MongoDB local server setup and use a database name of @#{Rails.root.basename}_#{Rails.env}@.
+
+h3. Database configuration file
+
+The file is similar to the Rails database.yml file, with environment definitions containing the database configuration attributes. For example:
+
+bc. development:
+  name: development
+  host: localhost
+  port: 27017
+  options:
+    auto_reconnect: true
+test:
+  name: test
+  host: localhost
+  port: 27017
+  options:
+    auto_reconnect: true
+
+If you are not using Rails, the default environment is @development@ and you can set the current environment in your code:
+
+bc. MongoDoc::Connection.env = 'test'
+
+You can also change the location of the configuration file:
+
+bc. MongoDoc::Connection.config_path = './config/mongodb.yml'
+
+h3. Programmatically setting the database connection information
+
+Finally, if you do not want to use the database configuration file, you can also set the database name, host, port, options, and strict values directly; for example, to set the database name to @stats@:
+
+bc. MongoDoc::Connection.name = 'stats'
+
+h2. Credits
+
+Les Hill, leshill on github
+
+h3. Thanks
+
+Thanks to Sandro and Durran for some great conversations and some lovely code.
+
+h2. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Copyright
+
+Copyright (c) 2009 - 2010 Les Hill. See LICENSE for details.
+
+fn1. Building from @HEAD@? MongoDoc *requires* mongoDB v1.3.2 or later. That means you must be using the 1.3.x nightly build as of 2010-01-22 .
+
+fn2. The Ruby driver exposes an API that understands JSON.

data/Rakefile

@@ -0,0 +1,135 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_doc"
+    gem.summary = %Q{ODM for MongoDB}
+    gem.description = %Q{ODM for MongoDB}
+    gem.email = "leshill@gmail.com"
+    gem.homepage = "http://github.com/leshill/mongodoc"
+    gem.authors = ["Les Hill"]
+    gem.add_dependency "mongo", "= 0.19"
+    gem.add_dependency "mongo_ext", "= 0.19"
+    gem.add_dependency "durran-validatable", "= 2.0.1"
+    gem.add_dependency "leshill-will_paginate", "= 2.3.11"
+    gem.add_development_dependency "rspec", "= 1.3.0"
+    gem.add_development_dependency "cucumber", "= 0.6.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty --tag ~@wip"
+end
+
+namespace :cucumber do
+  Cucumber::Rake::Task.new(:wip) do |t|
+    t.cucumber_opts = "--format pretty --tag @wip"
+  end
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.spec_opts = ['--options', "#{File.expand_path(File.dirname(__FILE__))}/spec/spec.opts"]
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.spec_opts = ['--options', "#{File.expand_path(File.dirname(__FILE__))}/spec/spec.opts"]
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "MongoDoc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :mongo do
+  desc 'Start mongod'
+  task :start do
+    default_config = { "dbpath" => "/data/db" }
+    config = begin
+      YAML.load_file(File.join(File.dirname(__FILE__), 'mongod.yml'))
+    rescue Exception => e
+      {}
+    end
+    config = default_config.merge(config)
+    sh("nohup #{config['mongod'] || 'mongod'} --dbpath #{config['dbpath']} &")
+    puts "\n"
+  end
+end
+
+namespace :mongoid do
+  desc 'Sync criteria from Mongoid'
+  task :sync do
+    require 'pathname'
+
+    src_dir = Pathname.new('../durran-mongoid/lib/mongoid')
+    dest_dir = Pathname.new('lib/mongoid')
+    dest_dir.mkpath
+    %w(criteria.rb contexts/paging.rb criterion extensions/symbol/inflections.rb extensions/hash/criteria_helpers.rb matchers).each do |f|
+      src = src_dir + f
+      if src.directory?
+        FileUtils.cp_r(src, dest_dir)
+      else
+        dest = dest_dir + f
+        dest.dirname.mkpath
+        FileUtils.cp(src, dest)
+      end
+    end
+  end
+end
+
+namespace :bench do
+  desc 'Run benchmark for MongoDoc'
+  task 'mongo_doc' do
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+    require 'perf/mongo_doc_runner'
+    MongoDocRunner.benchmark
+  end
+
+  desc 'Run profiler for driver'
+  task 'driver' do
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+    require 'perf/ruby_driver_runner'
+    RubyDriverRunner.benchmark
+  end
+end
+
+namespace :prof do
+  desc 'Run profiler for MongoDoc'
+  task 'mongo_doc' do
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+    require 'perf/mongo_doc_runner'
+    MongoDocRunner.profile
+  end
+
+  desc 'Run profiler for driver'
+  task 'driver' do
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+    require 'perf/ruby_driver_runner'
+    RubyDriverRunner.profile
+  end
+end

data/TODO

@@ -0,0 +1,31 @@
+As of 2010-02-23
+
+Associations
+------------
+
+Pull associations out of attributes and refactor
+
+Criteria
+--------
+
+Make critieria module, include into Document, CriteriaProxy, Association?
+
+Documentation
+-------------
+
+How to get started with Rails
+Using mongohq
+
+Dynamic Attributes
+------------------
+
+Document#[] => reads attribute
+Document#[]= => writes attribute
+Document#dynamic_attributes => key, value for each dynamic attribute
+Document#dynamic_attribute_names => list of dynamic attribute names
+
+Validations
+-----------
+
+validates_hash_keys :has_hash_name, :in => [array of names]
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/data/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/examples/simple_document.rb

@@ -0,0 +1,35 @@
+require 'mongo_doc'
+
+class Address
+  include MongoDoc::Document
+
+  key :street
+  key :city
+  key :state
+  key :zip_code
+  key :phone_number
+end
+
+class Contact
+  include MongoDoc::Document
+
+  key :name
+  key :interests
+  has_many :addresses
+
+  scope :in_state, lambda {|state| where('addresses.state' => state)}
+end
+
+Contact.collection.drop
+
+contact = Contact.new(:name => 'Hashrocket', :interests => ['ruby', 'rails', 'agile'])
+contact.addresses << Address.new(:street => '320 1st Street North, #712', :city => 'Jacksonville Beach', :state => 'FL', :zip_code => '32250', :phone_number => '877 885 8846')
+contact.save
+puts Contact.find_one(contact.to_param).addresses.first.street
+
+hashrocket = Contact.in_state('FL').find {|contact| contact.name == 'Hashrocket'}
+
+hashrocket_address = hashrocket.addresses.first
+hashrocket_address.update_attributes(:street => '320 First Street North, #712')
+
+puts Contact.where(:name => 'Hashrocket').first.addresses.first.street

data/examples/simple_object.rb

@@ -0,0 +1,30 @@
+require 'mongo_doc'
+
+class Contact
+  attr_accessor :name, :addresses, :interests
+end
+
+class Address
+  attr_accessor :street, :city, :state, :zip, :phone_number
+end
+
+collection = MongoDoc::Collection.new('contacts')
+collection.drop
+
+contact = Contact.new
+contact.name = 'Hashrocket'
+contact.interests = ['ruby', 'rails', 'agile']
+
+address = Address.new
+address.street = '320 First Street North, #712'
+address.city = 'Jacksonville Beach'
+address.state = 'FL'
+address.zip = '32250'
+address.phone_number = '877 885 8846'
+contact.addresses = [address]
+
+collection.save(contact)
+
+results = collection.find('addresses.state' => 'FL')
+hashrocket = results.to_a.find {|contact| contact.name == 'Hashrocket'}
+puts hashrocket.addresses.first.phone_number

data/features/finders.feature

@@ -0,0 +1,76 @@
+Feature: Finders
+
+  Background:
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       | Type    |
+      | Hashrocket | company |
+    And 'hashrocket' has interests, an array of:
+      | Interest      |
+      | ruby          |
+      | rails         |
+      | employment    |
+      | contract work |
+      | restaurants   |
+      | hotels        |
+      | flights       |
+      | car rentals   |
+    And 'hashrocket' has many addresses :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+      | 1 Lake Michigan Street | Chicago            | IL    | 60611    |
+      | 1 Main Street          | Santiago           | Chile |          |
+    And I save the document 'hashrocket'
+    And a Contact document named 'rocketeer' :
+      | Name           |
+      | Rocketeer Mike |
+    And 'rocketeer' has interests, an array of:
+      | Interest    |
+      | ruby        |
+      | rails       |
+      | restaurants |
+      | employment  |
+    And 'rocketeer' has many addresses :
+      | Street                 | City               | State | Zip Code |
+      | 1 Main Street          | Atlantic Beach     | FL    | 32233    |
+    And I save the document 'rocketeer'
+    And a Contact document named 'contractor' :
+      | Name          |
+      | Contractor Joe |
+    And 'contractor' has interests, an array of:
+      | Interest      |
+      | ruby          |
+      | rails         |
+      | contract work |
+      | flights       |
+      | car rentals   |
+      | hotels        |
+      | restaurants   |
+    And 'contractor' has many addresses :
+      | Street                 | City               | State | Zip Code |
+      | 1 Main St.             | Jacksonville       | FL    | 32218    |
+    And I save the document 'contractor'
+
+  Scenario: All
+    When I query contacts with find_all
+    Then the query result has 3 documents
+
+  Scenario: Count
+    When I query contacts with count
+    Then the query result was 3 documents
+
+  Scenario: First
+    When I query contacts with first
+    Then the query result is the document 'hashrocket'
+
+  Scenario: Last
+    When I query contacts with last
+    Then the query result is the document 'contractor'
+
+  Scenario: Find One
+    When I query contacts to find_one with the id of the 'contractor' document
+    Then the query result is the document 'contractor'
+
+  Scenario: Find One by Param
+    When I query contacts to find_one with the to_param of the 'contractor' document
+    Then the query result is the document 'contractor'

data/features/mongodb.yml

@@ -0,0 +1,7 @@
+cucumber:
+  name: cucumber
+  host: localhost
+  port: 27017
+  options:
+    auto_reconnect: true
+

data/features/mongodoc_base.feature

@@ -0,0 +1,128 @@
+Feature: MongoDoc::Base
+
+  Scenario: creating a simple document
+    Given an empty Address document collection
+    And a hash named 'hashrocket':
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+    When I create an Address 'address' from the hash 'hashrocket'
+    Then 'address' is not a new record
+    And the Address collection should have 1 document
+    And the document 'address' roundtrips
+
+  Scenario: saving a simple document
+    Given an empty Address document collection
+    And an Address document named 'hashrocket' :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+    When I save the document 'hashrocket'
+    Then 'hashrocket' is not a new record
+    And the Address collection should have 1 document
+    And the document 'hashrocket' roundtrips
+
+  Scenario: updating an attribute of a simple document
+    Given an empty Address document collection
+    And an Address document named 'hashrocket' :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+    And a hash named 'street':
+      | Street         |
+      | 320 First St N |
+    And I save the document 'hashrocket'
+    When I update the document 'hashrocket' with the hash named 'street'
+    And the document 'hashrocket' roundtrips
+    Then the attribute 'street' of 'hashrocket' is '320 First St N'
+
+  Scenario: failing to update an attribute of a simple document
+    Given an empty Address document collection
+    And an Address document named 'hashrocket' :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+    And a hash named 'street':
+      | Street         |
+      | 320 First St N |
+    And I save the document 'hashrocket'
+    And I set the id on the document 'hashrocket' to 1
+    When I update the document 'hashrocket' with the hash named 'street'
+    Then the last return value is false
+
+  Scenario: saving a has_many document
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       |
+      | Hashrocket |
+    And 'hashrocket' has many addresses :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+      | 1 Main Street          | Santiago           | Chile |          |
+    When I save the document 'hashrocket'
+    Then 'hashrocket' is not a new record
+    And the Contact collection should have 1 document
+    And the document 'hashrocket' roundtrips
+
+  Scenario: saving from a child document
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       |
+      | Hashrocket |
+    And 'hashrocket' has many addresses :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+      | 1 Main Street          | Santiago           | Chile |          |
+    When I save the last document
+    Then 'hashrocket' is not a new record
+    And the Contact collection should have 1 document
+    And the document 'hashrocket' roundtrips
+
+  Scenario: Update attributes from a has_many child document
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       |
+      | Hashrocket |
+    And 'hashrocket' has many addresses :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+      | 1 Main Street          | Santiago           | Chile |          |
+    And I save the last document
+    And that @last is named 'chile'
+    And a hash named 'street':
+      | Street         |
+      | 1a Calle       |
+    When I update the document 'chile' with the hash named 'street'
+    Then the last return value is true
+    And the document 'hashrocket' roundtrips
+
+  Scenario: update attributes from a has_one child document
+    Given an empty Place document collection
+    And a Place document named 'hashrocket' :
+      | Name       |
+      | Hashrocket |
+    And 'hashrocket' has one Address as address :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+    And I save the last document
+    And that @last is named 'address'
+    And a hash named 'street':
+      | Street         | City    |
+      | 320 1st St. N. | Jax Bch |
+    When I update the document 'address' with the hash named 'street'
+    Then the Place collection should have 1 document
+    And the document 'hashrocket' roundtrips
+
+  Scenario: Class criteria
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       | Type    |
+      | Hashrocket | company |
+    And I save the last document
+    When I query contacts with criteria where('type' => 'company')
+    Then the size of the last return value is 1
+
+  Scenario: Finder
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       | Type    |
+      | Hashrocket | company |
+    And I save the document 'hashrocket'
+    When I find a contact using the id of 'hashrocket'
+    Then the size of the last return value is 1