solargraph-rspec 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25d0ca1f34e0cf80057b86a412ec10cbacba388a96bd5b5e7b93f64457616e5a
-  data.tar.gz: d1b4b825f9df08a3333bab32d2af05a9cc6a48cd7903f5b4504baba1e775a960
+  metadata.gz: eb5a5e8955a55b4b936e0f7ac8b75daeddd08cc5eed9230b5706054398384480
+  data.tar.gz: bb897224942929755a8b9aebbc224bed114393f05b66115299b545a401b4bcdf
 SHA512:
-  metadata.gz: 1d7efb9da09a862654e5bb4fbd70bb983230cae9303e98ebc487cb0f00afe752ba8c936513dc23aac153e99f49d607b93111aada2f235fb47fdbeefcb81a0acb
-  data.tar.gz: aa9563e0d56a8ab37b45a739f6394e47e7dd597bc59bfb205a043ed41d9b5c47bc08b7a8184225ed75f2840bd57aeedd96ed05f325d32700c54e81aafb3e39d3
+  metadata.gz: 60902200d9a6574fe1313b51e270e568273fca41200e9dfbfdcd1f5529f6e95d3cda1e23b1eb303ab1be524048b23c435958590b29f2a9aab6083c0db788d55f
+  data.tar.gz: 405dce9b2d8b0621a66486d6840969cc635754bdbb40e0d1ec2b142cd48c11afa863f0e463afc47c3387f4ed264a607fec981d2df2fe0f15de9f37cc450445e0

data/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+Add here...
+
+## v0.3.0 - 2024-07-10
+
+### Added
+
+- Added `example_methods` as a configuration option to add your own example methods. (thanks to [@mskog](https://github.com/mskog) - first code contributor 🎉)
+
+## v0.2.2 - 2024-06-23
+
+### 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/**/*"
@@ -75,6 +80,19 @@ rspec:
     - let_it_be
 ```
 
+If you have your own custom `example`-like methods like `it`, you can add them to your `.solargraph.yml` file like this:
+
+```yaml
+# .solargraph.yml
+# ...
+rspec:
+  example_methods:
+    - my_it
+```
+
+This is useful if you use gems like [rspec-given](https://github.com/rspec-given/rspec-given) which introduces its own `let` and `example` methods.
+
+
 ### Gem completions
 
 Solargraph utilizes the YARD documentation to provide code completion. If you want to have completion for gems in your project, you can generate YARD documentation for them ([Read more](https://solargraph.org/guides/yard)).

data/lib/solargraph/rspec/config.rb

@@ -20,6 +20,11 @@ module Solargraph
         (Rspec::LET_METHODS + additional_let_methods).map(&:to_sym)
       end
 
+      # @return [Array<Symbol>]
+      def example_methods
+        (Rspec::EXAMPLE_METHODS + additional_example_methods).map(&:to_sym)
+      end
+
       private
 
       # @return [Hash]
@@ -32,6 +37,11 @@ module Solargraph
         (rspec_raw_data['let_methods'] || []).map(&:to_sym)
       end
 
+      # @return [Array<Symbol>]
+      def additional_example_methods
+        (rspec_raw_data['example_methods'] || []).map(&:to_sym)
+      end
+
       # @return [Hash]
       def raw_data
         @solargraph_config.raw_data

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/spec_walker/node_types.rb

@@ -25,9 +25,10 @@ module Solargraph
         end
 
         # @param ast [RubyVM::AbstractSyntaxTree::Node]
+        # @param config [Config]
         # @return [Boolean]
-        def self.a_example_block?(block_ast)
-          Solargraph::Rspec::EXAMPLE_METHODS.include?(method_with_block_name(block_ast))
+        def self.a_example_block?(block_ast, config)
+          config.example_methods.map(&:to_s).include?(method_with_block_name(block_ast))
         end
 
         # @param ast [RubyVM::AbstractSyntaxTree::Node]

data/lib/solargraph/rspec/spec_walker.rb

@@ -138,7 +138,7 @@ module Solargraph
         end
 
         walker.on :ITER do |block_ast|
-          next unless NodeTypes.a_example_block?(block_ast)
+          next unless NodeTypes.a_example_block?(block_ast, config)
 
           @handlers[:on_example_block].each do |handler|
             handler.call(PinFactory.build_location_range(block_ast))

data/lib/solargraph/rspec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Lekë Mula
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph