Rails源代码分析（31）：ActionController::Routing(2) PolymorphicRoutes

1 使用

action_controller base:

url_for :controller => 'posts', :action => nil

1.       def url_for(options = {})
2.         options ||= {}
3.         case options
4.           when String
5.             options
6.           when Hash
7.             @url.rewrite(rewrite_options(options))
8.           else
9.             polymorphic_url(options)
10.         end
11.       end

这个module主要提供了一个智能化的方法能够根据active record的model名字，这些方法对使用Restful风格的url很有作用。

1.   # Nested resources and/or namespaces are also supported, as illustrated in the example:
2.   #
3.      polymorphic_url([:admin, @article, @comment])
4.   #
5.   # results in:
6.   #   
7.      admin_article_comment_url(@article, @comment)

在框架中使用的地方包括：

   * url_for, so you can use it with a record as the argument, e.g.

     url_for(@article)

  

   * ActionView::Helpers::FormHelper uses <tt>polymorphic_path</tt>, so you can write

     <tt>form_for(@article)</tt> without having to specify <tt>:url</tt> 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.

除了polymorphic_url和polymorphic_path以外，还有一系列方法：

  # * <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>

使用例子：

  #   edit_polymorphic_path(@post)              # => "/posts/1/edit"

  #   formatted_polymorphic_path([@post, :pdf]) # => "/posts/1.pdf"

2 代码分析

1.   module PolymorphicRoutes
2.     # Constructs a call to a named RESTful route for the given record and returns the
3.     # resulting URL string. For example:
4.     #
5.     #   # calls post_url(post)
6.     #   polymorphic_url(post) # => "http://example.com/posts/1"
7.     #
8.     # ==== Options
9.     #
10.     # * <tt>:action</tt> - Specifies the action prefix for the named route:
11.     #    <tt>:new</tt>, <tt>:edit</tt>, or <tt>:formatted</tt>. Default is no prefix.
12.     # * <tt>:routing_type</tt> - Allowed values are <tt>:path</tt> or <tt>:url</tt>.
13.     #   Default is <tt>:url</tt>.
14.     #
15.     # ==== Examples
16.     #
17.     #   # an Article record
18.     #   polymorphic_url(record)  # same as article_url(record)
19.     #
20.     #   # a Comment record
21.     #   polymorphic_url(record)  # same as comment_url(record)
22.     #
23.     #   # it recognizes new records and maps to the collection
24.     #   record = Comment.new
25.     #   polymorphic_url(record)  # same as comments_url()
26.     #
27.     def polymorphic_url(record_or_hash_or_array, options = {})
28.       # 如果是Array则复制一份
29.      if record_or_hash_or_array.kind_of?(Array)
30.         record_or_hash_or_array = record_or_hash_or_array.dup
31.       end
33.       record    = extract_record(record_or_hash_or_array)
34.       format    = extract_format(record_or_hash_or_array, options)
35.       namespace = extract_namespace(record_or_hash_or_array)
36.       
37.       # 参数统一成Array
38.       args = case record_or_hash_or_array
39.         when Hash;  [ record_or_hash_or_array ]
40.         when Array; record_or_hash_or_array.dup
41.         else        [ record_or_hash_or_array ]
42.       end
44.       args << format if format
46.       inflection =
47.         case
48.         when options[:action].to_s == "new"
49.           args.pop
50.           :singular
51.         when record.respond_to?(:new_record?) && record.new_record?
52.           args.pop
53.           :plural
54.         else
55.           :singular
56.         end
57.       
58.       named_route = build_named_route_call(record_or_hash_or_array, namespace, inflection, options)
59.       # 根据生成的route方法名来调用route方法
60.       send!(named_route, *args)
61.     end
63.     # Returns the path component of a URL for the given record. It uses
64.     # <tt>polymorphic_url</tt> with <tt>:routing_type => :path</tt>.
65.     def polymorphic_path(record_or_hash_or_array, options = {})
66.       options[:routing_type] = :path
67.       polymorphic_url(record_or_hash_or_array, options)
68.     end
70.     # 动态生成方法：
71.     # * <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>
72.     %w(edit new formatted).each do |action|
73.       module_eval <<-EOT, __FILE__, __LINE__
74.         def #{action}_polymorphic_url(record_or_hash)
75.           polymorphic_url(record_or_hash, :action => "#{action}")
76.         end
78.         def #{action}_polymorphic_path(record_or_hash)
79.           polymorphic_url(record_or_hash, :action => "#{action}", :routing_type => :path)
80.         end
81.       EOT
82.     end
84.     private
85.       # 方法前缀 就是:action指定的
86.       def action_prefix(options)
87.         options[:action] ? "#{options[:action]}_" : ""
88.       end
90.       # route方法是 path 或者是 url 方法， 没有指定默认是url
91.      def routing_type(options)
92.         options[:routing_type] || :url
93.       end
95.       # 创建route方法名 = :action + 命名空间 + 串联各个父model名 + 操作model名 + 'path'或者'url'
96.      def build_named_route_call(records, namespace, inflection, options = {})
97.         unless records.is_a?(Array)
98.           record = extract_record(records)
99.           route  = ''
100.         else
101.           record = records.pop
102.           # 拼接除了最后一个record以外的records的名字
103.           route = records.inject("") do |string, parent|
104.             string << "#{RecordIdentifier.send!("singular_class_name", parent)}_"
105.           end
106.         end
108.         route << "#{RecordIdentifier.send!("#{inflection}_class_name", record)}_"
110.         action_prefix(options) + namespace + route + routing_type(options).to_s
111.       end
113.       # 根据实例的类来获得record实例
114.      def extract_record(record_or_hash_or_array)
115.         case record_or_hash_or_array
116.           when Array; record_or_hash_or_array.last
117.           when Hash;  record_or_hash_or_array[:id]
118.           else        record_or_hash_or_array
119.         end
120.       end
121.       
122.       # 根据:action (:new 或 :edit 或 :formatted) 来获得格式
123.       def extract_format(record_or_hash_or_array, options)
124.         # 如果是formatted并且是一个Array 那么返回最后一个参数指定的格式
125.         #  formatted_polymorphic_path([@post, :pdf]) # => "/posts/1.pdf"
126.         if options[:action].to_s == "formatted" && record_or_hash_or_array.is_a?(Array)
127.           record_or_hash_or_array.pop
128.         # 如果指定了:format
129.         elsif options[:format]
130.           options[:format]
131.         else
132.           nil
133.         end
134.       end
135.       
136.       # 抽取命名空间
137.       def extract_namespace(record_or_hash_or_array)
138.         returning "" do |namespace|
139.           # 如果是一个Array
140.           if record_or_hash_or_array.is_a?(Array)
141.             # 如果包含元素是String或者Symbol，那么删除，并且拼接到空间
142.             record_or_hash_or_array.delete_if do |record_or_namespace|
143.               if record_or_namespace.is_a?(String) || record_or_namespace.is_a?(Symbol)
144.                 namespace << "#{record_or_namespace}_"
145.               end
146.             end
147.           end  
148.         end
149.       end
150.   end