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

Inherits:
Cop
  • Object
show all
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(<<-SQL
     bar
   SQL
   )

   foo(<<-SQL, 123, <<-NOSQL,
     baz
   NOSQL
   )

   foo(
     bar(<<-SQL
       baz
     SQL
     ),
     123,
   )

# good

   foo(<<-SQL)
     bar
   SQL

   foo(<<-SQL, 123, <<-NOSQL)
     baz
   NOSQL

   foo(
     bar(<<-SQL),
     123,
   )

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 included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #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?, #correctable?, #disable_offense, #disable_uncorrectable?, #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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



111
112
113
 
# File 'lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb', line 111

def self.autocorrect_incompatible_with
  [Style::TrailingCommaInArguments]
end

Instance Method Details

#autocorrect(node) ⇒ Object

Autocorrection note:

Commas are a bit tricky to handle when the method call is embedded in another expression. Here’s an example:

[

first_array_value,
foo(<<-SQL, 123, 456,
  SELECT * FROM db
SQL
),
third_array_value,

]

The “internal” trailing comma is after ‘456`. The “external” trailing comma is after `)`.

To autocorrect, we remove the latter, and move the former up:

[

first_array_value,
foo(<<-SQL, 123, 456),
  SELECT * FROM db
SQL
third_array_value,

]



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb', line 97

def autocorrect(node)
  lambda do |corrector|
    fix_closing_parenthesis(node, corrector)

    if internal_trailing_comma?(node)
      remove_internal_trailing_comma(node, corrector)
    end

    if external_trailing_comma?(node)
      fix_external_trailing_comma(node, corrector)
    end
  end
end

#on_send(node) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb', line 59

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

  add_offense(outermost_send, location: :end)
end