rubocop 1.69.2 → 1.70.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE.txt +1 -1
- data/README.md +2 -2
- data/config/default.yml +19 -2
- data/lib/rubocop/cli/command/execute_runner.rb +3 -3
- data/lib/rubocop/config.rb +13 -4
- data/lib/rubocop/config_loader.rb +4 -0
- data/lib/rubocop/config_loader_resolver.rb +14 -3
- data/lib/rubocop/config_validator.rb +18 -8
- data/lib/rubocop/cop/base.rb +6 -0
- data/lib/rubocop/cop/bundler/gem_comment.rb +1 -1
- data/lib/rubocop/cop/internal_affairs/cop_enabled.rb +85 -0
- data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb +4 -3
- data/lib/rubocop/cop/internal_affairs.rb +1 -0
- data/lib/rubocop/cop/layout/argument_alignment.rb +1 -7
- data/lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb +1 -0
- data/lib/rubocop/cop/layout/extra_spacing.rb +1 -1
- data/lib/rubocop/cop/layout/first_argument_indentation.rb +2 -7
- data/lib/rubocop/cop/layout/first_array_element_indentation.rb +2 -7
- data/lib/rubocop/cop/layout/first_hash_element_indentation.rb +1 -6
- data/lib/rubocop/cop/layout/hash_alignment.rb +6 -4
- data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb +1 -0
- data/lib/rubocop/cop/layout/line_continuation_spacing.rb +7 -1
- data/lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb +1 -1
- data/lib/rubocop/cop/layout/line_length.rb +1 -0
- data/lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb +24 -0
- data/lib/rubocop/cop/layout/redundant_line_break.rb +1 -1
- data/lib/rubocop/cop/layout/space_after_method_name.rb +1 -1
- data/lib/rubocop/cop/layout/space_around_operators.rb +3 -3
- data/lib/rubocop/cop/layout/trailing_whitespace.rb +5 -3
- data/lib/rubocop/cop/lint/constant_reassignment.rb +152 -0
- data/lib/rubocop/cop/lint/duplicate_set_element.rb +20 -7
- data/lib/rubocop/cop/lint/literal_in_interpolation.rb +11 -3
- data/lib/rubocop/cop/lint/nested_method_definition.rb +5 -1
- data/lib/rubocop/cop/lint/non_atomic_file_operation.rb +4 -3
- data/lib/rubocop/cop/lint/numeric_operation_with_constant_result.rb +6 -14
- data/lib/rubocop/cop/lint/shared_mutable_default.rb +65 -0
- data/lib/rubocop/cop/lint/syntax.rb +4 -1
- data/lib/rubocop/cop/lint/unescaped_bracket_in_regexp.rb +1 -4
- data/lib/rubocop/cop/lint/void.rb +3 -2
- data/lib/rubocop/cop/metrics/method_length.rb +8 -1
- data/lib/rubocop/cop/mixin/check_line_breakable.rb +7 -7
- data/lib/rubocop/cop/mixin/comments_help.rb +2 -0
- data/lib/rubocop/cop/mixin/dig_help.rb +1 -1
- data/lib/rubocop/cop/mixin/preceding_following_alignment.rb +26 -16
- data/lib/rubocop/cop/mixin/space_before_punctuation.rb +1 -1
- data/lib/rubocop/cop/mixin/statement_modifier.rb +1 -1
- data/lib/rubocop/cop/mixin/string_literals_help.rb +1 -1
- data/lib/rubocop/cop/naming/block_forwarding.rb +1 -1
- data/lib/rubocop/cop/style/access_modifier_declarations.rb +32 -1
- data/lib/rubocop/cop/style/and_or.rb +1 -1
- data/lib/rubocop/cop/style/arguments_forwarding.rb +1 -4
- data/lib/rubocop/cop/style/class_and_module_children.rb +5 -2
- data/lib/rubocop/cop/style/each_for_simple_loop.rb +3 -6
- data/lib/rubocop/cop/style/empty_else.rb +4 -2
- data/lib/rubocop/cop/style/empty_literal.rb +1 -1
- data/lib/rubocop/cop/style/empty_method.rb +1 -1
- data/lib/rubocop/cop/style/exact_regexp_match.rb +2 -9
- data/lib/rubocop/cop/style/exponential_notation.rb +1 -1
- data/lib/rubocop/cop/style/float_division.rb +8 -4
- data/lib/rubocop/cop/style/hash_except.rb +54 -67
- data/lib/rubocop/cop/style/hash_syntax.rb +5 -2
- data/lib/rubocop/cop/style/it_assignment.rb +36 -0
- data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb +11 -1
- data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb +2 -0
- data/lib/rubocop/cop/style/missing_else.rb +2 -0
- data/lib/rubocop/cop/style/multiple_comparison.rb +26 -20
- data/lib/rubocop/cop/style/mutable_constant.rb +1 -1
- data/lib/rubocop/cop/style/object_then.rb +13 -15
- data/lib/rubocop/cop/style/quoted_symbols.rb +1 -1
- data/lib/rubocop/cop/style/raise_args.rb +5 -3
- data/lib/rubocop/cop/style/random_with_offset.rb +3 -3
- data/lib/rubocop/cop/style/redundant_current_directory_in_path.rb +2 -1
- data/lib/rubocop/cop/style/redundant_initialize.rb +12 -3
- data/lib/rubocop/cop/style/redundant_line_continuation.rb +7 -3
- data/lib/rubocop/cop/style/redundant_parentheses.rb +1 -4
- data/lib/rubocop/cop/style/redundant_regexp_argument.rb +3 -0
- data/lib/rubocop/cop/style/redundant_self_assignment.rb +6 -5
- data/lib/rubocop/cop/style/safe_navigation.rb +1 -1
- data/lib/rubocop/cop/style/send_with_literal_method_name.rb +2 -1
- data/lib/rubocop/cop/style/single_line_do_end_block.rb +1 -2
- data/lib/rubocop/cop/style/single_line_methods.rb +2 -3
- data/lib/rubocop/cop/style/slicing_with_range.rb +40 -11
- data/lib/rubocop/cop/style/super_arguments.rb +63 -15
- data/lib/rubocop/cop/style/yoda_condition.rb +8 -4
- data/lib/rubocop/cop/style/yoda_expression.rb +1 -0
- data/lib/rubocop/cop/util.rb +9 -2
- data/lib/rubocop/formatter/formatter_set.rb +1 -1
- data/lib/rubocop/lsp/diagnostic.rb +189 -0
- data/lib/rubocop/lsp/logger.rb +2 -2
- data/lib/rubocop/lsp/routes.rb +7 -23
- data/lib/rubocop/lsp/runtime.rb +15 -49
- data/lib/rubocop/lsp/stdin_runner.rb +83 -0
- data/lib/rubocop/path_util.rb +11 -8
- data/lib/rubocop/rspec/shared_contexts.rb +4 -1
- data/lib/rubocop/runner.rb +5 -6
- data/lib/rubocop/target_ruby.rb +15 -0
- data/lib/rubocop/version.rb +1 -1
- data/lib/rubocop.rb +3 -0
- data/lib/ruby_lsp/rubocop/addon.rb +78 -0
- data/lib/ruby_lsp/rubocop/wraps_built_in_lsp_runtime.rb +50 -0
- metadata +12 -4
@@ -61,6 +61,8 @@ module RuboCop
|
|
61
61
|
# https://bugs.ruby-lang.org/issues/18396.
|
62
62
|
# - Parentheses are required in anonymous arguments, keyword arguments
|
63
63
|
# and block passing in Ruby 3.2.
|
64
|
+
# - Parentheses are required when the first argument is a beginless range or
|
65
|
+
# the last argument is an endless range.
|
64
66
|
#
|
65
67
|
# @example EnforcedStyle: require_parentheses (default)
|
66
68
|
#
|
@@ -55,6 +55,22 @@ module RuboCop
|
|
55
55
|
MSG = 'Avoid comparing a variable with multiple items ' \
|
56
56
|
'in a conditional, use `Array#include?` instead.'
|
57
57
|
|
58
|
+
# @!method simple_double_comparison?(node)
|
59
|
+
def_node_matcher :simple_double_comparison?, <<~PATTERN
|
60
|
+
(send lvar :== lvar)
|
61
|
+
PATTERN
|
62
|
+
|
63
|
+
# @!method simple_comparison_lhs(node)
|
64
|
+
def_node_matcher :simple_comparison_lhs, <<~PATTERN
|
65
|
+
(send ${lvar call} :== $_)
|
66
|
+
PATTERN
|
67
|
+
|
68
|
+
# @!method simple_comparison_rhs(node)
|
69
|
+
def_node_matcher :simple_comparison_rhs, <<~PATTERN
|
70
|
+
(send $_ :== ${lvar call})
|
71
|
+
PATTERN
|
72
|
+
|
73
|
+
# rubocop:disable Metrics/AbcSize
|
58
74
|
def on_or(node)
|
59
75
|
root_of_or_node = root_of_or_node(node)
|
60
76
|
return unless node == root_of_or_node
|
@@ -67,27 +83,16 @@ module RuboCop
|
|
67
83
|
|
68
84
|
add_offense(range) do |corrector|
|
69
85
|
elements = values.map(&:source).join(', ')
|
70
|
-
|
86
|
+
argument = variable.lvar_type? ? variable_name(variable) : variable.source
|
87
|
+
prefer_method = "[#{elements}].include?(#{argument})"
|
71
88
|
|
72
89
|
corrector.replace(range, prefer_method)
|
73
90
|
end
|
74
91
|
end
|
92
|
+
# rubocop:enable Metrics/AbcSize
|
75
93
|
|
76
94
|
private
|
77
95
|
|
78
|
-
# @!method simple_double_comparison?(node)
|
79
|
-
def_node_matcher :simple_double_comparison?, '(send $lvar :== $lvar)'
|
80
|
-
|
81
|
-
# @!method simple_comparison_lhs?(node)
|
82
|
-
def_node_matcher :simple_comparison_lhs?, <<~PATTERN
|
83
|
-
(send $lvar :== $_)
|
84
|
-
PATTERN
|
85
|
-
|
86
|
-
# @!method simple_comparison_rhs?(node)
|
87
|
-
def_node_matcher :simple_comparison_rhs?, <<~PATTERN
|
88
|
-
(send $_ :== $lvar)
|
89
|
-
PATTERN
|
90
|
-
|
91
96
|
# rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
|
92
97
|
def find_offending_var(node, variables = Set.new, values = [])
|
93
98
|
if node.or_type?
|
@@ -95,8 +100,8 @@ module RuboCop
|
|
95
100
|
find_offending_var(node.rhs, variables, values)
|
96
101
|
elsif simple_double_comparison?(node)
|
97
102
|
return
|
98
|
-
elsif (var, obj = simple_comparison
|
99
|
-
return if allow_method_comparison? && obj.
|
103
|
+
elsif (var, obj = simple_comparison(node))
|
104
|
+
return if allow_method_comparison? && obj.call_type?
|
100
105
|
|
101
106
|
variables << var
|
102
107
|
return if variables.size > 1
|
@@ -125,12 +130,13 @@ module RuboCop
|
|
125
130
|
end
|
126
131
|
|
127
132
|
def comparison?(node)
|
128
|
-
simple_comparison
|
133
|
+
!!simple_comparison(node) || nested_comparison?(node)
|
129
134
|
end
|
130
135
|
|
131
|
-
def simple_comparison
|
132
|
-
if (var, obj = simple_comparison_lhs
|
133
|
-
|
136
|
+
def simple_comparison(node)
|
137
|
+
if (var, obj = simple_comparison_lhs(node)) || (obj, var = simple_comparison_rhs(node))
|
138
|
+
return if var.call_type? && !allow_method_comparison?
|
139
|
+
|
134
140
|
[var, obj]
|
135
141
|
end
|
136
142
|
end
|
@@ -33,9 +33,10 @@ module RuboCop
|
|
33
33
|
RESTRICT_ON_SEND = %i[then yield_self].freeze
|
34
34
|
|
35
35
|
def on_block(node)
|
36
|
+
return unless RESTRICT_ON_SEND.include?(node.method_name)
|
37
|
+
|
36
38
|
check_method_node(node.send_node)
|
37
39
|
end
|
38
|
-
|
39
40
|
alias on_numblock on_block
|
40
41
|
|
41
42
|
def on_send(node)
|
@@ -43,29 +44,26 @@ module RuboCop
|
|
43
44
|
|
44
45
|
check_method_node(node)
|
45
46
|
end
|
47
|
+
alias on_csend on_send
|
46
48
|
|
47
49
|
private
|
48
50
|
|
49
51
|
def check_method_node(node)
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
52
|
+
if preferred_method?(node)
|
53
|
+
correct_style_detected
|
54
|
+
else
|
55
|
+
opposite_style_detected
|
56
|
+
message = message(node)
|
57
|
+
add_offense(node.loc.selector, message: message) do |corrector|
|
58
|
+
prefer = style == :then && node.receiver.nil? ? 'self.then' : style
|
55
59
|
|
56
|
-
|
60
|
+
corrector.replace(node.loc.selector, prefer)
|
61
|
+
end
|
57
62
|
end
|
58
63
|
end
|
59
64
|
|
60
65
|
def preferred_method?(node)
|
61
|
-
|
62
|
-
when :then
|
63
|
-
node.method?(:yield_self)
|
64
|
-
when :yield_self
|
65
|
-
node.method?(:then)
|
66
|
-
else
|
67
|
-
false
|
68
|
-
end
|
66
|
+
node.method?(style)
|
69
67
|
end
|
70
68
|
|
71
69
|
def message(node)
|
@@ -98,7 +98,7 @@ module RuboCop
|
|
98
98
|
|
99
99
|
def style
|
100
100
|
return super unless super == :same_as_string_literals
|
101
|
-
return :single_quotes unless
|
101
|
+
return :single_quotes unless config.cop_enabled?('Style/StringLiterals')
|
102
102
|
|
103
103
|
string_literals_config['EnforcedStyle'].to_sym
|
104
104
|
end
|
@@ -50,6 +50,9 @@ module RuboCop
|
|
50
50
|
|
51
51
|
EXPLODED_MSG = 'Provide an exception class and message as arguments to `%<method>s`.'
|
52
52
|
COMPACT_MSG = 'Provide an exception object as an argument to `%<method>s`.'
|
53
|
+
ACCEPTABLE_ARG_TYPES = %i[
|
54
|
+
hash forwarded_restarg splat forwarded_restarg forwarded_args
|
55
|
+
].freeze
|
53
56
|
|
54
57
|
RESTRICT_ON_SEND = %i[raise fail].freeze
|
55
58
|
|
@@ -138,9 +141,8 @@ module RuboCop
|
|
138
141
|
|
139
142
|
arg = args.first
|
140
143
|
|
141
|
-
# Allow
|
142
|
-
|
143
|
-
arg.hash_type? || arg.splat_type?
|
144
|
+
# Allow nodes that may forward more than one argument
|
145
|
+
ACCEPTABLE_ARG_TYPES.include?(arg.type)
|
144
146
|
end
|
145
147
|
|
146
148
|
def allowed_non_exploded_type?(arg)
|
@@ -36,7 +36,7 @@ module RuboCop
|
|
36
36
|
(send
|
37
37
|
{nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
|
38
38
|
:rand
|
39
|
-
{int (
|
39
|
+
{int (range int int)}))
|
40
40
|
PATTERN
|
41
41
|
|
42
42
|
# @!method rand_op_integer?(node)
|
@@ -45,7 +45,7 @@ module RuboCop
|
|
45
45
|
(send
|
46
46
|
{nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
|
47
47
|
:rand
|
48
|
-
{int (
|
48
|
+
{int (range int int)})
|
49
49
|
{:+ :-}
|
50
50
|
int)
|
51
51
|
PATTERN
|
@@ -56,7 +56,7 @@ module RuboCop
|
|
56
56
|
(send
|
57
57
|
{nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
|
58
58
|
:rand
|
59
|
-
{int (
|
59
|
+
{int (range int int)})
|
60
60
|
{:succ :pred :next})
|
61
61
|
PATTERN
|
62
62
|
|
@@ -11,6 +11,9 @@ module RuboCop
|
|
11
11
|
# will not register an offense, because it allows the initializer to take a different
|
12
12
|
# number of arguments as its superclass potentially does.
|
13
13
|
#
|
14
|
+
# NOTE: If an initializer takes any arguments and has an empty body, RuboCop
|
15
|
+
# assumes it to *not* be redundant. This is to prevent potential `ArgumentError`.
|
16
|
+
#
|
14
17
|
# NOTE: If an initializer argument has a default value, RuboCop assumes it
|
15
18
|
# to *not* be redundant.
|
16
19
|
#
|
@@ -19,8 +22,10 @@ module RuboCop
|
|
19
22
|
# initializer.
|
20
23
|
#
|
21
24
|
# @safety
|
22
|
-
# This cop is unsafe because
|
23
|
-
#
|
25
|
+
# This cop is unsafe because removing an empty initializer may alter
|
26
|
+
# the behavior of the code, particularly if the superclass initializer
|
27
|
+
# raises an exception. In such cases, the empty initializer may act as
|
28
|
+
# a safeguard to prevent unintended errors from propagating.
|
24
29
|
#
|
25
30
|
# @example
|
26
31
|
# # bad
|
@@ -69,6 +74,10 @@ module RuboCop
|
|
69
74
|
# end
|
70
75
|
#
|
71
76
|
# # good (changes the parameter requirements)
|
77
|
+
# def initialize(_)
|
78
|
+
# end
|
79
|
+
#
|
80
|
+
# # good (changes the parameter requirements)
|
72
81
|
# def initialize(*)
|
73
82
|
# end
|
74
83
|
#
|
@@ -111,7 +120,7 @@ module RuboCop
|
|
111
120
|
return if acceptable?(node)
|
112
121
|
|
113
122
|
if node.body.nil?
|
114
|
-
register_offense(node, MSG_EMPTY)
|
123
|
+
register_offense(node, MSG_EMPTY) if node.arguments.empty?
|
115
124
|
else
|
116
125
|
return if node.body.begin_type?
|
117
126
|
|
@@ -112,10 +112,13 @@ module RuboCop
|
|
112
112
|
end
|
113
113
|
|
114
114
|
def inside_string_literal_or_method_with_argument?(range)
|
115
|
+
line_range = range_by_whole_lines(range)
|
116
|
+
|
115
117
|
processed_source.tokens.each_cons(2).any? do |token, next_token|
|
116
118
|
next if token.line == next_token.line
|
117
119
|
|
118
|
-
inside_string_literal?(range, token) ||
|
120
|
+
inside_string_literal?(range, token) ||
|
121
|
+
method_with_argument?(line_range, token, next_token)
|
119
122
|
end
|
120
123
|
end
|
121
124
|
|
@@ -155,8 +158,9 @@ module RuboCop
|
|
155
158
|
#
|
156
159
|
# do_something \
|
157
160
|
# argument
|
158
|
-
def method_with_argument?(current_token, next_token)
|
161
|
+
def method_with_argument?(line_range, current_token, next_token)
|
159
162
|
return false unless ARGUMENT_TAKING_FLOW_TOKEN_TYPES.include?(current_token.type)
|
163
|
+
return false unless current_token.pos.overlaps?(line_range)
|
160
164
|
|
161
165
|
ARGUMENT_TYPES.include?(next_token.type)
|
162
166
|
end
|
@@ -180,7 +184,7 @@ module RuboCop
|
|
180
184
|
|
181
185
|
def find_node_for_line(last_line)
|
182
186
|
processed_source.ast.each_node do |node|
|
183
|
-
return node if
|
187
|
+
return node if same_line?(node, last_line)
|
184
188
|
end
|
185
189
|
end
|
186
190
|
|
@@ -166,10 +166,7 @@ module RuboCop
|
|
166
166
|
def_node_matcher :interpolation?, '[^begin ^^dstr]'
|
167
167
|
|
168
168
|
def allow_in_multiline_conditions?
|
169
|
-
|
170
|
-
return false unless parentheses_around_condition_config['Enabled']
|
171
|
-
|
172
|
-
!!parentheses_around_condition_config['AllowInMultilineConditions']
|
169
|
+
!!config.for_enabled_cop('Style/ParenthesesAroundCondition')['AllowInMultilineConditions']
|
173
170
|
end
|
174
171
|
|
175
172
|
def check_send(begin_node, node)
|
@@ -52,7 +52,7 @@ module RuboCop
|
|
52
52
|
# rubocop:disable Metrics/AbcSize
|
53
53
|
def on_lvasgn(node)
|
54
54
|
return unless (rhs = node.rhs)
|
55
|
-
return unless rhs.
|
55
|
+
return unless rhs.call_type? && method_returning_self?(rhs.method_name)
|
56
56
|
return unless (receiver = rhs.receiver)
|
57
57
|
|
58
58
|
receiver_type = ASSIGNMENT_TYPE_TO_RECEIVER_TYPE[node.type]
|
@@ -77,6 +77,7 @@ module RuboCop
|
|
77
77
|
corrector.remove(correction_range(node))
|
78
78
|
end
|
79
79
|
end
|
80
|
+
alias on_csend on_send
|
80
81
|
|
81
82
|
private
|
82
83
|
|
@@ -88,7 +89,7 @@ module RuboCop
|
|
88
89
|
def_node_matcher :redundant_self_assignment?, <<~PATTERN
|
89
90
|
(send
|
90
91
|
(self) _
|
91
|
-
(
|
92
|
+
(call
|
92
93
|
(send
|
93
94
|
{(self) nil?} %1) #method_returning_self?
|
94
95
|
...))
|
@@ -96,10 +97,10 @@ module RuboCop
|
|
96
97
|
|
97
98
|
# @!method redundant_nonself_assignment?(node, receiver, method_name)
|
98
99
|
def_node_matcher :redundant_nonself_assignment?, <<~PATTERN
|
99
|
-
(
|
100
|
+
(call
|
100
101
|
%1 _
|
101
|
-
(
|
102
|
-
(
|
102
|
+
(call
|
103
|
+
(call
|
103
104
|
%1 %2) #method_returning_self?
|
104
105
|
...))
|
105
106
|
PATTERN
|
@@ -323,7 +323,7 @@ module RuboCop
|
|
323
323
|
return true if unsafe_method?(method)
|
324
324
|
|
325
325
|
method.each_ancestor(:send).any? do |ancestor|
|
326
|
-
break true unless config.
|
326
|
+
break true unless config.cop_enabled?('Lint/SafeNavigationChain')
|
327
327
|
|
328
328
|
break true if unsafe_method?(ancestor)
|
329
329
|
break true if nil_methods.include?(ancestor.method_name)
|
@@ -68,7 +68,7 @@ module RuboCop
|
|
68
68
|
def on_send(node)
|
69
69
|
return if allow_send? && !node.method?(:public_send)
|
70
70
|
return unless (first_argument = node.first_argument)
|
71
|
-
return unless
|
71
|
+
return unless first_argument.type?(*STATIC_METHOD_NAME_NODE_TYPES)
|
72
72
|
|
73
73
|
offense_range = offense_range(node)
|
74
74
|
method_name = first_argument.value
|
@@ -83,6 +83,7 @@ module RuboCop
|
|
83
83
|
end
|
84
84
|
end
|
85
85
|
end
|
86
|
+
alias on_csend on_send
|
86
87
|
# rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
|
87
88
|
|
88
89
|
private
|
@@ -68,8 +68,7 @@ module RuboCop
|
|
68
68
|
end
|
69
69
|
|
70
70
|
def single_line_blocks_preferred?
|
71
|
-
|
72
|
-
redundant_line_break_config['Enabled'] && redundant_line_break_config['InspectBlocks']
|
71
|
+
@config.for_enabled_cop('Layout/RedundantLineBreak')['InspectBlocks']
|
73
72
|
end
|
74
73
|
end
|
75
74
|
end
|
@@ -134,10 +134,9 @@ module RuboCop
|
|
134
134
|
end
|
135
135
|
|
136
136
|
def disallow_endless_method_style?
|
137
|
-
|
138
|
-
return true unless endless_method_config['Enabled']
|
137
|
+
return true unless config.cop_enabled?('Style/EndlessMethod')
|
139
138
|
|
140
|
-
|
139
|
+
config.for_cop('Style/EndlessMethod')['EnforcedStyle'] == 'disallow'
|
141
140
|
end
|
142
141
|
end
|
143
142
|
end
|
@@ -78,38 +78,67 @@ module RuboCop
|
|
78
78
|
return unless node.arguments.one?
|
79
79
|
|
80
80
|
range_node = node.first_argument
|
81
|
-
|
82
|
-
unless (message, removal_range =
|
83
|
-
|
84
|
-
|
81
|
+
offense_range = find_offense_range(node)
|
82
|
+
return unless (message, removal_range =
|
83
|
+
offense_message_with_removal_range(node, range_node, offense_range))
|
84
|
+
|
85
|
+
# Changing the range to beginningless or endless when unparenthesized
|
86
|
+
# changes the semantics of the code, and thus will not be considered
|
87
|
+
# an offense.
|
88
|
+
return if removal_range != offense_range && unparenthesized_call?(node)
|
85
89
|
|
86
|
-
add_offense(
|
90
|
+
add_offense(offense_range, message: message) do |corrector|
|
87
91
|
corrector.remove(removal_range)
|
88
92
|
end
|
89
93
|
end
|
94
|
+
alias on_csend on_send
|
90
95
|
|
91
96
|
private
|
92
97
|
|
93
|
-
def
|
98
|
+
def unparenthesized_call?(node)
|
99
|
+
node.loc.dot && !node.parenthesized?
|
100
|
+
end
|
101
|
+
|
102
|
+
def find_offense_range(node)
|
103
|
+
if node.loc.dot
|
104
|
+
node.loc.dot.join(node.source_range.end)
|
105
|
+
else
|
106
|
+
node.loc.selector
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
def offense_message_with_removal_range(node, range_node, offense_range)
|
94
111
|
if range_from_zero_till_minus_one?(range_node)
|
95
|
-
[format(MSG_USELESS_RANGE, prefer:
|
112
|
+
[format(MSG_USELESS_RANGE, prefer: offense_range.source), offense_range]
|
96
113
|
elsif range_till_minus_one?(range_node)
|
97
114
|
[
|
98
|
-
|
115
|
+
offense_message_for_partial_range(node, endless(range_node), offense_range),
|
116
|
+
range_node.end
|
99
117
|
]
|
100
118
|
elsif range_from_zero?(range_node) && target_ruby_version >= 2.7
|
101
119
|
[
|
102
|
-
|
120
|
+
offense_message_for_partial_range(node, beginless(range_node), offense_range),
|
121
|
+
range_node.begin
|
103
122
|
]
|
104
123
|
end
|
105
124
|
end
|
106
125
|
|
126
|
+
def offense_message_for_partial_range(node, prefer, offense_range)
|
127
|
+
current = node.loc.dot ? arguments_source(node) : offense_range.source
|
128
|
+
prefer = "[#{prefer}]" unless node.loc.dot
|
129
|
+
format(MSG, prefer: prefer, current: current)
|
130
|
+
end
|
131
|
+
|
107
132
|
def endless(range_node)
|
108
|
-
"
|
133
|
+
"#{range_node.begin.source}#{range_node.loc.operator.source}"
|
109
134
|
end
|
110
135
|
|
111
136
|
def beginless(range_node)
|
112
|
-
"
|
137
|
+
"#{range_node.loc.operator.source}#{range_node.end.source}"
|
138
|
+
end
|
139
|
+
|
140
|
+
def arguments_source(node)
|
141
|
+
node.first_argument.source_range.join(node.last_argument.source_range.end).source
|
113
142
|
end
|
114
143
|
end
|
115
144
|
end
|
@@ -23,6 +23,10 @@ module RuboCop
|
|
23
23
|
# `define_method`, therefore, `super` used within these blocks will be allowed.
|
24
24
|
# This approach might result in false negatives, yet ensuring safe detection takes precedence.
|
25
25
|
#
|
26
|
+
# NOTE: When forwarding the same arguments but replacing the block argument with a new inline
|
27
|
+
# block, it is not necessary to explicitly list the non-block arguments. As such, an offense
|
28
|
+
# will be registered in this case.
|
29
|
+
#
|
26
30
|
# @example
|
27
31
|
# # bad
|
28
32
|
# def method(*args, **kwargs)
|
@@ -44,6 +48,16 @@ module RuboCop
|
|
44
48
|
# super()
|
45
49
|
# end
|
46
50
|
#
|
51
|
+
# # bad - forwarding with overridden block
|
52
|
+
# def method(*args, **kwargs, &block)
|
53
|
+
# super(*args, **kwargs) { do_something }
|
54
|
+
# end
|
55
|
+
#
|
56
|
+
# # good - implicitly passing all non-block arguments
|
57
|
+
# def method(*args, **kwargs, &block)
|
58
|
+
# super { do_something }
|
59
|
+
# end
|
60
|
+
#
|
47
61
|
# # good - assigning to the block variable before calling super
|
48
62
|
# def method(&block)
|
49
63
|
# # Assigning to the block variable would pass the old value to super,
|
@@ -58,44 +72,75 @@ module RuboCop
|
|
58
72
|
ASSIGN_TYPES = %i[or_asgn lvasgn].freeze
|
59
73
|
|
60
74
|
MSG = 'Call `super` without arguments and parentheses when the signature is identical.'
|
75
|
+
MSG_INLINE_BLOCK = 'Call `super` without arguments and parentheses when all positional ' \
|
76
|
+
'and keyword arguments are forwarded.'
|
61
77
|
|
62
78
|
def on_super(super_node)
|
63
|
-
def_node = super_node
|
79
|
+
return unless (def_node = find_def_node(super_node))
|
80
|
+
|
81
|
+
def_node_args = def_node.arguments.argument_list
|
82
|
+
super_args = preprocess_super_args(super_node.arguments)
|
83
|
+
|
84
|
+
return unless arguments_identical?(def_node, super_node, def_node_args, super_args)
|
85
|
+
|
86
|
+
# If the number of arguments to the def node and super node are different here,
|
87
|
+
# it's because the block argument is not forwarded.
|
88
|
+
message = def_node_args.size == super_args.size ? MSG : MSG_INLINE_BLOCK
|
89
|
+
add_offense(super_node, message: message) do |corrector|
|
90
|
+
corrector.replace(super_node, 'super')
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
94
|
+
private
|
95
|
+
|
96
|
+
def find_def_node(super_node)
|
97
|
+
super_node.ancestors.find do |node|
|
64
98
|
# When defining dynamic methods, implicitly calling `super` is not possible.
|
65
99
|
# Since there is a possibility of delegation to `define_method`,
|
66
100
|
# `super` used within the block is always allowed.
|
67
|
-
break if node.block_type?
|
101
|
+
break if node.block_type? && !block_sends_to_super?(super_node, node)
|
68
102
|
|
69
103
|
break node if DEF_TYPES.include?(node.type)
|
70
104
|
end
|
71
|
-
return unless def_node
|
72
|
-
return unless arguments_identical?(def_node, def_node.arguments.argument_list,
|
73
|
-
super_node.arguments)
|
74
|
-
|
75
|
-
add_offense(super_node) { |corrector| corrector.replace(super_node, 'super') }
|
76
105
|
end
|
77
106
|
|
78
|
-
private
|
79
|
-
|
80
107
|
# rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
|
81
|
-
def arguments_identical?(def_node, def_args, super_args)
|
82
|
-
|
83
|
-
return false if def_args.size != super_args.size
|
108
|
+
def arguments_identical?(def_node, super_node, def_args, super_args)
|
109
|
+
return false if argument_list_size_differs?(def_args, super_args, super_node)
|
84
110
|
|
85
111
|
def_args.zip(super_args).each do |def_arg, super_arg|
|
86
112
|
next if positional_arg_same?(def_arg, super_arg)
|
87
113
|
next if positional_rest_arg_same(def_arg, super_arg)
|
88
114
|
next if keyword_arg_same?(def_arg, super_arg)
|
89
115
|
next if keyword_rest_arg_same?(def_arg, super_arg)
|
90
|
-
next if block_arg_same?(def_node, def_arg, super_arg)
|
116
|
+
next if block_arg_same?(def_node, super_node, def_arg, super_arg)
|
91
117
|
next if forward_arg_same?(def_arg, super_arg)
|
92
118
|
|
93
119
|
return false
|
94
120
|
end
|
121
|
+
|
95
122
|
true
|
96
123
|
end
|
97
124
|
# rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
|
98
125
|
|
126
|
+
def argument_list_size_differs?(def_args, super_args, super_node)
|
127
|
+
# If the def node has a block argument and the super node has an explicit block,
|
128
|
+
# the number of arguments is the same, so ignore the def node block arg.
|
129
|
+
def_args_size = def_args.size
|
130
|
+
def_args_size -= 1 if def_args.any?(&:blockarg_type?) && block_sends_to_super?(super_node)
|
131
|
+
|
132
|
+
def_args_size != super_args.size
|
133
|
+
end
|
134
|
+
|
135
|
+
def block_sends_to_super?(super_node, parent_node = super_node.parent)
|
136
|
+
# Checks if the send node of a block is the given super node,
|
137
|
+
# or a method chain containing it.
|
138
|
+
return false unless parent_node
|
139
|
+
return false unless parent_node.type?(:block, :numblock)
|
140
|
+
|
141
|
+
parent_node.send_node.each_node(:super).any?(super_node)
|
142
|
+
end
|
143
|
+
|
99
144
|
def positional_arg_same?(def_arg, super_arg)
|
100
145
|
return false unless def_arg.arg_type? || def_arg.optarg_type?
|
101
146
|
return false unless super_arg.lvar_type?
|
@@ -133,8 +178,11 @@ module RuboCop
|
|
133
178
|
def_arg.name == lvar_node.children.first
|
134
179
|
end
|
135
180
|
|
136
|
-
def block_arg_same?(def_node, def_arg, super_arg)
|
137
|
-
return false unless def_arg.blockarg_type?
|
181
|
+
def block_arg_same?(def_node, super_node, def_arg, super_arg)
|
182
|
+
return false unless def_arg.blockarg_type?
|
183
|
+
return true if block_sends_to_super?(super_node)
|
184
|
+
return false unless super_arg.block_pass_type?
|
185
|
+
|
138
186
|
# anonymous forwarding
|
139
187
|
return true if (block_pass_child = super_arg.children.first).nil? && def_arg.name.nil?
|
140
188
|
|