rubocop-ast 1.37.0 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71290c5f117f13043b681f7ce182d115284b84675bbfc0bf35448152ebfb42bd
-  data.tar.gz: 3c13a0e8e089409da5dd353bfea60c3981f56dac094f7a650690f3862bdf3e36
+  metadata.gz: 19ee463e3a3cb36f4cac11ef8a15c891d15ab7a7b616cab272bcef1e5d1511ad
+  data.tar.gz: d01d708fe51840b874ac59409db40e12860f04d639159606633bcaf31b73a22a
 SHA512:
-  metadata.gz: '08c425d33229f9116b91905ef14ea762ad2d17603ae581795d3101526a51ee6a4c8e1ab2e508f2355b688e4143f668e71767f8283934ee3b27f045315add0a28'
-  data.tar.gz: 58173b8980810073f670c9087905923661d8a3fe0a43c17b354388ee07728611a6c5d1a690a2813184a6d4286c29c090d11d4f28de001ae395bfb774c53720bc
+  metadata.gz: 3172e1d4d9ec2d01a910ef63dbb2593b8c685936e9399ecc6d701cbb808969f25eadf6a7b46bce1993202693c03c11b9bc724be0c2c0e4018213a96ffc41e3b0
+  data.tar.gz: 33871fb889a66acdc8c39c7007f3b829cd2158f3a3c6cc111a924f1350bb1b0bcafa17de4e2c4216f0065449455b29cbec12fa3483cea9eb5623301a9060219e

data/lib/rubocop/ast/builder.rb

@@ -2,20 +2,13 @@
 
 module RuboCop
   module AST
