Skip to content

Sync URI::Source with RubyLSP #2475

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
amomchilov wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Sync URI::Source with RubyLSP #2475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3740c5
Fix shim for `URI::Source#fragment`
amomchilov Jan 5, 2026
9863778
Add missing `/` in `URI::Source#to_s`
amomchilov Jan 6, 2026
cd56d1f
Sync `URI::Source` with RubyLSP
amomchilov Jan 5, 2026
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
2 changes: 1 addition & 1 deletion lib/tapioca/gem/listeners/source_location.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def add_source_location_comment(node, file, line)
# we can clear the gem version if the gem is the same one we are processing
version = "" if gem == @pipeline.gem

uri = SourceURI.build(
uri = URI::Source.build(
gem_name: gem.name,
gem_version: version,
path: path.to_s,
Expand Down
41 changes: 23 additions & 18 deletions lib/tapioca/helpers/source_uri.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# typed: true
# typed: strict
# frozen_string_literal: true

require "uri/file"

module Tapioca
class SourceURI < URI::File
extend T::Sig
# Don't redefine this class if RubyLSP already defined it.
# This also prevents us from registering two different classes for the `SOURCE` scheme.
return if defined?(URI::Source)

module URI
# Must be kept in sync with the one in Ruby LSP
# https://github.com/Shopify/ruby-lsp/blob/main/lib/ruby_lsp/requests/support/source_uri.rb
class Source < ::URI::File
COMPONENT = [
:scheme,
:gem_name,
Expand All @@ -22,12 +26,17 @@ class SourceURI < URI::File
# have the uri gem in their own bundle and thus not use a compatible version.
PARSER = const_defined?(:RFC2396_PARSER) ? RFC2396_PARSER : DEFAULT_PARSER #: RFC2396_Parser

# We need to hide these aliased methods from Sorbet, because it would otherwise complain about these
# being redefinitions of the existing methods it knows about from RubyLSP.
self #: as untyped # rubocop:disable Style/RedundantSelf
Copy link
Contributor

@Morriar Morriar Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need this since host and fragment are defined in the RBI?

Copy link
Contributor Author

@amomchilov amomchilov Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but for a different reason now. See the comment on lines 29-30

I renamed this class from Tapioca::SourceURI to URI::Source (same as what RubyLSP would define), so these are redefinitions of those methods now

Copy link
Contributor

@Morriar Morriar Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this this error? 🤔 https://sorbet.run/#%23%20typed%3A%20true%0A%0Amodule%20URI%0A%20%20class%20Source%20%3C%20%3A%3AURI%3A%3AFile%0A%20%20%20%20def%20bar%3B%20end%0A%20%20%20%20%0A%20%20%20%20def%20foo%3B%20end%0A%20%20end%0Aend%0A%0Amodule%20URI%0A%20%20class%20Source%20%3C%20%3A%3AURI%3A%3AFile%0A%20%20%20%20alias_method%28%3Afoo%2C%20%3Abar%29%0A%20%20end%0Aend

Copy link
Contributor Author

@amomchilov amomchilov Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep

.alias_method(:gem_name, :host)
self #: as untyped # rubocop:disable Style/RedundantSelf
.alias_method(:line_number, :fragment)

#: String?
attr_reader :gem_version

class << self
extend T::Sig

#: (gem_name: String, gem_version: String?, path: String, line_number: String?) -> instance
def build(gem_name:, gem_version:, path:, line_number:)
super(
Expand All @@ -41,21 +50,14 @@ def build(gem_name:, gem_version:, path:, line_number:)
end
end

#: -> String?
def gem_name
host
end

#: -> String?
def line_number
fragment
end

#: (String? v) -> void
def set_path(v) # rubocop:disable Naming/AccessorMethodName
return if v.nil?

@gem_version, @path = v.split("/", 2)
gem_version, path = v.delete_prefix("/").split("/", 2)

@gem_version = gem_version #: String?
@path = path #: String?
end

#: (String? v) -> bool
Expand All @@ -72,12 +74,15 @@ def check_host(v)

#: -> String
def to_s
"source://#{gem_name}/#{gem_version}#{path}##{line_number}"
"source://#{gem_name}/#{gem_version}/#{path}##{line_number}"
end

if URI.respond_to?(:register_scheme)
# Handle URI 0.11.0 and newer https://github.com/ruby/uri/pull/26
URI.register_scheme("SOURCE", self)
else
# Fallback for URI <0.11.0
@@schemes = @@schemes #: Hash[String, untyped] # rubocop:disable Style/ClassVars
@@schemes["SOURCE"] = self
end
end
Expand Down
2 changes: 1 addition & 1 deletion sorbet/rbi/shims/uri.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ module URI
sig { returns(String) }
attr_reader :host

sig { returns(String) }
sig { returns(T.nilable(String)) }
attr_reader :fragment
end

Expand Down
Loading