mongo_doc 0.4.2 → 0.5.5

data/.gitignore

@@ -1,5 +1,6 @@
 *.sw?
 .DS_Store
+.rvmrc
 coverage
 rdoc
 pkg

data/HISTORY.md

@@ -1,4 +1,11 @@
+## 0.5.0 to 0.5.5
+
+* update to ruby driver 0.20.1 and the new bson gems
+* require MongoDB 1.4
+* can be used with ActiveSupport 2 or 3
+* Rails3 support with [MongoDoc-Rails](http://github.com/leshill/mongo_doc-rails) thanks to elliotcm
+
 ## 0.4.2
 
-* 'Document#update_attributes' uses $ positional operator when used from within an embed_many association
+* `Document#update_attributes` uses $ positional operator when used from within an embed_many association
 * Require MongoDB 1.3.4 or greater

data/README.textile

@@ -1,37 +1,17 @@
 h1. MongoDoc
 
-Version: Turbulence (0.4.2) 2010/03/23
-
-h2. What's New in Turbulence (0.4.2)
-
-Support for the $ positional operator for in-place array updates. This requires MongoDB version 1.3.4 or higher.
-
-h2. What's New in Turbulence (0.4.1)
-
-API changes (@key@ and @has_*@ still supported, will be deprectated soon)
-
-* @MongoDoc::Document.attr_accessor@ works like the old @key@ macro, and allows two parameters:
-** @:default => 'some default value'@
-** @:type => Date@ used when dealing with values from the web which will be coming in as @String@ values
-* Association macros have been renamed
-** @embed@ was @has_one@
-** @embed_many@ was @has_many@
-** @embed_hash@ was @has_hash@
-
-Indexing suppport
-
-* @MongoDoc::Document.index@
+Version: Maelstrom (0.5.5) 2010/04/08
 
 h2. Notes
 
-* 2010-03-12 Thanks to weather in ATL, cleaned up attr_accessor and switched to embed association macros
+* 2010-03-12 Thanks to weather (in ATL, cleaned up attr_accessor and switched to embed association macros
 * 2010-03-10 Slides are out of date, use key instead of attr_accessor with MongoDoc::Document (implementation was way too hackish)
 * 2010-02-23 API is *changing* significantly
 * 2010-01-23 Tracking MongoDoc with @git@? *READ THIS NOTE*[1]
 
 h2. Quick Start
 
-* install MongoDB (at least 1.3.2)
+* install MongoDB (at least 1.4.0)
 * install the Ruby driver @gem install mongo@
 * install MongoDoc @gem install mongo_doc@
 * run an example from this directory @ruby -Ilib examples/simple_object.rb@
@@ -135,10 +115,16 @@ bc. hashrocket_address.update_attributes(:street => '320 First Street North, #71
 
 h2. Installation
 
-MongoDoc *requires* mongoDB v1.3.2 or later.
+MongoDoc *requires* mongoDB v1.4.0 or later.
 
 bc. sudo gem install mongo_doc
 
+h2. Rails 3
+
+As of version 0.5.0, you can use the mongo_doc-rails gem to add Rails3 support.
+
+bc. sudo gem install mongo_doc-rails
+
 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"@.
@@ -186,6 +172,8 @@ h3. Thanks
 
 Thanks to Sandro and Durran for some great conversations and some lovely code.
 
+Thanks to Elliot for pushing me to get Rails 3 support
+
 h2. Note on Patches/Pull Requests
 
 * Fork the project.

data/Rakefile

@@ -10,12 +10,13 @@ begin
     gem.homepage = "http://github.com/leshill/mongodoc"
     gem.authors = ["Les Hill"]
     gem.add_dependency "activesupport", ">= 2.3.4"
-    gem.add_dependency "mongo", "= 0.19.1"
-    gem.add_dependency "mongo_ext", "= 0.19.1"
+    gem.add_dependency "mongo", "= 0.20.1"
+    gem.add_dependency "bson", "= 0.20.1"
+    gem.add_dependency "bson_ext", "= 0.20.1"
     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.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
@@ -106,15 +107,22 @@ 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
+    require 'perf/mongo_document'
+    benchmark("MongoDoc saving documents", MongoDocument.new)
+  end
+
+  desc 'Run benchmark for MongoDoc Object'
+  task 'mongo_object' do
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+    require 'perf/mongo_doc_object'
+    benchmark("MongoDoc saving objects", MongoDocObject.new)
   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
+    require 'perf/ruby_driver'
+    benchmark("Ruby driver saving hashes", RubyDriver.new)
   end
 end
 
@@ -122,14 +130,53 @@ 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
+    require 'perf/mongo_document'
+    profile("MongoDoc saving documents", MongoDocument.new)
+  end
+
+  desc 'Run profiler for MongoDoc Object'
+  task 'mongo_object' do
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+    require 'perf/mongo_doc_object'
+    profile("MongoDoc saving objects", MongoDocObject.new)
   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
+    require 'perf/ruby_driver'
+    profile("Ruby driver saving hashes", RubyDriver.new)
+  end
+
+  def benchmark(what, runner)
+    puts "Benchmark: " + what
+
+    runner.generate(10000)
+
+    Benchmark.bm do |bm|
+      bm.report(what + " writes") do
+        runner.writes(10000)
+      end
+    end
+
+    Benchmark.bm do |bm|
+      bm.report(what + " reads") do
+        runner.reads(10000)
+      end
+    end
+  end
+
+  def profile(what, runner)
+    puts "Profiling: " + what
+    RubyProf.start
+
+    runner.generate(1000)
+    runner.writes(1000)
+    runner.reads(1000)
+
+    result = RubyProf.stop
+    printer = RubyProf::FlatPrinter.new(result)
+    printer.print(STDOUT, 0)
   end
 end
+

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.5

data/features/embed_hash.feature

@@ -0,0 +1,16 @@
+Feature: Embed Hash
+
+  Background:
+    Given a class Event
+
+  Scenario: Creating a new document
+    Given an Event document named 'event' :
+      | Name                 | Venue                          | Date       |
+      | NoSQL Live           | John Hancock Conference Center | 2010-03-11 |
+    And an Address document named 'address' :
+      | Street                 | City               | State | Zip Code |
+      | 320 First Street North | Jacksonville Beach | FL    | 32250    |
+    And I put the 'address' object on key 'office' of the 'addresses' hash of 'event'
+    When I save the document 'event'
+    Then the last return value is true
+    And the document 'event' roundtrips

data/features/step_definitions/document_steps.rb

@@ -42,7 +42,7 @@ end
 
 Given /^I set the id on the document '(.*)' to (.*)$/ do |doc_name, value|
   doc = instance_variable_get("@#{doc_name}")
-  doc._id = Mongo::ObjectID.from_string("%024x" % value.to_i(16))
+  doc._id = BSON::ObjectID.from_string("%024x" % value.to_i(16))
 end
 
 Given /^'(.+)' has one (.+?) as (.+?) \(identified by '(.+)'\):$/ do |doc_name, class_name, assoc_name, var_name, table|

data/features/step_definitions/documents.rb

@@ -35,4 +35,6 @@ class Event
   attr_accessor :name
   attr_accessor :venue
   attr_accessor :date, :type => Date
+
+  embed_hash :addresses
 end

data/features/step_definitions/embed_hash_steps.rb

@@ -0,0 +1,6 @@
+Given /^I put the '(\w+)' object on key '(\w+)' of the '(\w+)' hash of '(\w+)'$/ do |value_name, key, assoc, doc_name|
+  value = instance_variable_get("@#{value_name}")
+  doc = instance_variable_get("@#{doc_name}")
+  doc.send(assoc)[key] = value
+end
+

data/features/step_definitions/string_casting_steps.rb

@@ -14,7 +14,8 @@ def all=(value)
   @all = value
 end
 
-Given /^a class Event$/ do
+Given /^a class (.+)$/ do |type_name|
+  type_name.constantize.should be_kind_of(Class)
 end
 
 Given /^I create an (.+) '(.+)' with:$/ do |klass_name, object_name, table|

data/features/support/support.rb

@@ -3,6 +3,7 @@ require 'cucumber'
 require 'spec/expectations'
 require 'spec/bson_matchers'
 require 'mongo_doc'
+require 'active_support/json'
 
 MongoDoc::Connection.env = 'cucumber'
 MongoDoc::Connection.config_path = './features/mongodb.yml'

data/lib/mongo_doc/associations/collection_proxy.rb

@@ -24,16 +24,34 @@ module MongoDoc
 
       attr_reader :collection
 
-      def _root=(root)
-        @_root = root
+      def _modifier_path=(path)
+        super
         collection.each do |item|
-          item._root = root if is_document?(item)
+          item._modifier_path = _modifier_path + '.$' if ProxyBase.is_document?(item)
         end
       end
 
+      def _root=(value)
+        @_root = value
+        collection.each do |item|
+          item._root = value if ProxyBase.is_document?(item)
+        end
+      end
+
+      %w(_root _selector_path).each do |setter|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{setter}=(val)
+            super
+            collection.each do |item|
+              item.#{setter} = #{setter} if ProxyBase.is_document?(item)
+            end
+          end
+        RUBY
+      end
+
       def initialize(options)
-        super
         @collection = []
+        super
       end
 
       alias _append <<
@@ -52,7 +70,7 @@ module MongoDoc
       alias insert []=
 
       def build(attrs)
-        item = assoc_class.new(attrs)
+        item = _assoc_class.new(attrs)
         push(item)
       end
 
@@ -82,7 +100,7 @@ module MongoDoc
 
       def valid?
         all? do |child|
-          if is_document?(child)
+          if ProxyBase.is_document?(child)
             child.valid?
           else
             true
@@ -92,13 +110,11 @@ module MongoDoc
 
       protected
 
-      def annotated_keys(src, attrs, selector = false)
-        assoc_path = "#{assoc_name}" + (selector ? "" : ".$")
-        annotated = {}
-        attrs.each do |(key, value)|
-          annotated["#{assoc_path}.#{key}"] = value
-        end
-        annotated
+      def attach_document(doc)
+        doc._modifier_path = _modifier_path + '.$'
+        doc._selector_path = _selector_path
+        doc._root = _root
+        _root.send(:register_save_observer, doc)
       end
     end
   end

data/lib/mongo_doc/associations/document_proxy.rb

@@ -7,9 +7,18 @@ module MongoDoc
 
       delegate :to_bson, :id, :to => :document
 
-      def _root=(root)
-        @_root = root
-        document._root = root if is_document?(document)
+      %w(_modifier_path _selector_path).each do |setter|
+        class_eval(<<-RUBY, __FILE__, __LINE__)
+          def #{setter}=(path)
+            super
+            document.#{setter} = #{setter} if ProxyBase.is_document?(document)
+          end
+        RUBY
+      end
+
+      def _root=(value)
+        @_root = value
+        document._root = value if ProxyBase.is_document?(document)
       end
 
       def ==(other)
@@ -21,7 +30,7 @@ module MongoDoc
       end
 
       def build(attrs)
-        item = assoc_class.new(attrs)
+        item = _assoc_class.new(attrs)
         self.document = item
       end
 
@@ -31,7 +40,7 @@ module MongoDoc
       end
 
       def valid?
-        if is_document?(document)
+        if ProxyBase.is_document?(document)
           document.valid?
         else
           true

data/lib/mongo_doc/associations/hash_proxy.rb

@@ -21,28 +21,31 @@ module MongoDoc
 
       attr_reader :hash
 
-      def _root=(root)
-        @_root = root
-        hash.each do |key, value|
-          value._root = root if is_document?(value)
-        end
+      %w(_modifier_path _selector_path).each do |setter|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{setter}=(path)
+            super
+            hash.each do |key, doc|
+              doc.#{setter} = #{setter} + '.' + key.to_s if ProxyBase.is_document?(doc)
+            end
+          end
+        RUBY
       end
 
       def initialize(options)
-        super
         @hash = {}
+        super
       end
 
       alias put []=
       def []=(key, value)
         raise InvalidEmbeddedHashKey.new("Key name [#{key}] must be a valid element name, see http://www.mongodb.org/display/DOCS/BSON#BSON-noteonelementname") unless valid_key?(key)
-        attach(value)
-        put(key, value)
+        put(key, attach(key, value))
       end
       alias store []=
 
       def build(key, attrs)
-        item = assoc_class.new(attrs)
+        item = _assoc_class.new(attrs)
         store(key, item)
       end
 
@@ -71,7 +74,7 @@ module MongoDoc
 
       def valid?
         values.all? do |child|
-          if is_document?(child)
+          if ProxyBase.is_document?(child)
             child.valid?
           else
             true
@@ -81,13 +84,14 @@ module MongoDoc
 
       protected
 
-      def annotated_keys(src, attrs, selector = false)
-        assoc_path = "#{assoc_name}.#{index(src)}"
-        annotated = {}
-        attrs.each do |(key, value)|
-          annotated["#{assoc_path}.#{key}"] = value
+      def attach(key, value)
+        if ProxyBase.is_document?(value)
+          proxy = DocumentProxy.new(:path => _selector_path, :assoc_name => key, :root => _root, :parent => self)
+          proxy.document = value
+          proxy
+        else
+          value
         end
-        annotated
       end
 
       def valid_key?(key)

data/lib/mongo_doc/associations/proxy_base.rb

@@ -3,16 +3,16 @@ module MongoDoc
     module ProxyBase
       def self.included(klass)
         klass.class_eval do
-          attr_reader :assoc_name, :assoc_class, :_parent, :_root
+          attr_reader :_assoc_class, :_assoc_name, :_modifier_path, :_root, :_selector_path
         end
       end
 
-      def _parent=(parent)
-        @_parent = parent
-      end
-
-      def _path_to_root(src, attrs, selector = false)
-        _parent._path_to_root(src, annotated_keys(src, attrs, selector), selector)
+      %w(_modifier_path _selector_path).each do |setter|
+        module_eval(<<-RUBY, __FILE__, __LINE__)
+          def #{setter}=(path)
+            @#{setter} = (path.blank? ? '' : path + '.') + _assoc_name.to_s
+          end
+        RUBY
       end
 
       def _root=(root)
@@ -20,33 +20,28 @@ module MongoDoc
       end
 
       def initialize(options)
-        @assoc_name = options[:assoc_name]
-        @assoc_class = options[:assoc_class]
-        @_root = options[:root]
-        @_parent = options[:parent]
+        @_assoc_name = options[:assoc_name]
+        @_assoc_class = options[:assoc_class]
+        self._root = options[:root]
+        self._selector_path = self._modifier_path = options[:path]
       end
 
-      def attach(item)
-        if is_document?(item)
-          item._parent = self
-          item._root = _root
-          _root.send(:register_save_observer, item)
-        end
-        item
+      def self.is_document?(object)
+        object.respond_to?(:_root)
       end
 
       protected
 
-      def annotated_keys(src, hash, selector = false)
-        annotated = {}
-        hash.each do |(key, value)|
-          annotated["#{assoc_name}.#{key}"] = value
-        end
-        annotated
+      def attach(obj)
+        attach_document(obj) if ProxyBase.is_document?(obj)
+        obj
       end
 
-      def is_document?(object)
-        object.respond_to?(:_parent)
+      def attach_document(doc)
+        doc._modifier_path = _modifier_path
+        doc._selector_path = _selector_path
+        doc._root = _root
+        _root.send(:register_save_observer, doc)
       end
     end
   end

data/lib/mongo_doc/associations.rb

@@ -20,7 +20,10 @@ module MongoDoc
         define_method("#{name}=") do |value|
           association = instance_variable_get("@#{name}")
           unless association
-            association = Associations::DocumentProxy.new(:root => _root || self, :parent => self, :assoc_name => name, :assoc_class => assoc_class || self.class.class_from_name(name))
+            association = Associations::DocumentProxy.new(:path => _selector_path,
+                                                          :root => _root || self,
+                                                          :assoc_name => name,
+                                                          :assoc_class => assoc_class || self.class.class_from_name(name))
             instance_variable_set("@#{name}", association)
           end
           association.document = value
@@ -29,7 +32,7 @@ module MongoDoc
         validates_embedded name, :if => Proc.new { !send(name).nil? }
       end
     end
-    alias :has_one :embed
+    alias has_one embed
 
     def embed_many(*args)
       options = args.extract_options!
@@ -43,7 +46,10 @@ module MongoDoc
         define_method("#{name}") do
           association = instance_variable_get("@#{name}")
           unless association
-            association = Associations::CollectionProxy.new(:root => _root || self, :parent => self, :assoc_name => name, :assoc_class => assoc_class || self.class.class_from_name(name))
+            association = Associations::CollectionProxy.new(:path => _selector_path,
+                                                            :root => _root || self,
+                                                            :assoc_name => name,
+                                                            :assoc_class => assoc_class || self.class.class_from_name(name))
             instance_variable_set("@#{name}", association)
           end
           association
@@ -60,7 +66,7 @@ module MongoDoc
         end
       end
     end
-    alias :has_many :embed_many
+    alias has_many embed_many
 
     def embed_hash(*args)
       options = args.extract_options!
@@ -74,7 +80,10 @@ module MongoDoc
         define_method("#{name}") do
           association = instance_variable_get("@#{name}")
           unless association
-            association = Associations::HashProxy.new(:root => _root || self, :parent => self, :assoc_name => name, :assoc_class => assoc_class || self.class.class_from_name(name))
+            association = Associations::HashProxy.new(:path => _selector_path,
+                                                      :root => _root || self,
+                                                      :assoc_name => name,
+                                                      :assoc_class => assoc_class || self.class.class_from_name(name))
             instance_variable_set("@#{name}", association)
           end
           association
@@ -87,7 +96,7 @@ module MongoDoc
         end
       end
     end
-    alias :has_hash :embed_hash
+    alias has_hash embed_hash
 
     def class_from_name(name)
       type_name_with_module(name.to_s.classify).constantize rescue nil

data/lib/mongo_doc/attributes.rb

@@ -7,7 +7,6 @@ module MongoDoc
         class_inheritable_array :_associations
         self._associations = []
 
-        attr_accessor :_parent
         attr_accessor :_id
 
         extend ClassMethods
@@ -28,28 +27,11 @@ module MongoDoc
       end
     end
 
-    def _root
-      @_root
-    end
-
-    def _root=(root)
-      @_root = root
-      _associations.each do|a|
-        association = send(a)
-        association._root = root if association
-      end
-    end
-
-    def _path_to_root(src, attrs, selector = false)
-      return attrs unless _parent
-      _parent._path_to_root(self, attrs, selector)
-    end
-
     module ClassMethods
 
       def self.extended(klass)
         klass.class_eval do
-          metaclass.alias_method_chain :attr_accessor, :mongo
+          singleton_class.alias_method_chain :attr_accessor, :mongo
         end
       end
 
@@ -95,7 +77,7 @@ module MongoDoc
           end
         end
       end
-      alias :key :attr_accessor_with_mongo
+      alias key attr_accessor_with_mongo
 
     end
   end

data/lib/mongo_doc/collection.rb

@@ -50,7 +50,7 @@ module MongoDoc
     def insert(doc_or_docs, options = {})
       _collection.insert(doc_or_docs.to_bson, options)
     end
-    alias :<< :insert
+    alias << insert
 
     def save(doc, options = {})
       _collection.save(doc.to_bson, options)

data/lib/mongo_doc/connection.rb

@@ -82,7 +82,7 @@ module MongoDoc
     end
 
     def verify_server_version(connection)
-      raise UnsupportedServerVersionError.new('MongoDoc requires at least mongoDB version 1.3.2') unless connection.server_version >= "1.3.4"
+      raise UnsupportedServerVersionError.new('MongoDoc requires at least mongoDB version 1.4.0') unless connection.server_version >= "1.4.0"
     end
   end
 end

data/lib/mongo_doc/contexts/ids.rb

@@ -18,7 +18,7 @@ module Mongoid
 
       protected
 
-      # Convert ids from strings to +Mongo::ObjectID+s
+      # Convert ids from strings to +BSON::ObjectID+s
       def strings_to_object_ids(ids)
         if Array === ids
           ids.map {|id| string_to_object_id(id) }
@@ -28,10 +28,10 @@ module Mongoid
 
       end
 
-      # Convert ids from strings to +Mongo::ObjectID+s
+      # Convert ids from strings to +BSON::ObjectID+s
       def string_to_object_id(id)
         if String === id
-          ::Mongo::ObjectID.from_string(id)
+          ::BSON::ObjectID.from_string(id)
         else
           id
         end