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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
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 = 
'<<'
MSG = 
'`%<closing>s` is not aligned with `%<opening>s`.'
MSG_ARG = 
'`%<closing>s` is not aligned with `%<opening>s` or ' \
'beginning of method definition.'

Constants included from Heredoc

Heredoc::OPENING_DELIMITER

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source, #project_index

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from Heredoc

#on_str

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

cop_dir_for, #exclude_limit, read_limits

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_heredoc(node) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
 
# 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)

  message = message(node)
  add_offense(node.loc.heredoc_end, message: message) do |corrector|
    corrector.replace(node.loc.heredoc_end, indented_end(node))
  end
end