<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 equivalent to <%= "hello" %> # # <% # unless signed_in? # concat link_to("Sign In", action: :sign_in) # end # %> # # is equivalent to # # <% unless signed_in? %> # <%= link_to "Sign In", action: :sign_in %> # <% end %> # 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 +text+ if it is longer than a specified +:length+. If +text+ # is truncated, an omission marker will be appended to the result for a # total length not exceeding +:length+. # # You can also pass a block to render and append extra content after the # omission marker when +text+ is truncated. However, this content _can_ # cause the total length to exceed +:length+ characters. # # The result will be escaped unless escape: false is specified. # In any case, the result will be marked HTML-safe. Care should be taken # if +text+ might contain HTML tags or entities, because truncation could # produce invalid HTML, such as unbalanced or incomplete tags. # # ==== Options # # [+:length+] # The maximum number of characters that should be returned, excluding # any extra content from the block. Defaults to 30. # # [+:omission+] # The string to append after truncating. Defaults to "...". # # [+:separator+] # A string or regexp used to find a breaking point at which to truncate. # By default, truncation can occur at any character in +text+. # # [+:escape+] # Whether to escape the result. Defaults to true. # # ==== Examples # # 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 world...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 occurrences of +phrases+ in +text+ by formatting them with a
# highlighter string. +phrases+ can be one or more strings or regular
# expressions. The result will be marked HTML safe. By default, +text+ is
# sanitized before highlighting to prevent possible XSS attacks.
#
# If a block is specified, it will be used instead of the highlighter
# string. Each occurrence of a phrase will be passed to the block, and its
# return value will be inserted into the final result.
#
# ==== Options
#
# [+:highlighter+]
# The highlighter string. Uses \1 as the placeholder for a
# phrase, similar to +String#sub+. Defaults to "\1".
# This option is ignored if a block is specified.
#
# [+:sanitize+]
# Whether to sanitize +text+ before highlighting. Defaults to true.
#
# ==== Examples
#
# 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 the first occurrence of +phrase+ plus surrounding text from
# +text+. An omission marker is prepended / appended if the start / end of
# the result does not coincide with the start / end of +text+. The result
# is always stripped in any case. Returns +nil+ if +phrase+ isn't found.
#
# ==== Options
#
# [+:radius+]
# The number of characters (or tokens — see +:separator+ option) around
# +phrase+ to include in the result. Defaults to 100.
#
# [+:omission+]
# The marker to prepend / append when the start / end of the excerpt
# does not coincide with the start / end of +text+. Defaults to
# "...".
#
# [+:separator+]
# The separator between tokens to count for +:radius+. Defaults to
# "", which treats each character as a token.
#
# ==== Examples
#
# 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 = [
# { 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