Use rails lsp native addons (#2)

Author: johansenja

Gemfile

@@ -8,5 +8,3 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rubocop", "~> 1.21"
-
-gem "ruby-lsp-rails", git: "https://github.com/johansenja/ruby-lsp-rails.git", branch: "extend-runtime-server"

Gemfile.lock

@@ -1,18 +1,10 @@
-GIT
-  remote: https://github.com/johansenja/ruby-lsp-rails.git
-  revision: 31533663d38992acdc6f4d3ba5d41b3e9c83fd58
-  branch: extend-runtime-server
-  specs:
-    ruby-lsp-rails (0.3.13)
-      ruby-lsp (>= 0.17.12, < 0.18.0)
-
 PATH
   remote: .
   specs:
-    ruby-lsp-rails-factory-bot (0.1.0)
+    ruby-lsp-rails-factory-bot (0.2.0)
       factory_bot (~> 6.4.6)
-      ruby-lsp (~> 0.17.17)
-      ruby-lsp-rails
+      ruby-lsp (~> 0.23)
+      ruby-lsp-rails (~> 0.4)
 
 GEM
   remote: https://rubygems.org/
@@ -46,11 +38,11 @@ GEM
     parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
-    prism (1.0.0)
+    prism (1.3.0)
     racc (1.8.0)
     rainbow (3.1.1)
     rake (13.2.1)
-    rbs (3.5.3)
+    rbs (3.6.0)
       logger
     regexp_parser (2.9.2)
     rexml (3.3.2)
@@ -68,14 +60,16 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    ruby-lsp (0.17.17)
+    ruby-lsp (0.23.10)
       language_server-protocol (~> 3.17.0)
-      prism (~> 1.0)
+      prism (>= 1.2, < 2.0)
       rbs (>= 3, < 4)
       sorbet-runtime (>= 0.5.10782)
+    ruby-lsp-rails (0.4.0)
+      ruby-lsp (>= 0.23.0, < 0.24.0)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)
-    sorbet-runtime (0.5.11554)
+    sorbet-runtime (0.5.11589)
     strscan (3.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -88,7 +82,6 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 13.0)
   rubocop (~> 1.21)
-  ruby-lsp-rails!
   ruby-lsp-rails-factory-bot!
 
 BUNDLED WITH

lib/ruby_lsp/rails/factory_bot/addon.rb

@@ -1,49 +1,59 @@
 # frozen_string_literal: true
 
 require "ruby_lsp/addon"
-require "ruby_lsp_rails/runner_client"
+require "ruby_lsp/ruby_lsp_rails/runner_client"
 
 require_relative "completion"
 require_relative "hover"
-require_relative "server_extension"
+require_relative "addon_name"
 
 module RubyLsp
   module Rails
     module FactoryBot
       class Addon < ::RubyLsp::Addon
         def activate(global_state, *)
+          runner_client.register_server_addon(File.expand_path("server_addon.rb", __dir__))
+
           @ruby_index = global_state.index
         end
 
         def deactivate(*); end
 
         def name
-          "ruby-lsp-rails-factory-bot"
+          FactoryBot::ADDON_NAME
         end
 
         def create_completion_listener(response_builder, node_context, dispatcher, uri)
           path = uri.to_standardized_path
           return unless path&.end_with?("_test.rb") || path&.end_with?("_spec.rb")
           return unless factory_bot_call_args?(node_context)
 
-          Completion.new(response_builder, node_context, dispatcher, RubyLsp::Rails::RunnerClient.instance)
+          Completion.new(response_builder, node_context, dispatcher, runner_client)
         end
 
         def create_hover_listener(response_builder, node_context, dispatcher)
           # TODO: need URI param
-          Hover.new(response_builder, node_context, dispatcher, RubyLsp::Rails::RunnerClient.instance, @ruby_index)
+          Hover.new(response_builder, node_context, dispatcher, runner_client, @ruby_index)
         end
 
         def workspace_did_change_watched_files(changes)
           return unless changes.any? do |change|
             change[:uri].match?(/(?:spec|test).+factor.+\.rb/)
           end
 
-          RubyLsp::Rails::RunnerClient.instance.trigger_reload
+          runner_client.trigger_reload
         end
 
         private
 
