Handle namespaces for showing column information (#171)

* Handle namespaces for showing column information

* Add namespaced model for testing purposes

Author: vinistock

lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -46,7 +46,7 @@ def create_code_lens_listener(uri, emitter, message_queue)
         ).returns(T.nilable(Listener[T.nilable(Interface::Hover)]))
       end
       def create_hover_listener(nesting, index, emitter, message_queue)
-        Hover.new(client, emitter, message_queue)
+        Hover.new(client, nesting, index, emitter, message_queue)
       end
 
       sig { override.returns(String) }

lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -25,33 +25,53 @@ class Hover < ::RubyLsp::Listener
       sig { override.returns(ResponseType) }
       attr_reader :_response
 
-      sig { params(client: RailsClient, emitter: RubyLsp::EventEmitter, message_queue: Thread::Queue).void }
-      def initialize(client, emitter, message_queue)
+      sig do
+        params(
+          client: RailsClient,
+          nesting: T::Array[String],
+          index: RubyIndexer::Index,
+          emitter: RubyLsp::EventEmitter,
+          message_queue: Thread::Queue,
+        ).void
+      end
+      def initialize(client, nesting, index, emitter, message_queue)
         super(emitter, message_queue)
 
         @_response = T.let(nil, ResponseType)
         @client = client
+        @nesting = nesting
+        @index = index
         emitter.register(self, :on_constant_path, :on_constant_read, :on_call)
       end
 
       sig { params(node: YARP::ConstantPathNode).void }
       def on_constant_path(node)
-        @_response = generate_rails_document_link_hover(node.slice, node.location)
+        entries = @index.resolve(node.slice, @nesting)
+        return unless entries
+
+        name = T.must(entries.first).name
+        content = +""
+        column_info = generate_column_content(name)
+        content << column_info if column_info
+
+        urls = Support::RailsDocumentClient.generate_rails_document_urls(name)
+        content << urls.join("\n\n") unless urls.empty?
+        return if content.empty?
+
+        contents = RubyLsp::Interface::MarkupContent.new(kind: "markdown", value: content)
+        @_response = RubyLsp::Interface::Hover.new(range: range_from_location(node.location), contents: contents)
       end
 
       sig { params(node: YARP::ConstantReadNode).void }
       def on_constant_read(node)
-        model = @client.model(node.name.to_s)
-        return if model.nil?
+        entries = @index.resolve(node.name.to_s, @nesting)
+        return unless entries
+
+        content = generate_column_content(T.must(entries.first).name)
+        return unless content
 
-        schema_file = model[:schema_file]
-        content = +""
-        if schema_file
-          content << "[Schema](#{URI::Generic.build(scheme: "file", path: schema_file)})\n\n"
-        end
-        content << model[:columns].map { |name, type| "**#{name}**: #{type}\n" }.join("\n")
         contents = RubyLsp::Interface::MarkupContent.new(kind: "markdown", value: content)
-        @_response = RubyLsp::Interface::Hover.new(range: range_from_node(node), contents: contents)
+        @_response = RubyLsp::Interface::Hover.new(range: range_from_location(node.location), contents: contents)
       end
 
       sig { params(node: YARP::CallNode).void }
@@ -66,6 +86,18 @@ def on_call(node)
 
       private
 
+      sig { params(name: String).returns(T.nilable(String)) }
+      def generate_column_content(name)
+        model = @client.model(name)
+        return if model.nil?
+
+        schema_file = model[:schema_file]
+        content = +""
+        content << "[Schema](#{URI::Generic.build(scheme: "file", path: schema_file)})\n\n" if schema_file
+        content << model[:columns].map { |name, type| "**#{name}**: #{type}\n" }.join("\n")
+        content
+      end
+
       sig { params(name: String, location: YARP::Location).returns(T.nilable(Interface::Hover)) }
       def generate_rails_document_link_hover(name, location)
         urls = Support::RailsDocumentClient.generate_rails_document_urls(name)

test/dummy/app/models/blog/post.rb

@@ -0,0 +1,8 @@
+# typed: true
+# frozen_string_literal: true
+
+module Blog
+  class Post < ApplicationRecord
+    self.table_name = "posts"
+  end
+end

test/dummy/db/migrate/20231019180159_create_posts.rb

