Handle the Ruby root in source locations listener #1065
Conversation
vinistock
force-pushed
the
vs/handle_ruby_root_in_source_locations
branch
from
9079209
to
a3d6814
Compare
| end | ||
|
|
||
| # Strip out the RUBY_ROOT prefix, which is different for each user | ||
| path = path.sub(%r{^.*(?=/lib/ruby/[0-9\.]+)}, "RUBY_ROOT") |
There was a problem hiding this comment.
Would it be possible to use something like ENV['GEM_HOME'] or ENV['GEM_PATH'] to strip out the Ruby root? I would feel more confident if we could identify the Ruby root, rather than assuming it's whatever comes before /lib/ruby/<version number>. (Nice regex though!)
There was a problem hiding this comment.
I thought about using RUBY_ROOT, but I don't know if we can assume that every user will have a version manager that sets these environment variables. If someone is using the system Ruby, those aren't set.
But the Ruby path will always have lib/ruby/<version> as far as I know.
There was a problem hiding this comment.
Ah bummer. Okay this makes sense to me then.
There was a problem hiding this comment.
I think Gem.paths can be used here? It should come with any Ruby version Tapioca supports (at least 2.6 already has it).
I tried it with the system Ruby on my machine:
$ ruby -v
ruby 2.6.8p205 (2021-07-07 revision 67951) [universal.arm64e-darwin21]
$ irb
irb(main):001:0> Gem
=> Gem
irb(main):002:0> Gem.path
=> ["/Users/hung-wulo/.gem/ruby/2.6.0", "/Library/Ruby/Gems/2.6.0", "/System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/lib/ruby/gems/2.6.0"]
irb(main):003:0> caller
=>
["/Library/Ruby/Gems/2.6.0/gems/irb-1.4.1/lib/irb/workspace.rb:119:in `eval'",
"/Library/Ruby/Gems/2.6.0/gems/irb-1.4.1/lib/irb/workspace.rb:119:in `evaluate'",
There was a problem hiding this comment.
We'd need to go through the array returned to find which one is the Ruby path and not the gems path and then use it for the replacement. What's the advantage over the regex?
There was a problem hiding this comment.
I think what we are looking for is RbConfig::CONFIG["rubylibdir"]. We can use it on both sides of this equation.
There was a problem hiding this comment.
Nice! That's exactly what we're looking for.
vinistock
force-pushed
the
vs/handle_ruby_root_in_source_locations
branch
from
a3d6814
to
da918af
Compare
Motivation
When methods for gem RBIs come from Ruby itself, we are currently adding the full location. This is not ideal, since each user could have Ruby installed in a different folder, which may also include platform specific labels.
We have to sanitize the
RUBY_ROOTfrom the locations printed in order to properly add it in the Ruby LSP and provide navigation to Ruby's original source.Additionally, we were also adding source locations for native extension files (like
.soand.bundle). I don't think there's value in adding those, since it is not possible to navigate to them.Implementation
To address point 1, I have added a new
subthat changes the Ruby root for the literalRUBY_ROOTstring, which we can easily replace in the Ruby LSP for the realENV["RUBY_ROOT"]to point to the right URI.To address point 2, I added an early return in case the symbol was defined in a file that isn't a Ruby file.
Tests
Added a test include
Mutex_mto show the Ruby root behaviour.