Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Make `content_tag_for` and `div_for` accepts the array of records #2816

Merged
merged 1 commit into from

4 participants

Prem Sichanugrist José Valim Vijay Dev Santiago Pastorino
Prem Sichanugrist
Collaborator

So instead of having to do this:

   @items.each do |item|
     content_tag_for(:li, item) do
        Title: <%= item.title %>
     end
   end

You can now do this:

   content_tag_for(:li, @items) do |item|
     Title: <%= item.title %>
   end

(Same goes for the div_for)

actionpack/lib/action_view/helpers/record_tag_helper.rb
@@ -17,6 +17,19 @@ module ActionView
#
# <div id="person_123" class="person foo"> Joe Bloggs </div>
#
+ # You can also passed an array of Active Record objects, which will then
Vijay Dev Collaborator
vijaydev added a note

s/passed/pass

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
railties/guides/source/action_view_overview.textile
@@ -454,6 +454,83 @@ input("post", "title") # =>
<input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
</ruby>
+h4. RecordTagHelper
+
+This module provides methods for generating a container tag, such as a +<div>+, for your record. This this the recommended way of creating a container for render your Active Record object, as it adds an appropriate class and id attributes to that container. You can then refer to those containers easily by following the convention, instead of having to think about which class or id attribute you should use.
Vijay Dev Collaborator
vijaydev added a note

s/This this/This is

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
railties/guides/source/action_view_overview.textile
((13 lines not shown))
+
+<ruby>
+<%= content_tag_for(:tr, @post) do %>
+ <td><%= @post.title %></td>
+<% end %>
+</ruby>
+
+This will generate this HTML output:
+
+<html>
+<tr id="post_1234" class="post">
+ <td>Hello World!</td>
+</tr>
+</html>
+
+You can also supply a HTML attributes as an additional option hash. For example:
Vijay Dev Collaborator
vijaydev added a note

remove the 'a'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
railties/guides/source/action_view_overview.textile
((29 lines not shown))
+
+<ruby>
+<%= content_tag_for(:tr, @post, :class => "frontpage") do %>
+ <td><%= @post.title %></td>
+<% end %>
+</ruby>
+
+Will generate this HTML output:
+
+<html>
+<tr id="post_1234" class="post frontpage">
+ <td>Hello World!</td>
+</tr>
+</html>
+
+Additionaly, you can pass a collection of Active Record objects. This method will loops through your objects and create a container for each of them. For example, given +@posts+ is an array of two +Post+ objects:
Vijay Dev Collaborator
vijaydev added a note

s/Additionaly/Additionally. Though I prefer, "You can also pass a collection of .. "

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Prem Sichanugrist
Collaborator

@vijaydev pull request updated as requested.

Prem Sichanugrist
Collaborator

@josevalim bro, can I have a review of this commit?

actionpack/lib/action_view/helpers/record_tag_helper.rb
@@ -53,10 +81,20 @@ module ActionView
# <li id="person_123" class="person bar">...
#
def content_tag_for(tag_name, record, prefix = nil, options = nil, &block)
- options, prefix = prefix, nil if prefix.is_a?(Hash)
- options ||= {}
- options.merge!({ :class => "#{dom_class(record, prefix)} #{options[:class]}".strip, :id => dom_id(record, prefix) })
- content_tag(tag_name, options, &block)
+ if record.respond_to?(:to_ary)
+ record.map do |single_record|
José Valim Owner

Shouldn't this be record.to_ary.map ? I don't think implementing to_ary means it implements all Enumerable methods.

Prem Sichanugrist Collaborator
sikachu added a note

Yep, I totally agree on this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
actionpack/lib/action_view/helpers/record_tag_helper.rb
@@ -53,10 +81,20 @@ module ActionView
# <li id="person_123" class="person bar">...
#
def content_tag_for(tag_name, record, prefix = nil, options = nil, &block)
José Valim Owner

For readability, maybe we could break this method into two? content_tag_for and content_tag_for_each?

Prem Sichanugrist Collaborator
sikachu added a note

What do you mean?

  1. Two private methods that performs on multiple/single objects?
  2. Retain the old method, but add another method name content_tag_for_each?
José Valim Owner

I had in mind something like this:

def content_tag_for(tag_name, record, *args, &block)
  if record.respond_to?(:to_ary)
    record.to_ary.map do |single_record|
      capture { content_tag_for_each(tag_name, single_record, *args, &block) }
    end.join("\n")
  else
    content_tag_for_each(tag_name, record, *args, &block)
  end
end

And the content_tag_for_each would do the magic (and would likely be a private method).

Prem Sichanugrist Collaborator
sikachu added a note