@@ -0,0 +1,10 @@
+class CreatePosts < ActiveRecord::Migration[7.2]
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+
+      t.timestamps
+    end
+  end
+end

test/dummy/db/schema.rb

@@ -10,7 +10,14 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2023_03_30_202955) do
+ActiveRecord::Schema[7.2].define(version: 2023_10_19_180159) do
+  create_table "posts", force: :cascade do |t|
+    t.string "title"
+    t.text "body"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "users", force: :cascade do |t|
     t.string "first_name"
     t.string "last_name"

test/ruby_lsp_rails/extension_test.rb renamed to test/ruby_lsp_rails/addon_test.rb

@@ -37,7 +37,54 @@ class HoverTest < ActiveSupport::TestCase
         stub_http_request("200", expected_response.to_json)
         @client.stubs(check_if_server_is_running!: true)
 
-        response = hover_on_source("User", { line: 0, character: 0 })
+        response = hover_on_source(<<~RUBY, { line: 3, character: 0 })
+          class User < ApplicationRecord
+          end
+
+          User
+        RUBY
+
+        assert_equal(<<~CONTENT, response.contents.value)
+          [Schema](file://#{@client.root}/db/schema.rb)
+
+          **id**: integer
+
+          **first_name**: string
+
+          **last_name**: string
+
+          **age**: integer
+
+          **created_at**: datetime
+
+          **updated_at**: datetime
+        CONTENT
+      end
+
+      test "return column information for namespaced models" do
+        expected_response = {
+          schema_file: "#{@client.root}/db/schema.rb",
+          columns: [
+            ["id", "integer"],
+            ["first_name", "string"],
+            ["last_name", "string"],
+            ["age", "integer"],
+            ["created_at", "datetime"],
+            ["updated_at", "datetime"],
+          ],
+        }
+
+        stub_http_request("200", expected_response.to_json)
+        @client.stubs(check_if_server_is_running!: true)
+
+        response = hover_on_source(<<~RUBY, { line: 4, character: 6 })
+          module Blog
+            class User < ApplicationRecord
+            end
+          end
+
+          Blog::User
+        RUBY
 
         assert_equal(<<~CONTENT, response.contents.value)
           [Schema](file://#{@client.root}/db/schema.rb)
@@ -65,7 +112,12 @@ class HoverTest < ActiveSupport::TestCase
         stub_http_request("200", expected_response.to_json)
         @client.stubs(check_if_server_is_running!: true)
 
-        response = hover_on_source("User", { line: 0, character: 0 })
+        response = hover_on_source(<<~RUBY, { line: 3, character: 0 })
+          class User < ApplicationRecord
+          end
+
+          User
+        RUBY
 
         assert_includes(
           response.contents.value,
@@ -82,7 +134,12 @@ class HoverTest < ActiveSupport::TestCase
         stub_http_request("200", expected_response.to_json)
         @client.stubs(check_if_server_is_running!: true)
 
-        response = hover_on_source("User", { line: 0, character: 0 })
+        response = hover_on_source(<<~RUBY, { line: 3, character: 0 })
+          class User < ApplicationRecord
+          end
+
+          User
+        RUBY
 
         refute_match(/Schema/, response.contents.value)
       end
@@ -116,7 +173,11 @@ class HoverTest < ActiveSupport::TestCase
       end
 
       test "shows documentation for Rails constants" do
-        value = hover_on_source("ActiveRecord::Base", { line: 0, character: 14 }).contents.value
+        value = hover_on_source(<<~RUBY, { line: 2, character: 14 }).contents.value
+          class ActiveRecord::Base
+          end
+          ActiveRecord::Base
+        RUBY
 
         assert_match(/\[Rails Document: `ActiveRecord::Base`\]/, value)
         assert_match(%r{\(https://api\.rubyonrails\.org/.*Base\.html\)}, value)
@@ -129,7 +190,11 @@ def hover_on_source(source, position)
         store = RubyLsp::Store.new
         store.set(uri: uri, source: source, version: 1)
 
-        response = RubyLsp::Executor.new(store, @message_queue).execute(
+        executor = RubyLsp::Executor.new(store, @message_queue)
+        executor.instance_variable_get(:@index).index_single(
+          RubyIndexer::IndexablePath.new(nil, T.must(uri.to_standardized_path)), source
+        )
+        response = executor.execute(
           {
             method: "textDocument/hover",
             params: {