rubocop-ast 1.39.0 → 1.44.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d2a487128abbc36ae15a961ea8b7d1e5c63a266efb81cfbb815965d4f77a4e0
-  data.tar.gz: 10af6d44e0a7b22a6e43f3e14e720c0df6991be9efc2e38ad47c5526d170d935
+  metadata.gz: 9310771bd0730e0408e6db665c1f0db5d52ae370aa7eb761ac3942777f4d6cee
+  data.tar.gz: ccd0f8b884bc0f3d8404e46db57cabd956ac8e808873ead64c4ba38a2d2387fe
 SHA512:
-  metadata.gz: 4eec6dc6fbb933a3c8628cfc54332e1b019b7423b298ac155899cfc62db3e52ddfd1a3308d20bea5e856250ed56af0a84ae856e4ef482e7368e0f1c1be264639
-  data.tar.gz: 1e20432910c02a763ccc0d99ac18771b4ac0ac578c2d749ecc77e9084ec4784551fb8778ee3bbdf24709a9ec00f046320cb37c9975038c04f5674a24db943c04
+  metadata.gz: 74c053c8bcba554f9816b44b58f1d8b531c643d615961c9ffb56e79177d59a596477565b13d6317de7e7132dd7c70d9428ae8381a1757c9836073515edad8740
+  data.tar.gz: cd6d7101a68f5ccb8657acf28d094c07a44bbd6312b8a381e16f34f8a4211929a00c26d6f5adced13ef7da085d704ffd8d303d7ae0ade38d41de0792aa5c6898

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
@@ -200,8 +200,7 @@ module RuboCop
         arg = node.children[2]
 
         return unless node.send_type? && node.receiver.nil? && arg.is_a?(::AST::Node)
-
-        return arg if arg.type?(:def, :defs)
+        return arg if arg.any_def_type?
 
         def_modifier(arg)
       end
@@ -271,7 +270,7 @@ module RuboCop
 
       # @!method adjacent_def_modifier?(node = self)
       def_node_matcher :adjacent_def_modifier?, <<~PATTERN
-        (send nil? _ ({def defs} ...))
+        (send nil? _ (any_def ...))
       PATTERN
 
       # @!method bare_access_modifier_declaration?(node = self)

data/lib/rubocop/ast/node.rb

@@ -87,6 +87,9 @@ module RuboCop
 
       # @api private
       GROUP_FOR_TYPE = {
+        def: :any_def,
+        defs: :any_def,
+
         arg: :argument,
         optarg: :argument,
         restarg: :argument,
@@ -112,7 +115,8 @@ module RuboCop
         csend: :call,
 
         block: :any_block,
-        numblock: :any_block
+        numblock: :any_block,
+        itblock: :any_block
       }.freeze
       private_constant :GROUP_FOR_TYPE
 
@@ -512,6 +516,10 @@ module RuboCop
         parent&.send_type? && parent.arguments.include?(self)
       end
 
+      def any_def_type?
+        GROUP_FOR_TYPE[type] == :any_def
+      end
+
       def argument_type?
         GROUP_FOR_TYPE[type] == :argument
       end

data/lib/rubocop/ast/node_pattern/compiler/debug.rb

@@ -109,14 +109,7 @@ module RuboCop
             private
 
             def ruby_ast(ruby)
-              buffer = ::Parser::Source::Buffer.new('(ruby)', source: ruby)
-              ruby_parser.parse(buffer)
-            end
-
-            def ruby_parser
-              require 'parser/current'
-              builder = ::RuboCop::AST::Builder.new
-              ::Parser::CurrentRuby.new(builder)
+              ProcessedSource.new(ruby, RUBY_VERSION.to_f, '(ruby)').ast
             end
           end
 

data/lib/rubocop/ast/processed_source.rb

@@ -35,25 +35,21 @@ module RuboCop
       INVALID_LEVELS = %i[error fatal].freeze
       private_constant :INVALID_LEVELS
 
-      PARSER_ENGINES = %i[parser_whitequark parser_prism].freeze
+      PARSER_ENGINES = %i[default parser_whitequark parser_prism].freeze
       private_constant :PARSER_ENGINES
 
       attr_reader :path, :buffer, :ast, :comments, :tokens, :diagnostics,
                   :parser_error, :raw_source, :ruby_version, :parser_engine
 
