ruby-lsp-rails 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65c6258c3267f6d1d080e056f4561d61cf8f9bb93059dec1c0b70086fa0ce540
-  data.tar.gz: 536aac52752c432fc3c18d76c66151c099533849abc8968aafe832524e25303b
+  metadata.gz: 6bb6fcc96e3d0fd9357e7f8700acbae09e0d792499ed0d8b92fd577a97949108
+  data.tar.gz: cbb971feed21416f187195d0b23295801dbbc5c875c5d64961f2591e253f375a
 SHA512:
-  metadata.gz: 3b527faec645912d5c49aef3d4d2bb094a789410283ddcebcc9be168f703807831a5a5f2561a88dcecf5c4e3d894c0d2ccf9fe617688f09462e88ab7ae1a2ee8
-  data.tar.gz: b080811bd5697ae68573df2fd6d922dec47e2e16b5264cd86b707f73cab9689fffa858851da2ebed7a819930fbc148234db4de5c4a15dc2e4fffbec3e4fdfbcb
+  metadata.gz: dc8c684b4900726219d73c2855a1afe159e0ba02f8a953de86356e1cfb9667fe11dff4cbaf3446d5dd471689151f34072f1a099f82033c959516db30dcf81ce7
+  data.tar.gz: 72b8a8ba741fbccd174dc46bb86ef683634630866f209f0968eb6d228992f4986f46bac7f0de249a936649eef80a799c5505f9c8a3514f76d44e77a511b70325

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby DX Slack](https://img.shields.io/badge/Slack-Ruby%20DX-success?logo=slack)](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q)
+
 # Ruby LSP Rails
 
 Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for extra Rails editor features, such as:

data/Rakefile

@@ -30,4 +30,4 @@ end
 
 RubyLsp::CheckDocs.new(FileList["#{__dir__}/lib/ruby_lsp/**/*.rb"], FileList["#{__dir__}/misc/**/*.gif"])
 
-task default: :test
+task default: [:"db:setup", :test]

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -5,7 +5,9 @@ require "ruby_lsp/addon"
 
 require_relative "../../ruby_lsp_rails/version"
 require_relative "support/active_support_test_case_helper"
+require_relative "support/associations"
 require_relative "support/callbacks"
+require_relative "support/location_builder"
 require_relative "runner_client"
 require_relative "hover"
 require_relative "code_lens"
@@ -57,12 +59,12 @@ module RubyLsp
       sig do
         override.params(
           response_builder: ResponseBuilders::Hover,
-          nesting: T::Array[String],
+          node_context: NodeContext,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def create_hover_listener(response_builder, nesting, dispatcher)
-        Hover.new(@client, response_builder, nesting, T.must(@global_state), dispatcher)
+      def create_hover_listener(response_builder, node_context, dispatcher)
+        Hover.new(@client, response_builder, node_context, T.must(@global_state), dispatcher)
       end
 
       sig do
@@ -79,13 +81,13 @@ module RubyLsp
         override.params(
           response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
           uri: URI::Generic,
-          nesting: T::Array[String],
+          node_context: NodeContext,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def create_definition_listener(response_builder, uri, nesting, dispatcher)
+      def create_definition_listener(response_builder, uri, node_context, dispatcher)
         index = T.must(@global_state).index
-        Definition.new(@client, response_builder, nesting, index, dispatcher)
+        Definition.new(@client, response_builder, node_context, index, dispatcher)
       end
 
       sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }

data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -6,6 +6,7 @@ module RubyLsp
     # ![CodeLens demo](../../code_lens.gif)
     #
     # This feature adds several CodeLens features for Rails applications using Active Support test cases:
+    #
     # - Run tests in the VS Terminal
     # - Run tests in the VS Code Test Explorer
     # - Debug tests

data/lib/ruby_lsp/ruby_lsp_rails/definition.rb

@@ -10,6 +10,7 @@ module RubyLsp
     # definition of the symbol under the cursor.
     #
     # Currently supported targets:
+    #
     # - Callbacks
     # - Named routes (e.g. `users_path`)
     #
@@ -20,6 +21,7 @@ module RubyLsp
     # ```
     #
     # 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.
@@ -33,15 +35,15 @@ module RubyLsp
         params(
           client: RunnerClient,
           response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
-          nesting: T::Array[String],
+          node_context: NodeContext,
           index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(client, response_builder, nesting, index, dispatcher)
+      def initialize(client, response_builder, node_context, index, dispatcher)
         @client = client
         @response_builder = response_builder
-        @nesting = nesting
+        @nesting = T.let(node_context.nesting, T::Array[String])
         @index = index
 
         dispatcher.register(self, :on_call_node_enter)
@@ -55,7 +57,9 @@ module RubyLsp
 
         return unless message
 
-        if Support::Callbacks::ALL.include?(message)
+        if Support::Associations::ALL.include?(message)
+          handle_association(node)
+        elsif Support::Callbacks::ALL.include?(message)
           handle_callback(node)
         elsif message.end_with?("_path") || message.end_with?("_url")
           handle_route(node)
@@ -84,23 +88,28 @@ module RubyLsp
       end
 
       sig { params(node: Prism::CallNode).void }
-      def handle_route(node)
-        result = @client.route_location(T.must(node.message))
+      def handle_association(node)
+        first_argument = node.arguments&.arguments&.first
+        return unless first_argument.is_a?(Prism::SymbolNode)
+
+        association_name = first_argument.unescaped
+
+        result = @client.association_target_location(
+          model_name: @nesting.join("::"),
+          association_name: association_name,
+        )
+
         return unless result
 
-        *file_parts, line = result.fetch(:location).split(":")
+        @response_builder << Support::LocationBuilder.line_location_from_s(result.fetch(:location))
+      end
 
-        # 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(":")
+      sig { params(node: Prism::CallNode).void }
+      def handle_route(node)
+        result = @client.route_location(T.must(node.message))
+        return unless result
 
-        @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),
-          ),
-        )
+        @response_builder << Support::LocationBuilder.line_location_from_s(result.fetch(:location))
       end
 
       sig { params(name: String).void }

