<a href=\"http://example.com/\">Example</a>
" module TextHelper extend ActiveSupport::Concern include SanitizeHelper include TagHelper include OutputSafetyHelper # 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. # # <% # concat "hello" # # is the equivalent of <%= "hello" %> # # if logged_in # concat "Logged in!" # else # concat link_to('login', action: :login) # end # # will either display "Logged in!" or a login link # %> def concat(string) output_buffer << string end def safe_concat(string) output_buffer.respond_to?(:safe_concat) ? output_buffer.safe_concat(string) : concat(string) end # Truncates a given +text+ after a given :length if +text+ is longer than :length # (defaults to 30). The last characters will be replaced with the :omission (defaults to "...") # for a total length not exceeding :length. # # Pass a :separator to truncate +text+ at a natural break. # # Pass a block if you want to show extra content when the text is truncated. # # The result is marked as HTML-safe, but it is escaped by default, unless :escape is # +false+. Care should be taken if +text+ contains HTML tags or entities, because truncation # may produce invalid HTML (such as unbalanced or incomplete tags). # # truncate("Once upon a time in a world far far away") # # => "Once upon a time in a world..." # # truncate("Once upon a time in a world far far away", length: 17) # # => "Once upon a ti..." # # truncate("Once upon a time in a world far far away", length: 17, separator: ' ') # # => "Once upon a..." # # truncate("And they found that many people were sleeping better.", length: 25, omission: '... (continued)') # # => "And they f... (continued)" # # truncate("Once upon a time in a world far far away
") # # => "<p>Once upon a time in a wo..." # # truncate("Once upon a time in a world far far away
", escape: false) # # => "Once upon a time in a wo..."
#
# truncate("Once upon a time in a world far far away") { link_to "Continue", "#" }
# # => "Once upon a time in a wo...Continue"
def truncate(text, options = {}, &block)
if text
length = options.fetch(:length, 30)
content = text.truncate(length, options)
content = options[:escape] == false ? content.html_safe : ERB::Util.html_escape(content)
content << capture(&block) if block_given? && text.length > length
content
end
end
# 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
# \1) or passing a block that receives each matched term. By default +text+
# is sanitized to prevent possible XSS attacks. If the input is trustworthy, passing false
# for :sanitize will turn sanitizing off.
#
# highlight('You searched for: rails', 'rails')
# # => You searched for: rails
#
# highlight('You searched for: rails', /for|rails/)
# # => You searched for: rails
#
# highlight('You searched for: ruby, rails, dhh', 'actionpack')
# # => You searched for: ruby, rails, dhh
#
# highlight('You searched for: rails', ['for', 'rails'], highlighter: '\1')
# # => You searched for: rails
#
# highlight('You searched for: rails', 'rails', highlighter: '\1')
# # => You searched for: rails
#
# highlight('You searched for: rails', 'rails') { |match| link_to(search_path(q: match, match)) }
# # => You searched for: rails
#
# highlight('ruby on rails', 'rails', sanitize: false)
# # => ruby on rails
def highlight(text, phrases, options = {}, &block)
text = sanitize(text) if options.fetch(:sanitize, true)
if text.blank? || phrases.blank?
text || ""
else
patterns = Array(phrases).map { |phrase| Regexp === phrase ? phrase : Regexp.escape(phrase) }
pattern = /(#{patterns.join("|")})/i
highlighter = options.fetch(:highlighter, '\1') unless block
text.scan(/<[^>]*|[^<]+/).each do |segment|
if !segment.start_with?("<")
if block
segment.gsub!(pattern, &block)
else
segment.gsub!(pattern, highlighter)
end
end
end.join
end.html_safe
end
# Extracts an excerpt from +text+ that matches the first instance of +phrase+.
# The :radius option expands the excerpt on each side of the first occurrence of +phrase+ by the number of characters
# defined in :radius (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+,
# then the :omission option (which defaults to "...") will be prepended/appended accordingly. Use the
# :separator option to choose the delimitation. The resulting string will be stripped in any case. If the +phrase+
# isn't found, +nil+ is returned.
#
# excerpt('This is an example', 'an', radius: 5)
# # => ...s is an exam...
#
# excerpt('This is an example', 'is', radius: 5)
# # => This is a...
#
# excerpt('This is an example', 'is')
# # => This is an example
#
# excerpt('This next thing is an example', 'ex', radius: 2)
# # => ...next...
#
# excerpt('This is also an example', 'an', radius: 8, omission: ' tags. One newline
# (\n or \r\n) is considered a linebreak and a
# Here is some basic text...\n We want to put a paragraph... ...right there. Look ma! A class! Unblinkable. It's true.
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.
#
# ==== Options
# * :sanitize - If +false+, does not sanitize +text+.
# * :sanitize_options - Any extra options you want appended to the sanitize.
# * :wrapper_tag - String representing the wrapper tag, defaults to "p"
#
# ==== Examples
# my_text = "Here is some basic text...\n...with a line break."
#
# simple_format(my_text)
# # => "
...with a line break.
...with a line break.
# <% @items.each do |item| %>
#
#
#
# # 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| %>
# ">
#
# <% end %>
# <%= item %>
# ">
#
# <% end %>
def cycle(first_value, *values)
options = values.extract_options!
name = options.fetch(:name, "default")
values.unshift(*first_value)
cycle = get_cycle(name)
unless cycle && cycle.values == values
cycle = set_cycle(name, Cycle.new(*values))
end
cycle.to_s
end
# Returns the current cycle string after a cycle has been started. Useful
# for complex table highlighting or any other design need which requires
# the current cycle string in more than one place.
#
# # Alternate background colors
# @items = [1,2,3,4]
# <% @items.each do |item| %>
#
# <% item.values.each do |value| %>
# <%# Create a named cycle "colors" %>
# ">
# <%= value %>
#
# <% end %>
# <% reset_cycle("colors") %>
#
#
# <% @items.each do |item| %>
#
def reset_cycle(name = "default")
cycle = get_cycle(name)
cycle.reset if cycle
end
class Cycle # :nodoc:
attr_reader :values
def initialize(first_value, *values)
@values = values.unshift(first_value)
reset
end
def reset
@index = 0
end
def current_value
@values[previous_index].to_s
end
def to_s
value = @values[@index].to_s
@index = next_index
value
end
private
def next_index
step_index(1)
end
def previous_index
step_index(-1)
end
def step_index(n)
(@index + n) % @values.size
end
end
private
# 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.
def get_cycle(name)
@_cycles = Hash.new unless defined?(@_cycles)
@_cycles[name]
end
def set_cycle(name, cycle_object)
@_cycles = Hash.new unless defined?(@_cycles)
@_cycles[name] = cycle_object
end
def split_paragraphs(text)
return [] if text.blank?
text.to_str.gsub(/\r\n?/, "\n").split(/\n\n+/).map! do |t|
t.gsub!(/([^\n]\n)(?=[^\n])/, '\1">
# <% item.each do |value| %>
# ">
# <%= value %>
#
# <% end %>
#
# <% reset_cycle("colors") %>
#
# <% end %>
#
') || t
end
end
def cut_excerpt_part(part_position, part, separator, options)
return "", "" unless part
radius = options.fetch(:radius, 100)
omission = options.fetch(:omission, "...")
if separator != ""
part = part.split(separator)
part.delete("")
end
affix = part.length > radius ? omission : ""
part =
if part_position == :first
part.last(radius)
else
part.first(radius)
end
if separator != ""
part = part.join(separator)
end
return affix, part
end
end
end
end