rubocop-ast 1.38.0 → 1.42.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3a3205a51f90d1dc493ef4c1ec96a4f40ed796dfc58bfc3661db72e67e134abc
4
- data.tar.gz: 6d55fec1f58d712845ecb936db794934ea264e64b0adeb2c097fae63a5e5cb3e
3
+ metadata.gz: d19f7e10e7b8402e4cd47676b246f8ada988fe6039f45ce339f99e4aec065955
4
+ data.tar.gz: e877a86b9566a395e5e4d8b0656d688670c051090900cc1f753922f4f285882d
5
5
  SHA512:
6
- metadata.gz: 9468ab39ad7cd4ca56f0781605f07136dc89dfcbafc51482d5045799b468bf389d3c61671f49c7242f3dfbcc99090f3bd4b0c178d08b6038818b0158e3078658
7
- data.tar.gz: a5b2b0604abdd935bfba3213a908678b5697cee7345f5b9941bfdddbfc08ceb8e86cab35895490f2612fd71937baa2ff5b7d75bb2ee4dafb5efd656178dc00c1
6
+ metadata.gz: 2eae7d51990b5b02aef754cb28ded1563712df934b1903439cb84f9d67d4c9507186112739a12aaaa7fb4bec33b9226f32c62ac128e21124f4d171a31ee263e3
7
+ data.tar.gz: d7ab2ea49e961d91b556a385e77e3bc70f67168af0af26c582bd141737c22a81f1f73d4838855baa92ddb39b2751f266d2df496d279f96c44cd66c1481d5e153
@@ -2,20 +2,13 @@
2
2
 
3
3
  module RuboCop
4
4
  module AST
5
- # `RuboCop::AST::Builder` is an AST builder that is utilized to let `Parser`
6
- # generate ASTs with {RuboCop::AST::Node}.
7
- #
8
- # @example
9
- # buffer = Parser::Source::Buffer.new('(string)')
10
- # buffer.source = 'puts :foo'
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
- # TODO: Figure out what to do about literal encoding handling...
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 numblock_type?
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
 
@@ -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.send_type? || assignment.indexasgn_type?
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 `numblock` node associated with this method dispatch, if any.
42
+ # The `block`, `numblock`, or `itblock` node associated with this method dispatch, if any.
43
43
  #
44
- # @return [BlockNode, nil] the `block` or `numblock` node associated with this method
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
@@ -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.def_type? || arg.defs_type?
204
+ return arg if arg.type?(:def, :defs)
205
205
 
206
206
  def_modifier(arg)
207
207
  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
- (last_argument.block_pass_type? || last_argument.blockarg_type?)
60
+ last_argument.type?(:block_pass, :blockarg)
61
61
  end
62
62
 
63
63
  # A specialized `ParameterizedNode` for node that have a single child
@@ -112,7 +112,8 @@ module RuboCop
112
112
  csend: :call,
113
113
 
114
114
  block: :any_block,
115
- numblock: :any_block
115
+ numblock: :any_block,
116
+ itblock: :any_block
116
117
  }.freeze
117
118
  private_constant :GROUP_FOR_TYPE
118
119
 
@@ -685,7 +686,7 @@ module RuboCop
685
686
  def case_if_value_used?
686
687
  # (case <condition> <when...>)
687
688
  # (if <condition> <truebranch> <falsebranch>)
688
- sibling_index.zero? ? true : parent.value_used?
689
+ sibling_index.zero? || parent.value_used?
689
690
  end
690
691
 
691
692
  def while_until_value_used?
@@ -109,14 +109,7 @@ module RuboCop
109
109
  private
110
110
 
111
111
  def ruby_ast(ruby)
112
- buffer = ::Parser::Source::Buffer.new('(ruby)', source: ruby)
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
 
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # DO NOT MODIFY!!!!
4
- # This file is automatically generated by Racc 1.8.1
5
- # from Racc grammar file "parser.y".
4
+ # This file is automatically generated by Racc 1.5.0
5
+ # from Racc grammar file "".
6
6
  #
7
7
 
8
8
  require 'racc/parser.rb'
