Skip to content

Fix document link gem paths when to_spec returns nil #4060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vinistock wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix document link gem paths when to_spec returns nil #4060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/ruby_lsp/listeners/document_link.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ def gem_paths

Gem::Specification.stubs.each do |stub|
spec = stub.to_spec
next unless spec

lookup[spec.name] = {}
lookup[spec.name][spec.version.to_s] = {}

Expand All @@ -31,6 +33,8 @@ def gem_paths

Gem::Specification.default_stubs.each do |stub|
spec = stub.to_spec
next unless spec

lookup[spec.name] = {}
lookup[spec.name][spec.version.to_s] = {}
prefix_matchers = Regexp.union(spec.require_paths.map do |rp|
Expand Down
13 changes: 13 additions & 0 deletions test/requests/document_link_expectations_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,19 @@ def foo(x)
refute_empty(links, "Expected document link for source comment above multi-line sig block")
end

def test_does_not_fail_if_to_spec_returns_nil
# Guarantee that the cache is reset
RubyLsp::Listeners::DocumentLink.instance_variable_set(:@gem_paths, nil)

Gem::Specification.any_instance.stubs(:to_spec).returns(nil)

result = RubyLsp::Listeners::DocumentLink.gem_paths
refute_nil(result)
ensure
# Reset the cache again since we stubbed `to_spec` to return nil
RubyLsp::Listeners::DocumentLink.instance_variable_set(:@gem_paths, nil)
end

def test_package_url_links_with_invalid_uris
source = <<~RUBY
# pkg:gem/rubocop$1.78.0#:99
Expand Down
Loading