solargraph 0.58.3 → 0.60.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e2913913dac1fa336d5f2a7ac51a5cc7d7afb085fc14e0aea405ec4fc6f482c
-  data.tar.gz: 180f4779d6e070e919c8d4d1af3d4c72edb79370cbb9592671213db049254d2b
+  metadata.gz: 7c7397d5a9bbee07b12baa9372ce14f61216e5a310aa0f68605acabf8a9430e2
+  data.tar.gz: aeecf5c5d1ea7b1040fd3ae4bd9d1bff1685e468bd92b30dedfdd8ded2f1cd04
 SHA512:
-  metadata.gz: d30d4d79505a7bd37d906bd8eaf5351426e21a87ae23e922677a149dd946536c05a02debf70e1198d2f8b75dbf0a4941f9a2df34aa9ce2938b35da6458477fa5
-  data.tar.gz: 18a7d22d68a432c3b4e7c75385852a3f6f875a77269cabdfef4e91d229c93275236f04df50d5ff527cee7ba3a3100f41151e6f50f3d5947df0cbba83a304252e
+  metadata.gz: f4abae37c4fc8b57efe4a7b3550a2edbfc64455e8852f81660220f4a67facf101eafd058805b58cf0be6f9d5b9d16317cd21f6cd3b47f0c666c48418ee0d54c2
+  data.tar.gz: e14586769600dd63e2a96b8bcb4a5e4aa9bb045948e87e8c06b6606e711fed6816347051505eb756df55fed375a0419431dd02a44c2082d6d1ec0e2b13c6564f

data/.envrc

@@ -0,0 +1,3 @@
+# current git branch
+SOLARGRAPH_FORCE_VERSION=0.0.1.dev-$(git rev-parse --abbrev-ref HEAD | tr -d '\n' | tr -d '/' | tr -d '-'| tr -d '_')
+export SOLARGRAPH_FORCE_VERSION

data/.github/workflows/linting.yml

@@ -8,10 +8,10 @@ name: Linting
 on:
   workflow_dispatch: {}
   pull_request:
-    branches: [ master ]
+    branches: ['*']
   push:
     branches:
-      - 'main'
+      - 'master'
     tags:
       - 'v*'
 
@@ -31,13 +31,14 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.4
-          bundler: latest
           bundler-cache: true
-          cache-version: 2025-06-06
+          cache-version: 2026-01-11
 
       - name: Update to best available RBS
         run: |
-          bundle update rbs # use latest available for this Ruby version
+          # Add optional gem to be able to typecheck related code
+          echo "gem 'vernier', '>1.0', '<2'" >> .Gemfile
+          bundle install
 
       - name: Restore cache of gem annotations
         id: dot-cache-restore
@@ -58,6 +59,8 @@ jobs:
         run: |
           bundle exec overcommit --sign
           SOLARGRAPH_ASSERTS=on bundle exec overcommit --run --diff origin/master
+        # @todo Temporary, expect to revert in 0.60
+        continue-on-error: true
   rubocop:
     name: rubocop
     runs-on: ubuntu-latest
@@ -94,6 +97,8 @@ jobs:
 
     - name: Run rbs validate
       run: bundle exec rbs validate
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
   rubocop_todo:
     name: .rubocop_todo.yml
     runs-on: ubuntu-latest
@@ -111,6 +116,8 @@ jobs:
 
     - name: Run RuboCop
       run: bundle exec rubocop -c .rubocop.yml
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
 
     - name: Run RuboCop against todo file
       continue-on-error: true

data/.github/workflows/plugins.yml

@@ -9,7 +9,7 @@ on:
   push:
     branches: [master]
   pull_request:
-    branches: [master]
+    branches: ['*']
 
 permissions:
   contents: read
@@ -23,7 +23,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.4
+        ruby-version: 4.0 # keep same as typecheck.yml
         bundler-cache: true
     - uses: awalsh128/cache-apt-pkgs-action@latest
       with:
@@ -33,8 +33,9 @@ jobs:
       run: |
         echo 'gem "solargraph-rails"' > .Gemfile
         echo 'gem "solargraph-rspec"' >> .Gemfile
+        # Add optional gem to be able to typecheck related code
+        echo "gem 'vernier', '>1.0', '<2'" >> .Gemfile
         bundle install
-        bundle update rbs
     - name: Configure to use plugins
       run: |
         bundle exec solargraph config
