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 inherited from Cop

Cop::OPERATOR_METHODS

Constants included from Util

Util::PROC_NEW_NODE

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offences, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

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

Methods included from CheckMethods

#on_def, #on_defs

Methods inherited from Cop

#add_offence, all, #autocorrect?, #config_to_allow_offences, #config_to_allow_offences=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #exclude_file?, #exclude_paths, #ignore_node, #include_file?, #include_paths, inherited, #initialize, lint?, #message, non_rails, rails?, #relevant_file?, style?, #support_autocorrect?

Methods included from Util

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

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/rubocop/cop/style/method_def_parentheses.rb', line 26

def autocorrect(node)
  @corrections << lambda do |corrector|
    if style == :require_parentheses
      corrector.insert_after(node.children[1].loc.expression, ')')
      expression = node.loc.expression
      replacement = expression.source.sub(/(def\s+\S+)\s+/, '\1(')
      corrector.replace(expression, replacement)
    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
 
# File 'lib/rubocop/cop/style/method_def_parentheses.rb', line 12

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