solargraph-rspec 0.5.4 → 0.6.0

data/lib/solargraph/rspec/{test_helpers.rb → gems.rb}

@@ -2,16 +2,15 @@
 
 module Solargraph
   module Rspec
-    class TestHelpers
-      class GemHelpers < Struct.new(:required_gems, :helper_modules, keyword_init: true)
-        # @!attribute [r] required_gems
-        #   @return [Array<String>]
-        # @!attribute [r] helper_modules
-        #   @return [Array<String>]
-      end
+    class Gems
+      # rubocop:disable YARD/MeaninglessTag
+      # @param required_gems [Array<String>]
+      # @param helper_modules [Array<String>]
+      # rubocop:enable YARD/MeaninglessTag
+      GemHelpers = Struct.new(:required_gems, :helper_modules, keyword_init: true)
 
       class << self
-        # @return [String]
+        # @return [Array<String>]
         def gem_names
           GEM_HELPERS.flat_map(&:required_gems)
         end
@@ -37,7 +36,7 @@ module Solargraph
 
       GEM_HELPERS = [
         GemHelpers.new(
-          required_gems: %w[rspec],
+          required_gems: %w[rspec rspec-expectations rspec-core],
           helper_modules: %w[RSpec::Matchers]
         ),
         # https://github.com/rspec/rspec-mocks
@@ -48,7 +47,7 @@ module Solargraph
         # @see https://github.com/rspec/rspec-rails#what-tests-should-i-write
         # @see https://github.com/rspec/rspec-rails#helpful-rails-matchers
         GemHelpers.new(
-          required_gems: %w[rspec-rails actionmailer activesupport activerecord],
+          required_gems: %w[rspec-rails actionmailer activesupport actionpack],
           helper_modules: [
             'RSpec::Rails::Matchers',
             'ActionController::TestCase::Behavior',

data/lib/solargraph/rspec/pin_factory.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Credits: This file was originally copied and adapted from the log_bench gem.
+# Credits: This file was originally copied and adapted from the solargraph-rails gem.
 
 module Solargraph
   module Rspec
@@ -8,11 +8,12 @@ module Solargraph
     module PinFactory
       # @param namespace [Solargraph::Pin::Namespace]
       # @param name [String]
-      # @param types [Array<String>]
-      # @param location [Solargraph::Location]
+      # @param types [Array<String>, nil]
+      # @param [Parser::AST::Node, nil] node
+      # @param location [Solargraph::Location, nil]
       # @param comments [Array<String>]
       # @param attribute [Boolean]
-      # @param scope [:instance, :class]
+      # @param scope [:instance, :class] # rubocop:disable YARD/TagTypeSyntax
       # @return [Solargraph::Pin::Method]
       def self.build_public_method(
         namespace,
@@ -42,7 +43,7 @@ module Solargraph
       end
 
       # @param namespace [Solargraph::Pin::Namespace]
-      # @param name [String]
+      # @param module_name [String]
       # @param location [Solargraph::Location]
       # @return [Solargraph::Pin::Reference::Include]
       def self.build_module_include(namespace, module_name, location)
@@ -74,10 +75,36 @@ module Solargraph
         )
       end
 
+      # Given the following code, Solargraph::Parser.node_range returns the following range for block ast:
+      #
+      # some_method_with_block do
+      # ^ - block start
+      # end
+      # ^ - block end
+      #
+      # Instead we want the range to be:
+      #
+      # some_method_with_block do
+      #                        ^ - block start
+      # end
+      # ^ - block end
+      #
       # @param ast [::Parser::AST::Node]
       # @return [Solargraph::Range]
       def self.build_location_range(ast)
-        Solargraph::Parser.node_range(ast)
+        if ast.type == :block
+          method_range = Solargraph::Parser.node_range(ast.children[0])
+          full_block_range = Solargraph::Parser.node_range(ast)
+
+          Solargraph::Range.from_to(
+            method_range.ending.line,
+            method_range.ending.character,
+            full_block_range.ending.line,
+            full_block_range.ending.character
+          )
+        else
+          Solargraph::Parser.node_range(ast)
+        end
       end
 
       # @param location_range [Solargraph::Range]

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

@@ -11,6 +11,7 @@ module Solargraph
           # Transforms let block to method ast node
           # @param block_ast [::Parser::AST::Node]
           # @return [::Parser::AST::Node, nil]
+          # @param [String, nil] method_name
           def transform_block(block_ast, method_name = nil)
             method_name ||= NodeTypes.let_method_name(block_ast)
 
@@ -22,11 +23,6 @@ module Solargraph
                 block_ast.children[2]
               ]
             )
-          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}"
           end
         end
       end

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

