solargraph-rspec 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e419b2a50e53e4fab9030c7efc9821aef1c245987b50c87e0222e7889a024065
-  data.tar.gz: 0eb5170d658591b473c7c9df2613d017889bcf0c4e9488579ae07b6fa40c1e2c
+  metadata.gz: f5479aea692e6eb35870d21e537641872b30e6bdfe8a868110d79488f84c4964
+  data.tar.gz: 4c8bfb43f8dececdfe0d19b9c50a963e487caa0c623a020c67f82f0a83f55b7a
 SHA512:
-  metadata.gz: 4fd09eda66acdf1c5688152d5b5fae30afc7c97461eefd13bbf2c5e9be8fae53a05c822e7d3cb2a03d46d7823016c6119d0887fb0d6f1ee165010f824450617b
-  data.tar.gz: 54d762f7d838d9671ef57a3e9963fdba3ec850ce51ae8d69b9d05fb27dc569370feda39c7d09f1056dce6f6a384d097d30aa361de4adf5ed5b2d480d591b3867
+  metadata.gz: c098385b10b165f9619f0e64a0ad01b5da028fcd9e0f90a028f48132438d29af1394967492d2de9a964d66da98bcd6a8a66207af7d8903a853aca6ad3e52d86f
+  data.tar.gz: cf40aae6cb2777d1314bf6c510e4f38c2227f43b2bde6db5b3ed4144358775151c17f4a95970da9d0a9fcb295b0305b6226c11472e25e5ec6cf49e8e56fd772c

data/Appraisals

@@ -3,9 +3,9 @@
 appraise 'default' do
   # default gems from Gemfile
   gem 'net-imap', '~> 0.4.0' # https://github.com/lsegal/yard/issues/1629
-  gem 'actionmailer'
+  gem 'actionmailer', '>= 7'
   gem 'airborne'
-  gem 'rspec-rails'
+  gem 'rspec-rails', '>= 7'
   gem 'rspec-sidekiq'
   gem 'shoulda-matchers'
   gem 'webmock'

data/CHANGELOG.md

