ruby-lsp-rspec 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f01b37d539883d5abc213c66cba4c967c362ae8722a9e8c1afb4b8b39c4d069
-  data.tar.gz: 418b518147829b9770d22b64b9c64ec89efc8f699c6b266be5be29ad08f98bc3
+  metadata.gz: 9f59143ad42455a57861a393b556660d68a1efddab1a34490094f3cf1d59b65d
+  data.tar.gz: 6239e3ccc46fe341f501fea47c6f8cce115df176e359e3f962e9e3c7068f0083
 SHA512:
-  metadata.gz: cf2cad39b55746c3f1078235670b02e0d7dd1840327b873e19919828f3f5ac5e98929958254952089235ef0849cf52d5b2434988a2461bb70eddd406898d37fe
-  data.tar.gz: cb4e6d74c193c5b0cd876f88d8ae6948563f7c40c988729f9d18f94e951f3517df04e3de94d40dded9e0d5f04b788497272f86443a129385ea4ded8f328b5a60
+  metadata.gz: 261b3ac804b0d81bcd6e615349fcf27ab70b4e6b4c5a013c9c6f510bdd153d9203457f613405cd06ea43dedaec2db02d6563e36a1a6cb635451734f709514368
+  data.tar.gz: 692ca7238e48d6f370d208cbcfa4264d9e7ac540f6d5a45d16c4e9da6c467230b3e5d217d93c84f42d5cf70d6b800234ed0acdcf369112a523f5bf2cbef554f7

data/README.md

@@ -15,7 +15,7 @@ group :development do
 end
 ```
 
-> [!IMPORTANT] 
+> [!IMPORTANT]
 > Make sure the relevant features are [enabled](https://github.com/Shopify/ruby-lsp/tree/main/vscode#enable-or-disable-features) under your VSCode's `rubyLsp.enabledFeatures` setting, such as `codeLens`.
 
 After running `bundle install`, restart Ruby LSP and you should start seeing CodeLens in your RSpec test files.
@@ -56,6 +56,87 @@ In VS Code this feature can be triggered by one of the following methods:
 
 <img src="misc/go-to-definition.gif" alt="Go to definition" width="75%">
 
+### VS Code Configuration
+
+`ruby-lsp-rspec` can be configured through VS Code's `settings.json` file.
+
+All configuration options must be nested under the `Ruby LSP RSpec` addon within `rubyLsp.addonSettings`:
+
+```json
+{
+  // ...
+  "rubyLsp.addonSettings": {
+    "Ruby LSP RSpec": {
+      // Configuration options go here
+    }
+  }
+}
+```
+
+#### `rspecCommand`
+
+**Description:**
+
+Customize the command used to run tests via CodeLens. If not set, the command will be inferred based on the presence of a binstub or Gemfile.
+
+**Default Value**: `nil`
+
+**Example:**
+
+```json
+{
+  // ...
+  "rubyLsp.addonSettings": {
+    "Ruby LSP RSpec": {
+      "rspecCommand": "rspec -f d"
+    }
+  }
+}
+```
+
+#### `debug`
+
+**Description:**
+
+Enable debug logging. Currently, this only logs the RSpec command used by CodeLens to stderr, which can be viewed in VS Code's `OUTPUT` panel under `Ruby LSP`.
+
+**Default Value**: `false`
+
+**Example:**
+
+```json
+{
+  "rubyLsp.addonSettings": {
+    "Ruby LSP RSpec": {
+      "debug": true
+    }
+  }
+}
+```
+
+### Container Development
+
+When developing in containers, use the official [`Dev Containers`](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension. This ensures Ruby LSP and Ruby LSP RSpec run inside the container, allowing correct spec path resolution.
+
+For detailed container setup instructions, see the [Ruby LSP documentation](https://github.com/Shopify/ruby-lsp/blob/main/vscode/README.md?tab=readme-ov-file#developing-on-containers).
+
+Make sure to configure Ruby LSP to run inside the container by adding it to your `.devcontainer.json`:
+
+```json
+{
+  "name": "my-app",
+  // ...
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "Shopify.ruby-lsp",
+        // ...
+      ]
+    }
+  }
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ruby_lsp/ruby_lsp_rspec/addon.rb

@@ -14,9 +14,26 @@ module RubyLsp
     class Addon < ::RubyLsp::Addon
       extend T::Sig
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :rspec_command
+
+      sig { returns(T::Boolean) }
+      attr_reader :debug
+
+      sig { void }
+      def initialize
+        super
+        @debug = T.let(false, T::Boolean)
+        @rspec_command = T.let(nil, T.nilable(String))
+      end
+
       sig { override.params(global_state: GlobalState, message_queue: Thread::Queue).void }
       def activate(global_state, message_queue)
         @index = T.let(global_state.index, T.nilable(RubyIndexer::Index))
+
+        settings = global_state.settings_for_addon(name)
+        @rspec_command = T.let(settings&.dig(:rspecCommand), T.nilable(String))
+        @debug = settings&.dig(:debug) || false
       end
 
       sig { override.void }
@@ -38,7 +55,7 @@ module RubyLsp
       def create_code_lens_listener(response_builder, uri, dispatcher)
         return unless uri.to_standardized_path&.end_with?("_test.rb") || uri.to_standardized_path&.end_with?("_spec.rb")
 
-        CodeLens.new(response_builder, uri, dispatcher)
+        CodeLens.new(response_builder, uri, dispatcher, rspec_command: rspec_command, debug: debug)
       end
 
       sig do

data/lib/ruby_lsp/ruby_lsp_rspec/code_lens.rb

@@ -13,9 +13,11 @@ module RubyLsp
           response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens],
           uri: URI::Generic,
           dispatcher: Prism::Dispatcher,
+          rspec_command: T.nilable(String),
+          debug: T::Boolean,
         ).void
       end
-      def initialize(response_builder, uri, dispatcher)
+      def initialize(response_builder, uri, dispatcher, rspec_command: nil, debug: false)
         @response_builder = response_builder
         # Listener is only initialized if uri.to_standardized_path is valid
         @path = T.let(T.must(uri.to_standardized_path), String)
@@ -24,8 +26,10 @@ module RubyLsp
         @anonymous_example_count = T.let(0, Integer)
         dispatcher.register(self, :on_call_node_enter, :on_call_node_leave)
 
+        @debug = debug
         @base_command = T.let(
-          begin
+          # The user-configured command takes precedence over inferred command default
+          rspec_command || begin
             cmd = if File.exist?(File.join(Dir.pwd, "bin", "rspec"))
               "bin/rspec"
             else
@@ -71,6 +75,11 @@ module RubyLsp
 
       private
 
+      sig { params(message: String).void }
+      def log_message(message)
+        puts "[#{self.class}]: #{message}"
+      end
+
       sig { params(node: Prism::CallNode).returns(T::Boolean) }
       def valid_group?(node)
         !(node.block.nil? || (node.receiver && node.receiver&.slice != "RSpec"))
@@ -104,6 +113,8 @@ module RubyLsp
         line_number = node.location.start_line
         command = "#{@base_command} #{@path}:#{line_number}"
 
+        log_message("Full command: `#{command}`") if @debug
+
         grouping_data = { group_id: @group_id_stack.last, kind: kind }
         grouping_data[:id] = @group_id if kind == :group
 

data/lib/ruby_lsp_rspec/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module RSpec
-    VERSION = "0.1.21"
+    VERSION = "0.1.22"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Stan Lo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp