jnunemaker-mongomapper 0.3.3 → 0.3.4

data/History

@@ -1,3 +1,9 @@
+0.3.4 8/28/2009
+  * BACKWORDS COMPATIBILITY BREAK: Timestamps are now optional. To use them add timestamps! to your model.
+  * BACKWORDS COMPATIBILITY BREAK: Associations keys are no longer created automatically when you use belongs_to and many. Too much was hidden from the developer. You now have to declare them like key :creator_id, String and such.
+  * to_json now includes dynamic keys and embedded stuff by default
+  * added polymorphic many with :as option (dcu)
+  
 0.3.3 8/16/2009
   * BACKWORDS COMPATIBILITY BREAK: _id is now once again a string rather than an object id and will stay that way.
   * Custom id's can now be used because of the change to string id's

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/mongomapper.rb

@@ -25,6 +25,7 @@ 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/many_documents_as_proxy'
 
 require dir + 'callbacks'
 require dir + 'finder_options'
@@ -43,14 +44,15 @@ require dir + 'embedded_document'
 require dir + 'document'
 
 module MongoMapper
-  DocumentNotFound = Class.new(StandardError)
-  DocumentNotValid = Class.new(StandardError) do
+  DocumentNotFound  = Class.new(StandardError)
+  
+  DocumentNotValid  = Class.new(StandardError) do
     def initialize(document)
       @document = document
       super("Validation failed: #{@document.errors.full_messages.join(", ")}")
     end
   end
-
+  
   def self.connection
     @@connection ||= XGen::Mongo::Driver::Mongo.new
   end

data/lib/mongomapper/associations.rb

@@ -20,7 +20,6 @@ module MongoMapper
           association = Associations::Base.new(type, name, options)
           associations[association.name] = association
           define_association_methods(association)
-          define_association_keys(association)
           define_dependent_callback(association)
           association
         end
@@ -36,17 +35,6 @@ module MongoMapper
           end
         end
 
-        def define_association_keys(association)
-          if association.belongs_to?
-            key(association.belongs_to_key_name, String)
-            key(association.type_key_name, String) if association.polymorphic?
-          end
-
-          if association.many? && association.polymorphic?
-            association.klass.send(:key, association.type_key_name, String)
-          end
-        end
-
         def define_dependent_callback(association)
           if association.options[:dependent]
             if association.many?

data/lib/mongomapper/associations/base.rb

@@ -4,11 +4,9 @@ module MongoMapper
       attr_reader :type, :name, :options
 
       def initialize(type, name, options = {})
-        @options = options
-        @type = type
-        @name = name
+        @type, @name, @options = type, name, options
       end
-      
+
       def class_name
         @class_name ||= begin
           if cn = options[:class_name]
@@ -20,35 +18,43 @@ module MongoMapper
           end
         end
       end
-      
+
       def klass
         @klass ||= class_name.constantize
       end
-      
+
       def many?
         @many_type ||= @type == :many
       end
-      
+
       def belongs_to?
         @belongs_to_type ||= @type == :belongs_to
       end
-      
+
       def polymorphic?
         !!@options[:polymorphic]
       end
-      
+
+      def as?
+        !!@options[:as]
+      end
+
       def type_key_name
-        @type_key_name ||= many? ? '_type' : "#{name}_type"
+        @type_key_name ||= many? ? '_type' : "#{as}_type"
+      end
+
+      def as
+        @options[:as] || self.name
       end
-      
-      def belongs_to_key_name
-        "#{name}_id"
+
+      def foreign_key
+        @options[:foreign_key] || "#{name}_id"
       end
-      
+
       def ivar
         @ivar ||= "@_#{name}"
       end
-      
+
       def embeddable?
         many? && klass.embeddable?
       end
@@ -59,7 +65,13 @@ module MongoMapper
             if self.klass.embeddable?
               polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
             else
-              polymorphic? ? ManyPolymorphicProxy : ManyProxy
+              if polymorphic?
+                ManyPolymorphicProxy
+              elsif as?
+                ManyDocumentsAsProxy
+              else
+                ManyProxy
+              end
             end
           else
             polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy

data/lib/mongomapper/associations/belongs_to_polymorphic_proxy.rb

@@ -7,7 +7,7 @@ module MongoMapper
           id, type = doc.id, doc.class.name
         end
         
-        @owner.send("#{@association.belongs_to_key_name}=", id)
+        @owner.send("#{@association.foreign_key}=", id)
         @owner.send("#{@association.type_key_name}=", type)
         reset
       end
