module ActionView::Helpers::TextHelper

def auto_link(text, *args, &block)#link = :all, html = {}, &block)

link = :all, html = {}, &block)
Please e-mail me at me@email.com."
# => "Welcome to my new blog at http://www.myblog.com.
auto_link(post_body, :all, :target => "_blank") # => Once upon\na time

Please e-mail me at me@email.com."
# => "Welcome to my new blog at http://www.myblog.com.
auto_link(post_body, :urls) # => Once upon\na time
post_body = "Welcome to my new blog at http://www.myblog.com/. Please e-mail me at me@email.com."
as its optional third parameter:
+link+ as its optional second parameter and the +html_options+ hash
You can still use auto_link with the old API that accepts the


Please e-mail me at me@email.com."
# => "Welcome to my new blog at http://www.m....
end
truncate(text, 15)
auto_link(post_body, :html => { :target => '_blank' }) do |text|
post_body = "Welcome to my new blog at http://www.myblog.com/. Please e-mail me at me@email.com."

# => "Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com"
auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :link => :email_addresses)

# or e-mail david@loudthinking.com"
# => "Visit http://www.loudthinking.com/
auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :link => :urls)

# say hello to david@loudthinking.com"
# => "Go to http://www.rubyonrails.org and
auto_link("Go to http://www.rubyonrails.org and say hello to david@loudthinking.com")
==== Examples

e-mail address is yielded and the result is used as the link text.
:email_addresses, and :urls. If a block is given, each URL and
:html. Possible values for :link are :all (default),
will limit what should be linked. You can add HTML attributes to the links using
Turns all URLs and e-mail addresses into clickable links. The :link option
def auto_link(text, *args, &block)#link = :all, html = {}, &block)
  return '' if text.blank?
  options = args.size == 2 ? {} : args.extract_options! # this is necessary because the old auto_link API has a Hash as its last parameter
  unless args.empty?
    options[:link] = args[0] || :all
    options[:html] = args[1] || {}
  end
  options.reverse_merge!(:link => :all, :html => {})
  case options[:link].to_sym
    when :all                         then auto_link_email_addresses(auto_link_urls(text, options[:html], options, &block), options[:html], &block)
    when :email_addresses             then auto_link_email_addresses(text, options[:html], &block)
    when :urls                        then auto_link_urls(text, options[:html], options, &block)
  end
end

def auto_link_email_addresses(text, html_options = {}, options = {})

