rubocop-ast 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d42f2a7ab5fe1a168c8307ffad746e21eaa3811cdb5f9236ce423f2fb829b9ae
-  data.tar.gz: 74ca8b1fbbbb9f0a89ae61136235f9066579da11b4a056c0161a7a7a34092e19
+  metadata.gz: a4e1919e281d2cc09eca1c8f18effe89cd4c818f7981070e5cb222bde40d6be5
+  data.tar.gz: e7368a014cc2c9881552f935b6a841357275940e63ee567655f3bb151b118977
 SHA512:
-  metadata.gz: ffeca2200e1825749aa09f72e90b98b643617b55f4300ad9de8f34bedb59534278ebd4490d50d6e6866b055a5b5d9e28707e69c221c8da16e6c6691b83e7b162
-  data.tar.gz: 4e7b93a612f88394024fd26d025cbca1cf3b1926ea27650a115efd89b9f8bda2aab52d55968d427d1e63a295d588407046841d00ef5823e80443bb4d73b3acd2
+  metadata.gz: b1c16200ecf6bc69027525ac88c1214d9fb69ce8840307422560ac9c6e314c6d720e278100640da86a406e0d4ae7d229d3f943b4dd5a3446739584baa205336a
+  data.tar.gz: eafb7d829dd9c17182b43bc9ed091933bcb4ce7904b499a12a79054f76ecc25896917ae4f043f84790c2b2754f6563ab1457ce86fd58b8ddf490f8188263479a

data/README.md

