Add code lens extension (for Rails) #67

andyw8 · 2023-05-08T21:37:54Z

Based on #59

Reminder: Ensure @adisonlampert is credited in the release notes.

This depends on Shopify/vscode-ruby-lsp#639

TODO:

Get working with Test Explorer
Verify Debug CodeLens
Update docs
Add screenshot gif
Specify minimum Ruby LSP version (needs Make Common#create_code_lens more re-usable ruby-lsp#734 to be released). Also remove the Gemfile entry.
Update types (avoid T.unsafe)

Testing

  gem "ruby-lsp", github: "Shopify/ruby-lsp"
  gem "ruby-lsp-rails", github: "Shopify/ruby-lsp-rails", branch: "andyw8/add-code-lens-extension"

andyw8 · 2023-06-01T13:18:53Z

Note: This will requires changes if Shopify/ruby-lsp#734 is merged.

lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

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


lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

+        @response = T.let([], ResponseType)
+        @visibility = T.let("public", String)
+        @prev_visibility = T.let("public", String)
+        @path = T.let(uri.delete_prefix("file://"), String)


andyw8 · 2023-06-23T19:04:45Z

test/ruby_lsp_rails/code_lens_test.rb

+        assert_match("Debug", response[5].command.title)
+
+      ensure
+        RubyLsp::Requests::Hover.listeners.clear


We don't actually need this line, I've removed it.

test/ruby_lsp_rails/code_lens_test.rb

+        assert_match("Debug", response[5].command.title)
+
+      ensure
+        RubyLsp::Requests::Hover.listeners.clear


test/ruby_lsp_rails/code_lens_test.rb

+  module Rails
+    class CodeLensTest < ActiveSupport::TestCase
+      test "recognizes Rails Active Support test cases" do
+        message_queue = Thread::Queue.new


andyw8 · 2023-06-26T20:23:27Z

lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

+        @visibility = T.let("public", String)
+        @prev_visibility = T.let("public", String)


That may have been accidentally removed in a refactoring, but probably means we are missing a test, I'll look into.

Actually, these can just be removed. Methods defined with test do don't respect public/private/protected. (see Slack conversation in team channel from June 21).

egiurleo

🎉 🎉 🎉 Yay this is so cool!

vinistock

Vini & Stan

vinistock · 2023-06-27T14:18:30Z

lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

+  module Rails
+    # ![CodeLens demo](../../code_lens.gif)
+    #
+    # This feature adds several CodeLens features for Rails applications using the built-in test framework:


Let's say Active Support test cases.

vinistock · 2023-06-27T14:19:19Z

lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

+    # [code lens](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeLens)
+    # request informs the editor of runnable commands such as tests
+    #
+    # Example:


Suggested change

# Example:

# # Example

vinistock · 2023-06-27T14:19:43Z

lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

+    # ```ruby
+    # Run
+    # class HelloTest < ActiveSupport::TestCase
+    #   test "outputs hello" do


Suggested change

# test "outputs hello" do

# test "outputs hello" do # <- Will show code lenses for executing this test

sorbet/rbi/gems/[email protected]

andyw8 mentioned this pull request May 8, 2023

Add code lens extension (for Rails tests) #59

Closed

andyw8 assigned andyw8 and unassigned andyw8 May 8, 2023

andyw8 added this to the 2023-Q2 milestone May 8, 2023

andyw8 mentioned this pull request May 9, 2023

Remove unnecessary check for test_ in test name Shopify/vscode-ruby-lsp#604

Closed

andyw8 mentioned this pull request Jun 1, 2023

Make Common#create_code_lens more re-usable Shopify/ruby-lsp#734

Merged

andyw8 force-pushed the andyw8/add-code-lens-extension branch from 7d7a71c to a24b469 Compare June 9, 2023 19:49

andyw8 added the enhancement New feature or request label Jun 9, 2023

andyw8 mentioned this pull request Jun 10, 2023

Use testItem kind to determine if running single test or test file Shopify/vscode-ruby-lsp#639

Merged

andyw8 mentioned this pull request Jun 19, 2023

Schema display on hover does not show latest changes #84

Closed

andyw8 force-pushed the andyw8/add-code-lens-extension branch from 8e4899b to f44c5c4 Compare June 20, 2023 20:33

andyw8 mentioned this pull request Jun 23, 2023

Change how we warn about server not running #88

Merged

vinistock reviewed Jun 23, 2023

View reviewed changes

andyw8 force-pushed the andyw8/add-code-lens-extension branch 4 times, most recently from 347fe08 to 30624fa Compare June 23, 2023 19:05

Add Code Lens extension for Rails tests

abb108b

andyw8 force-pushed the andyw8/add-code-lens-extension branch from 30624fa to abb108b Compare June 23, 2023 19:13

andyw8 added 2 commits June 23, 2023 16:16

Use absolute path when running tests

8c79094

Add screen capture for Code Lens test runner

f7cd872

andyw8 marked this pull request as ready for review June 26, 2023 19:34

andyw8 requested a review from a team as a code owner June 26, 2023 19:34

andyw8 requested review from st0012 and egiurleo June 26, 2023 19:34

andyw8 mentioned this pull request Jun 26, 2023

Bump ruby-lsp from 0.6.1 to 0.6.2 #91

Closed

egiurleo reviewed Jun 26, 2023

View reviewed changes

No need to check method visibility

77f8535

egiurleo approved these changes Jun 26, 2023

View reviewed changes

vinistock approved these changes Jun 27, 2023

View reviewed changes

andyw8 added 5 commits June 27, 2023 10:32

Update ruby-lsp RBI

553288d

Update test framework name

66034f0

Fix example header formatting

6af3e6d

Update docs

446e845

Update wording

28e0786

andyw8 merged commit 9b72a87 into main Jun 27, 2023

andyw8 deleted the andyw8/add-code-lens-extension branch June 27, 2023 14:52

andyw8 mentioned this pull request Jun 27, 2023

Update README for Code Lens features #94

Merged

shopify-shipit bot temporarily deployed to production June 30, 2023 19:47 Inactive

		@visibility = T.let("public", String)
		@prev_visibility = T.let("public", String)

	# test "outputs hello" do
	# test "outputs hello" do # <- Will show code lenses for executing this test

Add code lens extension (for Rails) #67

Add code lens extension (for Rails) #67

Uh oh!

Conversation

andyw8 commented May 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

Uh oh!

andyw8 commented Jun 1, 2023

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

andyw8 Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

andyw8 Jun 26, 2023

Choose a reason for hiding this comment

Uh oh!

andyw8 Jun 26, 2023

Choose a reason for hiding this comment

Uh oh!

egiurleo left a comment

Choose a reason for hiding this comment

Uh oh!

vinistock left a comment

Choose a reason for hiding this comment

Uh oh!

vinistock Jun 27, 2023

Choose a reason for hiding this comment

Uh oh!

vinistock Jun 27, 2023

Choose a reason for hiding this comment

Uh oh!

vinistock Jun 27, 2023

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

andyw8 commented May 8, 2023 •

edited

Loading