RSpec
Ruby on Rails
Rubyexcerpt
-
auto_link
(<= v3.0.9)
-
auto_linked?
(<= v3.0.9)
-
auto_link_email_addresses
(<= v3.0.9)
-
auto_link_urls
(<= v3.0.9)
-
concat
-
current_cycle
-
cut_excerpt_part
(>= v4.0.2)
-
cycle
-
excerpt
-
get_cycle
-
highlight
-
markdown
(<= v2.3.8)
-
pluralize
-
reset_cycle
-
safe_concat
-
sanitize
(<= v1.2.6)
-
set_cycle
-
simple_format
-
split_paragraphs
(>= v4.0.2)
-
strip_links
(<= v1.2.6)
-
strip_tags
(<= v1.2.6)
-
textilize
(<= v2.3.8)
-
textilize_without_paragraph
(<= v2.3.8)
-
truncate
-
word_wrap
= private
= protected
excerpt(text, phrase, *args)
public
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
railsmonk -
September 23, 2008 - (<= v2.1.0)
Description copied from Rails 2.0
Extracts an excerpt from text that matches the first instance of phrase. The radius 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 excerpt_string will be prepended/appended accordingly. If the phrase isn‘t found, nil is returned.
Examples
excerpt('This is an example', 'an', 5) # => "...s is an examp..." excerpt('This is an example', 'is', 5) # => "This is an..." excerpt('This is an example', 'is') # => "This is an example" excerpt('This next thing is an example', 'ex', 2) # => "...next t..." excerpt('This is also an example', 'an', 8, '<chop> ') # => "<chop> is also an example"
