Skip to content

Enhance schema hover link to jump to the right table #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Enhance schema hover link to jump to the right table #212

Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
60cc1fe
Add schema collector
faraazahmad Dec 18, 2023
abe9229
add types
faraazahmad Dec 18, 2023
77da138
fix operator typo
faraazahmad Dec 18, 2023
e3f748f
add RubyLsp::Rails module
faraazahmad Dec 18, 2023
3d9b762
incorporate changes by @wbhouston
faraazahmad Jan 10, 2024
63bf2c1
fix schema collector test
faraazahmad Jan 10, 2024
da54d63
fix rack app test
faraazahmad Jan 10, 2024
4d97874
Update lib/ruby_lsp/ruby_lsp_rails/hover.rb
faraazahmad Jan 20, 2024
5f65cb9
fix: address comments
faraazahmad Jan 29, 2024
633edc5
Fix typing and linting
andyw8 Jan 29, 2024
0e414a7
fix: move schema file into class
faraazahmad Jan 31, 2024
c24d3d5
Update lib/ruby_lsp/ruby_lsp_rails/hover.rb
faraazahmad Mar 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions lib/ruby_lsp/ruby_lsp_rails/schema_collector.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# typed: strict
# frozen_string_literal: true

module RubyLsp
module Rails
class SchemaCollector < Prism::Visitor
extend T::Sig

sig { returns(T::Hash[String, Prism::Location]) }
attr_reader :tables

sig { void }
def initialize
@tables = {}

super
end

sig { params(node: Prism::CallNode).void }
def visit_call_node(node)
return if node.block.nil?

node.block.body.child_nodes.each do |child_node|
next unless child_node.is_a?(Prism::CallNode)
next unless child_node.name == :create_table

table_name = child_node.arguments.child_nodes.first.content
@tables[table_name.classify] = child_node.location
end
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not necessary to traverse the nodes directly within a Prism::Visitor. Per the documentation:

  def visit_call_node(node)
    if node.name == "foo"
      # Do something with the node
    end

    # Call super so that the visitor continues walking the tree
    super
  end

So this could be restructured to look like:

def visit_call_node(node)
  if node.name == 'create_table'
    # ensure the first argument is a string node and store the location
  end

  super
end

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @wbhouston! Thank you for these changes, they look great to me! Feel free to commit these changes to this PR

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@faraazahmad it won't be possible for @wbhouston to push to your branch.

end
end
end
end