wip

Author: andyw8

README.md

@@ -6,6 +6,7 @@ Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for ex
 * Run or debug a test by clicking on the code lens which appears above the test class, or an individual test.
 * 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 definition of a route.
 
 ## Installation
 

lib/ruby_lsp/ruby_lsp_rails/definition.rb

@@ -11,19 +11,23 @@ module Rails
     #
     # Currently supported targets:
     # - Callbacks
+    # - Routes
     #
     # # Example
     #
     # ```ruby
     # before_action :foo # <- Go to definition on this symbol will jump to the method if it is defined in the same class
     # ```
-    # Works even if multiple files, e.g.:
+    #
+    # Works even if the routes are defined in multiple files, e.g.:
+    #
+    # # route.rb
+    #
     # Rails.application.routes.draw do
-    #   load 'config/routes/oauth.rb'
+    #   load "config/routes/oauth.rb"
     # end
+    #
     # Won't work if route is not defined for in the development Rails env.
-    # Works for users_path() but not users_path, trying to figure out why.
-    # TODO: handle case for route_source_locations being false
     class Definition
       extend T::Sig
       include Requests::Support::Common
@@ -61,6 +65,8 @@ def on_call_node_enter(node)
         end
       end
 
+      private
+
       sig { params(node: Prism::CallNode).void }
       def handle_callback(node)
         arguments = node.arguments&.arguments
@@ -99,8 +105,6 @@ def handle_route(node)
         )
       end
 
-      private
-
       sig { params(name: String).void }
       def collect_definitions(name)
         methods = @index.resolve_method(name, @nesting.join("::"))

lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -74,6 +74,10 @@ def initialize
 
         $stderr.puts("Finished booting Ruby LSP Rails server")
 
+        unless ActionDispatch::Routing::Mapper.route_source_locations
+          $stderr.puts("Warning: `route_source_locations` is not enabled in the Rails application. Some features will be unavailable.")
+        end
+
         unless ENV["RAILS_ENV"] == "test"
           at_exit do
             if @wait_thread.alive?

lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -22,7 +22,7 @@
 # NOTE: We should avoid printing to stderr since it causes problems. We never read the standard error pipe from the
 # client, so it will become full and eventually hang or crash. Instead, return a response with an `error` key.
 
-ActionDispatch::Routing::Mapper.route_source_locations = true
+# ActionDispatch::Routing::Mapper.route_source_locations = true
 
 module RubyLsp
   module Rails
@@ -73,30 +73,7 @@ def execute(request, params)
           ::Rails.application.reloader.reload!
           VOID
         when "route_location"
-          unless ActionDispatch::Routing::Mapper.route_source_locations
-            return { error: "ABC" }
-          end
-
-          $stderr.puts("***params: #{params}")
-          name = T.must(params).fetch(:name).match(/^([a-z_]+)(_path|_url)$/)[1]
-
-          unless name
-            raise "no name found in: #{params}"
-          end
-
-          unless ::Rails.application.routes.named_routes.key?(name)
-            return {
-              result: {
-                location: nil,
-              },
-            }
-          end
-
-          {
-            result: {
-              location: ::Rails.root.to_s + "/" + ::Rails.application.routes.named_routes.get(name).source_location,
-            },
-          }
+          route_location(T.must(params).fetch(:name))
         else
           VOID
         end
@@ -106,6 +83,42 @@ def execute(request, params)
 
       private
 
+      sig { params(name: String).returns(T::Hash[Symbol, T.untyped]) }
+      def route_location(name)
+        unless ActionDispatch::Routing::Mapper.route_source_locations
+          return {
+            result: {
+              location: nil,
+            },
+          }
+        end
+
+        key = name.match(/^([a-z_]+)(_path|_url)$/)[1]
+
+        unless ::Rails.application.routes.named_routes.key?(key)
+          return {
+            result: {
+              location: nil,
+            },
+          }
+        end
+
+        route = ::Rails.application.routes.named_routes.get(key)
+
+        unless route&.source_location
+          return {
+            result: {
+              location: nil,
+            },
+          }
+        end
+        {
+          result: {
+            location: ::Rails.root.to_s + "/" + route.source_location,
+          },
+        }
+      end
+
       sig { params(model_name: String).returns(T::Hash[Symbol, T.untyped]) }
       def resolve_database_info_from_model(model_name)
         const = ActiveSupport::Inflector.safe_constantize(model_name)

test/dummy/config/initializers/action_dispatch.rb

@@ -1,5 +1,5 @@
 # typed: true
 # frozen_string_literal: true
 
-# Route source locations are normally only available in development, so we need to enable them in test mode.
+# Route source locations are normally only available in development, so we need to enable this in test mode.
 ActionDispatch::Routing::Mapper.route_source_locations = true

test/ruby_lsp_rails/definition_test.rb

@@ -111,7 +111,24 @@ def baz; end
           invalid_path
         RUBY
 
-        assert_equal(0, response.size)
+        assert_empty(response)
+      end
+
+      test "returns an empty response if `route_source_locations` isn't enabled" do
+        FileUtils.mv(
+          "test/dummy/config/initializers/action_dispatch.rb",
+          "test/dummy/config/initializers/action_dispatch.rb.bak",
+        )
+        response = generate_definitions_for_source(<<~RUBY, { line: 0, character: 0 })
+          users_path
+        RUBY
+
+        assert_empty(response)
+      ensure
+        FileUtils.mv(
+          "test/dummy/config/initializers/action_dispatch.rb.bak",
+          "test/dummy/config/initializers/action_dispatch.rb",
+        )
       end
 
       private