Changeset 8741

Timestamp:

01/27/08 01:18:47 (10 months ago)

Author:

nzkoz

Message:

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

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

Files:

• trunk/actionpack/lib/action_controller/polymorphic_routes.rb (modified) (6 diffs)
• trunk/actionpack/test/controller/polymorphic_routes_test.rb (modified) (1 diff)

trunk/actionpack/lib/action_controller/polymorphic_routes.rb

@@ -1 +1 @@
-module ActionController
+  # Polymorphic URL helpers are methods for smart resolution to a named route call when
+  # given an ActiveRecord model instance. They are to be used in combination with
+  # ActionController::Resources.
+  #
+  # These methods are useful when you want to generate correct URL or path to a RESTful
+  # resource without having to know the exact type of the record in question.
+  #
+  # Nested resources and/or namespaces are also supported, as illustrated in the example:
+  #
+  #   polymorphic_url([:admin, @article, @comment])
+  #   #-> results in:
+  #   admin_article_comment_url(@article, @comment)
+  #
+  # == Usage within the framework
+  #
+  # Polymorphic URL helpers are used in a number of places throughout the Rails framework:
+  #
+  # * <tt>url_for</tt>, so you can use it with a record as the argument, e.g.
+  #   <tt>url_for(@article)</tt>;
+  # * ActionView::Helpers::FormHelper uses <tt>polymorphic_path</tt>, so you can write
+  #   <tt>form_for(@article)</tt> without having to specify :url parameter for the form
+  #   action;
+  # * <tt>redirect_to</tt> (which, in fact, uses <tt>url_for</tt>) so you can write
+  #   <tt>redirect_to(post)</tt> in your controllers;
+  # * ActionView::Helpers::AtomFeedHelper, so you don't have to explicitly specify URLs
+  #   for feed entries.
+  #
+  # == Prefixed polymorphic helpers
+  #
+  # In addition to <tt>polymorphic_url</tt> and <tt>polymorphic_path</tt> methods, a
+  # number of prefixed helpers are available as a shorthand to <tt>:action => "..."</tt>
+  # in options. Those are:
+  #
+  # * <tt>edit_polymorphic_url</tt>, <tt>edit_polymorphic_path</tt>
+  # * <tt>new_polymorphic_url</tt>, <tt>new_polymorphic_path</tt>
+  # * <tt>formatted_polymorphic_url</tt>, <tt>formatted_polymorphic_path</tt>
+  #
+  # Example usage:
+  #
+  #   edit_polymorphic_path(@post)
+  #   #=> /posts/1/edit
+  #
+  #   formatted_polymorphic_path([@post, :pdf])
+  #   #=> /posts/1.pdf
-  module PolymorphicRoutes
+    # Constructs a call to a named RESTful route for the given record and returns the
+    # resulting URL string. For example:
+    #
+    #   polymorphic_url(post)
+    #   # calls post_url(post) #=> "http://example.com/posts/1"
+    #
+    # ==== Options
+    # * <tt>:action</tt> -- specifies the action prefix for the named route:
+    #   <tt>:new</tt>, <tt>:edit</tt> or <tt>:formatted</tt>. Default is no prefix.
+    # * <tt>:routing_type</tt> -- <tt>:path</tt> or <tt>:url</tt> (default <tt>:url</tt>).
+    #
+    # ==== Examples
+    #
+    #   # an Article record
+    #   polymorphic_url(record)  #->  article_url(record)
+    #
+    #   # a Comment record
+    #   polymorphic_url(record)  #->  comment_url(record)
+    #
+    #   # it recognizes new records and maps to the collection
+    #   record = Comment.new
+    #   polymorphic_url(record)  #->  comments_url()
+    #
-    def polymorphic_url(record_or_hash_or_array, options = {})
-
-
+   
+
-      namespace = extract_namespace(record_or_hash_or_array)
-      
@@ -12 +79 @@
-      end
-
+      args << format if format
+
-      inflection =
-        case
-
+.to_s
-          args.pop
-          :singular
@@ -28 +97 @@
-    end
-
-
-
+
+
+
+
+
-    end
-
@@ -44 +116 @@
-    end
-
-
-    private
-      def action_prefix(options)
@@ -51 +122 @@
-
-      def routing_type(options)
-"#{options[:routing_type] || "url"}"
+options[:routing_type] || :url
-      end
-
-      def build_named_route_call(records, namespace, inflection, options = {})
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-        end
-
-
+
+
+
-      end
-
@@ -79 +154 @@
-            record_or_hash_or_array.delete_if do |record_or_namespace|
-              if record_or_namespace.is_a?(String) || record_or_namespace.is_a?(Symbol)
-.to_s
+
-              end
-            end

trunk/actionpack/test/controller/polymorphic_routes_test.rb

@@ -6 +6 @@
-  def new_record?; @id.nil? end
-  def name
-
+
+
-  end
-end
-
-
-
+
-  def post_id; 1 end
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  end
-end
-
-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
-
-  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
-  
-  def admin_article_comment_url(article, comment)
-    "http://www.example.com/admin/test/articles/#{article.id}/comments/#{comment.id}"
-  end
-end
-
-
-class PolymorphicRoutesTest < Test::Unit::TestCase
-  include ActionController::PolymorphicRoutes
-
-  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_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