class RubyLsp::Rails::CodeLens

This feature adds several CodeLens features for Rails applications using Active Support test cases:

Run tests in the VS Terminal
Run tests in the VS Code Test Explorer
Debug tests

The code lens request informs the editor of runnable commands such as tests. It’s available for tests which inherit from ActiveSupport::TestCase or one of its descendants, such as ActionDispatch::IntegrationTest.

Example:¶ ↑

For the following code, Code Lenses will be added above the class definition above each test method.

“‘ruby Run class HelloTest < ActiveSupport::TestCase # <- Will show code lenses above for running or debugging the whole test test “outputs hello” do # <- Will show code lenses above for running or debugging this test # … end

test “outputs goodbye” do # <- Will show code lenses above for running or debugging this test # … end end ““

The code lenses will be displayed above the class and above each test method.

Note: When using the Test Explorer view, if your code contains a statement to pause execution (e.g. debugger) it will cause the test runner to hang.

Public Class Methods

new(response_builder, uri, dispatcher)

# File lib/ruby_lsp/ruby_lsp_rails/code_lens.rb, line 53
def initialize(response_builder, uri, dispatcher)
  @response_builder = response_builder
  @path = T.let(uri.to_standardized_path, T.nilable(String))
  @group_id = T.let(1, Integer)
  @group_id_stack = T.let([], T::Array[Integer])

  dispatcher.register(self, :on_call_node_enter, :on_class_node_enter, :on_def_node_enter, :on_class_node_leave)
end

Public Instance Methods

on_call_node_enter(node)

# File lib/ruby_lsp/ruby_lsp_rails/code_lens.rb, line 63
def on_call_node_enter(node)
  content = extract_test_case_name(node)

  return unless content

  line_number = node.location.start_line
  command = "#{test_command} #{@path}:#{line_number}"
  add_test_code_lens(node, name: content, command: command, kind: :example)
end

on_class_node_enter(node)

# File lib/ruby_lsp/ruby_lsp_rails/code_lens.rb, line 85
def on_class_node_enter(node)
  class_name = node.constant_path.slice
  if class_name.end_with?("Test")
    command = "#{test_command} #{@path}"
    add_test_code_lens(node, name: class_name, command: command, kind: :group)
    @group_id_stack.push(@group_id)
    @group_id += 1
  end
end

on_class_node_leave(node)

# File lib/ruby_lsp/ruby_lsp_rails/code_lens.rb, line 96
def on_class_node_leave(node)
  class_name = node.constant_path.slice
  if class_name.end_with?("Test")
    @group_id_stack.pop
  end
end

on_def_node_enter(node)

# File lib/ruby_lsp/ruby_lsp_rails/code_lens.rb, line 75
def on_def_node_enter(node)
  method_name = node.name.to_s
  if method_name.start_with?("test_")
    line_number = node.location.start_line
    command = "#{test_command} #{@path}:#{line_number}"
    add_test_code_lens(node, name: method_name, command: command, kind: :example)
  end
end

class RubyLsp::Rails::CodeLens

Example:¶ ↑

Public Class Methods

new(response_builder, uri, dispatcher) Show source

Public Instance Methods

on_call_node_enter(node) Show source

on_class_node_enter(node) Show source

on_class_node_leave(node) Show source

on_def_node_enter(node) Show source

new(response_builder, uri, dispatcher)

on_call_node_enter(node)

on_class_node_enter(node)

on_class_node_leave(node)

on_def_node_enter(node)