jnunemaker-mongomapper 0.3.1 → 0.3.2

data/History

@@ -1,3 +1,14 @@
+0.3.2 8/6/2009
+  * Added many polymorphic documents association
+  * Implemented build and create for many and many polymorphic documents
+  * <<, push and concat now work correctly for many and many polymorphic documents
+  * find(:first) now accepts order option
+  * id is now included by default with to_json
+  * _id is now always excluded from to_json
+  * Times are now always returned as UTC
+  * Default values are now a bit more intelligent for Array and Hash keys (djsun)
+  * Embedded documents now have _id as well so they can be identified more easily
+  
 0.3.1 7/28/2009
 * 1 minor tweak
   * Removed deep_merge gem as dependency as ActiveSupport has deep_merge that works good enough

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/mongomapper/associations/base.rb

@@ -56,8 +56,11 @@ module MongoMapper
       def proxy_class
         @proxy_class ||= begin
           if many?
-            return ManyProxy unless self.klass.embeddable?            
-            polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
+            if self.klass.embeddable?
+              polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
+            else
+              polymorphic? ? ManyPolymorphicProxy : ManyProxy
+            end
           else
             polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy
           end

data/lib/mongomapper/associations/belongs_to_polymorphic_proxy.rb

@@ -9,8 +9,7 @@ module MongoMapper
         
         @owner.send("#{@association.belongs_to_key_name}=", id)
         @owner.send("#{@association.type_key_name}=", type)
-        
-        reload_target
+        reset
       end
       
       protected

data/lib/mongomapper/associations/belongs_to_proxy.rb

@@ -8,13 +8,13 @@ module MongoMapper
         end
         
         @owner.send("#{@association.belongs_to_key_name}=", id)
-        reload_target
+        reset
       end
 
       protected
         def find_target
-          if ref = @owner.send(@association.belongs_to_key_name)
-            @association.klass.find(ref)
+          if association_id = @owner.send(@association.belongs_to_key_name)
+            @association.klass.find(association_id)
           end
         end
     end

data/lib/mongomapper/associations/many_documents_proxy.rb

@@ -0,0 +1,85 @@
+module MongoMapper
+  module Associations
+    class ManyDocumentsProxy < Proxy
+      delegate :klass, :to => :@association
+      
+      def find(*args)
+        options = args.extract_options!
+        klass.find(*args << scoped_options(options))
+      end
+      
+      def paginate(options)
+        klass.paginate(scoped_options(options))
+      end
+      
+      def all(options={})
+        find(:all, scoped_options(options))
+      end
+      
+      def first(options={})
+        find(:first, scoped_options(options))
+      end
+      
+      def last(options={})
+        find(:last, scoped_options(options))
+      end
+      
+      def count(conditions={})
+        klass.count(conditions.deep_merge(scoped_conditions))
+      end
+      
+      def replace(docs)
+        @target.map(&:destroy) if load_target
+        docs.each { |doc| apply_scope(doc).save }
+        reset
+      end
+      
+      def <<(*docs)
+        ensure_owner_saved
+        flatten_deeper(docs).each { |doc| apply_scope(doc).save }
+        reset
+      end
+      alias_method :push, :<<
+      alias_method :concat, :<<
+      
+      def build(attrs={})
+        doc = klass.new(attrs)
+        apply_scope(doc)
+        doc
+      end
+      
+      def create(attrs={})
+        doc = klass.new(attrs)
+        apply_scope(doc).save
+        doc
+      end
+      
+      protected
+        def scoped_conditions
+          {self.foreign_key => @owner.id}
+        end
+        
+        def scoped_options(options)
+          options.deep_merge({:conditions => scoped_conditions})
+        end
+        
+        def find_target
+          find(:all)
+        end
+        
+        def ensure_owner_saved
+          @owner.save if @owner.new?
+        end
+        
+        def apply_scope(doc)
+          ensure_owner_saved
+          doc.send("#{self.foreign_key}=", @owner.id)
+          doc
+        end
+
+        def foreign_key
+          @association.options[:foreign_key] || @owner.class.name.underscore.gsub("/", "_") + "_id"
+        end
+    end
+  end
+end

data/lib/mongomapper/associations/many_embedded_polymorphic_proxy.rb

@@ -1,6 +1,6 @@
 module MongoMapper
   module Associations
-    class ManyEmbeddedPolymorphicProxy < ArrayProxy      
+    class ManyEmbeddedPolymorphicProxy < Proxy      
       def replace(v)
         @_values = v.map do |doc_or_hash|
           if doc_or_hash.kind_of?(EmbeddedDocument)
