solargraph-rspec 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25d0ca1f34e0cf80057b86a412ec10cbacba388a96bd5b5e7b93f64457616e5a
-  data.tar.gz: d1b4b825f9df08a3333bab32d2af05a9cc6a48cd7903f5b4504baba1e775a960
+  metadata.gz: b218c57b18c9c34c920dc8085633940b40980109acc0767e3819f2f460af7598
+  data.tar.gz: 8d33d3922c38de08dde380776138fb2eddee93f72aaaee1cd7ae4dce7610ac69
 SHA512:
-  metadata.gz: 1d7efb9da09a862654e5bb4fbd70bb983230cae9303e98ebc487cb0f00afe752ba8c936513dc23aac153e99f49d607b93111aada2f235fb47fdbeefcb81a0acb
-  data.tar.gz: aa9563e0d56a8ab37b45a739f6394e47e7dd597bc59bfb205a043ed41d9b5c47bc08b7a8184225ed75f2840bd57aeedd96ed05f325d32700c54e81aafb3e39d3
+  metadata.gz: 0d6afb3098eeaa24b1c169ba6993306b14008837ebfd267c30bfe74788cd5deecb7985d33037984f5ed698d259daf9c698dba19f4eed0e6a346f521f081a2d7a
+  data.tar.gz: 88699cf9f89421e1a0306d37ce912c1a1fc231cd722cc4338ec757efed7ca304791b1c2e3e3271b9cb057efe91f2d3db8fa22c70739b88569a0be59c9b0de229

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- Suggest keeping `spec/**/*` in the `exclude` section of `.solargraph.yml` to avoid performance issues (see [commit](https://github.com/lekemula/solargraph-rspec/commit/3f0fc39e59e99bf9430e55c52ecb88650e49315e))
+- Fix `let` definitions when do/end keywords overlap with body definition
+  ```ruby
+    let(:todo) do # "do" keyword overlap
+      {
+        'todo' => 'end' # "end" keyword overlap
+      }
+    end
+  ```
+- Error handling in SpecWalker::FakeLetMethod
 
 ## [0.2.1] - 2024-06-09
 

data/README.md

@@ -34,14 +34,19 @@ Or add it to your Gemfile:
 
 ```ruby
 group :development do
-  gem 'solargraph' 
-  gem 'solargraph-rspec'
+  gem 'solargraph', require: false
+  gem 'solargraph-rspec', require: false
 end
 ```
 
 If you add them to your Gemfile, you'll have to tell your IDE plugin to use bundler to load the right version of solargraph.
 
-Add `solargraph-rspec` to your `.solargraph.yml` and remove the `spec` directory from the `exclude` list.
+Add `solargraph-rspec` to your `.solargraph.yml` as a plugin.
+
+> [!CAUTION]
+> To avoid **performance issues**, please keep the `spec/**/*` directory in **exclude** list in the Solargraph configuration.
+> That does not actually *exclude* the specs, but rather avoids pre-indexing the specs when Solargraph boots up, and only parses
+> the specs on demand when opened in the editor, which is what we usually want.
 
 (if you don't have a `.solargraph.yml` in your project root, you can run `solargraph config` to add one)
 
@@ -50,7 +55,7 @@ Add `solargraph-rspec` to your `.solargraph.yml` and remove the `spec` directory
  include:
  - "**/*.rb"
  exclude:
--- spec/**/*
++- spec/**/*
  - test/**/*
  - vendor/**/*
  - ".bundle/**/*"

data/lib/solargraph/rspec/spec_walker/fake_let_method.rb

@@ -4,18 +4,18 @@ module Solargraph
   module Rspec
     class SpecWalker
       class FakeLetMethod
-        MATCH_BODY = Regexp.union(
-          /do(.*)end/m,
-          /{(.*)}/m
-        )
+        MATCH_DO_END = /.*? do(.*)end/m.freeze
+        MATCH_CURLY = /{(.*)}/m.freeze
 
         # @param block_ast [RubyVM::AbstractSyntaxTree::Node]
-        # @return [RubyVM::AbstractSyntaxTree::Node]
+        # @return [RubyVM::AbstractSyntaxTree::Node, nil]
         def self.transform_block(block_ast, code, method_name = nil)
           method_name ||= NodeTypes.let_method_name(block_ast)
           block_body = block_ast.children[1]
-          matches = code.lines[block_body.first_lineno - 1..block_body.last_lineno - 1].join.match(MATCH_BODY)
-          method_body = (matches[1] || matches[2]).strip
+          let_definition_code = code.lines[block_body.first_lineno - 1..block_body.last_lineno - 1].join
+          match_do_end = let_definition_code.match(MATCH_DO_END)&.captures&.first || ''
+          match_curly = let_definition_code.match(MATCH_CURLY)&.captures&.first || ''
+          method_body = [match_do_end, match_curly].max_by(&:length).strip
 
           ast = RubyVM::AbstractSyntaxTree.parse <<~RUBY
             def #{method_name}
@@ -24,8 +24,11 @@ module Solargraph
           RUBY
 
           ast.children[2]
-        rescue SyntaxError
-          raise "Failed to build fake let method: #{block_ast.inspect}, message: #{e.message}"
+        rescue SyntaxError => e
+          Solargraph.logger.warn "[RSpec] Failed to build fake let method: #{e.message}, \
+            \n\nlet_definition_code: \n```\n#{let_definition_code}\n```, \
+            \n\nmethod_body: \n```\n#{method_body}\n```, \
+            \nast: #{block_ast.inspect}"
         ensure
           nil
         end

data/lib/solargraph/rspec/version.rb

@@ -2,6 +2,6 @@
 
 module Solargraph
   module Rspec
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Lekë Mula
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.49.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.49'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.49.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.49'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
 description: RSpec is a testing tool of choice for many Ruby developers. This plugin
   provides code completion and other features for RSpec files in Solargraph.
 email:
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Solargraph plugin supporting RSpec code completion