instance method
truncate
Ruby on Rails edge
Since v3.0.20Signature
truncate(truncate_to, options = {})Truncates a given text to length truncate_to if text is longer than truncate_to:
```
'Once upon a time in a world far far away'.truncate(27)
# => "Once upon a time in a wo..."
```
Pass a string or regexp `:separator` to truncate `text` at a natural break:
```
'Once upon a time in a world far far away'.truncate(27, separator: ' ')
# => "Once upon a time in a..."
'Once upon a time in a world far far away'.truncate(27, separator: /\s/)
# => "Once upon a time in a..."
```
The last characters will be replaced with the `:omission` string (defaults to "...").
The total length will not exceed `truncate_to` unless both `text` and `:omission`
are longer than `truncate_to`:
```
'And they found that many people were sleeping better.'.truncate(25, omission: '... (continued)')
# => "And they f... (continued)"
'And they found that many people were sleeping better.'.truncate(4, omission: '... (continued)')
# => "... (continued)"
```: (Integer, ?Hash[Symbol, top]) -> String
Parameters
-
truncate_toreq -
optionsopt = {}
Source
# File activesupport/lib/active_support/core_ext/string/filters.rb, line 94
def truncate(truncate_to, options = {})
return dup unless length > truncate_to
omission = options[:omission] || "..."
length_with_room_for_omission = truncate_to - omission.length
return omission.dup if length_with_room_for_omission <= 0
stop = \
if options[:separator]
rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission
else
length_with_room_for_omission
end
# Slice to_str, not self, so a SafeBuffer gives a plain String: the cut
# can split an HTML tag, so the result must not be html_safe. The slice is
# a fresh, mutable string, so append the omission to it.
to_str[0, stop] << omission
end
Defined in activesupport/lib/active_support/core_ext/string/filters.rb line 94
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in String