-      def self.from_file(path, ruby_version, parser_engine: :parser_whitequark)
+      def self.from_file(path, ruby_version, parser_engine: :default)
         file = File.read(path, mode: 'rb')
         new(file, ruby_version, path, parser_engine: parser_engine)
       end
 
       def initialize(
-        source, ruby_version, path = nil, parser_engine: :parser_whitequark, prism_result: nil
+        source, ruby_version, path = nil, parser_engine: :default, 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` ' \
-                               "or `parser_prism`, but `#{parser_engine}` was passed."
-        end
+        parser_engine = normalize_parser_engine(parser_engine, ruby_version)
 
         # Defaults source encoding to UTF-8, regardless of the encoding it has
         # been read with, which could be non-utf8 depending on the default
@@ -307,18 +303,20 @@ module RuboCop
             require 'parser/ruby34'
             Parser::Ruby34
           else
-            raise ArgumentError, "RuboCop found unknown Ruby version: #{ruby_version.inspect}"
+            raise ArgumentError, 'RuboCop supports target Ruby versions 3.4 and below with ' \
+                                 "`parser`. Specified target Ruby version: #{ruby_version.inspect}"
           end
         when :parser_prism
-          require_prism
-
           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
+          when 3.5
+            require 'prism/translation/parser35'
+            Prism::Translation::Parser35
           else
             raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
                                  "Specified target Ruby version: #{ruby_version.inspect}"
@@ -326,43 +324,22 @@ module RuboCop
         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.
-      def require_prism
-        require 'prism'
-      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!
+      def builder_class(parser_engine)
+        case parser_engine
+        when :parser_whitequark
+          RuboCop::AST::Builder
+        when :parser_prism
+          RuboCop::AST::BuilderPrism
+        end
       end
 
       # 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)
 
-        # 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
+        parser_instance = if prism_result
                             # 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.
@@ -386,6 +363,31 @@ module RuboCop
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
+      def normalize_parser_engine(parser_engine, ruby_version)
+        parser_engine = parser_engine.to_sym
+        unless PARSER_ENGINES.include?(parser_engine)
+          raise ArgumentError, 'The keyword argument `parser_engine` accepts `default`, ' \
+                               "`parser_whitequark`, or `parser_prism`, but `#{parser_engine}` " \
+                               'was passed.'
+        end
+        if parser_engine == :default
+          default_parser_engine(ruby_version)
+        else
+          parser_engine
+        end
+      end
+
+      # The Parser gem does not support Ruby 3.5 or later.
+      # It is also not fully compatible with Ruby 3.4 but for
+      # now respects using parser for backwards compatibility.
+      def default_parser_engine(ruby_version)
+        if ruby_version >= 3.4
+          :parser_prism
+        else
+          :parser_whitequark
+        end
+      end
+
       def first_token_index(range_or_node)
         begin_pos = source_range(range_or_node).begin_pos
         sorted_tokens.bsearch_index { |token| token.begin_pos >= begin_pos }

data/lib/rubocop/ast/traversal.rb

@@ -118,7 +118,7 @@ module RuboCop
       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
-                              while_post until_post iflipflop eflipflop
+                              while_post until_post
                               match_with_lvasgn begin kwbegin return
                               in_match match_alt break next
                               match_as array_pattern array_pattern_with_tail
@@ -126,7 +126,7 @@ module RuboCop
                               index indexasgn procarg0 kwargs]
       many_opt_node_children = %i[case rescue resbody ensure for when
                                   case_match in_pattern irange erange
-                                  match_pattern match_pattern_p]
+                                  match_pattern match_pattern_p iflipflop eflipflop]
 
       ### Callbacks for above
       def_callback no_children
@@ -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.44.1'
     end
   end
 end

data/lib/rubocop/ast.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'parser'
+require 'prism'
 require 'forwardable'
 require 'set'
 
@@ -92,6 +93,7 @@ require_relative 'ast/node/when_node'
 require_relative 'ast/node/while_node'
 require_relative 'ast/node/yield_node'
 require_relative 'ast/builder'
+require_relative 'ast/builder_prism'
 require_relative 'ast/processed_source'
 require_relative 'ast/rubocop_compatibility'
 require_relative 'ast/token'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.39.0
+  version: 1.44.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-16 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -18,14 +18,28 @@ 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
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: "    RuboCop's Node and NodePattern classes.\n"
 email: rubocop@googlegroups.com
 executables: []
@@ -39,6 +53,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