forked from rubocop/rubocop
/
parameter_lists.rb
120 lines (105 loc) · 3.39 KB
/
parameter_lists.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# frozen_string_literal: true
module RuboCop
module Cop
module Metrics
# This cop checks for methods with too many parameters.
#
# The maximum number of parameters is configurable.
# Keyword arguments can optionally be excluded from the total count,
# as they add less complexity than positional or optional parameters.
#
# NOTE: Explicit block argument `&block` is not counted to prevent
# erroneous change that is avoided by making block argument implicit.
#
# @example Max: 3
# # good
# def foo(a, b, c = 1)
# end
#
# @example Max: 2
# # bad
# def foo(a, b, c = 1)
# end
#
# @example CountKeywordArgs: true (default)
# # counts keyword args towards the maximum
#
# # bad (assuming Max is 3)
# def foo(a, b, c, d: 1)
# end
#
# # good (assuming Max is 3)
# def foo(a, b, c: 1)
# end
#
# @example CountKeywordArgs: false
# # don't count keyword args towards the maximum
#
# # good (assuming Max is 3)
# def foo(a, b, c, d: 1)
# end
#
# This cop also checks for the maximum number of optional parameters.
# This can be configured using the `MaxOptionalParameters` config option.
#
# @example MaxOptionalParameters: 3 (default)
# # good
# def foo(a = 1, b = 2, c = 3)
# end
#
# @example MaxOptionalParameters: 2
# # bad
# def foo(a = 1, b = 2, c = 3)
# end
#
class ParameterLists < Base
exclude_limit 'Max'
exclude_limit 'MaxOptionalParameters'
MSG = 'Avoid parameter lists longer than %<max>d parameters. [%<count>d/%<max>d]'
OPTIONAL_PARAMETERS_MSG = 'Method has too many optional parameters. [%<count>d/%<max>d]'
NAMED_KEYWORD_TYPES = %i[kwoptarg kwarg].freeze
private_constant :NAMED_KEYWORD_TYPES
def on_def(node)
optargs = node.arguments.select(&:optarg_type?)
return if optargs.count <= max_optional_parameters
message = format(
OPTIONAL_PARAMETERS_MSG,
max: max_optional_parameters,
count: optargs.count
)
add_offense(node, message: message) { self.max_optional_parameters = optargs.count }
end
alias on_defs on_def
def on_args(node)
count = args_count(node)
return unless count > max_params
return if argument_to_lambda_or_proc?(node)
add_offense(node, message: format(MSG, max: max_params, count: args_count(node))) do
self.max = count
end
end
private
# @!method argument_to_lambda_or_proc?(node)
def_node_matcher :argument_to_lambda_or_proc?, <<~PATTERN
^lambda_or_proc?
PATTERN
def args_count(node)
if count_keyword_args?
node.children.count { |a| !a.blockarg_type? }
else
node.children.count { |a| !NAMED_KEYWORD_TYPES.include?(a.type) && !a.blockarg_type? }
end
end
def max_params
cop_config['Max']
end
def max_optional_parameters
cop_config['MaxOptionalParameters']
end
def count_keyword_args?
cop_config['CountKeywordArgs']
end
end
end
end
end