diff options
author | Stan Lo <stan.lo@shopify.com> | 2022-11-06 14:55:24 +0000 |
---|---|---|
committer | git <svn-admin@ruby-lang.org> | 2022-11-07 14:44:25 +0000 |
commit | ca0b59267352dd23bc53b5cb6f09aacd0025f536 (patch) | |
tree | a0f50a1ed47385fb5b79613a50b56f889d35ac5f /lib/irb | |
parent | 72c7dba436a5ebb53dfb37f3e400e84b0c2f9f45 (diff) |
[ruby/irb] Don't lazily retrieve gem specs for completion
There are a few downsides of the current approach:
1. Because gem specs are lazily retrieved, this computation happens in
every irb completion test case, which is not necessary. (In tests we
don't cache the result of `retrieve_files_to_require_from_load_path`)
2. Gem::Specification.latest_specs is sensible to the content of
LOAD_PATH. And when combined with 1, tests fail "randomly" if they
try to mutate LOAD_PATH, even though the test subject it's something
else.
So by pre-computing and storing the gem paths in a constant, it guarantees
that the computation only happens once and it doesn't get affected by test
cases.
One argument could be made against the change is that, it'll store
unnecessary data for users that disable autocompletion. But the
counter-arguments are:
1. Since autocompletion is enabled by default, this should not be the
case for most users.
2. For users with autocompletion enabled, IRB already caches the
result of `retrieve_files_to_require_from_load_path` in memory, which
should have a similar size of GEM_SPECS. And we currently haven't
received any report about problems caused by such memory consumption.
https://github.com/ruby/irb/commit/c671d39020
Diffstat (limited to 'lib/irb')
-rw-r--r-- | lib/irb/completion.rb | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/lib/irb/completion.rb b/lib/irb/completion.rb index dbd652769e..b41d5de35e 100644 --- a/lib/irb/completion.rb +++ b/lib/irb/completion.rb @@ -64,25 +64,27 @@ module IRB if File.respond_to?(:absolute_path?) File.absolute_path?(p) else - if File.absolute_path(p) == p - true - else - false - end + File.absolute_path(p) == p end end + GEM_PATHS = + if defined?(Gem::Specification) + Gem::Specification.latest_specs(true).map { |s| + s.require_paths.map { |p| + if absolute_path?(p) + p + else + File.join(s.full_gem_path, p) + end + } + }.flatten + else + [] + end.freeze + def self.retrieve_gem_and_system_load_path - gem_paths = Gem::Specification.latest_specs(true).map { |s| - s.require_paths.map { |p| - if absolute_path?(p) - p - else - File.join(s.full_gem_path, p) - end - } - }.flatten if defined?(Gem::Specification) - candidates = (gem_paths.to_a | $LOAD_PATH) + candidates = (GEM_PATHS | $LOAD_PATH) candidates.map do |p| if p.respond_to?(:to_path) p.to_path |