@@ -7,12 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2026-08-12
+
+### Added
+- Add Rspec included modules support by @ShadiestGoat in #32
+
+### Changed
+- Chore: Test solargraph prereleases (#31)
+- Chore: More reliable closure and location updates by @apiology in #30
+- Chore: Less limiting of gem pin processing in specs by @apiology in #29
+Avoid inference from literal values by @castwide (#34)
+- Chore: fix failing specs (#35)
+
+
+## [0.5.5] - 2025-10-05
+
 ### Fixed
 - Go-to-defintion/Hover for RSpec DSL methods (eg. context or it)
 
+### Other Changes
+- Chore: Add rubocop-yard by @lekemula in #20
+- Chore: Add CI solargraph typecheck step by @lekemula in #21
+- Chore: Adjust specs/CI for next solargraph release after 0.56.2 by @lekemula in #22
+- Chore: Improve CI speed by @lekemula in #23
+- Chore: Improve tests speed by @lekemula in #24
+- Chore: Update testing steps in developer documentation by @apiology in #25
+- Chore: Move 3rd party gems to Appraisals by @lekemula in #27
+
 ### Changed
 - Update testing steps in developer documentation
 
+## [0.5.4] - 2025-09-06
+
+### Fixed
+- Fix breaking of solargraph rubocop diagnostics by @lekemula in #19
+
 ## [0.5.3] - 2025-09-02
 
 ### Fixed

data/README.md

@@ -77,27 +77,25 @@ Add `solargraph-rspec` to your `.solargraph.yml` as a plugin.
 ```
 ### Configuration
 
-If you have your own custom `let`-like memoized methods, you can add them to your `.solargraph.yml` file like this:
+You can customize the plugin behavior in your `.solargraph.yml`:
 
 ```yaml
 # .solargraph.yml
 # ...
 rspec:
+  # Custom let-like memoized methods (e.g., from rspec-given, test-prof)
   let_methods:
     - 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:
+  # Custom example-like methods (e.g., from rspec-given)
   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.
+  # RSpec helper files to analyze for included modules (shared contexts, custom matchers)
+  config_helper_files:
+    - spec/spec_helper.rb
+    - spec/rails_helper.rb
+```
 
 
 ### Gem completions
@@ -136,8 +134,7 @@ Contributing is easy - note that this Gem uses 'appraisal' to test against RSpec
    bundle exec appraisal install
    cp .solargraph.yml.example .solargraph.yml
    bundle exec appraisal bundle exec rbs collection update
-   rspec_gems=$(bundle exec appraisal bundle exec ruby -r './lib/solargraph-rspec' -e 'puts Solargraph::Rspec::Gems.gem_names.join(" ")' 2>/dev/null | tail -n1)
-   bundle exec appraisal bundle exec solargraph gems $rspec_gems
+   bundle exec appraisal bundle exec solargraph gems $(bundle exec appraisal bundle exec ruby -r './lib/solargraph-rspec' -e 'puts Solargraph::Rspec::Gems.gem_names.join(" ")' 2>/dev/null | tail -n1)
    bundle exec appraisal rspec
    ```
 3. Introduce your awesome changes

data/gemfiles/default.gemfile

@@ -16,9 +16,9 @@ gem "simplecov"
 gem "simplecov-cobertura"
 gem "unparser"
 gem "net-imap", "~> 0.4.0"
-gem "actionmailer"
+gem "actionmailer", ">= 7"
 gem "airborne"
-gem "rspec-rails"
+gem "rspec-rails", ">= 7"
 gem "rspec-sidekiq"
 gem "shoulda-matchers"
 gem "webmock"

data/gemfiles/default.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    solargraph-rspec (0.5.4)
+    solargraph-rspec (0.5.5)
       solargraph (>= 0.52.0)
 
 GEM
@@ -61,11 +61,13 @@ GEM
     ast (2.4.3)
     backport (1.2.0)
     base64 (0.3.0)
-    benchmark (0.4.1)
+    benchmark (0.5.0)
     bigdecimal (3.2.3)
     builder (3.3.0)
     byebug (12.0.0)
     coderay (1.1.3)
+    commander (5.0.0)
+      highline (~> 3.0.0)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.4)
     crack (1.0.0)
@@ -85,6 +87,7 @@ GEM
     globalid (1.2.1)
       activesupport (>= 6.1)
     hashdiff (1.2.1)
+    highline (3.0.1)
     http-accept (1.7.0)
     http-cookie (1.0.8)
       domain_name (~> 0.5)
@@ -95,13 +98,13 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    jaro_winkler (1.6.1)
-    json (2.13.2)
-    kramdown (2.5.1)
-      rexml (>= 3.3.9)
+    jaro_winkler (1.7.0)
+    json (2.21.2)
+    kramdown (2.5.2)
+      rexml (>= 3.4.4)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    language_server-protocol (3.17.0.5)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     loofah (2.24.1)
@@ -129,20 +132,25 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     netrc (0.11.0)
-    nokogiri (1.18.10-arm64-darwin)
+    nokogiri (1.19.4-arm64-darwin)
       racc (~> 1.4)
     observer (0.1.2)
     open3 (0.2.1)
     optparse (0.6.0)
     ostruct (0.6.3)
-    parallel (1.27.0)
-    parser (3.3.9.0)
+    parallel (2.1.0)
+    parlour (9.1.2)
+      commander (~> 5.0)
+      parser
+      rainbow (~> 3.0)
+      sorbet-runtime (>= 0.5)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
-    prism (1.5.1)
+    prism (1.9.0)
     profile-viewer (0.0.5)
       optparse
       webrick
@@ -182,14 +190,17 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.3.0)
-    rbs (3.9.5)
+    rbs (4.1.3)
       logger
-    rdoc (6.14.2)
+      prism (>= 1.6.0)
+      tsort
+    rdoc (7.2.0)
       erb
       psych (>= 4.0.0)
+      tsort
     redis-client (0.25.3)
       connection_pool
-    regexp_parser (2.11.3)
+    regexp_parser (2.12.0)
     reline (0.6.2)
       io-console (~> 0.5)
     rest-client (2.1.0)
@@ -197,7 +208,7 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    reverse_markdown (3.0.0)
+    reverse_markdown (3.0.2)
       nokogiri
     rexml (3.4.4)
     rspec (3.13.1)
@@ -226,20 +237,20 @@ GEM
       rspec-mocks (~> 3.0)
       sidekiq (>= 5, < 9)
     rspec-support (3.13.6)
-    rubocop (1.80.2)
+    rubocop (1.89.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.46.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.46.0)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
+      prism (~> 1.7)
     rubocop-yard (1.0.0)
       lint_roller
       rubocop (~> 1.72)
@@ -263,11 +274,11 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.57.0)
+    solargraph (0.60.3)
       ast (~> 2.4.3)
       backport (~> 1.2)
       benchmark (~> 0.4)
