ruby-lsp-rails 0.2.5 → 0.2.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/lib/ruby_lsp/ruby_lsp_rails/{extension.rb → addon.rb} +10 -8
- data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb +30 -32
- data/lib/ruby_lsp/ruby_lsp_rails/hover.rb +58 -30
- data/lib/ruby_lsp_rails/railtie.rb +2 -2
- data/lib/ruby_lsp_rails/version.rb +1 -1
- metadata +10 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d9abe40b8b01b5f0e7e81a3831b3da7fa57902d64f17cb0ce3a950d043d895ab
|
4
|
+
data.tar.gz: 02b60ff2b040617a25fea20d715066a17092459532f56dc08a4350997e1369bc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e76db2c3f6ea300e1b7a935b958a60b18a322e5039f518a0ccbc4efe2dbe7c69f65401987c0969d9fff479e3526831600a24788f477cbd19d3a2d528dc63a293
|
7
|
+
data.tar.gz: 1556932fe8c67752607b15e2520c2f71c0c88c2e1a005c78c1c72b31e49a2efac9e38a9da499bb91478ea8f8386661a269c18ab300809823d80c519cf517afa1
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Ruby LSP Rails
|
2
2
|
|
3
|
-
Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp)
|
3
|
+
Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for extra Rails editor features, such as:
|
4
4
|
|
5
5
|
- Displaying an ActiveRecord model's database columns and types when hovering over it
|
6
6
|
- Running tests and debugging tests through the terminal or the editor's UI
|
@@ -56,7 +56,7 @@ cause the test runner to hang.
|
|
56
56
|
This gem consists of two components that enable enhanced Rails functionality in the editor:
|
57
57
|
|
58
58
|
1. A Rack app that automatically exposes APIs when Rails server is running
|
59
|
-
1. A Ruby LSP
|
59
|
+
1. A Ruby LSP addon that connects to the exposed APIs to fetch runtime information from the Rails server
|
60
60
|
|
61
61
|
This is why the Rails server needs to be running for some features to work.
|
62
62
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
# typed: strict
|
2
2
|
# frozen_string_literal: true
|
3
3
|
|
4
|
-
require "ruby_lsp/
|
4
|
+
require "ruby_lsp/addon"
|
5
5
|
|
6
6
|
require_relative "rails_client"
|
7
7
|
require_relative "hover"
|
@@ -9,7 +9,7 @@ require_relative "code_lens"
|
|
9
9
|
|
10
10
|
module RubyLsp
|
11
11
|
module Rails
|
12
|
-
class
|
12
|
+
class Addon < ::RubyLsp::Addon
|
13
13
|
extend T::Sig
|
14
14
|
|
15
15
|
sig { returns(RailsClient) }
|
@@ -29,22 +29,24 @@ module RubyLsp
|
|
29
29
|
sig do
|
30
30
|
override.params(
|
31
31
|
uri: URI::Generic,
|
32
|
-
|
32
|
+
dispatcher: Prism::Dispatcher,
|
33
33
|
message_queue: Thread::Queue,
|
34
34
|
).returns(T.nilable(Listener[T::Array[Interface::CodeLens]]))
|
35
35
|
end
|
36
|
-
def create_code_lens_listener(uri,
|
37
|
-
CodeLens.new(uri,
|
36
|
+
def create_code_lens_listener(uri, dispatcher, message_queue)
|
37
|
+
CodeLens.new(uri, dispatcher, message_queue)
|
38
38
|
end
|
39
39
|
|
40
40
|
sig do
|
41
41
|
override.params(
|
42
|
-
|
42
|
+
nesting: T::Array[String],
|
43
|
+
index: RubyIndexer::Index,
|
44
|
+
dispatcher: Prism::Dispatcher,
|
43
45
|
message_queue: Thread::Queue,
|
44
46
|
).returns(T.nilable(Listener[T.nilable(Interface::Hover)]))
|
45
47
|
end
|
46
|
-
def create_hover_listener(
|
47
|
-
Hover.new(client,
|
48
|
+
def create_hover_listener(nesting, index, dispatcher, message_queue)
|
49
|
+
Hover.new(client, nesting, index, dispatcher, message_queue)
|
48
50
|
end
|
49
51
|
|
50
52
|
sig { override.returns(String) }
|
@@ -42,51 +42,49 @@ module RubyLsp
|
|
42
42
|
sig { override.returns(ResponseType) }
|
43
43
|
attr_reader :_response
|
44
44
|
|
45
|
-
sig { params(uri: URI::Generic,
|
46
|
-
def initialize(uri,
|
45
|
+
sig { params(uri: URI::Generic, dispatcher: Prism::Dispatcher, message_queue: Thread::Queue).void }
|
46
|
+
def initialize(uri, dispatcher, message_queue)
|
47
47
|
@_response = T.let([], ResponseType)
|
48
48
|
@path = T.let(uri.to_standardized_path, T.nilable(String))
|
49
|
-
|
49
|
+
dispatcher.register(self, :on_call_node_enter, :on_class_node_enter, :on_def_node_enter)
|
50
50
|
|
51
|
-
super(
|
51
|
+
super(dispatcher, message_queue)
|
52
52
|
end
|
53
53
|
|
54
|
-
sig { params(node:
|
55
|
-
def
|
56
|
-
message_value = node.message
|
57
|
-
return unless message_value == "test"
|
54
|
+
sig { params(node: Prism::CallNode).void }
|
55
|
+
def on_call_node_enter(node)
|
56
|
+
message_value = node.message
|
57
|
+
return unless message_value == "test"
|
58
58
|
|
59
|
-
|
59
|
+
arguments = node.arguments&.arguments
|
60
|
+
return unless arguments&.any?
|
60
61
|
|
61
|
-
|
62
|
-
|
62
|
+
first_argument = arguments.first
|
63
|
+
|
64
|
+
content = case first_argument
|
65
|
+
when Prism::StringConcatNode
|
66
|
+
left = first_argument.left
|
67
|
+
right = first_argument.right
|
63
68
|
# We only support two lines of concatenation on test names
|
64
|
-
if
|
65
|
-
|
66
|
-
|
69
|
+
if left.is_a?(Prism::StringNode) &&
|
70
|
+
right.is_a?(Prism::StringNode)
|
71
|
+
left.content + right.content
|
67
72
|
end
|
68
|
-
when
|
69
|
-
first_argument.
|
73
|
+
when Prism::StringNode
|
74
|
+
first_argument.content
|
70
75
|
end
|
71
76
|
|
72
|
-
|
73
|
-
return if parts.nil? || parts.empty?
|
74
|
-
|
75
|
-
# We can't handle interpolation yet
|
76
|
-
return unless parts.all? { |part| part.is_a?(SyntaxTree::TStringContent) }
|
77
|
-
|
78
|
-
test_name = parts.map(&:value).join
|
79
|
-
return if test_name.empty?
|
77
|
+
return unless content && !content.empty?
|
80
78
|
|
81
79
|
line_number = node.location.start_line
|
82
80
|
command = "#{BASE_COMMAND} #{@path}:#{line_number}"
|
83
|
-
add_test_code_lens(node, name:
|
81
|
+
add_test_code_lens(node, name: content, command: command, kind: :example)
|
84
82
|
end
|
85
83
|
|
86
84
|
# Although uncommon, Rails tests can be written with the classic "def test_name" syntax.
|
87
|
-
sig { params(node:
|
88
|
-
def
|
89
|
-
method_name = node.name.
|
85
|
+
sig { params(node: Prism::DefNode).void }
|
86
|
+
def on_def_node_enter(node)
|
87
|
+
method_name = node.name.to_s
|
90
88
|
if method_name.start_with?("test_")
|
91
89
|
line_number = node.location.start_line
|
92
90
|
command = "#{BASE_COMMAND} #{@path}:#{line_number}"
|
@@ -94,9 +92,9 @@ module RubyLsp
|
|
94
92
|
end
|
95
93
|
end
|
96
94
|
|
97
|
-
sig { params(node:
|
98
|
-
def
|
99
|
-
class_name = node.
|
95
|
+
sig { params(node: Prism::ClassNode).void }
|
96
|
+
def on_class_node_enter(node)
|
97
|
+
class_name = node.constant_path.slice
|
100
98
|
if class_name.end_with?("Test")
|
101
99
|
command = "#{BASE_COMMAND} #{@path}"
|
102
100
|
add_test_code_lens(node, name: class_name, command: command, kind: :group)
|
@@ -105,7 +103,7 @@ module RubyLsp
|
|
105
103
|
|
106
104
|
private
|
107
105
|
|
108
|
-
sig { params(node:
|
106
|
+
sig { params(node: Prism::Node, name: String, command: String, kind: Symbol).void }
|
109
107
|
def add_test_code_lens(node, name:, command:, kind:)
|
110
108
|
return unless @path
|
111
109
|
|
@@ -25,58 +25,86 @@ module RubyLsp
|
|
25
25
|
sig { override.returns(ResponseType) }
|
26
26
|
attr_reader :_response
|
27
27
|
|
28
|
-
sig
|
29
|
-
|
30
|
-
|
28
|
+
sig do
|
29
|
+
params(
|
30
|
+
client: RailsClient,
|
31
|
+
nesting: T::Array[String],
|
32
|
+
index: RubyIndexer::Index,
|
33
|
+
dispatcher: Prism::Dispatcher,
|
34
|
+
message_queue: Thread::Queue,
|
35
|
+
).void
|
36
|
+
end
|
37
|
+
def initialize(client, nesting, index, dispatcher, message_queue)
|
38
|
+
super(dispatcher, message_queue)
|
31
39
|
|
32
40
|
@_response = T.let(nil, ResponseType)
|
33
41
|
@client = client
|
34
|
-
|
42
|
+
@nesting = nesting
|
43
|
+
@index = index
|
44
|
+
dispatcher.register(self, :on_constant_path_node_enter, :on_constant_read_node_enter, :on_call_node_enter)
|
35
45
|
end
|
36
46
|
|
37
|
-
sig { params(node:
|
38
|
-
def
|
39
|
-
|
40
|
-
return
|
47
|
+
sig { params(node: Prism::ConstantPathNode).void }
|
48
|
+
def on_constant_path_node_enter(node)
|
49
|
+
entries = @index.resolve(node.slice, @nesting)
|
50
|
+
return unless entries
|
41
51
|
|
42
|
-
|
52
|
+
name = T.must(entries.first).name
|
43
53
|
content = +""
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
54
|
+
column_info = generate_column_content(name)
|
55
|
+
content << column_info if column_info
|
56
|
+
|
57
|
+
urls = Support::RailsDocumentClient.generate_rails_document_urls(name)
|
58
|
+
content << urls.join("\n\n") unless urls.empty?
|
59
|
+
return if content.empty?
|
60
|
+
|
48
61
|
contents = RubyLsp::Interface::MarkupContent.new(kind: "markdown", value: content)
|
49
|
-
@_response = RubyLsp::Interface::Hover.new(range:
|
62
|
+
@_response = RubyLsp::Interface::Hover.new(range: range_from_location(node.location), contents: contents)
|
50
63
|
end
|
51
64
|
|
52
|
-
sig { params(node:
|
53
|
-
def
|
54
|
-
|
55
|
-
|
56
|
-
|
65
|
+
sig { params(node: Prism::ConstantReadNode).void }
|
66
|
+
def on_constant_read_node_enter(node)
|
67
|
+
entries = @index.resolve(node.name.to_s, @nesting)
|
68
|
+
return unless entries
|
69
|
+
|
70
|
+
content = generate_column_content(T.must(entries.first).name)
|
71
|
+
return unless content
|
57
72
|
|
58
|
-
|
59
|
-
|
60
|
-
@_response = generate_rails_document_link_hover(full_constant_name(node), node)
|
73
|
+
contents = RubyLsp::Interface::MarkupContent.new(kind: "markdown", value: content)
|
74
|
+
@_response = RubyLsp::Interface::Hover.new(range: range_from_location(node.location), contents: contents)
|
61
75
|
end
|
62
76
|
|
63
|
-
sig { params(node:
|
64
|
-
def
|
65
|
-
|
66
|
-
|
77
|
+
sig { params(node: Prism::CallNode).void }
|
78
|
+
def on_call_node_enter(node)
|
79
|
+
message_value = node.message
|
80
|
+
message_loc = node.message_loc
|
81
|
+
|
82
|
+
return unless message_value && message_loc
|
67
83
|
|
68
|
-
@_response = generate_rails_document_link_hover(
|
84
|
+
@_response = generate_rails_document_link_hover(message_value, message_loc)
|
69
85
|
end
|
70
86
|
|
71
87
|
private
|
72
88
|
|
73
|
-
sig { params(name: String
|
74
|
-
def
|
89
|
+
sig { params(name: String).returns(T.nilable(String)) }
|
90
|
+
def generate_column_content(name)
|
91
|
+
model = @client.model(name)
|
92
|
+
return if model.nil?
|
93
|
+
|
94
|
+
schema_file = model[:schema_file]
|
95
|
+
content = +""
|
96
|
+
content << "[Schema](#{URI::Generic.build(scheme: "file", path: schema_file)})\n\n" if schema_file
|
97
|
+
content << model[:columns].map { |name, type| "**#{name}**: #{type}\n" }.join("\n")
|
98
|
+
content
|
99
|
+
end
|
100
|
+
|
101
|
+
sig { params(name: String, location: Prism::Location).returns(T.nilable(Interface::Hover)) }
|
102
|
+
def generate_rails_document_link_hover(name, location)
|
75
103
|
urls = Support::RailsDocumentClient.generate_rails_document_urls(name)
|
76
104
|
return if urls.empty?
|
77
105
|
|
78
106
|
contents = RubyLsp::Interface::MarkupContent.new(kind: "markdown", value: urls.join("\n\n"))
|
79
|
-
RubyLsp::Interface::Hover.new(range:
|
107
|
+
RubyLsp::Interface::Hover.new(range: range_from_location(location), contents: contents)
|
80
108
|
end
|
81
109
|
end
|
82
110
|
end
|
@@ -27,8 +27,8 @@ module RubyLsp
|
|
27
27
|
app_uri_path.write(app_uri)
|
28
28
|
|
29
29
|
at_exit do
|
30
|
-
# The app_uri.txt file should only exist when the server is running. The
|
31
|
-
# report if the server is running or not. If the server is not running, some of the
|
30
|
+
# The app_uri.txt file should only exist when the server is running. The addon uses its presence to
|
31
|
+
# report if the server is running or not. If the server is not running, some of the addon features
|
32
32
|
# will not be available.
|
33
33
|
File.delete(app_uri_path) if File.exist?(app_uri_path)
|
34
34
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ruby-lsp-rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.7
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Shopify
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-10-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|
@@ -30,20 +30,20 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - ">="
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 0.
|
33
|
+
version: 0.12.0
|
34
34
|
- - "<"
|
35
35
|
- !ruby/object:Gem::Version
|
36
|
-
version: 0.
|
36
|
+
version: 0.13.0
|
37
37
|
type: :runtime
|
38
38
|
prerelease: false
|
39
39
|
version_requirements: !ruby/object:Gem::Requirement
|
40
40
|
requirements:
|
41
41
|
- - ">="
|
42
42
|
- !ruby/object:Gem::Version
|
43
|
-
version: 0.
|
43
|
+
version: 0.12.0
|
44
44
|
- - "<"
|
45
45
|
- !ruby/object:Gem::Version
|
46
|
-
version: 0.
|
46
|
+
version: 0.13.0
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
48
|
name: sorbet-runtime
|
49
49
|
requirement: !ruby/object:Gem::Requirement
|
@@ -58,7 +58,7 @@ dependencies:
|
|
58
58
|
- - ">="
|
59
59
|
- !ruby/object:Gem::Version
|
60
60
|
version: 0.5.9897
|
61
|
-
description: A Ruby LSP
|
61
|
+
description: A Ruby LSP addon that adds extra editor functionality for Rails applications
|
62
62
|
email:
|
63
63
|
- ruby@shopify.com
|
64
64
|
executables: []
|
@@ -69,8 +69,8 @@ files:
|
|
69
69
|
- README.md
|
70
70
|
- Rakefile
|
71
71
|
- lib/ruby-lsp-rails.rb
|
72
|
+
- lib/ruby_lsp/ruby_lsp_rails/addon.rb
|
72
73
|
- lib/ruby_lsp/ruby_lsp_rails/code_lens.rb
|
73
|
-
- lib/ruby_lsp/ruby_lsp_rails/extension.rb
|
74
74
|
- lib/ruby_lsp/ruby_lsp_rails/hover.rb
|
75
75
|
- lib/ruby_lsp/ruby_lsp_rails/rails_client.rb
|
76
76
|
- lib/ruby_lsp/ruby_lsp_rails/support/rails_document_client.rb
|
@@ -101,8 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
101
101
|
- !ruby/object:Gem::Version
|
102
102
|
version: '0'
|
103
103
|
requirements: []
|
104
|
-
rubygems_version: 3.4.
|
104
|
+
rubygems_version: 3.4.21
|
105
105
|
signing_key:
|
106
106
|
specification_version: 4
|
107
|
-
summary: A Ruby LSP
|
107
|
+
summary: A Ruby LSP addon for Rails
|
108
108
|
test_files: []
|