mongo_doc 0.3.2 → 0.4.0

data/README.textile

@@ -1,7 +1,22 @@
 h1. MongoDoc
 
-Version: 0.3.2 2010/03/11
+Version: Turbulence (0.4.0) 2010/03/12
 
+h2. What's New in Turbulence (0.4.0)
+
+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@
+
+h2. Notes
+
+* 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]
@@ -55,9 +70,9 @@ 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
+bc.. in_fl = collection.where('addresses.state' => 'FL')
+in_fl_hashrocket = in_fl.where('name' => /rocket/)
+puts in_fl_hashrocket.first.addresses.first.phone_number
 
 p. Take a look in the examples directory for more code.
 
@@ -72,24 +87,24 @@ 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
+  attr_accessor :street
+  attr_accessor :city
+  attr_accessor :state
+  attr_accessor :zip_code
+  attr_accessor :phone_number
 end
 
 class Contact
   include MongoDoc::Document
 
-  key :name
-  key :interests
-  has_many :addresses
+  attr_accessor :name
+  attr_accessor :interests
+  embed_many :addresses
 
-  named_scope :in_state, lambda {|state| {:where => {'addresses.state' => state}}}
+  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.
+p. Since a mongoDB document has no fixed schema, we define the composition of a document directly in our classes. We can also specify associations using @embed@, @embed_many@, and @embed_hash@ (similar to ActiveRecord's @has_one@ and @has_many@.
 
 Building and saving a document is easy:
 
@@ -103,11 +118,12 @@ 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'}
+bc.. hashrocket_in_fl = Contact.in_state('FL').where(:name => /rocket/)
+hashrocket_address = hashrocket_in_fl.first.addresses.first
 
 p. And we can even perform partial updates:
 
-bc. hashrocket.addresses.first.update_attributes(:street => '320 First Street North, #712')
+bc. hashrocket_address.update_attributes(:street => '320 First Street North, #712')
 
 h2. Installation
 

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/examples/simple_document.rb

@@ -3,19 +3,19 @@ require 'mongo_doc'
 class Address
   include MongoDoc::Document
 
-  key :street
-  key :city
-  key :state
-  key :zip_code
-  key :phone_number
+  attr_accessor :street
+  attr_accessor :city
+  attr_accessor :state
+  attr_accessor :zip_code
+  attr_accessor :phone_number
 end
 
 class Contact
   include MongoDoc::Document
 
-  key :name
-  key :interests
-  has_many :addresses
+  attr_accessor :name
+  attr_accessor :interests
+  embed_many :addresses
 
   scope :in_state, lambda {|state| where('addresses.state' => state)}
 end
@@ -32,9 +32,9 @@ puts contact.to_param
 puts Contact.find_one(contact.to_param).addresses.first.street
 Contact.find(contact.to_param).each {|c| puts c.name}
 
-hashrocket = Contact.in_state('FL').find {|contact| contact.name == 'Hashrocket'}
+hashrocket_in_fl = Contact.in_state('FL').where(:name => /rocket/)
 
-hashrocket_address = hashrocket.addresses.first
+hashrocket_address = hashrocket_in_fl.first.addresses.first
 hashrocket_address.update_attributes(:street => '320 First Street North, #712')
 
 puts Contact.where(:name => 'Hashrocket').first.addresses.first.street

data/features/step_definitions/documents.rb

@@ -1,28 +1,28 @@
 class Address
   include MongoDoc::Document
 
-  key :street
-  key :city
-  key :state
-  key :zip_code
+  attr_accessor :street
+  attr_accessor :city
+  attr_accessor :state
+  attr_accessor :zip_code
 end
 
 class Place
   include MongoDoc::Document
 
-  key :name
-  key :type
-  has_one :address
+  attr_accessor :name
+  attr_accessor :type
+  embed :address
 end
 
 class Contact
   include MongoDoc::Document
 
-  key :name
-  key :type
-  key :note
-  key :interests
-  has_many :addresses
+  attr_accessor :name
+  attr_accessor :type
+  attr_accessor :note
+  attr_accessor :interests
+  embed_many :addresses
 
   scope :rubyists, any_in(:interests => ['ruby'])
   scope :contract_work, any_in(:interests => ['contract work'])
@@ -32,7 +32,7 @@ end
 class Event
   include MongoDoc::Document
 
-  key :name
-  key :venue
-  key :date, :type => Date
+  attr_accessor :name
+  attr_accessor :venue
+  attr_accessor :date, :type => Date
 end

data/lib/mongo_doc/associations.rb

@@ -0,0 +1,100 @@
+require 'mongo_doc/associations/proxy_base'
+require 'mongo_doc/associations/collection_proxy'
+require 'mongo_doc/associations/document_proxy'
+require 'mongo_doc/associations/hash_proxy'
+
+module MongoDoc
+  module Associations
+
+    def embed(*args)
+      options = args.extract_options!
+      assoc_class = if class_name = options.delete(:class_name)
+        self.class_from_name(class_name)
+      end
+
+      args.each do |name|
+        _associations << name unless _associations.include?(name)
+
+        attr_reader name
+
+        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))
+            instance_variable_set("@#{name}", association)
+          end
+          association.document = value
+        end
+
+        validates_embedded name, :if => Proc.new { !send(name).nil? }
+      end
+    end
+    alias :has_one :embed
+
+    def embed_many(*args)
+      options = args.extract_options!
+      assoc_class = if class_name = options.delete(:class_name)
+        self.class_from_name(class_name)
+      end
+
+      args.each do |name|
+        _associations << name unless _associations.include?(name)
+
+        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))
+            instance_variable_set("@#{name}", association)
+          end
+          association
+        end
+
+        validates_embedded name
+
+        define_method("#{name}=") do |arrayish|
+          proxy = send("#{name}")
+          proxy.clear
+          Array.wrap(arrayish).each do|item|
+            proxy << item
+          end
+        end
+      end
+    end
+    alias :has_many :embed_many
+
+    def embed_hash(*args)
+      options = args.extract_options!
+      assoc_class = if class_name = options.delete(:class_name)
+        self.class_from_name(class_name)
+      end
+
+      args.each do |name|
+        _associations << name unless _associations.include?(name)
+
+        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))
+            instance_variable_set("@#{name}", association)
+          end
+          association
+        end
+
+        validates_embedded name
+
+        define_method("#{name}=") do |hash|
+          send("#{name}").replace(hash)
+        end
+      end
+    end
+    alias :has_hash :embed_hash
+
+    def class_from_name(name)
+      type_name_with_module(name.to_s.classify).constantize rescue nil
+    end
+
+    def type_name_with_module(type_name)
+      (/^::/ =~ type_name) ? type_name : "#{parent}::#{type_name}"
+    end
+  end
+end

