rubocop 0.49.1 → 0.50.0

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

@@ -9,6 +9,8 @@ module RuboCop
     # A `block` node is essentially a method send with a block. Parser nests
     # the `send` node inside the `block` node.
     class BlockNode < Node
+      VOID_CONTEXT_METHODS = %i[each].freeze
+
       # The `send` node associated with this block.
       #
       # @return [SendNode] the `send` node associated with the `block` node
@@ -95,6 +97,13 @@ module RuboCop
         send_node.method?(:lambda)
       end
 
+      # Checks whether this node body is a void context.
+      #
+      # @return [Boolean] whether the `block` node body is a void context
+      def void_context?
+        VOID_CONTEXT_METHODS.include?(send_node.method_name)
+      end
+
       # Custom destructuring method. This can be used to normalize
       # destructuring for different variations of the node.
       #

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `def` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `def` nodes within RuboCop.
+    class DefNode < Node
+      include ParameterizedNode
+      include MethodIdentifierPredicates
+
+      # Checks whether this node body is a void context.
+      #
+      # @return [Boolean] whether the `def` node body is a void context
+      def void_context?
+        method?(:initialize) || assignment_method?
+      end
+
+      # The name of the defined method as a symbol.
+      #
+      # @return [Symbol] the name of the defined method
+      def method_name
+        node_parts[2]
+      end
+
+      # An array containing the arguments of the method definition.
+      #
+      # @return [Array<Node>] the arguments of the method definition
+      def arguments
+        node_parts[1]
+      end
+
+      # The body of the method definition.
+      #
+      # @note this can be either a `begin` node, if the method body contains
+      #       multiple expressions, or any other node, if it contains a single
+      #       expression.
+      #
+      # @return [Node] the body of the method definition
+      def body
+        node_parts[0]
+      end
+
+      # The receiver of the method definition, if any.
+      #
+      # @return [Node, nil] the receiver of the method definition, or `nil`.
+      def receiver
+        node_parts[3]
+      end
+
+      # Custom destructuring method. This can be used to normalize
+      # destructuring for different variations of the node.
+      #
+      # In this case, the `def` node destructures into:
+      #
+      #   `method_name, arguments, body`
+      #
+      # while the `defs` node destructures into:
+      #
+      #   `receiver, method_name, arguments, body`
+      #
+      # so we reverse the destructured array to get the optional receiver
+      # at the end, where it can be discarded.
+      #
+      # @return [Array] the different parts of the `def` or `defs` node
+      def node_parts
+        to_a.reverse
+      end
+    end
+  end
+end

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

@@ -20,6 +20,14 @@ module RuboCop
         loc.begin && loc.begin.is?('do')
       end
 
+      # Checks whether this node body is a void context.
+      # Always `true` for `for`.
+      #
+      # @return [true] whether the `for` node body is a void context
+      def void_context?
+        true
+      end
+
       # Returns the iteration variable of the `for` loop.
       #
       # @return [Node] The iteration variable of the `for` loop

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

@@ -82,10 +82,10 @@ module RuboCop
         (if? || unless?) && super
       end
 
-      # Chackes whether the `if` node has nested `if` nodes in any of its
+      # Chacks whether the `if` node has nested `if` nodes in any of its
       # branches.
       #
-      # @note This is a shallow search.
+      # @note This performs a shallow search.
       #
       # @return [Boolean] whether the `if` node contains nested conditionals
       def nested_conditional?
@@ -98,6 +98,14 @@ module RuboCop
         false
       end
 
