rubocop-ast 1.4.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e6f8d5799eb4f6871ac4666b174d020ca3131b801184b31324d7488abc64b8
-  data.tar.gz: f0be9d5375bc11ae205a2b6343aa2db37afdd330bbde6d22c82ee54b1d6ae03d
+  metadata.gz: 25e84f96e233a9c966ad15efd834e109fea1c11d0998e2913ffd81310568d2b2
+  data.tar.gz: f6b8a033d2fd90518fb102f2cfaa27a5ef32bcfb892783ef79e2b9ad33ab4235
 SHA512:
-  metadata.gz: aa8d27ca9cb6cb156f4a5cc1a951860fa2c04ef0cdf425c4ce2255825a08e664c0255e24c75495c66028f8aeadcf59f524b14b409c6d644129ff95e7a2c56194
-  data.tar.gz: 36c4874bf4e4dd2c8d076243ee08f670dcf17711ebced45f200f71dd720faf4cd1e119b9df491fcee140d33d94bc7ddc3fd88f8818665505702c24ac54e0b91e
+  metadata.gz: 326d28041a4c30d64cac801ceec9677eea264c7a98754217ae27b026bf9779122803402cdddd8306881320e8ac185ce3ff708d4b6e2c869840622303b50b9ab1
+  data.tar.gz: 293b516ba03824c5c9fc56557943993688cf0796bd7ffe567434f7633ca71aa24aec8ebcac89284c3b7b9fb7d38302cf666b1e7b0bb844700d70bad8c65cc767

data/lib/rubocop/ast.rb

@@ -6,7 +6,6 @@ require 'set'
 
 require_relative 'ast/ext/range'
 require_relative 'ast/ext/range_min_max'
-require_relative 'ast/ext/set'
 require_relative 'ast/node_pattern/method_definer'
 require_relative 'ast/node_pattern'
 require_relative 'ast/node/mixin/descendence'
@@ -54,6 +53,7 @@ require_relative 'ast/node/forward_args_node'
 require_relative 'ast/node/float_node'
 require_relative 'ast/node/hash_node'
 require_relative 'ast/node/if_node'
+require_relative 'ast/node/in_pattern_node'
 require_relative 'ast/node/index_node'
 require_relative 'ast/node/indexasgn_node'
 require_relative 'ast/node/int_node'
@@ -72,6 +72,7 @@ require_relative 'ast/node/return_node'
 require_relative 'ast/node/self_class_node'
 require_relative 'ast/node/send_node'
 require_relative 'ast/node/str_node'
+require_relative 'ast/node/dstr_node'
 require_relative 'ast/node/super_node'
 require_relative 'ast/node/symbol_node'
 require_relative 'ast/node/until_node'

data/lib/rubocop/ast/builder.rb

@@ -42,12 +42,14 @@ module RuboCop
         def:          DefNode,
         defined?:     DefinedNode,
         defs:         DefNode,
+        dstr:         DstrNode,
         ensure:       EnsureNode,
         for:          ForNode,
         forward_args: ForwardArgsNode,
         float:        FloatNode,
         hash:         HashNode,
         if:           IfNode,
+        in_pattern:   InPatternNode,
         int:          IntNode,
         index:        IndexNode,
         indexasgn:    IndexasgnNode,
@@ -68,7 +70,6 @@ module RuboCop
         csend:        SendNode,
         send:         SendNode,
         str:          StrNode,
-        dstr:         StrNode,
         xstr:         StrNode,
         sclass:       SelfClassNode,
         super:        SuperNode,

data/lib/rubocop/ast/node.rb

@@ -272,10 +272,12 @@ module RuboCop
 
       ## Destructuring
 
+      # @!method receiver(node = self)
       def_node_matcher :receiver, <<~PATTERN
         {(send $_ ...) ({block numblock} (send $_ ...) ...)}
       PATTERN
 
+      # @!method str_content(node = self)
       def_node_matcher :str_content, '(str $_)'
 
       def const_name
@@ -289,6 +291,7 @@ module RuboCop
         end
       end
 
