mongo_mapper 0.8.6 → 0.9.0

data/test/unit/test_keys.rb

@@ -2,8 +2,6 @@ require 'test_helper'
 require 'models'
 
 class KeyTest < Test::Unit::TestCase
-  include MongoMapper::Plugins::Keys
-
   context ".new with no id and _id of type integer" do
     should "not error" do
       lambda {

data/test/unit/test_plugins.rb

@@ -1,29 +1,35 @@
 require 'test_helper'
 
-module MyPlugin
-  def self.configure(model)
-    model.class_eval { attr_accessor :from_configure }
+class PluginsTest < Test::Unit::TestCase
+  should "default plugins to empty array" do
+    Class.new { extend MongoMapper::Plugins }.plugins.should == []
   end
 
-  module ClassMethods
-    def class_foo
-      'class_foo'
-    end
-  end
+  context "ActiveSupport::Concern" do
+    module MyConcern
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :from_concern
+      end
+
+      module ClassMethods
+        def class_foo
+          'class_foo'
+        end
+      end
 
-  module InstanceMethods
-    def instance_foo
-      'instance_foo'
+      module InstanceMethods
+        def instance_foo
+          'instance_foo'
+        end
+      end
     end
-  end
-end
 
-class PluginsTest < Test::Unit::TestCase
-  context "plugin" do
     setup do
       @document = Class.new do
         extend MongoMapper::Plugins
-        plugin MyPlugin
+        plugin MyConcern
       end
     end
 
@@ -36,15 +42,95 @@ class PluginsTest < Test::Unit::TestCase
     end
 
     should "pass model to configure" do
-      @document.new.should respond_to(:from_configure)
+      @document.new.should respond_to(:from_concern)
+    end
+
+    should "add plugin to plugins" do
+      @document.plugins.should include(MyConcern)
+    end
+
+    context "Document" do
+      setup do
+        MongoMapper::Document.plugins.delete(MyConcern)
+      end
+
+      should 'allow plugins on Document' do
+        MongoMapper::Document.plugin(MyConcern)
+        Doc().should respond_to(:class_foo)
+        Doc().new.should respond_to(:instance_foo)
+      end
+
+      should 'add plugins to classes that include Document before they are added' do
+        article = Doc()
+        MongoMapper::Document.plugin(MyConcern)
+        article.should respond_to(:class_foo)
+        article.new.should respond_to(:instance_foo)
+      end
+    end
+
+    context "EmbeddedDocument" do
+      setup do
+        MongoMapper::EmbeddedDocument.plugins.delete(MyConcern)
+      end
+
+      should 'allow plugins on EmbeddedDocument' do
+        MongoMapper::EmbeddedDocument.plugin(MyConcern)
+        article = EDoc()
+        article.should respond_to(:class_foo)
+        article.new.should respond_to(:instance_foo)
+      end
+
+      should 'add plugins to classes that include EmbeddedDocument before they are added' do
+        article = EDoc()
+        MongoMapper::EmbeddedDocument.plugin(MyConcern)
+        article.should respond_to(:class_foo)
+        article.new.should respond_to(:instance_foo)
+      end
     end
+  end
 
-    should "default plugins to empty array" do
-      Class.new { extend MongoMapper::Plugins }.plugins.should == []
+  context "deprecated plugin" do
+    module DeprecatedPlugin
+      def self.configure(model)
+        model.class_eval { attr_accessor :from_configure }
+      end
+
+      module ClassMethods
+        def class_foo
+          'class_foo'
+        end
+      end
+
+      module InstanceMethods
+        def instance_foo
+          'instance_foo'
+        end
+      end
+    end
+
+    setup do
+      silence_stderr do
+        @document = Class.new do
+          extend MongoMapper::Plugins
+          plugin DeprecatedPlugin
+        end
+      end
+    end
+
+    should "include instance methods" do
+      @document.new.instance_foo.should == 'instance_foo'
+    end
+
+    should "extend class methods" do
+      @document.class_foo.should == 'class_foo'
+    end
+
+    should "pass model to configure" do
+      @document.new.should respond_to(:from_configure)
     end
 
     should "add plugin to plugins" do
-      @document.plugins.should include(MyPlugin)
+      @document.plugins.should include(DeprecatedPlugin)
     end
   end
 end

data/test/unit/test_rails.rb

@@ -33,8 +33,8 @@ class TestRails < Test::Unit::TestCase
             write_attribute(:foo, value)
           end
 
-          def bar_before_typecast
-            read_attribute_before_typecast(:foo)
+          def bar_before_type_cast
+            read_attribute_before_type_cast(:foo)
           end
 
           def bar
@@ -51,8 +51,8 @@ class TestRails < Test::Unit::TestCase
         @klass.new(:foo => 'Bar').bar.should == 'Bar'
       end
 
-      should "be able to read key before typecast with read_attribute_before_typecast" do
-        @klass.new(:foo => 21).bar_before_typecast.should == 21
+      should "be able to read key before type cast with read_attribute_before_type_cast" do
+        @klass.new(:foo => 21).bar_before_type_cast.should == 21
         @klass.new(:foo => 21).bar.should == '21'
       end
 
@@ -120,8 +120,8 @@ class TestRails < Test::Unit::TestCase
             write_attribute(:foo, value)
           end
 
-          def bar_before_typecast
-            read_attribute_before_typecast(:foo)
+          def bar_before_type_cast
+            read_attribute_before_type_cast(:foo)
           end
 
           def bar
@@ -138,8 +138,8 @@ class TestRails < Test::Unit::TestCase
         @klass.new(:foo => 'Bar').bar.should == 'Bar'
       end
 
-      should "be able to read key before typecast with read_attribute_before_typecast" do
-        @klass.new(:foo => 21).bar_before_typecast.should == 21
+      should "be able to read key before type cast with read_attribute_before_type_cast" do
+        @klass.new(:foo => 21).bar_before_type_cast.should == 21
         @klass.new(:foo => 21).bar.should == '21'
       end
 

data/test/unit/test_serialization.rb

@@ -19,7 +19,122 @@ class SerializationTest < Test::Unit::TestCase
     )
   end
 
