ruby-lsp-rails 0.3.8 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: accc5f9539ddceaa7fde3dfdb64fcc74f697e9d17178c45e9271df463cad4f18
-  data.tar.gz: d594ee73741270b0d6837680a5bacc6e912c1ca856aeaa5806e7d1ad9e96aeb8
+  metadata.gz: e2543aa7d39f0a6b231112f9ddb365692c7e8d06eb14681da551ab55fd8f5a4d
+  data.tar.gz: e466ccd6d90934e083e638efdcedfb5d6b8f85fbce70b139e1542eeb2ab8a139
 SHA512:
-  metadata.gz: 955347d73c343311571e62d7c0bb656a3cc9176f8e6ff87ab010287345d754b49f1889c436c716ce0a40c2aa45938f094124cd18315f787c854db7aed2172ee1
-  data.tar.gz: 65731a4414f5b68884ea6003097b5b1e67caaaaf2a954b0d25de0ed937cc7600d1b1e4e8d2c25a28b25f526c72fc05e6f9a1996874f95584c4450a4212ef9269
+  metadata.gz: 8f7c82462682d93fd6b944c2705c8b62b424b4abc3636d1f2540eeee1ab9f7e2896eb77d338697bb65a0a64752529085f38e49bd5a75bfc668fa9d31dd5b0d10
+  data.tar.gz: a8978fdebb07ba8b76dd10a725b3b3c736961f103cefa806fbc0302b494516e0a196105bf7fac9d114c963a62c8a706959d53f1509a4ed343e2e9d24633c4372

data/README.md

@@ -9,6 +9,8 @@ Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for ex
 * 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.
 * Jump to the declaration of a route.
+* Code Lens allowing fast-forwarding or rewinding of migrations.
+* Code Lens showing the path that a route action corresponds to.
 
 ## Installation
 

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(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

@@ -5,11 +5,22 @@ module RubyLsp
   module Rails
     # ![CodeLens demo](../../code_lens.gif)
     #
-    # This feature adds several CodeLens features for Rails applications using Active Support test cases:
+    # This feature adds Code Lens features for Rails applications.
+    #
+    # For Active Support test cases:
     #
     # - Run tests in the VS Terminal
     # - Run tests in the VS Code Test Explorer
     # - Debug tests
+    # - Run migrations in the VS Terminal
+    #
+    # For Rails controllers:
+    #
+    # - See the path corresponding to an action
+    # - Click on the action's Code Lens to jump to its declaration in the routes.
+    #
+    # Note: This depends on a support for the `rubyLsp.openFile` command.
+    # For the VS Code extension this is built-in, but for other editors this may require some custom configuration.
     #
     # The
     # [code lens](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeLens)
@@ -32,12 +43,34 @@ module RubyLsp
     #     # ...
     #   end
     # end
-    # ````
+    # ```
+    #
+    # # Example:
+    # ```ruby
+    # Run
+    # class AddFirstNameToUsers < ActiveRecord::Migration[7.1]
+    #   # ...
+    # end
+    # ```
     #
     # The code lenses will be displayed above the class and above each test method.
     #
     # Note: When using the Test Explorer view, if your code contains a statement to pause execution (e.g. `debugger`) it
     # will cause the test runner to hang.
+    #
+    # For the following code, assuming the routing contains `resources :users`, a Code Lens will be seen above each
+    # action.
+    #
+    # ```ruby
+    # class UsersController < ApplicationController
+    #   GET /users(.:format)
+    #   def index # <- Will show code lens above for the path
+    #   end
+    # end
+    # ```
+    #
+    # Note: Complex routing configurations may not be supported.
+    #
     class CodeLens
       extend T::Sig
       include Requests::Support::Common
@@ -45,18 +78,31 @@ 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(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 }
@@ -74,46 +120,146 @@ module RubyLsp
       sig { params(node: Prism::DefNode).void }
       def on_def_node_enter(node)
         method_name = node.name.to_s
+
         if method_name.start_with?("test_")
           line_number = node.location.start_line
           command = "#{test_command} #{@path}:#{line_number}"
           add_test_code_lens(node, name: method_name, command: command, kind: :example)
         end
+
+        if controller?
+          add_route_code_lens_to_action(node)
+          add_jump_to_view(node)
+        end
       end
 
       sig { params(node: Prism::ClassNode).void }
       def on_class_node_enter(node)
         class_name = node.constant_path.slice
+        superclass_name = node.superclass&.slice
+
         if class_name.end_with?("Test")
           command = "#{test_command} #{@path}"
           add_test_code_lens(node, name: class_name, command: command, kind: :group)
           @group_id_stack.push(@group_id)
           @group_id += 1
         end
+
+        if superclass_name&.start_with?("ActiveRecord::Migration")
+          command = "#{migrate_command} VERSION=#{migration_version}"
+          add_migrate_code_lens(node, name: class_name, command: command)
+        end
+
+        # We need to use a stack because someone could define a nested class
+        # inside a controller. When we exit that nested class declaration, we are
+        # back in a controller context. This part is used in other places in the LSP
+        @constant_name_stack << [class_name, superclass_name]
       end
 
       sig { params(node: Prism::ClassNode).void }
       def on_class_node_leave(node)
         class_name = node.constant_path.slice
+
         if class_name.end_with?("Test")
           @group_id_stack.pop
         end
+
+        @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)) }
+      def controller?
+        class_name, superclass_name = @constant_name_stack.last
+        return false unless class_name && superclass_name
+
+        class_name.end_with?("Controller") && superclass_name.end_with?("Controller")
+      end
+
+      sig { params(node: Prism::DefNode).void }
+      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
+
+        file_path, line = route[:source_location]
+
+        @response_builder << create_code_lens(
+          node,
+          title: "#{route[:verb]} #{route[:path]}",
+          command_name: "rubyLsp.openFile",
+          arguments: [["file://#{file_path}#L#{line}"]],
+          data: { type: "file" },
+        )
+      end
+
       sig { returns(String) }
       def test_command
-        if Gem.win_platform?
-          "ruby bin/rails test"
-        else
-          "bin/rails test"
-        end
+        "#{RbConfig.ruby} bin/rails test"
+      end
+
+      sig { returns(String) }
+      def migrate_command
+        "#{RbConfig.ruby} bin/rails db:migrate"
+      end
+
+      sig { returns(T.nilable(String)) }
+      def migration_version
+        File.basename(T.must(@path)).split("_").first
+      end
+
+      sig { params(node: Prism::Node, name: String, command: String).void }
+      def add_migrate_code_lens(node, name:, command:)
+        return unless @path
+
+        @response_builder << create_code_lens(
+          node,
+          title: "Run",
+          command_name: "rubyLsp.runTask",
+          arguments: [command],
+          data: { type: "migrate" },
+        )
       end
 
       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,8 +36,12 @@ module RubyLsp
 
       extend T::Sig
 
+      sig { returns(String) }
+      attr_reader :rails_root
+
       sig { void }
       def initialize
+        @mutex = T.let(Mutex.new, Mutex)
         # Spring needs a Process session ID. It uses this ID to "attach" itself to the parent process, so that when the
         # parent ends, the spring process ends as well. If this is not set, Spring will throw an error while trying to
         # set its own session ID
@@ -67,7 +71,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 +85,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
@@ -122,6 +125,14 @@ module RubyLsp
         nil
       end
 
+      sig { params(controller: String, action: String).returns(T.nilable(T::Hash[Symbol, T.untyped])) }
+      def route(controller:, action:)
+        make_request("route_info", controller: controller, action: action)
+      rescue IncompleteMessageError
+        $stderr.puts("Ruby LSP Rails failed to get route information: #{@stderr.read}")
+        nil
+      end
+
       sig { void }
       def trigger_reload
         $stderr.puts("Reloading Rails application")
@@ -137,6 +148,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) }
@@ -157,26 +171,35 @@ 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
         json = message.to_json
 
-        @stdin.write("Content-Length: #{json.length}\r\n\r\n", json)
+        @mutex.synchronize do
+          @stdin.write("Content-Length: #{json.length}\r\n\r\n", json)
+        end
+      rescue Errno::EPIPE
+        # 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
+        raw_response = @mutex.synchronize do
+          headers = @stdout.gets("\r\n\r\n")
+          raise IncompleteMessageError unless headers
 
-        content_length = headers[/Content-Length: (\d+)/i, 1].to_i
-        raise EmptyMessageError if content_length.zero?
+          content_length = headers[/Content-Length: (\d+)/i, 1].to_i
+          raise EmptyMessageError if content_length.zero?
+
+          @stdout.read(content_length)
+        end
 
-        raw_response = @stdout.read(content_length)
         response = JSON.parse(T.must(raw_response), symbolize_names: true)
 
         if response[:error]
@@ -185,6 +208,15 @@ module RubyLsp
         end
 
         response.fetch(:result)
+      rescue Errno::EPIPE
+        # 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
 
@@ -205,6 +237,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
@@ -54,6 +54,8 @@ module RubyLsp
           VOID
         when "route_location"
           route_location(params.fetch(:name))
+        when "route_info"
+          resolve_route_info(params)
         else
           VOID
         end
@@ -63,6 +65,32 @@ module RubyLsp
 
       private
 
+      def resolve_route_info(requirements)
+        if requirements[:controller]
+          requirements[:controller] = requirements.fetch(:controller).underscore.delete_suffix("_controller")
+        end
+
+        # In Rails 7.2 we can use `from_requirements, otherwise we fall back to a private API
+        route = if ::Rails.application.routes.respond_to?(:from_requirements)
+          ::Rails.application.routes.from_requirements(requirements)
+        else
+          ::Rails.application.routes.routes.find { |route| route.requirements == requirements }
+        end
+
+        if route&.source_location
+          file, _, line = route.source_location.rpartition(":")
+          body = {
+            source_location: [::Rails.root.join(file).to_s, line],
+            verb: route.verb,
+            path: route.path.spec.to_s,
+          }
+
+          { result: body }
+        else
+          { result: nil }
+        end
+      end
+
       # Older versions of Rails don't support `route_source_locations`.
       # We also check that it's enabled.
       if ActionDispatch::Routing::Mapper.respond_to?(:route_source_locations) &&

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.3.8"
+    VERSION = "0.3.13"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.13
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-08-15 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.17
 signing_key:
 specification_version: 4
 summary: A Ruby LSP addon for Rails