Then we're on the same page. Thanks for suggestion dude, changing it now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Prem Sichanugrist sikachu Make `content_tag_for` and `div_for` accepts the array of records
So instead of having to do this:

   @items.each do |item|
     content_tag_for(:li, item) do
        Title: <%= item.title %>
     end
   end

You can now do this:

   content_tag_for(:li, @items) do |item|
     Title: <%= item.title %>
   end
b84cee0
Prem Sichanugrist
Collaborator

@josevalim pull request updated.

I think it's better to change the method signature a bit too, to make sure what to expected from the variable.

José Valim josevalim merged commit 036a250 into from
José Valim
Owner

Perfect pull request: docs + code + tests. Merged.

Santiago Pastorino
Collaborator

NICE CATCH!!!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Sep 4, 2011
  1. Prem Sichanugrist

    Make `content_tag_for` and `div_for` accepts the array of records

    sikachu authored
    So instead of having to do this:
    
       @items.each do |item|
         content_tag_for(:li, item) do
            Title: <%= item.title %>
         end
       end
    
    You can now do this:
    
       content_tag_for(:li, @items) do |item|
         Title: <%= item.title %>
       end
This page is out of date. Refresh to see the latest.
16 actionpack/CHANGELOG
View
@@ -1,5 +1,21 @@
*Rails 3.2.0 (unreleased)*
+* content_tag_for and div_for can now take the collection of records. It will also yield the record as the first argument if you set a receiving argument in your block [Prem Sichanugrist]
+
+ So instead of having to do this:
+
+ @items.each do |item|
+ content_tag_for(:li, item) do
+ Title: <%= item.title %>
+ end
+ end
+
+ You can now do this:
+
+ content_tag_for(:li, @items) do |item|
+ Title: <%= item.title %>
+ end
+
* send_file now guess the mime type [Esad Hajdarevic]
* Mime type entries for PDF, ZIP and other formats were added [Esad Hajdarevic]
56 actionpack/lib/action_view/helpers/record_tag_helper.rb
View
@@ -17,6 +17,19 @@ module RecordTagHelper
#
# <div id="person_123" class="person foo"> Joe Bloggs </div>
#
+ # You can also pass an array of Active Record objects, which will then
+ # get iterates over and yield each record as an argument for the block.
+ # For example:
+ #
+ # <%= div_for(@people, :class => "foo") do |person| %>
+ # <%= person.name %>
+ # <% end %>
+ #
+ # produces:
+ #
+ # <div id="person_123" class="person foo"> Joe Bloggs </div>
+ # <div id="person_124" class="person foo"> Jane Bloggs </div>
+ #
def div_for(record, *args, &block)
content_tag_for(:div, record, *args, &block)
end
@@ -42,6 +55,21 @@ def div_for(record, *args, &block)
#
# <tr id="foo_person_123" class="person">...
#
+ # You can also pass an array of objects which this method will loop through
+ # and yield the current object to the supplied block, reduce the need for
+ # having to iterate through the object (using <tt>each</tt>) beforehand.
+ # For example (assuming @people is an array of Person objects):
+ #
+ # <%= content_tag_for(:tr, @people) do |person| %>
+ # <td><%= person.first_name %></td>
+ # <td><%= person.last_name %></td>
+ # <% end %>
+ #
+ # produces:
+ #
+ # <tr id="person_123" class="person">...</tr>
+ # <tr id="person_124" class="person">...</tr>
+ #
# content_tag_for also accepts a hash of options, which will be converted to
# additional HTML attributes. If you specify a <tt>:class</tt> value, it will be combined
# with the default class name for your object. For example:
@@ -52,12 +80,30 @@ def div_for(record, *args, &block)
#
# <li id="person_123" class="person bar">...
#
- def content_tag_for(tag_name, record, prefix = nil, options = nil, &block)
- options, prefix = prefix, nil if prefix.is_a?(Hash)
- options ||= {}
- options.merge!({ :class => "#{dom_class(record, prefix)} #{options[:class]}".strip, :id => dom_id(record, prefix) })
- content_tag(tag_name, options, &block)
+ def content_tag_for(tag_name, single_or_multiple_records, prefix = nil, options = nil, &block)
+ if single_or_multiple_records.respond_to?(:to_ary)
+ single_or_multiple_records.to_ary.map do |single_record|
+ capture { content_tag_for_single_record(tag_name, single_record, prefix, options, &block) }
+ end.join("\n")
+ else
+ content_tag_for_single_record(tag_name, single_or_multiple_records, prefix, options, &block)
+ end
end
+
+ private
+
+ # Called by <tt>content_tag_for</tt> internally to render a content tag
+ # for each record.
+ def content_tag_for_single_record(tag_name, record, prefix, options, &block)
+ options, prefix = prefix, nil if prefix.is_a?(Hash)
+ options ||= {}
+ options.merge!({ :class => "#{dom_class(record, prefix)} #{options[:class]}".strip, :id => dom_id(record, prefix) })
+ if block.arity == 0
+ content_tag(tag_name, capture(&block), options)
+ else
+ content_tag(tag_name, capture(record, &block), options)
+ end
+ end
end
end
end
24 actionpack/test/template/record_tag_helper_test.rb
View
@@ -4,11 +4,12 @@
class Post
extend ActiveModel::Naming
include ActiveModel::Conversion
+ attr_writer :id, :body
def id
- 45
+ @id || 45
end
def body
- super || "What a wonderful world!"
+ super || @body || "What a wonderful world!"
end
end
@@ -58,4 +59,23 @@ def test_div_for_in_erb
actual = div_for(@post, :class => "bar") { concat @post.body }
assert_dom_equal expected, actual
end
+
+ def test_content_tag_for_collection
+ post_1 = Post.new.tap { |post| post.id = 101; post.body = "Hello!"; post.persisted = true }
+ post_2 = Post.new.tap { |post| post.id = 102; post.body = "World!"; post.persisted = true }
+ expected = %(<li class="post" id="post_101">Hello!</li>\n<li class="post" id="post_102">World!</li>)
+ actual = content_tag_for(:li, [post_1, post_2]) { |post| concat post.body }
+ assert_dom_equal expected, actual
+ end
+
+ def test_content_tag_for_collection_is_html_safe
+ end
+
+ def test_div_for_collection
+ post_1 = Post.new.tap { |post| post.id = 101; post.body = "Hello!"; post.persisted = true }
+ post_2 = Post.new.tap { |post| post.id = 102; post.body = "World!"; post.persisted = true }
+ expected = %(<div class="post" id="post_101">Hello!</div>\n<div class="post" id="post_102">World!</div>)
+ actual = div_for([post_1, post_2]) { |post| concat post.body }
+ assert_dom_equal expected, actual
+ end
end
77 railties/guides/source/action_view_overview.textile
View
@@ -454,6 +454,83 @@ input("post", "title") # =>
<input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
</ruby>
+h4. RecordTagHelper
+
+This module provides methods for generating a container tag, such as a +<div>+, for your record. This is the recommended way of creating a container for render your Active Record object, as it adds an appropriate class and id attributes to that container. You can then refer to those containers easily by following the convention, instead of having to think about which class or id attribute you should use.
+
+h5. content_tag_for
+
+Renders a container tag that relates to your Active Record Object.
+
+For example, given +@post+ is the object of +Post+ class, you can do:
+
+<ruby>
+<%= content_tag_for(:tr, @post) do %>
+ <td><%= @post.title %></td>
+<% end %>
+</ruby>
+
+This will generate this HTML output:
+
+<html>
+<tr id="post_1234" class="post">
+ <td>Hello World!</td>
+</tr>
+</html>
+
+You can also supply HTML attributes as an additional option hash. For example:
+
+<ruby>
+<%= content_tag_for(:tr, @post, :class => "frontpage") do %>
+ <td><%= @post.title %></td>
+<% end %>
+</ruby>
+
+Will generate this HTML output:
+
+<html>
+<tr id="post_1234" class="post frontpage">
+ <td>Hello World!</td>
+</tr>
+</html>
+
+You can pass a collection of Active Record objects. This method will loops through your objects and create a container for each of them. For example, given +@posts+ is an array of two +Post+ objects:
+
+<ruby>
+<%= content_tag_for(:tr, @posts) do |post| %>
+ <td><%= post.title %></td>
+<% end %>
+</ruby>
+
+Will generate this HTML output:
+
+<html>
+<tr id="post_1234" class="post">
+ <td>Hello World!</td>
+</tr>
+<tr id="post_1235" class="post">
+ <td>Ruby on Rails Rocks!</td>
+</tr>
+</html>
+
+h5. div_for
+
+This is actually a convenient method which calls +content_tag_for+ internally with +:div+ as the tag name. You can pass either an Active Record object or a collection of objects. For example:
+
+<ruby>
+<%= div_for(@post, :class => "frontpage") do %>
+ <td><%= @post.title %></td>
+<% end %>
+</ruby>
+
+Will generate this HTML output:
+
+<html>
+<div id="post_1234" class="post frontpage">
+ <td>Hello World!</td>
+</div>
+</html>
+
h4. AssetTagHelper
This module provides methods for generating HTML that links views to assets such as images, JavaScript files, stylesheets, and feeds.
Something went wrong with that request. Please try again.