@@ -14,15 +14,15 @@ module RuboCop
14
14
 
15
15
  racc_action_table = [
16
16
  14, 15, 16, 21, 18, 17, 19, 10, 11, 12,
17
- 60, 22, 20, 4, 24, 5, 40, 6, 7, 8,
18
- 28, 23, 56, 50, 40, 61, 43, 66, 51, 51,
17
+ 60, 22, 20, 4, 40, 5, 43, 6, 7, 8,
18
+ 28, 23, 56, 50, 66, 61, 24, 51, 51, 40,
19
19
  58, 14, 15, 16, 21, 18, 17, 19, 10, 11,
20
20
  12, nil, 22, 20, 4, nil, 5, nil, 6, 7,
21
21
  8, 28, 23, nil, nil, -34, 14, 15, 16, 21,
22
22
  18, 17, 19, 10, 11, 12, nil, 22, 20, 4,
23
23
  nil, 5, nil, 6, 7, 8, 9, 23, 14, 15,
24
24
  16, 21, 18, 17, 19, 10, 11, 12, nil, 22,
25
- 20, 4, nil, 5, nil, 6, 7, 8, 28, 23,
25
+ 20, 4, nil, 5, nil, 6, 7, 8, 9, 23,
26
26
  14, 15, 16, 21, 18, 17, 19, 10, 11, 12,
27
27
  nil, 22, 20, 4, nil, 5, nil, 6, 7, 8,
28
28
  9, 23, 14, 15, 16, 21, 18, 17, 19, 10,
@@ -33,7 +33,7 @@ racc_action_table = [
33
33
  18, 17, 19, 10, 11, 12, nil, 22, 20, 4,
34
34
  nil, 5, nil, 6, 7, 8, 9, 23, 14, 15,
35
35
  16, 21, 18, 17, 19, 10, 11, 12, nil, 22,
36
- 20, 4, nil, 5, nil, 6, 7, 8, 9, 23,
36
+ 20, 4, nil, 5, nil, 6, 7, 8, 28, 23,
37
37
  14, 15, 16, 21, 18, 17, 19, 10, 11, 12,
38
38
  nil, 22, 20, 4, 44, 5, nil, 6, 7, 8,
39
39
  28, 23, 14, 15, 16, 21, 18, 17, 19, 10,
@@ -47,31 +47,31 @@ racc_action_table = [
47
47
  20, 4, nil, 5, nil, 6, 7, 8, 9, 23,
48
48
  14, 15, 16, 21, 18, 17, 19, 10, 11, 12,
49
49
  nil, 22, 20, 4, nil, 5, nil, 6, 7, 8,
50
- 9, 23, -1, -1, -1, -2, -2, -2, 47, 48,
51
- 49 ]
50
+ 9, 23, 47, 48, 49, -1, -1, -1, -2, -2,
51
+ -2 ]
52
52
 
53
53
  racc_action_check = [
54
54
  42, 42, 42, 42, 42, 42, 42, 42, 42, 42,
55
- 54, 42, 42, 42, 1, 42, 10, 42, 42, 42,
56
- 42, 42, 42, 30, 11, 54, 24, 62, 30, 63,
55
+ 54, 42, 42, 42, 11, 42, 24, 42, 42, 42,
56
+ 42, 42, 42, 30, 62, 54, 1, 63, 30, 10,
57
57
  42, 59, 59, 59, 59, 59, 59, 59, 59, 59,
58
58
  59, nil, 59, 59, 59, nil, 59, nil, 59, 59,
59
- 59, 59, 59, nil, nil, 59, 0, 0, 0, 0,
59
+ 59, 59, 59, nil, nil, 59, 5, 5, 5, 5,
60
+ 5, 5, 5, 5, 5, 5, nil, 5, 5, 5,
61
+ nil, 5, nil, 5, 5, 5, 5, 5, 6, 6,
62
+ 6, 6, 6, 6, 6, 6, 6, 6, nil, 6,
63
+ 6, 6, nil, 6, nil, 6, 6, 6, 6, 6,
64
+ 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
65
+ nil, 7, 7, 7, nil, 7, nil, 7, 7, 7,
66
+ 7, 7, 8, 8, 8, 8, 8, 8, 8, 8,
67
+ 8, 8, nil, 8, 8, 8, nil, 8, nil, 8,
68
+ 8, 8, 8, 8, 9, 9, 9, 9, 9, 9,
69
+ 9, 9, 9, 9, nil, 9, 9, 9, nil, 9,
70
+ nil, 9, 9, 9, 9, 9, 0, 0, 0, 0,
60
71
  0, 0, 0, 0, 0, 0, nil, 0, 0, 0,
61
72
  nil, 0, nil, 0, 0, 0, 0, 0, 4, 4,
62
73
  4, 4, 4, 4, 4, 4, 4, 4, nil, 4,
63
74
  4, 4, nil, 4, nil, 4, 4, 4, 4, 4,
64
- 5, 5, 5, 5, 5, 5, 5, 5, 5, 5,
65
- nil, 5, 5, 5, nil, 5, nil, 5, 5, 5,
66
- 5, 5, 6, 6, 6, 6, 6, 6, 6, 6,
67
- 6, 6, nil, 6, 6, 6, nil, 6, nil, 6,
68
- 6, 6, 6, 6, 7, 7, 7, 7, 7, 7,
69
- 7, 7, 7, 7, nil, 7, 7, 7, nil, 7,
70
- nil, 7, 7, 7, 7, 7, 8, 8, 8, 8,
71
- 8, 8, 8, 8, 8, 8, nil, 8, 8, 8,
72
- nil, 8, nil, 8, 8, 8, 8, 8, 9, 9,
73
- 9, 9, 9, 9, 9, 9, 9, 9, nil, 9,
74
- 9, 9, nil, 9, nil, 9, 9, 9, 9, 9,
75
75
  27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
76
76
  nil, 27, 27, 27, 27, 27, nil, 27, 27, 27,
77
77
  27, 27, 28, 28, 28, 28, 28, 28, 28, 28,
@@ -85,17 +85,17 @@ racc_action_check = [
85
85
  50, 50, nil, 50, nil, 50, 50, 50, 50, 50,
86
86
  61, 61, 61, 61, 61, 61, 61, 61, 61, 61,
87
87
  nil, 61, 61, 61, nil, 61, nil, 61, 61, 61,
88
- 61, 61, 25, 25, 25, 26, 26, 26, 29, 29,
89
- 29 ]
88
+ 61, 61, 29, 29, 29, 25, 25, 25, 26, 26,
89
+ 26 ]
90
90
 
91
91
  racc_action_pointer = [
92
- 54, 14, nil, nil, 76, 98, 120, 142, 164, 186,
93
- 4, 12, nil, nil, nil, nil, nil, nil, nil, nil,
94
- nil, nil, nil, nil, 26, 315, 318, 208, 230, 321,
92
+ 164, 26, nil, nil, 186, 54, 76, 98, 120, 142,
93
+ 17, 2, nil, nil, nil, nil, nil, nil, nil, nil,
94
+ nil, nil, nil, nil, 16, 318, 321, 208, 230, 315,
95
95
  -2, nil, nil, 252, nil, nil, nil, nil, nil, nil,
96
96
  274, nil, -2, nil, nil, nil, nil, nil, nil, nil,
97
97
  296, nil, nil, nil, -6, nil, nil, nil, nil, 29,
98
- nil, 318, 1, -1, nil, nil, nil ]
98
+ nil, 318, -2, -3, nil, nil, nil ]
99
99
 