@@ -43,7 +44,9 @@ jobs:
     - name: Install gem types
       run: bundle exec rbs collection update
     - name: Ensure typechecking still works
-      run: bundle exec solargraph typecheck --level typed
+      run: bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
     - name: Ensure specs still run
       run: bundle exec rake spec
   rails:
@@ -54,7 +57,9 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.4
+        ruby-version: 3.4 # keep same as typecheck.yml
+        # See https://github.com/castwide/solargraph/actions/runs/19000135777/job/54265647107?pr=1119
+        rubygems: latest
         bundler-cache: false
     - uses: awalsh128/cache-apt-pkgs-action@latest
       with:
@@ -63,8 +68,10 @@ jobs:
     - name: Install gems
       run: |
         echo 'gem "solargraph-rails"' > .Gemfile
+        # Add optional gem to be able to typecheck related code
+        echo "gem 'vernier', '>1.0', '<2'" >> .Gemfile
         bundle install
-        bundle update rbs
+        bundle update --pre rbs
     - name: Configure to use plugins
       run: |
         bundle exec solargraph config
@@ -72,7 +79,9 @@ jobs:
     - name: Install gem types
       run: bundle exec rbs collection update
     - name: Ensure typechecking still works
-      run: bundle exec solargraph typecheck --level typed
+      run: bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
     - name: Ensure specs still run
       run: bundle exec rake spec
   rspec:
@@ -83,7 +92,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.4
+        ruby-version: 3.4 # keep same as typecheck.yml
         bundler-cache: false
     - uses: awalsh128/cache-apt-pkgs-action@latest
       with:
@@ -92,8 +101,10 @@ jobs:
     - name: Install gems
       run: |
         echo 'gem "solargraph-rspec"' >> .Gemfile
+        # Add optional gem to be able to typecheck related code
+        echo "gem 'vernier', '>1.0', '<2'" >> .Gemfile
         bundle install
-        bundle update rbs
+        bundle update --pre rbs
     - name: Configure to use plugins
       run: |
         bundle exec solargraph config
@@ -101,7 +112,9 @@ jobs:
     - name: Install gem types
       run: bundle exec rbs collection update
     - name: Ensure typechecking still works
-      run: bundle exec solargraph typecheck --level typed
+      run: bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
     - name: Ensure specs still run
       run: bundle exec rake spec
 
@@ -116,47 +129,46 @@ jobs:
     - name: clone https://github.com/lekemula/solargraph-rspec/
       run: |
        cd ..
-       # git clone https://github.com/lekemula/solargraph-rspec.git
-
-       # pending https://github.com/lekemula/solargraph-rspec/pull/30
-       git clone https://github.com/apiology/solargraph-rspec.git
+       git clone https://github.com/lekemula/solargraph-rspec.git
        cd solargraph-rspec
-       git checkout reset_closures
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.2'
+        ruby-version: 3.4
         rubygems: latest
         bundler-cache: false
     - name: Install gems
       run: |
-       set -x
+        set -x
 
-       cd ../solargraph-rspec
-       echo "gem 'solargraph', path: '../solargraph'" >> Gemfile
-       bundle config path ${{ env.BUNDLE_PATH }}
-       bundle install --jobs 4 --retry 3
-       bundle exec appraisal install
-       # @todo some kind of appraisal/bundle conflict?
-       #   https://github.com/castwide/solargraph/actions/runs/19038710934/job/54369767122?pr=1116
-       #   /home/runner/work/solargraph/solargraph-rspec/vendor/bundle/ruby/3.1.0/gems/bundler-2.6.9/lib/bundler/runtime.rb:317:in
-       #   `check_for_activated_spec!': You have already activated date
-       #   3.5.0, but your Gemfile requires date 3.4.1. Prepending
-       #   `bundle exec` to your command may solve
-       #   this. (Gem::LoadError)
-       bundle exec appraisal update date
-       # For some reason on ruby 3.1 it defaults to an old version: 1.3.2
-       # https://github.com/lekemula/solargraph-rspec/actions/runs/17814581205/job/50645370316?pr=22
-       # We update manually to the latest
-       bundle exec appraisal update rspec-rails
+        cd ../solargraph-rspec
+        echo "gem 'solargraph', path: '../solargraph'" >> Gemfile
+        bundle config path ${{ env.BUNDLE_PATH }}
+        bundle install --jobs 4 --retry 3
+        bundle exec appraisal install
+        # @todo some kind of appraisal/bundle conflict?
+        #   https://github.com/castwide/solargraph/actions/runs/19038710934/job/54369767122?pr=1116
+        #   /home/runner/work/solargraph/solargraph-rspec/vendor/bundle/ruby/3.1.0/gems/bundler-2.6.9/lib/bundler/runtime.rb:317:in
+        #   `check_for_activated_spec!': You have already activated date
+        #   3.5.0, but your Gemfile requires date 3.4.1. Prepending
+        #   `bundle exec` to your command may solve
+        #   this. (Gem::LoadError)
+        bundle exec appraisal update date
+        # For some reason on ruby 3.1 it defaults to an old version: 1.3.2
+        # https://github.com/lekemula/solargraph-rspec/actions/runs/17814581205/job/50645370316?pr=22
+        # We update manually to the latest
+        bundle exec appraisal update rspec-rails
     - name: Configure .solargraph.yml
       run: |
         cd ../solargraph-rspec
         cp .solargraph.yml.example .solargraph.yml
