instance method
excerpt
Ruby on Rails 3.2.22.5
Since v2.2.3Signature
excerpt(text, phrase, *args)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. The resulting string will be stripped in any case. If the phrase isn’t found, nil is returned.
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 => '<chop> ') # => <chop> is also an example
You can still use excerpt with the old API that accepts the radius as its optional third and the ellipsis as its optional forth parameter:
excerpt('This is an example', 'an', 5) # => ...s is an exam... excerpt('This is also an example', 'an', 8, '<chop> ') # => <chop> is also an example
Parameters
-
textreq -
phrasereq -
argsrest
Source
# File actionpack/lib/action_view/helpers/text_helper.rb, line 157
def excerpt(text, phrase, *args)
return unless text && phrase
options = args.extract_options!
unless args.empty?
ActiveSupport::Deprecation.warn "Calling excerpt with radius and omission as arguments is deprecated. " \
"Please call with :radius => #{args[0]}#{", :omission => '#{args[1]}'" if args[1]} instead.", caller
options[:radius] = args[0] || 100
options[:omission] = args[1] || "..."
end
options.reverse_merge!(:radius => 100, :omission => "...")
phrase = Regexp.escape(phrase)
return unless 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
end
Defined in actionpack/lib/action_view/helpers/text_helper.rb line 157
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActionView::Helpers::TextHelper