Deprecate Prism.lex_ripper

Since `on_sp` is emitted, it doesn't do a whole lot anymore.

Author: Earlopain

bin/prism

@@ -210,18 +210,10 @@ module Prism
 
     # bin/prism lex_compat [source]
     def lex_compat(argv)
+      require "ripper"
       source, filepath = read_source(argv)
 
-      ripper_value =
-        begin
-          Prism.lex_ripper(source)
-        rescue ArgumentError, SyntaxError
-          # If Ripper raises a syntax error, we want to continue as if it didn't
-          # return any tokens at all. prism won't raise a syntax error, so it's
-          # nicer to still be able to see the tokens that prism generated.
-          []
-        end
-
+      ripper_value = Ripper.lex(source)
       prism_compat = Prism.lex_compat(source, filepath: filepath)
       prism = Prism.lex(source, filepath: filepath)
 

lib/prism.rb

@@ -71,8 +71,7 @@ def self.lex_compat(source, **options)
   # :call-seq:
   #   Prism::lex_ripper(source) -> Array
   #
-  # This wraps the result of Ripper.lex. It produces almost exactly the
-  # same tokens. Raises SyntaxError if the syntax in source is invalid.
+  # Deprecated. Directly use `Ripper.lex` instead.
   def self.lex_ripper(source)
     LexRipper.new(source).result # steep:ignore
   end

lib/prism/lex_ripper.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 # :markup: markdown
 
+warn(<<~MSG, uplevel: 4, category: :deprecated)
+  [deprecation]: `Prism.lex_ripper` is deprecated and wil be removed in a future version. \
+  Use `Ripper.lex` directly.
+MSG
+
 require "ripper"
 
 module Prism
@@ -19,13 +24,6 @@ def result
 
       lex(source).each do |token|
         case token[1]
-        when :on_tstring_content
-          if previous[1] == :on_tstring_content && (token[2].start_with?("\#$") || token[2].start_with?("\#@"))
-            previous[2] << token[2]
-          else
-            results << token
-            previous = token
-          end
         when :on_words_sep
           if previous[1] == :on_words_sep
             previous[2] << token[2]

rakelib/lex.rake

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 # typed: ignore
 
+require "ripper"
+
 module Prism
   # This class is responsible for lexing files with both lex_compat and
   # lex_ripper and ensuring they match up. It keeps track of the files which
@@ -28,7 +30,7 @@ module Prism
       end
 
       result = Prism.lex_compat(source)
-      if result.errors.empty? && Prism.lex_ripper(source) == result.value
+      if result.errors.empty? && Ripper.lex(source) == result.value
         @passing_file_count += 1
         true
       else

test/prism/bom_test.rb

@@ -5,6 +5,7 @@
 return if RUBY_ENGINE != "ruby"
 
 require_relative "test_helper"
+require "ripper"
 
 module Prism
   class BOMTest < TestCase
@@ -53,7 +54,7 @@ def test_string
 
     def assert_bom(source)
       bommed = "\xEF\xBB\xBF#{source}"
-      assert_equal Prism.lex_ripper(bommed), Prism.lex_compat(bommed).value
+      assert_equal Ripper.lex(bommed), Prism.lex_compat(bommed).value
     end
   end
 end

test/prism/lex_test.rb

@@ -3,6 +3,7 @@
 return if !(RUBY_ENGINE == "ruby" && RUBY_VERSION >= "3.2.0")
 
 require_relative "test_helper"
+require "ripper"
 
 module Prism
   class LexTest < TestCase
@@ -49,9 +50,19 @@ def test_parse_lex_file
     if RUBY_VERSION >= "3.3"
       def test_lex_compare
         prism = Prism.lex_compat(File.read(__FILE__), version: "current").value
-        ripper = Prism.lex_ripper(File.read(__FILE__))
+        ripper = Ripper.lex(File.read(__FILE__))
         assert_equal(ripper, prism)
       end
     end
+
+    def test_lex_ripper_deprecated
+      warnings = capture_warnings { Prism.lex_ripper("foo") }
+
+      assert_include(warnings, "#{__FILE__}:#{__LINE__ - 2}")
+      assert_include(warnings, "`Prism.lex_ripper` is deprecated")
+
+      warnings = capture_warnings { Prism.lex_ripper("foo") }
+      assert_empty(warnings)
+    end
   end
 end