-    - name: Solargraph generate RSpec gems YARD and RBS pins
+    - name: Solargraph generate RSpec gems YARD pins
       run: |
         cd ../solargraph-rspec
-        bundle exec appraisal rbs collection update
+        # solargraph-rspec's specs don't pass a workspace, so it
+        # doesn't know where to look for the RBS collection - let's
+        # not load one so that the solargraph gems command below works
+
         rspec_gems=$(bundle exec appraisal ruby -r './lib/solargraph-rspec' -e 'puts Solargraph::Rspec::Gems.gem_names.join(" ")' 2>/dev/null | tail -n1)
         bundle exec appraisal solargraph gems $rspec_gems
     - name: Run specs
@@ -181,6 +193,8 @@ jobs:
         # This job uses 3.2 due to a problem compiling sqlite3 in earlier versions
         ruby-version: '3.2'
         bundler-cache: false
+        # https://github.com/apiology/solargraph/actions/runs/19400815835/job/55508092473?pr=17
+        rubygems: latest
         bundler: latest
       env:
         MATRIX_RAILS_VERSION: "7.0"
@@ -192,7 +206,7 @@ jobs:
        cd ../solargraph-rails
        echo "gem 'solargraph', path: '${GITHUB_WORKSPACE:?}'" >> Gemfile
        bundle install
-       bundle update rbs
+       bundle update --pre rbs
        RAILS_DIR="$(pwd)/spec/rails7"
        export RAILS_DIR
        cd ${RAILS_DIR}
@@ -217,3 +231,5 @@ jobs:
         ALLOW_IMPROVEMENTS=true bundle exec rake spec
       env:
         MATRIX_RAILS_VERSION: "7.0"
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true

data/.github/workflows/rspec.yml

@@ -11,7 +11,7 @@ on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ master ]
+    branches: ['*']
 
 permissions:
   contents: read
@@ -21,31 +21,25 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4', '4.0']
-        rbs-version: ['3.6.1', '3.9.5', '4.0.0.dev.4']
-        # Ruby 3.0 doesn't work with RBS 3.9.4 or 4.0.0.dev.4
+        # @todo Restore 'head' once ruby/setup-ruby publishes it for ubuntu-24.04.
+        #   It currently 404s ("Unavailable version head for ruby"), failing CI:
+        #   https://github.com/castwide/solargraph/actions/runs/25863741955/job/76000137015?pr=1187
+        ruby-version: ['3.1', '3.2', '3.3', '3.4', '4.0']
+        rbs-version: ['3.10.0', '4.0.0', '4.0.1', '4.0.2']
         exclude:
-          - ruby-version: '3.0'
-            rbs-version: '3.9.5'
-          - ruby-version: '3.0'
-            rbs-version: '4.0.0.dev.4'
-          # Missing require in 'rbs collection update' - hopefully
-          # fixed in next RBS release
-          - ruby-version: '4.0'
-            rbs-version: '3.6.1'
-          - ruby-version: '4.0'
-            rbs-version: '4.0.0.dev.4'
+          - ruby-version: '3.1'
+            rbs-version: '4.0.0'
+          - ruby-version: '3.1'
+            rbs-version: '4.0.1'
+          - ruby-version: '3.1'
+            rbs-version: '4.0.2'
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        # see https://github.com/castwide/solargraph/actions/runs/19391419903/job/55485410493?pr=1119
-        #
-        # match version in Gemfile.lock and use same version below
-        bundler: 2.5.23
-        bundler-cache: false
+        bundler-cache: true
     - name: Set rbs version
       run: echo "gem 'rbs', '${{ matrix.rbs-version }}'" >> .Gemfile
     #  /home/runner/.rubies/ruby-head/lib/ruby/gems/3.5.0+2/gems/rbs-3.9.4/lib/rbs.rb:11:
