Module: ActionView::Helpers::TextHelper
- Defined in:
- lib/action_view/helpers/text_helper.rb
Overview
Provides a set of methods for working with text strings that can help unburden the level of inline Ruby code in the templates. In the example below we iterate over a collection of posts provided to the template and prints each title after making sure it doesn’t run longer than 20 characters:
<% for post in @posts %>
Title: <%= truncate(post.title, 20) %>
<% end %>
Constant Summary collapse
- VERBOTEN_TAGS =
%w(form script)
- VERBOTEN_ATTRS =
/^on/i
Instance Method Summary collapse
-
#auto_link(text, link = :all, href_options = {}) ⇒ Object
Turns all urls and email addresses into clickable links.
-
#concat(string, binding) ⇒ Object
The regular puts and print are outlawed in eRuby.
-
#excerpt(text, phrase, radius = 100, excerpt_string = "...") ⇒ Object
Extracts an excerpt from the
text
surrounding thephrase
with a number of characters on each side determined byradius
. -
#highlight(text, phrase, highlighter = '<strong class="highlight">\1</strong>') ⇒ Object
Highlights the
phrase
where it is found in thetext
by surrounding it like <strong class=“highlight”>I’m a highlight phrase</strong>. -
#pluralize(count, singular, plural = nil) ⇒ Object
Attempts to pluralize the
singular
word unlesscount
is 1. -
#sanitize(html) ⇒ Object
Sanitizes the given HTML by making form and script tags into regular text, and removing all “onxxx” attributes (so that arbitrary Javascript cannot be executed).
-
#simple_format(text) ⇒ Object
Returns
text
transformed into html using very simple formatting rules Surrounds paragraphs with<p>
tags, and converts line breaks into<br />
Two consecutive newlines(\n\n
) are considered as a paragraph, one newline (\n
) is considered a linebreak, three or more consecutive newlines are turned into two newlines. -
#strip_links(text) ⇒ Object
Turns all links into words, like “<a href=”something“>else</a>” to “else”.
-
#truncate(text, length = 30, truncate_string = "...") ⇒ Object
Truncates
text
to the length oflength
and replaces the last three characters with thetruncate_string
if thetext
is longer thanlength
. -
#word_wrap(text, line_width = 80) ⇒ Object
Word wrap long lines to line_width.
Instance Method Details
#auto_link(text, link = :all, href_options = {}) ⇒ Object
Turns all urls and email addresses into clickable links. The link
parameter can limit what should be linked. Options are :all (default), :email_addresses, and :urls.
Example:
auto_link("Go to http://www.rubyonrails.com and say hello to [email protected]") =>
Go to <a href="http://www.rubyonrails.com">http://www.rubyonrails.com</a> and
say hello to <a href="mailto:[email protected]">[email protected]</a>
126 127 128 129 130 131 132 |
# File 'lib/action_view/helpers/text_helper.rb', line 126 def auto_link(text, link = :all, = {}) case link when :all then auto_link_urls(auto_link_email_addresses(text), ) when :email_addresses then auto_link_email_addresses(text) when :urls then auto_link_urls(text, ) end end |
#concat(string, binding) ⇒ Object
The regular puts and print are outlawed in eRuby. It’s recommended to use the <%= “hello” %> form instead of print “hello”. If you absolutely must use a method-based output, you can use concat. It’s use like this <% concat “hello”, binding %>. Notice that it doesn’t have an equal sign in front. Using <%= concat “hello” %> would result in a double hello.
15 16 17 |
# File 'lib/action_view/helpers/text_helper.rb', line 15 def concat(string, binding) eval("_erbout", binding).concat(string) end |
#excerpt(text, phrase, radius = 100, excerpt_string = "...") ⇒ Object
Extracts an excerpt from the text
surrounding the phrase
with a number of characters on each side determined by radius
. If the phrase isn’t found, nil is returned. Ex:
excerpt("hello my world", "my", 3) => "...lo my wo..."
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/action_view/helpers/text_helper.rb', line 38 def excerpt(text, phrase, radius = 100, excerpt_string = "...") if text.nil? || phrase.nil? then return end phrase = escape_regexp(phrase) if found_pos = text =~ /(#{phrase})/i start_pos = [ found_pos - radius, 0 ].max end_pos = [ found_pos + phrase.length + radius, text.length ].min prefix = start_pos > 0 ? excerpt_string : "" postfix = end_pos < text.length ? excerpt_string : "" prefix + text[start_pos..end_pos].strip + postfix else nil end end |
#highlight(text, phrase, highlighter = '<strong class="highlight">\1</strong>') ⇒ Object
Highlights the phrase
where it is found in the text
by surrounding it like <strong class=“highlight”>I’m a highlight phrase</strong>. The highlighter can be specialized by passing highlighter
as single-quoted string with 1 where the phrase is supposed to be inserted. N.B.: The phrase
is sanitized to include only letters, digits, and spaces before use.
30 31 32 33 |
# File 'lib/action_view/helpers/text_helper.rb', line 30 def highlight(text, phrase, highlighter = '<strong class="highlight">\1</strong>') if phrase.blank? then return text end text.gsub(/(#{escape_regexp(phrase)})/i, highlighter) unless text.nil? end |
#pluralize(count, singular, plural = nil) ⇒ Object
Attempts to pluralize the singular
word unless count
is 1. See source for pluralization rules.
56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/action_view/helpers/text_helper.rb', line 56 def pluralize(count, singular, plural = nil) "#{count} " + if count == 1 singular elsif plural plural elsif Object.const_defined?("Inflector") Inflector.pluralize(singular) else singular + "s" end end |
#sanitize(html) ⇒ Object
Sanitizes the given HTML by making form and script tags into regular text, and removing all “onxxx” attributes (so that arbitrary Javascript cannot be executed). Also removes href attributes that start with “javascript:”.
Returns the sanitized text.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/action_view/helpers/text_helper.rb', line 161 def sanitize(html) # only do this if absolutely necessary if html.index("<") tokenizer = HTML::Tokenizer.new(html) new_text = "" while token = tokenizer.next node = HTML::Node.parse(nil, 0, 0, token, false) new_text << case node when HTML::Tag if VERBOTEN_TAGS.include?(node.name) node.to_s.gsub(/</, "<") else if node.closing != :close node.attributes.delete_if { |attr,v| attr =~ VERBOTEN_ATTRS } if node.attributes["href"] =~ /^javascript:/i node.attributes.delete "href" end end node.to_s end else node.to_s.gsub(/</, "<") end end html = new_text end html end |
#simple_format(text) ⇒ Object
Returns text
transformed into html using very simple formatting rules Surrounds paragraphs with <p>
tags, and converts line breaks into <br />
Two consecutive newlines(\n\n
) are considered as a paragraph, one newline (\n
) is considered a linebreak, three or more consecutive newlines are turned into two newlines
110 111 112 113 114 115 116 117 |
# File 'lib/action_view/helpers/text_helper.rb', line 110 def simple_format(text) text.gsub!(/(\r\n|\n|\r)/, "\n") # lets make them newlines crossplatform text.gsub!(/\n\n+/, "\n\n") # zap dupes text.gsub!(/\n\n/, '</p>\0<p>') # turn two newlines into paragraph text.gsub!(/([^\n])(\n)([^\n])/, '\1\2<br />\3') # turn single newline into <br /> return '<p>' + text + '</p>' # wrap the first and last line in paragraphs before we're done end |
#strip_links(text) ⇒ Object
Turns all links into words, like “<a href=”something“>else</a>” to “else”.
135 136 137 |
# File 'lib/action_view/helpers/text_helper.rb', line 135 def strip_links(text) text.gsub(/<a.*>(.*)<\/a>/m, '\1') end |
#truncate(text, length = 30, truncate_string = "...") ⇒ Object
Truncates text
to the length of length
and replaces the last three characters with the truncate_string
if the text
is longer than length
.
21 22 23 24 |
# File 'lib/action_view/helpers/text_helper.rb', line 21 def truncate(text, length = 30, truncate_string = "...") if text.nil? then return end if text.length > length then text[0..(length - 3)] + truncate_string else text end end |
#word_wrap(text, line_width = 80) ⇒ Object
Word wrap long lines to line_width.
69 70 71 |
# File 'lib/action_view/helpers/text_helper.rb', line 69 def word_wrap(text, line_width = 80) text.gsub(/\n/, "\n\n").gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip end |