ruby-lsp-rails 0.3.10 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90b7d238d437e9ad3c29cad137e14e3094340243802f3d0f5cb7ddf68e582e1
-  data.tar.gz: cb64d09552cf7a0862ceeb8fb27c0c2b40ba596a267bec6aebdaf3ab2db139a4
+  metadata.gz: 9c4bfe664b0783f9ae11cc912ec6eff3cd8c2d9c5c9c51731a85d0ed7de2fbf1
+  data.tar.gz: 1f3f74de8ec6891464b84a8d88fd339e33ce1ddcdc770a6a34177c60d4001ebe
 SHA512:
-  metadata.gz: 8721f1e2bb8a2fc0acff6a3caab8b216c0225b9fdd69eb883944b10d0159619d35c501b7d3761b9fb086e0662e082dedc28c759cca3481d65ea97b3dae157e23
-  data.tar.gz: 7c329b8da4692954f7382069f8f046672675192536c79ee3c58f0239ee87b82c5aa7083b1e786dc3827a713b9e08232d7c8e92d8513bb2f89a37e97957116070
+  metadata.gz: 2e4493fb0f18638b208e3d9f40671846e351670936214420131ae0482fe7d6410f74afc5b808a707dd616471f83233eb201be51a25e29152817daa1ec0380e73
+  data.tar.gz: 9eb01978fc74c0d212a65240ff2f5874d38768abf85b647943c7eba0aee84116912a0ebe9c6206ddf84b6ee7b48f60535f1a288cd66c538ff56a40c501adc4ee

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -13,6 +13,7 @@ require_relative "hover"
 require_relative "code_lens"
 require_relative "document_symbol"
 require_relative "definition"
+require_relative "indexing_enhancement"
 
 module RubyLsp
   module Rails
@@ -35,6 +36,8 @@ module RubyLsp
         # Start booting the real client in a background thread. Until this completes, the client will be a NullClient
         Thread.new { @client = RunnerClient.create_client }
         register_additional_file_watchers(global_state: global_state, message_queue: message_queue)
+
+        T.must(@global_state).index.register_enhancement(IndexingEnhancement.new)
       end
 
       sig { override.void }
@@ -51,9 +54,7 @@ module RubyLsp
         ).void
       end
       def create_code_lens_listener(response_builder, uri, dispatcher)
-        return unless T.must(@global_state).test_library == "rails"
-
-        CodeLens.new(@client, response_builder, uri, dispatcher)
+        CodeLens.new(@client, T.must(@global_state), response_builder, uri, dispatcher)
       end
 
       sig do