@@ -20,7 +20,7 @@ module MongoMapper
         end
         
         def proxy_id
-          @proxy_id ||= @owner.send(@association.belongs_to_key_name)
+          @proxy_id ||= @owner.send(@association.foreign_key)
         end
         
         def proxy_class

data/lib/mongomapper/associations/belongs_to_proxy.rb

@@ -7,13 +7,13 @@ module MongoMapper
           id = doc.id
         end
 
-        @owner.send("#{@association.belongs_to_key_name}=", id)
+        @owner.send("#{@association.foreign_key}=", id)
         reset
       end
 
       protected
         def find_target
-          if association_id = @owner.send(@association.belongs_to_key_name)
+          if association_id = @owner.send(@association.foreign_key)
             @association.klass.find_by_id(association_id)
           end
         end

data/lib/mongomapper/associations/many_documents_as_proxy.rb

@@ -0,0 +1,27 @@
+module MongoMapper
+  module Associations
+    class ManyDocumentsAsProxy < ManyDocumentsProxy
+      protected
+        def scoped_conditions
+          {as_type_name => @owner.class.name, as_id_name => @owner.id}
+        end
+
+        def apply_scope(doc)
+          ensure_owner_saved
+
+          doc.send("#{as_type_name}=", @owner.class.name)
+          doc.send("#{as_id_name}=", @owner.id)
+
+          doc
+        end
+
+        def as_type_name
+          @as_type_name ||= @association.options[:as].to_s + "_type"
+        end
+
+        def as_id_name
+          @as_id_name ||= @association.options[:as].to_s + "_id"
+        end
+    end
+  end
+end

data/lib/mongomapper/document.rb

@@ -11,9 +11,6 @@ module MongoMapper
         include SaveWithValidation
         include RailsCompatibility::Document
         extend ClassMethods
-
-        key :created_at, Time
-        key :updated_at, Time
       end
 
       descendants << model
@@ -140,7 +137,14 @@ module MongoMapper
         end
         @collection
       end
-
+      
+      def timestamps!
+        key :created_at, Time
+        key :updated_at, Time
+        
+        class_eval { before_save :update_timestamps }
+      end
+      
       def validates_uniqueness_of(*args)
         add_validations(args, MongoMapper::Validations::ValidatesUniquenessOf)
       end
@@ -181,7 +185,22 @@ module MongoMapper
 
         def find_last(options)
           options.merge!(:limit => 1)
-          find_every({:order => '$natural desc'}.merge(options))[0]
+          options[:order] = invert_order_clause(options)
+          find_every(options)[0]
+          #find_every({:order => '$natural desc'}.merge(invert_order_clause(options)))[0]
+        end
+
+        def invert_order_clause(options)
+          return '$natural desc' unless options[:order]
+          options[:order].split(',').map do |order_segment| 
+            if order_segment =~ /\sasc/i
+              order_segment.sub /\sasc/i, ' desc'
+            elsif order_segment =~ /\sdesc/i
+              order_segment.sub /\sdesc/i, ' asc'
+            else
+              "#{order_segment.strip} desc"
+            end
+          end.join(',')
         end
 
         def find_some(ids, options={})
@@ -295,7 +314,6 @@ module MongoMapper
       end
 
       def create
-        update_timestamps
         assign_id
         save_to_collection
       end
@@ -307,7 +325,6 @@ module MongoMapper
       end
 
       def update
-        update_timestamps
         save_to_collection
       end
 

data/lib/mongomapper/embedded_document.rb

@@ -77,28 +77,39 @@ module MongoMapper
       end
 
       def parent_model
-        if parent = ancestors[1]
-          parent if parent.ancestors.include?(EmbeddedDocument)
+        (ancestors - [self,EmbeddedDocument]).find do |parent_class|
+          parent_class.ancestors.include?(EmbeddedDocument)
         end
       end
 
     private
-      def create_accessors_for(key)
-        define_method(key.name) do
-          read_attribute(key.name)
+      def accessors_module
+        if const_defined?('MongoMapperKeys') && constants.include?( 'MongoMapperKeys' )
+          const_get 'MongoMapperKeys'
+        else 
+          const_set 'MongoMapperKeys', Module.new
         end
+      end
 
-        define_method("#{key.name}_before_typecast") do
-          read_attribute_before_typecast(key.name)
-        end
+      def create_accessors_for(key)
+        accessors_module.module_eval <<-end_eval
+          def #{key.name}
+            read_attribute( :'#{key.name}' )
+          end
 