@@ -11,8 +11,7 @@ module MongoMapper
           end
         end
         
-        @target = nil
-        reload_target
+        reset
       end
 
       protected

data/lib/mongomapper/associations/many_embedded_proxy.rb

@@ -1,11 +1,9 @@
 module MongoMapper
   module Associations
-    class ManyEmbeddedProxy < ArrayProxy
+    class ManyEmbeddedProxy < Proxy
       def replace(v)
         @_values = v.map { |e| e.kind_of?(EmbeddedDocument) ? e.attributes : e }
-        @target = nil
-
-        reload_target
+        reset
       end
 
       protected

data/lib/mongomapper/associations/many_polymorphic_proxy.rb

@@ -0,0 +1,11 @@
+module MongoMapper
+  module Associations
+    class ManyPolymorphicProxy < ManyDocumentsProxy      
+      private
+        def apply_scope(doc)
+          doc.send("#{@association.type_key_name}=", doc.class.name)
+          super
+        end
+    end
+  end
+end

data/lib/mongomapper/associations/many_proxy.rb

@@ -1,55 +1,6 @@
 module MongoMapper
   module Associations
-    class ManyProxy < ArrayProxy
-      delegate :klass, :to => :@association
-      
-      def find(*args)
-        options = args.extract_options!
-        klass.find(*args << scoped_options(options))
-      end
-      
-      def paginate(options)
-        klass.paginate(scoped_options(options))
-      end
-      
-      def all(options={})
-        find(:all, scoped_options(options))
-      end
-      
-      def first(options={})
-        find(:first, scoped_options(options))
-      end
-      
-      def last(options={})
-        find(:last, scoped_options(options))
-      end
-      
-      def replace(docs)
-        if load_target
-          @target.map(&:destroy)
-        end
-
-        docs.each do |doc|
-          @owner.save if @owner.new?
-          doc.send(:write_attribute, self.foreign_key, @owner.id)
-          doc.save
-        end
-        
-        reload_target
-      end
-
-      protected
-        def scoped_options(options)
-          options.dup.deep_merge({:conditions => {self.foreign_key => @owner.id}})
-        end
-        
-        def find_target
-          find(:all)
-        end
-
-        def foreign_key
-          @association.options[:foreign_key] || @owner.class.name.underscore.gsub("/", "_") + "_id"
-        end
+    class ManyProxy < ManyDocumentsProxy
     end
   end
 end

data/lib/mongomapper/associations/proxy.rb

@@ -8,7 +8,7 @@ module MongoMapper
       end
 
       def initialize(owner, association)
-        @owner= owner
+        @owner = owner
         @association = association
         reset
       end

data/lib/mongomapper/document.rb

@@ -12,7 +12,6 @@ module MongoMapper
         include RailsCompatibility::Document
         extend ClassMethods
         
-        key :_id, MongoID
         key :created_at, Time
         key :updated_at, Time
       end
@@ -162,7 +161,8 @@ module MongoMapper
       end
       
       def find_first(options)
-        find_every(options.merge(:limit => 1, :order => '$natural asc'))[0]
+        options.merge!(:limit => 1)
+        find_every({:order => '$natural asc'}.merge(options))[0]
       end
       
       def find_last(options)
@@ -247,14 +247,6 @@ module MongoMapper
         freeze
       end
       
-      def ==(other)
-        other.is_a?(self.class) && id == other.id
-      end
-      
-      def id
-        read_attribute('_id').to_s
-      end
-      
     private
       def create_or_update
         result = new? ? create : update
@@ -277,8 +269,9 @@ module MongoMapper
       end
       
       def update_timestamps
-        write_attribute('created_at', Time.now.utc) if new?
-        write_attribute('updated_at', Time.now.utc)
+        now = Time.now.utc
+        write_attribute('created_at', now) if new?
+        write_attribute('updated_at', now)
       end
     end
   end # Document

data/lib/mongomapper/embedded_document.rb

@@ -13,11 +13,17 @@ module MongoMapper
         include RailsCompatibility::EmbeddedDocument
         include Validatable
         include Serialization
+        
+        key :_id, MongoID
       end
     end
     
     module ClassMethods
       def inherited(subclass)
+        unless subclass.embeddable?
+          subclass.collection(self.collection.name)
+        end
+        
         (@subclasses ||= []) << subclass
       end
       
@@ -141,6 +147,10 @@ module MongoMapper
           
           self.attributes = attrs
         end
+        
+        if self.class.embeddable? && read_attribute(:_id).blank?
+          write_attribute :_id, XGen::Mongo::Driver::ObjectID.new
+        end
       end
       
       def attributes=(attrs)
