Migrate Ruby LSP add-on to RBS comments

Author: vinistock

lib/ruby_lsp/tapioca/addon.rb

@@ -18,8 +18,6 @@
 module RubyLsp
   module Tapioca
     class Addon < ::RubyLsp::Addon
-      extend T::Sig
-
       #: -> void
       def initialize
         super
@@ -44,7 +42,7 @@ def activate(global_state, outgoing_queue)
           # Get a handle to the Rails add-on's runtime client. The call to `rails_runner_client` will block this thread
           # until the server has finished booting, but it will not block the main LSP. This has to happen inside of a
           # thread
-          addon = T.cast(::RubyLsp::Addon.get("Ruby LSP Rails", ">= 0.4.0", "< 0.5"), ::RubyLsp::Rails::Addon)
+          addon = ::RubyLsp::Addon.get("Ruby LSP Rails", ">= 0.4.0", "< 0.5") #: as ::RubyLsp::Rails::Addon
           @rails_runner_client = addon.rails_runner_client
           @outgoing_queue << Notification.window_log_message("Activating Tapioca add-on v#{version}")
           @rails_runner_client.register_server_addon(File.expand_path("server_addon.rb", __dir__))
@@ -93,10 +91,11 @@ def workspace_did_change_watched_files(changes)
         has_route_change = false #: bool
         has_fixtures_change = false #: bool
         needs_compiler_reload = false #: bool
+        index = @index #: as !nil
 
         constants = changes.flat_map do |change|
-          path = URI(change[:uri]).to_standardized_path
-          next unless file_updated?(change, path)
+          path = URI(change[:uri]).to_standardized_path #: String?
+          next unless path && file_updated?(change, path)
 
           if File.fnmatch("**/fixtures/**/*.yml{,.erb}", path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
             has_fixtures_change = true
@@ -115,7 +114,7 @@ def workspace_did_change_watched_files(changes)
             next
           end
 
-          entries = T.must(@index).entries_for(change[:uri])
+          entries = index.entries_for(change[:uri])
           next unless entries
 
           entries.filter_map do |entry|
@@ -178,14 +177,16 @@ def send_usage_telemetry(feature_name)
 
       #: (Hash[Symbol, untyped] change, String path) -> bool
       def file_updated?(change, path)
+        queue = @outgoing_queue #: as !nil
+
         case change[:type]
         when Constant::FileChangeType::CREATED
           @file_checksums[path] = Zlib.crc32(File.read(path)).to_s
           return true
         when Constant::FileChangeType::CHANGED
           current_checksum = Zlib.crc32(File.read(path)).to_s
           if @file_checksums[path] == current_checksum
-            T.must(@outgoing_queue) << Notification.window_log_message(
+            queue << Notification.window_log_message(
               "File has not changed. Skipping #{path}",
               type: Constant::MessageType::INFO,
             )
@@ -196,7 +197,7 @@ def file_updated?(change, path)
         when Constant::FileChangeType::DELETED
           @file_checksums.delete(path)
         else
-          T.must(@outgoing_queue) << Notification.window_log_message(
+          queue << Notification.window_log_message(
             "Unexpected file change type: #{change[:type]}",
             type: Constant::MessageType::WARNING,
           )
@@ -207,16 +208,16 @@ def file_updated?(change, path)
 
       #: -> void
       def run_gem_rbi_check
-        gem_rbi_check = RunGemRbiCheck.new(T.must(@global_state).workspace_path)
+        state = @global_state #: as !nil
+        gem_rbi_check = RunGemRbiCheck.new(state.workspace_path)
         gem_rbi_check.run
 
-        T.must(@outgoing_queue) << Notification.window_log_message(
-          gem_rbi_check.stdout,
-        ) unless gem_rbi_check.stdout.empty?
-        T.must(@outgoing_queue) << Notification.window_log_message(
-          gem_rbi_check.stderr,
-          type: Constant::MessageType::WARNING,
-        ) unless gem_rbi_check.stderr.empty?
+        queue = @outgoing_queue #: as !nil
+        queue << Notification.window_log_message(gem_rbi_check.stdout) unless gem_rbi_check.stdout.empty?
+
+        unless gem_rbi_check.stderr.empty?
+          queue << Notification.window_log_message(gem_rbi_check.stderr, type: Constant::MessageType::WARNING)
+        end
       end
     end
   end

lib/ruby_lsp/tapioca/run_gem_rbi_check.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "open3"
@@ -7,10 +7,10 @@
 module RubyLsp
   module Tapioca
     class RunGemRbiCheck
-      extend T::Sig
+      #: String
+      attr_reader :stdout, :stderr
 
-      attr_reader :stdout
-      attr_reader :stderr
+      #: Process::Status?
       attr_reader :status
 
       #: (String project_path) -> void
@@ -34,11 +34,9 @@ def run
 
       private
 
-      attr_reader :project_path
-
       #: -> bool?
       def git_repo?
-        _, status = Open3.capture2e("git", "rev-parse", "--is-inside-work-tree", chdir: project_path)
+        _, status = Open3.capture2e("git", "rev-parse", "--is-inside-work-tree", chdir: @project_path)
         status.success?
       end
 
@@ -49,7 +47,7 @@ def lockfile_changed?
 
       #: -> Pathname
       def lockfile
-        @lockfile ||= Pathname(project_path).join("Gemfile.lock") #: Pathname?
+        @lockfile ||= Pathname(@project_path).join("Gemfile.lock") #: Pathname?
       end
 
       #: -> String
@@ -81,15 +79,16 @@ def generate_gem_rbis
       #: (Array[String] gems) -> void
       def execute_tapioca_gem_command(gems)
         Bundler.with_unbundled_env do
-          stdout, stderr, status = T.unsafe(Open3).capture3(
-            "bundle",
-            "exec",
-            "tapioca",
-            "gem",
-            "--lsp_addon",
-            *gems,
-            chdir: project_path,
-          )
+          stdout, stderr, status = Open3 #: as untyped
+            .capture3(
+              "bundle",
+              "exec",
+              "tapioca",
+              "gem",
+              "--lsp_addon",
+              *gems,
+              chdir: @project_path,
+            )
 
           log_message(stdout) unless stdout.empty?
           @stderr = stderr unless stderr.empty?
@@ -101,7 +100,7 @@ def execute_tapioca_gem_command(gems)
       def remove_rbis(gems)
         files = Dir.glob(
           "sorbet/rbi/gems/{#{gems.join(",")}}@*.rbi",
-          base: project_path,
+          base: @project_path,
         )
         delete_files(files, "Removed RBIs for")
       end
@@ -117,16 +116,15 @@ def cleanup_orphaned_rbis
 
       #: (*untyped flags) -> Array[String]
       def git_ls_gem_rbis(*flags)
-        flags = T.unsafe(["git", "ls-files", *flags, "sorbet/rbi/gems/"])
-
-        execute_in_project_path(*flags)
+        self #: as untyped # rubocop:disable Style/RedundantSelf
+          .execute_in_project_path("git", "ls-files", *flags, "sorbet/rbi/gems/")
           .lines
           .map(&:strip)
       end
 
       #: (Array[String] files, String message) -> void
       def delete_files(files, message)
-        files_to_remove = files.map { |file| File.join(project_path, file) }
+        files_to_remove = files.map { |file| File.join(@project_path, file) }
         FileUtils.rm(files_to_remove)
         log_message("#{message}: #{files.join(", ")}") unless files.empty?
       end
@@ -142,10 +140,12 @@ def log_message(message)
         @stdout += "#{message}\n"
       end
 
+      #: (*String, ?stdin: String?) -> String
       def execute_in_project_path(*parts, stdin: nil)
-        options = { chdir: project_path }
+        options = { chdir: @project_path }
         options[:stdin_data] = stdin if stdin
-        stdout_and_stderr, _status = T.unsafe(Open3).capture2e(*parts, options)
+        stdout_and_stderr, _status = Open3 #: as untyped
+          .capture2e(*parts, options)
         stdout_and_stderr
       end
     end

spec/tapioca/addon_spec.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require "spec_helper"
-require "language_server-protocol"
 require "ruby_lsp/internal"
 require "ruby_lsp/ruby_lsp_rails/addon"
 require "ruby_lsp/tapioca/addon"