Add documentation for polymorphic URL helpers, make API consistent for polymorphic_path and polymorphic_url.

Closes #10883 [mislav] Closes #8782 [gbuesing] Closes #8720 [gbuesing]


git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8741 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

1 files changed, 106 insertions, 75 deletions

diff --git a/actionpack/test/controller/polymorphic_routes_test.rb b/actionpack/test/controller/polymorphic_routes_test.rb
index 51d71d1955..660e51334a 100644
--- a/actionpack/test/controller/polymorphic_routes_test.rb
+++ b/actionpack/test/controller/polymorphic_routes_test.rb
@@ -5,94 +5,125 @@ class Article
   def save; @id = 1 end
   def new_record?; @id.nil? end
   def name
-    @id.nil? ? 'new post' : "post ##{@id}"
+    model = self.class.name.downcase
+    @id.nil? ? "new #{model}" : "#{model} ##{@id}"
   end
 end
 
-class Comment
-  attr_reader :id
+class Comment < Article
   def post_id; 1 end
-  def save; @id = 1 end
-  def new_record?; @id.nil? end
-  def name
-    @id.nil? ? 'new comment' : "comment ##{@id}"
-  end
 end
 
+class Tag < Article
+  def comment_id; 1 end
+end
+
+# TODO: test nested models
 class Comment::Nested < Comment; end
 
-class Test::Unit::TestCase
-  protected
-  def articles_url
-    'http://www.example.com/articles'
-  end
-  alias_method :new_article_url, :articles_url
-  
-  def article_url(article)
-    "http://www.example.com/articles/#{article.id}"
-  end
+uses_mocha 'polymorphic URL helpers' do
+  class PolymorphicRoutesTest < Test::Unit::TestCase
 
-  def article_comments_url(article)
-    "http://www.example.com/articles/#{article.id}/comments"
-  end
-  
-  def article_comment_url(article, comment)
-    "http://www.example.com/articles/#{article.id}/comments/#{comment.id}"
-  end
-  
-  def admin_articles_url
-    "http://www.example.com/admin/articles"
-  end
-  alias_method :new_admin_article_url, :admin_articles_url
-  
-  def admin_article_url(article)
-    "http://www.example.com/admin/articles/#{article.id}"
-  end
-  
-  def admin_article_comments_url(article)
-    "http://www.example.com/admin/articles/#{article.id}/comments"
-  end
+    include ActionController::PolymorphicRoutes
+
+    def setup
+      @article = Article.new
+      @comment = Comment.new
+    end
   
-  def admin_article_comment_url(article, comment)
-    "http://www.example.com/admin/test/articles/#{article.id}/comments/#{comment.id}"
-  end
-end
+    def test_with_record
+      @article.save
+      expects(:article_url).with(@article)
+      polymorphic_url(@article)
+    end
 
+    def test_with_new_record
+      expects(:articles_url).with()
+      @article.expects(:new_record?).returns(true)
+      polymorphic_url(@article)
+    end
 
-class PolymorphicRoutesTest < Test::Unit::TestCase
-  include ActionController::PolymorphicRoutes
+    def test_with_record_and_action
+      expects(:new_article_url).with()
+      @article.expects(:new_record?).never
+      polymorphic_url(@article, :action => 'new')
+    end
 
-  def setup
-    @article = Article.new
-    @comment = Comment.new
-  end
-  
-  def test_with_record
-    assert_equal(articles_url, polymorphic_url(@article, :action => 'new'))
-    assert_equal(articles_url, polymorphic_url(@article))
-    @article.save
-    assert_equal(article_url(@article), polymorphic_url(@article))
-  end
-  
-  # TODO: Needs to be updated to correctly know about whether the object is in a hash or not
-  def xtest_with_hash
-    @article.save
-    assert_equal(article_url(@article), polymorphic_url(:id => @article))
-  end
+    def test_url_helper_prefixed_with_new
+      expects(:new_article_url).with()
+      new_polymorphic_url(@article)
+    end
+
+    def test_url_helper_prefixed_with_edit
+      @article.save
+      expects(:edit_article_url).with(@article)
+      edit_polymorphic_url(@article)
+    end
+
+    def test_formatted_url_helper
+      expects(:formatted_article_url).with(@article, :pdf)
+      formatted_polymorphic_url([@article, :pdf])
+    end
+
+    # TODO: should this work?
+    def xtest_format_option
+      @article.save
+      expects(:article_url).with(@article, :format => :pdf)
+      polymorphic_url(@article, :format => :pdf)
+    end
+
+    def test_with_nested
+      @comment.save
+      expects(:article_comment_url).with(@article, @comment)
+      polymorphic_url([@article, @comment])
+    end
+
+    def test_with_nested_unsaved
+      expects(:article_comments_url).with(@article)
+      polymorphic_url([@article, @comment])
+    end
+
+    def test_new_with_array_and_namespace
+      expects(:new_admin_article_url).with()
+      polymorphic_url([:admin, @article], :action => 'new')
+    end
+
+    def test_unsaved_with_array_and_namespace
+      expects(:admin_articles_url).with()
+      polymorphic_url([:admin, @article])
+    end
+
+    def test_nested_unsaved_with_array_and_namespace
+      @article.save
+      expects(:admin_article_url).with(@article)
+      polymorphic_url([:admin, @article])
+      expects(:admin_article_comments_url).with(@article)
+      polymorphic_url([:admin, @article, @comment])
+    end
+
+    def test_nested_with_array_and_namespace
+      @comment.save
+      expects(:admin_article_comment_url).with(@article, @comment)
+      polymorphic_url([:admin, @article, @comment])
+
+      # a ridiculously long named route tests correct ordering of namespaces and nesting:
+      @tag = Tag.new
+      @tag.save
+      expects(:site_admin_article_comment_tag_url).with(@article, @comment, @tag)
+      polymorphic_url([:site, :admin, @article, @comment, @tag])
+    end
+
+    # TODO: Needs to be updated to correctly know about whether the object is in a hash or not
+    def xtest_with_hash
+      expects(:article_url).with(@article)
+      @article.save
+      polymorphic_url(:id => @article)
+    end
+
+    def test_polymorphic_path_accepts_options
+      expects(:new_article_path).with()
+      polymorphic_path(@article, :action => :new)
+    end
 
-  def test_with_array
-    assert_equal(article_comments_url(@article), polymorphic_url([@article, @comment]))
-    @comment.save
-    assert_equal(article_comment_url(@article, @comment), polymorphic_url([@article, @comment]))
-  end  
-  
-  def test_with_array_and_namespace
-    assert_equal(admin_articles_url, polymorphic_url([:admin, @article], :action => 'new'))
-    assert_equal(admin_articles_url, polymorphic_url([:admin, @article]))
-    @article.save
-    assert_equal(admin_article_url(@article), polymorphic_url([:admin, @article]))
-    assert_equal(admin_article_comments_url(@article), polymorphic_url([:admin, @article, @comment]))
-    @comment.save
-    assert_equal(admin_article_comment_url(@article, @comment), polymorphic_url([:admin, @article, @comment]))
   end
 end