rubocop-ast 1.30.0 → 1.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84c917625cddd9b79c0979e269fdd324f8119b9d2b3c6081fae0ef449669bea5
-  data.tar.gz: 8d053cac9c670216326df54b5b7b6a8961bf89614defa16e93ad1c557a8b25a5
+  metadata.gz: e27c2b81b954a689111e1b592d34e91d6561e4b69bbdd098464671fde8488cf2
+  data.tar.gz: 67222d8e415d13972cc0817cd2a5468c04125600162cd0f4b3e441574deea4c3
 SHA512:
-  metadata.gz: c95bd42a576592153d70f61367aafacd9677021515534a487706b736cc02cfcf717fc6db39e3df7212088301383cb7d60af9b929b4ca65b7baa5a66f5eca059e
-  data.tar.gz: f0d99d3695e651ec10709dd729696a2b137c3b11603598164b433f61583218b16807c44ea1637ebe1922b496b8472795e4d54a4dc1312908f049e6f43b242ff8
+  metadata.gz: ac990087ef866dd14b059caa230aca760bba08db4394d65557df0aeba20d696ef9c25ccb89662428e26288b5cd8ea35d22a50884c2810bc01087188362a084f5
+  data.tar.gz: fb46af6a67f31258c33228fa5a748a7b110be68552a47a43b5487a49521b2b2c603215802a5d1a722b185388f6af97378492bfa7fbd00f563f0738c04e2afaf9

data/README.md

