ruby-lsp-rails-routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9cd218d807199a52c4a777b85f9fdf417317b5ec41b63fecd79aa53cb842630
+  data.tar.gz: 4ac4413993b99273f45c89e0d53398dab22a474d63eee5b4a705f0346842fff7
+SHA512:
+  metadata.gz: 7469386b93318ff3b35a26380b1a1105ff7995df6585a43c8f7d1a37fedc4f1597deb3948e0294fdd4d413577c23eeb87f80ec908ebba76f6f2f3a8ebbc4d9b3
+  data.tar.gz: db3cc968b08917d3565fc3805cf0d0730df0b72a675a02dc9c5f52bce52d591ca087bffa304ea6067b8ce4467268b79b22f5fcddba11dc5f5483a75337cda38c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [Unreleased]
+
+- Initial version: go-to-definition from `*_path` / `*_url` route helpers to the controller action.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 aki77
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# ruby-lsp-rails-routes
+
+A [Ruby LSP](https://github.com/Shopify/ruby-lsp) add-on that adds **go to definition** from Rails
+route helpers to the controller action they map to.
+
+ruby-lsp-rails already lets you jump from a `*_path` / `*_url` helper to its declaration in
+`config/routes.rb`. This add-on goes one step further: it resolves the named route to its
+controller action at runtime and offers the action's `def` line as an additional candidate. The
+routes.rb declaration is still offered, so both show up in the definition picker.
+
+```ruby
+redirect_to users_path # go to definition -> UsersController#index (and config/routes.rb)
+```
+
+## Requirements
+
+- [ruby-lsp](https://github.com/Shopify/ruby-lsp) `>= 0.26.0, < 0.27.0`
+- [ruby-lsp-rails](https://github.com/Shopify/ruby-lsp-rails) — this add-on talks to its rails
+  runner to resolve routes, so both must be installed.
+
+## Installation
+
+Add the gem to your application's `Gemfile`:
+
+```ruby
+group :development do
+  gem 'ruby-lsp-rails-routes', require: false
+end
+```
+
+Then run `bundle install` and restart the Ruby LSP server in your editor. The add-on is discovered
+automatically by Ruby LSP via the `lib/ruby_lsp/**/addon.rb` convention.
+
+## Scope
+
+The route helper must be called with a self (or implicit) receiver. Route helpers reached through
+an explicit receiver (`some_object.users_path`), `url_for`, and polymorphic routes are not
+supported. Routes that do not map to a controller action (`redirect`, mounted Rack apps, mounted
+engines) are skipped.
+
+## License
+
+MIT

data/lib/ruby_lsp/ruby_lsp_rails_routes/addon.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "version"
+require_relative "util"
+require_relative "definition"
+# NOTE: server_addon.rb is intentionally NOT required here. Its base class
+# RubyLsp::Rails::ServerAddon only exists in the rails runner process, which loads the file via
+# register_server_addon. Requiring it here would fail to load this add-on in the LSP process.
+
+module RubyLsp
+  module RailsRoutes
+    # Ruby LSP add-on that adds go-to-definition from *_path / *_url route helpers to the
+    # controller action the named route maps to. Works alongside ruby-lsp-rails, whose own
+    # Definition listener contributes the routes.rb declaration; this add-on only adds the action
+    # location as an extra candidate.
+    class Addon < ::RubyLsp::Addon
+      SERVER_ADDON_NAME = "Rails Routes"
+
+      def activate(_global_state, _outgoing_queue)
+        @server_addon_registered = false
+      end
+
+      def deactivate; end
+
+      def name
+        "Rails Routes"
+      end
+
+      def version
+        VERSION
+      end
+
+      # Invoked on every definition request. The ruby-lsp-rails client is resolved lazily here
+      # (not in #activate) because add-on activation order is not guaranteed, and because the
+      # runner client boots asynchronously — it is a NullClient until ready.
+      def create_definition_listener(response_builder, _uri, node_context, dispatcher)
+        client = rails_runner_client
+        return unless client
+
+        ensure_server_addon_registered(client)
+
+        Definition.new(client, SERVER_ADDON_NAME, response_builder, node_context, dispatcher)
+      end
+
+      private
+
+      # Returns the ruby-lsp-rails RunnerClient, or nil if the add-on is unavailable/incompatible.
+      def rails_runner_client
+        ::RubyLsp::Addon.get("Ruby LSP Rails", ">= 0.4.0").rails_runner_client
+      rescue ::RubyLsp::Addon::AddonNotFoundError, ::RubyLsp::Addon::IncompatibleApiError
+        nil
+      end
+
+      # Registers our server add-on exactly once. register_server_addon is a no-op on NullClient,
+      # so registering before the runner finishes booting would silently be lost. We therefore
+      # only register once the client is connected, guarded by an idempotency flag.
+      def ensure_server_addon_registered(client)
+        return if @server_addon_registered
+        return unless client.connected? # false for NullClient
+
+        client.register_server_addon(File.expand_path("server_addon.rb", __dir__))
+        @server_addon_registered = true
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails_routes/definition.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module RailsRoutes
+    # When the cursor is on a *_path / *_url route helper call, asks the rails runner process to
+    # resolve the named route to its controller action, and adds that action's source location as
+    # a definition candidate. ruby-lsp-rails' own Definition listener still contributes the
+    # routes.rb declaration to the same response builder, so both candidates coexist.
+    class Definition
+      include ::RubyLsp::Requests::Support::Common
+
+      def initialize(client, server_addon_name, response_builder, node_context, dispatcher)
+        @client = client
+        @server_addon_name = server_addon_name
+        @response_builder = response_builder
+        @node_context = node_context
+
+        dispatcher.register(self, :on_call_node_enter)
+      end
+
+      # Mirrors ruby-lsp-rails' own detection: self (or implicit) receiver, message ends with
+      # _path / _url.
+      def on_call_node_enter(node)
+        return unless self_receiver?(node)
+
+        message = node.message
+        return unless message
+        return unless message.end_with?("_path") || message.end_with?("_url")
+
+        result = @client.delegate_request(
+          server_addon_name: @server_addon_name,
+          request_name: "action_location",
+          name: message
+        )
+        return unless result && result[:location]
+
+        @response_builder << Util.location_from_s(result[:location])
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails_routes/server_addon.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# This file is loaded inside the rails runner process via RunnerClient#register_server_addon.
+# The base class RubyLsp::Rails::ServerAddon only exists in that process, so this file must never
+# be required from the LSP process (do not require_relative it from addon.rb).
+module RubyLsp
+  module RailsRoutes
+    # Runs inside the rails runner process. Resolves a named route to its controller action's
+    # source location by inspecting the application's routes, and returns it to the LSP process.
+    class ServerAddon < ::RubyLsp::Rails::ServerAddon
+      def name
+        "Rails Routes"
+      end
+
+      def execute(request, params)
+        case request
+        when "action_location"
+          send_result(action_location(params[:name]))
+        end
+      end
+
+      private
+
+      # Resolves a route helper name (e.g. "users_path") to its controller action's source
+      # location, returned as { location: "file:line" }. Returns nil when the route does not map
+      # to a resolvable controller action. Mirrors ruby-lsp-rails Server#route_location for the
+      # route lookup, then continues on to the action method's source_location.
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      def action_location(name)
+        # Rails 8 does not populate named_routes until the routes are loaded.
+        ::Rails.application.reload_routes_unless_loaded if ::Rails.application.respond_to?(:reload_routes_unless_loaded)
+
+        match_data = name.match(/^(.+)(_path|_url)$/)
+        return unless match_data
+
+        route = ::Rails.application.routes.named_routes.get(match_data[1])
+        return unless route
+
+        controller = route.defaults[:controller]
+        action = route.defaults[:action]
+        return unless controller && action
+
+        # camelize also converts a namespaced controller ("members/x") into "Members::X".
+        controller_class = "#{controller}_controller".camelize.constantize
+        # MVP assumes the action has an explicit `def` in the controller. instance_method may
+        # resolve to an inherited method; refining this is deferred to a later phase.
+        source_location = controller_class.instance_method(action).source_location
+        return unless source_location
+
+        file, line = source_location
+        { location: "#{file}:#{line}" }
+      rescue NameError
+        nil
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails_routes/util.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module RubyLsp
+  module RailsRoutes
+    # Helpers shared by the LSP-side listeners. Kept dependency-light so they can be unit tested
+    # without booting Ruby LSP.
+    module Util
+      class << self
+        # Converts a "path:line" string (1-based line, as returned by Method#source_location) into
+        # an Interface::Location (0-based line). The last segment is treated as the line only when
+        # it is numeric, so Windows drive letters ("C:/foo.rb:42") survive the split and a string
+        # without a line suffix falls back to line 0.
+        def location_from_s(location_string)
+          file_path, _, line = location_string.rpartition(":")
+          if file_path.empty? || line !~ /\A\d+\z/
+            file_path = location_string
+            line = nil
+          end
+          line_as_number = line ? line.to_i - 1 : 0
+
+          ::RubyLsp::Interface::Location.new(
+            uri: URI::Generic.from_path(path: file_path).to_s,
+            range: ::RubyLsp::Interface::Range.new(
+              start: ::RubyLsp::Interface::Position.new(line: line_as_number, character: 0),
+              end: ::RubyLsp::Interface::Position.new(line: line_as_number, character: 0)
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails_routes/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module RailsRoutes
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-rails-routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aki77
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+description: Provides go-to-definition from *_path / *_url route helpers to the controller
+  action the named route maps to.
+email:
+- 163168+aki77@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/ruby_lsp/ruby_lsp_rails_routes/addon.rb
+- lib/ruby_lsp/ruby_lsp_rails_routes/definition.rb
+- lib/ruby_lsp/ruby_lsp_rails_routes/server_addon.rb
+- lib/ruby_lsp/ruby_lsp_rails_routes/util.rb
+- lib/ruby_lsp/ruby_lsp_rails_routes/version.rb
+homepage: https://github.com/aki77/ruby-lsp-rails-routes
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Ruby LSP add-on for Rails route helpers
+test_files: []