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

Inherits:
Cop
  • Object
show all
Includes:
CheckMethods, ConfigurableEnforcedStyle
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::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods included from CheckMethods

#on_def, #on_defs

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/method_def_parentheses.rb', line 33

def autocorrect(node)
  @corrections << lambda do |corrector|
    if style == :require_parentheses
      args_expr = args_node(node).loc.expression
      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, ')')
    elsif style == :require_no_parentheses
      corrector.replace(node.loc.begin, ' ')
      corrector.remove(node.loc.end)
    end
  end
end

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



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

def check(node, _method_name, args, _body)
  if style == :require_parentheses
    if arguments?(args) && !parentheses?(args)
      add_offense(node,
                  args.loc.expression,
                  'Use def with parentheses when there are ' \
                  'parameters.') do
        opposite_style_detected
      end
    else
      correct_style_detected
    end
  elsif parentheses?(args)
    add_offense(args, :expression, 'Use def without parentheses.') do
      opposite_style_detected
    end
  else
    correct_style_detected
  end
end