-      bundler (~> 2.0)
+      bundler (>= 2.0)
       diff-lcs (~> 1.4)
       jaro_winkler (~> 1.6, >= 1.6.1)
       kramdown (~> 2.3)
@@ -278,23 +289,34 @@ GEM
       ostruct (~> 0.6)
       parser (~> 3.0)
       prism (~> 1.4)
-      rbs (>= 3.6.1, <= 4.0.0.dev.4)
+      rbs (>= 3.10.0)
+      rdoc (~> 7.0)
       reverse_markdown (~> 3.0)
       rubocop (~> 1.76)
+      sord (~> 7.0)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
       yard-activesupport-concern (~> 0.0)
       yard-solargraph (~> 0.1)
+    sorbet-runtime (0.6.13425)
+    sord (7.1.0)
+      commander (~> 5.0)
+      parlour (~> 9.1)
+      parser
+      rbs (>= 3.0, < 5)
+      sorbet-runtime
+      yard
     stringio (3.1.7)
-    thor (1.4.0)
-    tilt (2.6.1)
+    thor (1.5.0)
+    tilt (2.8.0)
     timeout (0.4.3)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
+    unicode-emoji (4.2.0)
     unparser (0.8.0)
       diff-lcs (~> 1.6)
       parser (>= 3.3.0)
@@ -306,7 +328,7 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.9.1)
-    yard (0.9.37)
+    yard (0.9.45)
     yard-activesupport-concern (0.0.1)
       yard (>= 0.8)
     yard-solargraph (0.1.0)
@@ -315,10 +337,11 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   arm64-darwin-24
 
 DEPENDENCIES
-  actionmailer
+  actionmailer (>= 7)
   airborne
   appraisal
   bundler
@@ -329,7 +352,7 @@ DEPENDENCIES
   rake
   rbs
   rspec
-  rspec-rails
+  rspec-rails (>= 7)
   rspec-sidekiq
   rubocop
   rubocop-yard

data/lib/solargraph/rspec/config.rb

@@ -6,6 +6,9 @@ module Solargraph
     #   rspec:
     #     let_methods:
     #       - let_it_be
+    #     config_helper_files:
+    #       - spec/spec_helper.rb
+    #       - spec/rails_helper.rb
     class Config
       def initialize(solargraph_config = Solargraph::Workspace::Config.new('./'))
         @solargraph_config = solargraph_config
@@ -25,8 +28,18 @@ module Solargraph
         (Rspec::EXAMPLE_METHODS + additional_example_methods).map(&:to_sym)
       end
 
+      # @return [Array<String>]
+      def config_helper_files
+        DEFAULT_CONFIG_HELPER_FILES + additional_config_helper_files
+      end
+
       private
 
+      DEFAULT_CONFIG_HELPER_FILES = [
+        'spec/spec_helper.rb',
+        'spec/rails_helper.rb'
+      ].freeze
+
       # @return [Hash]
       def rspec_raw_data
         @rspec_raw_data ||= raw_data['rspec'] || {}
@@ -46,6 +59,13 @@ module Solargraph
         (example_methods || []).map(&:to_sym)
       end
 
