rubocop-ast 1.24.1 → 1.46.0

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

@@ -2,9 +2,9 @@
 
 module RuboCop
   module AST
-    # A node extension for `kwsplat` nodes. This will be used in place of a
-    # plain  node when the builder constructs the AST, making its methods
-    # available to all `kwsplat` nodes within RuboCop.
+    # A node extension for `kwsplat` and `forwarded_kwrestarg` nodes. This will be used in
+    # place of a plain node when the builder constructs the AST, making its methods available to
+    # all `kwsplat` and `forwarded_kwrestarg` nodes within RuboCop.
     class KeywordSplatNode < Node
       include HashElementNode
 
@@ -41,6 +41,13 @@ module RuboCop
       def node_parts
         [self, self]
       end
+
+      # This provides `forwarded_kwrestarg` node to return true to be compatible with `kwsplat` node.
+      #
+      # @return [true]
+      def kwsplat_type?
+        true
+      end
     end
   end
 end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `masgn` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within RuboCop.
+    class MasgnNode < Node
+      # @return [MlhsNode] the `mlhs` node
+      def lhs
+        # The first child is a `mlhs` node
+        node_parts[0]
+      end
+
+      # @return [Array<Node>] the assignment nodes of the multiple assignment
+      def assignments
+        lhs.assignments
+      end
+
+      # @return [Array<Symbol>] names of all the variables being assigned
+      def names
+        assignments.map do |assignment|
+          if assignment.type?(:send, :indexasgn)
+            assignment.method_name
+          else
+            assignment.name
+          end
+        end
+      end
+
+      # The RHS (right hand side) of the multiple assignment. This returns
+      # the nodes as parsed: either a single node if the RHS has a single value,
+      # or an `array` node containing multiple nodes.
+      #
+      # NOTE: Due to how parsing works, `expression` will return the same for
+      # `a, b = x, y` and `a, b = [x, y]`.
+      #
+      # @return [Node] the right hand side of a multiple assignment.
+      def expression
+        node_parts[1]
+      end
+      alias rhs expression
+
+      # In contrast to `expression`, `values` always returns a Ruby array
+      # containing all the nodes being assigned on the RHS.
+      #
+      # Literal arrays are considered a singular value; but unlike `expression`,
+      # implied `array` nodes from assigning multiple values on the RHS are treated
+      # as separate.
+      #
+      # @return [Array<Node>] individual values being assigned on the RHS of the multiple assignment
+      def values
+        multiple_rhs? ? expression.children : [expression]
+      end
+
+      private
+
+      def multiple_rhs?
+        expression.array_type? && !expression.bracketed?
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     # Common functionality for primitive literal nodes: `sym`, `str`,
-    # `int`, `float`, ...
+    # `int`, `float`, `rational`, `complex`...
     module BasicLiteralNode
       # Returns the value of the literal.
       #

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

@@ -4,7 +4,7 @@ module RuboCop
   module AST
     # A mixin that helps give collection nodes array polymorphism.
     module CollectionNode
-      extend Forwardable
+      extend SimpleForwardable
 
       ARRAY_METHODS =
         (Array.instance_methods - Object.instance_methods - [:to_a]).freeze

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # Common functionality for nodes that deal with constants:
+    # `const`, `casgn`.
+    module ConstantNode
+      # @return [Node, nil] the node associated with the scope (e.g. cbase, const, ...)
+      def namespace
+        children[0]
+      end
+
+      # @return [Symbol] the demodulized name of the constant: "::Foo::Bar" => :Bar
+      def short_name
+        children[1]
+      end
+
+      # @return [Boolean] if the constant is a Module / Class, according to the standard convention.
+      #                   Note: some classes might have uppercase in which case this method
+      #                         returns false
+      def module_name?
+        short_name.match?(/[[:lower:]]/)
+      end
+      alias class_name? module_name?
+
+      # @return [Boolean] if the constant starts with `::` (aka s(:cbase))
+      def absolute?
+        return false unless namespace
+
+        each_path.first.cbase_type?
+      end
+
+      # @return [Boolean] if the constant does not start with `::` (aka s(:cbase))
+      def relative?
+        !absolute?
+      end
+
+      # Yield nodes for the namespace
+      #
+      #   For `::Foo::Bar::BAZ` => yields:
+      #      s(:cbase), then
+      #      s(:const, :Foo), then
+      #      s(:const, s(:const, :Foo), :Bar)
+      def each_path(&block)
+        return to_enum(__method__) unless block
+
+        descendants = []
+        last = self
+        loop do
+          last = last.children.first
+          break if last.nil?
+
+          descendants << last
+          break unless last.const_type?
+        end
+        descendants.reverse_each(&block)
+
+        self
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module RuboCop
     # Common functionality for nodes that are a kind of method dispatch:
     # `send`, `csend`, `super`, `zsuper`, `yield`, `defined?`,
     # and (modern only): `index`, `indexasgn`, `lambda`
