solargraph-rspec 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f73a95cc73aa3ce52cff1e5e4e8e06509f3a59ccf6a3371b9087fad38e135b0
-  data.tar.gz: 221342fb0163f67fce1648aa4b14310b31907aacc9637def0b61e690b8ff750e
+  metadata.gz: 25d0ca1f34e0cf80057b86a412ec10cbacba388a96bd5b5e7b93f64457616e5a
+  data.tar.gz: d1b4b825f9df08a3333bab32d2af05a9cc6a48cd7903f5b4504baba1e775a960
 SHA512:
-  metadata.gz: 47f84a714dc459f67e354b68ff1c037e0ee9170a364db3fb4aa8e7a04cef1ce81952fade0a109a41de91f57b0b18201d3d8ab95b901f94de679357688bc9e41f
-  data.tar.gz: a5bff062303a4fd717315083944c19dbe1c21a94ee795e9f29d5e2971d574038bb75677c596645dacd5861f5f624a7a36a93347c48e443a549ab7decc387dae3
+  metadata.gz: 1d7efb9da09a862654e5bb4fbd70bb983230cae9303e98ebc487cb0f00afe752ba8c936513dc23aac153e99f49d607b93111aada2f235fb47fdbeefcb81a0acb
+  data.tar.gz: aa9563e0d56a8ab37b45a739f6394e47e7dd597bc59bfb205a043ed41d9b5c47bc08b7a8184225ed75f2840bd57aeedd96ed05f325d32700c54e81aafb3e39d3

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [0.2.1] - 2024-06-09
+
+### Added
+
+- Documentation for `RSpec::ExampleGroups` DSL methods like `it`, `fit`, `example` etc.
+
+### Fixed
+
+- Fix nameless `subject` method completion inside nested `context` blocks
+- (Hack-ish) Fix `described_class` type collision when `RSpec.describe SomeClassWithoutNamespace`
+
 ## [0.2.0] - 2024-05-20
 
 ### Added

data/codecov.yml

@@ -0,0 +1,13 @@
+# https://docs.codecov.com/docs/common-recipe-list
+coverage:
+  status:
+    project: #add everything under here, more options at https://docs.codecov.com/docs/commit-status
+      default:
+        # basic
+        target: auto #default
+        threshold: 1%
+        base: auto
+        informational: true
+    patch:
+      default:
+        informational: true

data/lib/solargraph/rspec/convention.rb

@@ -8,7 +8,6 @@ require_relative 'correctors/described_class_corrector'
 require_relative 'correctors/let_methods_corrector'
 require_relative 'correctors/subject_method_corrector'
 require_relative 'correctors/context_block_methods_corrector'
-require_relative 'correctors/implicit_subject_method_corrector'
 require_relative 'correctors/dsl_methods_corrector'
 require_relative 'pin_factory'
 
@@ -50,6 +49,17 @@ module Solargraph
       include_context
     ].freeze
 
+    # @type [Array<Class<Correctors::Base>>]
+    CORRECTOR_CLASSES = [
+      Correctors::ContextBlockMethodsCorrector,
+      Correctors::ContextBlockNamespaceCorrector,
+      Correctors::DescribedClassCorrector,
+      Correctors::DslMethodsCorrector,
+      Correctors::ExampleAndHookBlocksBindingCorrector,
+      Correctors::LetMethodsCorrector,
+      Correctors::SubjectMethodCorrector
+    ].freeze
+
     # Provides completion for RSpec DSL and helper methods.
     #   - `describe` and `context` blocks
     #   - `let` and `let!` methods
@@ -105,86 +115,17 @@ module Solargraph
 
         rspec_walker = SpecWalker.new(source_map: source_map, config: config)
 
