Extract RubyFileChangeHandler

lib/ruby_lsp/file_change_handlers/ruby.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module FileChangeHandlers
+    class Ruby
+      class << self
+        extend T::Sig
+        sig { params(store: Store, index: RubyIndexer::Index, file_path: String, change_type: Integer).void }
+        def change(store, index, file_path, change_type)
+          load_path_entry = $LOAD_PATH.find { |load_path| file_path.start_with?(load_path) }
+          uri = URI::Generic.from_path(load_path_entry: load_path_entry, path: file_path)
+
+          case change_type
+          when Constant::FileChangeType::CREATED
+            content = File.read(file_path)
+            # If we receive a late created notification for a file that has already been claimed by the client, we want to
+            # handle change for that URI so that the require path tree is updated
+            store.key?(uri) ? index.handle_change(uri, content) : index.index_single(uri, content)
+          when Constant::FileChangeType::CHANGED
+            content = File.read(file_path)
+            # We only handle changes on file watched notifications if the client is not the one managing this URI.
+            # Otherwise, these changes are handled when running the combined requests
+            index.handle_change(uri, content) unless store.key?(uri)
+          when Constant::FileChangeType::DELETED
+            index.delete(uri)
+          end
+        rescue Errno::ENOENT
+          # If a file is created and then delete immediately afterwards, we will process the created notification before we
+          # receive the deleted one, but the file no longer exists. This may happen when running a test suite that creates
+          # and deletes files automatically.
+        end
+      end
+    end
+  end
+end

lib/ruby_lsp/internal.rb

@@ -43,6 +43,7 @@
 require "ruby_lsp/rbs_document"
 require "ruby_lsp/store"
 require "ruby_lsp/addon"
+require "ruby_lsp/file_change_handlers/ruby"
 
 # Response builders
 require "ruby_lsp/response_builders/response_builder"

lib/ruby_lsp/server.rb

@@ -1025,7 +1025,7 @@ def workspace_did_change_watched_files(message)
         next if file_path.nil? || File.directory?(file_path)
 
         if file_path.end_with?(".rb")
-          handle_ruby_file_change(index, file_path, change[:type])
+          FileChangeHandlers::Ruby.change(@store, index, file_path, change[:type])
           next
         end
 
@@ -1046,31 +1046,6 @@ def workspace_did_change_watched_files(message)
       end
     end
 
-    sig { params(index: RubyIndexer::Index, file_path: String, change_type: Integer).void }
-    def handle_ruby_file_change(index, file_path, change_type)
-      load_path_entry = $LOAD_PATH.find { |load_path| file_path.start_with?(load_path) }
-      uri = URI::Generic.from_path(load_path_entry: load_path_entry, path: file_path)
-
-      case change_type
-      when Constant::FileChangeType::CREATED
-        content = File.read(file_path)
-        # If we receive a late created notification for a file that has already been claimed by the client, we want to
-        # handle change for that URI so that the require path tree is updated
-        @store.key?(uri) ? index.handle_change(uri, content) : index.index_single(uri, content)
-      when Constant::FileChangeType::CHANGED
-        content = File.read(file_path)
-        # We only handle changes on file watched notifications if the client is not the one managing this URI.
-        # Otherwise, these changes are handled when running the combined requests
-        index.handle_change(uri, content) unless @store.key?(uri)
-      when Constant::FileChangeType::DELETED
-        index.delete(uri)
-      end
-    rescue Errno::ENOENT
-      # If a file is created and then delete immediately afterwards, we will process the created notification before we
-      # receive the deleted one, but the file no longer exists. This may happen when running a test suite that creates
-      # and deletes files automatically.
-    end
-
     sig { params(uri: URI::Generic).void }
     def handle_rubocop_config_change(uri)
       return unless defined?(Requests::Support::RuboCopFormatter)

test/file_change_handlers/ruby.rb

@@ -0,0 +1,142 @@
+# typed: true
+# frozen_string_literal: true
+
+require "test_helper"
+
+module RubyLsp
+  module FileChangeHandlers
+    class RubyTest < Minitest::Test
+      def setup
+        @server = RubyLsp::Server.new(test_mode: true)
+      end
+
+      def teardown
+        @server.run_shutdown
+      end
+
+      def test_did_change_watched_files_does_not_fail_for_non_existing_files
+        @server.process_message({
+          method: "workspace/didChangeWatchedFiles",
+          params: {
+            changes: [
+              {
+                uri: URI::Generic.from_path(path: File.join(Dir.pwd, "lib", "non_existing.rb")).to_s,
+                type: RubyLsp::Constant::FileChangeType::CREATED,
+              },
+            ],
+          },
+        })
+
+        assert_raises(Timeout::Error) do
+          Timeout.timeout(0.5) do
+            notification = find_message(RubyLsp::Notification, "window/logMessage")
+            flunk(notification.params.message)
+          end
+        end
+      end
+
+      def test_did_change_watched_files_handles_deletions
+        path = File.join(Dir.pwd, "lib", "foo.rb")
+
+        @server.global_state.index.expects(:delete).once.with do |uri|
+          uri.full_path == path
+        end
+
+        uri = URI::Generic.from_path(path: path)
+
+        @server.process_message({
+          method: "workspace/didChangeWatchedFiles",
+          params: {
+            changes: [
+              {
+                uri: uri,
+                type: RubyLsp::Constant::FileChangeType::DELETED,
+              },
+            ],
+          },
+        })
+      end
+
+      def test_did_change_watched_files_reports_addon_errors
+        Class.new(RubyLsp::Addon) do
+          def activate(global_state, outgoing_queue); end
+
+          def workspace_did_change_watched_files(changes)
+            raise StandardError, "boom"
+          end
+
+          def name
+            "Foo"
+          end
+
+          def deactivate; end
+
+          def version
+            "0.1.0"
+          end
+        end
+
+        Class.new(RubyLsp::Addon) do
+          def activate(global_state, outgoing_queue); end
+
+          def workspace_did_change_watched_files(changes)
+          end
+
+          def name
+            "Bar"
+          end
+
+          def deactivate; end
+
+          def version
+            "0.1.0"
+          end
+        end
+
+        @server.load_addons
+
+        bar = RubyLsp::Addon.get("Bar", "0.1.0")
+        bar.expects(:workspace_did_change_watched_files).once
+
+        begin
+          @server.process_message({
+            method: "workspace/didChangeWatchedFiles",
+            params: {
+              changes: [
+                {
+                  uri: URI::Generic.from_path(path: File.join(Dir.pwd, ".rubocop.yml")).to_s,
+                  type: RubyLsp::Constant::FileChangeType::CREATED,
+                },
+              ],
+            },
+          })
+
+          message = @server.pop_response.params.message
+          assert_match("Error in Foo add-on while processing watched file notifications", message)
+          assert_match("boom", message)
+        ensure
+          RubyLsp::Addon.unload_addons
+        end
+      end
+
+      def test_did_change_watched_files_processes_unique_change_entries
+        @server.expects(:handle_rubocop_config_change).once
+        @server.process_message({
+          method: "workspace/didChangeWatchedFiles",
+          params: {
+            changes: [
+              {
+                uri: URI::Generic.from_path(path: File.join(Dir.pwd, ".rubocop.yml")).to_s,
+                type: RubyLsp::Constant::FileChangeType::CHANGED,
+              },
+              {
+                uri: URI::Generic.from_path(path: File.join(Dir.pwd, ".rubocop.yml")).to_s,
+                type: RubyLsp::Constant::FileChangeType::CHANGED,
+              },
+            ],
+          },
+        })
+      end
+    end
+  end
+end

test/server_test.rb

@@ -500,130 +500,6 @@ def test_changed_file_only_indexes_ruby
     FileUtils.rm(T.must(path))
   end
 
-  def test_did_change_watched_files_does_not_fail_for_non_existing_files
-    @server.process_message({
-      method: "workspace/didChangeWatchedFiles",
-      params: {
-        changes: [
-          {
-            uri: URI::Generic.from_path(path: File.join(Dir.pwd, "lib", "non_existing.rb")).to_s,
-            type: RubyLsp::Constant::FileChangeType::CREATED,
-          },
-        ],
-      },
-    })
-
-    assert_raises(Timeout::Error) do
-      Timeout.timeout(0.5) do
-        notification = find_message(RubyLsp::Notification, "window/logMessage")
-        flunk(notification.params.message)
-      end
-    end
-  end
-
-  def test_did_change_watched_files_handles_deletions
-    path = File.join(Dir.pwd, "lib", "foo.rb")
-
-    @server.global_state.index.expects(:delete).once.with do |uri|
-      uri.full_path == path
-    end
-
-    uri = URI::Generic.from_path(path: path)
-
-    @server.process_message({
-      method: "workspace/didChangeWatchedFiles",
-      params: {
-        changes: [
-          {
-            uri: uri,
-            type: RubyLsp::Constant::FileChangeType::DELETED,
-          },
-        ],
-      },
-    })
-  end
-
-  def test_did_change_watched_files_reports_addon_errors
-    Class.new(RubyLsp::Addon) do
-      def activate(global_state, outgoing_queue); end
-
-      def workspace_did_change_watched_files(changes)
-        raise StandardError, "boom"
-      end
-
-      def name
-        "Foo"
-      end
-
-      def deactivate; end
-
-      def version
-        "0.1.0"
-      end
-    end
-
-    Class.new(RubyLsp::Addon) do
-      def activate(global_state, outgoing_queue); end
-
-      def workspace_did_change_watched_files(changes)
-      end
-
-      def name
-        "Bar"
-      end
-
-      def deactivate; end
-
-      def version
-        "0.1.0"
-      end
-    end
-
-    @server.load_addons
-
-    bar = RubyLsp::Addon.get("Bar", "0.1.0")
-    bar.expects(:workspace_did_change_watched_files).once
-
-    begin
-      @server.process_message({
-        method: "workspace/didChangeWatchedFiles",
-        params: {
-          changes: [
-            {
-              uri: URI::Generic.from_path(path: File.join(Dir.pwd, ".rubocop.yml")).to_s,
-              type: RubyLsp::Constant::FileChangeType::CREATED,
-            },
-          ],
-        },
-      })
-
-      message = @server.pop_response.params.message
-      assert_match("Error in Foo add-on while processing watched file notifications", message)
-      assert_match("boom", message)
-    ensure
-      RubyLsp::Addon.unload_addons
-    end
-  end
-
-  def test_did_change_watched_files_processes_unique_change_entries
-    @server.expects(:handle_rubocop_config_change).once
-    @server.process_message({
-      method: "workspace/didChangeWatchedFiles",
-      params: {
-        changes: [
-          {
-            uri: URI::Generic.from_path(path: File.join(Dir.pwd, ".rubocop.yml")).to_s,
-            type: RubyLsp::Constant::FileChangeType::CHANGED,
-          },
-          {
-            uri: URI::Generic.from_path(path: File.join(Dir.pwd, ".rubocop.yml")).to_s,
-            type: RubyLsp::Constant::FileChangeType::CHANGED,
-          },
-        ],
-      },
-    })
-  end
-
   def test_workspace_addons
     create_test_addons
     @server.load_addons