data/lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -24,15 +24,15 @@ module RubyLsp
         params(
           client: RunnerClient,
           response_builder: ResponseBuilders::Hover,
-          nesting: T::Array[String],
+          node_context: NodeContext,
           global_state: GlobalState,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(client, response_builder, nesting, global_state, dispatcher)
+      def initialize(client, response_builder, node_context, global_state, dispatcher)
         @client = client
         @response_builder = response_builder
-        @nesting = nesting
+        @nesting = T.let(node_context.nesting, T::Array[String])
         @index = T.let(global_state.index, RubyIndexer::Index)
         dispatcher.register(self, :on_constant_path_node_enter, :on_constant_read_node_enter, :on_call_node_enter)
       end

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -98,6 +98,22 @@ module RubyLsp
         nil
       end
 
+      sig do
+        params(
+          model_name: String,
+          association_name: String,
+        ).returns(T.nilable(T::Hash[Symbol, T.untyped]))
+      end
+      def association_target_location(model_name:, association_name:)
+        make_request(
+          "association_target_location",
+          model_name: model_name,
+          association_name: association_name,
+        )
+      rescue => e
+        $stderr.puts("Ruby LSP Rails failed with #{e.message}: #{@stderr.read}")
+      end
+
       sig { params(name: String).returns(T.nilable(T::Hash[Symbol, T.untyped])) }
       def route_location(name)
         make_request("route_location", name: name)

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -20,6 +20,10 @@ module RubyLsp
       end
 
       def start
+        # Load routes if they haven't been loaded yet (see https://github.com/rails/rails/pull/51614).
+        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
         $stdout.write("Content-Length: #{initialize_result.length}\r\n\r\n#{initialize_result}")
 
@@ -43,6 +47,8 @@ module RubyLsp
           VOID
         when "model"
           resolve_database_info_from_model(params.fetch(:name))
+        when "association_target_location"
+          resolve_association_target(params)
         when "reload"
           ::Rails.application.reloader.reload!
           VOID
@@ -110,6 +116,29 @@ module RubyLsp
         { error: e.full_message(highlight: false) }
       end
 
+      def resolve_association_target(params)
+        const = ActiveSupport::Inflector.safe_constantize(params[:model_name])
+        unless active_record_model?(const)
+          return {
+            result: nil,
+          }
+        end
+
+        association_klass = const.reflect_on_association(params[:association_name].intern).klass
+
+        source_location = Object.const_source_location(association_klass.to_s)
+
+        {
+          result: {
+            location: source_location.first + ":" + source_location.second.to_s,
+          },
+        }
+      rescue NameError
+        {
+          result: nil,
+        }
+      end
+
       def active_record_model?(const)
         !!(
           const &&

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

@@ -0,0 +1,20 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    module Support
+      module Associations
+        ALL = T.let(
+          [
+            "belongs_to",
+            "has_many",
+            "has_one",
+            "has_and_belongs_to_many",
+          ].freeze,
+          T::Array[String],
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    module Support
+      class LocationBuilder
+        class << self
+          extend T::Sig
+
+          sig { params(location_string: String).returns(Interface::Location) }
+          def line_location_from_s(location_string)
+            *file_parts, line = location_string.split(":")
+
+            raise ArgumentError, "Invalid location string given" unless file_parts
+
+            # 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(":")
+
+            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
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -16,34 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.5
+        version: 0.17.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.16.5
-    - - "<"
       - !ruby/object:Gem::Version
         version: 0.17.0
-- !ruby/object:Gem::Dependency
-  name: sorbet-runtime
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.9897
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.9897
+        version: 0.18.0
 description: A Ruby LSP addon that adds extra editor functionality for Rails applications
 email:
 - ruby@shopify.com
@@ -63,7 +49,9 @@ files:
 - 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
+- lib/ruby_lsp/ruby_lsp_rails/support/associations.rb
 - lib/ruby_lsp/ruby_lsp_rails/support/callbacks.rb
+- lib/ruby_lsp/ruby_lsp_rails/support/location_builder.rb
 - lib/ruby_lsp/ruby_lsp_rails/support/rails_document_client.rb
 - lib/ruby_lsp_rails/railtie.rb
 - lib/ruby_lsp_rails/version.rb
@@ -91,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.10
 signing_key: 
 specification_version: 4
 summary: A Ruby LSP addon for Rails