each email is yielded and the result is used as the link text.
Turns all email addresses into clickable links. If a block is given,
def auto_link_email_addresses(text, html_options = {}, options = {})
  text.to_str.gsub(AUTO_EMAIL_RE) do
    text = $&
    if auto_linked?($`, $')
      text.html_safe
    else
      display_text = block_given? ? yield(text) : text
      display_text = sanitize(display_text) unless options[:sanitize] == false
      mail_to text, display_text, html_options
    end
  end
end

def auto_link_urls(text, html_options = {}, options = {})

is yielded and the result is used as the link text.
Turns all urls into clickable links. If a block is given, each url
def auto_link_urls(text, html_options = {}, options = {})
  link_attributes = html_options.stringify_keys
  text.to_str.gsub(AUTO_LINK_RE) do
    scheme, href = $1, $&
    punctuation = []
    if auto_linked?($`, $')
      # do not change string; URL is already linked
      href
    else
      # don't include trailing punctuation character as part of the URL
      while href.sub!(/[^\w\/-]$/, '')
        punctuation.push $&
        if opening = BRACKETS[punctuation.last] and href.scan(opening).size > href.scan(punctuation.last).size
          href << punctuation.pop
          break
        end
      end
      link_text = block_given? ? yield(href) : href
      href = 'http://' + href unless scheme
      sanitize = options[:sanitize] != false
      content_tag(:a, link_text, link_attributes.merge('href' => href), sanitize) + punctuation.reverse.join('')
    end
  end
end

def auto_linked?(left, right)

Detects already linked context or position in the middle of a tag
def auto_linked?(left, right)
  (left =~ AUTO_LINK_CRE[0] and right =~ AUTO_LINK_CRE[1]) or
    (left.rindex(AUTO_LINK_CRE[2]) and $' !~ AUTO_LINK_CRE[3])
end

def concat(string)

%>
# will either display "Logged in!" or a login link
end
concat link_to('login', :action => login)
else
concat "Logged in!"
if logged_in

# is the equivalent of <%= "hello" %>
concat "hello"
<%
==== Examples

output text within a non-output code block (i.e., <% %>), you can use the concat method.
do not operate as expected in an eRuby code block. If you absolutely must
<%= "text" %> eRuby syntax. The regular _puts_ and _print_ methods
The preferred method of outputting text in your views is to use the
def concat(string)
  output_buffer << string
end

def current_cycle(name = "default")

<% end %>

<%= item %>
">
<% @items.each do |item| %>
@items = [1,2,3,4]
# Alternate background colors
==== Example

the current cycle string in more than one place.
for complex table highlighting or any other design need which requires
Returns the current cycle string after a cycle has been started. Useful
def current_cycle(name = "default")
  cycle = get_cycle(name)
  cycle.current_value unless cycle.nil?
end

def cycle(first_value, *values)

<% end %>


<% reset_cycle("colors") %>
<% end %>

<%= value %>
"colors") -%>">
<%# Create a named cycle "colors" %>
<% item.values.each do |value| %>

"row_class") -%>">
<% @items.each do |item| %>
{:first => 'June', :middle => 'Dae', :last => 'Jones'}]
{:first => 'Emily', :middle => 'Shannon', :maiden => 'Pike', :last => 'Hicks'},
@items = x = [{:first => 'Robert', :middle => 'Daniel', :last => 'James'},
# Cycle CSS classes for rows, and text colors for values within each row



<% end %>

item
">
<% @items.each do |item| %>

@items = [1,2,3,4]
# Alternate CSS classes for even and odd numbers...
==== Examples

anytime using the current_cycle method.
and passing the name of the cycle. The current cycle string can be obtained
"default". You can manually reset a cycle by calling reset_cycle
named cycle. The default name for a cycle without a +:name+ key is
Passing a Hash as the last parameter with a :name key will create a
classes for table rows. You can use named cycles to allow nesting in loops.
array every time it is called. This can be used for example, to alternate
Creates a Cycle object whose _to_s_ method cycles through elements of an
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

def excerpt(text, phrase, *args)

excerpt('This is also an example', 'an', 8, ' ') # => is also an example
excerpt('This is an example', 'an', 5) # => ...s is an exam...
optional forth parameter:
+radius+ as its optional third and the +ellipsis+ as its
You can still use excerpt with the old API that accepts the

# => is also an example
excerpt('This is also an example', 'an', :radius => 8, :omission => ' ')

# => ...next...
excerpt('This next thing is an example', 'ex', :radius => 2)

# => This is an example
excerpt('This is an example', 'is')

# => This is a...
excerpt('This is an example', 'is', :radius => 5)

# => ...s is an exam...
excerpt('This is an example', 'an', :radius => 5)
==== Examples

will be stripped in any case. If the +phrase+ isn't found, nil is returned.
then the :omission option (which defaults to "...") will be prepended/appended accordingly. The resulting string
defined in :radius (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+,
The :radius option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters
Extracts an excerpt from +text+ that matches the first instance of +phrase+.
def excerpt(text, phrase, *args)
  options = args.extract_options!
  unless args.empty?
    options[:radius] = args[0] || 100
    options[:omission] = args[1] || "..."
  end
  options.reverse_merge!(:radius => 100, :omission => "...")
  if text && phrase
    phrase = Regexp.escape(phrase)
    if found_pos = text.mb_chars =~ /(#{phrase})/i
      start_pos = [ found_pos - options[:radius], 0 ].max
      end_pos   = [ [ found_pos + phrase.mb_chars.length + options[:radius] - 1, 0].max, text.mb_chars.length ].min
      prefix  = start_pos > 0 ? options[:omission] : ""
      postfix = end_pos < text.mb_chars.length - 1 ? options[:omission] : ""
      prefix + text.mb_chars[start_pos..end_pos].strip + postfix
    else
      nil
    end
  end
end

def get_cycle(name)

uses an instance variable of ActionView::Base.
guaranteed to be reset every time a page is rendered, so it
The cycle helpers need to store the cycles in a place that is
def get_cycle(name)
  @_cycles = Hash.new unless defined?(@_cycles)
  return @_cycles[name]
end

def highlight(text, phrases, *args)

highlight('You searched for: rails', 'rails', '\1') # => You searched for: rails
+highlighter+ as its optional third parameter:
You can still use highlight with the old API that accepts the

# => You searched for: rails
highlight('You searched for: rails', 'rails', :highlighter => '\1')

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

# => You searched for: ruby, rails, dhh
highlight('You searched for: ruby, rails, dhh', 'actionpack')

# => You searched for: rails
highlight('You searched for: rails', 'rails')
==== Examples

'\1')
as a single-quoted string with \1 where the phrase is to be inserted (defaults to
a :highlighter string. The highlighter can be specialized by passing :highlighter
Highlights one or more +phrases+ everywhere in +text+ by inserting it into
def highlight(text, phrases, *args)
  options = args.extract_options!
  unless args.empty?
    options[:highlighter] = args[0] || '<strong class="highlight">\1</strong>'
  end
  options.reverse_merge!(:highlighter => '<strong class="highlight">\1</strong>')
  if text.present? && phrases.present?
    match = Array(phrases).map { |p| Regexp.escape(p) }.join('|')
    text = text.to_str.gsub(/(#{match})(?!(?:[^<]*?)(?:["'])[^<>]*>)/i, options[:highlighter])
  end
  text = sanitize(text) unless options[:sanitize] == false
  text
end

def pluralize(count, singular, plural = nil)

# => 0 people
pluralize(0, 'person')

# => 3 users
pluralize(3, 'person', 'users')

# => 2 people
pluralize(2, 'person')

# => 1 person
pluralize(1, 'person')
==== Examples

it will use the Inflector to determine the plural form
+plural+ is supplied, it will use that when count is > 1, otherwise
Attempts to pluralize the +singular+ word unless +count+ is 1. If
def pluralize(count, singular, plural = nil)
  "#{count || 0} " + ((count == 1 || count =~ /^1(\.0+)?$/) ? singular : (plural || singular.pluralize))
end

def reset_cycle(name = "default")


<% end %>

<% reset_cycle("colors") %>

<% end %>

<%= value %>
"colors") -%>">
<% item.each do |value| %>
">
<% @items.each do |item| %>

@items = [[1,2,3,4], [5,6,3], [3,4,5,6,7,4]]
# Alternate CSS classes for even and odd numbers...
==== Example

it is called. Pass in +name+ to reset a named cycle.
Resets a cycle so that it starts from the first element the next time
def reset_cycle(name = "default")
  cycle = get_cycle(name)
  cycle.reset unless cycle.nil?
end

def safe_concat(string)

def safe_concat(string)
  output_buffer.respond_to?(:safe_concat) ? output_buffer.safe_concat(string) : concat(string)
end

def set_cycle(name, cycle_object)

def set_cycle(name, cycle_object)
  @_cycles = Hash.new unless defined?(@_cycles)
  @_cycles[name] = cycle_object
end

def simple_format(text, html_options={}, options={})

# => "

Look ma! A class!

"
simple_format("Look ma! A class!", :class => 'description')

# => "

We want to put a paragraph...

\n\n

...right there.

"
simple_format(more_text)

more_text = "We want to put a paragraph...\n\n...right there."

# => "

Here is some basic text...\n
...with a line break.

"
simple_format(my_text)

my_text = "Here is some basic text...\n...with a line break."
==== Examples
will be added to all created paragraphs.
You can pass any HTML attributes into html_options. These

method does not remove the newlines from the +text+.
considered as a linebreak and a
tag is appended. This
paragraph and wrapped in

tags. One newline (\n) is
Two or more consecutive newlines(\n\n) are considered as a
Returns +text+ transformed into HTML using simple formatting rules.

def simple_format(text, html_options={}, options={})
  text = text ? text.to_str : ''
  text = text.dup if text.frozen?
  start_tag = tag('p', html_options, true)
  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.concat("</p>")
  text = sanitize(text) unless options[:sanitize] == false
  text
end

def truncate(text, options = {})

# => "

Once upon a time in a wo..."
truncate("

Once upon a time in a world far far away

")

# => "And they f... (continued)"
truncate("And they found that many people were sleeping better.", :length => 25, :omission => '... (continued)')

# => "Once upon a..."
truncate("Once upon a time in a world far far away", :length => 17, :separator => ' ')

# => "Once upon a ti..."
truncate("Once upon a time in a world far far away", :length => 17)

# => "Once upon a time in a world..."
truncate("Once upon a time in a world far far away")

==== Examples

or entities, because truncation may produce invalid HTML (such as unbalanced or incomplete tags).
used in views, unless wrapped by raw(). Care should be taken if +text+ contains HTML tags
The result is not marked as HTML-safe, so will be subject to the default escaping when

Pass a :separator to truncate +text+ at a natural break.

for a total length not exceeding :length.
(defaults to 30). The last characters will be replaced with the :omission (defaults to "...")
Truncates a given +text+ after a given :length if +text+ is longer than :length
def truncate(text, options = {})
  options.reverse_merge!(:length => 30)
  text.truncate(options.delete(:length), options) if text
end

def word_wrap(text, *args)

word_wrap('Once upon a time', 8) # => Once upon\na time
+line_width+ as its optional second parameter:
You can still use word_wrap with the old API that accepts the

# => Once\nupon\na\ntime
word_wrap('Once upon a time', :line_width => 1)

# => Once upon\na time
word_wrap('Once upon a time', :line_width => 8)

# => Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding\n a successor to the throne turned out to be more trouble than anyone could have\n imagined...
word_wrap('Once upon a time, in a kingdom called Far Far Away, a king fell ill, and finding a successor to the throne turned out to be more trouble than anyone could have imagined...')

# => Once upon a time
word_wrap('Once upon a time')

==== Examples

(which is 80 by default).
breaks on the first whitespace character that does not exceed +line_width+
Wraps the +text+ into lines no longer than +line_width+ width. This method
def word_wrap(text, *args)
  options = args.extract_options!
  unless args.blank?
    options[:line_width] = args[0] || 80
  end
  options.reverse_merge!(:line_width => 80)
  text.split("\n").collect do |line|
    line.length > options[:line_width] ? line.gsub(/(.{1,#{options[:line_width]}})(\s+|$)/, "\\1\n").strip : line
  end * "\n"
end