+      # @!method defined_module0(node = self)
       def_node_matcher :defined_module0, <<~PATTERN
         {(class (const $_ $_) ...)
          (module (const $_ $_) ...)
@@ -334,6 +337,7 @@ module RuboCop
       end
 
       # Some cops treat the shovel operator as a kind of assignment.
+      # @!method assignment_or_similar?(node = self)
       def_node_matcher :assignment_or_similar?, <<~PATTERN
         {assignment? (send _recv :<< ...)}
       PATTERN
@@ -469,37 +473,47 @@ module RuboCop
         node.match_guard_clause?
       end
 
+      # @!method match_guard_clause?(node = self)
       def_node_matcher :match_guard_clause?, <<~PATTERN
         [${(send nil? {:raise :fail} ...) return break next} single_line?]
       PATTERN
 
+      # @!method proc?(node = self)
       def_node_matcher :proc?, <<~PATTERN
         {(block (send nil? :proc) ...)
          (block (send #global_const?(:Proc) :new) ...)
          (send #global_const?(:Proc) :new)}
       PATTERN
 
+      # @!method lambda?(node = self)
       def_node_matcher :lambda?, '({block numblock} (send nil? :lambda) ...)'
+
+      # @!method lambda_or_proc?(node = self)
       def_node_matcher :lambda_or_proc?, '{lambda? proc?}'
 
+      # @!method global_const?(node = self, name)
       def_node_matcher :global_const?, '(const {nil? cbase} %1)'
 
+      # @!method class_constructor?(node = self)
       def_node_matcher :class_constructor?, <<~PATTERN
         {       (send #global_const?({:Class :Module :Struct}) :new ...)
          (block (send #global_const?({:Class :Module :Struct}) :new ...) ...)}
       PATTERN
 
       # @deprecated Use `:class_constructor?`
+      # @!method struct_constructor?(node = self)
       def_node_matcher :struct_constructor?, <<~PATTERN
         (block (send #global_const?(:Struct) :new ...) _ $_)
       PATTERN
 
+      # @!method class_definition?(node = self)
       def_node_matcher :class_definition?, <<~PATTERN
         {(class _ _ $_)
          (sclass _ $_)
          (block (send #global_const?({:Struct :Class}) :new ...) _ $_)}
       PATTERN
 
+      # @!method module_definition?(node = self)
       def_node_matcher :module_definition?, <<~PATTERN
         {(module _ $_)
          (block (send #global_const?(:Module) :new ...) _ $_)}
@@ -633,6 +647,7 @@ module RuboCop
         end
       end
 
+      # @!method new_class_or_module_block?(node = self)
       def_node_matcher :new_class_or_module_block?, <<~PATTERN
         ^(casgn _ _ (block (send (const _ {:Class :Module}) :new) ...))
       PATTERN

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

@@ -24,9 +24,9 @@ module RuboCop
         self
       end
 
-      # Returns an array of all the when branches in the `case` statement.
+      # Returns an array of all the `in` pattern branches in the `case` statement.
       #
-      # @return [Array<Node>] an array of `in_pattern` nodes
+      # @return [Array<InPatternNode>] an array of `in_pattern` nodes
       def in_pattern_branches
         node_parts[1...-1]
       end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `dstr` nodes. This will be used
+    # in place of a plain node when the builder constructs the AST, making
+    # its methods available to all `dstr` nodes within RuboCop.
+    class DstrNode < StrNode
+      def value
+        child_nodes.map do |child|
+          child.respond_to?(:value) ? child.value : child.source
+        end.join
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `in` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `in` nodes within RuboCop.
+    class InPatternNode < Node
+      # Returns a node of the pattern in the `in` branch.
+      #
+      # @return [Node] a pattern node
+      def pattern
+        node_parts.first
+      end
+
+      # Returns the index of the `in` branch within the `case` statement.
+      #
+      # @return [Integer] the index of the `in` branch
+      def branch_index
+        parent.in_pattern_branches.index(self)
+      end
+
+      # Checks whether the `in` node has a `then` keyword.
+      #
+      # @return [Boolean] whether the `in` node has a `then` keyword
+      def then?
+        loc.begin&.is?('then')
+      end
+
+      # Returns the body of the `in` node.
+      #
+      # @return [Node, nil] the body of the `in` node
+      def body
+        node_parts[-1]
+      end
+    end
+  end
+end

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

@@ -13,13 +13,9 @@ module RuboCop
       #
       # @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, ...)
+      # @overload each_child_node(type, ...)
       #   Yield only nodes matching any of the types.
-      #   @param [Symbol] type_a a node type
-      #   @param [Symbol] type_b a node type
+      #   @param [Symbol] type a node type
       # @yieldparam [Node] node each child node
       # @return [self] if a block is given
       # @return [Enumerator] if no block is given

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

@@ -165,16 +165,34 @@ module RuboCop
         ARITHMETIC_OPERATORS.include?(method_name)
       end
 
-      # Checks if this node is part of a chain of `def` modifiers.
+      # Checks if this node is part of a chain of `def` or `defs` modifiers.
       #
       # @example
       #
       #   private def foo; end
       #
-      # @return [Boolean] whether the dispatched method is a `def` modifier
-      def def_modifier?
-        send_type? &&
-          adjacent_def_modifier? || each_child_node(:send).any?(&:def_modifier?)
+      # @return wether the `def|defs` node is a modifier or not.
+      # See also `def_modifier` that returns the node or `nil`
+      def def_modifier?(node = self)
+        !!def_modifier(node)
+      end
+
+      # Checks if this node is part of a chain of `def` or `defs` modifiers.
+      #
+      # @example
+      #
+      #   private def foo; end
+      #
+      # @return [Node | nil] returns the `def|defs` node this is a modifier for,
+      # or `nil` if it isn't a def modifier
+      def def_modifier(node = self)
+        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?
+
+        def_modifier(arg)
       end
 
       # Checks whether this is a lambda. Some versions of parser parses
@@ -224,6 +242,7 @@ module RuboCop
 
       private
 
+      # @!method in_macro_scope?(node = self)
       def_node_matcher :in_macro_scope?, <<~PATTERN
         {
           root?                                    # Either a root node,
@@ -239,14 +258,17 @@ module RuboCop
         }
       PATTERN
 
+      # @!method adjacent_def_modifier?(node = self)
       def_node_matcher :adjacent_def_modifier?, <<~PATTERN
         (send nil? _ ({def defs} ...))
       PATTERN
 
+      # @!method bare_access_modifier_declaration?(node = self)
       def_node_matcher :bare_access_modifier_declaration?, <<~PATTERN
         (send nil? {:public :protected :private :module_function})
       PATTERN
 
+      # @!method non_bare_access_modifier_declaration?(node = self)
       def_node_matcher :non_bare_access_modifier_declaration?, <<~PATTERN
         (send nil? {:public :protected :private :module_function} _)
       PATTERN

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

@@ -9,6 +9,7 @@ module RuboCop
       include ParameterizedNode::RestArguments
       include MethodDispatchNode
 
+      # @!method attribute_accessor?(node = self)
       def_node_matcher :attribute_accessor?, <<~PATTERN
         [(send nil? ${:attr_reader :attr_writer :attr_accessor :attr} $...)
          (_    _    _                                                 _ ...)]

data/lib/rubocop/ast/node_pattern.rb

@@ -28,7 +28,7 @@ module RuboCop
       module Macros
         # Define a method which applies a pattern to an AST node
         #
-        # The new method will return nil if the node does not match
+        # The new method will return nil if the node does not match.
         # If the node matches, and a block is provided, the new method will
         # yield to the block (passing any captures as block arguments).
         # If the node matches, and no block is provided, the new method will

data/lib/rubocop/ast/processed_source.rb

@@ -41,7 +41,7 @@ module RuboCop
       def ast_with_comments
         return if !ast || !comments
 
-        @ast_with_comments ||= Parser::Source::Comment.associate(ast, comments)
+        @ast_with_comments ||= Parser::Source::Comment.associate_by_identity(ast, comments)
       end
 
       # Returns the source lines, line break characters removed, excluding a
@@ -236,6 +236,9 @@ module RuboCop
         when 2.8, 3.0
           require 'parser/ruby30'
           Parser::Ruby30
+        when 3.1
+          require 'parser/ruby31'
+          Parser::Ruby31
         else
           raise ArgumentError,
                 "RuboCop found unknown Ruby version: #{ruby_version.inspect}"

data/lib/rubocop/ast/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.4.0'
+      STRING = '1.7.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-01 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.1.5
+        version: 3.0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.1.5
+        version: 3.0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +61,6 @@ files:
 - lib/rubocop/ast/builder.rb
 - lib/rubocop/ast/ext/range.rb
 - lib/rubocop/ast/ext/range_min_max.rb
-- lib/rubocop/ast/ext/set.rb
 - lib/rubocop/ast/node.rb
 - lib/rubocop/ast/node/alias_node.rb
 - lib/rubocop/ast/node/and_node.rb
@@ -76,12 +75,14 @@ files:
 - lib/rubocop/ast/node/const_node.rb
 - lib/rubocop/ast/node/def_node.rb
 - lib/rubocop/ast/node/defined_node.rb
+- lib/rubocop/ast/node/dstr_node.rb
 - lib/rubocop/ast/node/ensure_node.rb
 - lib/rubocop/ast/node/float_node.rb
 - lib/rubocop/ast/node/for_node.rb
 - lib/rubocop/ast/node/forward_args_node.rb
 - lib/rubocop/ast/node/hash_node.rb
 - lib/rubocop/ast/node/if_node.rb
+- lib/rubocop/ast/node/in_pattern_node.rb
 - lib/rubocop/ast/node/index_node.rb
 - lib/rubocop/ast/node/indexasgn_node.rb
 - lib/rubocop/ast/node/int_node.rb
@@ -161,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rubocop/ast/ext/set.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-test = :foo
-case test
-when Set[:foo]
-  # ok, RUBY_VERSION > 2.4
-else
-  # Harmonize `Set#===`
-  class Set
-    alias === include?
-  end
-end