Skip to content

Add code lens extension (for Rails tests) #59

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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
74 changes: 74 additions & 0 deletions lib/ruby_lsp/ruby_lsp_rails/code_lens.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# typed: strict
# frozen_string_literal: true

module RubyLsp
module Rails
class CodeLens < ::RubyLsp::Listener
extend T::Sig
extend T::Generic

ResponseType = type_member { { fixed: T.nilable(T::Array[::RubyLsp::Interface::CodeLens]) } }

::RubyLsp::Requests::CodeLens.add_listener(self)

sig { override.returns(ResponseType) }
attr_reader :response

sig { params(uri: String, message_queue: Thread::Queue).void }
def initialize(uri, message_queue)
@response = T.let([], ResponseType)
@visibility = T.let("public", String)
@prev_visibility = T.let("public", String)
@path = T.let(uri.delete_prefix("file://"), String)
super
end

listener_events do
sig { params(node: SyntaxTree::Command).void }
def on_command(node)
if @visibility == "public"
message_value = node.message.value
if message_value == "test" && node.arguments.parts.any?
first_argument = node.arguments.parts.first
method_name = first_argument.parts.first.value if first_argument.is_a?(SyntaxTree::StringLiteral)

if method_name
add_code_lens(
node,
name: method_name,
command: RubyLsp::Requests::CodeLens::BASE_COMMAND + @path + " --name " + "test_" + method_name.gsub(
" ", "_"
),
)
end
end
end
end

sig { params(node: SyntaxTree::DefNode).void }
def on_def(node); end
end

private

sig { params(node: SyntaxTree::Node, name: String, command: String).void }
def add_code_lens(node, name:, command:)
@response << ::RubyLsp::Requests::CodeLens.create_code_lens(
node,
path: @path,
name: name,
test_command: command,
type: "test",
)

@response << ::RubyLsp::Requests::CodeLens.create_code_lens(
node,
path: @path,
name: name,
test_command: command,
type: "debug",
)
end
end
end
end
1 change: 1 addition & 0 deletions lib/ruby_lsp/ruby_lsp_rails/extension.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

require_relative "rails_client"
require_relative "hover"
require_relative "code_lens"

module RubyLsp
module Rails
Expand Down
4 changes: 2 additions & 2 deletions lib/ruby_lsp/ruby_lsp_rails/hover.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ class Hover < ::RubyLsp::Listener
sig { override.returns(ResponseType) }
attr_reader :response

sig { void }
def initialize
sig { params(uri: String, message_queue: Thread::Queue).void }
def initialize(uri, message_queue)
@response = T.let(nil, ResponseType)
super
end
Expand Down
25 changes: 25 additions & 0 deletions test/ruby_lsp_rails/code_lens_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# typed: true
# frozen_string_literal: true

require "test_helper"

module RubyLsp
module Rails
class CodeLensTest < ActiveSupport::TestCase
test "recognizes Rails active support test cases" do
message_queue = Thread::Queue.new
listener = CodeLens.new("", message_queue)

test_name = "handles test case"

RubyLsp::EventEmitter.new(listener).emit_for_target(Command(
Ident("test"),
Args([StringLiteral([TStringContent(test_name)], "")]),
BodyStmt(SyntaxTree::VoidStmt, "", "", "", ""),
))

assert_equal(test_name, T.must(T.must(listener.response).first).command.arguments[1])
end
end
end
end
9 changes: 6 additions & 3 deletions test/ruby_lsp_rails/hover_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ class HoverTest < ActiveSupport::TestCase
],
}

listener = Hover.new
message_queue = Thread::Queue.new
listener = Hover.new("", message_queue)

stub_http_request("200", expected_response.to_json)
RailsClient.instance.stubs(check_if_server_is_running!: true)
Expand Down Expand Up @@ -48,7 +49,8 @@ class HoverTest < ActiveSupport::TestCase
columns: [],
}

listener = Hover.new
message_queue = Thread::Queue.new
listener = Hover.new("", message_queue)

stub_http_request("200", expected_response.to_json)
RailsClient.instance.stubs(check_if_server_is_running!: true)
Expand All @@ -66,7 +68,8 @@ class HoverTest < ActiveSupport::TestCase
columns: [],
}

listener = Hover.new
message_queue = Thread::Queue.new
listener = Hover.new("", message_queue)

stub_http_request("200", expected_response.to_json)
RailsClient.instance.stubs(check_if_server_is_running!: true)
Expand Down