Class: RuboCop::Cop::Layout::HeredocArgumentClosingParenthesis

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb

Overview

This cop checks for the placement of the closing parenthesis in a method call that passes a HEREDOC string as an argument. It should be placed at the end of the line containing the opening HEREDOC tag.

Examples:

# bad

   foo("     bar\n   SQL\n   )\n\n   foo(<<-SQL, 123, <<-NOSQL,\n     bar\n   SQL\n     baz\n   NOSQL\n   )\n\n   foo(\n     bar(<<-SQL\n       baz\n     SQL\n     ),\n     123,\n   )\n\n# good\n\n   foo(<<-SQL)\n     bar\n   SQL\n\n   foo(<<-SQL, 123, <<-NOSQL)\n     bar\n   SQL\n     baz\n   NOSQL\n\n   foo(\n     bar(<<-SQL),\n       baz\n     SQL\n     123,\n   )\n"

Constant Summary collapse

MSG = 
'Put the closing parenthesis for a method call with a ' \
'HEREDOC parameter on the same line as the HEREDOC opening.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, badge, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



60
61
62
 
# File 'lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb', line 60

def self.autocorrect_incompatible_with
  [Style::TrailingCommaInArguments]
end

Instance Method Details

#on_send(node) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb', line 64

def on_send(node)
  heredoc_arg = extract_heredoc_argument(node)
  return unless heredoc_arg

  outermost_send = outermost_send_on_same_line(heredoc_arg)
  return unless outermost_send
  return unless outermost_send.loc.end
  return unless heredoc_arg.first_line != outermost_send.loc.end.line
  return if subsequent_closing_parentheses_in_same_line?(outermost_send)

  add_offense(outermost_send.loc.end) do |corrector|
    autocorrect(corrector, outermost_send)
  end
end