-        define_method("#{key.name}=") do |value|
-          write_attribute(key.name, value)
-        end
+          def #{key.name}_before_typecast
+            read_attribute_before_typecast(:'#{key.name}')
+          end
 
-        define_method("#{key.name}?") do
-          read_attribute(key.name).present?
-        end
+          def #{key.name}=(value)
+            write_attribute(:'#{key.name}', value)
+          end
+
+          def #{key.name}?
+            read_attribute(:#{key.name}).present?
+          end
+        end_eval
+        include accessors_module
       end
       
       def create_indexes_for(key)

data/lib/mongomapper/serialization.rb

@@ -10,7 +10,7 @@ module MongoMapper #:nodoc:
       end
 
       def serializable_key_names
-        key_names = @record.class.keys.keys
+        key_names = @record.attributes.keys
 
         if options[:only]
           options.delete(:except)

data/mongomapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongomapper}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2009-08-16}
+  s.date = %q{2009-08-28}
   s.default_executable = %q{mmconsole}
   s.email = %q{nunemaker@gmail.com}
   s.executables = ["mmconsole"]
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "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_as_proxy.rb",
      "lib/mongomapper/associations/many_documents_proxy.rb",
      "lib/mongomapper/associations/many_embedded_polymorphic_proxy.rb",
      "lib/mongomapper/associations/many_embedded_proxy.rb",
@@ -55,6 +56,7 @@ Gem::Specification.new do |s|
      "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_documents_as_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",
@@ -89,6 +91,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/functional/associations/test_belongs_to_polymorphic_proxy.rb",
      "test/functional/associations/test_belongs_to_proxy.rb",
+     "test/functional/associations/test_many_documents_as_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",

data/test/functional/associations/test_many_documents_as_proxy.rb

