prism 0.23.0 → 0.25.0

data/lib/prism/translation/parser/rubocop.rb

@@ -1,28 +1,64 @@
 # frozen_string_literal: true
+# typed: ignore
+
+warn "WARN: Prism is directly supported since RuboCop 1.62. The `prism/translation/parser/rubocop` file is deprecated."
 
 require "parser"
 require "rubocop"
 
-require "prism"
-require "prism/translation/parser"
+require_relative "../../prism"
+require_relative "../parser"
 
 module Prism
   module Translation
     class Parser
-      # This is the special version number that should be used in rubocop
+      # This is the special version numbers that should be used in RuboCop
       # configuration files to trigger using prism.
+
+      # For Ruby 3.3
       VERSION_3_3 = 80_82_73_83_77.33
 
+      # For Ruby 3.4
+      VERSION_3_4 = 80_82_73_83_77.34
+
       # This module gets prepended into RuboCop::AST::ProcessedSource.
       module ProcessedSource
-        # Redefine parser_class so that we can inject the prism parser into the
-        # list of known parsers.
-        def parser_class(ruby_version)
-          if ruby_version == Prism::Translation::Parser::VERSION_3_3
-            require "prism/translation/parser"
-            Prism::Translation::Parser
-          else
-            super
+        # This condition is compatible with rubocop-ast versions up to 1.30.0.
+        if RuboCop::AST::ProcessedSource.instance_method(:parser_class).arity == 1
+          # Redefine parser_class so that we can inject the prism parser into the
+          # list of known parsers.
+          def parser_class(ruby_version)
+            if ruby_version == Prism::Translation::Parser::VERSION_3_3
+              warn "WARN: Setting `TargetRubyVersion: 80_82_73_83_77.33` is deprecated. " \
+                   "Set to `ParserEngine: parser_prism` and `TargetRubyVersion: 3.3` instead."
+              require_relative "../parser33"
+              Prism::Translation::Parser33
+            elsif ruby_version == Prism::Translation::Parser::VERSION_3_4
+              warn "WARN: Setting `TargetRubyVersion: 80_82_73_83_77.34` is deprecated. " \
+                   "Set to `ParserEngine: parser_prism` and `TargetRubyVersion: 3.4` instead."
+              require_relative "../parser34"
+              Prism::Translation::Parser34
+            else
+              super
+            end
+          end
+        else
+          # Redefine parser_class so that we can inject the prism parser into the
+          # list of known parsers.
+          def parser_class(ruby_version, _parser_engine)
+            if ruby_version == Prism::Translation::Parser::VERSION_3_3
+              warn "WARN: Setting `TargetRubyVersion: 80_82_73_83_77.33` is deprecated. " \
+                   "Set to `ParserEngine: parser_prism` and `TargetRubyVersion: 3.3` instead."
+              require_relative "../parser33"
+              Prism::Translation::Parser33
+            elsif ruby_version == Prism::Translation::Parser::VERSION_3_4
+              warn "WARN: Setting `TargetRubyVersion: 80_82_73_83_77.34` is deprecated. " \
+                   "Set to `ParserEngine: parser_prism` and `TargetRubyVersion: 3.4` instead."
+              require_relative "../parser34"
+              Prism::Translation::Parser34
+            else
+              super
+            end
           end
         end
       end

data/lib/prism/translation/parser.rb

@@ -9,17 +9,20 @@ module Prism
     # the parser gem, and overrides the parse* methods to parse with prism and
     # then translate.
     class Parser < ::Parser::Base
+      Diagnostic = ::Parser::Diagnostic # :nodoc:
+      private_constant :Diagnostic
+
       # The parser gem has a list of diagnostics with a hard-coded set of error
       # messages. We create our own diagnostic class in order to set our own
       # error messages.
-      class Diagnostic < ::Parser::Diagnostic
-        # The message generated by prism.
+      class PrismDiagnostic < Diagnostic
+        # This is the cached message coming from prism.
         attr_reader :message
 
         # Initialize a new diagnostic with the given message and location.
-        def initialize(message, location)
+        def initialize(message, level, reason, location)
           @message = message
-          super(:error, :prism_error, {}, location, [])
+          super(level, reason, {}, location, [])
         end
       end
 
