ruby-lsp-rails 0.3.31 → 0.4.1

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -3,19 +3,42 @@
 
 require "json"
 require "open3"
+require "delegate"
 
 module RubyLsp
   module Rails
     module Common
-      # Write a message to the client. Can be used for sending notifications to the editor
-      def send_message(message)
-        json_message = message.to_json
-        @stdout.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+      class Progress
+        def initialize(stderr, id, supports_progress)
+          @stderr = stderr
+          @id = id
+          @supports_progress = supports_progress
+        end
+
+        def report(percentage: nil, message: nil)
+          return unless @supports_progress
+          return unless percentage || message
+
+          json_message = {
+            method: "$/progress",
+            params: {
+              token: @id,
+              value: {
+                kind: "report",
+                percentage: percentage,
+                message: message,
+              },
+            },
+          }.to_json
+
+          @stderr.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+        end
       end
 
-      # Log a message to the editor's output panel
-      def log_message(message)
-        $stderr.puts(message)
+      # Log a message to the editor's output panel. The type is the number of the message type, which can be found in
+      # the specification https://microsoft.github.io/language-server-protocol/specification/#messageType
+      def log_message(message, type: 4)
+        send_notification({ method: "window/logMessage", params: { type: type, message: message } })
       end
 
       # Sends an error result to a request, if the request failed. DO NOT INVOKE THIS METHOD FOR NOTIFICATIONS! Use
@@ -54,6 +77,82 @@ module RubyLsp
       rescue => e
         log_message("Request #{notification_name} failed:\n#{e.full_message(highlight: false)}")
       end
+
+      def begin_progress(id, title, percentage: nil, message: nil)
+        return unless @capabilities[:supports_progress]
+
+        # This is actually a request, but it is sent asynchronously and we do not return the response back to the
+        # server, so we consider it a notification from the perspective of the client/runtime server dynamic
+        send_notification({
+          id: "progress-request-#{id}",
+          method: "window/workDoneProgress/create",
+          params: { token: id },
+        })
+
+        send_notification({
+          method: "$/progress",
+          params: {
+            token: id,
+            value: {
+              kind: "begin",
+              title: title,
+              percentage: percentage,
+              message: message,
+            },
+          },
+        })
+      end
+
+      def report_progress(id, percentage: nil, message: nil)
+        return unless @capabilities[:supports_progress]
+
+        send_notification({
+          method: "$/progress",
+          params: {
+            token: id,
+            value: {
+              kind: "report",
+              percentage: percentage,
+              message: message,
+            },
+          },
+        })
+      end
+
+      def end_progress(id)
+        return unless @capabilities[:supports_progress]
+
+        send_notification({
+          method: "$/progress",
+          params: {
+            token: id,
+            value: { kind: "end" },
+          },
+        })
+      end
+
+      def with_progress(id, title, percentage: nil, message: nil, &block)
+        progress_block = Progress.new(@stderr, id, @capabilities[:supports_progress])
+        return block.call(progress_block) unless @capabilities[:supports_progress]
+
+        begin_progress(id, title, percentage: percentage, message: message)
+        block.call(progress_block)
+        end_progress(id)
+      end
+
+      private
+
+      # Write a response message back to the client
+      def send_message(message)
+        json_message = message.to_json
+        @stdout.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+      end
+
+      # Write a notification to the client to be transmitted to the editor
+      def send_notification(message)
+        json_message = message.to_json
+        @stderr.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+      end
     end
 
     class ServerAddon
@@ -76,16 +175,18 @@ module RubyLsp
         end
 
         # Instantiate all server addons and store them in a hash for easy access after we have discovered the classes
-        def finalize_registrations!(stdout)
+        def finalize_registrations!(stdout, stderr, capabilities)
           until @server_addon_classes.empty?
-            addon = @server_addon_classes.shift.new(stdout)
+            addon = @server_addon_classes.shift.new(stdout, stderr, capabilities)
             @server_addons[addon.name] = addon
           end
         end
       end
 
-      def initialize(stdout)
+      def initialize(stdout, stderr, capabilities)
         @stdout = stdout
+        @stderr = stderr
+        @capabilities = capabilities
       end
 
       def name
@@ -97,14 +198,31 @@ module RubyLsp
       end
     end
 
+    class IOWrapper < SimpleDelegator
+      def puts(*args)
+        args.each { |arg| log("#{arg}\n") }
+      end
+
+      def print(*args)
+        args.each { |arg| log(arg.to_s) }
+      end
+
+      private
+
+      def log(message)
+        json_message = { method: "window/logMessage", params: { type: 4, message: message } }.to_json
+        write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+      end
+    end
+
     class Server
       include Common
 
-      def initialize(stdout: $stdout, override_default_output_device: true)
+      def initialize(stdout: $stdout, stderr: $stderr, override_default_output_device: true, capabilities: {})
         # Grab references to the original pipes so that we can change the default output device further down
         @stdin = $stdin
         @stdout = stdout
-        @stderr = $stderr
+        @stderr = stderr
         @stdin.sync = true
         @stdout.sync = true
         @stderr.sync = true
