Module: ActionView::Helpers::TextHelper
- Defined in:
- lib/action_view/helpers/text_helper.rb
Overview
The TextHelper module provides a set of methods for filtering, formatting and transforming strings, which can reduce the amount of inline Ruby code in your views. These helper methods extend ActionView making them callable within your template files.
Defined Under Namespace
Classes: Cycle
Constant Summary collapse
- AUTO_LINK_RE =
%r{ ( # leading text <\w+.*?>| # leading HTML tag, or [^=!:'"/]| # leading punctuation, or ^ # beginning of line ) ( (?:https?://)| # protocol spec, or (?:www\.) # www.* ) ( [-\w]+ # subdomain or domain (?:\.[-\w]+)* # remaining subdomains or domain (?::\d+)? # port (?:/(?:(?:[~\w\+@%=\(\)-]|(?:[,.;:'][^\s$]))+)?)* # path (?:\?[\w\+@%&=.;-]+)? # query string (?:\#[\w\-]*)? # trailing anchor ) ([[:punct:]]|<|$|) # trailing text }x
Instance Method Summary collapse
-
#auto_link(text, link = :all, href_options = {}, &block) ⇒ Object
Turns all URLs and e-mail addresses into clickable links.
-
#concat(string, binding) ⇒ Object
The preferred method of outputting text in your views is to use the <%= “text” %> eRuby syntax.
-
#cycle(first_value, *values) ⇒ Object
Creates a Cycle object whose to_s method cycles through elements of an array every time it is called.
-
#excerpt(text, phrase, radius = 100, excerpt_string = "...") ⇒ Object
:nodoc:.
-
#highlight(text, phrases, highlighter = '<strong class="highlight">\1</strong>') ⇒ Object
Highlights one or more
phrases
everywhere intext
by inserting it into ahighlighter
string. -
#pluralize(count, singular, plural = nil) ⇒ Object
Attempts to pluralize the
singular
word unlesscount
is 1. -
#reset_cycle(name = "default") ⇒ Object
Resets a cycle so that it starts from the first element the next time it is called.
-
#simple_format(text, html_options = {}) ⇒ Object
Returns
text
transformed into HTML using simple formatting rules. -
#truncate(text, length = 30, truncate_string = "...") ⇒ Object
:nodoc:.
-
#word_wrap(text, line_width = 80) ⇒ Object
Wraps the
text
into lines no longer thanline_width
width.
Instance Method Details
#auto_link(text, link = :all, href_options = {}, &block) ⇒ Object
Turns all URLs and e-mail addresses into clickable links. The link
parameter will limit what should be linked. You can add HTML attributes to the links using href_options
. Options for link
are :all
(default), :email_addresses
, and :urls
. If a block is given, each URL and e-mail address is yielded and the result is used as the link text.
Examples
auto_link("Go to http://www.rubyonrails.org and say hello to [email protected]")
# => "Go to <a href=\"http://www.rubyonrails.org\">http://www.rubyonrails.org</a> and
# say hello to <a href=\"mailto:[email protected]\">[email protected]</a>"
auto_link("Visit http://www.loudthinking.com/ or e-mail [email protected]", :urls)
# => "Visit <a href=\"http://www.loudthinking.com/\">http://www.loudthinking.com/</a>
# or e-mail [email protected]"
auto_link("Visit http://www.loudthinking.com/ or e-mail [email protected]", :email_addresses)
# => "Visit http://www.loudthinking.com/ or e-mail <a href=\"mailto:[email protected]\">[email protected]</a>"
post_body = "Welcome to my new blog at http://www.myblog.com/. Please e-mail me at [email protected]."
auto_link(post_body, :all, :target => '_blank') do |text|
truncate(text, 15)
end
# => "Welcome to my new blog at <a href=\"http://www.myblog.com/\" target=\"_blank\">http://www.m...</a>.
Please e-mail me at <a href=\"mailto:[email protected]\">[email protected]</a>."
335 336 337 338 339 340 341 342 |
# File 'lib/action_view/helpers/text_helper.rb', line 335 def auto_link(text, link = :all, = {}, &block) return '' if text.blank? case link when :all then auto_link_email_addresses(auto_link_urls(text, , &block), &block) when :email_addresses then auto_link_email_addresses(text, &block) when :urls then auto_link_urls(text, , &block) end end |
#concat(string, binding) ⇒ Object
The preferred method of outputting text in your views is to use the <%= “text” %> eRuby syntax. The regular puts and print methods do not operate as expected in an eRuby code block. If you absolutely must output text within a non-output code block (i.e., <% %>), you can use the concat method.
Examples
<%
concat "hello", binding
# is the equivalent of <%= "hello" %>
if (logged_in == true):
concat "Logged in!", binding
else
concat link_to('login', :action => login), binding
end
# will either display "Logged in!" or a login link
%>
28 29 30 |
# File 'lib/action_view/helpers/text_helper.rb', line 28 def concat(string, binding) eval(ActionView::Base.erb_variable, binding) << string end |
#cycle(first_value, *values) ⇒ Object
Creates a Cycle object whose to_s method cycles through elements of an array every time it is called. This can be used for example, to alternate classes for table rows. You can use named cycles to allow nesting in loops. Passing a Hash as the last parameter with a :name
key will create a named cycle. You can manually reset a cycle by calling reset_cycle and passing the name of the cycle.
Examples
# Alternate CSS classes for even and odd numbers...
@items = [1,2,3,4]
<table>
<% @items.each do |item| %>
<tr class="<%= cycle("even", "odd") -%>">
<td>item</td>
</tr>
<% end %>
</table>
# Cycle CSS classes for rows, and text colors for values within each row
@items = x = [{:first => 'Robert', :middle => 'Daniel', :last => 'James'},
{:first => 'Emily', :middle => 'Shannon', :maiden => 'Pike', :last => 'Hicks'},
{:first => 'June', :middle => 'Dae', :last => 'Jones'}]
<% @items.each do |item| %>
<tr class="<%= cycle("even", "odd", :name => "row_class") -%>">
<td>
<% item.values.each do |value| %>
<%# Create a named cycle "colors" %>
<span style="color:<%= cycle("red", "green", "blue", :name => "colors") -%>">
<%= value %>
</span>
<% end %>
<% reset_cycle("colors") %>
</td>
</tr>
<% end %>
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/action_view/helpers/text_helper.rb', line 380 def cycle(first_value, *values) if (values.last.instance_of? Hash) params = values.pop name = params[:name] else name = "default" end values.unshift(first_value) cycle = get_cycle(name) if (cycle.nil? || cycle.values != values) cycle = set_cycle(name, Cycle.new(*values)) end return cycle.to_s end |
#excerpt(text, phrase, radius = 100, excerpt_string = "...") ⇒ Object
:nodoc:
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/action_view/helpers/text_helper.rb', line 113 def excerpt(text, phrase, radius = 100, excerpt_string = "...") if text && phrase phrase = Regexp.escape(phrase) if found_pos = text.chars =~ /(#{phrase})/i start_pos = [ found_pos - radius, 0 ].max end_pos = [ [ found_pos + phrase.chars.length + radius - 1, 0].max, text.chars.length ].min prefix = start_pos > 0 ? excerpt_string : "" postfix = end_pos < text.chars.length - 1 ? excerpt_string : "" prefix + text.chars[start_pos..end_pos].strip + postfix else nil end end end |
#highlight(text, phrases, highlighter = '<strong class="highlight">\1</strong>') ⇒ Object
Highlights one or more phrases
everywhere in text
by inserting it into a highlighter
string. The highlighter can be specialized by passing highlighter
as a single-quoted string with 1 where the phrase is to be inserted (defaults to ‘<strong class=“highlight”>1</strong>’)
Examples
highlight('You searched for: rails', 'rails')
# => You searched for: <strong class="highlight">rails</strong>
highlight('You searched for: ruby, rails, dhh', 'actionpack')
# => You searched for: ruby, rails, dhh
highlight('You searched for: rails', ['for', 'rails'], '<em>\1</em>')
# => You searched <em>for</em>: <em>rails</em>
highlight('You searched for: rails', 'rails', "<a href='search?q=\1'>\1</a>")
# => You searched for: <a href='search?q=rails>rails</a>
82 83 84 85 86 87 88 89 |
# File 'lib/action_view/helpers/text_helper.rb', line 82 def highlight(text, phrases, highlighter = '<strong class="highlight">\1</strong>') if text.blank? || phrases.blank? text else match = Array(phrases).map { |p| Regexp.escape(p) }.join('|') text.gsub(/(#{match})/i, highlighter) end end |
#pluralize(count, singular, plural = nil) ⇒ Object
Attempts to pluralize the singular
word unless count
is 1. If plural
is supplied, it will use that when count is > 1, otherwise it will use the Inflector to determine the plural form
Examples
pluralize(1, 'person')
# => 1 person
pluralize(2, 'person')
# => 2 people
pluralize(3, 'person', 'users')
# => 3 users
pluralize(0, 'person')
# => 0 people
166 167 168 |
# File 'lib/action_view/helpers/text_helper.rb', line 166 def pluralize(count, singular, plural = nil) "#{count || 0} " + ((count == 1 || count == '1') ? singular : (plural || singular.pluralize)) end |
#reset_cycle(name = "default") ⇒ Object
Resets a cycle so that it starts from the first element the next time it is called. Pass in name
to reset a named cycle.
Example
# Alternate CSS classes for even and odd numbers...
@items = [[1,2,3,4], [5,6,3], [3,4,5,6,7,4]]
<table>
<% @items.each do |item| %>
<tr class="<%= cycle("even", "odd") -%>">
<% item.each do |value| %>
<span style="color:<%= cycle("#333", "#666", "#999", :name => "colors") -%>">
<%= value %>
</span>
<% end %>
<% reset_cycle("colors") %>
</tr>
<% end %>
</table>
415 416 417 418 |
# File 'lib/action_view/helpers/text_helper.rb', line 415 def reset_cycle(name = "default") cycle = get_cycle(name) cycle.reset unless cycle.nil? end |
#simple_format(text, html_options = {}) ⇒ Object
Returns text
transformed into HTML using simple formatting rules. Two or more consecutive newlines(\n\n
) are considered as a paragraph and wrapped in <p>
tags. One newline (\n
) is considered as a linebreak and a <br />
tag is appended. This method does not remove the newlines from the text
.
You can pass any HTML attributes into html_options
. These will be added to all created paragraphs.
Examples
my_text = "Here is some basic text...\n...with a line break."
simple_format(my_text)
# => "<p>Here is some basic text...\n<br />...with a line break.</p>"
more_text = "We want to put a paragraph...\n\n...right there."
simple_format(more_text)
# => "<p>We want to put a paragraph...</p>\n\n<p>...right there.</p>"
simple_format("Look ma! A class!", :class => 'description')
# => "<p class='description'>Look ma! A class!</p>"
300 301 302 303 304 305 306 307 308 |
# File 'lib/action_view/helpers/text_helper.rb', line 300 def simple_format(text, ={}) start_tag = tag('p', , true) text = text.to_s.dup text.gsub!(/\r\n?/, "\n") # \r\n and \r -> \n text.gsub!(/\n\n+/, "</p>\n\n#{start_tag}") # 2+ newline -> paragraph text.gsub!(/([^\n]\n)(?=[^\n])/, '\1<br />') # 1 newline -> br text.insert 0, start_tag text << "</p>" end |
#truncate(text, length = 30, truncate_string = "...") ⇒ Object
:nodoc:
49 50 51 52 53 54 55 |
# File 'lib/action_view/helpers/text_helper.rb', line 49 def truncate(text, length = 30, truncate_string = "...") if text l = length - truncate_string.chars.length chars = text.chars (chars.length > length ? chars[0...l] + truncate_string : text).to_s end end |
#word_wrap(text, line_width = 80) ⇒ Object
Wraps the text
into lines no longer than line_width
width. This method breaks on the first whitespace character that does not exceed line_width
(which is 80 by default).
Examples
word_wrap('Once upon a time', 4)
# => Once\nupon\na\ntime
word_wrap('Once upon a time', 8)
# => Once upon\na time
word_wrap('Once upon a time')
# => Once upon a time
word_wrap('Once upon a time', 1)
# => Once\nupon\na\ntime
186 187 188 189 190 |
# File 'lib/action_view/helpers/text_helper.rb', line 186 def word_wrap(text, line_width = 80) text.split("\n").collect do |line| line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line end * "\n" end |