@@ -43,7 +46,7 @@ module Prism
         source = source_buffer.source
 
         offset_cache = build_offset_cache(source)
-        result = unwrap(Prism.parse(source, filepath: source_buffer.name), offset_cache)
+        result = unwrap(Prism.parse(source, filepath: source_buffer.name, version: convert_for_prism(version)), offset_cache)
 
         build_ast(result.value, offset_cache)
       ensure
@@ -56,7 +59,7 @@ module Prism
         source = source_buffer.source
 
         offset_cache = build_offset_cache(source)
-        result = unwrap(Prism.parse(source, filepath: source_buffer.name), offset_cache)
+        result = unwrap(Prism.parse(source, filepath: source_buffer.name, version: convert_for_prism(version)), offset_cache)
 
         [
           build_ast(result.value, offset_cache),
@@ -75,7 +78,7 @@ module Prism
         offset_cache = build_offset_cache(source)
         result =
           begin
-            unwrap(Prism.parse_lex(source, filepath: source_buffer.name), offset_cache)
+            unwrap(Prism.parse_lex(source, filepath: source_buffer.name, version: convert_for_prism(version)), offset_cache)
           rescue ::Parser::SyntaxError
             raise if !recover
           end
@@ -106,14 +109,123 @@ module Prism
         true
       end
 
+      # This is a hook to allow consumers to disable some warnings if they don't
+      # want them to block creating the syntax tree.
+      def valid_warning?(warning)
+        true
+      end
+
+      # Build a diagnostic from the given prism parse error.
+      def error_diagnostic(error, offset_cache)
+        location = error.location
+        diagnostic_location = build_range(location, offset_cache)
+
+        case error.type
+        when :argument_block_multi
+          Diagnostic.new(:error, :block_and_blockarg, {}, diagnostic_location, [])
+        when :argument_formal_constant
+          Diagnostic.new(:error, :argument_const, {}, diagnostic_location, [])
+        when :argument_formal_class
+          Diagnostic.new(:error, :argument_cvar, {}, diagnostic_location, [])
+        when :argument_formal_global
+          Diagnostic.new(:error, :argument_gvar, {}, diagnostic_location, [])
+        when :argument_formal_ivar
+          Diagnostic.new(:error, :argument_ivar, {}, diagnostic_location, [])
+        when :argument_no_forwarding_amp
+          Diagnostic.new(:error, :no_anonymous_blockarg, {}, diagnostic_location, [])
+        when :argument_no_forwarding_star
+          Diagnostic.new(:error, :no_anonymous_restarg, {}, diagnostic_location, [])
+        when :argument_no_forwarding_star_star
+          Diagnostic.new(:error, :no_anonymous_kwrestarg, {}, diagnostic_location, [])
+        when :begin_lonely_else
+          location = location.copy(length: 4)
+          diagnostic_location = build_range(location, offset_cache)
+          Diagnostic.new(:error, :useless_else, {}, diagnostic_location, [])
+        when :class_name, :module_name
+          Diagnostic.new(:error, :module_name_const, {}, diagnostic_location, [])
+        when :class_in_method
+          Diagnostic.new(:error, :class_in_def, {}, diagnostic_location, [])
+        when :def_endless_setter
+          Diagnostic.new(:error, :endless_setter, {}, diagnostic_location, [])
+        when :embdoc_term
+          Diagnostic.new(:error, :embedded_document, {}, diagnostic_location, [])
+        when :incomplete_variable_class, :incomplete_variable_class_3_3_0
+          location = location.copy(length: location.length + 1)
+          diagnostic_location = build_range(location, offset_cache)
+
+          Diagnostic.new(:error, :cvar_name, { name: location.slice }, diagnostic_location, [])
+        when :incomplete_variable_instance, :incomplete_variable_instance_3_3_0
+          location = location.copy(length: location.length + 1)
+          diagnostic_location = build_range(location, offset_cache)
+
+          Diagnostic.new(:error, :ivar_name, { name: location.slice }, diagnostic_location, [])
+        when :invalid_variable_global, :invalid_variable_global_3_3_0
+          Diagnostic.new(:error, :gvar_name, { name: location.slice }, diagnostic_location, [])
+        when :module_in_method
+          Diagnostic.new(:error, :module_in_def, {}, diagnostic_location, [])
+        when :numbered_parameter_ordinary
+          Diagnostic.new(:error, :ordinary_param_defined, {}, diagnostic_location, [])
+        when :numbered_parameter_outer_scope
+          Diagnostic.new(:error, :numparam_used_in_outer_scope, {}, diagnostic_location, [])
+        when :parameter_circular
+          Diagnostic.new(:error, :circular_argument_reference, { var_name: location.slice }, diagnostic_location, [])
+        when :parameter_name_repeat
+          Diagnostic.new(:error, :duplicate_argument, {}, diagnostic_location, [])
+        when :parameter_numbered_reserved
+          Diagnostic.new(:error, :reserved_for_numparam, { name: location.slice }, diagnostic_location, [])
+        when :regexp_unknown_options
+          Diagnostic.new(:error, :regexp_options, { options: location.slice[1..] }, diagnostic_location, [])
+        when :singleton_for_literals
+          Diagnostic.new(:error, :singleton_literal, {}, diagnostic_location, [])
+        when :string_literal_eof
+          Diagnostic.new(:error, :string_eof, {}, diagnostic_location, [])
+        when :unexpected_token_ignore
+          Diagnostic.new(:error, :unexpected_token, { token: location.slice }, diagnostic_location, [])
+        when :write_target_in_method
+          Diagnostic.new(:error, :dynamic_const, {}, diagnostic_location, [])
+        else
+          PrismDiagnostic.new(error.message, :error, error.type, diagnostic_location)
+        end
+      end
+
+      # Build a diagnostic from the given prism parse warning.
+      def warning_diagnostic(warning, offset_cache)
+        diagnostic_location = build_range(warning.location, offset_cache)
+
+        case warning.type
+        when :ambiguous_first_argument_plus
+          Diagnostic.new(:warning, :ambiguous_prefix, { prefix: "+" }, diagnostic_location, [])
+        when :ambiguous_first_argument_minus
+          Diagnostic.new(:warning, :ambiguous_prefix, { prefix: "-" }, diagnostic_location, [])
+        when :ambiguous_prefix_ampersand
+          Diagnostic.new(:warning, :ambiguous_prefix, { prefix: "&" }, diagnostic_location, [])
+        when :ambiguous_prefix_star
+          Diagnostic.new(:warning, :ambiguous_prefix, { prefix: "*" }, diagnostic_location, [])
+        when :ambiguous_prefix_star_star
+          Diagnostic.new(:warning, :ambiguous_prefix, { prefix: "**" }, diagnostic_location, [])
+        when :ambiguous_slash
+          Diagnostic.new(:warning, :ambiguous_regexp, {}, diagnostic_location, [])
+        when :dot_dot_dot_eol
+          Diagnostic.new(:warning, :triple_dot_at_eol, {}, diagnostic_location, [])
+        when :duplicated_hash_key
+          # skip, parser does this on its own
+        else
+          PrismDiagnostic.new(warning.message, :warning, warning.type, diagnostic_location)
+        end
+      end
+
       # If there was a error generated during the parse, then raise an
       # appropriate syntax error. Otherwise return the result.
       def unwrap(result, offset_cache)
         result.errors.each do |error|
           next unless valid_error?(error)
+          diagnostics.process(error_diagnostic(error, offset_cache))
+        end
 
-          location = build_range(error.location, offset_cache)
-          diagnostics.process(Diagnostic.new(error.message, location))
+        result.warnings.each do |warning|
+          next unless valid_warning?(warning)
+          diagnostic = warning_diagnostic(warning, offset_cache)
+          diagnostics.process(diagnostic) if diagnostic
         end
 
         result
@@ -156,7 +268,7 @@ module Prism
 
       # Build the parser gem tokens from the prism tokens.
       def build_tokens(tokens, offset_cache)
-        Lexer.new(source_buffer, tokens.map(&:first), offset_cache).to_a
+        Lexer.new(source_buffer, tokens, offset_cache).to_a
       end
 
       # Build a range from a prism location.
@@ -168,6 +280,18 @@ module Prism
         )
       end
 
