module SC::Helpers::TextHelper

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

Constants

Public Instance Methods

concat(string, binding) click to toggle source

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" %>
# File lib/sproutcore/helpers/text_helper.rb, line 35
def concat(string, binding)
  renderer.concat(string, binding)
end
cycle(first_value, *values) click to toggle source

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 %>
# File lib/sproutcore/helpers/text_helper.rb, line 196
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

  cycle.to_s
end
highlight(text, phrases, highlighter = '<strong class="highlight">\1</strong>') click to toggle source

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>
# 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
markdown(text) click to toggle source

Returns the text with all the Markdown codes turned into HTML tags. This method is only available if BlueCloth[http://www.deveiate.org/projects/BlueCloth] is available.

# File lib/sproutcore/helpers/text_helper.rb, line 118
def markdown(text)
  text.blank? ? "" : BlueCloth.new(text).to_html
end
pluralize(count, singular, plural = nil) click to toggle source

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
# 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") click to toggle source

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.

# File lib/sproutcore/helpers/text_helper.rb, line 215
def reset_cycle(name = "default")
  cycle = get_cycle(name)
  cycle.reset unless cycle.nil?
end
simple_format(text) click to toggle source

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.

# File lib/sproutcore/helpers/text_helper.rb, line 130
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
textilize(text) click to toggle source

Returns the text with all the Textile codes turned into HTML tags. This method is only available if RedCloth[http://whytheluckystiff.net/ruby/redcloth/] is available.

# File lib/sproutcore/helpers/text_helper.rb, line 84
def textilize(text)
  return '' if text.blank?
  textilized = RedCloth.new(text, [ :hard_breaks ])
  textilized.hard_breaks = true if textilized.respond_to?("hard_breaks=")
  textilized.to_html
end
textilize_without_paragraph(text) click to toggle source

Returns the text with all the Textile codes turned into HTML tags, but without the bounding <p> tag that RedCloth adds. This method is only available if RedCloth[http://whytheluckystiff.net/ruby/redcloth/] is available.

# File lib/sproutcore/helpers/text_helper.rb, line 95
def textilize_without_paragraph(text)
  textiled = textilize(text)
  textiled = textiled[3..-1] if textiled[0..2] == '<p>'
  textiled = textiled[0..-5] if textiled[-4..-1] == '</p>'
  textiled
end

Private Instance Methods

get_cycle(name) click to toggle source

The cycle helpers need to store the cycles in a place that is guaranteed to be reset every time a page is rendered, so it uses an instance variable of ActionView::Base.

# File lib/sproutcore/helpers/text_helper.rb, line 243
def get_cycle(name)
  @_cycles = Hash.new unless defined?(@_cycles)
  @_cycles[name]
end
set_cycle(name, cycle_object) click to toggle source
# File lib/sproutcore/helpers/text_helper.rb, line 248
def set_cycle(name, cycle_object)
  @_cycles = Hash.new unless defined?(@_cycles)
  @_cycles[name] = cycle_object
end