data/lib/mongo_doc/attributes.rb

@@ -1,8 +1,3 @@
-require 'mongo_doc/associations/proxy_base'
-require 'mongo_doc/associations/collection_proxy'
-require 'mongo_doc/associations/document_proxy'
-require 'mongo_doc/associations/hash_proxy'
-
 module MongoDoc
   module Attributes
     def self.included(klass)
@@ -51,33 +46,40 @@ module MongoDoc
     end
 
     module ClassMethods
+
+      def self.extended(klass)
+        klass.class_eval do
+          metaclass.alias_method_chain :attr_accessor, :mongo
+        end
+      end
+
       def _attributes
         _keys + _associations
       end
 
-      def key(*args)
+      def attr_accessor_with_mongo(*args)
         opts = args.extract_options!
         default = opts.delete(:default)
         type = opts.delete(:type)
         args.each do |name|
           _keys << name unless _keys.include?(name)
-          if default
-            attr_writer name
+          attr_writer name
 
-            define_method("_default_#{name}", default.kind_of?(Proc) ? default : Proc.new { default })
+          if default
+            define_method("_default_#{name}", default.kind_of?(Proc) ? default : proc { default })
             private "_default_#{name}"
 
             module_eval(<<-RUBY, __FILE__, __LINE__)
-              def #{name}
-                unless defined? @#{name}
-                  @#{name} = _default_#{name}
-                end
-                class << self; attr_reader :#{name} end
-                @#{name}
-              end
+              def #{name}                                # def birth_date
+                unless defined? @#{name}                 #   unless defined? @birth_date
+                  @#{name} = _default_#{name}            #     @birth_date = _default_birth_date
+                end                                      #   end
+                class << self; attr_reader :#{name} end  #   class << self; attr_reader :birth_date end
+                @#{name}                                 #   @birth_date
+              end                                        # end
             RUBY
           else
-            attr_accessor name
+            attr_reader name
           end
 
           if type and type.respond_to?(:cast_from_string)
@@ -93,94 +95,8 @@ module MongoDoc
           end
         end
       end
+      alias :key :attr_accessor_with_mongo
 
-      def has_one(*args)
-        options = args.extract_options!
-        assoc_class = if class_name = options.delete(:class_name)
-          self.class_from_name(class_name)
-        end
-
-        args.each do |name|
-          _associations << name unless _associations.include?(name)
-
-          attr_reader name
-
-          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))
-              instance_variable_set("@#{name}", association)
-            end
-            association.document = value
-          end
-
-          validates_embedded name, :if => Proc.new { !send(name).nil? }
-        end
-      end
-
-      def has_many(*args)
-        options = args.extract_options!
-        assoc_class = if class_name = options.delete(:class_name)
-          self.class_from_name(class_name)
-        end
-
-        args.each do |name|
-          _associations << name unless _associations.include?(name)
-
-          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))
-              instance_variable_set("@#{name}", association)
-            end
-            association
-          end
-
-          validates_embedded name
-
-          define_method("#{name}=") do |arrayish|
-            proxy = send("#{name}")
-            proxy.clear
-            Array.wrap(arrayish).each do|item|
-              proxy << item
-            end
-          end
-        end
-      end
-
-      def has_hash(*args)
-        options = args.extract_options!
-        assoc_class = if class_name = options.delete(:class_name)
-          self.class_from_name(class_name)
-        end
-
-        args.each do |name|
-          _associations << name unless _associations.include?(name)
-
-          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))
-              instance_variable_set("@#{name}", association)
-            end
-            association
-          end
-
-          validates_embedded name
-
-          define_method("#{name}=") do |hash|
-            send("#{name}").replace(hash)
-          end
-        end
-      end
-
-      def class_from_name(name)
-        type_name_with_module(name.to_s.classify).constantize rescue nil
-      end
-
-      def type_name_with_module(type_name)
-        (/^::/ =~ type_name) ? type_name : "#{parent}::#{type_name}"
-      end
     end
   end
 end

