class RubbyCop::Cop::Layout::IndentHeredoc

This cops checks the indentation of the here document bodies. The bodies are indented one step. In Ruby 2.3 or newer, squiggly heredocs (`<<~`) should be used. If you use the older rubies, you should introduce some library to your project (e.g. ActiveSupport, Powerpack or Unindent).

@example

# bad
<<-END
something
END

# good
# When EnforcedStyle is squiggly, bad code is auto-corrected to the
# following code.
<<~END
  something
END

# good
# When EnforcedStyle is active_support, bad code is auto-corrected to
# the following code.
<<-END.strip_heredoc
  something
END

Constants

LIBRARY_MSG
RUBY23_MSG
StripMethods

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 64
def autocorrect(node)
  check_style!

  case style
  when :squiggly
    correct_by_squiggly(node)
  else
    correct_by_library(node)
  end
end
on_dstr(node)
Alias for: on_str
on_str(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 46
def on_str(node)
  return unless heredoc?(node)

  body_indent_level = body_indent_level(node)

  if heredoc_indent_type(node) == '~'
    expected_indent_level = base_indent_level(node) + indentation_width
    return if expected_indent_level == body_indent_level
  else
    return unless body_indent_level.zero?
  end

  add_offense(node, :heredoc_body)
end
Also aliased as: on_dstr, on_xstr
on_xstr(node)
Alias for: on_str

Private Instance Methods

base_indent_level(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 152
def base_indent_level(node)
  base_line_num = node.loc.expression.line
  base_line = processed_source.lines[base_line_num - 1]
  indent_level(base_line)
end
body_indent_level(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 147
def body_indent_level(node)
  body = node.loc.heredoc_body.source
  indent_level(body)
end
check_style!() click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 123
def check_style!
  case style
  when nil
    raise Warning, "Auto-correction does not work for #{cop_name}. " \
                   'Please configure EnforcedStyle.'
  when :squiggly
    if target_ruby_version < 2.3
      raise Warning, '`squiggly` style is selectable only on Ruby ' \
                     "2.3 or higher for #{cop_name}."
    end
  end
end
correct_by_library(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 115
def correct_by_library(node)
  lambda do |corrector|
    corrector.replace(node.loc.heredoc_body, indented_body(node))
    corrected = ".#{StripMethods[style]}"
    corrector.insert_after(node.loc.expression, corrected)
  end
end
correct_by_squiggly(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 102
def correct_by_squiggly(node)
  return if target_ruby_version < 2.3
  lambda do |corrector|
    if heredoc_indent_type(node) == '~'
      corrector.replace(node.loc.heredoc_body, indented_body(node))
    else
      heredoc_beginning = node.loc.expression.source
      corrected = heredoc_beginning.sub(/<<-?/, '<<~')
      corrector.replace(node.loc.expression, corrected)
    end
  end
end
heredoc?(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 136
def heredoc?(node)
  node.loc.is_a?(Parser::Source::Map::Heredoc)
end
heredoc_indent_type(node) click to toggle source

Returns '~', '-' or nil

# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 163
def heredoc_indent_type(node)
  node.source[/^<<([~-])/, 1]
end
indent_level(str) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 158
def indent_level(str)
  str.scan(/^\s*/).reject { |line| line == "\n" }.min_by(&:size).size
end
indentation_width() click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 167
def indentation_width
  @config.for_cop('IndentationWidth')['Width'] || 2
end
indented_body(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 140
def indented_body(node)
  body = node.loc.heredoc_body.source
  body_indent_level = body_indent_level(node)
  correct_indent_level = base_indent_level(node) + indentation_width
  body.gsub(/^\s{#{body_indent_level}}/, ' ' * correct_indent_level)
end
message(node) click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 88
def message(node)
  case style
  when :squiggly
    current_indent_type = "<<#{heredoc_indent_type(node)}"
    format(RUBY23_MSG, indentation_width, current_indent_type)
  when nil
    method = "some library(e.g. ActiveSupport's `String#strip_heredoc`)"
    format(LIBRARY_MSG, indentation_width, method)
  else
    method = "`String##{StripMethods[style]}`"
    format(LIBRARY_MSG, indentation_width, method)
  end
end
style() click to toggle source
# File lib/rubbycop/cop/layout/indent_heredoc.rb, line 77
def style
  style = super
  return style unless style == :auto_detection

  if target_ruby_version >= 2.3
    :squiggly
  elsif rails?
    :active_support
  end
end