solargraph 0.56.2 → 0.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82754cd0869fed91a86a2bfb08ca0f54d6468f942620cddd3148bad99724ad88
-  data.tar.gz: 4e017a78936b0d24eaa6d5db7edcd01ea2b43d6cb365eb5b4892576a141ca2b7
+  metadata.gz: e56c80fcd3d09dfa44076f993bc9b9109499f5aca4453b2bec161257161791d6
+  data.tar.gz: e1063c87d37ac58f04cf790e40e6e01b5044d74ab2fa102b1a80a133ad47111b
 SHA512:
-  metadata.gz: 304fb86181925f916d7119da44b85a3753fc33d961da8a61c5525dbcb8d814a87baeeb9767d17b7ec6548c3ffe725bfda6eafbfd7ea75e8bdddf3f1a1a5c103b
-  data.tar.gz: 73d437e753be70628008f09a7846cba5e16fd47d045017b41c0b301d8a5b34ca04a45127a37c6eada4e61287944ca1af659ecab8df4681bab42a8ecc37d73bc4
+  metadata.gz: c4bf24a5265c55ce29e24ae70fd5504250aec4f684b7f2aa220ed96292feda346ad0d0ad9116399a59a57ae69e6846b8cca6b5ee7946690fa49a34b90777b913
+  data.tar.gz: d4c04335686f8d5af07fa7b0a581e96c197ad605bdd4b5a5eeb5fd41fe4ddca8c14a89b19c4b0acf5257909d2e45864929aacaf98d19c6459109f815a383c5b1

data/.github/workflows/linting.yml

@@ -0,0 +1,127 @@
+---
+# To debug locally:
+#   npm install -g act
+#   act pull_release -j overcommit
+
+name: Linting
+
+on:
+  workflow_dispatch: {}
+  pull_request:
+    branches: [ master ]
+  push:
+    branches:
+      - 'main'
+    tags:
+      - 'v*'
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  overcommit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        # Number of commits to fetch. 0 indicates all history for all branches and tags.
+        with:
+          fetch-depth: 0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler: latest
+          bundler-cache: true
+          cache-version: 2025-06-06
+
+      - name: Update to best available RBS
+        run: |
+          bundle update rbs # use latest available for this Ruby version
+
+      - name: Restore cache of gem annotations
+        id: dot-cache-restore
+        uses: actions/cache/restore@v4
+        with:
+          key: |
+            2025-06-26-09-${{ runner.os }}-dot-cache-${{ hashFiles('Gemfile.lock') }}
+          restore-keys: |
+            2025-06-26-09-${{ runner.os }}-dot-cache
+            2025-06-26-09-${{ runner.os }}-dot-cache-
+          path: |
+            /home/runner/.cache/solargraph
+
+      - name: Install gem types
+        run: bundle exec rbs collection install
+
+      - name: Overcommit
+        run: |
+          bundle exec overcommit --sign
+          SOLARGRAPH_ASSERTS=on bundle exec overcommit --run --diff origin/master
+  rubocop:
+    name: rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: ruby/setup-ruby@1a615958ad9d422dd932dc1d5823942ee002799f # v1.227.0
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - uses: reviewdog/action-rubocop@fcb74ba274da10b18d038d0bcddaae3518739634 # v2.21.2
+        with:
+          reporter: github-pr-check
+          skip_install: true
+          use_bundler: true
+          rubocop_extensions: 'rubocop-rspec:gemfile rubocop-rake:gemfile rubocop-yard:gemfile'
+          rubocop_flags: '-c .rubocop.yml'
+          fail_level: info
+          rubocop_version: Gemfile
+          level: info
+  rbs_validate:
+    name: rbs validate
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: false
+
+    - name: Install gems
+      run: bundle install
+
+    - name: Run rbs validate
+      run: bundle exec rbs validate
+  rubocop_todo:
+    name: .rubocop_todo.yml
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: false
+
+    - name: Install gems
+      run: bundle install
+
+    - name: Run RuboCop
+      run: bundle exec rubocop -c .rubocop.yml
+
+    - name: Run RuboCop against todo file
+      continue-on-error: true
+      run: |
+        cmd="bundle exec rubocop --auto-gen-config --exclude-limit=5 --no-offense-counts --no-auto-gen-timestamp"
+        ${cmd:?}
+        set +e
+        if [ -n "$(git status --porcelain)" ]
+        then
+          git status --porcelain
+          git diff -u .
+           >&2 echo "Please address any new issues, then run '${cmd:?}' and push up any improvements"
+           exit 1
+        fi

data/.github/workflows/plugins.yml

@@ -1,16 +1,21 @@
-name: Plugin Backwards Compatibility Tests
+---
+name: Plugin
+
+# To debug locally:
+#   npm install -g act
+#   cd /Users/broz/src/solargraph/ && act pull_request -j run_solargraph_rails_specs # e.g.
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 permissions:
   contents: read
 
 jobs:
-  test:
+  regression:
     runs-on: ubuntu-latest
 
     steps:
@@ -18,8 +23,8 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.0'
-        bundler-cache: false
+        ruby-version: 3.4
+        bundler-cache: true
     - uses: awalsh128/cache-apt-pkgs-action@latest
       with:
         packages: yq
@@ -29,14 +34,185 @@ jobs:
         echo 'gem "solargraph-rails"' > .Gemfile
         echo 'gem "solargraph-rspec"' >> .Gemfile
         bundle install
+        bundle update rbs
     - name: Configure to use plugins
       run: |
         bundle exec solargraph config
         yq -yi '.plugins += ["solargraph-rails"]' .solargraph.yml
         yq -yi '.plugins += ["solargraph-rspec"]' .solargraph.yml
     - name: Install gem types
-      run: bundle exec rbs collection install
+      run: bundle exec rbs collection update
+    - name: Ensure typechecking still works
+      run: bundle exec solargraph typecheck --level typed
+    - name: Ensure specs still run
+      run: bundle exec rake spec
+  rails:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: false
+    - uses: awalsh128/cache-apt-pkgs-action@latest
+      with:
+        packages: yq
+        version: 1.0
+    - name: Install gems
+      run: |
+        echo 'gem "solargraph-rails"' > .Gemfile
+        bundle install
+        bundle update rbs
+    - name: Configure to use plugins
+      run: |
+        bundle exec solargraph config
+        yq -yi '.plugins += ["solargraph-rails"]' .solargraph.yml
+    - name: Install gem types
+      run: bundle exec rbs collection update
+    - name: Ensure typechecking still works
+      run: bundle exec solargraph typecheck --level typed
+    - name: Ensure specs still run
+      run: bundle exec rake spec
+  rspec:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: false
+    - uses: awalsh128/cache-apt-pkgs-action@latest
+      with:
+        packages: yq
+        version: 1.0
+    - name: Install gems
+      run: |
+        echo 'gem "solargraph-rspec"' >> .Gemfile
+        bundle install
+        bundle update rbs
+    - name: Configure to use plugins
+      run: |
+        bundle exec solargraph config
+        yq -yi '.plugins += ["solargraph-rspec"]' .solargraph.yml
+    - name: Install gem types
+      run: bundle exec rbs collection update
     - name: Ensure typechecking still works
       run: bundle exec solargraph typecheck --level typed
     - name: Ensure specs still run
       run: bundle exec rake spec
+
+  run_solargraph_rspec_specs:
+    # check out solargraph-rspec as well as this project, and point the former to use the latter as a local gem
+    runs-on: ubuntu-latest
+    env:
+      SOLARGRAPH_CACHE: ${{ github.workspace }}/../solargraph-rspec/vendor/solargraph/cache
+      BUNDLE_PATH: ${{ github.workspace }}/../solargraph-rspec/vendor/bundle
+    steps:
+    - uses: actions/checkout@v3
+    - 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
+       cd solargraph-rspec
+       git checkout reset_closures
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        rubygems: latest
+        bundler-cache: false
+    - name: Install gems
+      run: |
+       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
+    - name: Configure .solargraph.yml
+      run: |
+        cd ../solargraph-rspec
+        cp .solargraph.yml.example .solargraph.yml
+    - name: Solargraph generate RSpec gems YARD and RBS pins
+      run: |
+        cd ../solargraph-rspec
+        bundle exec appraisal rbs collection update
+        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
+      run: |
+        cd ../solargraph-rspec
+        bundle exec appraisal rspec --format progress
+
+  run_solargraph_rails_specs:
+    # check out solargraph-rails as well as this project, and point the former to use the latter as a local gem
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: clone solargraph-rails
+      run: |
+       cd ..
+       git clone https://github.com/iftheshoefritz/solargraph-rails.git
+       cd solargraph-rails
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        # solargraph-rails supports Ruby 3.0+
+        ruby-version: '3.0'
+        bundler-cache: false
+        bundler: latest
+      env:
+        MATRIX_RAILS_VERSION: "7.0"
+    - name: Install gems
+      run: |
+       set -x
+       BUNDLE_PATH="${GITHUB_WORKSPACE:?}/vendor/bundle"
+       export BUNDLE_PATH
+       cd ../solargraph-rails
+       echo "gem 'solargraph', path: '${GITHUB_WORKSPACE:?}'" >> Gemfile
+       bundle install
+       bundle update rbs
+       RAILS_DIR="$(pwd)/spec/rails7"
+       export RAILS_DIR
+       cd ${RAILS_DIR}
+       bundle install
+       bundle exec --gemfile ../../Gemfile rbs --version
+       bundle exec --gemfile ../../Gemfile rbs collection install
+       cd ../../
+       # bundle exec rbs collection init
+       # bundle exec rbs collection install
+      env:
+        MATRIX_RAILS_VERSION: "7.0"
+        MATRIX_RAILS_MAJOR_VERSION: '7'
+    - name: Run specs
+      run: |
+        BUNDLE_PATH="${GITHUB_WORKSPACE:?}/vendor/bundle"
+        export BUNDLE_PATH
+        cd ../solargraph-rails
+        bundle exec solargraph --version
+        bundle info solargraph
+        bundle info rbs
+        bundle info yard
+        ALLOW_IMPROVEMENTS=true bundle exec rake spec
+      env:
+        MATRIX_RAILS_VERSION: "7.0"