100
100
  racc_action_default = [
101
101
  -47, -47, -1, -2, -31, -47, -47, -47, -47, -47,
@@ -107,26 +107,26 @@ racc_action_default = [
107
107
  -37, -47, -47, -47, -35, -39, -26 ]
108
108
 
109
109
  racc_goto_table = [
110
- 1, 33, 27, 25, 26, 34, 35, 36, 37, 38,
111
- 42, 32, 39, 41, 46, 63, 62, 64, 54, nil,
112
- nil, nil, nil, nil, nil, nil, 25, 26, 38, nil,
113
- nil, nil, nil, 53, 45, nil, nil, nil, nil, nil,
114
- 55, 25, 26, nil, nil, nil, 59, nil, nil, 57,
110
+ 1, 33, 64, 32, 25, 34, 35, 36, 37, 38,
111
+ 54, 26, 39, 41, 27, 42, 46, 63, 62, nil,
112
+ nil, nil, nil, nil, nil, nil, 45, 25, 38, nil,
113
+ nil, nil, nil, 53, 26, nil, nil, nil, nil, nil,
114
+ 55, 57, 25, nil, nil, nil, 59, nil, nil, 26,
115
115
  34, nil, nil, nil, nil, nil, nil, nil, nil, 53,
116
116
  nil, 65 ]
117
117
 
118
118
  racc_goto_check = [
119
- 1, 5, 4, 2, 3, 1, 1, 1, 1, 1,
120
- 8, 9, 6, 6, 10, 11, 12, 13, 14, nil,
121
- nil, nil, nil, nil, nil, nil, 2, 3, 1, nil,
122
- nil, nil, nil, 1, 9, nil, nil, nil, nil, nil,
123
- 1, 2, 3, nil, nil, nil, 5, nil, nil, 9,
119
+ 1, 5, 13, 9, 2, 1, 1, 1, 1, 1,
120
+ 14, 3, 6, 6, 4, 8, 10, 11, 12, nil,
121
+ nil, nil, nil, nil, nil, nil, 9, 2, 1, nil,
122
+ nil, nil, nil, 1, 3, nil, nil, nil, nil, nil,
123
+ 1, 9, 2, nil, nil, nil, 5, nil, nil, 3,
124
124
  1, nil, nil, nil, nil, nil, nil, nil, nil, 1,
125
125
  nil, 1 ]
126
126
 
127
127
  racc_goto_pointer = [
128
- nil, 0, -1, 0, -2, -4, 2, nil, -13, 7,
129
- -15, -44, -43, -42, -22 ]
128
+ nil, 0, 0, 7, 10, -4, 2, nil, -8, -1,
129
+ -13, -42, -41, -57, -30 ]
130
130
 
