rubocop-ast 1.39.0 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d2a487128abbc36ae15a961ea8b7d1e5c63a266efb81cfbb815965d4f77a4e0
-  data.tar.gz: 10af6d44e0a7b22a6e43f3e14e720c0df6991be9efc2e38ad47c5526d170d935
+  metadata.gz: 19ee463e3a3cb36f4cac11ef8a15c891d15ab7a7b616cab272bcef1e5d1511ad
+  data.tar.gz: d01d708fe51840b874ac59409db40e12860f04d639159606633bcaf31b73a22a
 SHA512:
-  metadata.gz: 4eec6dc6fbb933a3c8628cfc54332e1b019b7423b298ac155899cfc62db3e52ddfd1a3308d20bea5e856250ed56af0a84ae856e4ef482e7368e0f1c1be264639
-  data.tar.gz: 1e20432910c02a763ccc0d99ac18771b4ac0ac578c2d749ecc77e9084ec4784551fb8778ee3bbdf24709a9ec00f046320cb37c9975038c04f5674a24db943c04
+  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/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/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

data/lib/rubocop/ast/node.rb

@@ -112,7 +112,8 @@ module RuboCop
         csend: :call,
 
         block: :any_block,
-        numblock: :any_block
+        numblock: :any_block,
+        itblock: :any_block
       }.freeze
       private_constant :GROUP_FOR_TYPE
 

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

@@ -314,10 +314,10 @@ module RuboCop
 
           case ruby_version
           when 3.3
-            require_prism_translation_parser(ruby_version)
+            require 'prism/translation/parser33'
             Prism::Translation::Parser33
           when 3.4
-            require_prism_translation_parser(ruby_version)
+            require 'prism/translation/parser34'
             Prism::Translation::Parser34
           else
             raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
@@ -326,34 +326,45 @@ module RuboCop
         end
       end
 
+      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
-
-      # While Prism is not yet a dependency, users may run with outdated versions that
-      # don't have all the parsers.
-      def require_prism_translation_parser(version)
-        require "prism/translation/parser#{version.to_s.delete('.')}"
-      rescue LoadError
-        warn <<~MESSAGE
-          Error: Unable to load Prism parser for Ruby #{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
+      # rubocop:enable Metrics/MethodLength
 
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def create_parser(ruby_version, parser_engine, prism_result)
-        builder = RuboCop::AST::Builder.new
+        builder = builder_class(parser_engine).new
 
         parser_class = parser_class(ruby_version, parser_engine)
 

data/lib/rubocop/ast/traversal.rb

@@ -159,6 +159,7 @@ module RuboCop
       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
@@ -176,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/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.39.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.39.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-16 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: []