+        def runner_client
+          @rails_addon ||= ::RubyLsp::Addon.get(
+            "Ruby LSP Rails",
+            ::RubyLsp::Rails::FactoryBot::REQUIRED_RUBY_LSP_RAILS_VERSION
+          )
+          @rails_addon.rails_runner_client
+        end
+
         FACTORY_BOT_METHODS = %i[
           create
           build

lib/ruby_lsp/rails/factory_bot/addon_name.rb

@@ -0,0 +1,7 @@
+module RubyLsp
+  module Rails
+    module FactoryBot
+      ADDON_NAME = "ruby-lsp-rails-factory-bot".freeze
+    end
+  end
+end

lib/ruby_lsp/rails/factory_bot/completion.rb

@@ -2,6 +2,8 @@
 
 require "ruby_lsp/internal"
 
+require_relative "addon_name"
+
 module RubyLsp
   module Rails
     module FactoryBot
@@ -57,8 +59,10 @@ def on_call_node_enter(node)
         private
 
         def handle_attribute(factory_name, node, value = "")
-          @server_client.get_attributes(factory_name: factory_name, name: value)&.each do |attr|
-            $stderr.write "attribute", attr
+          make_request(
+            :attributes,
+            factory_name: factory_name, name: value
+          )&.each do |attr|
             label_details = Interface::CompletionItemLabelDetails.new(
               description: attr[:type],
             )
@@ -79,8 +83,10 @@ def handle_attribute(factory_name, node, value = "")
         end
 
         def handle_trait(factory_name, node, value = "")
-          @server_client.get_traits(factory_name: factory_name, name: value)&.each do |tr|
-            $stderr.write "trait", tr
+          make_request(
+            :traits,
+            factory_name: factory_name, name: value
+          )&.each do |tr|
             label_details = Interface::CompletionItemLabelDetails.new(
               description: tr[:owner],
             )
@@ -103,8 +109,7 @@ def handle_trait(factory_name, node, value = "")
         end
 
         def handle_factory(node, name)
-          @server_client.get_factories(name: name)&.each do |fact|
-            $stderr.write "factory", fact
+          make_request(:factories, name: name)&.each do |fact|
             @response_builder << Interface::CompletionItem.new(
               label: fact[:name],
               filter_text: fact[:name],
@@ -122,6 +127,14 @@ def handle_factory(node, name)
             )
           end
         end
+
+        def make_request(request_name, **params)
+          @server_client.delegate_request(
+            server_addon_name: FactoryBot::ADDON_NAME,
+            request_name: request_name,
+            **params
+          )
+        end
       end
     end
   end

lib/ruby_lsp/rails/factory_bot/hover.rb

@@ -2,6 +2,8 @@
 
 require "ruby_lsp/internal"
 
+require_relative "addon_name"
+
 module RubyLsp
   module Rails
     module FactoryBot
@@ -61,7 +63,8 @@ def on_symbol_node_enter(symbol_node)
 
         def handle_attribute(symbol_node, factory_node)
           name = symbol_node.value.to_s
-          attribute = @server_client.get_attributes(
+          attribute = make_request(
+            :attributes,
             factory_name: factory_node.value.to_s, name: name
           )&.find { |attr| attr[:name] == name }
 
@@ -76,7 +79,10 @@ def handle_attribute(symbol_node, factory_node)
         def handle_factory(symbol_node)
           name = symbol_node.value.to_s
 
-          factory = @server_client.get_factories(name: name)&.find { |f| f[:name] == name }
+          factory = make_request(
+            :factories,
+            name: name
+          )&.find { |f| f[:name] == name }
 
           return unless factory
 
@@ -102,7 +108,8 @@ def handle_trait(symbol_node, factory_node)
           factory_name = factory_node.value.to_s
           trait_name = symbol_node.value.to_s
 
-          trait = @server_client.get_traits(
+          trait = make_request(
+            :traits,
             factory_name: factory_name, name: trait_name
           )&.find { |tr| tr[:name] == trait_name }
 
@@ -113,6 +120,14 @@ def handle_trait(symbol_node, factory_node)
             category: :documentation
           )
         end
+
+        def make_request(request_name, **params)
+          @server_client.delegate_request(
+            server_addon_name: FactoryBot::ADDON_NAME,
+            request_name: request_name,
+            **params
+          )
+        end
       end
     end
   end