ruby-lsp-rspec 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79c44a257a6397dd3c0fc255c4bcc32b8766d1430f6c5f3e8fb31349615b549a
-  data.tar.gz: 31f87a129243a71c60759e239a7e48b0333dfdb85da5e48b34c6dfa48fea53d8
+  metadata.gz: 43af0ed802cbfedcb5157150ca7a532347bd61d7f672bd3a3c70decb6460422b
+  data.tar.gz: 9a9a54650225821e7a5296090f6a546febfb4040eeecc3c8405040c3b8a390cd
 SHA512:
-  metadata.gz: 1ab1b4fb860e5cc8793b46e6c18d5dd819f97288530ad8ed37f6fc975e3ad3e8ac36e25a77ce7665f85a805a3926f4adf9e8a352d8112f68d958588d50cbb3b8
-  data.tar.gz: ddb9bd8072cff3153d2db93af3bef525127b4c4a1dff871dd75dd4265e7959c1c8f944e9b81084c0d99dd2ddd406cfdeabd33f3663d548472413822725a4cf79
+  metadata.gz: 184b40befc64cc43c53eef48838cdab685422e97c1e92207a6abe042ba8fd1df7bf6d43584f400ee43b91c8aa8bab6f7dfbba6fbc2f5e26616e05850cdc6d0a7
+  data.tar.gz: afc524ecaa9acdaaf1338828a8ebaee32bd5519473905d63ccd6715c6dfcac75da7db74c3e6a1b0534c3e58691f47e511ad5cb84f0712cf91461b3ed74993c14

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

@@ -64,6 +64,8 @@ module RubyLsp
         ).void
       end
       def create_definition_listener(response_builder, uri, node_context, dispatcher)
+        return unless uri.to_standardized_path&.end_with?("_test.rb") || uri.to_standardized_path&.end_with?("_spec.rb")
+
         Definition.new(response_builder, uri, node_context, T.must(@index), dispatcher)
       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

@@ -13,9 +13,13 @@ module RubyLsp
           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)
+      def on_call_node(index, owner, node, file_path, code_units_cache)
         return if node.receiver
 
         name = node.name
@@ -44,10 +48,9 @@ module RubyLsp
           index.add(RubyIndexer::Entry::Method.new(
             method_name,
             file_path,
-            block_node.location,
-            block_node.location,
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
             nil,
-            index.configuration.encoding,
             [RubyIndexer::Entry::Signature.new([])],
             RubyIndexer::Entry::Visibility::PUBLIC,
             owner,
@@ -78,10 +81,9 @@ module RubyLsp
           index.add(RubyIndexer::Entry::Method.new(
             method_name,
             file_path,
-            block_node.location,
-            block_node.location,
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
+            RubyIndexer::Location.from_prism_location(block_node.location, code_units_cache),
             nil,
-            index.configuration.encoding,
             [RubyIndexer::Entry::Signature.new([])],
             RubyIndexer::Entry::Visibility::PUBLIC,
             owner,

data/lib/ruby_lsp_rspec/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module RSpec
-    VERSION = "0.1.15"
+    VERSION = "0.1.17"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors:
 - Stan Lo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-06 00:00:00.000000000 Z
+date: 2024-10-22 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