mongodoc 0.2.1 → 0.2.2

data/README.textile

@@ -2,6 +2,8 @@ h1. MongoDoc
 
 Version: 0.2.1 1/18/10
 
+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.
@@ -26,7 +28,7 @@ class Address
   attr_accessor :street, :city, :state, :zip, :phone_number
 end
 
-p. With MongoDoc, instead of saving JSON[1], we can save an object directly:
+p. With MongoDoc, instead of saving JSON[2], we can save an object directly:
 
 bc.. contact = Contact.new
 contact.name = 'Hashrocket'
@@ -100,21 +102,48 @@ bc. hashrocket.addresses.first.update_attributes(:street => '320 First Street No
 
 h2. Installation
 
+MongoDoc *requires* mongoDB v1.3.2 or later.
+
 bc. sudo gem install mongodoc
 
-h2. Configuration
+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:
 
-Configure your database connection in ./mongodb.yml, you do not need one if you are running on localhost with the default port
+bc. MongoDoc::Connection.config_path = './config/mongodb.yml'
 
-bc. name: test
-host: localhost
-port: 27017
-options:
-  auto_reconnect: true
+h3. Programmatically setting the database connection information
 
-You can change the location of the configuration file:
+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.config_path = './config/mongodb.yml'
+bc. MongoDoc::Connection.name = 'stats'
 
 h2. Credits
 
@@ -137,7 +166,8 @@ h2. Note on Patches/Pull Requests
 
 h2. Copyright
 
-Copyright (c) 2009 Les Hill. See LICENSE for details.
+Copyright (c) 2009 - 2010 Les Hill. See LICENSE for details.
 
-fn1. The Ruby driver exposes an API that understands JSON.
+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

@@ -10,12 +10,12 @@ begin
     gem.email = "leshill@gmail.com"
     gem.homepage = "http://github.com/leshill/mongodoc"
     gem.authors = ["Les Hill"]
-    gem.add_dependency "mongo", "= 0.18.2"
-    gem.add_dependency "mongo_ext", "= 0.18.2"
+    gem.add_dependency "mongo", "= 0.18.3"
+    gem.add_dependency "mongo_ext", "= 0.18.3"
     gem.add_dependency "durran-validatable", "= 2.0.1"
     gem.add_dependency "leshill-will_paginate", "= 2.3.11"
-    gem.add_development_dependency "rspec", "= 1.2.9"
-    gem.add_development_dependency "cucumber", "= 0.4.4"
+    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

data/TODO

@@ -0,0 +1,26 @@
+As of 2010-02-05
+
+Associations
+------------
+
+Pull associations out of attributes and refactor
+
+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

@@ -1 +1 @@
-0.2.1
+0.2.2

data/examples/simple_document.rb

@@ -20,12 +20,12 @@ class Contact
   named_scope :in_state, lambda {|state| {:where => {'addresses.state' => state}}}
 end
 
-MongoDoc.connect_to_database 'test'
 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'}
 

data/examples/simple_object.rb

@@ -8,8 +8,6 @@ class Address
   attr_accessor :street, :city, :state, :zip, :phone_number
 end
 
-MongoDoc.connect_to_database 'test'
-
 collection = MongoDoc::Collection.new('contacts')
 collection.drop
 

data/features/mongodb.yml

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

data/features/removing_documents.feature

@@ -0,0 +1,68 @@
+Feature: Removing Documents
+
+  Background:
+    Given an empty Contact document collection
+    And a Contact document named 'hashrocket' :
+      | Name       | Type    | Note                            |
+      | Hashrocket | company | Premier Rails development shop! |
+    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           | Note                |
+      | Rocketeer Mike | Fantastic developer |
+    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           | Note          |
+      | Contractor Joe | Knows MongoDB |
+    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'
+    And a Place document named 'hashrocket_hq' :
+      | Name       | Type    |
+      | Hashrocket | company |
+    And 'hashrocket_hq' has one Address as address (identified by 'hq_address'):
+      | Street                 | City               | State | Zip Code |
+      | 1 Main St.             | Jacksonville       | FL    | 32218    |
+    And I save the document 'hashrocket_hq'
+
+  Scenario: Simple Remove
+    Given the document 'contractor' roundtrips
+    When I remove 'contractor'
+    Then the document 'contractor' is not found
+
+  Scenario: Embedded Remove
+    When the document 'hashrocket_hq' roundtrips
+    Then an exception is raised if I remove 'hq_address'

data/features/step_definitions/collection_steps.rb

@@ -1,11 +1,11 @@
 Given /a new collection named '(.*)'/ do |name|
-  MongoDoc.database.drop_collection(name)
+  MongoDoc::Connection.database.drop_collection(name)
   @collection = MongoDoc::Collection.new(name)
 end
 
 Given /^an empty (\w+) collection$/ do |name|
-  MongoDoc.database.drop_collection(name)
-  MongoDoc.database.create_collection(name, :strict => true)
+  MongoDoc::Connection.database.drop_collection(name)
+  MongoDoc::Connection.database.create_collection(name, :strict => true)
 end
 
 Then /the collection should have (\d+) documents?/ do |count|

data/features/step_definitions/document_steps.rb

@@ -31,10 +31,10 @@ end
 Given /^'(.*)' has (?:a|an|many) (.*) :$/ do |doc_name, assoc_name, table|
   doc = instance_variable_get("@#{doc_name}")
   table.hashes.each do |hash|
-    doc.send(assoc_name) << hash.inject({}) do |attrs, (attr, value)|
+    doc.send(assoc_name).build(hash.inject({}) do |attrs, (attr, value)|
       attrs["#{attr.underscore.gsub(' ', '_')}"] = value
       attrs
-    end
+    end)
   end
   @all = doc.send(assoc_name)
   @last = @all.last

data/features/step_definitions/removing_documents_steps.rb

@@ -0,0 +1,14 @@
+When /^I remove '(.+)'$/ do |doc_name|
+  doc = instance_variable_get("@#{doc_name}")
+  doc.remove
+end
+
+Then /^the document '(.+)' is not found$/ do |doc_name|
+  doc = instance_variable_get("@#{doc_name}")
+  doc.class.find_one(doc.id)
+end
+
+Then /^an exception is raised if I remove '(.+)'$/ do |doc_name|
+  doc = instance_variable_get("@#{doc_name}")
+  lambda { doc.remove }.should raise_error
+end

data/features/support/support.rb

@@ -4,7 +4,7 @@ require 'spec/expectations'
 require 'spec/bson_matchers'
 require 'mongodoc'
 
-MongoDoc.config_path = './features/mongodb.yml'
-MongoDoc.connect_to_database
+MongoDoc::Connection.env = 'cucumber'
+MongoDoc::Connection.config_path = './features/mongodb.yml'
 
 World(BsonMatchers)

data/lib/mongodoc.rb

@@ -1,20 +1,17 @@
 require 'rubygems'
 
-gem 'mongo', '0.18.2'
-gem 'mongo_ext', '0.18.2'
+gem 'mongo', '0.18.3'
+gem 'mongo_ext', '0.18.3'
 gem 'durran-validatable', '2.0.1'
 gem 'leshill-will_paginate', '2.3.11'
 
 require 'mongo'
-require 'activesupport'
+require 'active_support'
 require 'validatable'
 require 'will_paginate/collection'
 
 module MongoDoc
-  VERSION = '0.1.2'
-
-  class NoConnectionError < RuntimeError; end
-  class NoDatabaseError < RuntimeError; end
+  VERSION = '0.2.2'
 end
 
 require 'mongodoc/connection'

data/lib/mongodoc/associations/collection_proxy.rb

@@ -0,0 +1,103 @@
+# Thanks Sandro!
+# http://github.com/sandro
+module MongoDoc
+  module Associations
+    class CollectionProxy < ProxyBase
+      # List of array methods (that are not in +Object+) that need to be
+      # delegated to +collection+.
+      ARRAY_METHODS = (Array.instance_methods - Object.instance_methods).map { |n| n.to_s }
+
+      # List of additional methods that must be delegated to +collection+.
+      MUST_DEFINE = %w[to_a to_ary inspect to_bson ==]
+
+      DO_NOT_DEFINE = %w[concat insert replace]
+
+      (ARRAY_METHODS + MUST_DEFINE - DO_NOT_DEFINE).uniq.each do |method|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{method}(*args, &block)                 # def each(*args, &block)
+            collection.send(:#{method}, *args, &block) #   collection.send(:each, *args, &block)
+          end                                          # end
+        RUBY
+      end
+
+      attr_reader :collection
+
+      def _root=(root)
+        @_root = root
+        collection.each do |item|
+          item._root = root if is_document?(item)
+        end
+      end
+
+      def initialize(options)
+        super
+        @collection = []
+      end
+
+      alias _append <<
+      def <<(item)
+        attach(item)
+        _append item
+        self
+      end
+      alias push <<
+
+      alias add []=
+      def []=(index, item)
+        attach(item)
+        add(index, item)
+      end
+      alias insert []=
+
+      def build(attrs)
+        item = assoc_class.new(attrs)
+        push(item)
+      end
+
+      def concat(array)
+        array.each do |item|
+          push(item)
+        end
+      end
+
+      # Lie about our class. Borrowed from Rake::FileList
+      # Note: Does not work for case equality (<tt>===</tt>)
+      def is_a?(klass)
+        klass == Array || super(klass)
+      end
+      alias kind_of? is_a?
+
+      def replace(other)
+        clear
+        concat(other)
+      end
+
+      alias _unshift unshift
+      def unshift(item)
+        attach(item)
+        _unshift(item)
+      end
+
+      def valid?
+        all? do |child|
+          if is_document?(child)
+            child.valid?
+          else
+            true
+          end
+        end
+      end
+
+      protected
+
+      def annotated_keys(src, attrs)
+        assoc_path = "#{assoc_name}.#{index(src)}"
+        annotated = {}
+        attrs.each do |(key, value)|
+          annotated["#{assoc_path}.#{key}"] = value
+        end
+        annotated
+      end
+    end
+  end
+end

data/lib/mongodoc/associations/document_proxy.rb

@@ -0,0 +1,53 @@
+module MongoDoc
+  module Associations
+    class DocumentProxy < ProxyBase
+
+      attr_reader :document
+
+      def _root=(root)
+        @_root = root
+        document._root = root if is_document?(document)
+      end
+
+      def ==(other)
+        if self.class === other
+          document == other.document
+        else
+          document == other
+        end
+      end
+
+      def build(attrs)
+        item = assoc_class.new(attrs)
+        self.document = item
+      end
+
+      def document=(doc)
+        attach(doc)
+        @document = doc
+      end
+
+      def valid?
+        if is_document?(document)
+          document.valid?
+        else
+          true
+        end
+      end
+
+      private
+
+      def method_missing(method, *args)
+        unless document.respond_to?(method)
+          raise NoMethodError, "undefined method `#{method.to_s}' for proxied \"#{document}\":#{document.class.to_s}"
+        end
+
+        if block_given?
+          document.send(method, *args)  { |*block_args| yield(*block_args) }
+        else
+          document.send(method, *args)
+        end
+      end
+    end
+  end
+end