-        Correctors::ContextBlockNamespaceCorrector.new(
-          namespace_pins: namespace_pins,
-          rspec_walker: rspec_walker
-        ).correct(source_map) do |pins_to_add|
-          pins += pins_to_add
-        end
-
-        Correctors::ExampleAndHookBlocksBindingCorrector.new(
-          namespace_pins: namespace_pins,
-          rspec_walker: rspec_walker
-        ).correct(source_map) do |pins_to_add|
-          pins += pins_to_add
-        end
-
-        # @type [Pin::Method, nil]
-        described_class_pin = nil
-        Correctors::DescribedClassCorrector.new(
-          namespace_pins: namespace_pins,
-          rspec_walker: rspec_walker
-        ).correct(
-          source_map
-        ) do |pins_to_add|
-          described_class_pin = pins_to_add.first
-          pins += pins_to_add
-        end
-
-        Correctors::LetMethodsCorrector.new(
-          namespace_pins: namespace_pins,
-          rspec_walker: rspec_walker
-        ).correct(
-          source_map
-        ) do |pins_to_add|
-          pins += pins_to_add
-        end
-
-        # @type [Pin::Method, nil]
-        subject_pin = nil
-        Correctors::SubjectMethodCorrector.new(
-          namespace_pins: namespace_pins,
-          rspec_walker: rspec_walker
-        ).correct(
-          source_map
-        ) do |pins_to_add|
-          subject_pin = pins_to_add.first
-          pins += pins_to_add
-        end
-
-        Correctors::ContextBlockMethodsCorrector.new(
-          namespace_pins: namespace_pins,
-          rspec_walker: rspec_walker
-        ).correct(source_map) do |pins_to_add|
-          pins += pins_to_add
-        end
-
-        Correctors::DslMethodsCorrector.new(
-          namespace_pins: namespace_pins,
-          rspec_walker: rspec_walker,
-          config: config
-        ).correct(
-          source_map
-        ) do |pins_to_add|
-          pins += pins_to_add
+        CORRECTOR_CLASSES.each do |corrector_class|
+          corrector_class.new(
+            namespace_pins: namespace_pins,
+            rspec_walker: rspec_walker,
+            added_pins: pins
+          ).correct(source_map)
         end
 
         rspec_walker.walk!
         pins += namespace_pins
 
-        # Implicit subject
-        if !subject_pin && described_class_pin
-          Correctors::ImplicitSubjectMethodCorrector.new(
-            namespace_pins: namespace_pins,
-            described_class_pin: described_class_pin
-          ).correct(
-            source_map
-          ) do |pins_to_add|
-            subject_pin = pins_to_add.first
-            pins += pins_to_add
-          end
-        end
-
         if pins.any?
           Solargraph.logger.debug(
             "[RSpec] added #{pins.map(&:inspect)} to #{source_map.filename}"

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

@@ -9,13 +9,22 @@ module Solargraph
         # @return [Array<Solargraph::Pin::Namespace>]
         attr_reader :namespace_pins
 
+        # @return [Solargraph::Rspec::SpecWalker]
+        attr_reader :rspec_walker
+
+        # @return [Array<Solargraph::Pin::Base]
+        attr_reader :added_pins
+
         # @param namespace_pins [Array<Solargraph::Pin::Base>]
-        def initialize(namespace_pins:)
+        # @param rspec_walker [Solargraph::Rspec::SpecWalker]
+        # @param added_pins [Array<Solargraph::Pin::Base>]
+        def initialize(namespace_pins:, rspec_walker:, added_pins: [])
           @namespace_pins = namespace_pins
+          @rspec_walker = rspec_walker
+          @added_pins = added_pins
         end
 
         # @param _source_map [Solargraph::SourceMap]
-        # @yield [Array<Solargraph::Pin::Base>] Pins to be added to the source map
         # @return [void]
         def correct(_source_map)
           raise NotImplementedError
@@ -23,6 +32,20 @@ module Solargraph
 
         private
 
+        # @param pin [Solargraph::Pin::Base, nil]
+        # @return [void]
+        def add_pin(pin)
+          return unless pin
+
+          added_pins.push(pin)
+        end
+
+        # @param pins [Array<Solargraph::Pin::Base>]
+        # @return [void]
+        def add_pins(*pins)
+          added_pins.concat(pins.flatten.compact)
+        end
+
         # @return [Solargraph::Pin::Namespace]
         def root_example_group_namespace_pin
           Solargraph::Pin::Namespace.new(

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

@@ -6,7 +6,7 @@ module Solargraph
   module Rspec
     module Correctors
       # A corrector that corrects pure ruby method blocks namespace defined inside describe/context blocks.
-      class ContextBlockMethodsCorrector < WalkerBase
+      class ContextBlockMethodsCorrector < Base
         # @param source_map [Solargraph::SourceMap]
         def correct(source_map)
           rspec_walker.after_walk do
@@ -28,8 +28,6 @@ module Solargraph
                 comments: pin.comments
               )
             end
-
-            yield [] if block_given?
           end
         end
       end

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'walker_base'
+require_relative 'base'
 
 module Solargraph
   module Rspec
     module Correctors
-      # A corrector of RSpec parsed pins by Solargraph
-      class ContextBlockNamespaceCorrector < WalkerBase
+      # RSpec generates a namespace class for each context block. This corrector add the pins for those namespaces.
+      class ContextBlockNamespaceCorrector < Base
         # @param source_map [Solargraph::SourceMap]
         def correct(source_map)
           # @param location_range [Solargraph::Range]
@@ -52,12 +52,8 @@ module Solargraph
             )
 
             namespace_pins << namespace_pin