@@ -10,38 +10,40 @@ module Solargraph
           ast.is_a?(::Parser::AST::Node) && ast.type == :block
         end
 
-        # @param ast [::Parser::AST::Node]
+        # @param block_ast [::Parser::AST::Node]
         # @return [Boolean]
         def self.a_context_block?(block_ast)
           Solargraph::Rspec::CONTEXT_METHODS.include?(method_with_block_name(block_ast))
         end
 
-        # @param ast [::Parser::AST::Node]
+        # @param block_ast [::Parser::AST::Node]
         # @return [Boolean]
         def self.a_subject_block?(block_ast)
           Solargraph::Rspec::SUBJECT_METHODS.include?(method_with_block_name(block_ast))
         end
 
-        # @param ast [::Parser::AST::Node]
+        # @param block_ast [::Parser::AST::Node]
         # @param config [Config]
         # @return [Boolean]
         def self.a_example_block?(block_ast, config)
           config.example_methods.map(&:to_s).include?(method_with_block_name(block_ast))
         end
 
-        # @param ast [::Parser::AST::Node]
+        # @param block_ast [::Parser::AST::Node]
         # @param config [Config]
         # @return [Boolean]
         def self.a_let_block?(block_ast, config)
           config.let_methods.map(&:to_s).include?(method_with_block_name(block_ast))
         end
 
-        # @param ast [::Parser::AST::Node]
+        # @param block_ast [::Parser::AST::Node]
         # @return [Boolean]
         def self.a_hook_block?(block_ast)
           Solargraph::Rspec::HOOK_METHODS.include?(method_with_block_name(block_ast))
         end
 
+        # @param [::Parser::AST::Node] ast
+        # @return [Boolean]
         def self.a_constant?(ast)
           ast.type == :const
         end
@@ -56,7 +58,7 @@ module Solargraph
         end
 
         # @param block_ast [::Parser::AST::Node]
-        # @return [::Parser::AST::Node]
+        # @return [::Parser::AST::Node, nil]
         def self.context_description_node(block_ast)
           return nil unless a_context_block?(block_ast)
 
@@ -64,7 +66,7 @@ module Solargraph
         end
 
         # @param block_ast [::Parser::AST::Node]
-        # @return [String]
+        # @return [String, nil]
         def self.let_method_name(block_ast)
           return nil unless a_block?(block_ast)
 

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

@@ -26,7 +26,7 @@ module Solargraph
           private
 
           # @see https://github.com/rspec/rspec-core/blob/1eeadce5aa7137ead054783c31ff35cbfe9d07cc/lib/rspec/core/example_group.rb#L862
-          # @param ast [Parser::AST::Node]
+          # @param string_ast [Parser::AST::Node]
           # @return [String]
           def string_to_const_name(string_ast)
             return unless string_ast.type == :str

data/lib/solargraph/rspec/spec_walker.rb

@@ -188,8 +188,9 @@ module Solargraph
       end
 
       # Find all describe/context blocks in the AST.
-      # @param ast [Parser::AST::Node]
       # @yield [String, Parser::AST::Node]
+      # @param [Parser::AST::Node] ast
+      # @param [String] root_namespace
       def each_context_block(ast, root_namespace = Rspec::ROOT_NAMESPACE, &block)
         each_block(ast, root_namespace) do |block_ast, parent_namespace|
           is_a_context = NodeTypes.a_context_block?(block_ast)

data/lib/solargraph/rspec/version.rb

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

data/lib/solargraph/rspec/walker.rb

@@ -54,6 +54,7 @@ module Solargraph
         end
 
         # @param children [Array<::Parser::AST::Node>]
+        # @param args [Array]
         def match_children(children, args = @args)
           args.each_with_index.all? do |arg, i|
             if arg == :any

data/rbs_collection.yaml

@@ -0,0 +1,20 @@
+
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rspec
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Lekë Mula
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-06 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -33,6 +34,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".solargraph.yml.example"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -54,24 +56,29 @@ files:
 - lib/solargraph/rspec/correctors/example_and_hook_blocks_binding_corrector.rb
 - lib/solargraph/rspec/correctors/let_methods_corrector.rb
 - 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
 - lib/solargraph/rspec/spec_walker/node_types.rb
 - lib/solargraph/rspec/spec_walker/rspec_context_namespace.rb
-- lib/solargraph/rspec/test_helpers.rb
 - lib/solargraph/rspec/version.rb
 - lib/solargraph/rspec/walker.rb
 - lib/solargraph_rspec.rb
+- rbs_collection.yaml
 - 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
@@ -86,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: []