@@ -112,10 +230,13 @@ module RubyLsp
         @stdout.binmode
         @stderr.binmode
 
+        # A hash containing the capabilities of the editor that may be relevant for the runtime server
+        @capabilities = capabilities
+
         # # Set the default output device to be $stderr. This means that using `puts` by itself will default to printing
         # # to $stderr and only explicit `$stdout.puts` will go to $stdout. This reduces the chance that output coming
         # # from the Rails app will be accidentally sent to the client
-        $> = $stderr if override_default_output_device
+        $> = IOWrapper.new(@stderr) if override_default_output_device
 
         @running = true
       end
@@ -155,8 +276,10 @@ module RubyLsp
             send_result(run_migrations)
           end
         when "reload"
-          with_notification_error_handling(request) do
-            ::Rails.application.reloader.reload!
+          with_progress("rails-reload", "Reloading Ruby LSP Rails instance") do
+            with_notification_error_handling(request) do
+              ::Rails.application.reloader.reload!
+            end
           end
         when "route_location"
           with_request_error_handling(request) do
@@ -169,7 +292,7 @@ module RubyLsp
         when "server_addon/register"
           with_notification_error_handling(request) do
             require params[:server_addon_path]
-            ServerAddon.finalize_registrations!(@stdout)
+            ServerAddon.finalize_registrations!(@stdout, @stderr, @capabilities)
           end
         when "server_addon/delegate"
           server_addon_name = params[:server_addon_name]
@@ -241,6 +364,8 @@ module RubyLsp
         info = {
           columns: const.columns.map { |column| [column.name, column.type, column.default, column.null] },
           primary_keys: Array(const.primary_key),
+          foreign_keys: collect_model_foreign_keys(const),
+          indexes: collect_model_indexes(const),
         }
 
         if ActiveRecord::Tasks::DatabaseTasks.respond_to?(:schema_dump_path)
@@ -312,8 +437,40 @@ module RubyLsp
           ::ActionView::PathRegistry.file_system_resolver_hooks.clear
         end
       end
+
+      def collect_model_foreign_keys(model)
+        return [] unless model.connection.respond_to?(:supports_foreign_keys?) &&
+          model.connection.supports_foreign_keys?
+
+        model.connection.foreign_keys(model.table_name).map do |key_definition|
+          key_definition.options[:column]
+        end
+      end
+
+      def collect_model_indexes(model)
+        return [] unless database_supports_indexing?(model)
+
+        model.connection.indexes(model.table_name).map do |index_definition|
+          {
+            name: index_definition.name,
+            columns: index_definition.columns,
+            unique: index_definition.unique,
+          }
+        end
+      end
+
+      def database_supports_indexing?(model)
+        return @database_supports_indexing if instance_variable_defined?(:@database_supports_indexing)
+
+        model.connection.indexes(model.table_name)
+        @database_supports_indexing = true
+      rescue NotImplementedError
+        @database_supports_indexing = false
+      end
     end
   end
 end
 
-RubyLsp::Rails::Server.new.start if ARGV.first == "start"
+if ARGV.first == "start"
+  RubyLsp::Rails::Server.new(capabilities: JSON.parse(ARGV[1], symbolize_names: true)).start
+end

data/lib/ruby_lsp/ruby_lsp_rails/support/active_support_test_case_helper.rb

@@ -4,9 +4,7 @@
 module RubyLsp
   module Rails
     module ActiveSupportTestCaseHelper
-      extend T::Sig
-
-      sig { params(node: Prism::CallNode).returns(T.nilable(String)) }
+      #: (Prism::CallNode node) -> String?
       def extract_test_case_name(node)
         message_value = node.message
         return unless message_value == "test" || message_value == "it"

data/lib/ruby_lsp/ruby_lsp_rails/support/location_builder.rb

@@ -6,9 +6,7 @@ module RubyLsp
     module Support
       class LocationBuilder
         class << self
-          extend T::Sig
-
-          sig { params(location_string: String).returns(Interface::Location) }
+          #: (String location_string) -> Interface::Location
           def line_location_from_s(location_string)
             *file_parts, line = location_string.split(":")
             raise ArgumentError, "Invalid location string given" if file_parts.empty?

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.3.31"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.31
+  version: 0.4.1
 platform: ruby
 authors:
 - Shopify
 bindir: bin
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.23.14
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.24.0
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.23.14
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.24.0
@@ -47,6 +47,7 @@ files:
 - lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb
 - lib/ruby_lsp/ruby_lsp_rails/hover.rb
 - lib/ruby_lsp/ruby_lsp_rails/indexing_enhancement.rb
+- lib/ruby_lsp/ruby_lsp_rails/rails_test_style.rb
 - lib/ruby_lsp/ruby_lsp_rails/runner_client.rb
 - lib/ruby_lsp/ruby_lsp_rails/server.rb
 - lib/ruby_lsp/ruby_lsp_rails/support/active_support_test_case_helper.rb
@@ -78,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A Ruby LSP addon for Rails
 test_files: []