[WIP] Factory bot

.github/workflows/ruby.yml

@@ -15,6 +15,10 @@ on:
 permissions:
   contents: read
 
+env:
+  SOLARGRAPH_CACHE: "${{ github.workspace }}/solargraph-rspec/gem-cache"
+  BUNDLE_GEMFILE: "${{ github.workspace }}/solargraph-rspec/gemfiles/default.gemfile"
+
 jobs:
   test:
     name: Tests (ruby v${{ matrix.ruby-version }})
@@ -25,7 +29,6 @@ jobs:
         # FIXME: Why '3.0' is not working with Appraisal?
         # FIXME: Add 'head' https://github.com/lekemula/solargraph-rspec/pull/8/commits/3b52752b96e7f2ec01831406f8e5a51c91523187 
         ruby-version: ['3.1', '3.2', '3.3']
-
     steps:
       - name: Checkout solargraph-rspec
         uses: actions/checkout@v4
@@ -42,32 +45,33 @@ jobs:
       - name: Cache Ruby gems
         uses: actions/cache@v3
         with:
-          path: solargraph-rspec/vendor/bundle
-          key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby-version }}-${{ hashFiles('solargraph-rspec/solargraph-rspec.gemspec') }}
-          restore-keys: |
-            bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby-version }}-${{ hashFiles('solargraph-rspec/solargraph-rspec.gemspec') }}
+          path: solargraph-rspec/gemfiles/vendor/bundle
+          key: bundle-use-ruby-${{ matrix.ruby-version }}-${{ hashFiles('solargraph-rspec/Gemfile', 'solargraph-rspec/gemfiles/default.gemfile.lock') }}
 
       - name: Install dependencies
         run: |
           cd solargraph-rspec
           bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3
-          bundle exec appraisal install
 
-      - name: Run Rubocop
-        run: cd solargraph-rspec && bundle exec rubocop
+      # - name: Run Rubocop
+      #   run: cd solargraph-rspec && bundle exec rubocop
 
-      - name: Set up yardocs
-        # yard gems caches the yardocs into <gem_path>/doc/.yardoc path, hence they should be cached by ruby gems cache 
-        run: cd solargraph-rspec && bundle exec appraisal yard gems --verbose
+      - name: 'Apply solargraph debug patch'
+        run: |-
+          echo 'exclude: ["vendor/**/*", "gemfiles/**/*"]' > solargraph-rspec/.solargraph.yml
+          cd solargraph-rspec/gemfiles/vendor/bundle/ruby/${{ matrix.ruby-version }}.0/gems/solargraph-0.56.0
 
-      - name: List all Yardoc constants and methods
-        run: |
-            cd solargraph-rspec
-            bundle exec yard list
+          awk '/Caching yardoc for/ { print "return nil unless Dir.exist?(gemspec.gem_dir)"; print; next }1' lib/solargraph/yardoc.rb > tmp.rb
+          mv tmp.rb lib/solargraph/yardoc.rb
+
+      - name: Cache Docs
+        run: |-
+          cd solargraph-rspec
+          bundle exec solargraph gems --rebuild
 
       - name: Run tests
-        run: cd solargraph-rspec && bundle exec appraisal rspec --format progress
+        run: cd solargraph-rspec && bundle exec rspec --format progress
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4

.gitignore

@@ -11,3 +11,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+.solargraph.yml
+vendor
+gemfiles/vendor

Gemfile

@@ -21,6 +21,7 @@ gem 'simplecov-cobertura' # Code coverage
 group :third_party_plugin_tests do
   gem 'actionmailer'
   gem 'airborne'
+  gem 'factory_bot', '~> 6.5'
   gem 'rspec-rails'
   gem 'rspec-sidekiq'
   gem 'shoulda-matchers'

gemfiles/.bundle/config

@@ -1,2 +1,3 @@
 ---
 BUNDLE_RETRY: "1"
+BUNDLE_PATH: "vendor/bundle"

gemfiles/default.gemfile

@@ -16,6 +16,7 @@ gem "simplecov-cobertura"
 group :third_party_plugin_tests do
   gem "actionmailer"
   gem "airborne"
+  gem "factory_bot", "~> 6.5"
   gem "rspec-rails"
   gem "rspec-sidekiq"
   gem "shoulda-matchers"

gemfiles/default.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    solargraph-rspec (0.4.1)
-      solargraph (~> 0.52, >= 0.52.0)
+    solargraph-rspec (0.5.2)
+      solargraph (~> 0.56, >= 0.56.0)
 
 GEM
   remote: https://rubygems.org/