-    # `RuboCop::AST::Builder` is an AST builder that is utilized to let `Parser`
-    # generate ASTs with {RuboCop::AST::Node}.
-    #
-    # @example
-    #   buffer = Parser::Source::Buffer.new('(string)')
-    #   buffer.source = 'puts :foo'
-    #
-    #   builder = RuboCop::AST::Builder.new
-    #   require 'parser/ruby25'
-    #   parser = Parser::Ruby25.new(builder)
-    #   root_node = parser.parse(buffer)
-    class Builder < Parser::Builders::Default
-      self.emit_forward_arg = true if respond_to?(:emit_forward_arg=)
-      self.emit_match_pattern = true if respond_to?(:emit_match_pattern=)
+    # Common functionality between the parser and prism builder
+    # @api private
+    module BuilderExtensions
+      def self.included(base)
+        base.emit_forward_arg = true
+        base.emit_match_pattern = true
+      end
 
       # @api private
       NODE_MAP = {
@@ -39,6 +32,7 @@ module RuboCop
         gvasgn:              AsgnNode,
         block:               BlockNode,
         numblock:            BlockNode,
+        itblock:             BlockNode,
         break:               BreakNode,
         case_match:          CaseMatchNode,
         casgn:               CasgnNode,
@@ -107,7 +101,7 @@ module RuboCop
         node_klass(type).new(type, children, location: source_map)
       end
 
-      # TODO: Figure out what to do about literal encoding handling...
+      # Overwrite the base method to allow strings with invalid encoding
       # More details here https://github.com/whitequark/parser/issues/283
       def string_value(token)
         value(token)
@@ -119,5 +113,20 @@ module RuboCop
         NODE_MAP[type] || Node
       end
     end
+
+    # `RuboCop::AST::Builder` is an AST builder that is utilized to let `Parser`
+    # generate ASTs with {RuboCop::AST::Node}.
+    #
+    # @example
+    #   buffer = Parser::Source::Buffer.new('(string)')
+    #   buffer.source = 'puts :foo'
+    #
+    #   builder = RuboCop::AST::Builder.new
+    #   require 'parser/ruby25'
+    #   parser = Parser::Ruby25.new(builder)
+    #   root_node = parser.parse(buffer)
+    class Builder < Parser::Builders::Default
+      include BuilderExtensions
+    end
   end
 end

data/lib/rubocop/ast/builder_prism.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A parser builder, based on the one provided by prism,
+    # which is capable of emitting AST for more recent Rubies.
+    class BuilderPrism < Prism::Translation::Parser::Builder
+      include BuilderExtensions
+    end
+  end
+end

data/lib/rubocop/ast/node/args_node.rb

@@ -32,7 +32,7 @@ module RuboCop
       #
       # @return [Array<Node>] array of argument nodes.
       def argument_list
-        each_descendant(*ARGUMENT_TYPES).to_a.freeze
+        each_descendant(:argument).to_a.freeze
       end
     end
   end

data/lib/rubocop/ast/node/array_node.rb

@@ -7,8 +7,8 @@ module RuboCop
     # to all `array` nodes within RuboCop.
     class ArrayNode < Node
       PERCENT_LITERAL_TYPES = {
-        string: /^%[wW]/,
-        symbol: /^%[iI]/
+        string: /\A%[wW]/,
+        symbol: /\A%[iI]/
       }.freeze
       private_constant :PERCENT_LITERAL_TYPES
 
@@ -50,7 +50,7 @@ module RuboCop
       # @return [Boolean] whether the array is enclosed in percent brackets
       def percent_literal?(type = nil)
         if type
-          loc.begin && loc.begin.source =~ PERCENT_LITERAL_TYPES[type]
+          loc.begin&.source&.match?(PERCENT_LITERAL_TYPES.fetch(type))
         else
           loc.begin&.source&.start_with?('%')
         end

data/lib/rubocop/ast/node/block_node.rb

@@ -11,6 +11,8 @@ module RuboCop
     class BlockNode < Node
       include MethodIdentifierPredicates
 
+      IT_BLOCK_ARGUMENT = [ArgNode.new(:arg, [:it])].freeze
+      private_constant :IT_BLOCK_ARGUMENT
       VOID_CONTEXT_METHODS = %i[each tap].freeze
       private_constant :VOID_CONTEXT_METHODS
 
@@ -46,10 +48,10 @@ module RuboCop
       #
       # @return [Array<Node>]
       def arguments
-        if numblock_type?
-          [].freeze # Numbered parameters have no block arguments.
-        else
+        if block_type?
           node_parts[1]
+        else
+          [].freeze # Numblocks and itblocks have no explicit block arguments.
         end
       end
 
@@ -60,6 +62,8 @@ module RuboCop
       def argument_list
         if numblock_type?
           numbered_arguments
+        elsif itblock_type?
+          IT_BLOCK_ARGUMENT
         else
           arguments.argument_list
         end
@@ -153,10 +157,7 @@ module RuboCop
 
       private
 
-      # Numbered arguments of this `numblock`.
       def numbered_arguments
-        return [].freeze unless numblock_type?
-
         max_param = children[1]
         1.upto(max_param).map do |i|
           ArgNode.new(:arg, [:"_#{i}"])

data/lib/rubocop/ast/node/ensure_node.rb

@@ -6,11 +6,24 @@ module RuboCop
     # node when the builder constructs the AST, making its methods available
     # to all `ensure` nodes within RuboCop.
     class EnsureNode < Node
+      DEPRECATION_WARNING_LOCATION_CACHE = [] # rubocop:disable Style/MutableConstant
+      private_constant :DEPRECATION_WARNING_LOCATION_CACHE
+
       # Returns the body of the `ensure` clause.
       #
       # @return [Node, nil] The body of the `ensure`.
       # @deprecated Use `EnsureNode#branch`
       def body
+        first_caller = caller(1..1).first
+
+        unless DEPRECATION_WARNING_LOCATION_CACHE.include?(first_caller)
+          warn '`EnsureNode#body` is deprecated and will be changed in the next major version of ' \
+               'rubocop-ast. Use `EnsureNode#branch` instead to get the body of the `ensure` branch.'
+          warn "Called from:\n#{caller.join("\n")}\n\n"
+
+          DEPRECATION_WARNING_LOCATION_CACHE << first_caller
+        end
+
         branch
       end
 

data/lib/rubocop/ast/node/if_node.rb

@@ -47,14 +47,14 @@ module RuboCop
       #
       # @return [Boolean] whether the node has an `else` clause
       def else?
-        loc.respond_to?(:else) && loc.else
+        loc?(:else)
       end
 
       # Checks whether the `if` node is a ternary operator.
       #
       # @return [Boolean] whether the `if` node is a ternary operator
       def ternary?
-        loc.respond_to?(:question)
+        loc?(:question)
       end
 
       # Returns the keyword of the `if` statement as a string. Returns an empty

data/lib/rubocop/ast/node/masgn_node.rb

@@ -20,7 +20,7 @@ module RuboCop
       # @return [Array<Symbol>] names of all the variables being assigned
       def names
         assignments.map do |assignment|
-          if assignment.send_type? || assignment.indexasgn_type?
+          if assignment.type?(:send, :indexasgn)
             assignment.method_name
           else
             assignment.name

data/lib/rubocop/ast/node/mixin/descendence.rb

@@ -25,7 +25,7 @@ module RuboCop
         children.each do |child|
           next unless child.is_a?(::AST::Node)
 
-          yield child if types.empty? || types.include?(child.type)
+          yield child if types.empty? || child.type?(*types)
         end
 
         self
@@ -95,7 +95,7 @@ module RuboCop
       def each_node(*types, &block)
         return to_enum(__method__, *types) unless block
 
-        yield self if types.empty? || types.include?(type)
+        yield self if types.empty? || type?(*types)
 
         visit_descendants(types, &block)
 
@@ -108,7 +108,7 @@ module RuboCop
         children.each do |child|
           next unless child.is_a?(::AST::Node)
 
-          yield child if types.empty? || types.include?(child.type)
+          yield child if types.empty? || child.type?(*types)
           child.visit_descendants(types, &block)
         end
       end

data/lib/rubocop/ast/node/mixin/hash_element_node.rb

@@ -99,7 +99,9 @@ module RuboCop
 
         def valid_argument_types?
           [first, second].all? do |argument|
+            # rubocop:disable InternalAffairs/NodeTypeMultiplePredicates
             argument.pair_type? || argument.kwsplat_type?
+            # rubocop:enable InternalAffairs/NodeTypeMultiplePredicates
           end
         end
 

data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb

@@ -39,10 +39,10 @@ module RuboCop
         end
       end
 
-      # The `block` or `numblock` node associated with this method dispatch, if any.
+      # The `block`, `numblock`, or `itblock` node associated with this method dispatch, if any.
       #
-      # @return [BlockNode, nil] the `block` or `numblock` node associated with this method
-      #                          call or `nil`
+      # @return [BlockNode, nil] the `block`, `numblock`, or `itblock` node associated with this
+      #                          method call or `nil`
       def block_node
         parent if block_literal?
       end
@@ -105,7 +105,7 @@ module RuboCop
       #
       # @return [Boolean] whether the dispatched method is a setter
       def setter_method?
-        loc.respond_to?(:operator) && loc.operator
+        loc?(:operator)
       end
       alias assignment? setter_method?
 
@@ -165,7 +165,7 @@ module RuboCop
       #
       # @return [Boolean] whether the dispatched method has a block
       def block_literal?
-        (parent&.block_type? || parent&.numblock_type?) && eql?(parent.send_node)
+        parent&.any_block_type? && eql?(parent.send_node)
       end
 
       # Checks whether this node is an arithmetic operation
@@ -201,7 +201,7 @@ module RuboCop
 
         return unless node.send_type? && node.receiver.nil? && arg.is_a?(::AST::Node)
 
-        return arg if arg.def_type? || arg.defs_type?
+        return arg if arg.type?(:def, :defs)
 
         def_modifier(arg)
       end
@@ -260,7 +260,7 @@ module RuboCop
           ^{                                       # or the parent is...
             sclass class module class_constructor? # a class-like node
             [ {                                    # or some "wrapper"
-                kwbegin begin block numblock
+                kwbegin begin any_block
                 (if _condition <%0 _>)  # note: we're excluding the condition of `if` nodes
               }
               #in_macro_scope?                     # that is itself in a macro scope

data/lib/rubocop/ast/node/mixin/parameterized_node.rb

@@ -57,7 +57,7 @@ module RuboCop
       # @return [Boolean] whether the last argument of the node is a block pass
       def block_argument?
         arguments? &&
-          (last_argument.block_pass_type? || last_argument.blockarg_type?)
+          last_argument.type?(:block_pass, :blockarg)
       end
 
       # A specialized `ParameterizedNode` for node that have a single child

data/lib/rubocop/ast/node/mixin/predicate_operator_node.rb

@@ -14,6 +14,11 @@ module RuboCop
       SEMANTIC_OR = 'or'
       private_constant :SEMANTIC_OR
 
+      LOGICAL_OPERATORS = [LOGICAL_AND, LOGICAL_OR].freeze
+      private_constant :LOGICAL_OPERATORS
+      SEMANTIC_OPERATORS = [SEMANTIC_AND, SEMANTIC_OR].freeze
+      private_constant :SEMANTIC_OPERATORS
+
       # Returns the operator as a string.
       #
       # @return [String] the operator
@@ -25,14 +30,14 @@ module RuboCop
       #
       # @return [Boolean] whether this is a logical operator
       def logical_operator?
-        operator == LOGICAL_AND || operator == LOGICAL_OR
+        LOGICAL_OPERATORS.include?(operator)
       end
 
       # Checks whether this is a semantic operator.
       #
       # @return [Boolean] whether this is a semantic operator
       def semantic_operator?
-        operator == SEMANTIC_AND || operator == SEMANTIC_OR
+        SEMANTIC_OPERATORS.include?(operator)
       end
     end
   end

data/lib/rubocop/ast/node/str_node.rb

@@ -13,6 +13,7 @@ module RuboCop
         :q => /\A%q/,
         :Q => /\A%Q/
       }.freeze
+      private_constant :PERCENT_LITERAL_TYPES
 
       def single_quoted?
         loc_is?(:begin, "'")
@@ -42,13 +43,12 @@ module RuboCop
       #
       # @return [Boolean] whether the string is enclosed in percent brackets
       def percent_literal?(type = nil)
-        opening_delimiter = loc.begin if loc.respond_to?(:begin)
-        return false unless opening_delimiter
+        return false unless loc?(:begin)
 
         if type
-          opening_delimiter.source.match?(PERCENT_LITERAL_TYPES.fetch(type))
+          loc.begin.source.match?(PERCENT_LITERAL_TYPES.fetch(type))
         else
-          opening_delimiter.source.start_with?('%')
+          loc.begin.source.start_with?('%')
         end
       end
     end

data/lib/rubocop/ast/node.rb

@@ -76,9 +76,6 @@ module RuboCop
       OPERATOR_KEYWORDS = %i[and or].to_set.freeze
       # @api private
       SPECIAL_KEYWORDS = %w[__FILE__ __LINE__ __ENCODING__].to_set.freeze
-      # @api private
-      ARGUMENT_TYPES = %i[arg optarg restarg kwarg kwoptarg kwrestarg
-                          blockarg forward_arg shadowarg].to_set.freeze
 
       LITERAL_RECURSIVE_METHODS = (COMPARISON_OPERATORS + %i[* ! <=>]).freeze
       LITERAL_RECURSIVE_TYPES = (OPERATOR_KEYWORDS + COMPOSITE_LITERALS + %i[begin pair]).freeze
@@ -98,7 +95,7 @@ module RuboCop
         kwrestarg: :argument,
         blockarg: :argument,
         forward_arg: :argument,
-        shardowarg: :argument,
+        shadowarg: :argument,
 
         true: :boolean,
         false: :boolean,
@@ -112,7 +109,11 @@ module RuboCop
         erange: :range,
 
         send: :call,
-        csend: :call
+        csend: :call,
+
+        block: :any_block,
+        numblock: :any_block,
+        itblock: :any_block
       }.freeze
       private_constant :GROUP_FOR_TYPE
 
@@ -343,7 +344,7 @@ module RuboCop
 
       # @!method receiver(node = self)
       def_node_matcher :receiver, <<~PATTERN
-        {(send $_ ...) ({block numblock} (call $_ ...) ...)}
+        {(send $_ ...) (any_block (call $_ ...) ...)}
       PATTERN
 
       # @!method str_content(node = self)
@@ -528,21 +529,30 @@ module RuboCop
         GROUP_FOR_TYPE[type] == :range
       end
 
+      def any_block_type?
+        GROUP_FOR_TYPE[type] == :any_block
+      end
+
       def guard_clause?
         node = operator_keyword? ? rhs : self
 
         node.match_guard_clause?
       end
 
+      # Shortcut to safely check if a location is present
+      # @return [Boolean]
+      def loc?(which_loc)
+        return false unless loc.respond_to?(which_loc)
+
+        !loc.public_send(which_loc).nil?
+      end
+
       # Shortcut to safely test a particular location, even if
       # this location does not exist or is `nil`
       def loc_is?(which_loc, str)
-        return false unless loc.respond_to?(which_loc)
-
-        location = loc.public_send(which_loc)
-        return false unless location
+        return false unless loc?(which_loc)
 
-        location.is?(str)
+        loc.public_send(which_loc).is?(str)
       end
 
       # @!method match_guard_clause?(node = self)
@@ -558,7 +568,7 @@ module RuboCop
       PATTERN
 
       # @!method lambda?(node = self)
-      def_node_matcher :lambda?, '({block numblock} (send nil? :lambda) ...)'
+      def_node_matcher :lambda?, '(any_block (send nil? :lambda) ...)'
 
       # @!method lambda_or_proc?(node = self)
       def_node_matcher :lambda_or_proc?, '{lambda? proc?}'
@@ -571,7 +581,7 @@ module RuboCop
         {
           (send #global_const?({:Class :Module :Struct}) :new ...)
           (send #global_const?(:Data) :define ...)
-          ({block numblock} {
+          (any_block {
             (send #global_const?({:Class :Module :Struct}) :new ...)
             (send #global_const?(:Data) :define ...)
           } ...)
@@ -581,20 +591,20 @@ module RuboCop
       # @deprecated Use `:class_constructor?`
       # @!method struct_constructor?(node = self)
       def_node_matcher :struct_constructor?, <<~PATTERN
-        ({block numblock} (send #global_const?(:Struct) :new ...) _ $_)
+        (any_block (send #global_const?(:Struct) :new ...) _ $_)
       PATTERN
 
       # @!method class_definition?(node = self)
       def_node_matcher :class_definition?, <<~PATTERN
         {(class _ _ $_)
          (sclass _ $_)
-         ({block numblock} (send #global_const?({:Struct :Class}) :new ...) _ $_)}
+         (any_block (send #global_const?({:Struct :Class}) :new ...) _ $_)}
       PATTERN
 
       # @!method module_definition?(node = self)
       def_node_matcher :module_definition?, <<~PATTERN
         {(module _ $_)
-         ({block numblock} (send #global_const?(:Module) :new ...) _ $_)}
+         (any_block (send #global_const?(:Module) :new ...) _ $_)}
       PATTERN
 
       # Some expressions are evaluated for their value, some for their side
@@ -657,8 +667,7 @@ module RuboCop
         last_node = self
 
         while (current_node = last_node.parent)
-          yield current_node if types.empty? ||
-                                types.include?(current_node.type)
+          yield current_node if types.empty? || current_node.type?(*types)
           last_node = current_node
         end
       end
@@ -677,7 +686,7 @@ module RuboCop
       def case_if_value_used?
         # (case <condition> <when...>)
         # (if <condition> <truebranch> <falsebranch>)
-        sibling_index.zero? ? true : parent.value_used?
+        sibling_index.zero? || parent.value_used?
       end
 
       def while_until_value_used?

data/lib/rubocop/ast/node_pattern/node.rb

@@ -48,7 +48,7 @@ module RuboCop
           children[0]
         end
 
-        # @return [Integer] nb of captures of that node and its descendants
+        # @return [Integer] nb of captures that this node will emit
         def nb_captures
           children_nodes.sum(&:nb_captures)
         end
@@ -243,6 +243,12 @@ module RuboCop
 
             [with(children: new_children)]
           end
+
+          # Each child in a union must contain the same number
+          # of captures. Only one branch ends up capturing.
+          def nb_captures
+            child.nb_captures
+          end
         end
 
         # Registry

data/lib/rubocop/ast/node_pattern/parser.racc.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.8.1
-# from Racc grammar file "parser.y".
+# This file is automatically generated by Racc 1.5.0
+# from Racc grammar file "".
 #
 
 require 'racc/parser.rb'
@@ -14,15 +14,15 @@ module RuboCop
 
 racc_action_table = [
     14,    15,    16,    21,    18,    17,    19,    10,    11,    12,
-    60,    22,    20,     4,    24,     5,    40,     6,     7,     8,
-    28,    23,    56,    50,    40,    61,    43,    66,    51,    51,
+    60,    22,    20,     4,    40,     5,    43,     6,     7,     8,
+    28,    23,    56,    50,    66,    61,    24,    51,    51,    40,
     58,    14,    15,    16,    21,    18,    17,    19,    10,    11,
     12,   nil,    22,    20,     4,   nil,     5,   nil,     6,     7,
      8,    28,    23,   nil,   nil,   -34,    14,    15,    16,    21,
     18,    17,    19,    10,    11,    12,   nil,    22,    20,     4,
    nil,     5,   nil,     6,     7,     8,     9,    23,    14,    15,
     16,    21,    18,    17,    19,    10,    11,    12,   nil,    22,
-    20,     4,   nil,     5,   nil,     6,     7,     8,    28,    23,
+    20,     4,   nil,     5,   nil,     6,     7,     8,     9,    23,
     14,    15,    16,    21,    18,    17,    19,    10,    11,    12,
    nil,    22,    20,     4,   nil,     5,   nil,     6,     7,     8,
      9,    23,    14,    15,    16,    21,    18,    17,    19,    10,
@@ -33,7 +33,7 @@ racc_action_table = [
     18,    17,    19,    10,    11,    12,   nil,    22,    20,     4,
    nil,     5,   nil,     6,     7,     8,     9,    23,    14,    15,
     16,    21,    18,    17,    19,    10,    11,    12,   nil,    22,
-    20,     4,   nil,     5,   nil,     6,     7,     8,     9,    23,
+    20,     4,   nil,     5,   nil,     6,     7,     8,    28,    23,
     14,    15,    16,    21,    18,    17,    19,    10,    11,    12,
    nil,    22,    20,     4,    44,     5,   nil,     6,     7,     8,
     28,    23,    14,    15,    16,    21,    18,    17,    19,    10,
@@ -47,31 +47,31 @@ racc_action_table = [
     20,     4,   nil,     5,   nil,     6,     7,     8,     9,    23,
     14,    15,    16,    21,    18,    17,    19,    10,    11,    12,
    nil,    22,    20,     4,   nil,     5,   nil,     6,     7,     8,
-     9,    23,    -1,    -1,    -1,    -2,    -2,    -2,    47,    48,
-    49 ]
+     9,    23,    47,    48,    49,    -1,    -1,    -1,    -2,    -2,
+    -2 ]
 
 racc_action_check = [
     42,    42,    42,    42,    42,    42,    42,    42,    42,    42,
-    54,    42,    42,    42,     1,    42,    10,    42,    42,    42,
-    42,    42,    42,    30,    11,    54,    24,    62,    30,    63,
+    54,    42,    42,    42,    11,    42,    24,    42,    42,    42,
+    42,    42,    42,    30,    62,    54,     1,    63,    30,    10,
     42,    59,    59,    59,    59,    59,    59,    59,    59,    59,
     59,   nil,    59,    59,    59,   nil,    59,   nil,    59,    59,
-    59,    59,    59,   nil,   nil,    59,     0,     0,     0,     0,
+    59,    59,    59,   nil,   nil,    59,     5,     5,     5,     5,
+     5,     5,     5,     5,     5,     5,   nil,     5,     5,     5,
+   nil,     5,   nil,     5,     5,     5,     5,     5,     6,     6,
+     6,     6,     6,     6,     6,     6,     6,     6,   nil,     6,
+     6,     6,   nil,     6,   nil,     6,     6,     6,     6,     6,
+     7,     7,     7,     7,     7,     7,     7,     7,     7,     7,
+   nil,     7,     7,     7,   nil,     7,   nil,     7,     7,     7,
+     7,     7,     8,     8,     8,     8,     8,     8,     8,     8,
+     8,     8,   nil,     8,     8,     8,   nil,     8,   nil,     8,
+     8,     8,     8,     8,     9,     9,     9,     9,     9,     9,
+     9,     9,     9,     9,   nil,     9,     9,     9,   nil,     9,
+   nil,     9,     9,     9,     9,     9,     0,     0,     0,     0,
      0,     0,     0,     0,     0,     0,   nil,     0,     0,     0,
    nil,     0,   nil,     0,     0,     0,     0,     0,     4,     4,
      4,     4,     4,     4,     4,     4,     4,     4,   nil,     4,
      4,     4,   nil,     4,   nil,     4,     4,     4,     4,     4,
-     5,     5,     5,     5,     5,     5,     5,     5,     5,     5,
-   nil,     5,     5,     5,   nil,     5,   nil,     5,     5,     5,
-     5,     5,     6,     6,     6,     6,     6,     6,     6,     6,
-     6,     6,   nil,     6,     6,     6,   nil,     6,   nil,     6,
-     6,     6,     6,     6,     7,     7,     7,     7,     7,     7,
-     7,     7,     7,     7,   nil,     7,     7,     7,   nil,     7,
-   nil,     7,     7,     7,     7,     7,     8,     8,     8,     8,
-     8,     8,     8,     8,     8,     8,   nil,     8,     8,     8,
-   nil,     8,   nil,     8,     8,     8,     8,     8,     9,     9,
-     9,     9,     9,     9,     9,     9,     9,     9,   nil,     9,
-     9,     9,   nil,     9,   nil,     9,     9,     9,     9,     9,
     27,    27,    27,    27,    27,    27,    27,    27,    27,    27,
    nil,    27,    27,    27,    27,    27,   nil,    27,    27,    27,
     27,    27,    28,    28,    28,    28,    28,    28,    28,    28,
@@ -85,17 +85,17 @@ racc_action_check = [
     50,    50,   nil,    50,   nil,    50,    50,    50,    50,    50,
     61,    61,    61,    61,    61,    61,    61,    61,    61,    61,
    nil,    61,    61,    61,   nil,    61,   nil,    61,    61,    61,
-    61,    61,    25,    25,    25,    26,    26,    26,    29,    29,
-    29 ]
+    61,    61,    29,    29,    29,    25,    25,    25,    26,    26,
+    26 ]
 
 racc_action_pointer = [
-    54,    14,   nil,   nil,    76,    98,   120,   142,   164,   186,
-     4,    12,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
-   nil,   nil,   nil,   nil,    26,   315,   318,   208,   230,   321,
+   164,    26,   nil,   nil,   186,    54,    76,    98,   120,   142,
+    17,     2,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+   nil,   nil,   nil,   nil,    16,   318,   321,   208,   230,   315,
     -2,   nil,   nil,   252,   nil,   nil,   nil,   nil,   nil,   nil,
    274,   nil,    -2,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
    296,   nil,   nil,   nil,    -6,   nil,   nil,   nil,   nil,    29,
-   nil,   318,     1,    -1,   nil,   nil,   nil ]
+   nil,   318,    -2,    -3,   nil,   nil,   nil ]
 
 racc_action_default = [
    -47,   -47,    -1,    -2,   -31,   -47,   -47,   -47,   -47,   -47,
@@ -107,26 +107,26 @@ racc_action_default = [
    -37,   -47,   -47,   -47,   -35,   -39,   -26 ]
 
 racc_goto_table = [
-     1,    33,    27,    25,    26,    34,    35,    36,    37,    38,
-    42,    32,    39,    41,    46,    63,    62,    64,    54,   nil,
-   nil,   nil,   nil,   nil,   nil,   nil,    25,    26,    38,   nil,
-   nil,   nil,   nil,    53,    45,   nil,   nil,   nil,   nil,   nil,
-    55,    25,    26,   nil,   nil,   nil,    59,   nil,   nil,    57,
+     1,    33,    64,    32,    25,    34,    35,    36,    37,    38,
+    54,    26,    39,    41,    27,    42,    46,    63,    62,   nil,
+   nil,   nil,   nil,   nil,   nil,   nil,    45,    25,    38,   nil,
+   nil,   nil,   nil,    53,    26,   nil,   nil,   nil,   nil,   nil,
+    55,    57,    25,   nil,   nil,   nil,    59,   nil,   nil,    26,
     34,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    53,
    nil,    65 ]
 
 racc_goto_check = [
-     1,     5,     4,     2,     3,     1,     1,     1,     1,     1,
-     8,     9,     6,     6,    10,    11,    12,    13,    14,   nil,
-   nil,   nil,   nil,   nil,   nil,   nil,     2,     3,     1,   nil,
-   nil,   nil,   nil,     1,     9,   nil,   nil,   nil,   nil,   nil,
-     1,     2,     3,   nil,   nil,   nil,     5,   nil,   nil,     9,
+     1,     5,    13,     9,     2,     1,     1,     1,     1,     1,
+    14,     3,     6,     6,     4,     8,    10,    11,    12,   nil,
+   nil,   nil,   nil,   nil,   nil,   nil,     9,     2,     1,   nil,
+   nil,   nil,   nil,     1,     3,   nil,   nil,   nil,   nil,   nil,
+     1,     9,     2,   nil,   nil,   nil,     5,   nil,   nil,     3,
      1,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,     1,
    nil,     1 ]
 
 racc_goto_pointer = [
-   nil,     0,    -1,     0,    -2,    -4,     2,   nil,   -13,     7,
-   -15,   -44,   -43,   -42,   -22 ]
+   nil,     0,     0,     7,    10,    -4,     2,   nil,    -8,    -1,
+   -13,   -42,   -41,   -57,   -30 ]
 
 racc_goto_default = [
    nil,    29,     2,     3,   nil,   nil,   nil,    13,   nil,   nil,
@@ -239,7 +239,6 @@ Racc_arg = [
   racc_shift_n,
   racc_reduce_n,
   racc_use_result_var ]
-Ractor.make_shareable(Racc_arg) if defined?(Ractor)
 
 Racc_token_to_s_table = [
   "$end",
@@ -290,7 +289,6 @@ Racc_token_to_s_table = [
   "opt_rest",
   "rest",
   "arg_list" ]
-Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
 
 Racc_debug_parser = false
 

data/lib/rubocop/ast/processed_source.rb

@@ -4,6 +4,27 @@ require 'digest/sha1'
 
 module RuboCop
   module AST
+    # A `Prism` interface's class that provides a fixed `Prism::ParseLexResult` instead of parsing.
+    #
+    # This class implements the `parse_lex` method to return a preparsed `Prism::ParseLexResult`
+    # rather than parsing the source code.  When the parse result is already available externally,
+    # such as in Ruby LSP, the Prism parsing process can be bypassed.
+    class PrismPreparsed
+      def initialize(prism_result)
+        unless prism_result.is_a?(Prism::ParseLexResult)
+          raise ArgumentError, <<~MESSAGE
+            Expected a `Prism::ParseLexResult` object, but received `#{prism_result.class}`.
+          MESSAGE
+        end
+
+        @prism_result = prism_result
+      end
+
+      def parse_lex(_source, **_prism_options)
+        @prism_result
+      end
+    end
+
     # ProcessedSource contains objects which are generated by Parser
     # and other information such as disabled lines for cops.
     # It also provides a convenient way to access source lines.
@@ -25,7 +46,9 @@ module RuboCop
         new(file, ruby_version, path, parser_engine: parser_engine)
       end
 
-      def initialize(source, ruby_version, path = nil, parser_engine: :parser_whitequark)
+      def initialize(
+        source, ruby_version, path = nil, parser_engine: :parser_whitequark, prism_result: nil
+      )
         parser_engine = parser_engine.to_sym
         unless PARSER_ENGINES.include?(parser_engine)
           raise ArgumentError, 'The keyword argument `parser_engine` accepts `parser_whitequark` ' \
@@ -44,7 +67,7 @@ module RuboCop
         @parser_engine = parser_engine
         @parser_error = nil
 
-        parse(source, ruby_version, parser_engine)
+        parse(source, ruby_version, parser_engine, prism_result)
       end
 
       def ast_with_comments
@@ -202,7 +225,7 @@ module RuboCop
         end
       end
 
-      def parse(source, ruby_version, parser_engine)
+      def parse(source, ruby_version, parser_engine, prism_result)
         buffer_name = @path || STRING_SOURCE_NAME
         @buffer = Parser::Source::Buffer.new(buffer_name, 1)
 
@@ -216,7 +239,9 @@ module RuboCop
           return
         end
 
-        @ast, @comments, @tokens = tokenize(create_parser(ruby_version, parser_engine))
+        parser = create_parser(ruby_version, parser_engine, prism_result)
+
+        @ast, @comments, @tokens = tokenize(parser)
       end
 
       def tokenize(parser)
@@ -285,12 +310,7 @@ module RuboCop
             raise ArgumentError, "RuboCop found unknown Ruby version: #{ruby_version.inspect}"
           end
         when :parser_prism
-          begin
-            require 'prism'
-          rescue LoadError
-            warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
-            exit!
-          end
+          require_prism
 
           case ruby_version
           when 3.3
@@ -306,10 +326,64 @@ module RuboCop
         end
       end
 
-      def create_parser(ruby_version, parser_engine)
-        builder = RuboCop::AST::Builder.new
+      def builder_class(parser_engine)
+        case parser_engine
+        when :parser_whitequark
+          RuboCop::AST::Builder
+        when :parser_prism
+          require_prism
+          require_relative 'builder_prism'
+          RuboCop::AST::BuilderPrism
+        end
+      end
+
+      # Prism is a native extension, a `LoadError` will be raised if linked to an incompatible
+      # Ruby version. Only raise if it really was caused by Prism not being present.
+      # rubocop:disable Metrics/MethodLength
+      def require_prism
+        require 'prism'
+        required_prism_version = '1.4.0'
+        if required_prism_version > Prism::VERSION
+          # While Prism is not yet a dependency, users may run with outdated versions that
+          # don't have all the parsers.
+          warn <<~MESSAGE
+            Error: Prism version #{Prism::VERSION} was loaded, but rubocop-ast requires #{required_prism_version}.
+            * If you're using Bundler and don't yet have `gem 'prism'` as a dependency, add it now.
+            * If you're using Bundler and already have `gem 'prism'` as a dependency, update it to the most recent version.
+            * If you don't use Bundler, run `gem update prism`.
+          MESSAGE
+          exit!
+        end
+      rescue LoadError => e
+        raise unless e.path == 'prism'
+
+        warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
+        exit!
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def create_parser(ruby_version, parser_engine, prism_result)
+        builder = builder_class(parser_engine).new
+
+        parser_class = parser_class(ruby_version, parser_engine)
+
+        # NOTE: Check if the `Prism#initialize` method has the `:parser` keyword argument.
+        # The `:parser` keyword argument cannot be used to switch parsers because older versions of
+        # Prism do not support it.
+        parser_switch_available = parser_class.instance_method(:initialize).parameters.assoc(:key)
+
+        parser_instance = if prism_result && parser_switch_available
+                            # NOTE: Since it is intended for use with Ruby LSP, it targets only Prism.
+                            # If there is no reuse of a pre-parsed result, such as in Ruby LSP,
+                            # regular parsing with Prism occurs, and `else` branch will be executed.
+                            prism_reparsed = PrismPreparsed.new(prism_result)
+                            parser_class.new(builder, parser: prism_reparsed)
+                          else
+                            parser_class.new(builder)
+                          end
 
-        parser_class(ruby_version, parser_engine).new(builder).tap do |parser|
+        parser_instance.tap do |parser|
           # On JRuby there's a risk that we hang in tokenize() if we
           # don't set the all errors as fatal flag. The problem is caused by a bug
           # in Racc that is discussed in issue #93 of the whitequark/parser
@@ -321,6 +395,7 @@ module RuboCop
           end
         end
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       def first_token_index(range_or_node)
         begin_pos = source_range(range_or_node).begin_pos

data/lib/rubocop/ast/token.rb

@@ -5,6 +5,7 @@ module RuboCop
     # A basic wrapper around Parser's tokens.
     class Token
       LEFT_PAREN_TYPES = %i[tLPAREN tLPAREN2].freeze
+      LEFT_CURLY_TYPES = %i[tLCURLY tLAMBEG].freeze
 
       attr_reader :pos, :type, :text
 
@@ -83,7 +84,7 @@ module RuboCop
       end
 
       def left_curly_brace?
-        type == :tLCURLY || type == :tLAMBEG
+        LEFT_CURLY_TYPES.include?(type)
       end
 
       def right_curly_brace?

data/lib/rubocop/ast/traversal.rb

@@ -26,16 +26,18 @@ module RuboCop
         SEND = 'send(TYPE_TO_METHOD[child.type], child)'
         assign_code = 'child = node.children[%<index>i]'
         code = "#{assign_code}\n#{SEND}"
+        # How a particular child node should be visited. For example, if a child node
+        # can be nil it should be guarded behind a nil check. Or, if a child node is a literal
+        # (like a symbol) then the literal itself should not be visited.
         TEMPLATE = {
           skip: '',
           always: code,
           nil?: "#{code} if child"
         }.freeze
 
-        def def_callback(type, *signature,
-                         arity: signature.size..signature.size,
-                         arity_check: ENV.fetch('RUBOCOP_DEBUG', nil) && self.arity_check(arity),
-                         body: self.body(signature, arity_check))
+        def def_callback(type, *child_node_types,
+                         expected_children_count: child_node_types.size..child_node_types.size,
+                         body: self.body(child_node_types, expected_children_count))
           type, *aliases = type
           lineno = caller_locations(1, 1).first.lineno
           module_eval(<<~RUBY, __FILE__, lineno)
@@ -49,16 +51,23 @@ module RuboCop
           end
         end
 
-        def body(signature, prelude)
-          signature
-            .map.with_index do |arg, i|
-              TEMPLATE[arg].gsub('%<index>i', i.to_s)
+        def body(child_node_types, expected_children_count)
+          visit_children_code =
+            child_node_types
+            .map.with_index do |child_type, i|
+              TEMPLATE.fetch(child_type).gsub('%<index>i', i.to_s)
             end
-            .unshift(prelude)
             .join("\n")
+
+          <<~BODY
+            #{children_count_check_code(expected_children_count)}
+            #{visit_children_code}
+          BODY
         end
 
-        def arity_check(range)
+        def children_count_check_code(range)
+          return '' unless ENV.fetch('RUBOCOP_DEBUG', false)
+
           <<~RUBY
             n = node.children.size
             raise DebugError, [
@@ -72,18 +81,18 @@ module RuboCop
       extend CallbackCompiler
       send_code = CallbackCompiler::SEND
 
-      ### arity == 0
+      ### children count == 0
       no_children = %i[true false nil self cbase zsuper redo retry
                        forward_args forwarded_args match_nil_pattern
                        forward_arg forwarded_restarg forwarded_kwrestarg
                        lambda empty_else kwnilarg
                        __FILE__ __LINE__ __ENCODING__]
 
-      ### arity == 0..1
+      ### children count == 0..1
       opt_symbol_child = %i[restarg kwrestarg]
       opt_node_child = %i[splat kwsplat match_rest]
 
-      ### arity == 1
+      ### children count == 1
       literal_child = %i[int float complex
                          rational str sym lvar
                          ivar cvar gvar nth_ref back_ref
@@ -100,12 +109,12 @@ module RuboCop
       NO_CHILD_NODES = (no_children + opt_symbol_child + literal_child).to_set.freeze
       private_constant :NO_CHILD_NODES # Used by Commissioner
 
-      ### arity > 1
+      ### children count > 1
       symbol_then_opt_node = %i[lvasgn ivasgn cvasgn gvasgn]
       symbol_then_node_or_nil = %i[optarg kwoptarg]
       node_then_opt_node = %i[while until module sclass]
 
-      ### variable arity
+      ### variable children count
       many_node_children = %i[dstr dsym xstr regexp array hash pair
                               mlhs masgn or_asgn and_asgn rasgn mrasgn
                               undef alias args super yield or and
@@ -121,18 +130,18 @@ module RuboCop
 
       ### Callbacks for above
       def_callback no_children
-      def_callback opt_symbol_child, :skip, arity: 0..1
-      def_callback opt_node_child, :nil?, arity: 0..1
+      def_callback opt_symbol_child, :skip, expected_children_count: 0..1
+      def_callback opt_node_child, :nil?, expected_children_count: 0..1
 
       def_callback literal_child, :skip
       def_callback node_child, :always
       def_callback node_or_nil_child, :nil?
 
-      def_callback symbol_then_opt_node, :skip, :nil?, arity: 1..2
+      def_callback symbol_then_opt_node, :skip, :nil?, expected_children_count: 1..2
       def_callback symbol_then_node_or_nil, :skip, :nil?
       def_callback node_then_opt_node, :always, :nil?
 
-      def_callback many_symbol_children, :skip, arity_check: nil
+      def_callback many_symbol_children, :skip, expected_children_count: (0..)
       def_callback many_node_children, body: <<~RUBY
         node.children.each { |child| #{send_code} }
       RUBY
@@ -143,13 +152,14 @@ module RuboCop
 
       ### Other particular cases
       def_callback :const, :nil?, :skip
-      def_callback :casgn, :nil?, :skip, :nil?, arity: 2..3
+      def_callback :casgn, :nil?, :skip, :nil?, expected_children_count: 2..3
       def_callback :class, :always, :nil?, :nil?
       def_callback :def, :skip, :always, :nil?
       def_callback :op_asgn, :always, :skip, :always
       def_callback :if, :always, :nil?, :nil?
       def_callback :block, :always, :always, :nil?
       def_callback :numblock, :always, :skip, :nil?
+      def_callback :itblock, :always, :skip, :nil?
       def_callback :defs, :always, :skip, :always, :nil?
 
       def_callback %i[send csend], body: <<~RUBY
@@ -167,7 +177,7 @@ module RuboCop
 
       to_define = ::Parser::Meta::NODE_TYPES.to_a
       to_define -= defined
-      to_define -= %i[numargs ident] # transient
+      to_define -= %i[numargs itarg ident] # transient
       to_define -= %i[blockarg_expr restarg_expr] # obsolete
       to_define -= %i[objc_kwarg objc_restarg objc_varargs] # mac_ruby
       def_callback to_define, body: <<~RUBY

data/lib/rubocop/ast/utilities/simple_forwardable.rb

@@ -5,11 +5,22 @@ module RuboCop
   module SimpleForwardable
     def def_delegators(accessor, *methods)
       methods.each do |method|
-        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-          def #{method}(...)           # def example(...)
-            #{accessor}.#{method}(...) #   foo.example(...)
-          end                          # end
-        RUBY
+        if method.end_with?('=') && method.to_s != '[]='
+          # Defining a delegator for `foo=` can't use `foo=(...)` because it is a
+          # syntax error. Fall back to doing a slower `public_send` instead.
+          # TODO: Use foo(method, ...) when Ruby 3.1 is required.
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def #{method}(*args, **kwargs, &blk)                         # def example=(*args, **kwargs, &blk)
+              #{accessor}.public_send(:#{method}, *args, **kwargs, &blk) #   foo.public_send(:example=, *args, **kwargs, &blk)
+            end                                                          # end
+          RUBY
+        else
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+            def #{method}(...)           # def example(...)
+              #{accessor}.#{method}(...) #   foo.example(...)
+            end                          # end
+          RUBY
+        end
       end
     end
   end

data/lib/rubocop/ast/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.37.0'
+      STRING = '1.41.0'
     end
   end
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.37.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -18,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.1.0
+        version: 3.3.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.1.0
+        version: 3.3.7.2
 description: "    RuboCop's Node and NodePattern classes.\n"
 email: rubocop@googlegroups.com
 executables: []
@@ -39,6 +38,7 @@ files:
 - lib/rubocop-ast.rb
 - lib/rubocop/ast.rb
 - lib/rubocop/ast/builder.rb
+- lib/rubocop/ast/builder_prism.rb
 - lib/rubocop/ast/ext/range.rb
 - lib/rubocop/ast/node.rb
 - lib/rubocop/ast/node/alias_node.rb
@@ -147,7 +147,6 @@ metadata:
   documentation_uri: https://docs.rubocop.org/rubocop-ast/
   bug_tracker_uri: https://github.com/rubocop/rubocop-ast/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RuboCop tools to deal with Ruby code AST.
 test_files: []