rubocop-ast 1.38.0 → 1.46.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/builder.rb +25 -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/complex_node.rb +13 -0
- data/lib/rubocop/ast/node/ensure_node.rb +13 -0
- data/lib/rubocop/ast/node/masgn_node.rb +1 -1
- data/lib/rubocop/ast/node/mixin/basic_literal_node.rb +1 -1
- data/lib/rubocop/ast/node/mixin/hash_element_node.rb +2 -0
- data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb +5 -6
- data/lib/rubocop/ast/node/mixin/numeric_node.rb +2 -2
- data/lib/rubocop/ast/node/mixin/parameterized_node.rb +1 -1
- data/lib/rubocop/ast/node.rb +18 -3
- data/lib/rubocop/ast/node_pattern/compiler/debug.rb +3 -8
- data/lib/rubocop/ast/node_pattern/compiler/sequence_subcompiler.rb +1 -1
- data/lib/rubocop/ast/node_pattern/node.rb +1 -1
- data/lib/rubocop/ast/processed_source.rb +90 -42
- data/lib/rubocop/ast/traversal.rb +33 -23
- data/lib/rubocop/ast/utilities/simple_forwardable.rb +16 -5
- data/lib/rubocop/ast/version.rb +1 -1
- data/lib/rubocop/ast.rb +3 -0
- metadata +20 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2b94b9545a7aceaf8b52e8e6b8713df63fe1113c4040fd5f92563438c0307d21
|
4
|
+
data.tar.gz: 6db23c373003f60f0faf0f48ff1a4cb7d086f36820e7f5e732a147eea0d22f98
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3a0fb03bcb60b82177efefcf2146d1512c50f9791f094769d64ae7c87899e9984ce41eebdb1fc8f6d8c40b287e42621f6d4bd9fdde23fe9884ebc0dd2202b5ae
|
7
|
+
data.tar.gz: 8fd5e39ac28109336a207edfedf5fc6b782ede8da4594cfdd1faf41e8e9df4d59a17716e1ea55121c575514d17fce9e0b3071ab98ecc54b007f66af8f002f560
|
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,11 +32,13 @@ 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,
|
45
39
|
case: CaseNode,
|
46
40
|
class: ClassNode,
|
41
|
+
complex: ComplexNode,
|
47
42
|
const: ConstNode,
|
48
43
|
def: DefNode,
|
49
44
|
defined?: DefinedNode,
|
@@ -107,7 +102,7 @@ module RuboCop
|
|
107
102
|
node_klass(type).new(type, children, location: source_map)
|
108
103
|
end
|
109
104
|
|
110
|
-
#
|
105
|
+
# Overwrite the base method to allow strings with invalid encoding
|
111
106
|
# More details here https://github.com/whitequark/parser/issues/283
|
112
107
|
def string_value(token)
|
113
108
|
value(token)
|
@@ -119,5 +114,20 @@ module RuboCop
|
|
119
114
|
NODE_MAP[type] || Node
|
120
115
|
end
|
121
116
|
end
|
117
|
+
|
118
|
+
# `RuboCop::AST::Builder` is an AST builder that is utilized to let `Parser`
|
119
|
+
# generate ASTs with {RuboCop::AST::Node}.
|
120
|
+
#
|
121
|
+
# @example
|
122
|
+
# buffer = Parser::Source::Buffer.new('(string)')
|
123
|
+
# buffer.source = 'puts :foo'
|
124
|
+
#
|
125
|
+
# builder = RuboCop::AST::Builder.new
|
126
|
+
# require 'parser/ruby25'
|
127
|
+
# parser = Parser::Ruby25.new(builder)
|
128
|
+
# root_node = parser.parse(buffer)
|
129
|
+
class Builder < Parser::Builders::Default
|
130
|
+
include BuilderExtensions
|
131
|
+
end
|
122
132
|
end
|
123
133
|
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}"])
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module AST
|
5
|
+
# A node extension for `complex` nodes. This will be used in place of a plain
|
6
|
+
# node when the builder constructs the AST, making its methods available to
|
7
|
+
# all `complex` nodes within RuboCop.
|
8
|
+
class ComplexNode < Node
|
9
|
+
include BasicLiteralNode
|
10
|
+
include NumericNode
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -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
|
|
@@ -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
|
@@ -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
|
|
@@ -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.def_type? || arg.defs_type?
|
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)
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
module RuboCop
|
4
4
|
module AST
|
5
|
-
# Common functionality for primitive numeric nodes: `int`, `float`, `rational`...
|
5
|
+
# Common functionality for primitive numeric nodes: `int`, `float`, `rational`, `complex`...
|
6
6
|
module NumericNode
|
7
7
|
SIGN_REGEX = /\A[+-]/.freeze
|
8
8
|
private_constant :SIGN_REGEX
|
@@ -15,7 +15,7 @@ module RuboCop
|
|
15
15
|
#
|
16
16
|
# @return [Boolean] whether this literal has a sign.
|
17
17
|
def sign?
|
18
|
-
source.match(SIGN_REGEX)
|
18
|
+
source.match?(SIGN_REGEX)
|
19
19
|
end
|
20
20
|
end
|
21
21
|
end
|
@@ -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
|
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,11 @@ 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,
|
120
|
+
|
121
|
+
match_pattern: :any_match_pattern,
|
122
|
+
match_pattern_p: :any_match_pattern
|
116
123
|
}.freeze
|
117
124
|
private_constant :GROUP_FOR_TYPE
|
118
125
|
|
@@ -265,7 +272,7 @@ module RuboCop
|
|
265
272
|
def right_siblings
|
266
273
|
return [].freeze unless parent
|
267
274
|
|
268
|
-
parent.children[sibling_index + 1..].freeze
|
275
|
+
parent.children[(sibling_index + 1)..].freeze
|
269
276
|
end
|
270
277
|
|
271
278
|
# Common destructuring method. This can be used to normalize
|
@@ -512,6 +519,10 @@ module RuboCop
|
|
512
519
|
parent&.send_type? && parent.arguments.include?(self)
|
513
520
|
end
|
514
521
|
|
522
|
+
def any_def_type?
|
523
|
+
GROUP_FOR_TYPE[type] == :any_def
|
524
|
+
end
|
525
|
+
|
515
526
|
def argument_type?
|
516
527
|
GROUP_FOR_TYPE[type] == :argument
|
517
528
|
end
|
@@ -532,6 +543,10 @@ module RuboCop
|
|
532
543
|
GROUP_FOR_TYPE[type] == :any_block
|
533
544
|
end
|
534
545
|
|
546
|
+
def any_match_pattern_type?
|
547
|
+
GROUP_FOR_TYPE[type] == :any_match_pattern
|
548
|
+
end
|
549
|
+
|
535
550
|
def guard_clause?
|
536
551
|
node = operator_keyword? ? rhs : self
|
537
552
|
|
@@ -685,7 +700,7 @@ module RuboCop
|
|
685
700
|
def case_if_value_used?
|
686
701
|
# (case <condition> <when...>)
|
687
702
|
# (if <condition> <truebranch> <falsebranch>)
|
688
|
-
sibling_index.zero?
|
703
|
+
sibling_index.zero? || parent.value_used?
|
689
704
|
end
|
690
705
|
|
691
706
|
def while_until_value_used?
|
@@ -15,10 +15,12 @@ module RuboCop
|
|
15
15
|
@visit = {}
|
16
16
|
end
|
17
17
|
|
18
|
+
# rubocop:disable Naming/PredicateMethod
|
18
19
|
def enter(node_id)
|
19
20
|
@visit[node_id] = false
|
20
21
|
true
|
21
22
|
end
|
23
|
+
# rubocop:enable Naming/PredicateMethod
|
22
24
|
|
23
25
|
def success(node_id)
|
24
26
|
@visit[node_id] = true
|
@@ -109,14 +111,7 @@ module RuboCop
|
|
109
111
|
private
|
110
112
|
|
111
113
|
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)
|
114
|
+
ProcessedSource.new(ruby, RUBY_VERSION.to_f, '(ruby)').ast
|
120
115
|
end
|
121
116
|
end
|
122
117
|
|
@@ -261,7 +261,7 @@ module RuboCop
|
|
261
261
|
arities = children
|
262
262
|
.reverse
|
263
263
|
.map(&:arity_range)
|
264
|
-
.map { |r| last = last.begin + r.begin..last.max + r.max }
|
264
|
+
.map { |r| last = (last.begin + r.begin)..(last.max + r.max) }
|
265
265
|
.reverse!
|
266
266
|
arities.push last_arity
|
267
267
|
end
|
@@ -179,7 +179,7 @@ module RuboCop
|
|
179
179
|
class AnyOrder < Node
|
180
180
|
include ForbidInSeqHead
|
181
181
|
|
182
|
-
ARITIES = Hash.new { |h, k| h[k] = k - 1..Float::INFINITY }
|
182
|
+
ARITIES = Hash.new { |h, k| h[k] = (k - 1)..Float::INFINITY }
|
183
183
|
private_constant :ARITIES
|
184
184
|
|
185
185
|
def term_nodes
|
@@ -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)
|
@@ -235,7 +256,8 @@ module RuboCop
|
|
235
256
|
[ast, comments, tokens]
|
236
257
|
end
|
237
258
|
|
238
|
-
|
259
|
+
# rubocop:disable Lint/FloatComparison, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
|
260
|
+
def parser_class(ruby_version, parser_engine)
|
239
261
|
case parser_engine
|
240
262
|
when :parser_whitequark
|
241
263
|
case ruby_version
|
@@ -282,54 +304,54 @@ module RuboCop
|
|
282
304
|
require 'parser/ruby34'
|
283
305
|
Parser::Ruby34
|
284
306
|
else
|
285
|
-
raise ArgumentError,
|
307
|
+
raise ArgumentError, 'RuboCop supports target Ruby versions 3.4 and below with ' \
|
308
|
+
"`parser`. Specified target Ruby version: #{ruby_version.inspect}"
|
286
309
|
end
|
287
310
|
when :parser_prism
|
288
|
-
require_prism
|
289
|
-
|
290
311
|
case ruby_version
|
291
312
|
when 3.3
|
292
|
-
|
313
|
+
require 'prism/translation/parser33'
|
293
314
|
Prism::Translation::Parser33
|
294
315
|
when 3.4
|
295
|
-
|
316
|
+
require 'prism/translation/parser34'
|
296
317
|
Prism::Translation::Parser34
|
318
|
+
when 3.5
|
319
|
+
require 'prism/translation/parser35'
|
320
|
+
Prism::Translation::Parser35
|
297
321
|
else
|
298
322
|
raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
|
299
323
|
"Specified target Ruby version: #{ruby_version.inspect}"
|
300
324
|
end
|
301
325
|
end
|
302
326
|
end
|
327
|
+
# rubocop:enable Lint/FloatComparison, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
|
303
328
|
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
|
312
|
-
exit!
|
329
|
+
def builder_class(parser_engine)
|
330
|
+
case parser_engine
|
331
|
+
when :parser_whitequark
|
332
|
+
RuboCop::AST::Builder
|
333
|
+
when :parser_prism
|
334
|
+
RuboCop::AST::BuilderPrism
|
335
|
+
end
|
313
336
|
end
|
314
337
|
|
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
|
338
|
+
# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
|
339
|
+
def create_parser(ruby_version, parser_engine, prism_result)
|
340
|
+
builder = builder_class(parser_engine).new
|
341
|
+
|
342
|
+
parser_class = parser_class(ruby_version, parser_engine)
|
328
343
|
|
329
|
-
|
330
|
-
|
344
|
+
parser_instance = if parser_engine == :parser_prism && prism_result
|
345
|
+
# NOTE: Since it is intended for use with Ruby LSP, it targets only Prism.
|
346
|
+
# If there is no reuse of a pre-parsed result, such as in Ruby LSP,
|
347
|
+
# regular parsing with Prism occurs, and `else` branch will be executed.
|
348
|
+
prism_reparsed = PrismPreparsed.new(prism_result)
|
349
|
+
parser_class.new(builder, parser: prism_reparsed)
|
350
|
+
else
|
351
|
+
parser_class.new(builder)
|
352
|
+
end
|
331
353
|
|
332
|
-
|
354
|
+
parser_instance.tap do |parser|
|
333
355
|
# On JRuby there's a risk that we hang in tokenize() if we
|
334
356
|
# don't set the all errors as fatal flag. The problem is caused by a bug
|
335
357
|
# in Racc that is discussed in issue #93 of the whitequark/parser
|
@@ -341,6 +363,32 @@ module RuboCop
|
|
341
363
|
end
|
342
364
|
end
|
343
365
|
end
|
366
|
+
# rubocop:enable Metrics/AbcSize, Metrics/MethodLength
|
367
|
+
|
368
|
+
def normalize_parser_engine(parser_engine, ruby_version)
|
369
|
+
parser_engine = parser_engine.to_sym
|
370
|
+
unless PARSER_ENGINES.include?(parser_engine)
|
371
|
+
raise ArgumentError, 'The keyword argument `parser_engine` accepts `default`, ' \
|
372
|
+
"`parser_whitequark`, or `parser_prism`, but `#{parser_engine}` " \
|
373
|
+
'was passed.'
|
374
|
+
end
|
375
|
+
if parser_engine == :default
|
376
|
+
default_parser_engine(ruby_version)
|
377
|
+
else
|
378
|
+
parser_engine
|
379
|
+
end
|
380
|
+
end
|
381
|
+
|
382
|
+
# The Parser gem does not support Ruby 3.5 or later.
|
383
|
+
# It is also not fully compatible with Ruby 3.4 but for
|
384
|
+
# now respects using parser for backwards compatibility.
|
385
|
+
def default_parser_engine(ruby_version)
|
386
|
+
if ruby_version >= 3.4
|
387
|
+
:parser_prism
|
388
|
+
else
|
389
|
+
:parser_whitequark
|
390
|
+
end
|
391
|
+
end
|
344
392
|
|
345
393
|
def first_token_index(range_or_node)
|
346
394
|
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
|
@@ -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
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
|
|
@@ -47,6 +48,7 @@ require_relative 'ast/node/case_match_node'
|
|
47
48
|
require_relative 'ast/node/case_node'
|
48
49
|
require_relative 'ast/node/casgn_node'
|
49
50
|
require_relative 'ast/node/class_node'
|
51
|
+
require_relative 'ast/node/complex_node'
|
50
52
|
require_relative 'ast/node/const_node'
|
51
53
|
require_relative 'ast/node/def_node'
|
52
54
|
require_relative 'ast/node/defined_node'
|
@@ -92,6 +94,7 @@ require_relative 'ast/node/when_node'
|
|
92
94
|
require_relative 'ast/node/while_node'
|
93
95
|
require_relative 'ast/node/yield_node'
|
94
96
|
require_relative 'ast/builder'
|
97
|
+
require_relative 'ast/builder_prism'
|
95
98
|
require_relative 'ast/processed_source'
|
96
99
|
require_relative 'ast/rubocop_compatibility'
|
97
100
|
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.46.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: 2025-
|
13
|
+
date: 2025-07-16 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
|
@@ -54,6 +69,7 @@ files:
|
|
54
69
|
- lib/rubocop/ast/node/case_node.rb
|
55
70
|
- lib/rubocop/ast/node/casgn_node.rb
|
56
71
|
- lib/rubocop/ast/node/class_node.rb
|
72
|
+
- lib/rubocop/ast/node/complex_node.rb
|
57
73
|
- lib/rubocop/ast/node/const_node.rb
|
58
74
|
- lib/rubocop/ast/node/csend_node.rb
|
59
75
|
- lib/rubocop/ast/node/def_node.rb
|