data/.github/workflows/rspec.yml

@@ -17,21 +17,71 @@ permissions:
   contents: read
 
 jobs:
-  test:
-
+  rspec:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4', 'head']
-
+        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
+        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'
     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
+    - 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:
+    #    warning: tsort was loaded from the standard library,
+    #    but will no longer be part of the default gems
+    #    starting from Ruby 3.6.0
+    - name: Work around legacy rbs deprecation on ruby > 3.4
+      run: echo "gem 'tsort'" >> .Gemfile
+    - name: Install 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
+    - name: Run tests
+      run: bundle exec rake spec
+  undercover:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        # fetch all history for all branches and tags so we can
+        # compare against origin/master
+        fetch-depth: 0
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.4'
         bundler-cache: false
     - name: Install gems
       run: bundle install
     - name: Run tests
-      run: bundle exec rspec
+      run: bundle exec rake spec
+    - name: Check PR coverage
+      run: bundle exec rake undercover
+      continue-on-error: true

data/.github/workflows/typecheck.yml

@@ -17,7 +17,8 @@ permissions:
   contents: read
 
 jobs:
-  test:
+  solargraph_typed:
+    name: Solargraph / strong
 
     runs-on: ubuntu-latest
 
@@ -29,8 +30,10 @@ jobs:
         ruby-version: 3.4
         bundler-cache: false
     - name: Install gems
-      run: bundle install
+      run: |
+        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 typed
+      run: SOLARGRAPH_ASSERTS=on bundle exec solargraph typecheck --level strong

data/.gitignore

@@ -9,3 +9,8 @@
 doc
 coverage
 /tmp/
+/rspec-examples.txt
+/.ruby-version
+/Makefile
+/.pryrc
+/.rspec-local

data/.overcommit.yml

@@ -0,0 +1,72 @@
+---
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+
+  Solargraph:
+    enabled: true
+    exclude:
+      - 'spec/**/*'
+
+  FixMe:
+    enabled: true
+    exclude:
+      # don't freak out over line below
+      - '.overcommit.yml'
+      # from upstream
+      - 'rbs/fills/rubygems/0/basic_specification.rbs'
+    keywords: ['FIXME', 'TODO', 'XXX']
+
+  # creates false positives in CI
+  AuthorName:
+    enabled: false
+
+  # creates false positives in CI
+  AuthorEmail:
+    enabled: false
+
+  ALL:
+    # if you change the next line to 'report', and you make changes to
+    # a file, overcommit will have you make the entire file pass
+    #
+    problem_on_unmodified_line: warn
+    # on_warn: fail
+    exclude:
+      - lib/solargraph/rails/annotations/**/*
+      - vendor/**/*
+      - ".bundle/**/*"
+      - 'core.*'
+
+verify_signatures: false
+
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes
+
+gemfile: Gemfile

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--profile

data/.rubocop.yml

@@ -0,0 +1,66 @@
+---
+inherit_from: .rubocop_todo.yml
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "spec/fixtures/invalid_byte.rb"
+    - "spec/fixtures/invalid_node_comment.rb"
+    - "spec/fixtures/invalid_utf8.rb"
+    - "vendor/**/*"
+    - "vendor/**/.*"
+  TargetRubyVersion: 3.0
+
+# We don't use the spec/solargraph directory
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Metrics/ParameterLists:
+  Max: 7
+  CountKeywordArgs: false
+
+# we tend to use @@ and the risk doesn't seem high
+Style/ClassVars:
+  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
+Metrics/MethodLength:
+  Max: 60
+Metrics/ClassLength:
+  Max: 500
+Metrics/CyclomaticComplexity:
+  Max: 23
+Metrics/PerceivedComplexity:
+  Max: 29
+RSpec/ExampleLength:
+  Max: 17
+
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+  - rubocop-yard