Class: RuboCop::Cop::Style::MethodDefParentheses

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

Overview

This cops checks for parentheses around the arguments in method definitions. Both instance and class/singleton methods are checked.

Constant Summary

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 ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

Methods included from OnMethodDef

#on_def, #on_defs

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

#autocorrect(node) ⇒ Object



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/rubocop/cop/style/method_def_parentheses.rb', line 29

def autocorrect(node)
  lambda do |corrector|
    if node.args_type?
      # offense is registered on args node when parentheses are unwanted
      corrector.replace(node.loc.begin, ' ')
      corrector.remove(node.loc.end)
    else
      args_expr = args_node(node).source_range
      args_with_space = range_with_surrounding_space(args_expr, :left)
      just_space = Parser::Source::Range.new(args_expr.source_buffer,
                                             args_with_space.begin_pos,
                                             args_expr.begin_pos)
      corrector.replace(just_space, '(')
      corrector.insert_after(args_expr, ')')
    end
  end
end

#on_method_def(node, _method_name, args, _body) ⇒ Object



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/rubocop/cop/style/method_def_parentheses.rb', line 13

def on_method_def(node, _method_name, args, _body)
  if style == :require_parentheses ||
     (style == :require_no_parentheses_except_multiline &&
      args.multiline?)
    if arguments?(args) && !parentheses?(args)
      missing_parentheses(node, args)
    else
      correct_style_detected
    end
  elsif parentheses?(args)
    unwanted_parentheses(args)
  else
    correct_style_detected
  end
end