rubocop-ast 1.37.0 → 1.39.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/lib/rubocop/ast/node/args_node.rb +1 -1
- data/lib/rubocop/ast/node/array_node.rb +3 -3
- data/lib/rubocop/ast/node/if_node.rb +2 -2
- data/lib/rubocop/ast/node/masgn_node.rb +1 -1
- data/lib/rubocop/ast/node/mixin/descendence.rb +3 -3
- data/lib/rubocop/ast/node/mixin/hash_element_node.rb +2 -0
- data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +4 -4
- data/lib/rubocop/ast/node/mixin/parameterized_node.rb +1 -1
- data/lib/rubocop/ast/node/mixin/predicate_operator_node.rb +7 -2
- data/lib/rubocop/ast/node/str_node.rb +4 -4
- data/lib/rubocop/ast/node.rb +27 -19
- data/lib/rubocop/ast/node_pattern/node.rb +7 -1
- data/lib/rubocop/ast/processed_source.rb +78 -14
- data/lib/rubocop/ast/token.rb +2 -1
- data/lib/rubocop/ast/traversal.rb +29 -20
- data/lib/rubocop/ast/utilities/simple_forwardable.rb +16 -5
- data/lib/rubocop/ast/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7d2a487128abbc36ae15a961ea8b7d1e5c63a266efb81cfbb815965d4f77a4e0
|
4
|
+
data.tar.gz: 10af6d44e0a7b22a6e43f3e14e720c0df6991be9efc2e38ad47c5526d170d935
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4eec6dc6fbb933a3c8628cfc54332e1b019b7423b298ac155899cfc62db3e52ddfd1a3308d20bea5e856250ed56af0a84ae856e4ef482e7368e0f1c1be264639
|
7
|
+
data.tar.gz: 1e20432910c02a763ccc0d99ac18771b4ac0ac578c2d749ecc77e9084ec4784551fb8778ee3bbdf24709a9ec00f046320cb37c9975038c04f5674a24db943c04
|
@@ -7,8 +7,8 @@ module RuboCop
|
|
7
7
|
# to all `array` nodes within RuboCop.
|
8
8
|
class ArrayNode < Node
|
9
9
|
PERCENT_LITERAL_TYPES = {
|
10
|
-
string:
|
11
|
-
symbol:
|
10
|
+
string: /\A%[wW]/,
|
11
|
+
symbol: /\A%[iI]/
|
12
12
|
}.freeze
|
13
13
|
private_constant :PERCENT_LITERAL_TYPES
|
14
14
|
|
@@ -50,7 +50,7 @@ module RuboCop
|
|
50
50
|
# @return [Boolean] whether the array is enclosed in percent brackets
|
51
51
|
def percent_literal?(type = nil)
|
52
52
|
if type
|
53
|
-
loc.begin
|
53
|
+
loc.begin&.source&.match?(PERCENT_LITERAL_TYPES.fetch(type))
|
54
54
|
else
|
55
55
|
loc.begin&.source&.start_with?('%')
|
56
56
|
end
|
@@ -47,14 +47,14 @@ module RuboCop
|
|
47
47
|
#
|
48
48
|
# @return [Boolean] whether the node has an `else` clause
|
49
49
|
def else?
|
50
|
-
loc
|
50
|
+
loc?(:else)
|
51
51
|
end
|
52
52
|
|
53
53
|
# Checks whether the `if` node is a ternary operator.
|
54
54
|
#
|
55
55
|
# @return [Boolean] whether the `if` node is a ternary operator
|
56
56
|
def ternary?
|
57
|
-
loc
|
57
|
+
loc?(:question)
|
58
58
|
end
|
59
59
|
|
60
60
|
# Returns the keyword of the `if` statement as a string. Returns an empty
|
@@ -20,7 +20,7 @@ module RuboCop
|
|
20
20
|
# @return [Array<Symbol>] names of all the variables being assigned
|
21
21
|
def names
|
22
22
|
assignments.map do |assignment|
|
23
|
-
if assignment.
|
23
|
+
if assignment.type?(:send, :indexasgn)
|
24
24
|
assignment.method_name
|
25
25
|
else
|
26
26
|
assignment.name
|
@@ -25,7 +25,7 @@ module RuboCop
|
|
25
25
|
children.each do |child|
|
26
26
|
next unless child.is_a?(::AST::Node)
|
27
27
|
|
28
|
-
yield child if types.empty? ||
|
28
|
+
yield child if types.empty? || child.type?(*types)
|
29
29
|
end
|
30
30
|
|
31
31
|
self
|
@@ -95,7 +95,7 @@ module RuboCop
|
|
95
95
|
def each_node(*types, &block)
|
96
96
|
return to_enum(__method__, *types) unless block
|
97
97
|
|
98
|
-
yield self if types.empty? ||
|
98
|
+
yield self if types.empty? || type?(*types)
|
99
99
|
|
100
100
|
visit_descendants(types, &block)
|
101
101
|
|
@@ -108,7 +108,7 @@ module RuboCop
|
|
108
108
|
children.each do |child|
|
109
109
|
next unless child.is_a?(::AST::Node)
|
110
110
|
|
111
|
-
yield child if types.empty? ||
|
111
|
+
yield child if types.empty? || child.type?(*types)
|
112
112
|
child.visit_descendants(types, &block)
|
113
113
|
end
|
114
114
|
end
|
@@ -99,7 +99,9 @@ module RuboCop
|
|
99
99
|
|
100
100
|
def valid_argument_types?
|
101
101
|
[first, second].all? do |argument|
|
102
|
+
# rubocop:disable InternalAffairs/NodeTypeMultiplePredicates
|
102
103
|
argument.pair_type? || argument.kwsplat_type?
|
104
|
+
# rubocop:enable InternalAffairs/NodeTypeMultiplePredicates
|
103
105
|
end
|
104
106
|
end
|
105
107
|
|
@@ -105,7 +105,7 @@ module RuboCop
|
|
105
105
|
#
|
106
106
|
# @return [Boolean] whether the dispatched method is a setter
|
107
107
|
def setter_method?
|
108
|
-
loc
|
108
|
+
loc?(:operator)
|
109
109
|
end
|
110
110
|
alias assignment? setter_method?
|
111
111
|
|
@@ -165,7 +165,7 @@ module RuboCop
|
|
165
165
|
#
|
166
166
|
# @return [Boolean] whether the dispatched method has a block
|
167
167
|
def block_literal?
|
168
|
-
|
168
|
+
parent&.any_block_type? && eql?(parent.send_node)
|
169
169
|
end
|
170
170
|
|
171
171
|
# Checks whether this node is an arithmetic operation
|
@@ -201,7 +201,7 @@ module RuboCop
|
|
201
201
|
|
202
202
|
return unless node.send_type? && node.receiver.nil? && arg.is_a?(::AST::Node)
|
203
203
|
|
204
|
-
return arg if arg.
|
204
|
+
return arg if arg.type?(:def, :defs)
|
205
205
|
|
206
206
|
def_modifier(arg)
|
207
207
|
end
|
@@ -260,7 +260,7 @@ module RuboCop
|
|
260
260
|
^{ # or the parent is...
|
261
261
|
sclass class module class_constructor? # a class-like node
|
262
262
|
[ { # or some "wrapper"
|
263
|
-
kwbegin begin
|
263
|
+
kwbegin begin any_block
|
264
264
|
(if _condition <%0 _>) # note: we're excluding the condition of `if` nodes
|
265
265
|
}
|
266
266
|
#in_macro_scope? # that is itself in a macro scope
|
@@ -57,7 +57,7 @@ module RuboCop
|
|
57
57
|
# @return [Boolean] whether the last argument of the node is a block pass
|
58
58
|
def block_argument?
|
59
59
|
arguments? &&
|
60
|
-
|
60
|
+
last_argument.type?(:block_pass, :blockarg)
|
61
61
|
end
|
62
62
|
|
63
63
|
# A specialized `ParameterizedNode` for node that have a single child
|
@@ -14,6 +14,11 @@ module RuboCop
|
|
14
14
|
SEMANTIC_OR = 'or'
|
15
15
|
private_constant :SEMANTIC_OR
|
16
16
|
|
17
|
+
LOGICAL_OPERATORS = [LOGICAL_AND, LOGICAL_OR].freeze
|
18
|
+
private_constant :LOGICAL_OPERATORS
|
19
|
+
SEMANTIC_OPERATORS = [SEMANTIC_AND, SEMANTIC_OR].freeze
|
20
|
+
private_constant :SEMANTIC_OPERATORS
|
21
|
+
|
17
22
|
# Returns the operator as a string.
|
18
23
|
#
|
19
24
|
# @return [String] the operator
|
@@ -25,14 +30,14 @@ module RuboCop
|
|
25
30
|
#
|
26
31
|
# @return [Boolean] whether this is a logical operator
|
27
32
|
def logical_operator?
|
28
|
-
operator
|
33
|
+
LOGICAL_OPERATORS.include?(operator)
|
29
34
|
end
|
30
35
|
|
31
36
|
# Checks whether this is a semantic operator.
|
32
37
|
#
|
33
38
|
# @return [Boolean] whether this is a semantic operator
|
34
39
|
def semantic_operator?
|
35
|
-
operator
|
40
|
+
SEMANTIC_OPERATORS.include?(operator)
|
36
41
|
end
|
37
42
|
end
|
38
43
|
end
|
@@ -13,6 +13,7 @@ module RuboCop
|
|
13
13
|
:q => /\A%q/,
|
14
14
|
:Q => /\A%Q/
|
15
15
|
}.freeze
|
16
|
+
private_constant :PERCENT_LITERAL_TYPES
|
16
17
|
|
17
18
|
def single_quoted?
|
18
19
|
loc_is?(:begin, "'")
|
@@ -42,13 +43,12 @@ module RuboCop
|
|
42
43
|
#
|
43
44
|
# @return [Boolean] whether the string is enclosed in percent brackets
|
44
45
|
def percent_literal?(type = nil)
|
45
|
-
|
46
|
-
return false unless opening_delimiter
|
46
|
+
return false unless loc?(:begin)
|
47
47
|
|
48
48
|
if type
|
49
|
-
|
49
|
+
loc.begin.source.match?(PERCENT_LITERAL_TYPES.fetch(type))
|
50
50
|
else
|
51
|
-
|
51
|
+
loc.begin.source.start_with?('%')
|
52
52
|
end
|
53
53
|
end
|
54
54
|
end
|
data/lib/rubocop/ast/node.rb
CHANGED
@@ -76,9 +76,6 @@ module RuboCop
|
|
76
76
|
OPERATOR_KEYWORDS = %i[and or].to_set.freeze
|
77
77
|
# @api private
|
78
78
|
SPECIAL_KEYWORDS = %w[__FILE__ __LINE__ __ENCODING__].to_set.freeze
|
79
|
-
# @api private
|
80
|
-
ARGUMENT_TYPES = %i[arg optarg restarg kwarg kwoptarg kwrestarg
|
81
|
-
blockarg forward_arg shadowarg].to_set.freeze
|
82
79
|
|
83
80
|
LITERAL_RECURSIVE_METHODS = (COMPARISON_OPERATORS + %i[* ! <=>]).freeze
|
84
81
|
LITERAL_RECURSIVE_TYPES = (OPERATOR_KEYWORDS + COMPOSITE_LITERALS + %i[begin pair]).freeze
|
@@ -98,7 +95,7 @@ module RuboCop
|
|
98
95
|
kwrestarg: :argument,
|
99
96
|
blockarg: :argument,
|
100
97
|
forward_arg: :argument,
|
101
|
-
|
98
|
+
shadowarg: :argument,
|
102
99
|
|
103
100
|
true: :boolean,
|
104
101
|
false: :boolean,
|
@@ -112,7 +109,10 @@ module RuboCop
|
|
112
109
|
erange: :range,
|
113
110
|
|
114
111
|
send: :call,
|
115
|
-
csend: :call
|
112
|
+
csend: :call,
|
113
|
+
|
114
|
+
block: :any_block,
|
115
|
+
numblock: :any_block
|
116
116
|
}.freeze
|
117
117
|
private_constant :GROUP_FOR_TYPE
|
118
118
|
|
@@ -343,7 +343,7 @@ module RuboCop
|
|
343
343
|
|
344
344
|
# @!method receiver(node = self)
|
345
345
|
def_node_matcher :receiver, <<~PATTERN
|
346
|
-
{(send $_ ...) (
|
346
|
+
{(send $_ ...) (any_block (call $_ ...) ...)}
|
347
347
|
PATTERN
|
348
348
|
|
349
349
|
# @!method str_content(node = self)
|
@@ -528,21 +528,30 @@ module RuboCop
|
|
528
528
|
GROUP_FOR_TYPE[type] == :range
|
529
529
|
end
|
530
530
|
|
531
|
+
def any_block_type?
|
532
|
+
GROUP_FOR_TYPE[type] == :any_block
|
533
|
+
end
|
534
|
+
|
531
535
|
def guard_clause?
|
532
536
|
node = operator_keyword? ? rhs : self
|
533
537
|
|
534
538
|
node.match_guard_clause?
|
535
539
|
end
|
536
540
|
|
541
|
+
# Shortcut to safely check if a location is present
|
542
|
+
# @return [Boolean]
|
543
|
+
def loc?(which_loc)
|
544
|
+
return false unless loc.respond_to?(which_loc)
|
545
|
+
|
546
|
+
!loc.public_send(which_loc).nil?
|
547
|
+
end
|
548
|
+
|
537
549
|
# Shortcut to safely test a particular location, even if
|
538
550
|
# this location does not exist or is `nil`
|
539
551
|
def loc_is?(which_loc, str)
|
540
|
-
return false unless loc
|
541
|
-
|
542
|
-
location = loc.public_send(which_loc)
|
543
|
-
return false unless location
|
552
|
+
return false unless loc?(which_loc)
|
544
553
|
|
545
|
-
|
554
|
+
loc.public_send(which_loc).is?(str)
|
546
555
|
end
|
547
556
|
|
548
557
|
# @!method match_guard_clause?(node = self)
|
@@ -558,7 +567,7 @@ module RuboCop
|
|
558
567
|
PATTERN
|
559
568
|
|
560
569
|
# @!method lambda?(node = self)
|
561
|
-
def_node_matcher :lambda?, '(
|
570
|
+
def_node_matcher :lambda?, '(any_block (send nil? :lambda) ...)'
|
562
571
|
|
563
572
|
# @!method lambda_or_proc?(node = self)
|
564
573
|
def_node_matcher :lambda_or_proc?, '{lambda? proc?}'
|
@@ -571,7 +580,7 @@ module RuboCop
|
|
571
580
|
{
|
572
581
|
(send #global_const?({:Class :Module :Struct}) :new ...)
|
573
582
|
(send #global_const?(:Data) :define ...)
|
574
|
-
(
|
583
|
+
(any_block {
|
575
584
|
(send #global_const?({:Class :Module :Struct}) :new ...)
|
576
585
|
(send #global_const?(:Data) :define ...)
|
577
586
|
} ...)
|
@@ -581,20 +590,20 @@ module RuboCop
|
|
581
590
|
# @deprecated Use `:class_constructor?`
|
582
591
|
# @!method struct_constructor?(node = self)
|
583
592
|
def_node_matcher :struct_constructor?, <<~PATTERN
|
584
|
-
(
|
593
|
+
(any_block (send #global_const?(:Struct) :new ...) _ $_)
|
585
594
|
PATTERN
|
586
595
|
|
587
596
|
# @!method class_definition?(node = self)
|
588
597
|
def_node_matcher :class_definition?, <<~PATTERN
|
589
598
|
{(class _ _ $_)
|
590
599
|
(sclass _ $_)
|
591
|
-
(
|
600
|
+
(any_block (send #global_const?({:Struct :Class}) :new ...) _ $_)}
|
592
601
|
PATTERN
|
593
602
|
|
594
603
|
# @!method module_definition?(node = self)
|
595
604
|
def_node_matcher :module_definition?, <<~PATTERN
|
596
605
|
{(module _ $_)
|
597
|
-
(
|
606
|
+
(any_block (send #global_const?(:Module) :new ...) _ $_)}
|
598
607
|
PATTERN
|
599
608
|
|
600
609
|
# Some expressions are evaluated for their value, some for their side
|
@@ -657,8 +666,7 @@ module RuboCop
|
|
657
666
|
last_node = self
|
658
667
|
|
659
668
|
while (current_node = last_node.parent)
|
660
|
-
yield current_node if types.empty? ||
|
661
|
-
types.include?(current_node.type)
|
669
|
+
yield current_node if types.empty? || current_node.type?(*types)
|
662
670
|
last_node = current_node
|
663
671
|
end
|
664
672
|
end
|
@@ -677,7 +685,7 @@ module RuboCop
|
|
677
685
|
def case_if_value_used?
|
678
686
|
# (case <condition> <when...>)
|
679
687
|
# (if <condition> <truebranch> <falsebranch>)
|
680
|
-
sibling_index.zero?
|
688
|
+
sibling_index.zero? || parent.value_used?
|
681
689
|
end
|
682
690
|
|
683
691
|
def while_until_value_used?
|
@@ -48,7 +48,7 @@ module RuboCop
|
|
48
48
|
children[0]
|
49
49
|
end
|
50
50
|
|
51
|
-
# @return [Integer] nb of captures
|
51
|
+
# @return [Integer] nb of captures that this node will emit
|
52
52
|
def nb_captures
|
53
53
|
children_nodes.sum(&:nb_captures)
|
54
54
|
end
|
@@ -243,6 +243,12 @@ module RuboCop
|
|
243
243
|
|
244
244
|
[with(children: new_children)]
|
245
245
|
end
|
246
|
+
|
247
|
+
# Each child in a union must contain the same number
|
248
|
+
# of captures. Only one branch ends up capturing.
|
249
|
+
def nb_captures
|
250
|
+
child.nb_captures
|
251
|
+
end
|
246
252
|
end
|
247
253
|
|
248
254
|
# Registry
|
@@ -4,6 +4,27 @@ require 'digest/sha1'
|
|
4
4
|
|
5
5
|
module RuboCop
|
6
6
|
module AST
|
7
|
+
# A `Prism` interface's class that provides a fixed `Prism::ParseLexResult` instead of parsing.
|
8
|
+
#
|
9
|
+
# This class implements the `parse_lex` method to return a preparsed `Prism::ParseLexResult`
|
10
|
+
# rather than parsing the source code. When the parse result is already available externally,
|
11
|
+
# such as in Ruby LSP, the Prism parsing process can be bypassed.
|
12
|
+
class PrismPreparsed
|
13
|
+
def initialize(prism_result)
|
14
|
+
unless prism_result.is_a?(Prism::ParseLexResult)
|
15
|
+
raise ArgumentError, <<~MESSAGE
|
16
|
+
Expected a `Prism::ParseLexResult` object, but received `#{prism_result.class}`.
|
17
|
+
MESSAGE
|
18
|
+
end
|
19
|
+
|
20
|
+
@prism_result = prism_result
|
21
|
+
end
|
22
|
+
|
23
|
+
def parse_lex(_source, **_prism_options)
|
24
|
+
@prism_result
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
7
28
|
# ProcessedSource contains objects which are generated by Parser
|
8
29
|
# and other information such as disabled lines for cops.
|
9
30
|
# It also provides a convenient way to access source lines.
|
@@ -25,7 +46,9 @@ module RuboCop
|
|
25
46
|
new(file, ruby_version, path, parser_engine: parser_engine)
|
26
47
|
end
|
27
48
|
|
28
|
-
def initialize(
|
49
|
+
def initialize(
|
50
|
+
source, ruby_version, path = nil, parser_engine: :parser_whitequark, prism_result: nil
|
51
|
+
)
|
29
52
|
parser_engine = parser_engine.to_sym
|
30
53
|
unless PARSER_ENGINES.include?(parser_engine)
|
31
54
|
raise ArgumentError, 'The keyword argument `parser_engine` accepts `parser_whitequark` ' \
|
@@ -44,7 +67,7 @@ module RuboCop
|
|
44
67
|
@parser_engine = parser_engine
|
45
68
|
@parser_error = nil
|
46
69
|
|
47
|
-
parse(source, ruby_version, parser_engine)
|
70
|
+
parse(source, ruby_version, parser_engine, prism_result)
|
48
71
|
end
|
49
72
|
|
50
73
|
def ast_with_comments
|
@@ -202,7 +225,7 @@ module RuboCop
|
|
202
225
|
end
|
203
226
|
end
|
204
227
|
|
205
|
-
def parse(source, ruby_version, parser_engine)
|
228
|
+
def parse(source, ruby_version, parser_engine, prism_result)
|
206
229
|
buffer_name = @path || STRING_SOURCE_NAME
|
207
230
|
@buffer = Parser::Source::Buffer.new(buffer_name, 1)
|
208
231
|
|
@@ -216,7 +239,9 @@ module RuboCop
|
|
216
239
|
return
|
217
240
|
end
|
218
241
|
|
219
|
-
|
242
|
+
parser = create_parser(ruby_version, parser_engine, prism_result)
|
243
|
+
|
244
|
+
@ast, @comments, @tokens = tokenize(parser)
|
220
245
|
end
|
221
246
|
|
222
247
|
def tokenize(parser)
|
@@ -285,19 +310,14 @@ module RuboCop
|
|
285
310
|
raise ArgumentError, "RuboCop found unknown Ruby version: #{ruby_version.inspect}"
|
286
311
|
end
|
287
312
|
when :parser_prism
|
288
|
-
|
289
|
-
require 'prism'
|
290
|
-
rescue LoadError
|
291
|
-
warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
|
292
|
-
exit!
|
293
|
-
end
|
313
|
+
require_prism
|
294
314
|
|
295
315
|
case ruby_version
|
296
316
|
when 3.3
|
297
|
-
|
317
|
+
require_prism_translation_parser(ruby_version)
|
298
318
|
Prism::Translation::Parser33
|
299
319
|
when 3.4
|
300
|
-
|
320
|
+
require_prism_translation_parser(ruby_version)
|
301
321
|
Prism::Translation::Parser34
|
302
322
|
else
|
303
323
|
raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
|
@@ -306,10 +326,53 @@ module RuboCop
|
|
306
326
|
end
|
307
327
|
end
|
308
328
|
|
309
|
-
|
329
|
+
# Prism is a native extension, a `LoadError` will be raised if linked to an incompatible
|
330
|
+
# Ruby version. Only raise if it really was caused by Prism not being present.
|
331
|
+
def require_prism
|
332
|
+
require 'prism'
|
333
|
+
rescue LoadError => e
|
334
|
+
raise unless e.path == 'prism'
|
335
|
+
|
336
|
+
warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
|
337
|
+
exit!
|
338
|
+
end
|
339
|
+
|
340
|
+
# While Prism is not yet a dependency, users may run with outdated versions that
|
341
|
+
# don't have all the parsers.
|
342
|
+
def require_prism_translation_parser(version)
|
343
|
+
require "prism/translation/parser#{version.to_s.delete('.')}"
|
344
|
+
rescue LoadError
|
345
|
+
warn <<~MESSAGE
|
346
|
+
Error: Unable to load Prism parser for Ruby #{version}.
|
347
|
+
* If you're using Bundler and don't yet have `gem 'prism'` as a dependency, add it now.
|
348
|
+
* If you're using Bundler and already have `gem 'prism'` as a dependency, update it to the most recent version.
|
349
|
+
* If you don't use Bundler, run `gem update prism`.
|
350
|
+
MESSAGE
|
351
|
+
exit!
|
352
|
+
end
|
353
|
+
|
354
|
+
# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
|
355
|
+
def create_parser(ruby_version, parser_engine, prism_result)
|
310
356
|
builder = RuboCop::AST::Builder.new
|
311
357
|
|
312
|
-
parser_class(ruby_version, parser_engine)
|
358
|
+
parser_class = parser_class(ruby_version, parser_engine)
|
359
|
+
|
360
|
+
# NOTE: Check if the `Prism#initialize` method has the `:parser` keyword argument.
|
361
|
+
# The `:parser` keyword argument cannot be used to switch parsers because older versions of
|
362
|
+
# Prism do not support it.
|
363
|
+
parser_switch_available = parser_class.instance_method(:initialize).parameters.assoc(:key)
|
364
|
+
|
365
|
+
parser_instance = if prism_result && parser_switch_available
|
366
|
+
# NOTE: Since it is intended for use with Ruby LSP, it targets only Prism.
|
367
|
+
# If there is no reuse of a pre-parsed result, such as in Ruby LSP,
|
368
|
+
# regular parsing with Prism occurs, and `else` branch will be executed.
|
369
|
+
prism_reparsed = PrismPreparsed.new(prism_result)
|
370
|
+
parser_class.new(builder, parser: prism_reparsed)
|
371
|
+
else
|
372
|
+
parser_class.new(builder)
|
373
|
+
end
|
374
|
+
|
375
|
+
parser_instance.tap do |parser|
|
313
376
|
# On JRuby there's a risk that we hang in tokenize() if we
|
314
377
|
# don't set the all errors as fatal flag. The problem is caused by a bug
|
315
378
|
# in Racc that is discussed in issue #93 of the whitequark/parser
|
@@ -321,6 +384,7 @@ module RuboCop
|
|
321
384
|
end
|
322
385
|
end
|
323
386
|
end
|
387
|
+
# rubocop:enable Metrics/AbcSize, Metrics/MethodLength
|
324
388
|
|
325
389
|
def first_token_index(range_or_node)
|
326
390
|
begin_pos = source_range(range_or_node).begin_pos
|
data/lib/rubocop/ast/token.rb
CHANGED
@@ -5,6 +5,7 @@ module RuboCop
|
|
5
5
|
# A basic wrapper around Parser's tokens.
|
6
6
|
class Token
|
7
7
|
LEFT_PAREN_TYPES = %i[tLPAREN tLPAREN2].freeze
|
8
|
+
LEFT_CURLY_TYPES = %i[tLCURLY tLAMBEG].freeze
|
8
9
|
|
9
10
|
attr_reader :pos, :type, :text
|
10
11
|
|
@@ -83,7 +84,7 @@ module RuboCop
|
|
83
84
|
end
|
84
85
|
|
85
86
|
def left_curly_brace?
|
86
|
-
type
|
87
|
+
LEFT_CURLY_TYPES.include?(type)
|
87
88
|
end
|
88
89
|
|
89
90
|
def right_curly_brace?
|
@@ -26,16 +26,18 @@ module RuboCop
|
|
26
26
|
SEND = 'send(TYPE_TO_METHOD[child.type], child)'
|
27
27
|
assign_code = 'child = node.children[%<index>i]'
|
28
28
|
code = "#{assign_code}\n#{SEND}"
|
29
|
+
# How a particular child node should be visited. For example, if a child node
|
30
|
+
# can be nil it should be guarded behind a nil check. Or, if a child node is a literal
|
31
|
+
# (like a symbol) then the literal itself should not be visited.
|
29
32
|
TEMPLATE = {
|
30
33
|
skip: '',
|
31
34
|
always: code,
|
32
35
|
nil?: "#{code} if child"
|
33
36
|
}.freeze
|
34
37
|
|
35
|
-
def def_callback(type, *
|
36
|
-
|
37
|
-
|
38
|
-
body: self.body(signature, arity_check))
|
38
|
+
def def_callback(type, *child_node_types,
|
39
|
+
expected_children_count: child_node_types.size..child_node_types.size,
|
40
|
+
body: self.body(child_node_types, expected_children_count))
|
39
41
|
type, *aliases = type
|
40
42
|
lineno = caller_locations(1, 1).first.lineno
|
41
43
|
module_eval(<<~RUBY, __FILE__, lineno)
|
@@ -49,16 +51,23 @@ module RuboCop
|
|
49
51
|
end
|
50
52
|
end
|
51
53
|
|
52
|
-
def body(
|
53
|
-
|
54
|
-
|
55
|
-
|
54
|
+
def body(child_node_types, expected_children_count)
|
55
|
+
visit_children_code =
|
56
|
+
child_node_types
|
57
|
+
.map.with_index do |child_type, i|
|
58
|
+
TEMPLATE.fetch(child_type).gsub('%<index>i', i.to_s)
|
56
59
|
end
|
57
|
-
.unshift(prelude)
|
58
60
|
.join("\n")
|
61
|
+
|
62
|
+
<<~BODY
|
63
|
+
#{children_count_check_code(expected_children_count)}
|
64
|
+
#{visit_children_code}
|
65
|
+
BODY
|
59
66
|
end
|
60
67
|
|
61
|
-
def
|
68
|
+
def children_count_check_code(range)
|
69
|
+
return '' unless ENV.fetch('RUBOCOP_DEBUG', false)
|
70
|
+
|
62
71
|
<<~RUBY
|
63
72
|
n = node.children.size
|
64
73
|
raise DebugError, [
|
@@ -72,18 +81,18 @@ module RuboCop
|
|
72
81
|
extend CallbackCompiler
|
73
82
|
send_code = CallbackCompiler::SEND
|
74
83
|
|
75
|
-
###
|
84
|
+
### children count == 0
|
76
85
|
no_children = %i[true false nil self cbase zsuper redo retry
|
77
86
|
forward_args forwarded_args match_nil_pattern
|
78
87
|
forward_arg forwarded_restarg forwarded_kwrestarg
|
79
88
|
lambda empty_else kwnilarg
|
80
89
|
__FILE__ __LINE__ __ENCODING__]
|
81
90
|
|
82
|
-
###
|
91
|
+
### children count == 0..1
|
83
92
|
opt_symbol_child = %i[restarg kwrestarg]
|
84
93
|
opt_node_child = %i[splat kwsplat match_rest]
|
85
94
|
|
86
|
-
###
|
95
|
+
### children count == 1
|
87
96
|
literal_child = %i[int float complex
|
88
97
|
rational str sym lvar
|
89
98
|
ivar cvar gvar nth_ref back_ref
|
@@ -100,12 +109,12 @@ module RuboCop
|
|
100
109
|
NO_CHILD_NODES = (no_children + opt_symbol_child + literal_child).to_set.freeze
|
101
110
|
private_constant :NO_CHILD_NODES # Used by Commissioner
|
102
111
|
|
103
|
-
###
|
112
|
+
### children count > 1
|
104
113
|
symbol_then_opt_node = %i[lvasgn ivasgn cvasgn gvasgn]
|
105
114
|
symbol_then_node_or_nil = %i[optarg kwoptarg]
|
106
115
|
node_then_opt_node = %i[while until module sclass]
|
107
116
|
|
108
|
-
### variable
|
117
|
+
### variable children count
|
109
118
|
many_node_children = %i[dstr dsym xstr regexp array hash pair
|
110
119
|
mlhs masgn or_asgn and_asgn rasgn mrasgn
|
111
120
|
undef alias args super yield or and
|
@@ -121,18 +130,18 @@ module RuboCop
|
|
121
130
|
|
122
131
|
### Callbacks for above
|
123
132
|
def_callback no_children
|
124
|
-
def_callback opt_symbol_child, :skip,
|
125
|
-
def_callback opt_node_child, :nil?,
|
133
|
+
def_callback opt_symbol_child, :skip, expected_children_count: 0..1
|
134
|
+
def_callback opt_node_child, :nil?, expected_children_count: 0..1
|
126
135
|
|
127
136
|
def_callback literal_child, :skip
|
128
137
|
def_callback node_child, :always
|
129
138
|
def_callback node_or_nil_child, :nil?
|
130
139
|
|
131
|
-
def_callback symbol_then_opt_node, :skip, :nil?,
|
140
|
+
def_callback symbol_then_opt_node, :skip, :nil?, expected_children_count: 1..2
|
132
141
|
def_callback symbol_then_node_or_nil, :skip, :nil?
|
133
142
|
def_callback node_then_opt_node, :always, :nil?
|
134
143
|
|
135
|
-
def_callback many_symbol_children, :skip,
|
144
|
+
def_callback many_symbol_children, :skip, expected_children_count: (0..)
|
136
145
|
def_callback many_node_children, body: <<~RUBY
|
137
146
|
node.children.each { |child| #{send_code} }
|
138
147
|
RUBY
|
@@ -143,7 +152,7 @@ module RuboCop
|
|
143
152
|
|
144
153
|
### Other particular cases
|
145
154
|
def_callback :const, :nil?, :skip
|
146
|
-
def_callback :casgn, :nil?, :skip, :nil?,
|
155
|
+
def_callback :casgn, :nil?, :skip, :nil?, expected_children_count: 2..3
|
147
156
|
def_callback :class, :always, :nil?, :nil?
|
148
157
|
def_callback :def, :skip, :always, :nil?
|
149
158
|
def_callback :op_asgn, :always, :skip, :always
|
@@ -5,11 +5,22 @@ module RuboCop
|
|
5
5
|
module SimpleForwardable
|
6
6
|
def def_delegators(accessor, *methods)
|
7
7
|
methods.each do |method|
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
8
|
+
if method.end_with?('=') && method.to_s != '[]='
|
9
|
+
# Defining a delegator for `foo=` can't use `foo=(...)` because it is a
|
10
|
+
# syntax error. Fall back to doing a slower `public_send` instead.
|
11
|
+
# TODO: Use foo(method, ...) when Ruby 3.1 is required.
|
12
|
+
class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
|
13
|
+
def #{method}(*args, **kwargs, &blk) # def example=(*args, **kwargs, &blk)
|
14
|
+
#{accessor}.public_send(:#{method}, *args, **kwargs, &blk) # foo.public_send(:example=, *args, **kwargs, &blk)
|
15
|
+
end # end
|
16
|
+
RUBY
|
17
|
+
else
|
18
|
+
class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
|
19
|
+
def #{method}(...) # def example(...)
|
20
|
+
#{accessor}.#{method}(...) # foo.example(...)
|
21
|
+
end # end
|
22
|
+
RUBY
|
23
|
+
end
|
13
24
|
end
|
14
25
|
end
|
15
26
|
end
|
data/lib/rubocop/ast/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rubocop-ast
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.39.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Bozhidar Batsov
|
@@ -10,7 +10,7 @@ authors:
|
|
10
10
|
autorequire:
|
11
11
|
bindir: bin
|
12
12
|
cert_chain: []
|
13
|
-
date:
|
13
|
+
date: 2025-03-16 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: parser
|