@@ -1,7 +1,7 @@
 # RuboCop AST
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-ast.svg)](https://badge.fury.io/rb/rubocop-ast)
-[![CI](https://github.com/rubocop/rubocop-ast/workflows/CI/badge.svg)](https://github.com/rubocop/rubocop-ast/actions?query=workflow%3ACI)
+[![CI](https://github.com/rubocop/rubocop-ast/actions/workflows/rubocop.yml/badge.svg)](https://github.com/rubocop/rubocop-ast/actions/workflows/rubocop.yml)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a29666e6373bc41bc0a9/test_coverage)](https://codeclimate.com/github/rubocop/rubocop-ast/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a29666e6373bc41bc0a9/maintainability)](https://codeclimate.com/github/rubocop/rubocop-ast/maintainability)
 

data/lib/rubocop/ast/builder.rb

@@ -72,6 +72,7 @@ module RuboCop
         or:                  OrNode,
         pair:                PairNode,
         procarg0:            Procarg0Node,
+        rational:            RationalNode,
         regexp:              RegexpNode,
         rescue:              RescueNode,
         resbody:             ResbodyNode,

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

@@ -17,7 +17,11 @@ module RuboCop
       # @return [Array<Node>] an array of value nodes
       alias values children
 
-      # @deprecated Use `values.each` (a.k.a. `children.each`)
+      # Calls the given block for each `value` node in the `array` literal.
+      # If no block is given, an `Enumerator` is returned.
+      #
+      # @return [self] if a block is given
+      # @return [Enumerator] if no block is given
       def each_value(&block)
         return to_enum(__method__) unless block
 

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

@@ -12,6 +12,14 @@ module RuboCop
       def body
         node_parts[1]
       end
+
+      # Checks whether this node body is a void context.
+      # Always `true` for `ensure`.
+      #
+      # @return [true] whether the `ensure` node body is a void context
+      def void_context?
+        true
+      end
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     # Common functionality for primitive literal nodes: `sym`, `str`,
-    # `int`, `float`, ...
+    # `int`, `float`, `rational`...
     module BasicLiteralNode
       # Returns the value of the literal.
       #

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

@@ -2,7 +2,7 @@
 
 module RuboCop
   module AST
-    # Common functionality for primitive numeric nodes: `int`, `float`, ...
+    # Common functionality for primitive numeric nodes: `int`, `float`, `rational`...
     module NumericNode
       SIGN_REGEX = /\A[+-]/.freeze
       private_constant :SIGN_REGEX

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `rational` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available to
+    # all `rational` nodes within RuboCop.
+    class RationalNode < Node
+      include BasicLiteralNode
+      include NumericNode
+    end
+  end
+end

data/lib/rubocop/ast/node.rb

@@ -88,6 +88,27 @@ module RuboCop
       EMPTY_PROPERTIES = {}.freeze
       private_constant :EMPTY_CHILDREN, :EMPTY_PROPERTIES
 
+      # Define a +recursive_?+ predicate method for the given node kind.
+      private_class_method def self.def_recursive_literal_predicate(kind) # rubocop:disable Metrics/MethodLength
+        recursive_kind = "recursive_#{kind}?"
+        kind_filter = "#{kind}?"
+
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{recursive_kind}                                     # def recursive_literal?
+            case type                                               #   case type
+            when :send                                              #   when :send
+              LITERAL_RECURSIVE_METHODS.include?(method_name) &&    #     LITERAL_RECURSIVE_METHODS.include?(method_name) &&
+                receiver.send(:#{recursive_kind}) &&                #       receiver.send(:recursive_literal?) &&
+                arguments.all?(&:#{recursive_kind})                 #       arguments.all?(&:recursive_literal?)
+            when LITERAL_RECURSIVE_TYPES                            #   when LITERAL_RECURSIVE_TYPES
+              children.compact.all?(&:#{recursive_kind})            #     children.compact.all?(&:recursive_literal?)
+            else                                                    #   else
+              send(:#{kind_filter})                                 #     send(:literal?)
+            end                                                     #   end
+          end                                                       # end
+        RUBY
+      end
+
       # @see https://www.rubydoc.info/gems/ast/AST/Node:initialize
       def initialize(type, children = EMPTY_CHILDREN, properties = EMPTY_PROPERTIES)
         @mutable_attributes = {}
@@ -326,13 +347,13 @@ module RuboCop
         # 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|
+        result    = ancestors.filter_map do |ancestor|
           parent_module_name_part(ancestor) do |full_name|
             return nil unless full_name
 
             full_name
           end
-        end.compact.reverse.join('::')
+        end.reverse.join('::')
         result.empty? ? 'Object' : result
       end
 
@@ -380,22 +401,11 @@ module RuboCop
         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
-            LITERAL_RECURSIVE_METHODS.include?(method_name) &&
-              receiver.send(recursive_kind) &&
-              arguments.all?(&recursive_kind)
-          when LITERAL_RECURSIVE_TYPES
-            children.compact.all?(&recursive_kind)
-          else
-            send(kind_filter)
-          end
-        end
-      end
+      # @!macro [attach] def_recursive_literal_predicate
+      #   @!method recursive_$1?
+      #     @return [Boolean]
+      def_recursive_literal_predicate :literal
+      def_recursive_literal_predicate :basic_literal
 
       def variable?
         VARIABLES.include?(type)
@@ -547,8 +557,7 @@ module RuboCop
       # 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?
+      def value_used? # rubocop:disable Metrics/MethodLength
         # Be conservative and return true if we're not sure.
         return false if parent.nil?
 
@@ -569,7 +578,6 @@ module RuboCop
           true
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Some expressions are evaluated for their value, some for their side
       # effects, and some for both.

data/lib/rubocop/ast/node_pattern/compiler/binding.rb

@@ -26,8 +26,9 @@ module RuboCop
             var
           end
 
-          # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-          def union_bind(enum)
+          # Yields for each branch of the given union, forbidding unification of
+          # bindings which only appear in a subset of the union.
+          def union_bind(enum) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
             # We need to reset @bound before each branch is processed.
             # Moreover we need to keep track of newly encountered wildcards.
             # Var `newly_bound_intersection` will hold those that are encountered
@@ -62,7 +63,6 @@ module RuboCop
 
             result
           end
-          # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
           private
 

data/lib/rubocop/ast/node_pattern/compiler/sequence_subcompiler.rb

@@ -13,8 +13,8 @@ module RuboCop
         # Doc on how this fits in the compiling process:
         #   /docs/modules/ROOT/pages/node_pattern.adoc
         #
-        # rubocop:disable Metrics/ClassLength
-        class SequenceSubcompiler < Subcompiler
+        class SequenceSubcompiler < Subcompiler # rubocop:disable Metrics/ClassLength
+          # Shift of 1 from standard Ruby indices
           DELTA = 1
           POSITIVE = :positive?.to_proc
           private_constant :POSITIVE
@@ -413,7 +413,6 @@ module RuboCop
             @in_sync = sub_compilers.all?(&:in_sync)
           end
         end
-        # rubocop:enable Metrics/ClassLength
       end
     end
   end

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

@@ -2,7 +2,7 @@
 # encoding: UTF-8
 #--
 # This file is automatically generated. Do not modify it.
-# Generated by: oedipus_lex version 2.6.1.
+# Generated by: oedipus_lex version 2.6.2.
 # Source: lib/rubocop/ast/node_pattern/lexer.rex
 #++
 
@@ -70,7 +70,6 @@ class RuboCop::AST::NodePattern::LexerRex
     yield
   end
 
-
   ##
   # The current scanner class. Must be overridden in subclasses.
 

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

@@ -7,7 +7,6 @@ module RuboCop
       class Node < ::Parser::AST::Node
         extend Forwardable
         include ::RuboCop::AST::Descendence
-        using Ext::RangeMinMax
 
         MATCHES_WITHIN_SET = %i[symbol number string].to_set.freeze
         private_constant :MATCHES_WITHIN_SET

data/lib/rubocop/ast/node_pattern/parser.racc.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.7.1
-# from Racc grammar file "".
+# This file is automatically generated by Racc 1.8.1
+# from Racc grammar file "parser.y".
 #
 
 require 'racc/parser.rb'

data/lib/rubocop/ast/processed_source.rb

@@ -2,28 +2,36 @@
 
 require 'digest/sha1'
 
-# rubocop:disable Metrics/ClassLength
 module RuboCop
   module AST
     # ProcessedSource contains objects which are generated by Parser
     # and other information such as disabled lines for cops.
     # It also provides a convenient way to access source lines.
-    class ProcessedSource
+    class ProcessedSource # rubocop:disable Metrics/ClassLength
       # @api private
       STRING_SOURCE_NAME = '(string)'
 
       INVALID_LEVELS = %i[error fatal].freeze
       private_constant :INVALID_LEVELS
 
+      PARSER_ENGINES = %i[parser_whitequark parser_prism].freeze
+      private_constant :PARSER_ENGINES
+
       attr_reader :path, :buffer, :ast, :comments, :tokens, :diagnostics,
-                  :parser_error, :raw_source, :ruby_version
+                  :parser_error, :raw_source, :ruby_version, :parser_engine
 
-      def self.from_file(path, ruby_version)
+      def self.from_file(path, ruby_version, parser_engine: :parser_whitequark)
         file = File.read(path, mode: 'rb')
-        new(file, ruby_version, path)
+        new(file, ruby_version, path, parser_engine: parser_engine)
       end
 
-      def initialize(source, ruby_version, path = nil)
+      def initialize(source, ruby_version, path = nil, parser_engine: :parser_whitequark)
+        parser_engine = parser_engine.to_sym
+        unless PARSER_ENGINES.include?(parser_engine)
+          raise ArgumentError, 'The keyword argument `parser_engine` accepts `parser_whitequark` ' \
+                               "or `parser_prism`, but `#{parser_engine}` was passed."
+        end
+
         # Defaults source encoding to UTF-8, regardless of the encoding it has
         # been read with, which could be non-utf8 depending on the default
         # external encoding.
@@ -33,9 +41,10 @@ module RuboCop
         @path = path
         @diagnostics = []
         @ruby_version = ruby_version
+        @parser_engine = parser_engine
         @parser_error = nil
 
-        parse(source, ruby_version)
+        parse(source, ruby_version, parser_engine)
       end
 
       def ast_with_comments
@@ -193,13 +202,13 @@ module RuboCop
         end
       end
 
-      def parse(source, ruby_version)
+      def parse(source, ruby_version, parser_engine)
         buffer_name = @path || STRING_SOURCE_NAME
         @buffer = Parser::Source::Buffer.new(buffer_name, 1)
 
         begin
           @buffer.source = source
-        rescue EncodingError => e
+        rescue EncodingError, Parser::UnknownEncodingInMagicComment => e
           @parser_error = e
           @ast = nil
           @comments = []
@@ -207,7 +216,7 @@ module RuboCop
           return
         end
 
-        @ast, @comments, @tokens = tokenize(create_parser(ruby_version))
+        @ast, @comments, @tokens = tokenize(create_parser(ruby_version, parser_engine))
       end
 
       def tokenize(parser)
@@ -226,59 +235,81 @@ module RuboCop
         [ast, comments, tokens]
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-      def parser_class(ruby_version)
-        case ruby_version
-        when 1.9
-          require 'parser/ruby19'
-          Parser::Ruby19
-        when 2.0
-          require 'parser/ruby20'
-          Parser::Ruby20
-        when 2.1
-          require 'parser/ruby21'
-          Parser::Ruby21
-        when 2.2
-          require 'parser/ruby22'
-          Parser::Ruby22
-        when 2.3
-          require 'parser/ruby23'
-          Parser::Ruby23
-        when 2.4
-          require 'parser/ruby24'
-          Parser::Ruby24
-        when 2.5
-          require 'parser/ruby25'
-          Parser::Ruby25
-        when 2.6
-          require 'parser/ruby26'
-          Parser::Ruby26
-        when 2.7
-          require 'parser/ruby27'
-          Parser::Ruby27
-        when 2.8, 3.0
-          require 'parser/ruby30'
-          Parser::Ruby30
-        when 3.1
-          require 'parser/ruby31'
-          Parser::Ruby31
-        when 3.2
-          require 'parser/ruby32'
-          Parser::Ruby32
-        when 3.3
-          require 'parser/ruby33'
-          Parser::Ruby33
-        else
-          raise ArgumentError,
-                "RuboCop found unknown Ruby version: #{ruby_version.inspect}"
+      def parser_class(ruby_version, parser_engine) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        case parser_engine
+        when :parser_whitequark
+          case ruby_version
+          when 1.9
+            require 'parser/ruby19'
+            Parser::Ruby19
+          when 2.0
+            require 'parser/ruby20'
+            Parser::Ruby20
+          when 2.1
+            require 'parser/ruby21'
+            Parser::Ruby21
+          when 2.2
+            require 'parser/ruby22'
+            Parser::Ruby22
+          when 2.3
+            require 'parser/ruby23'
+            Parser::Ruby23
+          when 2.4
+            require 'parser/ruby24'
+            Parser::Ruby24
+          when 2.5
+            require 'parser/ruby25'
+            Parser::Ruby25
+          when 2.6
+            require 'parser/ruby26'
+            Parser::Ruby26
+          when 2.7
+            require 'parser/ruby27'
+            Parser::Ruby27
+          when 2.8, 3.0
+            require 'parser/ruby30'
+            Parser::Ruby30
+          when 3.1
+            require 'parser/ruby31'
+            Parser::Ruby31
+          when 3.2
+            require 'parser/ruby32'
+            Parser::Ruby32
+          when 3.3
+            require 'parser/ruby33'
+            Parser::Ruby33
+          when 3.4
+            require 'parser/ruby34'
+            Parser::Ruby34
+          else
+            raise ArgumentError, "RuboCop found unknown Ruby version: #{ruby_version.inspect}"
+          end
+        when :parser_prism
+          begin
+            require 'prism'
+          rescue LoadError
+            warn "Error: Unable to load Prism. Add `gem 'prism'` to your Gemfile."
+            exit!
+          end
+
+          case ruby_version
+          when 3.3
+            require 'prism/translation/parser33'
+            Prism::Translation::Parser33
+          when 3.4
+            require 'prism/translation/parser34'
+            Prism::Translation::Parser34
+          else
+            raise ArgumentError, 'RuboCop supports target Ruby versions 3.3 and above with Prism. ' \
+                                 "Specified target Ruby version: #{ruby_version.inspect}"
+          end
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
-      def create_parser(ruby_version)
+      def create_parser(ruby_version, parser_engine)
         builder = RuboCop::AST::Builder.new
 
-        parser_class(ruby_version).new(builder).tap do |parser|
+        parser_class(ruby_version, parser_engine).new(builder).tap do |parser|
           # On JRuby there's a risk that we hang in tokenize() if we
           # don't set the all errors as fatal flag. The problem is caused by a bug
           # in Racc that is discussed in issue #93 of the whitequark/parser
@@ -311,4 +342,3 @@ module RuboCop
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/lib/rubocop/ast/token.rb

@@ -83,7 +83,7 @@ module RuboCop
       end
 
       def left_curly_brace?
-        type == :tLCURLY
+        type == :tLCURLY || type == :tLAMBEG
       end
 
       def right_curly_brace?

data/lib/rubocop/ast/traversal.rb

@@ -38,14 +38,14 @@ module RuboCop
                          body: self.body(signature, arity_check))
           type, *aliases = type
           lineno = caller_locations(1, 1).first.lineno
-          module_eval(<<~RUBY, __FILE__, lineno) # rubocop:disable Style/EvalWithLocation
+          module_eval(<<~RUBY, __FILE__, lineno)
             def on_#{type}(node)        # def on_send(node)
               #{body}                   #   # body ...
               nil                       #   nil
             end                         # end
           RUBY
           aliases.each do |m|
-            alias_method "on_#{m}", "on_#{type}"
+            alias_method :"on_#{m}", :"on_#{type}"
           end
         end
 

data/lib/rubocop/ast/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module AST
     module Version
-      STRING = '1.30.0'
+      STRING = '1.32.1'
     end
   end
 end

data/lib/rubocop/ast.rb

@@ -5,7 +5,6 @@ require 'forwardable'
 require 'set'
 
 require_relative 'ast/ext/range'
-require_relative 'ast/ext/range_min_max'
 require_relative 'ast/node_pattern/method_definer'
 require_relative 'ast/node_pattern'
 require_relative 'ast/node/mixin/descendence'
@@ -70,6 +69,7 @@ require_relative 'ast/node/or_node'
 require_relative 'ast/node/pair_node'
 require_relative 'ast/node/procarg0_node'
 require_relative 'ast/node/range_node'
+require_relative 'ast/node/rational_node'
 require_relative 'ast/node/regexp_node'
 require_relative 'ast/node/rescue_node'
 require_relative 'ast/node/resbody_node'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ast
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 1.32.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2024-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1.0
+        version: 3.3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1.0
+        version: 3.3.1.0
 description: "    RuboCop's Node and NodePattern classes.\n"
 email: rubocop@googlegroups.com
 executables: []
@@ -40,7 +40,6 @@ files:
 - lib/rubocop/ast.rb
 - lib/rubocop/ast/builder.rb
 - lib/rubocop/ast/ext/range.rb
-- lib/rubocop/ast/ext/range_min_max.rb
 - lib/rubocop/ast/node.rb
 - lib/rubocop/ast/node/alias_node.rb
 - lib/rubocop/ast/node/and_asgn_node.rb
@@ -92,6 +91,7 @@ files:
 - lib/rubocop/ast/node/pair_node.rb
 - lib/rubocop/ast/node/procarg0_node.rb
 - lib/rubocop/ast/node/range_node.rb
+- lib/rubocop/ast/node/rational_node.rb
 - lib/rubocop/ast/node/regexp_node.rb
 - lib/rubocop/ast/node/resbody_node.rb
 - lib/rubocop/ast/node/rescue_node.rb
@@ -149,14 +149,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: RuboCop tools to deal with Ruby code AST.

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module AST
-    module Ext
-      # Refinement to circumvent broken `Range#minmax` for infinity ranges in 2.6-
-      module RangeMinMax
-        if ::Range.instance_method(:minmax).owner != ::Range
-          refine ::Range do
-            def minmax
-              [min, max]
-            end
-          end
-        end
-      end
-    end
-  end
-end