instance method
indent
Ruby on Rails edge
Since v4.0.13Signature
indent(amount, indent_string = nil, indent_empty_lines = false)Indents the lines in the receiver:
```
<<EOS.indent(2)
def some_method
some_code
end
EOS
# =>
def some_method
some_code
end
```
The second argument, `indent_string`, specifies which indent string to
use. The default is `nil`, which tells the method to make a guess by
peeking at the first indented line, and fall back to a space if there is
none.
```
" foo".indent(2) # => " foo"
"foo\n\t\tbar".indent(2) # => "\t\tfoo\n\t\t\t\tbar"
"foo".indent(2, "\t") # => "\t\tfoo"
```
While `indent_string` is typically one space or tab, it may be any string.
The third argument, `indent_empty_lines`, is a flag that says whether
empty lines should be indented. Default is false.
```
"foo\n\nbar".indent(2) # => " foo\n\n bar"
"foo\n\nbar".indent(2, nil, true) # => " foo\n \n bar"
```: (Integer, ?String?, ?boolish) -> String
Parameters
-
amountreq -
indent_stringopt = nil -
indent_empty_linesopt = false
Source
# File activesupport/lib/active_support/core_ext/string/indent.rb, line 50
def indent(amount, indent_string = nil, indent_empty_lines = false)
dup.tap { |_| _.indent!(amount, indent_string, indent_empty_lines) }
end
Defined in activesupport/lib/active_support/core_ext/string/indent.rb line 50
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in String