@@ -79,7 +80,9 @@ module RubyLsp
 
       sig do
         override.params(
-          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
+          response_builder: ResponseBuilders::CollectionResponseBuilder[T.any(
+            Interface::Location, Interface::LocationLink
+          )],
           uri: URI::Generic,
           node_context: NodeContext,
           dispatcher: Prism::Dispatcher,

data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -79,20 +79,30 @@ module RubyLsp
       sig do
         params(
           client: RunnerClient,
+          global_state: GlobalState,
           response_builder:  ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens],
           uri: URI::Generic,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(client, response_builder, uri, dispatcher)
+      def initialize(client, global_state, response_builder, uri, dispatcher)
         @client = client
+        @global_state = global_state
         @response_builder = response_builder
         @path = T.let(uri.to_standardized_path, T.nilable(String))
         @group_id = T.let(1, Integer)
         @group_id_stack = T.let([], T::Array[Integer])
         @constant_name_stack = T.let([], T::Array[[String, T.nilable(String)]])
 
-        dispatcher.register(self, :on_call_node_enter, :on_class_node_enter, :on_def_node_enter, :on_class_node_leave)
+        dispatcher.register(
+          self,
+          :on_call_node_enter,
+          :on_class_node_enter,
+          :on_def_node_enter,
+          :on_class_node_leave,
+          :on_module_node_enter,
+          :on_module_node_leave,
+        )
       end
 
       sig { params(node: Prism::CallNode).void }
@@ -119,6 +129,7 @@ module RubyLsp
 
         if controller?
           add_route_code_lens_to_action(node)
+          add_jump_to_view(node)
         end
       end
 
@@ -156,6 +167,16 @@ module RubyLsp
         @constant_name_stack.pop
       end
 
+      sig { params(node: Prism::ModuleNode).void }
+      def on_module_node_enter(node)
+        @constant_name_stack << [node.constant_path.slice, nil]
+      end
+
+      sig { params(node: Prism::ModuleNode).void }
+      def on_module_node_leave(node)
+        @constant_name_stack.pop
+      end
+
       private
 
       sig { returns(T.nilable(T::Boolean)) }
@@ -167,34 +188,42 @@ module RubyLsp
       end
 
       sig { params(node: Prism::DefNode).void }
-      def add_route_code_lens_to_action(node)
-        class_name, _ = T.must(@constant_name_stack.last)
-        route = @client.route(
-          controller: class_name,
-          action: node.name.to_s,
+      def add_jump_to_view(node)
+        class_name = @constant_name_stack.map(&:first).join("::")
+        action_name = node.name
+        controller_name = class_name
+          .delete_suffix("Controller")
+          .gsub(/([a-z])([A-Z])/, "\\1_\\2")
+          .gsub("::", "/")
+          .downcase
+
+        view_uris = Dir.glob("#{@client.rails_root}/app/views/#{controller_name}/#{action_name}*").map! do |path|
+          URI::Generic.from_path(path: path).to_s
+        end
+        return if view_uris.empty?
+
+        @response_builder << create_code_lens(
+          node,
+          title: "Jump to view",
+          command_name: "rubyLsp.openFile",
+          arguments: [view_uris],
+          data: { type: "file" },
         )
+      end
 
+      sig { params(node: Prism::DefNode).void }
+      def add_route_code_lens_to_action(node)
+        class_name, _ = T.must(@constant_name_stack.last)
+        route = @client.route(controller: class_name, action: node.name.to_s)
         return unless route
 
-        path = route[:path]
-        verb = route[:verb]
-        source_location = route[:source_location]
-
-        arguments = [
-          source_location,
-          {
-            start_line: node.location.start_line - 1,
-            start_column: node.location.start_column,
-            end_line: node.location.end_line - 1,
-            end_column: node.location.end_column,
-          },
-        ]
+        file_path, line = route[:source_location]
 
         @response_builder << create_code_lens(
           node,
-          title: [verb, path].join(" "),
+          title: "#{route[:verb]} #{route[:path]}",
           command_name: "rubyLsp.openFile",
-          arguments: arguments,
+          arguments: [["file://#{file_path}#L#{line}"]],
           data: { type: "file" },
         )
       end
@@ -230,6 +259,7 @@ module RubyLsp
       sig { params(node: Prism::Node, name: String, command: String, kind: Symbol).void }
       def add_test_code_lens(node, name:, command:, kind:)
         return unless @path
+        return unless @global_state.test_library == "rails"
 
         arguments = [
           @path,

data/lib/ruby_lsp/ruby_lsp_rails/definition.rb

@@ -17,7 +17,7 @@ module RubyLsp
     # # Example
     #
     # ```ruby
-    # before_action :foo # <- Go to definition on this symbol will jump to the method if it is defined in the same class
+    # before_action :foo # <- Go to definition on this symbol will jump to the method
     # ```
     #
     # Notes for named routes:
@@ -34,7 +34,9 @@ module RubyLsp
       sig do
         params(
           client: RunnerClient,
-          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
+          response_builder: RubyLsp::ResponseBuilders::CollectionResponseBuilder[T.any(
+            Interface::Location, Interface::LocationLink
+          )],
           node_context: NodeContext,
           index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,

data/lib/ruby_lsp/ruby_lsp_rails/indexing_enhancement.rb

@@ -0,0 +1,113 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    class IndexingEnhancement
+      extend T::Sig
+      include RubyIndexer::Enhancement
+
+      sig do
+        override.params(
+          index: RubyIndexer::Index,
+          owner: T.nilable(RubyIndexer::Entry::Namespace),
+          node: Prism::CallNode,
+          file_path: String,
+        ).void
+      end
+      def on_call_node(index, owner, node, file_path)
+        return unless owner
+
+        name = node.name
+
+        case name
+        when :extend
+          handle_concern_extend(index, owner, node)
+        when :has_one, :has_many, :belongs_to, :has_and_belongs_to_many
+          handle_association(index, owner, node, file_path)
+        end
+      end
+
+      private
+
+      sig do
+        params(
+          index: RubyIndexer::Index,
+          owner: RubyIndexer::Entry::Namespace,
+          node: Prism::CallNode,
+          file_path: String,
+        ).void
+      end
+      def handle_association(index, owner, node, file_path)
+        arguments = node.arguments&.arguments
+        return unless arguments
+
+        name_arg = arguments.first
+
+        name = case name_arg
+        when Prism::StringNode
+          name_arg.content
+        when Prism::SymbolNode
+          name_arg.value
+        end
+
+        return unless name
+
+        # Reader
+        index.add(RubyIndexer::Entry::Method.new(
+          name,
+          file_path,
+          name_arg.location,
+          name_arg.location,
+          [],
+          [RubyIndexer::Entry::Signature.new([])],
+          RubyIndexer::Entry::Visibility::PUBLIC,
+          owner,
+        ))
+
+        # Writer
+        index.add(RubyIndexer::Entry::Method.new(
+          "#{name}=",
+          file_path,
+          name_arg.location,
+          name_arg.location,
+          [],
+          [RubyIndexer::Entry::Signature.new([RubyIndexer::Entry::RequiredParameter.new(name: name.to_sym)])],
+          RubyIndexer::Entry::Visibility::PUBLIC,
+          owner,
+        ))
+      end
+
+      sig do
+        params(
+          index: RubyIndexer::Index,
+          owner: RubyIndexer::Entry::Namespace,
+          node: Prism::CallNode,
+        ).void
+      end
+      def handle_concern_extend(index, owner, node)
+        arguments = node.arguments&.arguments
+        return unless arguments
+
+        arguments.each do |node|
+          next unless node.is_a?(Prism::ConstantReadNode) || node.is_a?(Prism::ConstantPathNode)
+
+          module_name = node.full_name
+          next unless module_name == "ActiveSupport::Concern"
+
+          index.register_included_hook(owner.name) do |index, base|
+            class_methods_name = "#{owner.name}::ClassMethods"
+
+            if index.indexed?(class_methods_name)
+              singleton = index.existing_or_new_singleton_class(base.name)
+              singleton.mixin_operations << RubyIndexer::Entry::Include.new(class_methods_name)
+            end
+          end
+        rescue Prism::ConstantPathNode::DynamicPartsInConstantPathError,
+               Prism::ConstantPathNode::MissingNodesInConstantPathError
+          # Do nothing
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -36,6 +36,9 @@ module RubyLsp
 
       extend T::Sig
 
+      sig { returns(String) }
+      attr_reader :rails_root
+
       sig { void }
       def initialize
         # Spring needs a Process session ID. It uses this ID to "attach" itself to the parent process, so that when the
@@ -67,7 +70,8 @@ module RubyLsp
 
         begin
           count += 1
-          read_response
+          initialize_response = T.must(read_response)
+          @rails_root = T.let(initialize_response[:root], String)
         rescue EmptyMessageError
           $stderr.puts("Ruby LSP Rails is retrying initialize (#{count})")
           retry if count < MAX_RETRIES
@@ -80,9 +84,7 @@ module RubyLsp
             if @wait_thread.alive?
               $stderr.puts("Ruby LSP Rails is force killing the server")
               sleep(0.5) # give the server a bit of time if we already issued a shutdown notification
-
-              # Windows does not support the `TERM` signal, so we're forced to use `KILL` here
-              Process.kill(T.must(Signal.list["KILL"]), @wait_thread.pid)
+              force_kill
             end
           end
         end
@@ -145,6 +147,9 @@ module RubyLsp
         send_message("shutdown")
         sleep(0.5) # give the server a bit of time to shutdown
         [@stdin, @stdout, @stderr].each(&:close)
+      rescue IOError
+        # The server connection may have died
+        force_kill
       end
 
       sig { returns(T::Boolean) }
@@ -165,7 +170,7 @@ module RubyLsp
         read_response
       end
 
-      sig { params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
+      sig { overridable.params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
       def send_message(request, params = nil)
         message = { method: request }
         message[:params] = params if params
@@ -176,9 +181,11 @@ module RubyLsp
         # The server connection died
       end
 
-      alias_method :send_notification, :send_message
+      # Notifications are like messages, but one-way, with no response sent back.
+      sig { params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
+      def send_notification(request, params = nil) = send_message(request, params)
 
-      sig { returns(T.nilable(T::Hash[Symbol, T.untyped])) }
+      sig { overridable.returns(T.nilable(T::Hash[Symbol, T.untyped])) }
       def read_response
         headers = @stdout.gets("\r\n\r\n")
         raise IncompleteMessageError unless headers
@@ -199,6 +206,12 @@ module RubyLsp
         # The server connection died
         nil
       end
+
+      sig { void }
+      def force_kill
+        # Windows does not support the `TERM` signal, so we're forced to use `KILL` here
+        Process.kill(T.must(Signal.list["KILL"]), @wait_thread.pid)
+      end
     end
 
     class NullClient < RunnerClient
@@ -218,6 +231,11 @@ module RubyLsp
         true
       end
 
+      sig { override.returns(String) }
+      def rails_root
+        Dir.pwd
+      end
+
       private
 
       sig { override.params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -24,7 +24,7 @@ module RubyLsp
         routes_reloader = ::Rails.application.routes_reloader
         routes_reloader.execute_unless_loaded if routes_reloader&.respond_to?(:execute_unless_loaded)
 
-        initialize_result = { result: { message: "ok" } }.to_json
+        initialize_result = { result: { message: "ok", root: ::Rails.root.to_s } }.to_json
         $stdout.write("Content-Length: #{initialize_result.length}\r\n\r\n#{initialize_result}")
 
         while @running

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.3.10"
+    VERSION = "0.3.12"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.12
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.2
+        version: 0.17.12
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.18.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.2
+        version: 0.17.12
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.18.0
@@ -46,6 +46,7 @@ files:
 - 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/indexing_enhancement.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
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A Ruby LSP addon for Rails