rubbycop 0.49.0

data/lib/rubbycop/ast/node/keyword_splat_node.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  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 RubbyCop.
+    class KeywordSplatNode < Node
+      include HashElementNode
+
+      DOUBLE_SPLAT = '**'.freeze
+
+      # This is used for duck typing with `pair` nodes which also appear as
+      # `hash` elements.
+      #
+      # @return [false]
+      def hash_rocket?
+        false
+      end
+
+      # This is used for duck typing with `pair` nodes which also appear as
+      # `hash` elements.
+      #
+      # @return [false]
+      def colon?
+        false
+      end
+
+      # Returns the operator for the `kwsplat` as a string.
+      #
+      # @return [String] the double splat operator
+      def operator
+        DOUBLE_SPLAT
+      end
+
+      # Custom destructuring method. This is used to normalize the branches
+      # for `pair` and `kwsplat` nodes, to add duck typing to `hash` elements.
+      #
+      # @return [Array<KeywordSplatNode>] the different parts of the `kwsplat`
+      def node_parts
+        [self, self]
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/mixin/binary_operator_node.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # Common functionality for nodes that are binary operations:
+    # `or`, `and` ...
+    module BinaryOperatorNode
+      # Returns the left hand side node of the binary operation.
+      #
+      # @return [Node] the left hand side of the binary operation
+      def lhs
+        node_parts[0]
+      end
+
+      # Returns the right hand side node of the binary operation.
+      #
+      # @return [Node] the right hand side of the binary operation
+      def rhs
+        node_parts[1]
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/mixin/conditional_node.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # Common functionality for nodes that have conditions:
+    # `if`, `while`, `until`, `case`.
+    # This currently doesn't include `when` nodes, because they have multiple
+    # conditions, and need to be checked for that.
+    module ConditionalNode
+      # Checks whether the condition of the node is written on a single line.
+      #
+      # @return [Boolean] whether the condition is on a single line
+      def single_line_condition?
+        loc.keyword.line == condition.source_range.line
+      end
+
+      # Checks whether the condition of the node is written on more than
+      # one line.
+      #
+      # @return [Boolean] whether the condition is on more than one line
+      def multiline_condition?
+        !single_line_condition?
+      end
+
+      # Returns the condition of the node. This works together with each node's
+      # custom destructuring method to select the correct part of the node.
+      #
+      # @return [Node, nil] the condition of the node
+      def condition
+        node_parts[0]
+      end
+
+      # Returns the body associated with the condition. This works together with
+      # each node's custom destructuring method to select the correct part of
+      # the node.
+      #
+      # @note For `if` nodes, this is the truthy branch.
+      #
+      # @return [Node, nil] the body of the node
+      def body
+        node_parts[1]
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/mixin/hash_element_node.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # Common functionality for nodes that can be used as hash elements:
+    # `pair`, `kwsplat`
+    module HashElementNode
+      # Returns the key of this `hash` element.
+      #
+      # @note For keyword splats, this returns the whole node
+      #
+      # @return [Node] the key of the hash element
+      def key
+        node_parts[0]
+      end
+
+      # Returns the value of this `hash` element.
+      #
+      # @note For keyword splats, this returns the whole node
+      #
+      # @return [Node] the value of the hash element
+      def value
+        node_parts[1]
+      end
+
+      # Checks whether this `hash` element is on the same line as `other`.
+      #
+      # @note A multiline element is considered to be on the same line if it
+      #       shares any of its lines with `other`
+      #
+      # @return [Boolean] whether this element is on the same line as `other`
+      def same_line?(other)
+        loc.last_line == other.loc.line || loc.line == other.loc.last_line
+      end
+
+      # Returns the delta between this pair's key and the argument pair's.
+      #
+      # @note Keys on the same line always return a delta of 0
+      # @note Keyword splats always return a delta of 0 for right alignment
+      #
+      # @param [Symbol] alignment whether to check the left or right side
+      # @return [Integer] the delta between the two keys
+      def key_delta(other, alignment = :left)
+        HashElementDelta.new(self, other).key_delta(alignment)
+      end
+
+      # Returns the delta between this element's value and the argument's.
+      #
+      # @note Keyword splats always return a delta of 0
+      #
+      # @return [Integer] the delta between the two values
+      def value_delta(other)
+        HashElementDelta.new(self, other).value_delta
+      end
+
+      # Returns the delta between this element's delimiter and the argument's.
+      #
+      # @note Pairs with different delimiter styles return a delta of 0
+      #
+      # @return [Integer] the delta between the two delimiters
+      def delimiter_delta(other)
+        HashElementDelta.new(self, other).delimiter_delta
+      end
+
+      # A helper class for comparing the positions of different parts of a
+      # `pair` node.
+      class HashElementDelta
+        def initialize(first, second)
+          @first = first
+          @second = second
+
+          raise ArgumentError unless valid_argument_types?
+        end
+
+        def key_delta(alignment = :left)
+          return 0 if first.same_line?(second)
+          return 0 if keyword_splat? && alignment == :right
+
+          delta(first.key.loc, second.key.loc, alignment)
+        end
+
+        def value_delta
+          return 0 if first.same_line?(second)
+          return 0 if keyword_splat?
+
+          delta(first.value.loc, second.value.loc)
+        end
+
+        def delimiter_delta
+          return 0 if first.same_line?(second)
+          return 0 if first.delimiter != second.delimiter
+
+          delta(first.loc.operator, second.loc.operator)
+        end
+
+        private
+
+        attr_reader :first, :second
+
+        def valid_argument_types?
+          [first, second].all? do |argument|
+            argument.pair_type? || argument.kwsplat_type?
+          end
+        end
+
+        def delta(first, second, alignment = :left)
+          case alignment
+          when :left
+            first.column - second.column
+          when :right
+            first.last_column - second.last_column
+          else
+            0
+          end
+        end
+
+        def keyword_splat?
+          [first, second].any?(&:kwsplat_type?)
+        end
+      end
+
+      private_constant :HashElementDelta
+    end
+  end
+end

data/lib/rubbycop/ast/node/mixin/modifier_node.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # Common functionality for nodes that can be used as modifiers:
+    # `if`, `while`, `until`
+    module ModifierNode
+      # Checks whether the node is in a modifier form, i.e. a condition
+      # trailing behind an expression.
+      #
+      # @return [Boolean] whether the node is a modifier
+      def modifier_form?
+        loc.end.nil?
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/mixin/predicate_operator_node.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # Common functionality for nodes that are predicates:
+    # `or`, `and` ...
+    module PredicateOperatorNode
+      LOGICAL_AND  = '&&'.freeze
+      SEMANTIC_AND = 'and'.freeze
+      LOGICAL_OR   = '||'.freeze
+      SEMANTIC_OR  = 'or'.freeze
+
+      # Returns the operator as a string.
+      #
+      # @return [String] the operator
+      def operator
+        loc.operator.source
+      end
+
+      # Checks whether this is a logical operator.
+      #
+      # @return [Boolean] whether this is a logical operator
+      def logical_operator?
+        operator == LOGICAL_AND || operator == LOGICAL_OR
+      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
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/or_node.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # A node extension for `or` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `or` nodes within RubbyCop.
+    class OrNode < Node
+      include BinaryOperatorNode
+      include PredicateOperatorNode
+
+      # Returns the alternate operator of the `or` as a string.
+      # Returns `or` for `||` and vice versa.
+      #
+      # @return [String] the alternate of the `or` operator
+      def alternate_operator
+        logical_operator? ? SEMANTIC_OR : LOGICAL_OR
+      end
+
+      # Returns the inverse keyword of the `or` node as a string.
+      # Returns `and` for `or` and `&&` for `||`.
+      #
+      # @return [String] the inverse of the `or` operator
+      def inverse_operator
+        logical_operator? ? LOGICAL_AND : SEMANTIC_AND
+      end
+
+      # Custom destructuring method. This can be used to normalize
+      # destructuring for different variations of the node.
+      #
+      # @return [Array<Node>] the different parts of the `or` predicate
+      def node_parts
+        to_a
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/pair_node.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # A node extension for `pair` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `pair` nodes within RubbyCop.
+    class PairNode < Node
+      include HashElementNode
+
+      HASH_ROCKET = '=>'.freeze
+      SPACED_HASH_ROCKET = ' => '.freeze
+      COLON = ':'.freeze
+      SPACED_COLON = ': '.freeze
+
+      # Checks whether the `pair` uses a hash rocket delimiter.
+      #
+      # @return [Boolean] whether this `pair` uses a hash rocket delimiter
+      def hash_rocket?
+        loc.operator.is?(HASH_ROCKET)
+      end
+
+      # Checks whether the `pair` uses a colon delimiter.
+      #
+      # @return [Boolean] whether this `pair` uses a colon delimiter
+      def colon?
+        loc.operator.is?(COLON)
+      end
+
+      # Returns the delimiter of the `pair` as a string. Returns `=>` for a
+      # colon delimited `pair`, and `:` for a hash rocket delimited `pair`.
+      #
+      # @param [Boolean] with_spacing whether to include spacing
+      # @return [String] the delimiter of the `pair`
+      def delimiter(with_spacing = false)
+        if with_spacing
+          hash_rocket? ? SPACED_HASH_ROCKET : SPACED_COLON
+        else
+          hash_rocket? ? HASH_ROCKET : COLON
+        end
+      end
+
+      # Returns the inverse delimiter of the `pair` as a string.
+      #
+      # @param [Boolean] with_spacing whether to include spacing
+      # @return [String] the inverse delimiter of the `pair`
+      def inverse_delimiter(with_spacing = false)
+        if with_spacing
+          hash_rocket? ? SPACED_COLON : SPACED_HASH_ROCKET
+        else
+          hash_rocket? ? COLON : HASH_ROCKET
+        end
+      end
+
+      # Custom destructuring method. This is used to normalize the branches
+      # for `pair` and `kwsplat` nodes, to add duck typing to `hash` elements.
+      #
+      # @return [Array<Node>] the different parts of the `pair`
+      def node_parts
+        to_a
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/resbody_node.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # A node extension for `resbody` nodes. This will be used in place of a
+    # plain node when the builder constructs the AST, making its methods
+    # available to all `resbody` nodes within RubbyCop.
+    class ResbodyNode < Node
+      # Returns the body of the `rescue` clause.
+      #
+      # @return [Node, nil] The body of the `resbody`.
+      def body
+        node_parts[2]
+      end
+
+      # Custom destructuring method. This can be used to normalize
+      # destructuring for different variations of the node.
+      #
+      # @return [Array<Node>] the different parts of the `resbody` statement
+      def node_parts
+        to_a
+      end
+    end
+  end
+end

data/lib/rubbycop/ast/node/send_node.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module AST
+    # A node extension for `send` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `send` nodes within RubbyCop.
+    class SendNode < Node
+      # The receiving node of the method invocation.
+      #
+      # @return [Node, nil] the receiver of the invoked method or `nil`
+      def receiver
+        node_parts[0]
+      end
+
+      # The name of the invoked method called as a string.
+      #
+      # @return [Symbol] the name of the invoked method
+      def method_name
+        node_parts[1]
+      end
+
+      # 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 a macro method. A macro method is defined
+      # as a method that sits in a class- or module body and has an implicit
+      # receiver.
+      #
+      # @note This does not include DSLs that use nested blocks, like RSpec
+      #
+      # @return [Boolean] whether the method is a macro method
+      def macro?
+        !receiver && macro_scope?
+      end
+
+      # Checks whether the method name 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
+
+      # An array containing the arguments of the method invocation.
+      #
+      # @return [Array<Node>] the arguments of the method invocation or `nil`
+      def arguments
+        node_parts[2..-1]
+      end
+
+      # A shorthand for getting the first argument of the method invocation.
+      # Equivalent to `arguments.first`.
+      #
+      # @return [Node, nil] the first argument of the method invocation,
+      #                     or `nil` if there are no arguments
+      def first_argument
+        arguments[0]
+      end
+
+      # A shorthand for getting the last argument of the method invocation.
+      # Equivalent to `arguments.last`.
+      #
+      # @return [Node, nil] the last argument of the method invocation,
+      #                     or `nil` if there are no arguments
+      def last_argument
+        arguments[-1]
+      end
+
+      # Checks whether this method was invoked with arguments.
+      #
+      # @return [Boolean] whether this method was invoked with arguments
+      def arguments?
+        !arguments.empty?
+      end
+
+      # Checks whether this method invocation's arguments are wrapped in
+      # parentheses.
+      #
+      # @return [Boolean] whether this method invocation's arguments are
+      #                   wrapped in parentheses
+      def parenthesized?
+        loc.end && loc.end.is?(')')
+      end
+
+      # Checks whether the invoked method is a setter method.
+      #
+      # @return [Boolean] whether the invoked method is a setter
+      def setter_method?
+        loc.operator
+      end
+
+      # Checks whether the invoked method is an operator method.
+      #
+      # @return [Boolean] whether the invoked method is an operator
+      def operator_method?
+        RubbyCop::Cop::Util::OPERATOR_METHODS.include?(method_name)
+      end
+
+      # Checks whether the invoked method is a comparison method.
+      #
+      # @return [Boolean] whether the involed method is a comparison
+      def comparison_method?
+        COMPARISON_OPERATORS.include?(method_name)
+      end
+
+      # Checks whether the invoked method is an assignment method.
+      #
+      # @return [Boolean] whether the invoked method is an assignment.
+      def assignment_method?
+        !comparison_method? && method_name.to_s.end_with?('=')
+      end
+
+      # Checks whether the method call 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.dot && loc.dot.is?('.')
+      end
+
+      # Checks whether the method call 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.dot && loc.dot.is?('::')
+      end
+
+      # Checks whether the receiver of this method invocation is `self`.
+      #
+      # @return [Boolean] whether the receiver of this method invocation
+      #                   is `self`
+      def self_receiver?
+        receiver && receiver.self_type?
+      end
+
+      # Checks whether the method call is of the implicit form of `#call`,
+      # e.g. `foo.(bar)`.
+      #
+      # @return [Boolean] whether the method is an implicit form of `#call`
+      def implicit_call?
+        method_name == :call && !loc.selector
+      end
+
+      # Checks whether the invoked method is a predicate method.
+      #
+      # @return [Boolean] whether the invoked method is a predicate method
+      def predicate_method?
+        method_name.to_s.end_with?('?')
+      end
+
+      # Checks whether the invoked method is a bang method.
+      #
+      # @return [Boolean] whether the invoked method is a bang method
+      def bang_method?
+        method_name.to_s.end_with?('!')
+      end
+
+      # Checks whether the invoked method is a camel case method,
+      # e.g. `Integer()`.
+      #
+      # @return [Boolean] whether the invoked method is a camel case method
+      def camel_case_method?
+        method_name.to_s =~ /\A[A-Z]/
+      end
+
+      # Whether the last argument of the method invocation is a block pass,
+      # i.e. `&block`.
+      #
+      # @return [Boolean] whether the invoked method is a block pass
+      def block_argument?
+        arguments? && last_argument.block_pass_type?
+      end
+
+      # Checks whether any argument of the method invocation is a splat
+      # argument, i.e. `*splat`.
+      #
+      # @return [Boolean] whether the invoked method is a splat argument
+      def splat_argument?
+        arguments? && arguments.any?(&:splat_type?)
+      end
+
+      # Custom destructuring method. This can be used to normalize
+      # destructuring for different variations of the node.
+      #
+      # @return [Array] the different parts of the `send` node
+      def node_parts
+        to_a
+      end
+
+      private
+
+      def_matcher :macro_scope?, <<-PATTERN
+        {^({class module} ...)
+         ^^({class module} ... (begin ...))}
+      PATTERN
+    end
+  end
+end