ruby-lsp-rails 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c6faaac7ecd3824bd041d7273207db6c8611306ef0a33d7d02eb42cc8e931c0
-  data.tar.gz: 26ee8d231aab1512d52547056838f42a194265645fceb80dc9c02d77eba0e286
+  metadata.gz: 463c37a3e7c9fef9c7b5433d2ef9519f41a29867a0089fe6508fc701a6cf1871
+  data.tar.gz: 0f3e7a164235e85b610f9e0855a0d57e9a25125999ff1c15ed31acc54880cad2
 SHA512:
-  metadata.gz: e6d4711e5a31d9a59b4648e693796ab1398c04abe9b00e55627a6815b989751b8764d0c33a26679a4530aeadf8900d0f7d0f59b0dd0ab55fb68365be831f2199
-  data.tar.gz: e55de08bde09f2b065ec8820ac29f831ec094efdb23eb8ce930f488c851ad3b4e183ef7f0dafca5d16d511ffa87ae0be20bba4c903a0d4b6d9b2dee2532df369
+  metadata.gz: 85cbe926939cac7051877d168de8164099265329ccb0cbe4ff6dbe9d1508ae64ce52b168a816d6cd538c79c384f04a1873654b692c98592cb032bc9c1470f318
+  data.tar.gz: c1023803f769de1d701788a85e17906b9626aa9fee89a7d36cabb849826ca68021c00402d8a3d7043cb3128ac7966195fb9ef5b0714109fff96ad907359d7ed5

data/README.md

@@ -16,7 +16,8 @@ There is no need to add the gem to your bundle.
 
 * Hover over an ActiveRecord model to reveal its schema.
 * Run or debug a test by clicking on the code lens which appears above the test class, or an individual test.
-* Navigate to validations, callbacks and test cases using your editor's "Go to Symbol" feature, or outline view.
+* Navigate to associations, validations, callbacks and test cases using your editor's "Go to Symbol" feature, or outline view.
+* Jump to the definition of callbacks using your editor's "Go to Definition" feature.
 
 ## Documentation
 

data/Rakefile

@@ -23,6 +23,7 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
   rdoc.rdoc_dir = "docs"
   rdoc.markup = "markdown"
+  rdoc.generator = "snapper"
   rdoc.options.push("--copy-files", "misc")
   rdoc.options.push("--copy-files", "LICENSE.txt")
 end

data/lib/ruby-lsp-rails.rb

@@ -10,6 +10,7 @@ module RubyLsp
   # - [Hover](rdoc-ref:RubyLsp::Rails::Hover)
   # - [CodeLens](rdoc-ref:RubyLsp::Rails::CodeLens)
   # - [DocumentSymbol](rdoc-ref:RubyLsp::Rails::DocumentSymbol)
+  # - [Definition](rdoc-ref:RubyLsp::Rails::Definition)
   module Rails
   end
 end

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -4,10 +4,12 @@
 require "ruby_lsp/addon"
 
 require_relative "support/active_support_test_case_helper"
+require_relative "support/callbacks"
 require_relative "runner_client"
 require_relative "hover"
 require_relative "code_lens"
 require_relative "document_symbol"
+require_relative "definition"
 
 module RubyLsp
   module Rails
@@ -23,8 +25,10 @@ module RubyLsp
         @client = T.let(NullClient.new, RunnerClient)
       end
 
-      sig { override.params(message_queue: Thread::Queue).void }
-      def activate(message_queue)
+      sig { override.params(global_state: GlobalState, message_queue: Thread::Queue).void }
+      def activate(global_state, message_queue)
+        @global_state = T.let(global_state, T.nilable(RubyLsp::GlobalState))
+        $stderr.puts("Activating Ruby LSP Rails addon v#{VERSION}")
         # Start booting the real client in a background thread. Until this completes, the client will be a NullClient
         Thread.new { @client = RunnerClient.create_client }
       end
@@ -43,6 +47,8 @@ module RubyLsp
         ).void
       end
       def create_code_lens_listener(response_builder, uri, dispatcher)
+        return unless T.must(@global_state).test_library == "rails"
+
         CodeLens.new(response_builder, uri, dispatcher)
       end
 
