rubocop-ast 1.30.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84c917625cddd9b79c0979e269fdd324f8119b9d2b3c6081fae0ef449669bea5
-  data.tar.gz: 8d053cac9c670216326df54b5b7b6a8961bf89614defa16e93ad1c557a8b25a5
+  metadata.gz: 71290c5f117f13043b681f7ce182d115284b84675bbfc0bf35448152ebfb42bd
+  data.tar.gz: 3c13a0e8e089409da5dd353bfea60c3981f56dac094f7a650690f3862bdf3e36
 SHA512:
-  metadata.gz: c95bd42a576592153d70f61367aafacd9677021515534a487706b736cc02cfcf717fc6db39e3df7212088301383cb7d60af9b929b4ca65b7baa5a66f5eca059e
-  data.tar.gz: f0d99d3695e651ec10709dd729696a2b137c3b11603598164b433f61583218b16807c44ea1637ebe1922b496b8472795e4d54a4dc1312908f049e6f43b242ff8
+  metadata.gz: '08c425d33229f9116b91905ef14ea762ad2d17603ae581795d3101526a51ee6a4c8e1ab2e508f2355b688e4143f668e71767f8283934ee3b27f045315add0a28'
+  data.tar.gz: 58173b8980810073f670c9087905923661d8a3fe0a43c17b354388ee07728611a6c5d1a690a2813184a6d4286c29c090d11d4f28de001ae395bfb774c53720bc

data/README.md

@@ -1,7 +1,7 @@
 # RuboCop AST
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-ast.svg)](https://badge.fury.io/rb/rubocop-ast)
-[![CI](https://github.com/rubocop/rubocop-ast/workflows/CI/badge.svg)](https://github.com/rubocop/rubocop-ast/actions?query=workflow%3ACI)
+[![CI](https://github.com/rubocop/rubocop-ast/actions/workflows/rubocop.yml/badge.svg)](https://github.com/rubocop/rubocop-ast/actions/workflows/rubocop.yml)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a29666e6373bc41bc0a9/test_coverage)](https://codeclimate.com/github/rubocop/rubocop-ast/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a29666e6373bc41bc0a9/maintainability)](https://codeclimate.com/github/rubocop/rubocop-ast/maintainability)
 

data/lib/rubocop/ast/builder.rb

@@ -63,8 +63,11 @@ module RuboCop
         irange:              RangeNode,
         erange:              RangeNode,
         kwargs:              HashNode,
+        kwbegin:             KeywordBeginNode,
         kwsplat:             KeywordSplatNode,
         lambda:              LambdaNode,
+        masgn:               MasgnNode,
+        mlhs:                MlhsNode,
         module:              ModuleNode,
         next:                NextNode,
         op_asgn:             OpAsgnNode,
@@ -72,6 +75,7 @@ module RuboCop
         or:                  OrNode,
         pair:                PairNode,
         procarg0:            Procarg0Node,
+        rational:            RationalNode,
         regexp:              RegexpNode,
         rescue:              RescueNode,
         resbody:             ResbodyNode,
@@ -86,6 +90,10 @@ module RuboCop
         sym:                 SymbolNode,
         until:               UntilNode,
         until_post:          UntilNode,
+        lvar:                VarNode,
+        ivar:                VarNode,
+        cvar:                VarNode,
+        gvar:                VarNode,
         when:                WhenNode,
         while:               WhileNode,
         while_post:          WhileNode,

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

@@ -17,7 +17,11 @@ module RuboCop
       # @return [Array<Node>] an array of value nodes
       alias values children
 
-      # @deprecated Use `values.each` (a.k.a. `children.each`)
+      # Calls the given block for each `value` node in the `array` literal.
+      # If no block is given, an `Enumerator` is returned.
+      #
+      # @return [self] if a block is given
+      # @return [Enumerator] if no block is given
       def each_value(&block)
         return to_enum(__method__) unless block
 
@@ -30,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/block_node.rb

@@ -90,14 +90,14 @@ module RuboCop
       #
       # @return [Boolean] whether the `block` literal is enclosed in braces
       def braces?
-        loc.end&.is?('}')
+        loc.end.is?('}')
       end
 
       # Checks whether the `block` literal is delimited by `do`-`end` keywords.
       #
       # @return [Boolean] whether the `block` literal is enclosed in `do`-`end`
       def keywords?
-        loc.end&.is?('end')
+        loc.end.is?('end')
       end
 
       # The delimiters for this `block` literal.

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

@@ -6,19 +6,10 @@ module RuboCop
     # 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 CasgnNode < Node
-      # The namespace of the constant being assigned.
-      #
-      # @return [Node, nil] the node associated with the scope (e.g. cbase, const, ...)
-      def namespace
-        node_parts[0]
-      end
+      include ConstantNode
 
-      # The name of the variable being assigned as a symbol.
-      #
-      # @return [Symbol] the name of the variable being assigned
-      def name
-        node_parts[1]
-      end
+      alias name short_name
+      alias lhs short_name
 
       # The expression being assigned to the variable.
       #
@@ -26,6 +17,7 @@ module RuboCop
       def expression
         node_parts[2]
       end
+      alias rhs expression
     end
   end
 end

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

@@ -4,58 +4,7 @@ module RuboCop
   module AST
     # A node extension for `const` nodes.
     class ConstNode < Node
-      # @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
+      include ConstantNode
     end
   end
 end

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

@@ -13,7 +13,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `def` node body is a void context
       def void_context?
-        method?(:initialize) || assignment_method?
+        (def_type? && method?(:initialize)) || assignment_method?
       end
 
       # Checks whether this method definition node forwards its arguments

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

@@ -9,9 +9,32 @@ 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`.
+      #
+      # @return [true] whether the `ensure` node body is a void context
+      def void_context?
+        true
+      end
     end
   end
 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.
       #
@@ -102,7 +109,7 @@ module RuboCop
       #
       # @return [Boolean] whether the `if` node has at least one `elsif` branch
       def elsif_conditional?
-        else_branch&.if_type? && else_branch&.elsif?
+        else_branch&.if_type? && else_branch.elsif?
       end
 
       # Returns the branch of the `if` node that gets evaluated when its

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/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.send_type? || assignment.indexasgn_type?
+            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`...
     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/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 && 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 && 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 && 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/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`...
     module NumericNode
       SIGN_REGEX = /\A[+-]/.freeze
       private_constant :SIGN_REGEX

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

@@ -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
+
+      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)
+        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