+      # Checks whether the `if` node has at least one `elsif` branch. Returns
+      # true if this `if` node itself is an `elsif`.
+      #
+      # @return [Boolean] whether the `if` node has at least one `elsif` branch
+      def elsif_conditional?
+        else_branch && else_branch.if_type? && else_branch.elsif?
+      end
+
       # Returns the branch of the `if` node that gets evaluated when its
       # condition is truthy.
       #

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A mixin that helps give collection nodes array polymorphism.
+    module CollectionNode
+      extend Forwardable
+
+      ARRAY_METHODS =
+        (Array.instance_methods - Object.instance_methods - [:to_a]).freeze
+
+      def_delegators :to_a, *ARRAY_METHODS
+    end
+  end
+end

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

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # Common functionality for nodes that are a kind of method dispatch:
+    # `send`, `csend`, `super`, `zsuper`, `yield`
+    module MethodDispatchNode
+      extend NodePattern::Macros
+      include MethodIdentifierPredicates
+
+      # The receiving node of the method dispatch.
+      #
+      # @return [Node, nil] the receiver of the dispatched method or `nil`
+      def receiver
+        node_parts[0]
+      end
+
+      # The name of the dispatched method as a symbol.
+      #
+      # @return [Symbol] the name of the dispatched method
+      def method_name
+        node_parts[1]
+      end
+
+      # An array containing the arguments of the dispatched method.
+      #
+      # @return [Array<Node>] the arguments of the dispatched method
+      def arguments
+        node_parts[2..-1]
+      end
+
+      # Checks whether the dispatched method is a macro method. A macro method
+      # is defined as a method that sits in a class, module, or block body and
+      # has an implicit receiver.
+      #
+      # @note This does not include DSLs that use nested blocks, like RSpec
+      #
+      # @return [Boolean] whether the dispatched method is a macro method
+      def macro?
+        !receiver && macro_scope?
+      end
+
+      # Checks whether the dispatched method is a bare access modifier affects
+      # all methods defined after the macro.
+      #
+      # @return [Boolean] whether the dispatched method is access modifier
+      def access_modifier?
+        macro? && bare_access_modifier?
+      end
+
+      # Checks whether the name of the dispatched method matches the argument
+      # and has an implicit receiver.
+      #
+      # @param [Symbol, String] name the method name to check for
+      # @return [Boolean] whether the method name matches the argument
+      def command?(name)
+        !receiver && method?(name)
+      end
+
+      # Checks whether the dispatched method is a setter method.
+      #
+      # @return [Boolean] whether the dispatched method is a setter
+      def setter_method?
+        loc.respond_to?(:operator) && loc.operator
+      end
+
+      # Checks whether the dispatched method uses a dot to connect the
+      # receiver and the method name.
+      #
+      # This is useful for comparison operators, which can be called either
+      # with or without a dot, i.e. `foo == bar` or `foo.== bar`.
+      #
+      # @return [Boolean] whether the method was called with a connecting dot
+      def dot?
+        loc.respond_to?(:dot) && loc.dot && loc.dot.is?('.')
+      end
+
+      # Checks whether the dispatched method uses a double colon to connect the
+      # receiver and the method name.
+      #
+      # @return [Boolean] whether the method was called with a connecting dot
+      def double_colon?
+        loc.respond_to?(:dot) && loc.dot && loc.dot.is?('::')
+      end
+
+      # Checks whether the *explicit* receiver of this method dispatch is
+      # `self`.
+      #
+      # @return [Boolean] whether the receiver of this method dispatch is `self`
+      def self_receiver?
+        receiver && receiver.self_type?
+      end
+
+      # Checks whether the *explicit* receiver of this method dispatch is a
+      # `const` node.
+      #
+      # @return [Boolean] whether the receiver of this method dispatch
+      #                   is a `const` node
+      def const_receiver?
+        receiver && receiver.const_type?
+      end
+
+      # Checks whether the method dispatch is the implicit form of `#call`,
+      # e.g. `foo.(bar)`.
+      #
+      # @return [Boolean] whether the method is the implicit form of `#call`
+      def implicit_call?
+        method?(:call) && !loc.selector
+      end
+
+      # Whether this method dispatch has an explicit block.
+      #
+      # @return [Boolean] whether the dispatched method has a block
+      def block_literal?
+        parent && parent.block_type? && eql?(parent.send_node)
+      end
+
+      # The `block` node associated with this method dispatch, if any.
+      #
+      # @return [BlockNode, nil] the `block` node associated with this method
+      #                          call or `nil`
+      def block_node
+        parent if block_literal?
+      end
+
+      # Checks if this node is part of a chain of `def` modifiers.
+      #
+      # @example
+      #
+      #   private def foo; end
+      #
+      # @return [Boolean] whether the dispatched method is a `def` modifier
+      def def_modifier?
+        send_type? &&
+          [self, *each_descendant(:send)].any?(&:adjacent_def_modifier?)
+      end
+
+      private
+
+      def_node_matcher :macro_scope?, <<-PATTERN
+        {^{({sclass class module block} ...) class_constructor?}
+         ^^{({sclass class module block} ... (begin ...)) class_constructor?}
+         ^#macro_kwbegin_wrapper?
+         #root_node?}
+      PATTERN
+
+      # Check if a node's parent is a kwbegin wrapper within a macro scope
+      #
+      # @param parent [Node] parent of the node being checked
+      #
+      # @return [Boolean] true if the parent is a kwbegin in a macro scope
+      def macro_kwbegin_wrapper?(parent)
+        parent.kwbegin_type? && macro_scope?(parent)
+      end
+
+      # Check if a node does not have a parent
+      #
+      # @param node [Node]
+      #
+      # @return [Boolean] if the parent is nil
+      def root_node?(node)
+        node.parent.nil?
+      end
+
+      def_node_matcher :adjacent_def_modifier?, <<-PATTERN
+        (send nil _ ({def defs} ...))
+      PATTERN
+
+      def_node_matcher :bare_access_modifier?, <<-PATTERN
+        (send nil {:public :protected :private :module_function})
+      PATTERN
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # Common predicates for nodes that reference method identifiers:
+    # `send`, `csend`, `def`, `defs`, `super`, `zsuper`
+    #
+    # @note this mixin expects `#method_name` and `#receiver` to be implemented
+    module MethodIdentifierPredicates
+      ENUMERATOR_METHODS = %i[collect collect_concat detect downto each
+                              find find_all find_index inject loop map!
+                              map reduce reject reject! reverse_each select
+                              select! times upto].freeze
+
+      # Checks whether the method name matches the argument.
+      #
+      # @param [Symbol, String] name the method name to check for
+      # @return [Boolean] whether the method name matches the argument
+      def method?(name)
+        method_name == name.to_sym
+      end
+
+      # Checks whether the method is an operator method.
+      #
+      # @return [Boolean] whether the method is an operator
+      def operator_method?
+        RuboCop::Cop::Util::OPERATOR_METHODS.include?(method_name)
+      end
+
+      # Checks whether the method is a comparison method.
+      #
+      # @return [Boolean] whether the method is a comparison
+      def comparison_method?
+        Node::COMPARISON_OPERATORS.include?(method_name)
+      end
+
+      # Checks whether the method is an assignment method.
+      #
+      # @return [Boolean] whether the method is an assignment
+      def assignment_method?
+        !comparison_method? && method_name.to_s.end_with?('=')
+      end
+
+      # Checks whether the method is an enumerator method.
+      #
+      # @return [Boolean] whether the method is an enumerator
+      def enumerator_method?
+        ENUMERATOR_METHODS.include?(method_name) ||
+          method_name.to_s.start_with?('each_')
+      end
+
+      # Checks whether the method is a predicate method.
+      #
+      # @return [Boolean] whether the method is a predicate method
+      def predicate_method?
+        method_name.to_s.end_with?('?')
+      end
+
+      # Checks whether the method is a bang method.
+      #
+      # @return [Boolean] whether the method is a bang method
+      def bang_method?
+        method_name.to_s.end_with?('!')
+      end
+
+      # Checks whether the method is a camel case method,
+      # e.g. `Integer()`.
+      #
+      # @return [Boolean] whether the method is a camel case method
+      def camel_case_method?
+        method_name.to_s =~ /\A[A-Z]/
+      end
+
+      # Checks whether the *explicit* receiver of this node is `self`.
+      #
+      # @return [Boolean] whether the receiver of this node is `self`
+      def self_receiver?
+        receiver && receiver.self_type?
+      end
+
+      # Checks whether the *explicit* receiver of node is a `const` node.
+      #
+      # @return [Boolean] whether the receiver of this node is a `const` node
+      def const_receiver?
+        receiver && receiver.const_type?
+      end
+    end
+  end
+end

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

@@ -3,71 +3,58 @@
 module RuboCop
   module AST
     # Common functionality for nodes that are parameterized:
-    # `send`, `super`, `zsuper` ...
+    # `send`, `super`, `zsuper`, `def`, `defs`
     module ParameterizedNode
-      # Checks whether this super invocation's arguments are wrapped in
-      # parentheses.
+      # Checks whether this node's arguments are wrapped in parentheses.
       #
-      # @return [Boolean] whether this super invocation's arguments are
+      # @return [Boolean] whether this node's arguments are
       #                   wrapped in parentheses
       def parenthesized?
         loc.end && loc.end.is?(')')
       end
 
-      # A shorthand for getting the first argument of the method invocation.
+      # A shorthand for getting the first argument of the node.
       # Equivalent to `arguments.first`.
       #
-      # @return [Node, nil] the first argument of the method invocation,
+      # @return [Node, nil] the first argument of the node,
       #                     or `nil` if there are no arguments
       def first_argument
         arguments[0]
       end
 
-      # A shorthand for getting the last argument of the method invocation.
+      # A shorthand for getting the last argument of the node.
       # Equivalent to `arguments.last`.
       #
-      # @return [Node, nil] the last argument of the method invocation,
+      # @return [Node, nil] the last argument of the node,
       #                     or `nil` if there are no arguments
       def last_argument
         arguments[-1]
       end
 
-      # Checks whether this method was invoked with arguments.
+      # Checks whether this node has any arguments.
       #
-      # @return [Boolean] whether this method was invoked with arguments
+      # @return [Boolean] whether this node has any arguments
       def arguments?
         !arguments.empty?
       end
 
-      # Checks whether any argument of the method invocation is a splat
+      # Checks whether any argument of the node is a splat
       # argument, i.e. `*splat`.
       #
-      # @return [Boolean] whether the invoked method is a splat argument
+      # @return [Boolean] whether the node is a splat argument
       def splat_argument?
-        arguments? && arguments.any?(&:splat_type?)
+        arguments? &&
+          (arguments.any?(&:splat_type?) || arguments.any?(&:restarg_type?))
       end
+      alias rest_argument? splat_argument?
 
-      # Whether the last argument of the method invocation is a block pass,
+      # Whether the last argument of the node is a block pass,
       # i.e. `&block`.
       #
-      # @return [Boolean] whether the invoked method is a block pass
+      # @return [Boolean] whether the last argument of the node is a block pass
       def block_argument?
-        arguments? && last_argument.block_pass_type?
-      end
-
-      # Whether this method invocation has an explicit block.
-      #
-      # @return [Boolean] whether the invoked method has a block
-      def block_literal?
-        parent && parent.block_type? && eql?(parent.send_node)
-      end
-
-      # The block node associated with this method call, if any.
-      #
-      # @return [BlockNode, nil] the `block` node associated with this method
-      #                          call or `nil`
-      def block_node
-        parent if block_literal?
+        arguments? &&
+          (last_argument.block_pass_type? || last_argument.blockarg_type?)
       end
     end
   end