@@ -35,7 +35,9 @@ See the [docs site](https://docs.rubocop.org/rubocop-ast) for more details.
 
 ### Parser compatibility switches
 
-This gem, by default, uses most [legacy AST output from parser](https://github.com/whitequark/parser/#usage), except for `emit_forward_arg` which is set to `true`.
+This gem, by default, uses most [legacy AST output from parser](https://github.com/whitequark/parser/#usage), except for the following which are set to `true`:
+* `emit_forward_arg`
+* `emit_match_pattern`
 
 The main `RuboCop` gem uses these defaults (and is currently only compatible with these), but this gem can be used separately from `RuboCop` and is meant to be compatible with all settings. For example, to have `-> { ... }` emitted
 as `LambdaNode` instead of `SendNode`:

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'
@@ -72,6 +71,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

@@ -14,7 +14,8 @@ module RuboCop
     #   parser = Parser::Ruby25.new(builder)
     #   root_node = parser.parse(buffer)
     class Builder < Parser::Builders::Default
-      self.emit_forward_arg = true
+      self.emit_forward_arg = true if respond_to?(:emit_forward_arg=)
+      self.emit_match_pattern = true if respond_to?(:emit_match_pattern=)
 
       # @api private
       NODE_MAP = {
@@ -41,6 +42,7 @@ module RuboCop
         def:          DefNode,
         defined?:     DefinedNode,
         defs:         DefNode,
+        dstr:         DstrNode,
         ensure:       EnsureNode,
         for:          ForNode,
         forward_args: ForwardArgsNode,
@@ -52,6 +54,7 @@ module RuboCop
         indexasgn:    IndexasgnNode,
         irange:       RangeNode,
         erange:       RangeNode,
+        kwargs:       HashNode,
         kwsplat:      KeywordSplatNode,
         lambda:       LambdaNode,
         module:       ModuleNode,
@@ -66,7 +69,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/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/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

@@ -224,6 +224,7 @@ module RuboCop
 
       private
 
+      # @!method in_macro_scope?(node = self)
       def_node_matcher :in_macro_scope?, <<~PATTERN
         {
           root?                                    # Either a root node,
@@ -239,14 +240,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/node_pattern/lexer.rex

@@ -13,7 +13,8 @@ class RuboCop::AST::NodePattern::LexerRex
 macros
         CONST_NAME                /[A-Z:][a-zA-Z_:]+/
         SYMBOL_NAME               /[\w+@*\/?!<>=~|%^-]+|\[\]=?/
-        IDENTIFIER                /[a-zA-Z_][a-zA-Z0-9_-]*/
+        IDENTIFIER                /[a-z][a-zA-Z0-9_]*/
+        NODE_TYPE                 /[a-z][a-zA-Z0-9_-]*/  # Same as identifier but allows '-'
         CALL                      /(?:#{CONST_NAME}\.)?#{IDENTIFIER}[!?]?/
         REGEXP_BODY               /(?:[^\/]|\\\/)*/
         REGEXP                    /\/(#{REGEXP_BODY})(?<!\\)\/([imxo]*)/
@@ -27,14 +28,14 @@ rules
           %w"( ) { | } [ ] < > $ ! ^ ` ... + * ? ,"
         )}/o                      { emit ss.matched, &:to_sym }
         /#{REGEXP}/o              { emit_regexp }
-        /%(#{CONST_NAME})/o       { emit :tPARAM_CONST }
+        /%?(#{CONST_NAME})/o      { emit :tPARAM_CONST }
         /%([a-z_]+)/              { emit :tPARAM_NAMED }
         /%(\d*)/                  { emit(:tPARAM_NUMBER) { |s| s.empty? ? 1 : s.to_i } } # Map `%` to `%1`
         /_(#{IDENTIFIER})/o       { emit :tUNIFY }
         /_/o                      { emit :tWILDCARD }
         /\#(#{CALL})/o            { @state = :ARG; emit :tFUNCTION_CALL, &:to_sym }
         /#{IDENTIFIER}\?/o        { @state = :ARG; emit :tPREDICATE, &:to_sym }
-        /#{IDENTIFIER}/o          { emit :tNODE_TYPE, &:to_sym }
+        /#{NODE_TYPE}/o           { emit :tNODE_TYPE, &:to_sym }
   :ARG  /\(/                      { @state = nil; emit :tARG_LIST }
   :ARG  //                        { @state = nil }
         /\#.*/                    { emit_comment }

data/lib/rubocop/ast/node_pattern/lexer.rex.rb

@@ -26,7 +26,8 @@ class RuboCop::AST::NodePattern::LexerRex
   # :stopdoc:
   CONST_NAME  = /[A-Z:][a-zA-Z_:]+/
   SYMBOL_NAME = /[\w+@*\/?!<>=~|%^-]+|\[\]=?/
-  IDENTIFIER  = /[a-zA-Z_][a-zA-Z0-9_-]*/
+  IDENTIFIER  = /[a-z][a-zA-Z0-9_]*/
+  NODE_TYPE   = /[a-z][a-zA-Z0-9_-]*/
   CALL        = /(?:#{CONST_NAME}\.)?#{IDENTIFIER}[!?]?/
   REGEXP_BODY = /(?:[^\/]|\\\/)*/
   REGEXP      = /\/(#{REGEXP_BODY})(?<!\\)\/([imxo]*)/
@@ -134,7 +135,7 @@ class RuboCop::AST::NodePattern::LexerRex
             action { emit ss.matched, &:to_sym }
           when ss.skip(/#{REGEXP}/o) then
             action { emit_regexp }
-          when ss.skip(/%(#{CONST_NAME})/o) then
+          when ss.skip(/%?(#{CONST_NAME})/o) then
             action { emit :tPARAM_CONST }
           when ss.skip(/%([a-z_]+)/) then
             action { emit :tPARAM_NAMED }
@@ -148,7 +149,7 @@ class RuboCop::AST::NodePattern::LexerRex
             action { @state = :ARG; emit :tFUNCTION_CALL, &:to_sym }
           when ss.skip(/#{IDENTIFIER}\?/o) then
             action { @state = :ARG; emit :tPREDICATE, &:to_sym }
-          when ss.skip(/#{IDENTIFIER}/o) then
+          when ss.skip(/#{NODE_TYPE}/o) then
             action { emit :tNODE_TYPE, &:to_sym }
           when ss.skip(/\#.*/) then
             action { emit_comment }

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/traversal.rb

@@ -114,9 +114,10 @@ module RuboCop
                               in_match match_alt break next
                               match_as array_pattern array_pattern_with_tail
                               hash_pattern const_pattern find_pattern
-                              index indexasgn procarg0]
+                              index indexasgn procarg0 kwargs]
       many_opt_node_children = %i[case rescue resbody ensure for when
-                                  case_match in_pattern irange erange]
+                                  case_match in_pattern irange erange
+                                  match_pattern match_pattern_p]
 
       ### Callbacks for above
       def_callback no_children

data/lib/rubocop/ast/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.2.0'
+      STRING = '1.5.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2021-05-02 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,6 +75,7 @@ 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
@@ -161,14 +161,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: RuboCop tools to deal with Ruby code AST.

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