-  [:json].each do |format|
+  context "#serializable_hash" do
+    class List
+      include MongoMapper::Document
+      key :name
+      many :items,          :class_name => 'SerializationTest::Item'
+      belongs_to :creator,  :class_name => 'SerializationTest::User'
+    end
+
+    class Item
+      include MongoMapper::Document
+
+      key :title
+      key :description
+      many :assignments, :class_name => 'SerializationTest::Assignment'
+
+      def a_method
+        1
+      end
+    end
+
+    class Assignment
+      include MongoMapper::EmbeddedDocument
+      belongs_to :assigned_by,  :class_name => 'SerializationTest::User'
+      belongs_to :user,         :class_name => 'SerializationTest::User'
+
+      def serializable_hash(options = {})
+        super({:only => :user_id}.merge(options))
+      end
+    end
+
+    class User
+      include MongoMapper::Document
+      key :name, String
+    end
+
+    setup do
+      @user1 = User.new(:name => 'Brandon')
+      @user2 = User.new(:name => 'John')
+      @item = Item.new(
+        :title => 'Serialization',
+        :description => 'Make it work like magic!',
+        :assignments => [
+          Assignment.new(:assigned_by => @user1, :user => @user2)
+        ]
+      )
+    end
+
+    should "only include specified attributes with :only option" do
+      @item.serializable_hash(:only => :title).should == {'title' => 'Serialization'}
+    end
+
+    should "exclude attributes specified with :except option" do
+      hash = @item.serializable_hash(:except => :description)
+      hash['title'].should_not be_nil
+      hash['description'].should be_nil
+    end
+
+    should "add :methods with :only option" do
+      @item.serializable_hash(:only => :title, :methods => :a_method).should == {
+        'title' => 'Serialization',
+        'a_method' => 1
+      }
+    end
+
+    should "call #serializable_hash on embedded many docs" do
+      @item.serializable_hash.should == {
+        'id'          => @item.id,
+        'title'       => 'Serialization',
+        'description' => 'Make it work like magic!',
+        'assignments' => [{'user_id' => @user2.id}]
+      }
+    end
+
+    context "with :include" do
+      setup do
+        @list = List.new(:title => 'MongoMapper', :items => [@item], :creator => @user1)
+      end
+
+      should "add many association" do
+        hash = @list.serializable_hash(:include => :items)
+        hash['items'].should be_instance_of(Array)
+        hash['items'].first['title'].should == 'Serialization'
+      end
+
+      should "add belongs_to association" do
+        hash = @list.serializable_hash(:include => :creator)
+        hash['creator'].should == @user1.serializable_hash
+      end
+
+      should "add one association" do
+        author_class = Doc do
+          key :post_id, ObjectId
+        end
+        post_class = Doc('Post') do
+          one :author, :class => author_class
+        end
+
+        author = author_class.new
+        hash = post_class.new(:author => author).serializable_hash(:include => :author)
+        hash['author'].should == author.serializable_hash
+      end
+
+      should "include multiple associations" do
+        hash = @list.serializable_hash(:include => [:items, :creator])
+        hash['items'].should be_instance_of(Array)
+        hash['creator'].should == @user1.serializable_hash
+      end
+
+      should "include multiple associations with options" do
+        hash = @list.serializable_hash(:include => {:creator => {:only => :name}})
+        hash['creator'].should == @user1.serializable_hash(:only => :name)
+      end
+    end
+  end
+
+  [:json, :xml].each do |format|
     context format do
       should "be reversable" do
         serialized = @instance.send("to_#{format}")

