rubocop-ast 1.33.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f8352e57bd480b219c3219e60a2e7750e03dfbec0e34c0c0235139d11c0870
-  data.tar.gz: 390a70bd777f6525138ab82faf2242d90ee1c1ace80dc7219e420e4d8780e296
+  metadata.gz: 71290c5f117f13043b681f7ce182d115284b84675bbfc0bf35448152ebfb42bd
+  data.tar.gz: 3c13a0e8e089409da5dd353bfea60c3981f56dac094f7a650690f3862bdf3e36
 SHA512:
-  metadata.gz: b949d204d6c94ac8b4a3ac2546eb25f21a317cb74ea2a8b668c06e504a8b37775c4b6b3257ee59a15231cfbcc97d5c20500680d244e722173dffd4dd80620baf
-  data.tar.gz: b0cbd03ab6d36c40a450e1faccd8eeecdb1b8edfcb0d8dae0e3e3c0adb5050a88967b8fdccb1a553e2f5e63fcfadebb5327e54c25d941df02633071d21a3b449
+  metadata.gz: '08c425d33229f9116b91905ef14ea762ad2d17603ae581795d3101526a51ee6a4c8e1ab2e508f2355b688e4143f668e71767f8283934ee3b27f045315add0a28'
+  data.tar.gz: 58173b8980810073f670c9087905923661d8a3fe0a43c17b354388ee07728611a6c5d1a690a2813184a6d4286c29c090d11d4f28de001ae395bfb774c53720bc

data/lib/rubocop/ast/builder.rb

@@ -63,6 +63,7 @@ module RuboCop
         irange:              RangeNode,
         erange:              RangeNode,
         kwargs:              HashNode,
+        kwbegin:             KeywordBeginNode,
         kwsplat:             KeywordSplatNode,
         lambda:              LambdaNode,
         masgn:               MasgnNode,

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

@@ -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.

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

@@ -12,6 +12,7 @@ module RuboCop
       def name
         node_parts[0]
       end
+      alias lhs name
 
       # The expression being assigned to the variable.
       #
@@ -19,6 +20,7 @@ module RuboCop
       def expression
         node_parts[1]
       end
+      alias rhs expression
     end
   end
 end

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

@@ -9,6 +9,7 @@ module RuboCop
       include ConstantNode
 
       alias name short_name
+      alias lhs short_name
 
       # The expression being assigned to the variable.
       #
@@ -16,6 +17,7 @@ module RuboCop
       def expression
         node_parts[2]
       end
+      alias rhs expression
     end
   end
 end

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

@@ -9,10 +9,25 @@ module RuboCop
       # Returns the body of the `ensure` clause.
       #
       # @return [Node, nil] The body of the `ensure`.
+      # @deprecated Use `EnsureNode#branch`
       def body
+        branch
+      end
+
+      # Returns an the ensure branch in the exception handling statement.
+      #
+      # @return [Node, nil] the body of the ensure branch.
+      def branch
         node_parts[1]
       end
 
+      # Returns the `rescue` node of the `ensure`, if present.
+      #
+      # @return [Node, nil] The `rescue` node.
+      def rescue_node
+        node_parts[0] if node_parts[0].rescue_type?
+      end
+
       # Checks whether this node body is a void context.
       # Always `true` for `ensure`.
       #

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.
       #

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `kwbegin` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `kwbegin` nodes within RuboCop.
+    class KeywordBeginNode < Node
+      # Returns the body of the `kwbegin` block. Returns `self` if the `kwbegin` contains
+      # multiple nodes.
+      #
+      # @return [Node, nil] The body of the `kwbegin`.
+      def body
+        return unless node_parts.any?
+
+        if rescue_node
+          rescue_node.body
+        elsif ensure_node
+          ensure_node.node_parts[0]
+        elsif node_parts.one?
+          node_parts[0]
+        else
+          self
+        end
+      end
+
+      # Returns the `rescue` node of the `kwbegin` block, if one is present.
+      #
+      # @return [Node, nil] The `rescue` node within `kwbegin`.
+      def ensure_node
+        node_parts[0] if node_parts[0]&.ensure_type?
+      end
+
+      # Returns the `rescue` node of the `kwbegin` block, if one is present.
+      #
+      # @return [Node, nil] The `rescue` node within `kwbegin`.
+      def rescue_node
+        return ensure_node&.rescue_node if ensure_node&.rescue_node
+
+        node_parts[0] if node_parts[0]&.rescue_type?
+      end
+    end
+  end
+end

data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb

@@ -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
@@ -281,7 +281,7 @@ module RuboCop
 
       # @!method non_bare_access_modifier_declaration?(node = self)
       def_node_matcher :non_bare_access_modifier_declaration?, <<~PATTERN
-        (send nil? {:public :protected :private :module_function} _)
+        (send nil? {:public :protected :private :module_function} _+)
       PATTERN
     end
   end

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

@@ -8,13 +8,15 @@ module RuboCop
     class MlhsNode < Node
       # Returns all the assignment nodes on the left hand side (LHS) of a multiple assignment.
       # These are generally assignment nodes (`lvasgn`, `ivasgn`, `cvasgn`, `gvasgn`, `casgn`)
-      # but can also be `send` nodes in case of `foo.bar, ... =` or `foo[:bar], ... =`.
+      # but can also be `send` nodes in case of `foo.bar, ... =` or `foo[:bar], ... =`,
+      # or a `splat` node for `*, ... =`.
       #
       # @return [Array<Node>] the assignment nodes of the multiple assignment LHS
       def assignments
         child_nodes.flat_map do |node|
           if node.splat_type?