@@ -50,12 +56,11 @@ module RubyLsp
         override.params(
           response_builder: ResponseBuilders::Hover,
           nesting: T::Array[String],
-          index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def create_hover_listener(response_builder, nesting, index, dispatcher)
-        Hover.new(@client, response_builder, nesting, index, dispatcher)
+      def create_hover_listener(response_builder, nesting, dispatcher)
+        Hover.new(@client, response_builder, nesting, T.must(@global_state), dispatcher)
       end
 
       sig do
@@ -68,6 +73,19 @@ module RubyLsp
         DocumentSymbol.new(response_builder, dispatcher)
       end
 
+      sig do
+        override.params(
+          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
+          uri: URI::Generic,
+          nesting: T::Array[String],
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      def create_definition_listener(response_builder, uri, nesting, dispatcher)
+        index = T.must(@global_state).index
+        Definition.new(response_builder, nesting, index, dispatcher)
+      end
+
       sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }
       def workspace_did_change_watched_files(changes)
         if changes.any? do |change|

data/lib/ruby_lsp/ruby_lsp_rails/definition.rb

@@ -0,0 +1,87 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    # ![Definition demo](../../definition.gif)
+    #
+    # The [definition
+    # request](https://microsoft.github.io/language-server-protocol/specification#textDocument_definition) jumps to the
+    # definition of the symbol under the cursor.
+    #
+    # Currently supported targets:
+    # - Callbacks
+    #
+    # # Example
+    #
+    # ```ruby
+    # before_action :foo # <- Go to definition on this symbol will jump to the method if it is defined in the same class
+    # ```
+    class Definition
+      extend T::Sig
+      include Requests::Support::Common
+
+      sig do
+        params(
+          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
+          nesting: T::Array[String],
+          index: RubyIndexer::Index,
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      def initialize(response_builder, nesting, index, dispatcher)
+        @response_builder = response_builder
+        @nesting = nesting
+        @index = index
+
+        dispatcher.register(self, :on_call_node_enter)
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_enter(node)
+        return unless self_receiver?(node)
+
+        message = node.message
+
+        return unless message && Support::Callbacks::ALL.include?(message)
+
+        arguments = node.arguments&.arguments
+        return unless arguments&.any?
+
+        arguments.each do |argument|
+          name = case argument
+          when Prism::SymbolNode
+            argument.value
+          when Prism::StringNode
+            argument.content
+          end
+
+          next unless name
+
+          collect_definitions(name)
+        end
+      end
+
+      private
+
+      sig { params(name: String).void }
+      def collect_definitions(name)
+        methods = @index.resolve_method(name, @nesting.join("::"))
+        return unless methods
+
+        methods.each do |target_method|
+          location = target_method.location
+          file_path = target_method.file_path
+
+          @response_builder << Interface::Location.new(
+            uri: URI::Generic.from_path(path: file_path).to_s,
+            range: Interface::Range.new(
+              start: Interface::Position.new(line: location.start_line - 1, character: location.start_column),
+              end: Interface::Position.new(line: location.end_line - 1, character: location.end_column),
+            ),
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb

@@ -6,69 +6,13 @@ module RubyLsp
     # ![Document Symbol demo](../../document_symbol.gif)
     #
     # The [document symbol](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol)
-    # request allows users to navigate between ActiveSupport test cases with VS Code's "Go to Symbol" feature.
+    # request allows users to navigate between associations, validations, callbacks and ActiveSupport test cases with
+    # VS Code's "Go to Symbol" feature.
     class DocumentSymbol
       extend T::Sig
       include Requests::Support::Common
       include ActiveSupportTestCaseHelper
 
-      MODEL_CALLBACKS = T.let(
-        [
-          "before_validation",
-          "after_validation",
-          "before_save",
-          "around_save",
-          "after_save",
-          "before_create",
-          "around_create",
-          "after_create",
-          "after_commit",
-          "after_rollback",
-          "before_update",
-          "around_update",
-          "after_update",
-          "before_destroy",
-          "around_destroy",
-          "after_destroy",
-          "after_initialize",
-          "after_find",
-          "after_touch",
-        ].freeze,
-        T::Array[String],
-      )
-
-      CONTROLLER_CALLBACKS = T.let(
-        [
-          "after_action",
-          "append_after_action",
-          "append_around_action",
-          "append_before_action",
-          "around_action",
-          "before_action",
-          "prepend_after_action",
-          "prepend_around_action",
-          "prepend_before_action",
-          "skip_after_action",
-          "skip_around_action",
-          "skip_before_action",
-        ].freeze,
-        T::Array[String],
-      )
-
-      JOB_CALLBACKS = T.let(
-        [
-          "after_enqueue",
-          "after_perform",
-          "around_enqueue",
-          "around_perform",
-          "before_enqueue",
-          "before_perform",
-        ].freeze,
-        T::Array[String],
-      )
-
-      CALLBACKS = T.let((MODEL_CALLBACKS + CONTROLLER_CALLBACKS + JOB_CALLBACKS).freeze, T::Array[String])
-
       sig do
         params(
           response_builder: ResponseBuilders::DocumentSymbol,
@@ -98,9 +42,9 @@ module RubyLsp
 
         message = node.message
         case message
-        when *CALLBACKS, "validate"
+        when *Support::Callbacks::ALL, "validate"
           handle_all_arg_types(node, T.must(message))
-        when "validates", "validates!", "validates_each"
+        when "validates", "validates!", "validates_each", "belongs_to", "has_one", "has_many", "has_and_belongs_to_many"
           handle_symbol_and_string_arg_types(node, T.must(message))
         when "validates_with"
           handle_class_arg_types(node, T.must(message))
@@ -115,7 +59,7 @@ module RubyLsp
 
         if block
           append_document_symbol(
-            name: "#{message}(<anonymous>)",
+            name: "#{message} <anonymous>",
             range: range_from_location(node.location),
             selection_range: range_from_location(block.location),
           )
@@ -132,7 +76,7 @@ module RubyLsp
             next unless name
 
             append_document_symbol(
-              name: "#{message}(#{name})",
+              name: "#{message} :#{name}",
               range: range_from_location(argument.location),
               selection_range: range_from_location(T.must(argument.value_loc)),
             )
@@ -141,13 +85,13 @@ module RubyLsp
             next if name.empty?
 
             append_document_symbol(
-              name: "#{message}(#{name})",
+              name: "#{message} :#{name}",
               range: range_from_location(argument.location),
               selection_range: range_from_location(argument.content_loc),
             )
           when Prism::LambdaNode
             append_document_symbol(
-              name: "#{message}(<anonymous>)",
+              name: "#{message} <anonymous>",
               range: range_from_location(node.location),
               selection_range: range_from_location(argument.location),
             )
@@ -156,12 +100,12 @@ module RubyLsp
 
             arg_receiver = argument.receiver
 
-            name = arg_receiver.name if arg_receiver.is_a?(Prism::ConstantReadNode)
-            name = arg_receiver.full_name if arg_receiver.is_a?(Prism::ConstantPathNode)
+            name = arg_receiver.full_name if arg_receiver.is_a?(Prism::ConstantReadNode) ||
+              arg_receiver.is_a?(Prism::ConstantPathNode)
             next unless name
 
             append_document_symbol(
-              name: "#{message}(#{name})",
+              name: "#{message} #{name}",
               range: range_from_location(argument.location),
               selection_range: range_from_location(argument.location),
             )
@@ -170,7 +114,7 @@ module RubyLsp
             next if name.empty?
 
             append_document_symbol(
-              name: "#{message}(#{name})",
+              name: "#{message} #{name}",
               range: range_from_location(argument.location),
               selection_range: range_from_location(argument.location),
             )
@@ -190,7 +134,7 @@ module RubyLsp
             next unless name
 
             append_document_symbol(
-              name: "#{message}(#{name})",
+              name: "#{message} :#{name}",
               range: range_from_location(argument.location),
               selection_range: range_from_location(T.must(argument.value_loc)),
             )
@@ -199,7 +143,7 @@ module RubyLsp
             next if name.empty?
 
             append_document_symbol(
-              name: "#{message}(#{name})",
+              name: "#{message} :#{name}",
               range: range_from_location(argument.location),
               selection_range: range_from_location(argument.content_loc),
             )
@@ -219,7 +163,7 @@ module RubyLsp
             next if name.empty?
 
             append_document_symbol(
-              name: "#{message}(#{name})",
+              name: "#{message} #{name}",
               range: range_from_location(argument.location),
               selection_range: range_from_location(argument.location),
             )

data/lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -25,15 +25,15 @@ module RubyLsp
           client: RunnerClient,
           response_builder: ResponseBuilders::Hover,
           nesting: T::Array[String],
-          index: RubyIndexer::Index,
+          global_state: GlobalState,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(client, response_builder, nesting, index, dispatcher)
+      def initialize(client, response_builder, nesting, global_state, dispatcher)
         @client = client
         @response_builder = response_builder
         @nesting = nesting
-        @index = index
+        @index = T.let(global_state.index, RubyIndexer::Index)
         dispatcher.register(self, :on_constant_path_node_enter, :on_constant_read_node_enter, :on_call_node_enter)
       end
 

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -30,6 +30,9 @@ module RubyLsp
 
       class InitializationError < StandardError; end
       class IncompleteMessageError < StandardError; end
+      class EmptyMessageError < StandardError; end
+
+      MAX_RETRIES = 5
 
       extend T::Sig
 
@@ -59,7 +62,16 @@ module RubyLsp
         @stdout.binmode # for Windows compatibility
 
         $stderr.puts("Ruby LSP Rails booting server")
-        read_response
+        count = 0
+
+        begin
+          count += 1
+          read_response
+        rescue EmptyMessageError
+          $stderr.puts("Ruby LSP Rails is retrying initialize (#{count})")
+          retry if count < MAX_RETRIES
+        end
+
         $stderr.puts("Finished booting Ruby LSP Rails server")
 
         unless ENV["RAILS_ENV"] == "test"
@@ -134,7 +146,10 @@ module RubyLsp
         headers = @stdout.gets("\r\n\r\n")
         raise IncompleteMessageError unless headers
 
-        raw_response = @stdout.read(headers[/Content-Length: (\d+)/i, 1].to_i)
+        content_length = headers[/Content-Length: (\d+)/i, 1].to_i
+        raise EmptyMessageError if content_length.zero?
+
+        raw_response = @stdout.read(content_length)
         response = JSON.parse(T.must(raw_response), symbolize_names: true)
 
         if response[:error]

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

@@ -0,0 +1,67 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    module Support
+      module Callbacks
+        MODELS = T.let(
+          [
+            "before_validation",
+            "after_validation",
+            "before_save",
+            "around_save",
+            "after_save",
+            "before_create",
+            "around_create",
+            "after_create",
+            "after_commit",
+            "after_rollback",
+            "before_update",
+            "around_update",
+            "after_update",
+            "before_destroy",
+            "around_destroy",
+            "after_destroy",
+            "after_initialize",
+            "after_find",
+            "after_touch",
+          ].freeze,
+          T::Array[String],
+        )
+
+        CONTROLLERS = T.let(
+          [
+            "after_action",
+            "append_after_action",
+            "append_around_action",
+            "append_before_action",
+            "around_action",
+            "before_action",
+            "prepend_after_action",
+            "prepend_around_action",
+            "prepend_before_action",
+            "skip_after_action",
+            "skip_around_action",
+            "skip_before_action",
+          ].freeze,
+          T::Array[String],
+        )
+
+        JOBS = T.let(
+          [
+            "after_enqueue",
+            "after_perform",
+            "around_enqueue",
+            "around_perform",
+            "before_enqueue",
+            "before_perform",
+          ].freeze,
+          T::Array[String],
+        )
+
+        ALL = T.let((MODELS + CONTROLLERS + JOBS).freeze, T::Array[String])
+      end
+    end
+  end
+end

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.3.3"
+    VERSION = "0.3.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -58,20 +58,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.16.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.16.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -99,11 +99,13 @@ files:
 - lib/ruby-lsp-rails.rb
 - lib/ruby_lsp/ruby_lsp_rails/addon.rb
 - lib/ruby_lsp/ruby_lsp_rails/code_lens.rb
+- lib/ruby_lsp/ruby_lsp_rails/definition.rb
 - lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb
 - lib/ruby_lsp/ruby_lsp_rails/hover.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
+- lib/ruby_lsp/ruby_lsp_rails/support/callbacks.rb
 - lib/ruby_lsp/ruby_lsp_rails/support/rails_document_client.rb
 - lib/ruby_lsp_rails/railtie.rb
 - lib/ruby_lsp_rails/version.rb
@@ -124,14 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key: 
 specification_version: 4
 summary: A Ruby LSP addon for Rails