-            if block_given?
-              yield [
-                namespace_include_pin,
-                namespace_extend_pin
-              ]
-            end
+
+            add_pins(namespace_extend_pin, namespace_include_pin)
           end
         end
       end

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'walker_base'
+require_relative 'base'
 
 module Solargraph
   module Rspec
     module Correctors
-      class DescribedClassCorrector < WalkerBase
+      # Defines `described_class` method in the example group block
+      class DescribedClassCorrector < Base
         # @param source_map [Solargraph::SourceMap]
         # @return [void]
         def correct(_source_map)
@@ -14,7 +15,7 @@ module Solargraph
             next unless namespace_pin
 
             described_class_pin = rspec_described_class_method(namespace_pin, location_range, described_class_name)
-            yield [described_class_pin].compact if block_given?
+            add_pin(described_class_pin)
           end
         end
 

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

@@ -1,44 +1,47 @@
 # frozen_string_literal: true
 
-require_relative 'walker_base'
+require_relative 'base'
+require 'yard'
 
 module Solargraph
   module Rspec
     module Correctors
-      class DslMethodsCorrector < WalkerBase
-        # @param namespace_pins [Array<Solargraph::Pin::Base>]
-        # @param rspec_walker [Solargraph::Rspec::SpecWalker]
-        # @param config [Solargraph::Rspec::Config]
-        def initialize(namespace_pins:, rspec_walker:, config:)
-          super(namespace_pins: namespace_pins, rspec_walker: rspec_walker)
-          @config = config
+      # Includes DSL method helpers in the example group block for completion (ie. it, before, let, subject, etc.)
+      class DslMethodsCorrector < Base
+        # @return [Array<YARD::CodeObjects::Base>]
+        def self.rspec_yardoc_tags
+          @rspec_yardoc_tags ||= begin
+            spec = Gem::Specification.find_by_name('rspec-core')
+            require_paths = spec.require_paths.map { |path| File.join(spec.full_gem_path, path) }
+            Solargraph.logger.debug "[RSpec] Loading YARD registry for rspec-core from #{require_paths}"
+            YARD::Registry.load(require_paths, true)
+            YARD::Registry.all
+          end
         end
 
         # @param source_map [Solargraph::SourceMap]
         # @return [void]
         def correct(_source_map)
           rspec_walker.after_walk do
-            if block_given?
-              yield namespace_pins.flat_map { |namespace_pin| add_context_dsl_methods(namespace_pin) }
-              yield namespace_pins.flat_map { |namespace_pin| add_methods_with_example_binding(namespace_pin) }
+            namespace_pins.each do |namespace_pin|
+              add_pins(context_dsl_methods(namespace_pin))
+              add_pins(methods_with_example_binding(namespace_pin))
             end
           end
         end
 
         private
 
-        # @return [Solargraph::Rspec::Config]
-        attr_reader :config
-
         # RSpec executes example and hook blocks (eg. it, before, after)in the context of the example group.
-        # @yieldsef changes the binding of the block to correct class.
+        # Tag @yieldsef changes the binding of the block to correct class.
         # @return [Array<Solargraph::Pin::Method>]
-        def add_methods_with_example_binding(namespace_pin)
+        def methods_with_example_binding(namespace_pin)
           rspec_context_block_methods.map do |method|
+            # TODO: Add location from YARD registry and documentation for other methods not just example group methods.
             PinFactory.build_public_method(
               namespace_pin,
               method.to_s,
-              comments: ["@yieldself [#{namespace_pin.path}]"], # Fixes the binding of the block to the correct class
+              comments: [example_group_documentation(method), "@yieldself [#{namespace_pin.path}]"],
               scope: :class
             )
           end
@@ -48,7 +51,7 @@ module Solargraph
         #   Fix this once Solargraph supports extending class methods.
         # @param namespace_pin [Solargraph::Pin::Base]
         # @return [Array<Solargraph::Pin::Base>]
