Extract RubyLsp::TestHelper for addons to use (#1833)

Extract RubyLsp::TestHelper for addons to use

Co-authored-by: Andy Waite <andyw8@users.noreply.github.com>

lib/ruby_lsp/test_helper.rb

@@ -0,0 +1,42 @@
+# typed: strict
+# frozen_string_literal: true
+
+# NOTE: This module is intended to be used by addons for writing their own tests, so keep that in mind if changing.
+
+module RubyLsp
+  module TestHelper
+    extend T::Sig
+
+    sig do
+      type_parameters(:T)
+        .params(
+          source: T.nilable(String),
+          uri: URI::Generic,
+          block: T.proc.params(server: RubyLsp::Server, uri: URI::Generic).returns(T.type_parameter(:T)),
+        ).returns(T.type_parameter(:T))
+    end
+    def with_server(source = nil, uri = Kernel.URI("file:///fake.rb"), &block)
+      server = RubyLsp::Server.new(test_mode: true)
+      server.process_message(method: "initialized")
+
+      if source
+        server.process_message({
+          method: "textDocument/didOpen",
+          params: {
+            textDocument: {
+              uri: uri,
+              text: source,
+              version: 1,
+            },
+          },
+        })
+      end
+
+      index = server.index
+      index.index_single(RubyIndexer::IndexablePath.new(nil, T.must(uri.to_standardized_path)), source)
+      block.call(server, uri)
+    ensure
+      T.must(server).run_shutdown
+    end
+  end
+end

test/test_helper.rb

@@ -18,6 +18,7 @@
 $VERBOSE = nil unless ENV["VERBOSE"] || ENV["CI"]
 
 require_relative "../lib/ruby_lsp/internal"
+require_relative "../lib/ruby_lsp/test_helper"
 require_relative "../lib/rubocop/cop/ruby_lsp/use_language_server_aliases"
 require_relative "../lib/rubocop/cop/ruby_lsp/use_register_with_handler_method"
 
@@ -40,6 +41,7 @@
 module Minitest
   class Test
     extend T::Sig
+    include RubyLsp::TestHelper
 
     Minitest::Test.make_my_diffs_pretty!
 
@@ -50,37 +52,6 @@ def stub_no_typechecker
       RubyLsp::DependencyDetector.instance.stubs(:typechecker).returns(false)
     end
 
-    sig do
-      type_parameters(:T)
-        .params(
-          source: T.nilable(String),
-          uri: URI::Generic,
-          block: T.proc.params(server: RubyLsp::Server, uri: URI::Generic).returns(T.type_parameter(:T)),
-        ).returns(T.type_parameter(:T))
-    end
-    def with_server(source = nil, uri = URI("file:///fake.rb"), &block)
-      server = RubyLsp::Server.new(test_mode: true)
-
-      if source
-        server.process_message({
-          method: "textDocument/didOpen",
-          params: {
-            textDocument: {
-              uri: uri,
-              text: source,
-              version: 1,
-            },
-          },
-        })
-      end
-
-      index = server.index
-      index.index_single(RubyIndexer::IndexablePath.new(nil, T.must(uri.to_standardized_path)), source)
-      block.call(server, uri)
-    ensure
-      T.must(server).run_shutdown
-    end
-
     sig do
       params(
         addon_creation_method: Symbol,