rubocop-ast 1.40.0 → 1.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 572b1323e4358215b5e093fa0326fb04dc3d7986746143b75bd0d58223d2dc9e
-  data.tar.gz: 96d40dd742d28e480ca3be7dd7fd16bf9f410e7631373d4c441a74530bfc0314
+  metadata.gz: 724e2118bf289e457d58db38594035fb1888100577cbc82ca6e7352b2d952d24
+  data.tar.gz: 0f957ba53af55775cfa988490b2ea07db0022d9b3dba3d28c48a95aff64552ad
 SHA512:
-  metadata.gz: fd75e5325a907aead5239937ee34447d16da764f1fe2a31d140c9d4f5398b4c4a81c5f88a697bb62149845fc24691b53d526cc5ac05b1060472e92fceaceefae
-  data.tar.gz: d04d2d4dcf76bd6b23e9f6b2a44af18562d8bed8d9767b0511e58feabe762f90fba42f73869500fbe8c34ec1d0e4b6bebe74e7b3bbee18a83b284a97c05d477c
+  metadata.gz: db7476e8bff5a7357b8722d6a48fd185ef296e10c9e69de6e8efd76e5f281e7ad8e4c18303df1415c8219359f17fe860742fd12ae3be726f8acdeacf9afed84f
+  data.tar.gz: c06cf9bed363772ee88102f93685993025c03886d0f68b01d139d20c128fe4d3bd66707321431d559b75801ce84613f6c0ccf3bb19fad674482a377418134e53

data/lib/rubocop/ast/builder.rb

@@ -32,6 +32,7 @@ module RuboCop
         gvasgn:              AsgnNode,
         block:               BlockNode,
         numblock:            BlockNode,
+        itblock:             BlockNode,
         break:               BreakNode,
         case_match:          CaseMatchNode,
         casgn:               CasgnNode,

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/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,11 +303,10 @@ 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/parser33'
@@ -319,6 +314,9 @@ module RuboCop
           when 3.4
             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}"
@@ -331,49 +329,17 @@ module RuboCop
         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
+        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.
@@ -397,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

@@ -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.40.0'
+      STRING = '1.43.0'
     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,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.43.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -18,14 +17,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: []
@@ -148,7 +161,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
@@ -163,8 +175,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: []