ruby-lsp-rspec 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96d32309254df952d00b15dc1a00511df1f9f0c89eacd55882194739ea57b7b0
-  data.tar.gz: fa9accef54584ffaa86299c6e975f5c5b1298caacc91bc497fde97d66a0b703c
+  metadata.gz: 8ee975e071dae85f67f651eae432c395c5e1e11ce0e49d3287a109f4b6bb4015
+  data.tar.gz: fe19cccd32213234a643ed076809a9dda8a5e732c5df4a3f692cc8b48976dc82
 SHA512:
-  metadata.gz: 8b611c0e6ec010041a1fcc2dac6bd8a0bbe6adebb7d99bf8d420c4f44ab3bc2a6b7e1d1aaed6535817c3e1c3d502f598c07f0c7d21f0510f4724fb1e0d749c80
-  data.tar.gz: e5cedb8932a7a5ce6e9b097642e12b39efe2f5e1694d7f26b33712f72ed11b97861e5d8a4e6eb7dc6bb180d1d304e4c9866a59f45a8826dbfb4fadee277d1527
+  metadata.gz: b413a288abc15b33c20447eea18e8c6825b3ec27c16e3919c9012c492062491b628952d7b3507b5067751f6ae4cba30de1baa069e087e3f6c30940c10835135b
+  data.tar.gz: ff98f027f9d7be1a9d2db2ddde55dc5fce4039a22ce406e34afd6beeadc526bd412ed0e57343bf36a712db23d4b9aff393bf5f555918da6884d5847d7770ff30

data/README.md

@@ -4,8 +4,6 @@
 
 Ruby LSP RSpec is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for displaying CodeLens for RSpec tests.
 
-![Screenshot of the code lenses](/misc/example.gif)
-
 ## Installation
 
 To install, add the following line to your application's Gemfile:
@@ -19,14 +17,41 @@ end
 
 After running `bundle install`, restart Ruby LSP and you should start seeing CodeLens in your RSpec test files.
 
