plaid 14.7.0 → 14.8.0

data/vendor/bundle/ruby/2.6.0/gems/rubocop-ast-0.4.2/lib/rubocop/ast/node.rb

@@ -1,708 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module AST
-    # `RuboCop::AST::Node` is a subclass of `Parser::AST::Node`. It provides
-    # access to parent nodes and an object-oriented way to traverse an AST with
-    # the power of `Enumerable`.
-    #
-    # It has predicate methods for every node type, like this:
-    #
-    # @example
-    #   node.send_type?    # Equivalent to: `node.type == :send`
-    #   node.op_asgn_type? # Equivalent to: `node.type == :op_asgn`
-    #
-    #   # Non-word characters (other than a-zA-Z0-9_) in type names are omitted.
-    #   node.defined_type? # Equivalent to: `node.type == :defined?`
-    #
-    #   # Find the first lvar node under the receiver node.
-    #   lvar_node = node.each_descendant.find(&:lvar_type?)
-    #
-    class Node < Parser::AST::Node # rubocop:disable Metrics/ClassLength
-      include RuboCop::AST::Sexp
-      extend NodePattern::Macros
-
-      # <=> isn't included here, because it doesn't return a boolean.
-      COMPARISON_OPERATORS = %i[== === != <= >= > <].freeze
-
-      TRUTHY_LITERALS = %i[str dstr xstr int float sym dsym array
-                           hash regexp true irange erange complex
-                           rational regopt].freeze
-      FALSEY_LITERALS = %i[false nil].freeze
-      LITERALS = (TRUTHY_LITERALS + FALSEY_LITERALS).freeze
-      COMPOSITE_LITERALS = %i[dstr xstr dsym array hash irange
-                              erange regexp].freeze
-      BASIC_LITERALS = (LITERALS - COMPOSITE_LITERALS).freeze
-      MUTABLE_LITERALS = %i[str dstr xstr array hash
-                            regexp irange erange].freeze
-      IMMUTABLE_LITERALS = (LITERALS - MUTABLE_LITERALS).freeze
-
-      EQUALS_ASSIGNMENTS = %i[lvasgn ivasgn cvasgn gvasgn
-                              casgn masgn rasgn mrasgn].freeze
-      SHORTHAND_ASSIGNMENTS = %i[op_asgn or_asgn and_asgn].freeze
-      ASSIGNMENTS = (EQUALS_ASSIGNMENTS + SHORTHAND_ASSIGNMENTS).freeze
-
-      BASIC_CONDITIONALS = %i[if while until].freeze
-      CONDITIONALS = [*BASIC_CONDITIONALS, :case].freeze
-      POST_CONDITION_LOOP_TYPES = %i[while_post until_post].freeze
-      LOOP_TYPES = (POST_CONDITION_LOOP_TYPES + %i[while until for]).freeze
-      VARIABLES = %i[ivar gvar cvar lvar].freeze
-      REFERENCES = %i[nth_ref back_ref].freeze
-      KEYWORDS = %i[alias and break case class def defs defined?
-                    kwbegin do else ensure for if module next
-                    not or postexe redo rescue retry return self
-                    super zsuper then undef until when while
-                    yield].freeze
-      OPERATOR_KEYWORDS = %i[and or].freeze
-      SPECIAL_KEYWORDS = %w[__FILE__ __LINE__ __ENCODING__].freeze
-      ARGUMENT_TYPES = %i[arg optarg restarg kwarg kwoptarg kwrestarg blockarg].freeze
-
-      # @see https://www.rubydoc.info/gems/ast/AST/Node:initialize
-      def initialize(type, children = [], properties = {})
-        @mutable_attributes = {}
-
-        # ::AST::Node#initialize freezes itself.
-        super
-
-        # #parent= may be invoked multiple times for a node because there are
-        # pending nodes while constructing AST and they are replaced later.
-        # For example, `lvar` and `send` type nodes are initially created as an
-        # `ident` type node and fixed to the appropriate type later.
-        # So, the #parent attribute needs to be mutable.
-        each_child_node do |child_node|
-          child_node.parent = self unless child_node.complete?
-        end
-      end
-
-      Parser::Meta::NODE_TYPES.each do |node_type|
-        method_name = "#{node_type.to_s.gsub(/\W/, '')}_type?"
-        define_method(method_name) do
-          type == node_type
-        end
-      end
-
-      # Returns the parent node, or `nil` if the receiver is a root node.
-      #
-      # @return [Node, nil] the parent node or `nil`
-      def parent
-        @mutable_attributes[:parent]
-      end
-
-      def parent=(node)
-        @mutable_attributes[:parent] = node
-      end
-
-      def complete!
-        @mutable_attributes.freeze
-        each_child_node(&:complete!)
-      end
-
-      def complete?
-        @mutable_attributes.frozen?
-      end
-
-      protected :parent=
-
-      # Override `AST::Node#updated` so that `AST::Processor` does not try to
-      # mutate our ASTs. Since we keep references from children to parents and
-      # not just the other way around, we cannot update an AST and share
-      # identical subtrees. Rather, the entire AST must be copied any time any
-      # part of it is changed.
-      def updated(type = nil, children = nil, properties = {})
-        properties[:location] ||= @location
-        klass = RuboCop::AST::Builder::NODE_MAP[type || @type] || Node
-        klass.new(type || @type, children || @children, properties)
-      end
-
-      # Returns the index of the receiver node in its siblings. (Sibling index
-      # uses zero based numbering.)
-      # Use is discouraged, this is a potentially slow method.
-      #
-      # @return [Integer, nil] the index of the receiver node in its siblings
-      def sibling_index
-        parent&.children&.index { |sibling| sibling.equal?(self) }
-      end
-
-      # Use is discouraged, this is a potentially slow method and can lead
-      # to even slower algorithms
-      # @return [Node, nil] the right (aka next) sibling
-      def right_sibling
-        return unless parent
-
-        parent.children[sibling_index + 1].freeze
-      end
-
-      # Use is discouraged, this is a potentially slow method and can lead
-      # to even slower algorithms
-      # @return [Node, nil] the left (aka previous) sibling
-      def left_sibling
-        i = sibling_index
-        return if i.nil? || i.zero?
-
-        parent.children[i - 1].freeze
-      end
-
-      # Use is discouraged, this is a potentially slow method and can lead
-      # to even slower algorithms
-      # @return [Array<Node>] the left (aka previous) siblings
-      def left_siblings
-        return [].freeze unless parent
-
-        parent.children[0...sibling_index].freeze
-      end
-
-      # Use is discouraged, this is a potentially slow method and can lead
-      # to even slower algorithms
-      # @return [Array<Node>] the right (aka next) siblings
-      def right_siblings
-        return [].freeze unless parent
-
-        parent.children[sibling_index + 1..-1].freeze
-      end
-
-      # Common destructuring method. This can be used to normalize
-      # destructuring for different variations of the node.
-      # Some node types override this with their own custom
-      # destructuring method.
-      #
-      # @return [Array<Node>] the different parts of the ndde
-      def node_parts
-        to_a
-      end
-
-      # Calls the given block for each ancestor node from parent to root.
-      # If no block is given, an `Enumerator` is returned.
-      #
-      # @overload each_ancestor
-      #   Yield all nodes.
-      # @overload each_ancestor(type)
-      #   Yield only nodes matching the type.
-      #   @param [Symbol] type a node type
-      # @overload each_ancestor(type_a, type_b, ...)
-      #   Yield only nodes matching any of the types.
-      #   @param [Symbol] type_a a node type
-      #   @param [Symbol] type_b a node type
-      # @yieldparam [Node] node each ancestor node
-      # @return [self] if a block is given
-      # @return [Enumerator] if no block is given
-      def each_ancestor(*types, &block)
-        return to_enum(__method__, *types) unless block_given?
-
-        visit_ancestors(types, &block)
-
-        self
-      end
-
-      # Returns an array of ancestor nodes.
-      # This is a shorthand for `node.each_ancestor.to_a`.
-      #
-      # @return [Array<Node>] an array of ancestor nodes
-      def ancestors
-        each_ancestor.to_a
-      end
-
-      # Calls the given block for each child node.
-      # If no block is given, an `Enumerator` is returned.
-      #
-      # Note that this is different from `node.children.each { |child| ... }`
-      # which yields all children including non-node elements.
-      #
-      # @overload each_child_node
-      #   Yield all nodes.
-      # @overload each_child_node(type)
-      #   Yield only nodes matching the type.
-      #   @param [Symbol] type a node type
-      # @overload each_child_node(type_a, type_b, ...)
-      #   Yield only nodes matching any of the types.
-      #   @param [Symbol] type_a a node type
-      #   @param [Symbol] type_b a node type
-      # @yieldparam [Node] node each child node
-      # @return [self] if a block is given
-      # @return [Enumerator] if no block is given
-      def each_child_node(*types)
-        return to_enum(__method__, *types) unless block_given?
-
-        children.each do |child|
-          next unless child.is_a?(Node)
-
-          yield child if types.empty? || types.include?(child.type)
-        end
-
-        self
-      end
-
-      # Returns an array of child nodes.
-      # This is a shorthand for `node.each_child_node.to_a`.
-      #
-      # @return [Array<Node>] an array of child nodes
-      def child_nodes
-        each_child_node.to_a
-      end
-
-      # Calls the given block for each descendant node with depth first order.
-      # If no block is given, an `Enumerator` is returned.
-      #
-      # @overload each_descendant
-      #   Yield all nodes.
-      # @overload each_descendant(type)
-      #   Yield only nodes matching the type.
-      #   @param [Symbol] type a node type
-      # @overload each_descendant(type_a, type_b, ...)
-      #   Yield only nodes matching any of the types.
-      #   @param [Symbol] type_a a node type
-      #   @param [Symbol] type_b a node type
-      # @yieldparam [Node] node each descendant node
-      # @return [self] if a block is given
-      # @return [Enumerator] if no block is given
-      def each_descendant(*types, &block)
-        return to_enum(__method__, *types) unless block_given?
-
-        visit_descendants(types, &block)
-
-        self
-      end
-
-      # Returns an array of descendant nodes.
-      # This is a shorthand for `node.each_descendant.to_a`.
-      #
-      # @return [Array<Node>] an array of descendant nodes
-      def descendants
-        each_descendant.to_a
-      end
-
-      # Calls the given block for the receiver and each descendant node in
-      # depth-first order.
-      # If no block is given, an `Enumerator` is returned.
-      #
-      # This method would be useful when you treat the receiver node as the root
-      # of a tree and want to iterate over all nodes in the tree.
-      #
-      # @overload each_node
-      #   Yield all nodes.
-      # @overload each_node(type)
-      #   Yield only nodes matching the type.
-      #   @param [Symbol] type a node type
-      # @overload each_node(type_a, type_b, ...)
-      #   Yield only nodes matching any of the types.
-      #   @param [Symbol] type_a a node type
-      #   @param [Symbol] type_b a node type
-      # @yieldparam [Node] node each node
-      # @return [self] if a block is given
-      # @return [Enumerator] if no block is given
-      def each_node(*types, &block)
-        return to_enum(__method__, *types) unless block_given?
-
-        yield self if types.empty? || types.include?(type)
-
-        visit_descendants(types, &block)
-
-        self
-      end
-
-      def source
-        loc.expression.source
-      end
-
-      def source_range
-        loc.expression
-      end
-
-      def first_line
-        loc.line
-      end
-
-      def last_line
-        loc.last_line
-      end
-
-      def line_count
-        return 0 unless source_range
-
-        source_range.last_line - source_range.first_line + 1
-      end
-
-      def nonempty_line_count
-        source.lines.grep(/\S/).size
-      end
-
-      def source_length
-        source_range ? source_range.size : 0
-      end
-
-      ## Destructuring
-
-      def_node_matcher :receiver, <<~PATTERN
-        {(send $_ ...) ({block numblock} (send $_ ...) ...)}
-      PATTERN
-
-      def_node_matcher :str_content, '(str $_)'
-
-      def const_name
-        return unless const_type?
-
-        namespace, name = *self
-        if namespace && !namespace.cbase_type?
-          "#{namespace.const_name}::#{name}"
-        else
-          name.to_s
-        end
-      end
-
-      def_node_matcher :defined_module0, <<~PATTERN
-        {(class (const $_ $_) ...)
-         (module (const $_ $_) ...)
-         (casgn $_ $_        (send #global_const?({:Class :Module}) :new ...))
-         (casgn $_ $_ (block (send #global_const?({:Class :Module}) :new ...) ...))}
-      PATTERN
-
-      private :defined_module0
-
-      def defined_module
-        namespace, name = *defined_module0
-        s(:const, namespace, name) if name
-      end
-
-      def defined_module_name
-        (const = defined_module) && const.const_name
-      end
-
-      ## Searching the AST
-
-      def parent_module_name
-        # what class or module is this method/constant/etc definition in?
-        # returns nil if answer cannot be determined
-        ancestors = each_ancestor(:class, :module, :sclass, :casgn, :block)
-        result    = ancestors.map do |ancestor|
-          parent_module_name_part(ancestor) { |full_name| return full_name }
-        end.compact.reverse.join('::')
-        result.empty? ? 'Object' : result
-      end
-
-      ## Predicates
-
-      def multiline?
-        line_count > 1
-      end
-
-      def single_line?
-        line_count == 1
-      end
-
-      def empty_source?
-        source_length.zero?
-      end
-
-      # Some cops treat the shovel operator as a kind of assignment.
-      def_node_matcher :assignment_or_similar?, <<~PATTERN
-        {assignment? (send _recv :<< ...)}
-      PATTERN
-
-      def literal?
-        LITERALS.include?(type)
-      end
-
-      def basic_literal?
-        BASIC_LITERALS.include?(type)
-      end
-
-      def truthy_literal?
-        TRUTHY_LITERALS.include?(type)
-      end
-
-      def falsey_literal?
-        FALSEY_LITERALS.include?(type)
-      end
-
-      def mutable_literal?
-        MUTABLE_LITERALS.include?(type)
-      end
-
-      def immutable_literal?
-        IMMUTABLE_LITERALS.include?(type)
-      end
-
-      %i[literal basic_literal].each do |kind|
-        recursive_kind = :"recursive_#{kind}?"
-        kind_filter = :"#{kind}?"
-        define_method(recursive_kind) do
-          case type
-          when :send
-            [*COMPARISON_OPERATORS, :!, :<=>].include?(method_name) &&
-              receiver.send(recursive_kind) &&
-              arguments.all?(&recursive_kind)
-          when :begin, :pair, *OPERATOR_KEYWORDS, *COMPOSITE_LITERALS
-            children.compact.all?(&recursive_kind)
-          else
-            send(kind_filter)
-          end
-        end
-      end
-
-      def variable?
-        VARIABLES.include?(type)
-      end
-
-      def reference?
-        REFERENCES.include?(type)
-      end
-
-      def equals_asgn?
-        EQUALS_ASSIGNMENTS.include?(type)
-      end
-
-      def shorthand_asgn?
-        SHORTHAND_ASSIGNMENTS.include?(type)
-      end
-
-      def assignment?
-        ASSIGNMENTS.include?(type)
-      end
-
-      def basic_conditional?
-        BASIC_CONDITIONALS.include?(type)
-      end
-
-      def conditional?
-        CONDITIONALS.include?(type)
-      end
-
-      def post_condition_loop?
-        POST_CONDITION_LOOP_TYPES.include?(type)
-      end
-
-      # Note: `loop { }` is a normal method call and thus not a loop keyword.
-      def loop_keyword?
-        LOOP_TYPES.include?(type)
-      end
-
-      def keyword?
-        return true if special_keyword? || send_type? && prefix_not?
-        return false unless KEYWORDS.include?(type)
-
-        !OPERATOR_KEYWORDS.include?(type) || loc.operator.is?(type.to_s)
-      end
-
-      def special_keyword?
-        SPECIAL_KEYWORDS.include?(source)
-      end
-
-      def operator_keyword?
-        OPERATOR_KEYWORDS.include?(type)
-      end
-
-      def parenthesized_call?
-        loc.respond_to?(:begin) && loc.begin && loc.begin.is?('(')
-      end
-
-      def call_type?
-        send_type? || csend_type?
-      end
-
-      def chained?
-        parent&.call_type? && eql?(parent.receiver)
-      end
-
-      def argument?
-        parent&.send_type? && parent.arguments.include?(self)
-      end
-
-      def argument_type?
-        ARGUMENT_TYPES.include?(type)
-      end
-
-      def boolean_type?
-        true_type? || false_type?
-      end
-
-      def numeric_type?
-        int_type? || float_type?
-      end
-
-      def range_type?
-        irange_type? || erange_type?
-      end
-
-      def guard_clause?
-        node = and_type? || or_type? ? rhs : self
-
-        node.match_guard_clause?
-      end
-
-      def_node_matcher :match_guard_clause?, <<~PATTERN
-        [${(send nil? {:raise :fail} ...) return break next} single_line?]
-      PATTERN
-
-      def_node_matcher :proc?, <<~PATTERN
-        {(block (send nil? :proc) ...)
-         (block (send #global_const?(:Proc) :new) ...)
-         (send #global_const?(:Proc) :new)}
-      PATTERN
-
-      def_node_matcher :lambda?, '({block numblock} (send nil? :lambda) ...)'
-      def_node_matcher :lambda_or_proc?, '{lambda? proc?}'
-
-      def_node_matcher :global_const?, '(const {nil? cbase} %1)'
-
-      def_node_matcher :class_constructor?, <<~PATTERN
-        {       (send #global_const?({:Class :Module}) :new ...)
-         (block (send #global_const?({:Class :Module}) :new ...) ...)}
-      PATTERN
-
-      def_node_matcher :struct_constructor?, <<~PATTERN
-        (block (send #global_const?(:Struct) :new ...) _ $_)
-      PATTERN
-
-      def_node_matcher :class_definition?, <<~PATTERN
-        {(class _ _ $_)
-         (sclass _ $_)
-         (block (send #global_const?({:Struct :Class}) :new ...) _ $_)}
-      PATTERN
-
-      def_node_matcher :module_definition?, <<~PATTERN
-        {(module _ $_)
-         (block (send #global_const?(:Module) :new ...) _ $_)}
-      PATTERN
-
-      # Some expressions are evaluated for their value, some for their side
-      # effects, and some for both
-      # If we know that an expression is useful only for its side effects, that
-      # means we can transform it in ways which preserve the side effects, but
-      # change the return value
-      # So, does the return value of this node matter? If we changed it to
-      # `(...; nil)`, might that affect anything?
-      #
-      # rubocop:disable Metrics/MethodLength
-      def value_used?
-        # Be conservative and return true if we're not sure.
-        return false if parent.nil?
-
-        case parent.type
-        when :array, :defined?, :dstr, :dsym, :eflipflop, :erange, :float,
-             :hash, :iflipflop, :irange, :not, :pair, :regexp, :str, :sym,
-             :when, :xstr
-          parent.value_used?
-        when :begin, :kwbegin
-          begin_value_used?
-        when :for
-          for_value_used?
-        when :case, :if
-          case_if_value_used?
-        when :while, :until, :while_post, :until_post
-          while_until_value_used?
-        else
-          true
-        end
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      # Some expressions are evaluated for their value, some for their side
-      # effects, and some for both.
-      # If we know that expressions are useful only for their return values,
-      # and have no side effects, that means we can reorder them, change the
-      # number of times they are evaluated, or replace them with other
-      # expressions which are equivalent in value.
-      # So, is evaluation of this node free of side effects?
-      #
-      def pure?
-        # Be conservative and return false if we're not sure
-        case type
-        when :__FILE__, :__LINE__, :const, :cvar, :defined?, :false, :float,
-             :gvar, :int, :ivar, :lvar, :nil, :str, :sym, :true, :regopt
-          true
-        when :and, :array, :begin, :case, :dstr, :dsym, :eflipflop, :ensure,
-             :erange, :for, :hash, :if, :iflipflop, :irange, :kwbegin, :not,
-             :or, :pair, :regexp, :until, :until_post, :when, :while,
-             :while_post
-          child_nodes.all?(&:pure?)
-        else
-          false
-        end
-      end
-
-      protected
-
-      def visit_descendants(types, &block)
-        each_child_node do |child|
-          yield child if types.empty? || types.include?(child.type)
-          child.visit_descendants(types, &block)
-        end
-      end
-
-      private
-
-      def visit_ancestors(types)
-        last_node = self
-
-        while (current_node = last_node.parent)
-          yield current_node if types.empty? ||
-                                types.include?(current_node.type)
-          last_node = current_node
-        end
-      end
-
-      def begin_value_used?
-        # the last child node determines the value of the parent
-        sibling_index == parent.children.size - 1 ? parent.value_used? : false
-      end
-
-      def for_value_used?
-        # `for var in enum; body; end`
-        # (for <var> <enum> <body>)
-        sibling_index == 2 ? parent.value_used? : true
-      end
-
-      def case_if_value_used?
-        # (case <condition> <when...>)
-        # (if <condition> <truebranch> <falsebranch>)
-        sibling_index.zero? ? true : parent.value_used?
-      end
-
-      def while_until_value_used?
-        # (while <condition> <body>) -> always evaluates to `nil`
-        sibling_index.zero?
-      end
-
-      def parent_module_name_part(node)
-        case node.type
-        when :class, :module, :casgn
-          # TODO: if constant name has cbase (leading ::), then we don't need
-          # to keep traversing up through nested classes/modules
-          node.defined_module_name
-        when :sclass
-          yield parent_module_name_for_sclass(node)
-        else # block
-          parent_module_name_for_block(node) { yield nil }
-        end
-      end
-
-      def parent_module_name_for_sclass(sclass_node)
-        # TODO: look for constant definition and see if it is nested
-        # inside a class or module
-        subject = sclass_node.children[0]
-
-        if subject.const_type?
-          "#<Class:#{subject.const_name}>"
-        elsif subject.self_type?
-          "#<Class:#{sclass_node.parent_module_name}>"
-        end
-      end
-
-      def parent_module_name_for_block(ancestor)
-        if ancestor.method?(:class_eval)
-          # `class_eval` with no receiver applies to whatever module or class
-          # we are currently in
-          return unless (receiver = ancestor.receiver)
-
-          yield unless receiver.const_type?
-          receiver.const_name
-        elsif !new_class_or_module_block?(ancestor)
-          yield
-        end
-      end
-
-      def_node_matcher :new_class_or_module_block?, <<~PATTERN
-        ^(casgn _ _ (block (send (const _ {:Class :Module}) :new) ...))
-      PATTERN
-    end
-  end
-end