Class String
In: lib/indentation/string_mod.rb
Parent: Object

Methods

find_least_indentation   indent   indent!   reset_indentation   reset_indentation!  

Public Instance methods

find_least_indentation(options = {:ignore_blank_lines => true, :ignore_empty_lines => true})

Split across newlines and return the fewest number of indentation characters found on each line

indent(num = nil, i_char = ' ')

Return an indented copy of this string Arguments:

  • num - How many of the specified indentation to use. 
          Default for spaces is 2. Default for other is 1.
      If set to a negative value, removes that many of the specified indentation character,
      tabs, or spaces from the beginning of the string
  • i_char - Character (or string) to use for indentation
indent!(num = nil, i_char = ' ')

Indents this string Arguments:

  • num - How many of the specified indentation to use. 
          Default for spaces is 2. Default for other is 1.
      If set to a negative value, removes that many of the specified indentation character,
      tabs, or spaces from the beginning of the string
  • i_char - Character (or string) to use for indentation
reset_indentation(modifier = 0)

Find the least indentation of all lines within this string and remove that amount (if any) Can pass an optional modifier that changes the indentation amount removed

reset_indentation!(modifier = 0)

Replaces the current string with one that has had its indentation reset Can pass an optional modifier that changes the indentation amount removed

[Validate]