Class: RuboCop::Cop::Style::ClosingParenthesisIndentation

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment, OnMethodDef
Defined in:
lib/rubocop/cop/style/closing_parenthesis_indentation.rb

Overview

This cops checks the indentation of hanging closing parentheses in method calls, method definitions, and grouped expressions. A hanging closing parenthesis means ‘)` preceded by a line break.

Examples:


# good: when x is on its own line, indent this way
func(
  x,
  y
)

# good: when x follows opening parenthesis, align parentheses
a = b * (x +
         y
        )

# bad
def func(
  x,
  y
  )

Constant Summary collapse

MSG_INDENT = 
'Indent `)` the same as the start of the line where `(` is.'.freeze
MSG_ALIGN = 
'Align `)` with `(`.'.freeze

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from OnMethodDef

#on_def, #on_defs

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #configured_indentation_width, #display_column, #indentation, #offset

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_begin(node) ⇒ Object 



42
43
44
 
# File 'lib/rubocop/cop/style/closing_parenthesis_indentation.rb', line 42

def on_begin(node)
  check(node, node.children)
end

#on_send(node) ⇒ Object 



37
38
39
40
 
# File 'lib/rubocop/cop/style/closing_parenthesis_indentation.rb', line 37

def on_send(node)
  _receiver, _method_name, *args = *node
  check(node, args)
end