@@ -170,7 +180,15 @@ module MongoMapper
       end
       
       def ==(other)
-        other.is_a?(self.class) && attributes == other.attributes
+        other.is_a?(self.class) && id == other.id
+      end
+      
+      def id
+        self._id.to_s
+      end
+      
+      def id=(value)
+        self._id = value
       end
       
       def inspect
@@ -191,7 +209,8 @@ module MongoMapper
         end
       
         def read_attribute(name)
-          self.class.keys[name].get(instance_variable_get("@#{name}"))
+          value = self.class.keys[name].get(instance_variable_get("@#{name}"))
+          instance_variable_set "@#{name}", value
         end
       
         def read_attribute_before_typecast(name)

data/lib/mongomapper/key.rb

@@ -41,12 +41,13 @@ module MongoMapper
     private
       def typecast(value)
         return HashWithIndifferentAccess.new(value) if value.is_a?(Hash) && type == Hash
+        return value.utc if type == Time && value.kind_of?(type)
         return value if value.kind_of?(type) || value.nil?
         begin
           if    type == String    then value.to_s
           elsif type == Float     then value.to_f
           elsif type == Array     then value.to_a
-          elsif type == Time      then Time.parse(value.to_s)
+          elsif type == Time      then Time.parse(value.to_s).utc
           elsif type == MongoID   then MongoID.mm_typecast(value)
           #elsif type == Date      then Date.parse(value.to_s)
           elsif type == Boolean   then Boolean.mm_typecast(value)

data/lib/mongomapper/serializers/json_serializer.rb

@@ -50,6 +50,8 @@ module MongoMapper #:nodoc:
     #         "created_at": "2006/08/01", "awesome": true,
     #         "permalink": "1-konata-izumi"}
     def to_json(options = {})
+      apply_to_json_defaults(options)
+      
       if include_root_in_json
         "{#{self.class.json_class_name}: #{JsonSerializer.new(self, options).to_s}}"
       else
@@ -73,5 +75,18 @@ module MongoMapper #:nodoc:
         @json_class_name ||= name.demodulize.underscore.inspect
       end
     end
+    
+    private
+      def apply_to_json_defaults(options)
+        unless options[:only]
+          methods = [options.delete(:methods)].flatten.compact
+          methods << :id
+          options[:methods] = methods.uniq
+        end
+
+        except = [options.delete(:except)].flatten.compact
+        except << :_id
+        options[:except] = except
+      end
   end
 end

data/lib/mongomapper.rb

@@ -29,7 +29,7 @@ class MongoID < XGen::Mongo::Driver::ObjectID
       end
     rescue => exception
       if exception.message == 'illegal ObjectID format'
-        raise MongoMapper::DocumentNotFound
+        raise MongoMapper::IllegalID
       else
         raise exception
       end
@@ -40,31 +40,38 @@ end
 dir = Pathname(__FILE__).dirname.expand_path + 'mongomapper'
 
 require dir + 'associations'
-require dir + 'associations/proxy'
-require dir + 'associations/array_proxy'
 require dir + 'associations/base'
+
+require dir + 'associations/proxy'
+require dir + 'associations/many_documents_proxy'
+
+require dir + 'associations/belongs_to_proxy'
+require dir + 'associations/belongs_to_polymorphic_proxy'
 require dir + 'associations/many_proxy'
+require dir + 'associations/many_polymorphic_proxy'
 require dir + 'associations/many_embedded_proxy'
 require dir + 'associations/many_embedded_polymorphic_proxy'
-require dir + 'associations/belongs_to_proxy'
-require dir + 'associations/belongs_to_polymorphic_proxy'
+
 require dir + 'callbacks'
 require dir + 'finder_options'
 require dir + 'key'
 require dir + 'observing'
 require dir + 'pagination'
-require dir + 'rails_compatibility/document'
-require dir + 'rails_compatibility/embedded_document'
 require dir + 'save_with_validation'
 require dir + 'serialization'
 require dir + 'validations'
 
+require dir + 'rails_compatibility/document'
+require dir + 'rails_compatibility/embedded_document'
+
 require dir + 'embedded_document'
 require dir + 'document'
 
-module MongoMapper  
-  class DocumentNotFound < StandardError; end
-  class DocumentNotValid < StandardError
+module MongoMapper
+  DocumentNotFound = Class.new(StandardError)
+  IllegalID        = Class.new(StandardError)
+  
+  DocumentNotValid = Class.new(StandardError) do
     def initialize(document)
       @document = document
       super("Validation failed: #{@document.errors.full_messages.join(", ")}")