@@ -0,0 +1,253 @@
+require 'test_helper'
+require 'models'
+
+class ManyDocumentsAsProxyTest < Test::Unit::TestCase
+  def setup
+    clear_all_collections
+  end
+
+  should "default reader to empty array" do
+    Post.new.comments.should == []
+  end
+
+  should "add type and id key to polymorphic class base" do
+    PostComment.keys.keys.should include('commentable_type')
+    PostComment.keys.keys.should include('commentable_id')
+  end
+
+  should "allow adding to association like it was an array" do
+    post = Post.new
+    post.comments << PostComment.new(:body => 'foo bar')
+    post.comments << PostComment.new(:body => 'baz')
+    post.comments.concat PostComment.new(:body => 'baz')
+
+    post.comments.size.should == 3
+  end
+
+  should "be able to replace the association" do
+    post = Post.new
+
+    lambda {
+      post.comments = [
+        PostComment.new(:body => 'foo'),
+        PostComment.new(:body => 'bar'),
+        PostComment.new(:body => 'baz')
+      ]
+    }.should change { PostComment.count }.by(3)
+
+    from_db = Post.find(post.id)
+    from_db.comments.size.should == 3
+    from_db.comments[0].body.should == 'foo'
+    from_db.comments[1].body.should == 'bar'
+    from_db.comments[2].body.should == 'baz'
+  end
+
+  context "build" do
+    should "assign foreign key" do
+      post = Post.new
+      comment = post.comments.build
+      comment.commentable_id.should == post.id
+    end
+
+    should "assign _type" do
+      post = Post.new
+      comment = post.comments.build
+      comment.commentable_type.should == "Post"
+    end
+
+    should "allow assigning attributes" do
+      post = Post.new
+      comment = post.comments.build(:body => 'foo bar')
+      comment.body.should == 'foo bar'
+    end
+  end
+
+  context "create" do
+    should "assign foreign key" do
+      post = Post.new
+      comment = post.comments.create
+      comment.commentable_id.should == post.id
+    end
+
+    should "assign _type" do
+      post = Post.new
+      comment = post.comments.create
+      comment.commentable_type.should == "Post"
+    end
+
+    should "save record" do
+      post = Post.new
+      lambda {
+        post.comments.create(:body => 'baz')
+      }.should change { PostComment.count }
+    end
+
+    should "allow passing attributes" do
+      post = Post.create
+      comment = post.comments.create(:body => 'foo bar')
+      comment.body.should == 'foo bar'
+    end
+  end
+
+  context "count" do
+    should "work scoped to association" do
+      post = Post.create
+      3.times { post.comments.create(:body => 'foo bar') }
+
+      other_post = Post.create
+      2.times { other_post.comments.create(:body => 'baz') }
+
+      post.comments.count.should == 3
+      other_post.comments.count.should == 2
+    end
+
+    should "work with conditions" do
+      post = Post.create
+      post.comments.create(:body => 'foo bar')
+      post.comments.create(:body => 'baz')
+      post.comments.create(:body => 'foo bar')
+
+      post.comments.count(:body => 'foo bar').should == 2
+    end
+  end
+
+  context "Finding scoped to association" do
+    setup do
+      @post = Post.new
+
+      @comment1 = PostComment.create(:body => 'comment1')
+      @comment2 = PostComment.create(:body => 'comment2')
+      @comment3 = PostComment.create(:body => 'comment3')
+      @post.comments = [@comment1, @comment2]
+      @post.save
+
+      @post2 = Post.create(:body => "post #2")
+      @comment4 = PostComment.create(:body => 'comment4')
+      @comment5 = PostComment.create(:body => 'comment5')
+      @comment6 = PostComment.create(:body => 'comment6')
+      @post2.comments = [@comment4, @comment5, @comment6]
+      @post2.save
+    end
+
+    context "with :all" do
+      should "work" do
+        @post.comments.find(:all).should include(@comment1)
+        @post.comments.find(:all).should include(@comment2)
+      end
+
+      should "work with conditions" do
+        comments = @post.comments.find(:all, :conditions => {:body => 'comment1'})
+        comments.should == [@comment1]
+      end
+
+      should "work with order" do
+        comments = @post.comments.find(:all, :order => '$natural desc')
+        comments.should == [@comment2, @comment1]
+      end
+    end
+
+    context "with #all" do
+      should "work" do
+        @post.comments.all.should == [@comment1, @comment2]
+      end
+
+      should "work with conditions" do
+        comments = @post.comments.all(:conditions => {:body => 'comment1'})
+        comments.should == [@comment1]
+      end
+
+      should "work with order" do
+        comments = @post.comments.all(:order => '$natural desc')
+        comments.should == [@comment2, @comment1]
+      end
+    end
+
+    context "with :first" do
+      should "work" do
+        lambda {@post.comments.find(:first)}.should_not raise_error
+      end
+
+      should "work with conditions" do
+        comment = @post.comments.find(:first, :conditions => {:body => 'comment2'})
+        comment.body.should == 'comment2'
+      end
+    end
+
+    context "with #first" do
+      should "work" do
+        @post.comments.first.should == @comment1
+      end
+
+      should "work with conditions" do
+        comment = @post.comments.first(:conditions => {:body => 'comment2'})
+        comment.should == @comment2
+      end
+    end
+
+    context "with :last" do
+      should "work" do
+        @post.comments.find(:last, :order => 'created_at asc').should == @comment2
+      end
+
+      should "work with conditions" do
+        post = @post.comments.find(:last, :conditions => {:body => 'comment1'})
+        post.body.should == 'comment1'
+      end
+    end
+
+    context "with #last" do
+      should "work" do
+        @post.comments.last.should == @comment2
+      end
+
+      should "work with conditions" do
+        comment = @post.comments.last(:conditions => {:body => 'comment1'})
+        comment.should == @comment1
+      end
+    end
+
+    context "with one id" do
+      should "work for id in association" do
+        @post.comments.find(@comment2.id).should == @comment2
+      end
+
+      should "not work for id not in association" do
+        lambda {
+          @post.comments.find(@comment5.id)
+        }.should raise_error(MongoMapper::DocumentNotFound)
+      end
+    end
+
+    context "with multiple ids" do
+      should "work for ids in association" do
+        posts = @post.comments.find(@comment1.id, @comment2.id)
+        posts.should == [@comment1, @comment2]
+      end
+
+      should "not work for ids not in association" do
+        lambda {
+          @post.comments.find(@comment1.id, @comment2.id, @comment4.id)
+        }.should raise_error(MongoMapper::DocumentNotFound)
+      end
+    end
+
+    context "with #paginate" do
+      setup do
+        @comments = @post2.comments.paginate(:per_page => 2, :page => 1, :order => 'created_at asc')
+      end
+
+      should "return total pages" do
+        @comments.total_pages.should == 2
+      end
+
+      should "return total entries" do
+        @comments.total_entries.should == 3
+      end
+
+      should "return the subject" do
+        @comments.should include(@comment4)
+        @comments.should include(@comment5)
+      end
+    end
+  end
+end