-        def add_context_dsl_methods(namespace_pin)
+        def context_dsl_methods(namespace_pin)
           Rspec::CONTEXT_METHODS.map do |method|
             PinFactory.build_public_method(
               namespace_pin,
@@ -58,10 +61,36 @@ module Solargraph
           end
         end
 
+        # @param method [String]
+        # @return [String]
+        def example_group_documentation(method)
+          return unless Rspec::EXAMPLE_METHODS.include?(method)
+
+          yardoc = rspec_yardoc_tags_at("RSpec::Core::ExampleGroup.#{method}")
+
+          unless yardoc
+            Solargraph.logger.warn "[RSpec] YARD documentation not found for RSpec::Core::ExampleGroup.#{method}"
+            return
+          end
+
+          yardoc.docstring.all
+        end
+
+        # @param method [String]
+        # @return [YARD::CodeObjects::MethodObject, nil]
+        def rspec_yardoc_tags_at(method_path)
+          self.class.rspec_yardoc_tags.find { |tag| tag.path == method_path }
+        end
+
         # @return [Array<String>]
         def rspec_context_block_methods
           config.let_methods + Rspec::HOOK_METHODS + Rspec::EXAMPLE_METHODS
         end
+
+        # @return [Solargraph::Rspec::Config]
+        def config
+          Solargraph::Rspec::Convention.config
+        end
       end
     end
   end

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

@@ -1,44 +1,34 @@
 # frozen_string_literal: true
 
-require_relative 'walker_base'
+require_relative 'base'
 
 module Solargraph
   module Rspec
     module Correctors
-      # Sets the correct namespace binding for example group blocks (it, example, etc.) and
-      # hook blocks (before, after, around)
-      class ExampleAndHookBlocksBindingCorrector < WalkerBase
+      # RSpec executes example and hook blocks in the context of the example group (ie. describe blocks).
+      # This correctors sets the right bindings to those blocks.
+      class ExampleAndHookBlocksBindingCorrector < Base
         # @param source_map [Solargraph::SourceMap]
         # @return [void]
         def correct(source_map)
           rspec_walker.on_example_block do |location_range|
             bind_closest_namespace(location_range, source_map)
-
-            yield [] if block_given?
           end
 
           rspec_walker.on_hook_block do |location_range|
             bind_closest_namespace(location_range, source_map)
-
-            yield [] if block_given?
           end
 
           rspec_walker.on_let_method do |_method_name, location_range|
             bind_closest_namespace(location_range, source_map)
-
-            yield [] if block_given?
           end
 
           rspec_walker.on_blocks_in_examples do |location_range|
             bind_closest_namespace(location_range, source_map)
-
-            yield [] if block_given?
           end
 
           rspec_walker.on_subject do |_method_name, location_range|
             bind_closest_namespace(location_range, source_map)
-
-            yield [] if block_given?
           end
         end
 

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'walker_base'
+require_relative 'base'
 
 module Solargraph
   module Rspec
     module Correctors
       # Defines let-like methods in the example group block
-      class LetMethodsCorrector < WalkerBase
+      class LetMethodsCorrector < Base
         # @param source_map [Solargraph::SourceMap]
         # @return [void]
         def correct(_source_map)
@@ -15,7 +15,7 @@ module Solargraph
             next unless namespace_pin
 
             pin = rspec_let_method(namespace_pin, let_name, location_range, fake_method_ast)
-            yield [pin] if block_given?
+            add_pin(pin)
           end
         end
 

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

@@ -11,14 +11,52 @@ module Solargraph
         # @return [void]
         def correct(_source_map)
           rspec_walker.on_subject do |subject_name, location_range, fake_method_ast|
-            next unless subject_name
-
             namespace_pin = closest_namespace_pin(namespace_pins, location_range.start.line)
             next unless namespace_pin
 
-            subject_pin = rspec_let_method(namespace_pin, subject_name, location_range, fake_method_ast)
-            yield [subject_pin].compact if block_given?
+            subject_pin = rspec_subject_method(namespace_pin, subject_name, location_range, fake_method_ast)
+            add_pin(subject_pin)
           end
+
+          rspec_walker.after_walk do
+            next unless described_class_pin
+
+            namespace_pin = closest_namespace_pin(namespace_pins, described_class_pin.location.range.start.line)
+
+            add_pin(implicit_subject_pin(described_class_pin, namespace_pin)) if namespace_pin
+          end
+        end
+
+        private
+
+        # @return [Pin::Method, nil]
+        def described_class_pin
+          @described_class_pin ||= added_pins.find { |pin| pin.is_a?(Pin::Method) && pin.name == 'described_class' }
+        end
+
+        # @param namespace_pin [Pin::Namespace]
+        # @param subject_name [String, nil]
+        # @param location_range [Solargraph::Range]
+        # @param fake_method_ast [Parser::AST::Node]
+        # @return [Pin::Method]
+        def rspec_subject_method(namespace_pin, subject_name, location_range, fake_method_ast)
+          method_name = subject_name || 'subject'
+          rspec_let_method(namespace_pin, method_name, location_range, fake_method_ast)
+        end
+
+        # @param described_class_pin [Pin::Method]
+        # @param namespace_pin [Pin::Namespace]
+        # @return [Pin::Method]
+        def implicit_subject_pin(described_class_pin, namespace_pin)
+          described_class = described_class_pin.return_type.first.subtypes.first.name
+
+          PinFactory.build_public_method(
+            namespace_pin,
+            'subject',
+            types: ["::#{described_class}"],
+            location: described_class_pin.location,
+            scope: :instance
+          )
         end
       end
     end

data/lib/solargraph/rspec/spec_walker.rb

@@ -201,6 +201,10 @@ module Solargraph
           block_name = RspecContextNamespace.from_block_ast(block_ast)
           next unless block_name
 
+          # @HACK: When we describe `SomeClass` without a namespace, Solargraph confuses described_class with the
+          # `RSpec::ExampleGroups::SomeClass` constant. To avoid this, we append the root namespace with "Test"
+          block_name = "Test#{block_name}" if parent_namespace == Rspec::ROOT_NAMESPACE
+
           parent_namespace = namespace_name = "#{parent_namespace}::#{block_name}"
           block&.call(namespace_name, block_ast)
           next parent_namespace

data/lib/solargraph/rspec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph-rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Lekë Mula
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-20 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -45,6 +45,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- codecov.yml
 - lib/solargraph-rspec.rb
 - lib/solargraph/rspec/config.rb
 - lib/solargraph/rspec/convention.rb
@@ -54,10 +55,8 @@ files:
 - lib/solargraph/rspec/correctors/described_class_corrector.rb
 - lib/solargraph/rspec/correctors/dsl_methods_corrector.rb
 - lib/solargraph/rspec/correctors/example_and_hook_blocks_binding_corrector.rb
-- lib/solargraph/rspec/correctors/implicit_subject_method_corrector.rb
 - lib/solargraph/rspec/correctors/let_methods_corrector.rb
 - lib/solargraph/rspec/correctors/subject_method_corrector.rb
-- lib/solargraph/rspec/correctors/walker_base.rb
 - lib/solargraph/rspec/pin_factory.rb
 - lib/solargraph/rspec/spec_walker.rb
 - lib/solargraph/rspec/spec_walker/fake_let_method.rb

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'let_methods_corrector'
-
-module Solargraph
-  module Rspec
-    module Correctors
-      # Defines let-like methods in the example group block
-      class ImplicitSubjectMethodCorrector < Base
-        # @return [Pin::Method]
-        attr_reader :described_class_pin
-
-        # @param namespace_pins [Array<Pin::Namespace>]
-        # @param described_class_pin [Pin::Method]
-        def initialize(namespace_pins:, described_class_pin:)
-          super(namespace_pins: namespace_pins)
-
-          @described_class_pin = described_class_pin
-        end
-
-        # @param source_map [Solargraph::SourceMap]
-        # @return [void]
-        def correct(_source_map)
-          namespace_pin = closest_namespace_pin(namespace_pins, described_class_pin.location.range.start.line)
-
-          yield [implicit_subject_pin(described_class_pin, namespace_pin)] if block_given? && namespace_pin
-        end
-
-        private
-
-        # @param described_class_pin [Pin::Method]
-        # @param namespace_pin [Pin::Namespace]
-        # @return [Pin::Method]
-        def implicit_subject_pin(described_class_pin, namespace_pin)
-          described_class = described_class_pin.return_type.first.subtypes.first.name
-
-          PinFactory.build_public_method(
-            namespace_pin,
-            'subject',
-            types: ["::#{described_class}"],
-            location: described_class_pin.location,
-            scope: :instance
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-# A corrector that walks through RSpec AST nodes and corrects them
-module Solargraph
-  module Rspec
-    module Correctors
-      # A corrector of RSpec parsed pins by Solargraph
-      # @abstract
-      class WalkerBase < Base
-        # @return [Array<Solargraph::Pin::Namespace>]
-        attr_reader :namespace_pins
-
-        # @return [Solargraph::Rspec::SpecWalker]
-        attr_reader :rspec_walker
-
-        # @param namespace_pins [Array<Solargraph::Pin::Base>]
-        # @param rspec_walker [Solargraph::Rspec::SpecWalker]
-        def initialize(namespace_pins:, rspec_walker:)
-          super(namespace_pins: namespace_pins)
-          @rspec_walker = rspec_walker
-        end
-      end
-    end
-  end
-end