data/mongomapper.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongomapper}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2009-07-28}
+  s.date = %q{2009-08-06}
   s.default_executable = %q{mmconsole}
   s.email = %q{nunemaker@gmail.com}
   s.executables = ["mmconsole"]
@@ -24,12 +24,13 @@ Gem::Specification.new do |s|
      "bin/mmconsole",
      "lib/mongomapper.rb",
      "lib/mongomapper/associations.rb",
-     "lib/mongomapper/associations/array_proxy.rb",
      "lib/mongomapper/associations/base.rb",
      "lib/mongomapper/associations/belongs_to_polymorphic_proxy.rb",
      "lib/mongomapper/associations/belongs_to_proxy.rb",
+     "lib/mongomapper/associations/many_documents_proxy.rb",
      "lib/mongomapper/associations/many_embedded_polymorphic_proxy.rb",
      "lib/mongomapper/associations/many_embedded_proxy.rb",
+     "lib/mongomapper/associations/many_polymorphic_proxy.rb",
      "lib/mongomapper/associations/many_proxy.rb",
      "lib/mongomapper/associations/proxy.rb",
      "lib/mongomapper/callbacks.rb",
@@ -47,6 +48,12 @@ Gem::Specification.new do |s|
      "lib/mongomapper/validations.rb",
      "mongomapper.gemspec",
      "test/NOTE_ON_TESTING",
+     "test/functional/associations/test_belongs_to_polymorphic_proxy.rb",
+     "test/functional/associations/test_belongs_to_proxy.rb",
+     "test/functional/associations/test_many_embedded_polymorphic_proxy.rb",
+     "test/functional/associations/test_many_embedded_proxy.rb",
+     "test/functional/associations/test_many_polymorphic_proxy.rb",
+     "test/functional/associations/test_many_proxy.rb",
      "test/functional/test_associations.rb",
      "test/functional/test_callbacks.rb",
      "test/functional/test_document.rb",
@@ -77,7 +84,13 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Awesome gem for modeling your domain and storing it in mongo}
   s.test_files = [
-    "test/functional/test_associations.rb",
+    "test/functional/associations/test_belongs_to_polymorphic_proxy.rb",
+     "test/functional/associations/test_belongs_to_proxy.rb",
+     "test/functional/associations/test_many_embedded_polymorphic_proxy.rb",
+     "test/functional/associations/test_many_embedded_proxy.rb",
+     "test/functional/associations/test_many_polymorphic_proxy.rb",
+     "test/functional/associations/test_many_proxy.rb",
+     "test/functional/test_associations.rb",
      "test/functional/test_callbacks.rb",
      "test/functional/test_document.rb",
      "test/functional/test_pagination.rb",

data/test/functional/associations/test_belongs_to_polymorphic_proxy.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'models'
+
+class BelongsToPolymorphicProxyTest < Test::Unit::TestCase
+  def setup
+    clear_all_collections
+  end
+  
+  should "default to nil" do
+    status = Status.new
+    status.target.should be_nil
+  end
+
+  should "be able to replace the association" do
+    status = Status.new
+    project = Project.new(:name => "mongomapper")
+    status.target = project
+    status.save.should be_true
+
+    from_db = Status.find(status.id)
+    from_db.target.should_not be_nil
+    from_db.target_id.should == project.id
+    from_db.target_type.should == "Project"
+    from_db.target.name.should == "mongomapper"
+  end
+
+  should "unset the association" do
+    status = Status.new
+    project = Project.new(:name => "mongomapper")
+    status.target = project
+    status.save.should be_true
+
+    from_db = Status.find(status.id)
+    from_db.target = nil
+    from_db.target_type.should be_nil
+    from_db.target_id.should be_nil
+    from_db.target.should be_nil
+  end
+end

data/test/functional/associations/test_belongs_to_proxy.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'models'
+
+class BelongsToProxyTest < Test::Unit::TestCase
+  def setup
+    clear_all_collections
+  end
+  
+  should "default to nil" do
+    status = Status.new
+    status.project.should be_nil
+  end
+  
+  should "be able to replace the association" do
+    status = Status.new
+    project = Project.new(:name => "mongomapper")
+    status.project = project
+    status.save.should be_true
+    
+    from_db = Status.find(status.id)
+    from_db.project.should_not be_nil
+    from_db.project.name.should == "mongomapper"
+  end
+  
+  should "unset the association" do
+    status = Status.new
+    project = Project.new(:name => "mongomapper")
+    status.project = project
+    status.save.should be_true
+    
+    from_db = Status.find(status.id)
+    from_db.project = nil
+    from_db.project.should be_nil
+  end
+end