solargraph-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b29106f92a5279085cce258a7aabc92070d5452446a8f5a0b9c141d2a3d5a52d
+  data.tar.gz: a153e3a43ff36c494484ecef9e7ef4f31066b0c002f0c3e16505a3357231591f
+SHA512:
+  metadata.gz: 7c12a1454723f6acfe6bafcb856ff300734d27429d6ee08f053f2c05b30f7ff3885bb595ce14fb360bbfeec1cbf9339938a52cfa2f63874fce4cbd2d6efacbcf
+  data.tar.gz: 3b81a6a82e580bc0e5ff86a0aeb66d61f6f9c8a8e7191ac0df52a31ac482b9dc774cd10b43d881babf80fdd6e60c93dc87a25a7f72ad296aea6d57743c550055

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- 
+
+## [0.1.0] - 2024-05-11 (First Release 🎉)
+
+### Added
+
+- `describe` and `it` methods completion
+- memoized `let` and `let!` methods completion 
+- implicit and explicit `subject` methods
+- `described_class` with appropriate type inference
+- `RSpec::Matchers` methods completion
+- Completes normal ruby methods within `describe/context` blocks
+- RSpec DSL suggestions (eg. `it`, `describe`, `fit`.. etc.)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at l.mula@finlink.de. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Lekë Mula
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Solargraph::Rspec - A Solargraph plugin for better RSpec support
+
+![Tests](https://github.com/lekemula/solargraph-rspec/actions/workflows/ruby.yml/badge.svg)
+[![codecov](https://codecov.io/gh/lekemula/solargraph-rspec/graph/badge.svg?token=FH7ER8ZDPW)](https://codecov.io/gh/lekemula/solargraph-rspec)
+
+
+RSpec is a testing framework of choice for many Ruby developers. But at the same time is highly dynamic and heavily relying on metaprogramming making it hard to provide accurate code completion and type inference. 
+
+This gem aims to provide a better support for RSpec in Solargraph and it supports the following features:
+  - `describe` and `it` methods completion
+  - memoized `let` and `let!` methods completion 
+  - implicit and explicit `subject` methods
+  - `described_class` with appropriate type inference
+  - `RSpec::Matchers` methods completion
+  - and more to come...
+
+  ![solargraph-rspec_smaller](https://github.com/lekemula/solargraph-rspec/assets/9197495/66f86e5b-258e-4d8c-8a64-0685d15ece00)
+
+## Installation
+
+###  Install `solargraph` and `solargraph-rspec`
+
+Install the gems from the command line:
+
+```bash
+gem install solargraph solargraph-rspec
+```
+
+Or add it to your Gemfile:
+
+```ruby
+group :development do
+  gem 'solargraph' 
+  gem 'solargraph-rspec'
+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.
+
+(if you don't have a `.solargraph.yml` in your project root, you can run `solargraph config` to add one)
+
+```diff
+@@ -2,7 +2,6 @@
+ include:
+ - "**/*.rb"
+ exclude:
+-- spec/**/*
+ - test/**/*
+ - vendor/**/*
+ - ".bundle/**/*"
+@@ -18,5 +17,6 @@ formatter:
+     only: []
+     extra_args: []
+ require_paths: []
+-plugins: []
++plugins:
++  - solargraph-rspec
+ max_files: 5000
+```
+### Configuration
+
+If you have your own custom `let`-like memoized methods, you can add them to your `.solargraph.yml` file like this:
+
+```yaml
+# .solargraph.yml
+# ...
+rspec:
+  let_methods:
+    - let_it_be
+```
+
+### 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)).
+
+Run `yard gems` to generate documentation for your installed gems.
+
+Run `yard config --gem-install-yri` to generate YARD documentation automatically when you install new gems.
+
+## Acknowledgements
+
+This gem is inspired by the [solargraph-rails](https://github.com/iftheshoefritz/solargraph-rails) which gave me an idea of how to extend Solargraph with custom features and provided me with simple and very understandable test suite which helped me to get started with playing around with Solargraph. 
+
+In fact, most of the code I initially wrote on [a fork](https://github.com/lekemula/solargraph-rails/tree/rspec-support) of it, but then I realized that it would make more sense to extract it into a separate gem where it could be used by non-Rails projects as well.
+
+It also goes without saying that the Solargraph gem itself is a great tool that it has helped me a lot in my daily work and I'm very grateful to [@castwide](https://github.com/castwide) for creating it and maintaining it. :heart:
+
+It's codebase IMO is an exemplary of how Ruby code written in a very simple POROs without any wild metaprogramming magic and supplemented with YARDocs, for such a complex tools can be very readable and understandable even for a total newbie like me in this domain!
+
+## Contributing
+
+### Bug Reports and Feature Requests
+
+[GitHub Issues](https://github.com/lekemula/solargraph-rspec/issues) are the best place to ask questions, report problems, and suggest improvements.
+
+### Development
+
+Code contributions are always appreciated. Feel free to fork the repo and submit pull requests. Check for open issues that could use help. Start new issues to discuss changes that have a major impact on the code or require large time commitments.
+
+Contributing is easy:
+1. Create a fork and clone it
+2. Run `bundle install` to install dependencies
+3. Run `yard gems` to generate YARD documentation for your installed gems
+4. Run `bundle exec spec` to run the tests
+5. Introduce your awesome changes
+6. Ensure they are well covered with tests
+7. Record your changes in the [CHANGELOG.md](./CHANGELOG.md)
+7. Submit a pull request :rocket:
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/solargraph/rspec/config.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Rspec
+    # @example .solargraph.yml configuration for rspec
+    #   rspec:
+    #     let_methods:
+    #       - let_it_be
+    class Config
+      def initialize(solargraph_config = Solargraph::Workspace::Config.new('./'))
+        @solargraph_config = solargraph_config
+        Solargraph.logger.debug "[RSpec] Solargraph config: #{raw_data}"
+      end
+
+      # @return [Solargraph::Workspace::Config]
+      attr_reader :solargraph_config
+
+      # @return [Array<Symbol>]
+      def let_methods
+        (Rspec::LET_METHODS + additional_let_methods).map(&:to_sym)
+      end
+
+      private
+
+      # @return [Hash]
+      def rspec_raw_data
+        @rspec_raw_data ||= raw_data['rspec'] || {}
+      end
+
+      # @return [Array<Symbol>]
+      def additional_let_methods
+        (rspec_raw_data['let_methods'] || []).map(&:to_sym)
+      end
+
+      # @return [Hash]
+      def raw_data
+        @solargraph_config.raw_data
+      end
+    end
+  end
+end

data/lib/solargraph/rspec/convention.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+require_relative 'spec_walker'
+require_relative 'correctors/context_block_namespace_corrector'
+require_relative 'correctors/example_and_hook_blocks_binding_corrector'
+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 'util'
+
+module Solargraph
+  module Rspec
+    ROOT_NAMESPACE = 'RSpec::ExampleGroups'
+    HELPER_MODULES = ['RSpec::Matchers'].freeze
+    HOOK_METHODS = %w[before after around].freeze
+    LET_METHODS = %w[let let!].freeze
+    EXAMPLE_METHODS = %w[
+      example
+      it
+      specify
+      focus
+      fexample
+      fit
+      fspecify
+      xexample
+      xit
+      xspecify
+      skip
+      pending
+    ].freeze
+
+    CONTEXT_METHODS = %w[
+      example_group
+      describe
+      context
+      xdescribe
+      xcontext
+      fdescribe
+      fcontext
+      shared_examples
+      include_examples
+      it_behaves_like
+      it_should_behave_like
+      shared_context
+      include_context
+    ].freeze
+
+    # Provides completion for RSpec DSL and helper methods.
+    #   - `describe` and `context` blocks
+    #   - `let` and `let!` methods
+    #   - `subject` method
+    #   - `described_class` method
+    #   - `it` method with correct binding
+    #   - `RSpec::Matchers` module
+    class Convention < Solargraph::Convention::Base
+      # @return [Config]
+      def self.config
+        @config ||= Config.new
+      end
+
+      # @param filename [String]
+      # @return [Boolean]
+      def self.valid_filename?(filename)
+        filename.include?('spec/')
+      end
+
+      # @param yard_map [YardMap]
+      # @return [Environ]
+      def global(_yard_map)
+        pins = []
+        pins += include_helper_pins
+
+        if pins.any?
+          Solargraph.logger.debug(
+            "[RSpec] added global pins #{pins.map(&:inspect)}"
+          )
+        end
+
+        Environ.new(pins: pins)
+      rescue StandardError => e
+        raise e if ENV['SOLARGRAPH_DEBUG']
+
+        Solargraph.logger.warn(
+          "[RSpec] Error processing global pins: #{e.message}\n#{e.backtrace.join("\n")}"
+        )
+        EMPTY_ENVIRON
+      end
+
+      # @param source_map [SourceMap]
+      # @return [Environ]
+      def local(source_map)
+        Solargraph.logger.debug "[RSpec] processing #{source_map.filename}"
+
+        return EMPTY_ENVIRON unless self.class.valid_filename?(source_map.filename)
+
+        # @type [Array<Pin::Base>]
+        pins = []
+        # @type [Array<Pin::Namespace>]
+        namespace_pins = []
+
+        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
+        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}"
+          )
+        end
+
+        Environ.new(requires: ['rspec'], pins: pins)
+      rescue StandardError => e
+        raise e if ENV['SOLARGRAPH_DEBUG']
+
+        Solargraph.logger.warn(
+          "[RSpec] Error processing #{source_map.filename}: #{e.message}\n#{e.backtrace.join("\n")}"
+        )
+        EMPTY_ENVIRON
+      end
+
+      private
+
+      # @param helper_modules [Array<String>]
+      # @param source_map [SourceMap]
+      # @return [Array<Pin::Base>]
+      def include_helper_pins(helper_modules: HELPER_MODULES)
+        helper_modules.map do |helper_module|
+          Util.build_module_include(
+            root_example_group_namespace_pin,
+            helper_module,
+            root_example_group_namespace_pin.location
+          )
+        end
+      end
+
+      # @return [Config]
+      def config
+        self.class.config
+      end
+
+      # @return [Pin::Namespace]
+      def root_example_group_namespace_pin
+        Solargraph::Pin::Namespace.new(
+          name: ROOT_NAMESPACE,
+          location: Util.dummy_location('lib/rspec/core/example_group.rb')
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Rspec
+    module Correctors
+      # A corrector of RSpec parsed pins by Solargraph
+      # @abstract
+      class Base
+        # @return [Array<Solargraph::Pin::Namespace>]
+        attr_reader :namespace_pins
+
+        # @param namespace_pins [Array<Solargraph::Pin::Base>]
+        def initialize(namespace_pins:)
+          @namespace_pins = namespace_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
+        end
+
+        private
+
+        # @return [Solargraph::Pin::Namespace]
+        def root_example_group_namespace_pin
+          Solargraph::Pin::Namespace.new(
+            name: ROOT_NAMESPACE,
+            location: Util.dummy_location('lib/rspec/core/example_group.rb')
+          )
+        end
+
+        # @param namespace_pins [Array<Pin::Namespace>]
+        # @param line [Integer]
+        # @return [Pin::Namespace, nil]
+        def closest_namespace_pin(namespace_pins, line)
+          namespace_pins.min_by do |namespace_pin|
+            distance = line - namespace_pin.location.range.start.line
+            distance >= 0 ? distance : Float::INFINITY
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Solargraph
+  module Rspec
+    module Correctors
+      # A corrector that corrects pure ruby method blocks namespace defined inside describe/context blocks.
+      class ContextBlockMethodsCorrector < WalkerBase
+        # @param source_map [Solargraph::SourceMap]
+        def correct(source_map)
+          rspec_walker.after_walk do
+            source_map.pins.each_with_index do |pin, index|
+              next unless pin.is_a?(Solargraph::Pin::Method)
+
+              namespace_pin = closest_namespace_pin(namespace_pins, pin.location.range.start.line)
+              next unless namespace_pin
+
+              source_map.pins[index] = Solargraph::Pin::Method.new(
+                visibility: pin.visibility,
+                parameters: pin.parameters,
+                closure: namespace_pin,
+                node: pin.node,
+                signatures: pin.signatures,
+                location: pin.location,
+                name: pin.name,
+                scope: pin.scope,
+                comments: pin.comments
+              )
+            end
+
+            yield [] if block_given?
+          end
+        end
+      end
+    end
+  end
+end