Class: RuboCop::Cop::Layout::ClosingHeredocIndentation

Inherits:
Cop
  • Object
show all
Includes:
Heredoc
Defined in:
lib/rubocop/cop/layout/closing_heredoc_indentation.rb

Overview

Checks the indentation of here document closings.

Examples:


# bad
class Foo
  def bar
    <<~SQL
      'Hi'
  SQL
  end
end

# good
class Foo
  def bar
    <<~SQL
      'Hi'
    SQL
  end
end

# bad

# heredoc contents is before closing heredoc.
foo arg,
    <<~EOS
  Hi
    EOS

# good
foo arg,
    <<~EOS
  Hi
EOS

# good
foo arg,
    <<~EOS
      Hi
    EOS

Constant Summary collapse

SIMPLE_HEREDOC =
'<<'.freeze
MSG =
'`%<closing>s` is not aligned with `%<opening>s`.'.freeze
MSG_ARG =
'`%<closing>s` is not aligned with `%<opening>s` or ' \
'beginning of method definition.'.freeze

Constants included from Heredoc

Heredoc::OPENING_DELIMITER

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from Heredoc

#on_str

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object



65
66
67
68
69
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 65

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(node.loc.heredoc_end, indented_end(node))
  end
end

#on_heredoc(node) ⇒ Object



57
58
59
60
61
62
63
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 57

def on_heredoc(node)
  return if heredoc_type(node) == SIMPLE_HEREDOC ||
            opening_indentation(node) == closing_indentation(node) ||
            argument_indentation_correct?(node)

  add_offense(node, location: :heredoc_end)
end