+      # @return [Array<String>]
+      def additional_config_helper_files
+        # @type [Array<String>, nil]
+        config_files = rspec_raw_data['config_helper_files']
+        config_files || []
+      end
+
       # @return [Hash]
       def raw_data
         @solargraph_config.raw_data

data/lib/solargraph/rspec/convention.rb

@@ -11,6 +11,7 @@ require_relative 'correctors/subject_method_corrector'
 require_relative 'correctors/dsl_methods_corrector'
 require_relative 'gems'
 require_relative 'pin_factory'
+require_relative 'rspec_configure'
 
 module Solargraph
   module Rspec
@@ -86,8 +87,16 @@ module Solargraph
           root_example_group_namespace_pin: root_example_group_namespace_pin
         )
         pins += annotation_pins
+
+        # Add pins from RSpec.configure blocks
+        rspec_configure = RSpecConfigure.new(
+          config: config,
+          root_namespace_pin: root_example_group_namespace_pin
+        )
+        pins += rspec_configure.pins
+
         # TODO: Include gem requires conditionally based on Gemfile definition
-        requires = Solargraph::Rspec::Gems.gem_names
+        requires = Solargraph::Rspec::Gems.gem_names + rspec_configure.extra_requires
 
         if pins.any?
           Solargraph.logger.debug(

data/lib/solargraph/rspec/correctors/base.rb

@@ -68,7 +68,12 @@ module Solargraph
         # @param pin [Solargraph::Pin::Base]
         # @param new_closure [Solargraph::Pin::Closure]
         def override_closure(pin, new_closure)
-          # HACK: We should only rely on public API, and avoid instance_variable_get/set.
+          if pin.respond_to?(:closure=)
+            pin.closure = new_closure
+            return
+          end
+
+          # work around older version of Solargraph
           pin.instance_variable_set('@closure', new_closure)
           pin.reset_generated!
 
@@ -104,8 +109,19 @@ module Solargraph
             closure.location.filename
           )
 
-          # HACK: We should only rely on public API, and avoid instance_variable_get/set.
-          closure.instance_variable_set('@location', new_location)
+          if closure.respond_to?(:location=)
+            closure.location = new_location
+          else
+            # work around older version of Solargraph
+            closure.instance_variable_set('@location', new_location)
+            closure.reset_generated!
+          end
+
+          # find children of this pin and reset them, as they may have
+          # cached their binder or context based on the old closure
+          source_map.pins.select { |child_pin| child_pin.closure == closure }.each do |child_pin|
+            child_pin.reset_generated!
+          end
         end
       end
     end

data/lib/solargraph/rspec/rspec_configure.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'spec_configuration_walker'
+require_relative 'pin_factory'
+
+module Solargraph
+  module Rspec
+    # Handles RSpec.configure ... config.include parsing
+    # Provides pins for modules included globally via RSpec.configure
+    class RSpecConfigure
+      # @param config [Config]
+      # @param root_namespace_pin [Solargraph::Pin::Namespace]
+      def initialize(config:, root_namespace_pin:)
+        @config = config
+        @root_namespace_pin = root_namespace_pin
+        @included_modules = nil
+      end
+
+      # @return [Array<Solargraph::Pin::Reference::Include>]
+      def pins
+        included_modules.map do |mod|
+          Solargraph::Pin::Reference::Include.new(
+            closure: @root_namespace_pin,
+            name: mod.module_name,
+            location: Solargraph::Location.new(mod.file, Solargraph::Parser.node_range(mod.node))
+          )
+        end
+      end
+
+      # @return [Array<String>]
+      def extra_requires
+        included_modules.map(&:file).uniq + support_files
+      end
+
+      # @return [Array<SpecConfigurationWalker::IncludedModule>]
+      def included_modules
+        @included_modules ||= parse_included_modules
+      end
+
+      private
+
+      # @return [Array<String>]
+      def support_files
+        Dir['spec/support/**/*.rb']
+      end
+
+      # @return [Array<SpecConfigurationWalker::IncludedModule>]
+      def parse_included_modules
+        modules = []
+
+        @config.config_helper_files.each do |file_path|
+          ast = Solargraph::Parser.parse(File.read(file_path), file_path)
+          walker = SpecConfigurationWalker.new(ast, file_path)
+          modules += walker.extract_included_modules
+        rescue Errno::ENOENT
+          # Ignore missing files - they may not exist in all projects
+        rescue StandardError => e
+          Solargraph.logger.error(
+            "[RSpec] [RSpecConfigure] Error reading helper file '#{file_path}': #{e.message}"
+          )
+        end
+
+        modules
+      end
+    end
+  end
+end

data/lib/solargraph/rspec/spec_configuration_walker.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative 'walker'
+require_relative 'spec_walker/full_constant_name'
+
+module Solargraph
+  module Rspec
+    # Walks AST to find RSpec.configure blocks and extract included modules
+    class SpecConfigurationWalker
+      # @param ast [::Parser::AST::Node]
+      # @param filename [String] The file being parsed
+      def initialize(ast, filename)
+        @ast = ast
+        @filename = filename
+        @walker = Walker.new(ast)
+        @included_modules = []
+      end
+
+      # Represents a module included via config.include in RSpec.configure
+      # @param node [::Parser::AST::Node] The AST node for the include call
+      # @param file [String] The file where this module is included
+      # @param module_name [String] The fully qualified name of the included module
+      class IncludedModule < Struct.new(:node, :file, :module_name)
+      end
+
+      # Walk the AST and extract included modules
+      # @return [Array<IncludedModule>]
+      def extract_included_modules
+        @walker.on :block, [:send] do |node|
+          send_node = node.children[0]
+          send_receiver = send_node.children[0]
+
+          # Check if this is RSpec.configure
+          next unless send_receiver&.type == :const
+          next unless send_receiver.children[1] == :RSpec
+          next unless send_node.children[1] == :configure
+
+          # Ensure block has arguments (the config parameter)
+          next if node.children[1].children.empty?
+
+          process_configure_block(node)
+        end
+
+        @walker.walk
+        @included_modules
+      end
+
+      private
+
+      # Process the RSpec.configure block to find config.include calls
+      # @param configure_block [::Parser::AST::Node]
+      # @return [void]
+      def process_configure_block(configure_block)
+        # Get the config variable name (e.g., |config| or |c|)
+        config_name = configure_block.children[1].children[0].children[0]
+
+        config_walker = Walker.new(configure_block)
+        config_walker.on :send, [:lvar, config_name] do |include_node|
+          # Look for config.include calls
+          next unless include_node.children[1] == :include
+
+          mod_node = include_node.children[2]
+          next unless mod_node.is_a?(::Parser::AST::Node)
+          next unless mod_node.type == :const
+
+          module_name = SpecWalker::FullConstantName.from_ast(mod_node)
+          @included_modules << IncludedModule.new(include_node, @filename, module_name)
+        end
+
+        config_walker.walk
+      end
+    end
+  end
+end

data/lib/solargraph/rspec/version.rb

@@ -2,6 +2,6 @@
 
 module Solargraph
   module Rspec
-    VERSION = '0.5.5'
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rspec
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Lekë Mula
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-05 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -57,6 +58,8 @@ files:
 - lib/solargraph/rspec/correctors/subject_method_corrector.rb
 - lib/solargraph/rspec/gems.rb
 - lib/solargraph/rspec/pin_factory.rb
+- lib/solargraph/rspec/rspec_configure.rb
+- lib/solargraph/rspec/spec_configuration_walker.rb
 - lib/solargraph/rspec/spec_walker.rb
 - lib/solargraph/rspec/spec_walker/fake_let_method.rb
 - lib/solargraph/rspec/spec_walker/full_constant_name.rb
@@ -69,11 +72,13 @@ files:
 - release_gem.sh
 - sig/solargraph/rspec.rbs
 - solargraph-rspec.gemspec
+homepage:
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/lekemula/solargraph-rspec
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,7 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Solargraph plugin supporting RSpec code completion
 test_files: []