Module: SC::Helpers::TextHelper

Included in:
Builder::Html
Defined in:
lib/sproutcore/helpers/text_helper.rb

Overview

The TextHelper Module provides a set of methods for filtering, formatting and transforming strings that can reduce the amount of inline Ruby code in your views. These helper methods extend ActionView making them callable within your template files as shown in the following example which truncates the title of each post to 10 characters.

<% @posts.each do |post| %>
  # post == 'This is my title'
  Title: <%= truncate(post.title, 10) %>
<% end %>
 => Title: This is my...

Defined Under Namespace

Classes: Cycle

Constant Summary collapse 

%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:]]|\s|<|$)       # trailing text
}x

Instance Method Summary collapse

Instance Method Details

Turns all urls and email 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.

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>

If a block is given, each url and email address is yielded and the result is used as the link text.

auto_link(post.body, :all, :target => '_blank') do |text|
  truncate(text, 15)
end



155
156
157
158
159
160
161
162
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 155

def auto_link(text, link = :all, href_options = {}, &block)
  return '' if text.blank?
  case link
    when :all             then auto_link_urls(auto_link_email_addresses(text, &block), href_options, &block)
    when :email_addresses then auto_link_email_addresses(text, &block)
    when :urls            then auto_link_urls(text, href_options, &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 code block, you can use the concat method.

<% concat "hello", binding %>

is equivalent to using:

<%= "hello" %>



35
36
37
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 35

def concat(string, binding)
  renderer.concat(string, binding)
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:

<% @items.each do |item| %>
  <tr class="<%= cycle("even", "odd") -%>">
    <td>item</td>
  </tr>
<% end %>

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.

 <% @items.each do |item| %>
   <tr class="<%= cycle("even", "odd", :name => "row_class")
     <td>
       <% item.values.each do |value| %>
         <span style="color:<%= cycle("red", "green", "blue", :name => "colors") -%>">
           value
         </span>
       <% end %>
       <% reset_cycle("colors") %>
     </td>
  </tr>
<% end %>



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 199

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

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

highlight('You searched for: rails', 'rails')
# => You searched for: <strong class="highlight">rails</strong>

highlight('You searched for: rails', ['for', 'rails'], '<em>\1</em>')
# => You searched <em>for</em>: <em>rails</em>



48
49
50
51
52
53
54
55
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 48

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, if the ActiveSupport Inflector is loaded, it will use the Inflector to determine the plural form, otherwise it will just add an ‘s’ to the singular word.

pluralize(1, 'person')  => 1 person
pluralize(2, 'person')  => 2 people
pluralize(3, 'person', 'users')  => 3 users



65
66
67
68
69
70
71
72
73
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 65

def pluralize(count, singular, plural = nil)
   "#{count || 0} " + if count == 1 || count == '1'
    singular
  elsif plural
    plural
  else
    singular.plural
  end
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.



217
218
219
220
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 217

def reset_cycle(name = "default")
  cycle = get_cycle(name)
  cycle.reset unless cycle.nil?
end

#simple_format(text) ⇒ 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.



133
134
135
136
137
138
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 133

def simple_format(text)
  content_tag 'p', text.to_s.
    gsub(/\r\n?/, "\n").                    # \r\n and \r -> \n
    gsub(/\n\n+/, "</p>\n\n<p>").           # 2+ newline  -> paragraph
    gsub(/([^\n]\n)(?=[^\n])/, '\1<br />')  # 1 newline   -> br
end

#strip_links(text) ⇒ Object

Strips link tags from text leaving just the link label.

strip_links('<a href="http://www.rubyonrails.org">Ruby on Rails</a>')
 => Ruby on Rails



168
169
170
 
# File 'lib/sproutcore/helpers/text_helper.rb', line 168

def strip_links(text)
  text.gsub(/<a\b.*?>(.*?)<\/a>/mi, '\1')
end