Merge pull request #5310 from Serabe/layout_for_partials_with_collections

Adds :layout option to render :partial when a collection is given.

actionpack/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Rails 4.0.0 (unreleased) ##
 
+* Adds support for layouts when rendering a partial with a given collection. *serabe*
+
 * Allows the route helper `root` to take a string argument. For example, `root 'pages#main'`. *bcardarella*
 
 * Forms of persisted records use always PATCH (via the `_method` hack). *fxn*

actionpack/lib/action_view/renderer/partial_renderer.rb

@@ -158,6 +158,43 @@ module ActionView
   #     Name: <%= user.name %>
   #   </div>
   #
+  # If a collection is given, the layout will be rendered once for each item in the collection. Just think
+  # these two snippets have the same output:
+  #
+  #   <%# app/views/users/_user.html.erb %>
+  #   Name: <%= user.name %>
+  #
+  #   <%# app/views/users/index.html.erb %>
+  #   <%# This does not use layouts %>
+  #   <ul>
+  #     <% users.each do |user| -%>
+  #       <li>
+  #         <%= render :partial => "user", :locals => { :user => user } %>
+  #       </li>
+  #     <% end -%>
+  #   </ul>
+  #
+  #   <%# app/views/users/_li_layout.html.erb %>
+  #   <li>
+  #     <%= yield %>
+  #   </li>
+  #
+  #   <%# app/views/users/index.html.erb %>
+  #   <ul>
+  #     <%= render :partial => "user", :layout => "li_layout", :collection => users %>
+  #   </ul>
+  #
+  #   Given two users whose names are Alice and Bob, these snippets return:
+  #
+  #   <ul>
+  #     <li>
+  #       Name: Alice
+  #     </li>
+  #     <li>
+  #       Name: Bob
+  #     </li>
+  #   </ul>
+  #
   # You can also apply a layout to a block within any template:
   #
   #   <%# app/views/users/_chief.html.erb &>
@@ -238,7 +275,14 @@ module ActionView
         spacer = find_template(@options[:spacer_template]).render(@view, @locals)
       end
 
+      if layout = @options[:layout]
+        layout = find_template(layout)
+      end
+
       result = @template ? collection_with_template : collection_without_template
+      
+      result.map!{|content| layout.render(@view, @locals) { content } } if layout
+      
       result.join(spacer).html_safe
     end
 
@@ -342,9 +386,10 @@ module ActionView
         locals[as] = object
         segments << template.render(@view, locals)
       end
-
+      
       segments
     end
+    
 
     def collection_without_template
       segments, locals, collection_data = [], @locals, @collection_data

actionpack/test/fixtures/test/_b_layout_for_partial.html.erb

@@ -0,0 +1 @@
+<b><%= yield %></b>

actionpack/test/template/render_test.rb

@@ -238,6 +238,10 @@ module RenderTestCases
   def test_render_partial_with_nil_values_in_collection
     assert_equal "Hello: davidHello: Anonymous", @view.render(:partial => "test/customer", :collection => [ Customer.new("david"), nil ])
   end
+  
+  def test_render_partial_with_layout_using_collection_and_template
+    assert_equal "<b>Hello: Amazon</b><b>Hello: Yahoo</b>", @view.render(:partial => "test/customer", :layout => 'test/b_layout_for_partial', :collection => [ Customer.new("Amazon"), Customer.new("Yahoo") ])
+  end
 
   def test_render_partial_with_empty_array_should_return_nil
     assert_nil @view.render(:partial => [])