rubocop-ast 1.38.1 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7fd9852873f22808386ddc6962f7373509ec03930f3e5c667475d512480b705
-  data.tar.gz: b6d36926cd045b8486679af378d1fdd21875b941d3f5916fbb6876f04ef75e11
+  metadata.gz: 572b1323e4358215b5e093fa0326fb04dc3d7986746143b75bd0d58223d2dc9e
+  data.tar.gz: 96d40dd742d28e480ca3be7dd7fd16bf9f410e7631373d4c441a74530bfc0314
 SHA512:
-  metadata.gz: b83bb3a5b3c20a8831d6ad8e075d536b3ff8042d873ce6062161fbe1556e80da5fc4646499dc0432864ecb034ffe3ade83f7ac2f37562a9df22620b486e61e5a
-  data.tar.gz: d6f98f800797330d515911991c9215e8fa616cdcde7a73666aa0d25ff05b70b9274a1f0df689f8a820a6573c391bca487100a258a142c21a60f3fd8ea6e5c5e8
+  metadata.gz: fd75e5325a907aead5239937ee34447d16da764f1fe2a31d140c9d4f5398b4c4a81c5f88a697bb62149845fc24691b53d526cc5ac05b1060472e92fceaceefae
+  data.tar.gz: d04d2d4dcf76bd6b23e9f6b2a44af18562d8bed8d9767b0511e58feabe762f90fba42f73869500fbe8c34ec1d0e4b6bebe74e7b3bbee18a83b284a97c05d477c

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 = {
@@ -107,7 +100,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 +112,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.rb

@@ -685,7 +685,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/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)
@@ -289,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. ' \
@@ -301,35 +326,64 @@ 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
+      # rubocop:enable Metrics/MethodLength
 
-      # 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: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)
 
-      def create_parser(ruby_version, parser_engine)
-        builder = RuboCop::AST::Builder.new
+        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
@@ -341,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/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,7 +152,7 @@ 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

data/lib/rubocop/ast/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.38.1'
+      STRING = '1.40.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.38.1
+  version: 1.40.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -39,6 +39,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