131
131
  racc_goto_default = [
132
132
  nil, 29, 2, 3, nil, nil, nil, 13, nil, nil,
@@ -239,7 +239,6 @@ Racc_arg = [
239
239
  racc_shift_n,
240
240
  racc_reduce_n,
241
241
  racc_use_result_var ]
242
- Ractor.make_shareable(Racc_arg) if defined?(Ractor)
243
242
 
244
243
  Racc_token_to_s_table = [
245
244
  "$end",
@@ -290,7 +289,6 @@ Racc_token_to_s_table = [
290
289
  "opt_rest",
291
290
  "rest",
292
291
  "arg_list" ]
293
- Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
294
292
 
295
293
  Racc_debug_parser = false
296
294
 
@@ -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: :parser_whitequark)
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(source, ruby_version, path = nil, parser_engine: :parser_whitequark)
29
- parser_engine = parser_engine.to_sym
30
- unless PARSER_ENGINES.include?(parser_engine)
31
- raise ArgumentError, 'The keyword argument `parser_engine` accepts `parser_whitequark` ' \
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
- @ast, @comments, @tokens = tokenize(create_parser(ruby_version, parser_engine))
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,22 @@ module RuboCop
282
303
  require 'parser/ruby34'
283
304
  Parser::Ruby34
284
305
  else
285
- raise ArgumentError, "RuboCop found unknown Ruby version: #{ruby_version.inspect}"
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
310
  require_prism
289
311
 
290
312
  case ruby_version
291
313
  when 3.3
292
- require_prism_translation_parser(ruby_version)
314
+ require 'prism/translation/parser33'
293
315
  Prism::Translation::Parser33
294
316
  when 3.4
295
- require_prism_translation_parser(ruby_version)
317
+ require 'prism/translation/parser34'
296
318
  Prism::Translation::Parser34
319
+ when 3.5
320
+ require 'prism/translation/parser35'
321
+ Prism::Translation::Parser35
297
322
  else
298
323
  raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
299
324
  "Specified target Ruby version: #{ruby_version.inspect}"
@@ -301,35 +326,64 @@ module RuboCop
301
326
  end
302
327
  end
303
328
 
329
+ def builder_class(parser_engine)
330
+ case parser_engine
331
+ when :parser_whitequark
332
+ RuboCop::AST::Builder
333
+ when :parser_prism
334
+ require_prism
335
+ require_relative 'builder_prism'
336
+ RuboCop::AST::BuilderPrism
337
+ end
338
+ end
339
+
304
340
  # Prism is a native extension, a `LoadError` will be raised if linked to an incompatible
305
341
  # Ruby version. Only raise if it really was caused by Prism not being present.
342
+ # rubocop:disable Metrics/MethodLength
306
343
  def require_prism
307
344
  require 'prism'
345
+ required_prism_version = '1.4.0'
346
+ if required_prism_version > Prism::VERSION
347
+ # While Prism is not yet a dependency, users may run with outdated versions that
348
+ # don't have all the parsers.
349
+ warn <<~MESSAGE
350
+ Error: Prism version #{Prism::VERSION} was loaded, but rubocop-ast requires #{required_prism_version}.
351
+ * If you're using Bundler and don't yet have `gem 'prism'` as a dependency, add it now.
352
+ * If you're using Bundler and already have `gem 'prism'` as a dependency, update it to the most recent version.
353
+ * If you don't use Bundler, run `gem update prism`.
354
+ MESSAGE
355
+ exit!
356
+ end
308
357
  rescue LoadError => e
309
358
  raise unless e.path == 'prism'
310
359
 
311
360
  warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
312
361
  exit!
313
362
  end
363
+ # rubocop:enable Metrics/MethodLength
314
364
 
315
- # While Prism is not yet a dependency, users may run with outdated versions that
316
- # don't have all the parsers.
317
- def require_prism_translation_parser(version)
318
- require "prism/translation/parser#{version.to_s.delete('.')}"
319
- rescue LoadError
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
365
+ # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
366
+ def create_parser(ruby_version, parser_engine, prism_result)
367
+ builder = builder_class(parser_engine).new
368
+
369
+ parser_class = parser_class(ruby_version, parser_engine)
328
370
 
329
- def create_parser(ruby_version, parser_engine)
330
- builder = RuboCop::AST::Builder.new
371
+ # NOTE: Check if the `Prism#initialize` method has the `:parser` keyword argument.
372
+ # The `:parser` keyword argument cannot be used to switch parsers because older versions of
373
+ # Prism do not support it.
374
+ parser_switch_available = parser_class.instance_method(:initialize).parameters.assoc(:key)
331
375
 
332
- parser_class(ruby_version, parser_engine).new(builder).tap do |parser|
376
+ parser_instance = if prism_result && parser_switch_available
377
+ # NOTE: Since it is intended for use with Ruby LSP, it targets only Prism.
378
+ # If there is no reuse of a pre-parsed result, such as in Ruby LSP,
379
+ # regular parsing with Prism occurs, and `else` branch will be executed.
380
+ prism_reparsed = PrismPreparsed.new(prism_result)
381
+ parser_class.new(builder, parser: prism_reparsed)
382
+ else
383
+ parser_class.new(builder)
384
+ end
385
+
386
+ parser_instance.tap do |parser|
333
387
  # On JRuby there's a risk that we hang in tokenize() if we
334
388
  # don't set the all errors as fatal flag. The problem is caused by a bug
335
389
  # in Racc that is discussed in issue #93 of the whitequark/parser
@@ -341,6 +395,32 @@ module RuboCop
341
395
  end
342
396
  end
343
397
  end
398
+ # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
399
+
400
+ def normalize_parser_engine(parser_engine, ruby_version)
401
+ parser_engine = parser_engine.to_sym
402
+ unless PARSER_ENGINES.include?(parser_engine)
403
+ raise ArgumentError, 'The keyword argument `parser_engine` accepts `default`, ' \
404
+ "`parser_whitequark`, or `parser_prism`, but `#{parser_engine}` " \
405
+ 'was passed.'
406
+ end
407
+ if parser_engine == :default
408
+ default_parser_engine(ruby_version)
409
+ else
410
+ parser_engine
411
+ end
412
+ end
413
+
414
+ # The Parser gem does not support Ruby 3.5 or later.
415
+ # It is also not fully compatible with Ruby 3.4 but for
416
+ # now respects using parser for backwards compatibility.
417
+ def default_parser_engine(ruby_version)
418
+ if ruby_version >= 3.5
419
+ :parser_prism
420
+ else
421
+ :parser_whitequark
422
+ end
423
+ end
344
424
 
345
425
  def first_token_index(range_or_node)
346
426
  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, *signature,
36
- arity: signature.size..signature.size,
37
- arity_check: ENV.fetch('RUBOCOP_DEBUG', nil) && self.arity_check(arity),
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(signature, prelude)
53
- signature
54
- .map.with_index do |arg, i|
55
- TEMPLATE[arg].gsub('%<index>i', i.to_s)
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 arity_check(range)
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
- ### arity == 0
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
- ### arity == 0..1
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
- ### arity == 1
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
- ### arity > 1
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 arity
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, arity: 0..1
125
- def_callback opt_node_child, :nil?, arity: 0..1
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?, arity: 1..2
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, arity_check: nil
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?, arity: 2..3
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
- class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
9
- def #{method}(...) # def example(...)
10
- #{accessor}.#{method}(...) # foo.example(...)
11
- end # end
12
- RUBY
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
@@ -3,7 +3,7 @@
3
3
  module RuboCop
4
4
  module AST
5
5
  module Version
6
- STRING = '1.38.0'
6
+ STRING = '1.42.0'
7
7
  end
8
8
  end
9
9
  end
metadata CHANGED
@@ -1,16 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rubocop-ast
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.38.0
4
+ version: 1.42.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Bozhidar Batsov
8
8
  - Jonas Arvidsson
9
9
  - Yuji Nakayama
10
- autorequire:
11
10
  bindir: bin
12
11
  cert_chain: []
13
- date: 2025-01-27 00:00:00.000000000 Z
12
+ date: 2025-03-25 00:00:00.000000000 Z
14
13
  dependencies:
15
14
  - !ruby/object:Gem::Dependency
16
15
  name: parser
@@ -18,14 +17,14 @@ dependencies:
18
17
  requirements:
19
18
  - - ">="
20
19
  - !ruby/object:Gem::Version
21
- version: 3.3.1.0
20
+ version: 3.3.7.2
22
21
  type: :runtime
23
22
  prerelease: false
24
23
  version_requirements: !ruby/object:Gem::Requirement
25
24
  requirements:
26
25
  - - ">="
27
26
  - !ruby/object:Gem::Version
28
- version: 3.3.1.0
27
+ version: 3.3.7.2
29
28
  description: " RuboCop's Node and NodePattern classes.\n"
30
29
  email: rubocop@googlegroups.com
31
30
  executables: []
@@ -39,6 +38,7 @@ files:
39
38
  - lib/rubocop-ast.rb
40
39
  - lib/rubocop/ast.rb
41
40
  - lib/rubocop/ast/builder.rb
41
+ - lib/rubocop/ast/builder_prism.rb
42
42
  - lib/rubocop/ast/ext/range.rb
43
43
  - lib/rubocop/ast/node.rb
44
44
  - lib/rubocop/ast/node/alias_node.rb
@@ -147,7 +147,6 @@ metadata:
147
147
  documentation_uri: https://docs.rubocop.org/rubocop-ast/
148
148
  bug_tracker_uri: https://github.com/rubocop/rubocop-ast/issues
149
149
  rubygems_mfa_required: 'true'
150
- post_install_message:
151
150
  rdoc_options: []
152
151
  require_paths:
153
152
  - lib
@@ -162,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
162
161
  - !ruby/object:Gem::Version
163
162
  version: '0'
164
163
  requirements: []
165
- rubygems_version: 3.5.11
166
- signing_key:
164
+ rubygems_version: 3.6.2
167
165
  specification_version: 4
168
166
  summary: RuboCop tools to deal with Ruby code AST.
169
167
  test_files: []