@@ -79,11 +79,13 @@ GEM
     debug (1.10.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    diff-lcs (1.6.0)
+    diff-lcs (1.6.2)
     docile (1.4.1)
     domain_name (0.6.20240107)
     drb (2.2.1)
     erubi (1.13.1)
+    factory_bot (6.5.4)
+      activesupport (>= 6.1.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
     hashdiff (1.1.2)
@@ -97,13 +99,13 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    jaro_winkler (1.6.0)
-    json (2.10.2)
+    jaro_winkler (1.6.1)
+    json (2.12.2)
     kramdown (2.5.1)
       rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    language_server-protocol (3.17.0.4)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.6.6)
     loofah (2.24.0)
@@ -134,16 +136,19 @@ GEM
     netrc (0.11.0)
     nokogiri (1.17.2-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.17.2-x86_64-linux)
+      racc (~> 1.4)
     observer (0.1.2)
     optparse (0.6.0)
-    ostruct (0.6.1)
-    parallel (1.26.3)
-    parser (3.3.7.2)
+    ostruct (0.6.2)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
+    prism (1.4.0)
     profile-viewer (0.0.4)
       optparse
       webrick
@@ -183,7 +188,7 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
-    rbs (3.6.1)
+    rbs (3.9.4)
       logger
     rdoc (6.12.0)
       psych (>= 4.0.0)
@@ -200,16 +205,16 @@ GEM
     reverse_markdown (3.0.0)
       nokogiri
     rexml (3.4.1)
-    rspec (3.13.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-rails (7.1.1)
@@ -225,20 +230,21 @@ GEM
       rspec-expectations (~> 3.0)
       rspec-mocks (~> 3.0)
       sidekiq (>= 5, < 9)
-    rspec-support (3.13.2)
-    rubocop (1.74.0)
+    rspec-support (3.13.4)
+    rubocop (1.78.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.41.0)
+    rubocop-ast (1.45.1)
       parser (>= 3.3.7.2)
+      prism (~> 1.4)
     ruby-progressbar (1.13.0)
     securerandom (0.3.2)
     shoulda-matchers (6.4.0)
@@ -258,28 +264,29 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.52.0)
+    solargraph (0.56.0)
       backport (~> 1.2)
-      benchmark
+      benchmark (~> 0.4)
       bundler (~> 2.0)
       diff-lcs (~> 1.4)
-      jaro_winkler (~> 1.6)
+      jaro_winkler (~> 1.6, >= 1.6.1)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
       logger (~> 1.6)
       observer (~> 0.1)
       ostruct (~> 0.6)
       parser (~> 3.0)
-      rbs (~> 3.0)
-      reverse_markdown (>= 2.0, < 4)
+      prism (~> 1.4)
+      rbs (~> 3.3)
+      reverse_markdown (~> 3.0)
       rubocop (~> 1.38)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
       yard-solargraph (~> 0.1)
     stringio (3.1.5)
     thor (1.3.2)
-    tilt (2.6.0)
+    tilt (2.6.1)
     timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -298,13 +305,15 @@ GEM
 
 PLATFORMS
   arm64-darwin-24
+  x86_64-linux
 
 DEPENDENCIES
   actionmailer
   airborne
   appraisal
   bundler
   debug
+  factory_bot (~> 6.5)
   profile-viewer
   pry-byebug
   rake

lib/solargraph/rspec/convention.rb

@@ -10,6 +10,8 @@
 require_relative 'correctors/subject_method_corrector'
 require_relative 'correctors/context_block_methods_corrector'
 require_relative 'correctors/dsl_methods_corrector'
+require_relative 'factory_bot'
+require_relative 'spec_helper_include'
 require_relative 'test_helpers'
 require_relative 'pin_factory'
 
@@ -120,6 +122,8 @@ def local(source_map)
         pins = []
         # @type [Array<Pin::Namespace>]
         namespace_pins = []
+        # @type [Array<String>]
+        extra_requires = ['rspec']
 
         rspec_walker = SpecWalker.new(source_map: source_map, config: config)
 
@@ -133,14 +137,31 @@ def local(source_map)
 
         rspec_walker.walk!
         pins += namespace_pins
+        pins += begin
+          FactoryBot.instance.pins
+        rescue StandardError => e
+          Solargraph.logger.error("[solargraph-rspec] [factory bot] Can't add pins: #{e}")
+          []
+        end
+        begin
+          pins += SpecHelperInclude.instance.pins
+          extra_requires += SpecHelperInclude.instance.extra_requires
+        rescue StandardError => e
+          Solargraph.logger.error("[solargraph-rspec] [spec helper] Can't add pins: #{e}")
+        end
 
         if pins.any?
           Solargraph.logger.debug(
             "[RSpec] added #{pins.map(&:inspect)} to #{source_map.filename}"
           )
         end
+        if extra_requires.any?
+          Solargraph.logger.debug(
+            "[RSpec] added requires #{extra_requires} to #{source_map.filename}"
+          )
+        end
 
-        Environ.new(requires: [], pins: pins)
+        Environ.new(requires: extra_requires, pins: pins)
       rescue StandardError, SyntaxError => e
         raise e if ENV['SOLARGRAPH_DEBUG']