rubocop-ast 1.37.0 → 1.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71290c5f117f13043b681f7ce182d115284b84675bbfc0bf35448152ebfb42bd
-  data.tar.gz: 3c13a0e8e089409da5dd353bfea60c3981f56dac094f7a650690f3862bdf3e36
+  metadata.gz: c7fd9852873f22808386ddc6962f7373509ec03930f3e5c667475d512480b705
+  data.tar.gz: b6d36926cd045b8486679af378d1fdd21875b941d3f5916fbb6876f04ef75e11
 SHA512:
-  metadata.gz: '08c425d33229f9116b91905ef14ea762ad2d17603ae581795d3101526a51ee6a4c8e1ab2e508f2355b688e4143f668e71767f8283934ee3b27f045315add0a28'
-  data.tar.gz: 58173b8980810073f670c9087905923661d8a3fe0a43c17b354388ee07728611a6c5d1a690a2813184a6d4286c29c090d11d4f28de001ae395bfb774c53720bc
+  metadata.gz: b83bb3a5b3c20a8831d6ad8e075d536b3ff8042d873ce6062161fbe1556e80da5fc4646499dc0432864ecb034ffe3ade83f7ac2f37562a9df22620b486e61e5a
+  data.tar.gz: d6f98f800797330d515911991c9215e8fa616cdcde7a73666aa0d25ff05b70b9274a1f0df689f8a820a6573c391bca487100a258a142c21a60f3fd8ea6e5c5e8

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/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

@@ -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,10 @@ module RuboCop
         erange: :range,
 
         send: :call,
-        csend: :call
+        csend: :call,
+
+        block: :any_block,
+        numblock: :any_block
       }.freeze
       private_constant :GROUP_FOR_TYPE
 
@@ -343,7 +343,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 +528,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 +567,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 +580,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 +590,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 +666,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

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/processed_source.rb

@@ -285,19 +285,14 @@ 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
-            require 'prism/translation/parser33'
+            require_prism_translation_parser(ruby_version)
             Prism::Translation::Parser33
           when 3.4
-            require 'prism/translation/parser34'
+            require_prism_translation_parser(ruby_version)
             Prism::Translation::Parser34
           else
             raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
@@ -306,6 +301,31 @@ 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!
+      end
+
       def create_parser(ruby_version, parser_engine)
         builder = RuboCop::AST::Builder.new
 

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/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.38.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.37.0
+  version: 1.38.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser