rubocop-ast 1.36.2 → 1.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c76274a87f19afed0f78fd17a51276f0018b7d1771e762135102b4d52b5a5e
-  data.tar.gz: b1e0a8669b789f063b3a73cdddc6187ef65fa80e8af376a898d90003af988370
+  metadata.gz: 3a3205a51f90d1dc493ef4c1ec96a4f40ed796dfc58bfc3661db72e67e134abc
+  data.tar.gz: 6d55fec1f58d712845ecb936db794934ea264e64b0adeb2c097fae63a5e5cb3e
 SHA512:
-  metadata.gz: 53acbd7b42693e94af37b5ec5e894c77416edabb7a5ad7cb9a4bc82f605dad8b6f324a41a68fe83cfe8227d4421fff4bba77c1b6c33d1234af7972b74a3e6f2f
-  data.tar.gz: d5723bec108faa1d19eff03b0fefb2f8eeefe885253f16180bedbde4589cba16db6dfd45d27bb82a0f14538e9c93416dd23756f0f79fa3d68ae67a7b3ff30c64
+  metadata.gz: 9468ab39ad7cd4ca56f0781605f07136dc89dfcbafc51482d5045799b468bf389d3c61671f49c7242f3dfbcc99090f3bd4b0c178d08b6038818b0158e3078658
+  data.tar.gz: a5b2b0604abdd935bfba3213a908678b5697cee7345f5b9941bfdddbfc08ceb8e86cab35895490f2612fd71937baa2ff5b7d75bb2ee4dafb5efd656178dc00c1

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
 
@@ -34,7 +34,7 @@ module RuboCop
       #
       # @return [Boolean] whether the array is enclosed in square brackets
       def square_brackets?
-        loc.begin&.is?('[')
+        loc_is?(:begin, '[')
       end
 
       # Checks whether the `array` literal is delimited by percent brackets.
@@ -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/for_node.rb

@@ -17,7 +17,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `for` node has a `do` keyword
       def do?
-        loc.begin&.is?('do')
+        loc_is?(:begin, 'do')
       end
 
       # Checks whether this node body is a void context.

data/lib/rubocop/ast/node/hash_node.rb

@@ -115,7 +115,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `hash` literal is enclosed in braces
       def braces?
-        loc.end&.is?('}')
+        loc_is?(:end, '}')
       end
     end
   end

data/lib/rubocop/ast/node/if_node.rb

@@ -25,6 +25,13 @@ module RuboCop
         keyword == 'unless'
       end
 
+      # Checks whether the `if` node has an `then` clause.
+      #
+      # @return [Boolean] whether the node has an `then` clause
+      def then?
+        loc_is?(:begin, 'then')
+      end
+
       # Checks whether the `if` is an `elsif`. Parser handles these by nesting
       # `if` nodes in the `else` branch.
       #
@@ -40,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/in_pattern_node.rb

@@ -24,7 +24,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `in` node has a `then` keyword
       def then?
-        loc.begin&.is?('then')
+        loc_is?(:begin, 'then')
       end
 
       # Returns the body of the `in` node.

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/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?
 
@@ -117,7 +117,7 @@ module RuboCop
       #
       # @return [Boolean] whether the method was called with a connecting dot
       def dot?
-        loc.respond_to?(:dot) && loc.dot&.is?('.')
+        loc_is?(:dot, '.')
       end
 
       # Checks whether the dispatched method uses a double colon to connect the
@@ -125,7 +125,7 @@ module RuboCop
       #
       # @return [Boolean] whether the method was called with a connecting dot
       def double_colon?
-        loc.respond_to?(:dot) && loc.dot&.is?('::')
+        loc_is?(:dot, '::')
       end
 
       # Checks whether the dispatched method uses a safe navigation operator to
@@ -133,7 +133,7 @@ module RuboCop
       #
       # @return [Boolean] whether the method was called with a connecting dot
       def safe_navigation?
-        loc.respond_to?(:dot) && loc.dot&.is?('&.')
+        loc_is?(:dot, '&.')
       end
 
       # Checks whether the *explicit* receiver of this method dispatch is
@@ -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
@@ -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

@@ -13,7 +13,7 @@ module RuboCop
       # @return [Boolean] whether this node's arguments are
       #                   wrapped in parentheses
       def parenthesized?
-        loc.end&.is?(')')
+        loc_is?(:end, ')')
       end
 
       # A shorthand for getting the first argument of the node.

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

@@ -8,13 +8,49 @@ module RuboCop
     class StrNode < Node
       include BasicLiteralNode
 
+      PERCENT_LITERAL_TYPES = {
+        :% => /\A%(?=[^a-zA-Z])/,
+        :q => /\A%q/,
+        :Q => /\A%Q/
+      }.freeze
+      private_constant :PERCENT_LITERAL_TYPES
+
+      def single_quoted?
+        loc_is?(:begin, "'")
+      end
+
+      def double_quoted?
+        loc_is?(:begin, '"')
+      end
+
       def character_literal?
-        loc.respond_to?(:begin) && loc.begin&.is?('?')
+        loc_is?(:begin, '?')
       end
 
       def heredoc?
         loc.is_a?(Parser::Source::Map::Heredoc)
       end
+
+      # Checks whether the string literal is delimited by percent brackets.
+      #
+      # @overload percent_literal?
+      #   Check for any string percent literal.
+      #
+      # @overload percent_literal?(type)
+      #   Check for a string percent literal of type `type`.
+      #
+      # @param type [Symbol] an optional percent literal type
+      #
+      # @return [Boolean] whether the string is enclosed in percent brackets
+      def percent_literal?(type = nil)
+        return false unless loc?(:begin)
+
+        if type
+          loc.begin.source.match?(PERCENT_LITERAL_TYPES.fetch(type))
+        else
+          loc.begin.source.start_with?('%')
+        end
+      end
     end
   end
 end

data/lib/rubocop/ast/node/until_node.rb

@@ -28,7 +28,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `until` node has a `do` keyword
       def do?
-        loc.begin&.is?('do')
+        loc_is?(:begin, 'do')
       end
     end
   end

data/lib/rubocop/ast/node/when_node.rb

@@ -33,7 +33,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `when` node has a `then` keyword
       def then?
-        loc.begin&.is?('then')
+        loc_is?(:begin, 'then')
       end
 
       # Returns the body of the `when` node.

data/lib/rubocop/ast/node/while_node.rb

@@ -28,7 +28,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `until` node has a `do` keyword
       def do?
-        loc.begin&.is?('do')
+        loc_is?(:begin, 'do')
       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)
@@ -497,7 +497,7 @@ module RuboCop
       end
 
       def parenthesized_call?
-        loc.respond_to?(:begin) && loc.begin&.is?('(')
+        loc_is?(:begin, '(')
       end
 
       def call_type?
@@ -528,12 +528,32 @@ 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?(which_loc)
+
+        loc.public_send(which_loc).is?(str)
+      end
+
       # @!method match_guard_clause?(node = self)
       def_node_matcher :match_guard_clause?, <<~PATTERN
         [${(send nil? {:raise :fail} ...) return break next} single_line?]
@@ -547,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?}'
@@ -560,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 ...)
           } ...)
@@ -570,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
@@ -646,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/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.36.2'
+      STRING = '1.38.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.36.2
+  version: 1.38.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser