solargraph-rspec 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b218c57b18c9c34c920dc8085633940b40980109acc0767e3819f2f460af7598
-  data.tar.gz: 8d33d3922c38de08dde380776138fb2eddee93f72aaaee1cd7ae4dce7610ac69
+  metadata.gz: eb5a5e8955a55b4b936e0f7ac8b75daeddd08cc5eed9230b5706054398384480
+  data.tar.gz: bb897224942929755a8b9aebbc224bed114393f05b66115299b545a401b4bcdf
 SHA512:
-  metadata.gz: 0d6afb3098eeaa24b1c169ba6993306b14008837ebfd267c30bfe74788cd5deecb7985d33037984f5ed698d259daf9c698dba19f4eed0e6a346f521f081a2d7a
-  data.tar.gz: 88699cf9f89421e1a0306d37ce912c1a1fc231cd722cc4338ec757efed7ca304791b1c2e3e3271b9cb057efe91f2d3db8fa22c70739b88569a0be59c9b0de229
+  metadata.gz: 60902200d9a6574fe1313b51e270e568273fca41200e9dfbfdcd1f5529f6e95d3cda1e23b1eb303ab1be524048b23c435958590b29f2a9aab6083c0db788d55f
+  data.tar.gz: 405dce9b2d8b0621a66486d6840969cc635754bdbb40e0d1ec2b142cd48c11afa863f0e463afc47c3387f4ed264a607fec981d2df2fe0f15de9f37cc450445e0

data/CHANGELOG.md

@@ -7,6 +7,16 @@ 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))

data/README.md

@@ -80,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/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.2'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Lekë Mula
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-07-10 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'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.49.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.49'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.49.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
 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.4.10
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Solargraph plugin supporting RSpec code completion