rubocop-ast 1.38.1 → 1.44.1
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/builder.rb +24 -15
- data/lib/rubocop/ast/builder_prism.rb +11 -0
- data/lib/rubocop/ast/node/block_node.rb +7 -6
- data/lib/rubocop/ast/node/ensure_node.rb +13 -0
- data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +5 -6
- data/lib/rubocop/ast/node.rb +10 -2
- data/lib/rubocop/ast/node_pattern/compiler/debug.rb +1 -8
- data/lib/rubocop/ast/processed_source.rb +87 -41
- data/lib/rubocop/ast/traversal.rb +33 -23
- data/lib/rubocop/ast/version.rb +1 -1
- data/lib/rubocop/ast.rb +2 -0
- metadata +19 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9310771bd0730e0408e6db665c1f0db5d52ae370aa7eb761ac3942777f4d6cee
|
4
|
+
data.tar.gz: ccd0f8b884bc0f3d8404e46db57cabd956ac8e808873ead64c4ba38a2d2387fe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 74c053c8bcba554f9816b44b58f1d8b531c643d615961c9ffb56e79177d59a596477565b13d6317de7e7132dd7c70d9428ae8381a1757c9836073515edad8740
|
7
|
+
data.tar.gz: cd6d7101a68f5ccb8657acf28d094c07a44bbd6312b8a381e16f34f8a4211929a00c26d6f5adced13ef7da085d704ffd8d303d7ae0ade38d41de0792aa5c6898
|
data/lib/rubocop/ast/builder.rb
CHANGED
@@ -2,20 +2,13 @@
|
|
2
2
|
|
3
3
|
module RuboCop
|
4
4
|
module AST
|
5
|
-
#
|
6
|
-
#
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
# builder = RuboCop::AST::Builder.new
|
13
|
-
# require 'parser/ruby25'
|
14
|
-
# parser = Parser::Ruby25.new(builder)
|
15
|
-
# root_node = parser.parse(buffer)
|
16
|
-
class Builder < Parser::Builders::Default
|
17
|
-
self.emit_forward_arg = true if respond_to?(:emit_forward_arg=)
|
18
|
-
self.emit_match_pattern = true if respond_to?(:emit_match_pattern=)
|
5
|
+
# Common functionality between the parser and prism builder
|
6
|
+
# @api private
|
7
|
+
module BuilderExtensions
|
8
|
+
def self.included(base)
|
9
|
+
base.emit_forward_arg = true
|
10
|
+
base.emit_match_pattern = true
|
11
|
+
end
|
19
12
|
|
20
13
|
# @api private
|
21
14
|
NODE_MAP = {
|
@@ -39,6 +32,7 @@ module RuboCop
|
|
39
32
|
gvasgn: AsgnNode,
|
40
33
|
block: BlockNode,
|
41
34
|
numblock: BlockNode,
|
35
|
+
itblock: BlockNode,
|
42
36
|
break: BreakNode,
|
43
37
|
case_match: CaseMatchNode,
|
44
38
|
casgn: CasgnNode,
|
@@ -107,7 +101,7 @@ module RuboCop
|
|
107
101
|
node_klass(type).new(type, children, location: source_map)
|
108
102
|
end
|
109
103
|
|
110
|
-
#
|
104
|
+
# Overwrite the base method to allow strings with invalid encoding
|
111
105
|
# More details here https://github.com/whitequark/parser/issues/283
|
112
106
|
def string_value(token)
|
113
107
|
value(token)
|
@@ -119,5 +113,20 @@ module RuboCop
|
|
119
113
|
NODE_MAP[type] || Node
|
120
114
|
end
|
121
115
|
end
|
116
|
+
|
117
|
+
# `RuboCop::AST::Builder` is an AST builder that is utilized to let `Parser`
|
118
|
+
# generate ASTs with {RuboCop::AST::Node}.
|
119
|
+
#
|
120
|
+
# @example
|
121
|
+
# buffer = Parser::Source::Buffer.new('(string)')
|
122
|
+
# buffer.source = 'puts :foo'
|
123
|
+
#
|
124
|
+
# builder = RuboCop::AST::Builder.new
|
125
|
+
# require 'parser/ruby25'
|
126
|
+
# parser = Parser::Ruby25.new(builder)
|
127
|
+
# root_node = parser.parse(buffer)
|
128
|
+
class Builder < Parser::Builders::Default
|
129
|
+
include BuilderExtensions
|
130
|
+
end
|
122
131
|
end
|
123
132
|
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module AST
|
5
|
+
# A parser builder, based on the one provided by prism,
|
6
|
+
# which is capable of emitting AST for more recent Rubies.
|
7
|
+
class BuilderPrism < Prism::Translation::Parser::Builder
|
8
|
+
include BuilderExtensions
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -11,6 +11,8 @@ module RuboCop
|
|
11
11
|
class BlockNode < Node
|
12
12
|
include MethodIdentifierPredicates
|
13
13
|
|
14
|
+
IT_BLOCK_ARGUMENT = [ArgNode.new(:arg, [:it])].freeze
|
15
|
+
private_constant :IT_BLOCK_ARGUMENT
|
14
16
|
VOID_CONTEXT_METHODS = %i[each tap].freeze
|
15
17
|
private_constant :VOID_CONTEXT_METHODS
|
16
18
|
|
@@ -46,10 +48,10 @@ module RuboCop
|
|
46
48
|
#
|
47
49
|
# @return [Array<Node>]
|
48
50
|
def arguments
|
49
|
-
if
|
50
|
-
[].freeze # Numbered parameters have no block arguments.
|
51
|
-
else
|
51
|
+
if block_type?
|
52
52
|
node_parts[1]
|
53
|
+
else
|
54
|
+
[].freeze # Numblocks and itblocks have no explicit block arguments.
|
53
55
|
end
|
54
56
|
end
|
55
57
|
|
@@ -60,6 +62,8 @@ module RuboCop
|
|
60
62
|
def argument_list
|
61
63
|
if numblock_type?
|
62
64
|
numbered_arguments
|
65
|
+
elsif itblock_type?
|
66
|
+
IT_BLOCK_ARGUMENT
|
63
67
|
else
|
64
68
|
arguments.argument_list
|
65
69
|
end
|
@@ -153,10 +157,7 @@ module RuboCop
|
|
153
157
|
|
154
158
|
private
|
155
159
|
|
156
|
-
# Numbered arguments of this `numblock`.
|
157
160
|
def numbered_arguments
|
158
|
-
return [].freeze unless numblock_type?
|
159
|
-
|
160
161
|
max_param = children[1]
|
161
162
|
1.upto(max_param).map do |i|
|
162
163
|
ArgNode.new(:arg, [:"_#{i}"])
|
@@ -6,11 +6,24 @@ module RuboCop
|
|
6
6
|
# node when the builder constructs the AST, making its methods available
|
7
7
|
# to all `ensure` nodes within RuboCop.
|
8
8
|
class EnsureNode < Node
|
9
|
+
DEPRECATION_WARNING_LOCATION_CACHE = [] # rubocop:disable Style/MutableConstant
|
10
|
+
private_constant :DEPRECATION_WARNING_LOCATION_CACHE
|
11
|
+
|
9
12
|
# Returns the body of the `ensure` clause.
|
10
13
|
#
|
11
14
|
# @return [Node, nil] The body of the `ensure`.
|
12
15
|
# @deprecated Use `EnsureNode#branch`
|
13
16
|
def body
|
17
|
+
first_caller = caller(1..1).first
|
18
|
+
|
19
|
+
unless DEPRECATION_WARNING_LOCATION_CACHE.include?(first_caller)
|
20
|
+
warn '`EnsureNode#body` is deprecated and will be changed in the next major version of ' \
|
21
|
+
'rubocop-ast. Use `EnsureNode#branch` instead to get the body of the `ensure` branch.'
|
22
|
+
warn "Called from:\n#{caller.join("\n")}\n\n"
|
23
|
+
|
24
|
+
DEPRECATION_WARNING_LOCATION_CACHE << first_caller
|
25
|
+
end
|
26
|
+
|
14
27
|
branch
|
15
28
|
end
|
16
29
|
|
@@ -39,10 +39,10 @@ module RuboCop
|
|
39
39
|
end
|
40
40
|
end
|
41
41
|
|
42
|
-
# The `block` or `
|
42
|
+
# The `block`, `numblock`, or `itblock` node associated with this method dispatch, if any.
|
43
43
|
#
|
44
|
-
# @return [BlockNode, nil] the `block` or `
|
45
|
-
# call or `nil`
|
44
|
+
# @return [BlockNode, nil] the `block`, `numblock`, or `itblock` node associated with this
|
45
|
+
# method call or `nil`
|
46
46
|
def block_node
|
47
47
|
parent if block_literal?
|
48
48
|
end
|
@@ -200,8 +200,7 @@ module RuboCop
|
|
200
200
|
arg = node.children[2]
|
201
201
|
|
202
202
|
return unless node.send_type? && node.receiver.nil? && arg.is_a?(::AST::Node)
|
203
|
-
|
204
|
-
return arg if arg.type?(:def, :defs)
|
203
|
+
return arg if arg.any_def_type?
|
205
204
|
|
206
205
|
def_modifier(arg)
|
207
206
|
end
|
@@ -271,7 +270,7 @@ module RuboCop
|
|
271
270
|
|
272
271
|
# @!method adjacent_def_modifier?(node = self)
|
273
272
|
def_node_matcher :adjacent_def_modifier?, <<~PATTERN
|
274
|
-
(send nil? _ (
|
273
|
+
(send nil? _ (any_def ...))
|
275
274
|
PATTERN
|
276
275
|
|
277
276
|
# @!method bare_access_modifier_declaration?(node = self)
|
data/lib/rubocop/ast/node.rb
CHANGED
@@ -87,6 +87,9 @@ module RuboCop
|
|
87
87
|
|
88
88
|
# @api private
|
89
89
|
GROUP_FOR_TYPE = {
|
90
|
+
def: :any_def,
|
91
|
+
defs: :any_def,
|
92
|
+
|
90
93
|
arg: :argument,
|
91
94
|
optarg: :argument,
|
92
95
|
restarg: :argument,
|
@@ -112,7 +115,8 @@ module RuboCop
|
|
112
115
|
csend: :call,
|
113
116
|
|
114
117
|
block: :any_block,
|
115
|
-
numblock: :any_block
|
118
|
+
numblock: :any_block,
|
119
|
+
itblock: :any_block
|
116
120
|
}.freeze
|
117
121
|
private_constant :GROUP_FOR_TYPE
|
118
122
|
|
@@ -512,6 +516,10 @@ module RuboCop
|
|
512
516
|
parent&.send_type? && parent.arguments.include?(self)
|
513
517
|
end
|
514
518
|
|
519
|
+
def any_def_type?
|
520
|
+
GROUP_FOR_TYPE[type] == :any_def
|
521
|
+
end
|
522
|
+
|
515
523
|
def argument_type?
|
516
524
|
GROUP_FOR_TYPE[type] == :argument
|
517
525
|
end
|
@@ -685,7 +693,7 @@ module RuboCop
|
|
685
693
|
def case_if_value_used?
|
686
694
|
# (case <condition> <when...>)
|
687
695
|
# (if <condition> <truebranch> <falsebranch>)
|
688
|
-
sibling_index.zero?
|
696
|
+
sibling_index.zero? || parent.value_used?
|
689
697
|
end
|
690
698
|
|
691
699
|
def while_until_value_used?
|
@@ -109,14 +109,7 @@ module RuboCop
|
|
109
109
|
private
|
110
110
|
|
111
111
|
def ruby_ast(ruby)
|
112
|
-
|
113
|
-
ruby_parser.parse(buffer)
|
114
|
-
end
|
115
|
-
|
116
|
-
def ruby_parser
|
117
|
-
require 'parser/current'
|
118
|
-
builder = ::RuboCop::AST::Builder.new
|
119
|
-
::Parser::CurrentRuby.new(builder)
|
112
|
+
ProcessedSource.new(ruby, RUBY_VERSION.to_f, '(ruby)').ast
|
120
113
|
end
|
121
114
|
end
|
122
115
|
|
@@ -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.
|
@@ -14,23 +35,21 @@ module RuboCop
|
|
14
35
|
INVALID_LEVELS = %i[error fatal].freeze
|
15
36
|
private_constant :INVALID_LEVELS
|
16
37
|
|
17
|
-
PARSER_ENGINES = %i[parser_whitequark parser_prism].freeze
|
38
|
+
PARSER_ENGINES = %i[default parser_whitequark parser_prism].freeze
|
18
39
|
private_constant :PARSER_ENGINES
|
19
40
|
|
20
41
|
attr_reader :path, :buffer, :ast, :comments, :tokens, :diagnostics,
|
21
42
|
:parser_error, :raw_source, :ruby_version, :parser_engine
|
22
43
|
|
23
|
-
def self.from_file(path, ruby_version, parser_engine: :
|
44
|
+
def self.from_file(path, ruby_version, parser_engine: :default)
|
24
45
|
file = File.read(path, mode: 'rb')
|
25
46
|
new(file, ruby_version, path, parser_engine: parser_engine)
|
26
47
|
end
|
27
48
|
|
28
|
-
def initialize(
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
"or `parser_prism`, but `#{parser_engine}` was passed."
|
33
|
-
end
|
49
|
+
def initialize(
|
50
|
+
source, ruby_version, path = nil, parser_engine: :default, prism_result: nil
|
51
|
+
)
|
52
|
+
parser_engine = normalize_parser_engine(parser_engine, ruby_version)
|
34
53
|
|
35
54
|
# Defaults source encoding to UTF-8, regardless of the encoding it has
|
36
55
|
# been read with, which could be non-utf8 depending on the default
|
@@ -44,7 +63,7 @@ module RuboCop
|
|
44
63
|
@parser_engine = parser_engine
|
45
64
|
@parser_error = nil
|
46
65
|
|
47
|
-
parse(source, ruby_version, parser_engine)
|
66
|
+
parse(source, ruby_version, parser_engine, prism_result)
|
48
67
|
end
|
49
68
|
|
50
69
|
def ast_with_comments
|
@@ -202,7 +221,7 @@ module RuboCop
|
|
202
221
|
end
|
203
222
|
end
|
204
223
|
|
205
|
-
def parse(source, ruby_version, parser_engine)
|
224
|
+
def parse(source, ruby_version, parser_engine, prism_result)
|
206
225
|
buffer_name = @path || STRING_SOURCE_NAME
|
207
226
|
@buffer = Parser::Source::Buffer.new(buffer_name, 1)
|
208
227
|
|
@@ -216,7 +235,9 @@ module RuboCop
|
|
216
235
|
return
|
217
236
|
end
|
218
237
|
|
219
|
-
|
238
|
+
parser = create_parser(ruby_version, parser_engine, prism_result)
|
239
|
+
|
240
|
+
@ast, @comments, @tokens = tokenize(parser)
|
220
241
|
end
|
221
242
|
|
222
243
|
def tokenize(parser)
|
@@ -282,18 +303,20 @@ module RuboCop
|
|
282
303
|
require 'parser/ruby34'
|
283
304
|
Parser::Ruby34
|
284
305
|
else
|
285
|
-
raise ArgumentError,
|
306
|
+
raise ArgumentError, 'RuboCop supports target Ruby versions 3.4 and below with ' \
|
307
|
+
"`parser`. Specified target Ruby version: #{ruby_version.inspect}"
|
286
308
|
end
|
287
309
|
when :parser_prism
|
288
|
-
require_prism
|
289
|
-
|
290
310
|
case ruby_version
|
291
311
|
when 3.3
|
292
|
-
|
312
|
+
require 'prism/translation/parser33'
|
293
313
|
Prism::Translation::Parser33
|
294
314
|
when 3.4
|
295
|
-
|
315
|
+
require 'prism/translation/parser34'
|
296
316
|
Prism::Translation::Parser34
|
317
|
+
when 3.5
|
318
|
+
require 'prism/translation/parser35'
|
319
|
+
Prism::Translation::Parser35
|
297
320
|
else
|
298
321
|
raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
|
299
322
|
"Specified target Ruby version: #{ruby_version.inspect}"
|
@@ -301,35 +324,32 @@ module RuboCop
|
|
301
324
|
end
|
302
325
|
end
|
303
326
|
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
|
312
|
-
exit!
|
327
|
+
def builder_class(parser_engine)
|
328
|
+
case parser_engine
|
329
|
+
when :parser_whitequark
|
330
|
+
RuboCop::AST::Builder
|
331
|
+
when :parser_prism
|
332
|
+
RuboCop::AST::BuilderPrism
|
333
|
+
end
|
313
334
|
end
|
314
335
|
|
315
|
-
#
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
warn <<~MESSAGE
|
321
|
-
Error: Unable to load Prism parser for Ruby #{version}.
|
322
|
-
* If you're using Bundler and don't yet have `gem 'prism'` as a dependency, add it now.
|
323
|
-
* If you're using Bundler and already have `gem 'prism'` as a dependency, update it to the most recent version.
|
324
|
-
* If you don't use Bundler, run `gem update prism`.
|
325
|
-
MESSAGE
|
326
|
-
exit!
|
327
|
-
end
|
336
|
+
# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
|
337
|
+
def create_parser(ruby_version, parser_engine, prism_result)
|
338
|
+
builder = builder_class(parser_engine).new
|
339
|
+
|
340
|
+
parser_class = parser_class(ruby_version, parser_engine)
|
328
341
|
|
329
|
-
|
330
|
-
|
342
|
+
parser_instance = if prism_result
|
343
|
+
# NOTE: Since it is intended for use with Ruby LSP, it targets only Prism.
|
344
|
+
# If there is no reuse of a pre-parsed result, such as in Ruby LSP,
|
345
|
+
# regular parsing with Prism occurs, and `else` branch will be executed.
|
346
|
+
prism_reparsed = PrismPreparsed.new(prism_result)
|
347
|
+
parser_class.new(builder, parser: prism_reparsed)
|
348
|
+
else
|
349
|
+
parser_class.new(builder)
|
350
|
+
end
|
331
351
|
|
332
|
-
|
352
|
+
parser_instance.tap do |parser|
|
333
353
|
# On JRuby there's a risk that we hang in tokenize() if we
|
334
354
|
# don't set the all errors as fatal flag. The problem is caused by a bug
|
335
355
|
# in Racc that is discussed in issue #93 of the whitequark/parser
|
@@ -341,6 +361,32 @@ module RuboCop
|
|
341
361
|
end
|
342
362
|
end
|
343
363
|
end
|
364
|
+
# rubocop:enable Metrics/AbcSize, Metrics/MethodLength
|
365
|
+
|
366
|
+
def normalize_parser_engine(parser_engine, ruby_version)
|
367
|
+
parser_engine = parser_engine.to_sym
|
368
|
+
unless PARSER_ENGINES.include?(parser_engine)
|
369
|
+
raise ArgumentError, 'The keyword argument `parser_engine` accepts `default`, ' \
|
370
|
+
"`parser_whitequark`, or `parser_prism`, but `#{parser_engine}` " \
|
371
|
+
'was passed.'
|
372
|
+
end
|
373
|
+
if parser_engine == :default
|
374
|
+
default_parser_engine(ruby_version)
|
375
|
+
else
|
376
|
+
parser_engine
|
377
|
+
end
|
378
|
+
end
|
379
|
+
|
380
|
+
# The Parser gem does not support Ruby 3.5 or later.
|
381
|
+
# It is also not fully compatible with Ruby 3.4 but for
|
382
|
+
# now respects using parser for backwards compatibility.
|
383
|
+
def default_parser_engine(ruby_version)
|
384
|
+
if ruby_version >= 3.4
|
385
|
+
:parser_prism
|
386
|
+
else
|
387
|
+
:parser_whitequark
|
388
|
+
end
|
389
|
+
end
|
344
390
|
|
345
391
|
def first_token_index(range_or_node)
|
346
392
|
begin_pos = source_range(range_or_node).begin_pos
|
@@ -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,16 +109,16 @@ 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
|
112
|
-
while_post until_post
|
121
|
+
while_post until_post
|
113
122
|
match_with_lvasgn begin kwbegin return
|
114
123
|
in_match match_alt break next
|
115
124
|
match_as array_pattern array_pattern_with_tail
|
@@ -117,22 +126,22 @@ module RuboCop
|
|
117
126
|
index indexasgn procarg0 kwargs]
|
118
127
|
many_opt_node_children = %i[case rescue resbody ensure for when
|
119
128
|
case_match in_pattern irange erange
|
120
|
-
match_pattern match_pattern_p]
|
129
|
+
match_pattern match_pattern_p iflipflop eflipflop]
|
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,13 +152,14 @@ 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
|
150
159
|
def_callback :if, :always, :nil?, :nil?
|
151
160
|
def_callback :block, :always, :always, :nil?
|
152
161
|
def_callback :numblock, :always, :skip, :nil?
|
162
|
+
def_callback :itblock, :always, :skip, :nil?
|
153
163
|
def_callback :defs, :always, :skip, :always, :nil?
|
154
164
|
|
155
165
|
def_callback %i[send csend], body: <<~RUBY
|
@@ -167,7 +177,7 @@ module RuboCop
|
|
167
177
|
|
168
178
|
to_define = ::Parser::Meta::NODE_TYPES.to_a
|
169
179
|
to_define -= defined
|
170
|
-
to_define -= %i[numargs ident] # transient
|
180
|
+
to_define -= %i[numargs itarg ident] # transient
|
171
181
|
to_define -= %i[blockarg_expr restarg_expr] # obsolete
|
172
182
|
to_define -= %i[objc_kwarg objc_restarg objc_varargs] # mac_ruby
|
173
183
|
def_callback to_define, body: <<~RUBY
|
data/lib/rubocop/ast/version.rb
CHANGED
data/lib/rubocop/ast.rb
CHANGED
@@ -1,6 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require 'parser'
|
4
|
+
require 'prism'
|
4
5
|
require 'forwardable'
|
5
6
|
require 'set'
|
6
7
|
|
@@ -92,6 +93,7 @@ require_relative 'ast/node/when_node'
|
|
92
93
|
require_relative 'ast/node/while_node'
|
93
94
|
require_relative 'ast/node/yield_node'
|
94
95
|
require_relative 'ast/builder'
|
96
|
+
require_relative 'ast/builder_prism'
|
95
97
|
require_relative 'ast/processed_source'
|
96
98
|
require_relative 'ast/rubocop_compatibility'
|
97
99
|
require_relative 'ast/token'
|
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.44.1
|
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: 2025-
|
13
|
+
date: 2025-04-11 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: parser
|
@@ -18,14 +18,28 @@ dependencies:
|
|
18
18
|
requirements:
|
19
19
|
- - ">="
|
20
20
|
- !ruby/object:Gem::Version
|
21
|
-
version: 3.3.
|
21
|
+
version: 3.3.7.2
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
25
25
|
requirements:
|
26
26
|
- - ">="
|
27
27
|
- !ruby/object:Gem::Version
|
28
|
-
version: 3.3.
|
28
|
+
version: 3.3.7.2
|
29
|
+
- !ruby/object:Gem::Dependency
|
30
|
+
name: prism
|
31
|
+
requirement: !ruby/object:Gem::Requirement
|
32
|
+
requirements:
|
33
|
+
- - "~>"
|
34
|
+
- !ruby/object:Gem::Version
|
35
|
+
version: '1.4'
|
36
|
+
type: :runtime
|
37
|
+
prerelease: false
|
38
|
+
version_requirements: !ruby/object:Gem::Requirement
|
39
|
+
requirements:
|
40
|
+
- - "~>"
|
41
|
+
- !ruby/object:Gem::Version
|
42
|
+
version: '1.4'
|
29
43
|
description: " RuboCop's Node and NodePattern classes.\n"
|
30
44
|
email: rubocop@googlegroups.com
|
31
45
|
executables: []
|
@@ -39,6 +53,7 @@ files:
|
|
39
53
|
- lib/rubocop-ast.rb
|
40
54
|
- lib/rubocop/ast.rb
|
41
55
|
- lib/rubocop/ast/builder.rb
|
56
|
+
- lib/rubocop/ast/builder_prism.rb
|
42
57
|
- lib/rubocop/ast/ext/range.rb
|
43
58
|
- lib/rubocop/ast/node.rb
|
44
59
|
- lib/rubocop/ast/node/alias_node.rb
|