-            node.child_nodes.first
+            # Anonymous splats have no children
+            node.child_nodes.first || node
           elsif node.mlhs_type?
             node.assignments
           else

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

@@ -10,12 +10,13 @@ module RuboCop
       def assignment_node
         node_parts[0]
       end
+      alias lhs assignment_node
 
       # The name of the variable being assigned as a symbol.
       #
       # @return [Symbol] the name of the variable being assigned
       def name
-        assignment_node.name
+        assignment_node.call_type? ? assignment_node.method_name : assignment_node.name
       end
 
       # The operator being used for assignment as a symbol.
@@ -31,6 +32,7 @@ module RuboCop
       def expression
         node_parts.last
       end
+      alias rhs expression
     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
+
+      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)
+        opening_delimiter = loc.begin if loc.respond_to?(:begin)
+        return false unless opening_delimiter
+
+        if type
+          opening_delimiter.source.match?(PERCENT_LITERAL_TYPES.fetch(type))
+        else
+          opening_delimiter.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

@@ -88,6 +88,34 @@ module RuboCop
       EMPTY_PROPERTIES = {}.freeze
       private_constant :EMPTY_CHILDREN, :EMPTY_PROPERTIES
 
+      # @api private
+      GROUP_FOR_TYPE = {
+        arg: :argument,
+        optarg: :argument,
+        restarg: :argument,
+        kwarg: :argument,
+        kwoptarg: :argument,
+        kwrestarg: :argument,
+        blockarg: :argument,
+        forward_arg: :argument,
+        shardowarg: :argument,
+
+        true: :boolean,
+        false: :boolean,
+
+        int: :numeric,
+        float: :numeric,
+        rational: :numeric,
+        complex: :numeric,
+
+        irange: :range,
+        erange: :range,
+
+        send: :call,
+        csend: :call
+      }.freeze
+      private_constant :GROUP_FOR_TYPE
+
       # Define a +recursive_?+ predicate method for the given node kind.
       private_class_method def self.def_recursive_literal_predicate(kind) # rubocop:disable Metrics/MethodLength
         recursive_kind = "recursive_#{kind}?"
@@ -126,6 +154,16 @@ module RuboCop
         end
       end
 
+      # Determine if the node is one of several node types in a single query
+      # Allows specific single node types, as well as "grouped" types
+      # (e.g. `:boolean` for `:true` or `:false`)
+      def type?(*types)
+        return true if types.include?(type)
+
+        group_type = GROUP_FOR_TYPE[type]
+        !group_type.nil? && types.include?(group_type)
+      end
+
       (Parser::Meta::NODE_TYPES - [:send]).each do |node_type|
         method_name = "#{node_type.to_s.gsub(/\W/, '')}_type?"
         class_eval <<~RUBY, __FILE__, __LINE__ + 1
@@ -312,13 +350,12 @@ module RuboCop
       def_node_matcher :str_content, '(str $_)'
 
       def const_name
-        return unless const_type?
+        return unless const_type? || casgn_type?
 
-        namespace, name = *self
         if namespace && !namespace.cbase_type?
-          "#{namespace.const_name}::#{name}"
+          "#{namespace.const_name}::#{short_name}"
         else
-          name.to_s
+          short_name.to_s
         end
       end
 
@@ -460,11 +497,11 @@ module RuboCop
       end
 
       def parenthesized_call?
-        loc.respond_to?(:begin) && loc.begin&.is?('(')
+        loc_is?(:begin, '(')
       end
 
       def call_type?
-        send_type? || csend_type?
+        GROUP_FOR_TYPE[type] == :call
       end
 
       def chained?
@@ -476,27 +513,38 @@ module RuboCop
       end
 
       def argument_type?
-        ARGUMENT_TYPES.include?(type)
+        GROUP_FOR_TYPE[type] == :argument
       end
 
       def boolean_type?
-        true_type? || false_type?
+        GROUP_FOR_TYPE[type] == :boolean
       end
 
       def numeric_type?
-        int_type? || float_type? || rational_type? || complex_type?
+        GROUP_FOR_TYPE[type] == :numeric
       end
 
       def range_type?
-        irange_type? || erange_type?
+        GROUP_FOR_TYPE[type] == :range
       end
 
       def guard_clause?
-        node = and_type? || or_type? ? rhs : self
+        node = operator_keyword? ? rhs : self
 
         node.match_guard_clause?
       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
+
+        location.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?]

data/lib/rubocop/ast/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.33.0'
+      STRING = '1.37.0'
     end
   end
 end

data/lib/rubocop/ast.rb

@@ -60,6 +60,7 @@ require_relative 'ast/node/in_pattern_node'
 require_relative 'ast/node/index_node'
 require_relative 'ast/node/indexasgn_node'
 require_relative 'ast/node/int_node'
+require_relative 'ast/node/keyword_begin_node'
 require_relative 'ast/node/keyword_splat_node'
 require_relative 'ast/node/lambda_node'
 require_relative 'ast/node/masgn_node'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.37.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -69,6 +69,7 @@ files:
 - lib/rubocop/ast/node/index_node.rb
 - lib/rubocop/ast/node/indexasgn_node.rb
 - lib/rubocop/ast/node/int_node.rb
+- lib/rubocop/ast/node/keyword_begin_node.rb
 - lib/rubocop/ast/node/keyword_splat_node.rb
 - lib/rubocop/ast/node/lambda_node.rb
 - lib/rubocop/ast/node/masgn_node.rb