data/test/unit/test_translation.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class TranslationTest < Test::Unit::TestCase
+  should "translate add mongo_mapper translations" do
+    I18n.translate("mongo_mapper.errors.messages.taken").should == "has already been taken"
+  end
+
+  should "set i18n_scope" do
+    Doc().i18n_scope.should == :mongo_mapper
+  end
+
+  should "translate document attributes" do
+    I18n.config.backend.store_translations(:en, :mongo_mapper => {:attributes => {:thing => {:foo => 'Bar'}}})
+    doc = Doc('Thing') do
+      key :foo, String
+    end
+    doc.human_attribute_name(:foo).should == 'Bar'
+  end
+
+  should "translate embedded document attributes" do
+    I18n.config.backend.store_translations(:en, :mongo_mapper => {:attributes => {:thing => {:foo => 'Bar'}}})
+    doc = EDoc('Thing') do
+      key :foo, String
+    end
+    doc.human_attribute_name(:foo).should == 'Bar'
+  end
+end

data/test/unit/test_validations.rb

@@ -4,27 +4,7 @@ class ValidationsTest < Test::Unit::TestCase
   context "Validations" do
     context "on a Document" do
       setup do
-        @document = Doc()
-      end
-
-      context "Validating uniquness of" do
-        should "not validate nil when allow_nil false" do
-          @document.key :name, String
-          @document.validates_uniqueness_of :name, :allow_nil => false
-          doc = @document.new(:name => nil)
-          doc.should have_error_on(:name)
-          doc.name = "Ryan"
-          doc.should_not have_error_on(:name)
-        end
-
-        should "not validate blank when allow_blank false" do
-          @document.key :name, String
-          @document.validates_uniqueness_of :name, :allow_blank => false
-          doc = @document.new(:name => "")
-          doc.should have_error_on(:name)
-          doc.name = "Ryan"
-          doc.should_not have_error_on(:name)
-        end
+        @document = Doc('John')
       end
 
       context "Validating acceptance of" do
@@ -42,9 +22,13 @@ class ValidationsTest < Test::Unit::TestCase
         should "work with validates_confirmation_of macro" do
           @document.key :password, String
           @document.validates_confirmation_of :password
+
+          # NOTE: Api change as ActiveModel passes if password_confirmation is nil
           doc = @document.new
           doc.password = 'foobar'
+          doc.password_confirmation = 'foobar1'
           doc.should have_error_on(:password)
+
           doc.password_confirmation = 'foobar'
           doc.should_not have_error_on(:password)
         end
@@ -160,19 +144,19 @@ class ValidationsTest < Test::Unit::TestCase
       end # numericality of
 
       context "validating presence of" do
-        should "work with validates_presence_of macro" do
-          @document.key :name, String
-          @document.validates_presence_of :name
-          doc = @document.new
-          doc.should have_error_on(:name)
-        end
-
-        should "work with :required shortcut on key definition" do
-          @document.key :name, String, :required => true
-          doc = @document.new
-          doc.should have_error_on(:name)
-        end
-      end
+           should "work with validates_presence_of macro" do
+             @document.key :name, String
+             @document.validates_presence_of :name
+             doc = @document.new
+             doc.should have_error_on(:name)
+           end
+
+           should "work with :required shortcut on key definition" do
+             @document.key :name, String, :required => true
+             doc = @document.new
+             doc.should have_error_on(:name)
+           end
+         end
 
       context "validating exclusion of" do
         should "throw error if enumerator not provided" do
@@ -184,7 +168,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "work with validates_exclusion_of macro" do
           @document.key :action, String
-          @document.validates_exclusion_of :action, :within => %w(kick run)
+          @document.validates_exclusion_of :action, :in => %w(kick run)
 
           doc = @document.new
           doc.should_not have_error_on(:action)
@@ -211,7 +195,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow nil is true and value is nil" do
           @document.key :action, String
-          @document.validates_exclusion_of :action, :within => %w(kick run), :allow_nil => true
+          @document.validates_exclusion_of :action, :in => %w(kick run), :allow_nil => true
 
           doc = @document.new
           doc.should_not have_error_on(:action)
@@ -219,7 +203,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow blank is true and value is blank" do
           @document.key :action, String
-          @document.validates_exclusion_of :action, :within => %w(kick run), :allow_nil => true
+          @document.validates_exclusion_of :action, :in => %w(kick run), :allow_nil => true
 
           doc = @document.new(:action => '')
           doc.should_not have_error_on(:action)
@@ -236,13 +220,13 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "work with validates_inclusion_of macro" do
           @document.key :action, String
-          @document.validates_inclusion_of :action, :within => %w(kick run)
+          @document.validates_inclusion_of :action, :in => %w(kick run)
 
           doc = @document.new
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'fart'
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'kick'
           doc.should_not have_error_on(:action)
@@ -252,10 +236,10 @@ class ValidationsTest < Test::Unit::TestCase
           @document.key :action, String, :in => %w(kick run)
 
           doc = @document.new
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'fart'
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'kick'
           doc.should_not have_error_on(:action)
@@ -263,7 +247,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow nil is true and value is nil" do
           @document.key :action, String
-          @document.validates_inclusion_of :action, :within => %w(kick run), :allow_nil => true
+          @document.validates_inclusion_of :action, :in => %w(kick run), :allow_nil => true
 
           doc = @document.new
           doc.should_not have_error_on(:action)
@@ -271,7 +255,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow blank is true and value is blank" do
           @document.key :action, String
-          @document.validates_inclusion_of :action, :within => %w(kick run), :allow_blank => true
+          @document.validates_inclusion_of :action, :in => %w(kick run), :allow_blank => true
 
           doc = @document.new(:action => '')
           doc.should_not have_error_on(:action)
@@ -302,6 +286,7 @@ class ValidationsTest < Test::Unit::TestCase
           @embedded_doc.validates_confirmation_of :password
           doc = @embedded_doc.new
           doc.password = 'foobar'
+          doc.password_confirmation = 'foobar1'
           doc.should have_error_on(:password)
           doc.password_confirmation = 'foobar'
           doc.should_not have_error_on(:password)
@@ -418,19 +403,19 @@ class ValidationsTest < Test::Unit::TestCase
       end # numericality of
 
       context "validating presence of" do
-        should "work with validates_presence_of macro" do
-          @embedded_doc.key :name, String
-          @embedded_doc.validates_presence_of :name
-          doc = @embedded_doc.new
-          doc.should have_error_on(:name)
-        end
-
-        should "work with :required shortcut on key definition" do
-          @embedded_doc.key :name, String, :required => true
-          doc = @embedded_doc.new
-          doc.should have_error_on(:name)
-        end
-      end
+         should "work with validates_presence_of macro" do
+           @embedded_doc.key :name, String
+           @embedded_doc.validates_presence_of :name
+           doc = @embedded_doc.new
+           doc.should have_error_on(:name)
+         end
+
+         should "work with :required shortcut on key definition" do
+           @embedded_doc.key :name, String, :required => true
+           doc = @embedded_doc.new
+           doc.should have_error_on(:name)
+         end
+       end
 
       context "validating exclusion of" do
         should "throw error if enumerator not provided" do
@@ -442,7 +427,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "work with validates_exclusion_of macro" do
           @embedded_doc.key :action, String
-          @embedded_doc.validates_exclusion_of :action, :within => %w(kick run)
+          @embedded_doc.validates_exclusion_of :action, :in => %w(kick run)
 
           doc = @embedded_doc.new
           doc.should_not have_error_on(:action)
@@ -469,7 +454,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow nil is true and value is nil" do
           @embedded_doc.key :action, String
-          @embedded_doc.validates_exclusion_of :action, :within => %w(kick run), :allow_nil => true
+          @embedded_doc.validates_exclusion_of :action, :in => %w(kick run), :allow_nil => true
 
           doc = @embedded_doc.new
           doc.should_not have_error_on(:action)
@@ -477,7 +462,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow blank is true and value is blank" do
           @embedded_doc.key :action, String
-          @embedded_doc.validates_exclusion_of :action, :within => %w(kick run), :allow_nil => true
+          @embedded_doc.validates_exclusion_of :action, :in => %w(kick run), :allow_nil => true
 
           doc = @embedded_doc.new(:action => '')
           doc.should_not have_error_on(:action)
@@ -494,13 +479,13 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "work with validates_inclusion_of macro" do
           @embedded_doc.key :action, String
-          @embedded_doc.validates_inclusion_of :action, :within => %w(kick run)
+          @embedded_doc.validates_inclusion_of :action, :in => %w(kick run)
 
           doc = @embedded_doc.new
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'fart'
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'kick'
           doc.should_not have_error_on(:action)
@@ -510,10 +495,10 @@ class ValidationsTest < Test::Unit::TestCase
           @embedded_doc.key :action, String, :in => %w(kick run)
 
           doc = @embedded_doc.new
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'fart'
-          doc.should have_error_on(:action, 'is not in the list')
+          doc.should have_error_on(:action, 'is not included in the list')
 
           doc.action = 'kick'
           doc.should_not have_error_on(:action)
@@ -521,7 +506,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow nil is true and value is nil" do
           @embedded_doc.key :action, String
-          @embedded_doc.validates_inclusion_of :action, :within => %w(kick run), :allow_nil => true
+          @embedded_doc.validates_inclusion_of :action, :in => %w(kick run), :allow_nil => true
 
           doc = @embedded_doc.new
           doc.should_not have_error_on(:action)
@@ -529,7 +514,7 @@ class ValidationsTest < Test::Unit::TestCase
 
         should "not have error if allow blank is true and value is blank" do
           @embedded_doc.key :action, String
-          @embedded_doc.validates_inclusion_of :action, :within => %w(kick run), :allow_blank => true
+          @embedded_doc.validates_inclusion_of :action, :in => %w(kick run), :allow_blank => true
 
           doc = @embedded_doc.new(:action => '')
           doc.should_not have_error_on(:action)
@@ -541,24 +526,24 @@ class ValidationsTest < Test::Unit::TestCase
   end # Validations
 
   context "Adding validation errors" do
-    setup do
-      @document = Doc do
-        key :action, String
-        def action_present
-          errors.add(:action, 'is invalid') if action.blank?
+      setup do
+        @document = Doc do
+          key :action, String
+          def action_present
+            errors.add(:action, 'is invalid') if action.blank?
+          end
         end
       end
-    end
 
-    should "work with validate callback" do
-      @document.validate :action_present
+      should "work with validate callback" do
+        @document.validate :action_present
 
-      doc = @document.new
-      doc.action = nil
-      doc.should have_error_on(:action)
+        doc = @document.new
+        doc.action = nil
+        doc.should have_error_on(:action)
 
-      doc.action = 'kick'
-      doc.should_not have_error_on(:action)
+        doc.action = 'kick'
+        doc.should_not have_error_on(:action)
+      end
     end
-  end
 end