data/lib/mongo_doc/contexts/mongo.rb

@@ -40,7 +40,7 @@ module MongoDoc
       end
 
       # Determine if the context is empty or blank given the criteria. Will
-      # perform a quick has_one asking only for the id.
+      # perform a quick find_one asking only for the id.
       #
       # Example:
       #

data/lib/mongo_doc/contexts.rb

@@ -10,7 +10,7 @@ module Mongoid
     class UnknownContext < RuntimeError; end
 
     # Determines the context to be used for this criteria. If the class is an
-    # embedded document, then the context will be the array in the has_many
+    # embedded document, then the context will be the array in the embed_many
     # association it is in. If the class is a root, then the database itself
     # will be the context.
     #

data/lib/mongo_doc/document.rb

@@ -1,6 +1,7 @@
 require 'mongo_doc/bson'
 require 'mongo_doc/query'
 require 'mongo_doc/attributes'
+require 'mongo_doc/associations'
 require 'mongo_doc/criteria'
 require 'mongo_doc/finders'
 require 'mongo_doc/scope'
@@ -16,6 +17,7 @@ module MongoDoc
     def self.included(klass)
       klass.class_eval do
         include Attributes
+        extend Associations
         extend ClassMethods
         extend Criteria
         extend Finders

data/lib/mongo_doc.rb

@@ -4,7 +4,7 @@ require 'validatable'
 require 'will_paginate/collection'
 
 module MongoDoc
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end
 
 require 'mongo_doc/connection'

data/mongo_doc.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongo_doc}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Les Hill"]
-  s.date = %q{2010-03-11}
+  s.date = %q{2010-03-13}
   s.description = %q{ODM for MongoDB}
   s.email = %q{leshill@gmail.com}
   s.extra_rdoc_files = [
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
      "features/support/support.rb",
      "features/using_criteria.feature",
      "lib/mongo_doc.rb",
+     "lib/mongo_doc/associations.rb",
      "lib/mongo_doc/associations/collection_proxy.rb",
      "lib/mongo_doc/associations/document_proxy.rb",
      "lib/mongo_doc/associations/hash_proxy.rb",
@@ -119,6 +120,7 @@ Gem::Specification.new do |s|
      "spec/associations/collection_proxy_spec.rb",
      "spec/associations/document_proxy_spec.rb",
      "spec/associations/hash_proxy_spec.rb",
+     "spec/associations_spec.rb",
      "spec/attributes_accessor_spec.rb",
      "spec/attributes_spec.rb",
      "spec/bson_matchers.rb",
@@ -155,6 +157,7 @@ Gem::Specification.new do |s|
     "spec/associations/collection_proxy_spec.rb",
      "spec/associations/document_proxy_spec.rb",
      "spec/associations/hash_proxy_spec.rb",
+     "spec/associations_spec.rb",
      "spec/attributes_accessor_spec.rb",
      "spec/attributes_spec.rb",
      "spec/bson_matchers.rb",

data/spec/associations/collection_proxy_spec.rb

@@ -4,11 +4,11 @@ describe MongoDoc::Associations::CollectionProxy do
   class CollectionProxyTest
     include MongoDoc::Document
 
-    key :name
+    attr_accessor :name
   end
 
   let(:root) { stub('root', :register_save_observer => nil) }
-  let(:proxy) { MongoDoc::Associations::CollectionProxy.new(:assoc_name => 'has_many_name', :assoc_class => CollectionProxyTest, :root => root, :parent => root) }
+  let(:proxy) { MongoDoc::Associations::CollectionProxy.new(:assoc_name => 'embed_many_name', :assoc_class => CollectionProxyTest, :root => root, :parent => root) }
   let(:item) { CollectionProxyTest.new }
 
   context "#<<" do

data/spec/associations/hash_proxy_spec.rb

@@ -4,11 +4,11 @@ describe MongoDoc::Associations::HashProxy do
   class HashProxyTest
     include MongoDoc::Document
 
-    key :name
+    attr_accessor :name
   end
 
   let(:root) { stub('root', :register_save_observer => nil) }
-  let(:proxy) { MongoDoc::Associations::HashProxy.new(:assoc_name => 'has_many_name', :assoc_class => HashProxyTest, :root => root, :parent => root) }
+  let(:proxy) { MongoDoc::Associations::HashProxy.new(:assoc_name => 'embed_hash_name', :assoc_class => HashProxyTest, :root => root, :parent => root) }
   let(:item) { HashProxyTest.new }
   let(:other_item) {[1,2]}