+      # Converts the version format handled by Parser to the format handled by Prism.
+      def convert_for_prism(version)
+        case version
+        when 33
+          "3.3.0"
+        when 34
+          "3.4.0"
+        else
+          "latest"
+        end
+      end
+
       require_relative "parser/compiler"
       require_relative "parser/lexer"
 

data/lib/prism/translation/parser33.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Prism
+  module Translation
+    # This class is the entry-point for Ruby 3.3 of `Prism::Translation::Parser`.
+    class Parser33 < Parser
+      def version # :nodoc:
+        33
+      end
+    end
+  end
+end

data/lib/prism/translation/parser34.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Prism
+  module Translation
+    # This class is the entry-point for Ruby 3.4 of `Prism::Translation::Parser`.
+    class Parser34 < Parser
+      def version # :nodoc:
+        34
+      end
+    end
+  end
+end

data/lib/prism/translation/ripper/sexp.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "../ripper"
+
+module Prism
+  module Translation
+    class Ripper
+      # This class mirrors the ::Ripper::SexpBuilder subclass of ::Ripper that
+      # returns the arrays of [type, *children].
+      class SexpBuilder < Ripper
+        # :stopdoc:
+
+        attr_reader :error
+
+        private
+
+        def dedent_element(e, width)
+          if (n = dedent_string(e[1], width)) > 0
+            e[2][1] += n
+          end
+          e
+        end
+
+        def on_heredoc_dedent(val, width)
+          sub = proc do |cont|
+            cont.map! do |e|
+              if Array === e
+                case e[0]
+                when :@tstring_content
+                  e = dedent_element(e, width)
+                when /_add\z/
+                  e[1] = sub[e[1]]
+                end
+              elsif String === e
+                dedent_string(e, width)
+              end
+              e
+            end
+          end
+          sub[val]
+          val
+        end
+
+        events = private_instance_methods(false).grep(/\Aon_/) {$'.to_sym}
+        (PARSER_EVENTS - events).each do |event|
+          module_eval(<<-End, __FILE__, __LINE__ + 1)
+            def on_#{event}(*args)
+              args.unshift :#{event}
+            end
+          End
+        end
+
+        SCANNER_EVENTS.each do |event|
+          module_eval(<<-End, __FILE__, __LINE__ + 1)
+            def on_#{event}(tok)
+              [:@#{event}, tok, [lineno(), column()]]
+            end
+          End
+        end
+
+        def on_error(mesg)
+          @error = mesg
+        end
+        remove_method :on_parse_error
+        alias on_parse_error on_error
+        alias compile_error on_error
+
+        # :startdoc:
+      end
+
+      # This class mirrors the ::Ripper::SexpBuilderPP subclass of ::Ripper that
+      # returns the same values as ::Ripper::SexpBuilder except with a couple of
+      # niceties that flatten linked lists into arrays.
+      class SexpBuilderPP < SexpBuilder
+        # :stopdoc:
+
+        private
+
+        def on_heredoc_dedent(val, width)
+          val.map! do |e|
+            next e if Symbol === e and /_content\z/ =~ e
+            if Array === e and e[0] == :@tstring_content
+              e = dedent_element(e, width)
+            elsif String === e
+              dedent_string(e, width)
+            end
+            e
+          end
+          val
+        end
+
+        def _dispatch_event_new
+          []
+        end
+
+        def _dispatch_event_push(list, item)
+          list.push item
+          list
+        end
+
+        def on_mlhs_paren(list)
+          [:mlhs, *list]
+        end
+
+        def on_mlhs_add_star(list, star)
+          list.push([:rest_param, star])
+        end
+
+        def on_mlhs_add_post(list, post)
+          list.concat(post)
+        end
+
+        PARSER_EVENT_TABLE.each do |event, arity|
+          if /_new\z/ =~ event and arity == 0
+            alias_method "on_#{event}", :_dispatch_event_new
+          elsif /_add\z/ =~ event
+            alias_method "on_#{event}", :_dispatch_event_push
+          end
+        end
+
+        # :startdoc:
+      end
+    end
+  end
+end

data/lib/prism/translation/ripper/shim.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# This writes the prism ripper translation into the Ripper constant so that
+# users can transparently use Ripper without any changes.
+Ripper = Prism::Translation::Ripper