Merge pull request #120 from Shopify/vs/handle_breaking_changes

Upgrade to Ruby LSP v0.8.0 and handle breaking changes

Author: vinistock

Gemfile.lock

@@ -3,7 +3,7 @@ PATH
   specs:
     ruby-lsp-rails (0.2.2)
       rails (>= 6.0)
-      ruby-lsp (>= 0.6.2, < 0.8.0)
+      ruby-lsp (>= 0.8.0, < 0.9.0)
       sorbet-runtime (>= 0.5.9897)
 
 GEM
@@ -197,7 +197,7 @@ GEM
       rubocop (~> 1.51)
     rubocop-sorbet (0.7.2)
       rubocop (>= 0.90.0)
-    ruby-lsp (0.7.6)
+    ruby-lsp (0.8.0)
       language_server-protocol (~> 3.17.0)
       sorbet-runtime
       syntax_tree (>= 6.1.1, < 7)

lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -39,15 +39,13 @@ class CodeLens < ::RubyLsp::Listener
       ResponseType = type_member { { fixed: T::Array[::RubyLsp::Interface::CodeLens] } }
       BASE_COMMAND = "bin/rails test"
 
-      ::RubyLsp::Requests::CodeLens.add_listener(self)
-
       sig { override.returns(ResponseType) }
       attr_reader :response
 
-      sig { params(uri: String, emitter: EventEmitter, message_queue: Thread::Queue).void }
+      sig { params(uri: URI::Generic, emitter: EventEmitter, message_queue: Thread::Queue).void }
       def initialize(uri, emitter, message_queue)
         @response = T.let([], ResponseType)
-        @path = T.let(URI(uri).path, T.nilable(String))
+        @path = T.let(uri.to_standardized_path, T.nilable(String))
         emitter.register(self, :on_command, :on_class, :on_def)
 
         super(emitter, message_queue)
@@ -109,6 +107,8 @@ def on_class(node)
 
       sig { params(node: SyntaxTree::Node, name: String, command: String, kind: Symbol).void }
       def add_test_code_lens(node, name:, command:, kind:)
+        return unless @path
+
         arguments = [
           @path,
           name,

lib/ruby_lsp/ruby_lsp_rails/extension.rb

@@ -12,9 +12,39 @@ module Rails
     class Extension < ::RubyLsp::Extension
       extend T::Sig
 
+      sig { returns(RailsClient) }
+      def client
+        @client ||= T.let(RailsClient.new, T.nilable(RailsClient))
+      end
+
       sig { override.void }
       def activate
-        RubyLsp::Rails::RailsClient.instance.check_if_server_is_running!
+        client.check_if_server_is_running!
+      end
+
+      sig { override.void }
+      def deactivate; end
+
+      # Creates a new CodeLens listener. This method is invoked on every CodeLens request
+      sig do
+        override.params(
+          uri: URI::Generic,
+          emitter: EventEmitter,
+          message_queue: Thread::Queue,
+        ).returns(T.nilable(Listener[T::Array[Interface::CodeLens]]))
+      end
+      def create_code_lens_listener(uri, emitter, message_queue)
+        CodeLens.new(uri, emitter, message_queue)
+      end
+
+      sig do
+        override.params(
+          emitter: EventEmitter,
+          message_queue: Thread::Queue,
+        ).returns(T.nilable(Listener[T.nilable(Interface::Hover)]))
+      end
+      def create_hover_listener(emitter, message_queue)
+        Hover.new(client, emitter, message_queue)
       end
 
       sig { override.returns(String) }

lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -20,22 +20,21 @@ class Hover < ::RubyLsp::Listener
 
       ResponseType = type_member { { fixed: T.nilable(::RubyLsp::Interface::Hover) } }
 
-      ::RubyLsp::Requests::Hover.add_listener(self)
-
       sig { override.returns(ResponseType) }
       attr_reader :response
 
-      sig { params(emitter: RubyLsp::EventEmitter, message_queue: Thread::Queue).void }
-      def initialize(emitter, message_queue)
-        super
+      sig { params(client: RailsClient, emitter: RubyLsp::EventEmitter, message_queue: Thread::Queue).void }
+      def initialize(client, emitter, message_queue)
+        super(emitter, message_queue)
 
         @response = T.let(nil, ResponseType)
+        @client = client
         emitter.register(self, :on_const)
       end
 
       sig { params(node: SyntaxTree::Const).void }
       def on_const(node)
-        model = RailsClient.instance.model(node.value)
+        model = @client.model(node.value)
         return if model.nil?
 
         schema_file = model[:schema_file]

lib/ruby_lsp/ruby_lsp_rails/rails_client.rb

@@ -1,7 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "singleton"
 require "net/http"
 
 module RubyLsp
@@ -10,7 +9,6 @@ class RailsClient
       class ServerAddressUnknown < StandardError; end
 
       extend T::Sig
-      include Singleton
 
       SERVER_NOT_RUNNING_MESSAGE = "Rails server is not running. " \
         "To get Rails features in the editor, boot the Rails server"

ruby-lsp-rails.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_dependency("rails", ">= 6.0")
-  spec.add_dependency("ruby-lsp", ">= 0.6.2", "< 0.8.0")
+  spec.add_dependency("ruby-lsp", ">= 0.8.0", "< 0.9.0")
   spec.add_dependency("sorbet-runtime", ">= 0.5.9897")
 end