@@ -54,15 +48,11 @@ jobs:
     #    starting from Ruby 3.6.0
     - name: Work around legacy rbs deprecation on ruby > 3.4
       run: echo "gem 'tsort'" >> .Gemfile
-    - name: Install gems
+    - name: Update gems
       run: |
-        bundle _2.5.23_ install
         bundle update rbs # use latest available for this Ruby version
-        bundle list
-        bundle exec solargraph pin 'Bundler::Dsl#source'
     - name: Update types
-      run: |
-        bundle exec rbs collection update
+      run: bundle exec rbs collection update
     - name: Run tests
       run: bundle exec rake spec
   undercover:
@@ -77,9 +67,9 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: '3.4'
-        bundler-cache: false
-    - name: Install gems
-      run: bundle install
+        bundler-cache: true
+    - name: Update types
+      run: bundle exec rbs collection update
     - name: Run tests
       run: bundle exec rake spec
     - name: Check PR coverage

data/.github/workflows/typecheck.yml

@@ -11,7 +11,7 @@ on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ master ]
+    branches: ['*']
 
 permissions:
   contents: read
@@ -27,13 +27,16 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.4
+        ruby-version: 4.0
         bundler-cache: false
     - name: Install gems
       run: |
+        # Add optional gem to be able to typecheck related code
+        echo "gem 'vernier', '>1.0', '<2'" >> .Gemfile
         bundle install
-        bundle update rbs # use latest available for this Ruby version
     - name: Install gem types
       run: bundle exec rbs collection install
     - name: Typecheck self
       run: SOLARGRAPH_ASSERTS=on bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true

data/.rubocop.yml

@@ -17,9 +17,29 @@ AllCops:
     - "spec/fixtures/invalid_byte.rb"
     - "spec/fixtures/invalid_node_comment.rb"
     - "spec/fixtures/invalid_utf8.rb"
+    - "spec/fixtures/gem-with-yard-macros/**/*"
     - "vendor/**/*"
     - "vendor/**/.*"
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
+
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'spec/fixtures/rdoc-lib/rdoc-lib.gemspec'
+    - 'spec/fixtures/rubocop-custom-version/specifications/rubocop-0.0.0.gemspec'
+    - 'spec/fixtures/vendored/vendor/do_not_use.gemspec'
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+  Exclude:
+    - 'spec/fixtures/**/*'
+
+Lint/EmptyFile:
+  Exclude:
+    - 'spec/fixtures/vendored/vendor/do_not_use.gemspec'
+
+Naming/VariableName:
+  Exclude:
+    - 'spec/fixtures/unicode.rb'
 
 # We don't use the spec/solargraph directory
 RSpec/SpecFilePathFormat:
@@ -31,6 +51,14 @@ Style/MethodDefParentheses:
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
+Naming/AsciiIdentifiers:
+  Exclude:
+    - 'spec/fixtures/unicode.rb'
+
+Lint/EmptyClass:
+  Exclude:
+    - spec/fixtures/**/*.rb
+
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 
@@ -42,23 +70,28 @@ Metrics/ParameterLists:
 Style/ClassVars:
   Enabled: false
 
+# Allow $stderr.puts for communication with users as 'warn' can be
+# suppressed for unrelated reasons.
+Style/StderrPuts:
+  Enabled: false
+
 #
 # Set a relaxed standard on harder-to-address item for ease of
 # contribution - if you are good at refactoring, we welcome PRs to
 # improve existing code!
 #
 Metrics/AbcSize:
-  Max: 65
+  Max: 110
 Metrics/MethodLength:
-  Max: 60
+  Max: 70
 Metrics/ClassLength:
   Max: 500
 Metrics/CyclomaticComplexity:
-  Max: 23
+  Max: 40
 Metrics/PerceivedComplexity:
-  Max: 29
+  Max: 40
 RSpec/ExampleLength:
-  Max: 17
+  Max: 310
 
 plugins:
   - rubocop-rspec