-    module MethodDispatchNode
+    module MethodDispatchNode # rubocop:disable Metrics/ModuleLength
       extend NodePattern::Macros
       include MethodIdentifierPredicates
 
@@ -28,10 +28,21 @@ module RuboCop
         node_parts[1]
       end
 
-      # The `block` or `numblock` node associated with this method dispatch, if any.
+      # The source range for the method name or keyword that dispatches this call.
       #
-      # @return [BlockNode, nil] the `block` or `numblock` node associated with this method
-      #                          call or `nil`
+      # @return [Parser::Source::Range] the source range for the method name or keyword
+      def selector
+        if loc.respond_to? :keyword
+          loc.keyword
+        else
+          loc.selector
+        end
+      end
+
+      # The `block`, `numblock`, or `itblock` node associated with this method dispatch, if any.
+      #
+      # @return [BlockNode, nil] the `block`, `numblock`, or `itblock` node associated with this
+      #                          method call or `nil`
       def block_node
         parent if block_literal?
       end
@@ -94,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?
 
@@ -106,7 +117,7 @@ module RuboCop
       #
       # @return [Boolean] whether the method was called with a connecting dot
       def dot?
-        loc.respond_to?(:dot) && loc.dot && loc.dot.is?('.')
+        loc_is?(:dot, '.')
       end
 
       # Checks whether the dispatched method uses a double colon to connect the
@@ -114,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 && loc.dot.is?('::')
+        loc_is?(:dot, '::')
       end
 
       # Checks whether the dispatched method uses a safe navigation operator to
@@ -122,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 && loc.dot.is?('&.')
+        loc_is?(:dot, '&.')
       end
 
       # Checks whether the *explicit* receiver of this method dispatch is
@@ -147,14 +158,14 @@ module RuboCop
       #
       # @return [Boolean] whether the method is the implicit form of `#call`
       def implicit_call?
-        method?(:call) && !loc.selector
+        method?(:call) && !selector
       end
 
       # Whether this method dispatch has an explicit block.
       #
       # @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
@@ -189,8 +200,7 @@ module RuboCop
         arg = node.children[2]
 
         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.any_def_type?
 
         def_modifier(arg)
       end
@@ -222,9 +232,9 @@ module RuboCop
       #
       # @return [Boolean] whether this method is a unary operation
       def unary_operation?
-        return false unless loc.selector
+        return false unless selector
 
-        operator_method? && loc.expression.begin_pos == loc.selector.begin_pos
+        operator_method? && loc.expression.begin_pos == selector.begin_pos
       end
 
       # Checks whether this is a binary operation.
@@ -235,9 +245,9 @@ module RuboCop
       #
       # @return [Boolean] whether this method is a binary operation
       def binary_operation?
-        return false unless loc.selector
+        return false unless selector
 
-        operator_method? && loc.expression.begin_pos != loc.selector.begin_pos
+        operator_method? && loc.expression.begin_pos != selector.begin_pos
       end
 
       private
@@ -249,7 +259,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
@@ -260,7 +270,7 @@ module RuboCop
 
       # @!method adjacent_def_modifier?(node = self)
       def_node_matcher :adjacent_def_modifier?, <<~PATTERN
-        (send nil? _ ({def defs} ...))
+        (send nil? _ (any_def ...))
       PATTERN
 
       # @!method bare_access_modifier_declaration?(node = self)
@@ -270,7 +280,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/numeric_node.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module AST
-    # Common functionality for primitive numeric nodes: `int`, `float`, ...
+    # Common functionality for primitive numeric nodes: `int`, `float`, `rational`, `complex`...
     module NumericNode
       SIGN_REGEX = /\A[+-]/.freeze
       private_constant :SIGN_REGEX
@@ -15,7 +15,7 @@ module RuboCop
       #
       # @return [Boolean] whether this literal has a sign.
       def sign?
-        source.match(SIGN_REGEX)
+        source.match?(SIGN_REGEX)
       end
     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.
@@ -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/mlhs_node.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `mlhs` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within 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], ... =`,
+      # 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?
+            # Anonymous splats have no children
+            node.child_nodes.first || node
+          elsif node.mlhs_type?
+            node.assignments
+          else
+            node
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `rational` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available to
+    # all `rational` nodes within RuboCop.
+    class RationalNode < Node
+      include BasicLiteralNode
+      include NumericNode
+    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 && 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/var_node.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `lvar`, `ivar`, `cvar` and `gvar` nodes.
+    # This will be used in place of a plain node when the builder constructs
+    # the AST, making its methods available to all assignment nodes within RuboCop.
+    class VarNode < Node
+      # @return [Symbol] The name of the variable.
+      def name
+        node_parts[0]
+      end
+    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