123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::Heredoc - Included

OPENING_DELIMITER

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::Heredoc - Included

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#argument_indentation_correct?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 74

def argument_indentation_correct?(node)
  return false unless node.argument? || node.chained?

  opening_indentation(
    find_node_used_heredoc_argument(node.parent)
  ) == closing_indentation(node)
end

#closing_indentation(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 82

def closing_indentation(node)
  indent_level(heredoc_closing(node))
end

#find_node_used_heredoc_argument(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 101

def find_node_used_heredoc_argument(node)
  if node.parent&.send_type?
    find_node_used_heredoc_argument(node.parent)
  else
    node
  end
end

#heredoc_closing(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 90

def heredoc_closing(node)
  node.loc.heredoc_end.source_line
end

#heredoc_opening(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 86

def heredoc_opening(node)
  node.source_range.source_line
end

#indent_level(source_line) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 117

def indent_level(source_line)
  source_line[/\A */].length
end

#indented_end(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 94

def indented_end(node)
  closing_indent = closing_indentation(node)
  opening_indent = opening_indentation(node)
  closing_text = heredoc_closing(node)
  closing_text.gsub(/^\s{#{closing_indent}}/, ' ' * opening_indent)
end

#message(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 109

def message(node)
  format(
    node.argument? ? MSG_ARG : MSG,
    closing: heredoc_closing(node).strip,
    opening: heredoc_opening(node).strip
  )
end

#on_heredoc(node)

[ GitHub ]

  
# 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

#opening_indentation(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/closing_heredoc_indentation.rb', line 70

def opening_indentation(node)
  indent_level(heredoc_opening(node))
end