ruby-lsp-rails 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463c37a3e7c9fef9c7b5433d2ef9519f41a29867a0089fe6508fc701a6cf1871
-  data.tar.gz: 0f3e7a164235e85b610f9e0855a0d57e9a25125999ff1c15ed31acc54880cad2
+  metadata.gz: 65c6258c3267f6d1d080e056f4561d61cf8f9bb93059dec1c0b70086fa0ce540
+  data.tar.gz: 536aac52752c432fc3c18d76c66151c099533849abc8968aafe832524e25303b
 SHA512:
-  metadata.gz: 85cbe926939cac7051877d168de8164099265329ccb0cbe4ff6dbe9d1508ae64ce52b168a816d6cd538c79c384f04a1873654b692c98592cb032bc9c1470f318
-  data.tar.gz: c1023803f769de1d701788a85e17906b9626aa9fee89a7d36cabb849826ca68021c00402d8a3d7043cb3128ac7966195fb9ef5b0714109fff96ad907359d7ed5
+  metadata.gz: 3b527faec645912d5c49aef3d4d2bb094a789410283ddcebcc9be168f703807831a5a5f2561a88dcecf5c4e3d894c0d2ccf9fe617688f09462e88ab7ae1a2ee8
+  data.tar.gz: b080811bd5697ae68573df2fd6d922dec47e2e16b5264cd86b707f73cab9689fffa858851da2ebed7a819930fbc148234db4de5c4a15dc2e4fffbec3e4fdfbcb

data/README.md

@@ -2,8 +2,11 @@
 
 Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for extra Rails editor features, such as:
 
-- Displaying an ActiveRecord model's database columns and types when hovering over it
-- Running tests and debugging tests through the terminal or the editor's UI
+* 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 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.
 
 ## Installation
 
@@ -12,13 +15,6 @@ If you haven't already done so, you'll need to first [set up Ruby LSP](https://g
 As of v0.3.0, Ruby LSP will automatically include the Ruby LSP Rails addon in its custom bundle when a Rails app is detected.
 There is no need to add the gem to your bundle.
 
-## Features
-
-* 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 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
 
 See the [documentation](https://shopify.github.io/ruby-lsp-rails) for more in-depth details about the
@@ -41,9 +37,7 @@ When extension is stopped (e.g. by quitting the editor), the server instance is
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp-rails. This project is
-intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
-[Contributor Covenant](https://github.com/Shopify/ruby-lsp-rails/blob/main/CODE_OF_CONDUCT.md) code of conduct.
+See [CONTRIBUTING.md](https://github.com/Shopify/ruby-lsp-rails/blob/main/CONTRIBUTING.md)
 
 ## License
 

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -3,6 +3,7 @@
 
 require "ruby_lsp/addon"
 
+require_relative "../../ruby_lsp_rails/version"
 require_relative "support/active_support_test_case_helper"
 require_relative "support/callbacks"
 require_relative "runner_client"
@@ -31,6 +32,7 @@ module RubyLsp
         $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 }
+        register_additional_file_watchers(global_state: global_state, message_queue: message_queue)
       end
 
       sig { override.void }
@@ -83,7 +85,7 @@ module RubyLsp
       end
       def create_definition_listener(response_builder, uri, nesting, dispatcher)
         index = T.must(@global_state).index
-        Definition.new(response_builder, nesting, index, dispatcher)
+        Definition.new(@client, response_builder, nesting, index, dispatcher)
       end
 
       sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }
@@ -95,6 +97,32 @@ module RubyLsp
         end
       end
 
+      sig { params(global_state: GlobalState, message_queue: Thread::Queue).void }
+      def register_additional_file_watchers(global_state:, message_queue:)
+        return unless global_state.supports_watching_files
+
+        message_queue << Request.new(
+          id: "ruby-lsp-rails-file-watcher",
+          method: "client/registerCapability",
+          params: Interface::RegistrationParams.new(
+            registrations: [
+              Interface::Registration.new(
+                id: "workspace/didChangeWatchedFilesRails",
+                method: "workspace/didChangeWatchedFiles",
+                register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
+                  watchers: [
+                    Interface::FileSystemWatcher.new(
+                      glob_pattern: "**/*structure.sql",
+                      kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE,
+                    ),
+                  ],
+                ),
+              ),
+            ],
+          ),
+        )
+      end
+
       sig { override.returns(String) }
       def name
         "Ruby LSP Rails"

data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -42,8 +42,6 @@ module RubyLsp
       include Requests::Support::Common
       include ActiveSupportTestCaseHelper
 
-      BASE_COMMAND = "bin/rails test"
-
       sig do
         params(
           response_builder:  ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens],
@@ -67,7 +65,7 @@ module RubyLsp
         return unless content
 
         line_number = node.location.start_line
-        command = "#{BASE_COMMAND} #{@path}:#{line_number}"
+        command = "#{test_command} #{@path}:#{line_number}"
         add_test_code_lens(node, name: content, command: command, kind: :example)
       end
 
@@ -77,7 +75,7 @@ module RubyLsp
         method_name = node.name.to_s
         if method_name.start_with?("test_")
           line_number = node.location.start_line
-          command = "#{BASE_COMMAND} #{@path}:#{line_number}"
+          command = "#{test_command} #{@path}:#{line_number}"
           add_test_code_lens(node, name: method_name, command: command, kind: :example)
         end
       end
@@ -86,21 +84,32 @@ module RubyLsp
       def on_class_node_enter(node)
         class_name = node.constant_path.slice
         if class_name.end_with?("Test")
-          command = "#{BASE_COMMAND} #{@path}"
+          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
-
-        @group_id_stack.push(@group_id)
-        @group_id += 1
       end
 
       sig { params(node: Prism::ClassNode).void }
       def on_class_node_leave(node)
-        @group_id_stack.pop
+        class_name = node.constant_path.slice
+        if class_name.end_with?("Test")
+          @group_id_stack.pop
+        end
       end
 
       private
 
+      sig { returns(String) }
+      def test_command
+        if Gem.win_platform?
+          "ruby bin/rails test"
+        else
+          "bin/rails test"
+        end
+      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

data/lib/ruby_lsp/ruby_lsp_rails/definition.rb

@@ -11,25 +11,35 @@ module RubyLsp
     #
     # Currently supported targets:
     # - Callbacks
+    # - Named routes (e.g. `users_path`)
     #
     # # Example
     #
     # ```ruby
     # before_action :foo # <- Go to definition on this symbol will jump to the method if it is defined in the same class
     # ```
+    #
+    # Notes for named routes:
+    # - It is available only in Rails 7.1 or newer.
+    # - Route may be defined across multiple files, e.g. using `draw`, rather than in `routes.rb`.
+    # - Routes won't be found if not defined for the Rails development environment.
+    # - If using `constraints`, the route can only be found if the constraints are met.
+    # - Changes to routes won't be picked up until the server is restarted.
     class Definition
       extend T::Sig
       include Requests::Support::Common
 
       sig do
         params(
+          client: RunnerClient,
           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)
+      def initialize(client, response_builder, nesting, index, dispatcher)
+        @client = client
         @response_builder = response_builder
         @nesting = nesting
         @index = index
@@ -43,8 +53,19 @@ module RubyLsp
 
         message = node.message
 
-        return unless message && Support::Callbacks::ALL.include?(message)
+        return unless message
+
+        if Support::Callbacks::ALL.include?(message)
+          handle_callback(node)
+        elsif message.end_with?("_path") || message.end_with?("_url")
+          handle_route(node)
+        end
+      end
 
+      private
+
+      sig { params(node: Prism::CallNode).void }
+      def handle_callback(node)
         arguments = node.arguments&.arguments
         return unless arguments&.any?
 
@@ -62,7 +83,25 @@ module RubyLsp
         end
       end
 
-      private
+      sig { params(node: Prism::CallNode).void }
+      def handle_route(node)
+        result = @client.route_location(T.must(node.message))
+        return unless result
+
+        *file_parts, line = result.fetch(:location).split(":")
+
+        # On Windows, file paths will look something like `C:/path/to/file.rb:123`. Only the last colon is the line
+        # number and all other parts compose the file path
+        file_path = file_parts.join(":")
+
+        @response_builder << Interface::Location.new(
+          uri: URI::Generic.from_path(path: file_path).to_s,
+          range: Interface::Range.new(
+            start: Interface::Position.new(line: Integer(line) - 1, character: 0),
+            end: Interface::Position.new(line: Integer(line) - 1, character: 0),
+          ),
+        )
+      end
 
       sig { params(name: String).void }
       def collect_definitions(name)

data/lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb

@@ -21,12 +21,22 @@ module RubyLsp
       end
       def initialize(response_builder, dispatcher)
         @response_builder = response_builder
-
-        dispatcher.register(self, :on_call_node_enter)
+        @namespace_stack = T.let([], T::Array[String])
+
+        dispatcher.register(
+          self,
+          :on_call_node_enter,
+          :on_class_node_enter,
+          :on_class_node_leave,
+          :on_module_node_enter,
+          :on_module_node_leave,
+        )
       end
 
       sig { params(node: Prism::CallNode).void }
       def on_call_node_enter(node)
+        return if @namespace_stack.empty?
+
         content = extract_test_case_name(node)
 
         if content
@@ -44,15 +54,46 @@ module RubyLsp
         case message
         when *Support::Callbacks::ALL, "validate"
           handle_all_arg_types(node, T.must(message))
-        when "validates", "validates!", "validates_each", "belongs_to", "has_one", "has_many", "has_and_belongs_to_many"
+        when "validates", "validates!", "validates_each", "belongs_to", "has_one", "has_many",
+          "has_and_belongs_to_many", "attr_readonly", "scope"
           handle_symbol_and_string_arg_types(node, T.must(message))
         when "validates_with"
           handle_class_arg_types(node, T.must(message))
         end
       end
 
+      sig { params(node: Prism::ClassNode).void }
+      def on_class_node_enter(node)
+        add_to_namespace_stack(node)
+      end
+
+      sig { params(node: Prism::ClassNode).void }
+      def on_class_node_leave(node)
+        remove_from_namespace_stack(node)
+      end
+
+      sig { params(node: Prism::ModuleNode).void }
+      def on_module_node_enter(node)
+        add_to_namespace_stack(node)
+      end
+
+      sig { params(node: Prism::ModuleNode).void }
+      def on_module_node_leave(node)
+        remove_from_namespace_stack(node)
+      end
+
       private
 
+      sig { params(node: T.any(Prism::ClassNode, Prism::ModuleNode)).void }
+      def add_to_namespace_stack(node)
+        @namespace_stack << node.constant_path.slice
+      end
+
+      sig { params(node: T.any(Prism::ClassNode, Prism::ModuleNode)).void }
+      def remove_from_namespace_stack(node)
+        @namespace_stack.delete(node.constant_path.slice)
+      end
+
       sig { params(node: Prism::CallNode, message: String).void }
       def handle_all_arg_types(node, message)
         block = node.block

data/lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -77,13 +77,14 @@ module RubyLsp
         schema_file = model[:schema_file]
 
         @response_builder.push(
-          "[Schema](#{URI::Generic.build(scheme: "file", path: schema_file)})",
+          "[Schema](#{URI::Generic.from_path(path: schema_file)})",
           category: :links,
         ) if schema_file
 
         @response_builder.push(
           model[:columns].map do |name, type|
-            "**#{name}**: #{type}\n"
+            primary_key_suffix = " (PK)" if model[:primary_keys].include?(name)
+            "**#{name}**: #{type}#{primary_key_suffix}\n"
           end.join("\n"),
           category: :documentation,
         )

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -46,14 +46,15 @@ module RubyLsp
           Process.setsid
         rescue Errno::EPERM
           # If we can't set the session ID, continue
+        rescue NotImplementedError
+          # setpgrp() may be unimplemented on some platform
+          # https://github.com/Shopify/ruby-lsp-rails/issues/348
+        end
+
+        stdin, stdout, stderr, wait_thread = Bundler.with_original_env do
+          Open3.popen3("bundle", "exec", "rails", "runner", "#{__dir__}/server.rb", "start")
         end
 
-        stdin, stdout, stderr, wait_thread = Open3.popen3(
-          "bin/rails",
-          "runner",
-          "#{__dir__}/server.rb",
-          "start",
-        )
         @stdin = T.let(stdin, IO)
         @stdout = T.let(stdout, IO)
         @stderr = T.let(stderr, IO)
@@ -79,7 +80,9 @@ 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
-              Process.kill(T.must(Signal.list["TERM"]), @wait_thread.pid)
+
+              # 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
         end
@@ -95,6 +98,14 @@ module RubyLsp
         nil
       end
 
+      sig { params(name: String).returns(T.nilable(T::Hash[Symbol, T.untyped])) }
+      def route_location(name)
+        make_request("route_location", name: name)
+      rescue IncompleteMessageError
+        $stderr.puts("Ruby LSP Rails failed to get route location: #{@stderr.read}")
+        nil
+      end
+
       sig { void }
       def trigger_reload
         $stderr.puts("Reloading Rails application")

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -1,24 +1,8 @@
-# typed: strict
+# typed: false
 # frozen_string_literal: true
 
-require "sorbet-runtime"
 require "json"
 
-begin
-  T::Configuration.default_checked_level = :never
-  # Suppresses call validation errors
-  T::Configuration.call_validation_error_handler = ->(*) {}
-  # Suppresses errors caused by T.cast, T.let, T.must, etc.
-  T::Configuration.inline_type_error_handler = ->(*) {}
-  # Suppresses errors caused by incorrect parameter ordering
-  T::Configuration.sig_validation_error_handler = ->(*) {}
-rescue
-  # Need this rescue so that if another gem has
-  # already set the checked level by the time we
-  # get to it, we don't fail outright.
-  nil
-end
-
 # 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.
 
@@ -27,16 +11,14 @@ module RubyLsp
     class Server
       VOID = Object.new
 
-      extend T::Sig
-
-      sig { void }
       def initialize
         $stdin.sync = true
         $stdout.sync = true
-        @running = T.let(true, T::Boolean)
+        $stdin.binmode
+        $stdout.binmode
+        @running = true
       end
 
-      sig { void }
       def start
         initialize_result = { result: { message: "ok" } }.to_json
         $stdout.write("Content-Length: #{initialize_result.length}\r\n\r\n#{initialize_result}")
@@ -54,22 +36,18 @@ module RubyLsp
         end
       end
 
-      sig do
-        params(
-          request: String,
-          params: T.nilable(T::Hash[Symbol, T.untyped]),
-        ).returns(T.any(Object, T::Hash[Symbol, T.untyped]))
-      end
       def execute(request, params)
         case request
         when "shutdown"
           @running = false
           VOID
         when "model"
-          resolve_database_info_from_model(T.must(params).fetch(:name))
+          resolve_database_info_from_model(params.fetch(:name))
         when "reload"
           ::Rails.application.reloader.reload!
           VOID
+        when "route_location"
+          route_location(params.fetch(:name))
         else
           VOID
         end
@@ -79,10 +57,37 @@ module RubyLsp
 
       private
 
-      sig { params(model_name: String).returns(T::Hash[Symbol, T.untyped]) }
+      # 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) &&
+          ActionDispatch::Routing::Mapper.route_source_locations
+        def route_location(name)
+          match_data = name.match(/^(.+)(_path|_url)$/)
+          return { result: nil } unless match_data
+
+          key = match_data[1]
+
+          # A token could match the _path or _url pattern, but not be an actual route.
+          route = ::Rails.application.routes.named_routes.get(key)
+          return { result: nil } unless route&.source_location
+
+          {
+            result: {
+              location: ::Rails.root.join(route.source_location).to_s,
+            },
+          }
+        rescue => e
+          { error: e.full_message(highlight: false) }
+        end
+      else
+        def route_location(name)
+          { result: nil }
+        end
+      end
+
       def resolve_database_info_from_model(model_name)
         const = ActiveSupport::Inflector.safe_constantize(model_name)
-        unless const && defined?(ActiveRecord) && const < ActiveRecord::Base && !const.abstract_class?
+        unless active_record_model?(const)
           return {
             result: nil,
           }
@@ -91,6 +96,7 @@ module RubyLsp
         info = {
           result: {
             columns: const.columns.map { |column| [column.name, column.type] },
+            primary_keys: Array(const.primary_key),
           },
         }
 
@@ -103,6 +109,15 @@ module RubyLsp
       rescue => e
         { error: e.full_message(highlight: false) }
       end
+
+      def active_record_model?(const)
+        !!(
+          const &&
+            defined?(ActiveRecord) &&
+            ActiveRecord::Base > const && # We do this 'backwards' in case the class overwrites `<`
+          !const.abstract_class?
+        )
+      end
     end
   end
 end

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

@@ -66,18 +66,25 @@ module RubyLsp
           private def build_search_index
             return unless RAILTIES_VERSION
 
-            $stderr.puts("Fetching Rails Documents...")
+            $stderr.puts("Fetching search index for Rails documentation")
 
-            response = Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/v#{RAILTIES_VERSION}/js/search_index.js"))
+            response = Net::HTTP.get_response(
+              URI("#{RAILS_DOC_HOST}/v#{RAILTIES_VERSION}/js/search_index.js"),
+              { "User-Agent" => "ruby-lsp-rails/#{RubyLsp::Rails::VERSION}" },
+            )
 
             body = case response
             when Net::HTTPSuccess
+              $stderr.puts("Finished fetching search index for Rails documentation")
               response.body
             when Net::HTTPRedirection
               # If the version's doc is not found, e.g. Rails main, it'll be redirected
               # In this case, we just fetch the latest doc
               response = Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/js/search_index.js"))
-              response.body if response.is_a?(Net::HTTPSuccess)
+              if response.is_a?(Net::HTTPSuccess)
+                $stderr.puts("Finished fetching search index for Rails documentation")
+                response.body
+              end
             else
               $stderr.puts("Response failed: #{response.inspect}")
               nil

data/lib/ruby_lsp_rails/version.rb

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

metadata

@@ -1,64 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.16.5
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.17.0
@@ -68,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.16.5
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.17.0
@@ -133,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: A Ruby LSP addon for Rails