-## Usages (with VS Code)
+## Features
+
+### CodeLens
+
+1. When clicking `Run`, the test(s) will be executed via the Test Explorer
+    - However, deeply nested tests may not be displayed correctly at the moment
+2. When clicking `Run In Terminal`, a test command will be generated in the terminal
+3. When clicking `Debug`, the test(s) will be executed with VS Code debugger enabled (requires the [`debug`](https://github.com/ruby/debug) gem)
+    - [Learn how to set breakpoints in VS Code](https://code.visualstudio.com/docs/editor/debugging#_breakpoints)
+
+<img src="misc/code-lens.gif" alt="CodeLens" width="75%">
+
+### Document Symbols
+
+Document Symbols can be triggered by:
+
+- Typing `@` in VS Code's command palette
+- Pressing `Cmd+Shift+O`
+
+<img src="misc/document-symbol.gif" alt="Document Symbols" width="75%">
+
+### Go to definition
+
+`ruby-lsp-rspec` supports go-to-definition on methods defined through `let` and `subject` DSLs in spec files.
+
+In VS Code this feature can be triggered by one of the following methods:
+
+- `Right click` on the target, and then select `Go to Definition`
+- Placing the cursor on the target, and then hit `F12`
+- `Command + click` the target
 
-1. When clicking `Run`, the test(s) will be executed via the Test Explorer.
-    - However, deeply nested tests may not be displayed correctly at the moment.
-2. When clicking `Run In Terminal`, a test command will be generated in the terminal.
-3. When clicking `Debug`, the test(s) will be executed with VS Code debugger enabled (requires the [`debug`](https://github.com/ruby/debug) gem).
-    - [Learn how to set breakpoints in VS Code](https://code.visualstudio.com/docs/editor/debugging#_breakpoints).
+> [!Note]
+> This feature requires indexing your spec files so they can't be excluded from Ruby LSP's indexing.
 
+<img src="misc/go-to-definition.gif" alt="Go to definition" width="75%">
 
 ## Development
 

data/lib/ruby_lsp/ruby_lsp_rspec/addon.rb

@@ -6,6 +6,8 @@ require "ruby_lsp/internal"
 
 require_relative "code_lens"
 require_relative "document_symbol"
+require_relative "definition"
+require_relative "indexing_enhancement"
 
 module RubyLsp
   module RSpec
@@ -13,7 +15,10 @@ module RubyLsp
       extend T::Sig
 
       sig { override.params(global_state: GlobalState, message_queue: Thread::Queue).void }
-      def activate(global_state, message_queue); end
+      def activate(global_state, message_queue)
+        @index = T.let(global_state.index, T.nilable(RubyIndexer::Index))
+        global_state.index.register_enhancement(IndexingEnhancement.new)
+      end
 
       sig { override.void }
       def deactivate; end
@@ -47,6 +52,21 @@ module RubyLsp
         DocumentSymbol.new(response_builder, dispatcher)
       end
 
+      sig do
+        override.params(
+          response_builder: ResponseBuilders::CollectionResponseBuilder[T.any(
+            Interface::Location,
+            Interface::LocationLink,
+          )],
+          uri: URI::Generic,
+          node_context: NodeContext,
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      def create_definition_listener(response_builder, uri, node_context, dispatcher)
+        Definition.new(response_builder, uri, node_context, T.must(@index), dispatcher)
+      end
+
       sig { override.returns(String) }
       def name
         "Ruby LSP RSpec"

data/lib/ruby_lsp/ruby_lsp_rspec/code_lens.rb

@@ -21,6 +21,7 @@ module RubyLsp
         @path = T.let(T.must(uri.to_standardized_path), String)
         @group_id = T.let(1, Integer)
         @group_id_stack = T.let([], T::Array[Integer])
+        @anonymous_example_count = T.let(0, Integer)
         dispatcher.register(self, :on_call_node_enter, :on_call_node_leave)
 
         @base_command = T.let(
@@ -93,7 +94,8 @@ module RubyLsp
             argument.slice
           end
         else
-          "<unnamed>"
+          @anonymous_example_count += 1
+          "<unnamed-#{@anonymous_example_count}>"
         end
       end
 

data/lib/ruby_lsp/ruby_lsp_rspec/definition.rb

@@ -0,0 +1,55 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module RSpec
+    class Definition
+      extend T::Sig
+
+      include ::RubyLsp::Requests::Support::Common
+
+      sig do
+        params(
+          response_builder: ResponseBuilders::CollectionResponseBuilder[T.any(
+            Interface::Location,
+            Interface::LocationLink,
+          )],
+          uri: URI::Generic,
+          node_context: NodeContext,
+          index: RubyIndexer::Index,
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      def initialize(response_builder, uri, node_context, index, dispatcher)
+        @response_builder = response_builder
+        @uri = uri
+        @node_context = node_context
+        @index = index
+        dispatcher.register(self, :on_call_node_enter)
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_enter(node)
+        message = node.message
+        return unless message
+
+        return if @node_context.locals_for_scope.include?(message)
+
+        entries = @index[message]
+        return unless entries
+        return if entries.empty?
+
+        entries.each do |entry|
+          # Technically, let can be defined in a different file, but we're not going to handle that case yet
+          next unless entry.file_path == @uri.to_standardized_path
+
+          @response_builder << Interface::LocationLink.new(
+            target_uri: URI::Generic.from_path(path: entry.file_path).to_s,
+            target_range: range_from_location(entry.location),
+            target_selection_range: range_from_location(entry.name_location),
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rspec/document_symbol.rb

@@ -74,7 +74,7 @@ module RubyLsp
 
         case argument
         when Prism::StringNode
-          argument.content.dump
+          argument.unescaped
         when Prism::CallNode
           "<#{argument.name}>"
         when nil

data/lib/ruby_lsp/ruby_lsp_rspec/indexing_enhancement.rb

@@ -0,0 +1,95 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module RSpec
+    class IndexingEnhancement
+      extend T::Sig
+      include RubyIndexer::Enhancement
+
+      sig do
+        override.params(
+          index: RubyIndexer::Index,
+          owner: T.nilable(RubyIndexer::Entry::Namespace),
+          node: Prism::CallNode,
+          file_path: String,
+          code_units_cache: T.any(
+            T.proc.params(arg0: Integer).returns(Integer),
+            Prism::CodeUnitsCache,
+          ),
+        ).void
+      end
+      def on_call_node(index, owner, node, file_path, code_units_cache)
+        return if node.receiver
+
+        name = node.name
+
+        case name
+        when :let, :let!
+          block_node = node.block
+          return unless block_node
+
+          arguments = node.arguments
+          return unless arguments
+
+          return if arguments.arguments.count != 1
+
+          method_name_node = T.must(arguments.arguments.first)
+
+          method_name = case method_name_node
+          when Prism::StringNode
+            method_name_node.slice
+          when Prism::SymbolNode
+            method_name_node.unescaped
+          end
+
+          return unless method_name
+
+          index.add(RubyIndexer::Entry::Method.new(
+            method_name,
+            file_path,
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
+            nil,
+            [RubyIndexer::Entry::Signature.new([])],
+            RubyIndexer::Entry::Visibility::PUBLIC,
+            owner,
+          ))
+        when :subject, :subject!
+          block_node = node.block
+          return unless block_node
+
+          arguments = node.arguments
+
+          if arguments && arguments.arguments.count == 1
+            method_name_node = T.must(arguments.arguments.first)
+          end
+
+          method_name = if method_name_node
+            case method_name_node
+            when Prism::StringNode
+              method_name_node.slice
+            when Prism::SymbolNode
+              method_name_node.unescaped
+            end
+          else
+            "subject"
+          end
+
+          return unless method_name
+
+          index.add(RubyIndexer::Entry::Method.new(
+            method_name,
+            file_path,
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
+            nil,
+            [RubyIndexer::Entry::Signature.new([])],
+            RubyIndexer::Entry::Visibility::PUBLIC,
+            owner,
+          ))
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp_rspec/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module RSpec
-    VERSION = "0.1.14"
+    VERSION = "0.1.16"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.16
 platform: ruby
 authors:
 - Stan Lo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-03 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.1
 description: RSpec addon for ruby-lsp
 email:
 - stan001212@gmail.com
@@ -41,7 +41,9 @@ files:
 - lib/ruby-lsp-rspec.rb
 - lib/ruby_lsp/ruby_lsp_rspec/addon.rb
 - lib/ruby_lsp/ruby_lsp_rspec/code_lens.rb
+- lib/ruby_lsp/ruby_lsp_rspec/definition.rb
 - lib/ruby_lsp/ruby_lsp_rspec/document_symbol.rb
+- lib/ruby_lsp/ruby_lsp_rspec/indexing_enhancement.rb
 - lib/ruby_lsp_rspec/version.rb
 homepage: https://github.com/st0012/ruby-lsp-rspec
 licenses: