class Bootsnap::LoadPathCache::Path

Constants

RUBY_LIBDIR

Built-in ruby lib stuff doesn’t change, but things can occasionally be installed into sitedir, which generally lives under libdir.

RUBY_SITEDIR
STABLE

a Path can be either stable of volatile, depending on how frequently we expect its contents may change. Stable paths aren’t rescanned nearly as often.

VOLATILE

Attributes

path[R]

Public Class Methods

new(path) click to toggle source
# File lib/bootsnap/load_path_cache/path.rb, line 23
def initialize(path)
  @path = path.to_s.freeze
end

Public Instance Methods

entries_and_dirs(store) click to toggle source

Return a list of all the requirable files and all of the subdirectories of this Path.

# File lib/bootsnap/load_path_cache/path.rb, line 40
def entries_and_dirs(store)
  if stable?
    # the cached_mtime field is unused for 'stable' paths, but is
    # set to zero anyway, just in case we change the stability heuristics.
    _, entries, dirs = store.get(expanded_path)
    return [entries, dirs] if entries # cache hit
    entries, dirs = scan!
    store.set(expanded_path, [0, entries, dirs])
    return [entries, dirs]
  end

  cached_mtime, entries, dirs = store.get(expanded_path)

  current_mtime = latest_mtime(expanded_path, dirs || [])
  return [[], []]        if current_mtime == -1 # path does not exist
  return [entries, dirs] if cached_mtime == current_mtime

  entries, dirs = scan!
  store.set(expanded_path, [current_mtime, entries, dirs])
  [entries, dirs]
end
expanded_path() click to toggle source
# File lib/bootsnap/load_path_cache/path.rb, line 62
def expanded_path
  File.expand_path(path).freeze
end
non_directory?() click to toggle source

True if the path exists, but represents a non-directory object

# File lib/bootsnap/load_path_cache/path.rb, line 28
def non_directory?
  !File.stat(path).directory?
rescue Errno::ENOENT, Errno::ENOTDIR
  false
end
relative?() click to toggle source
# File lib/bootsnap/load_path_cache/path.rb, line 34
def relative?
  !path.start_with?(SLASH)
end
stable?() click to toggle source

A path is considered ‘stable’ if it is part of a Gem.path or the ruby distribution. When adding or removing files in these paths, the cache must be cleared before the change will be noticed.

# File lib/bootsnap/load_path_cache/path.rb, line 10
def stable?
  stability == STABLE
end
volatile?() click to toggle source

A path is considered volatile if it doesn’t live under a Gem.path or the ruby distribution root. These paths are scanned for new additions more frequently.

# File lib/bootsnap/load_path_cache/path.rb, line 17
def volatile?
  stability == VOLATILE
end

Private Instance Methods

latest_mtime(path, dirs) click to toggle source

last time a directory was modified in this subtree. dirs should be a list of relative paths to directories under path. e.g. for /a/b and /a/b/c, pass (‘/a/b’, [‘c’])

# File lib/bootsnap/load_path_cache/path.rb, line 75
def latest_mtime(path, dirs)
  max = -1
  ["", *dirs].each do |dir|
    curr = begin
      File.mtime("#{path}/#{dir}").to_i
           rescue Errno::ENOENT, Errno::ENOTDIR
             -1
    end
    max = curr if curr > max
  end
  max
end
scan!() click to toggle source
# File lib/bootsnap/load_path_cache/path.rb, line 68
def scan! # (expensive) returns [entries, dirs]
  PathScanner.call(expanded_path)
end
stability() click to toggle source
# File lib/bootsnap/load_path_cache/path.rb, line 99
def stability
  @stability ||= begin
    if Gem.path.detect { |p| expanded_path.start_with?(p.to_s) }
      STABLE
    elsif Bootsnap.bundler? && expanded_path.start_with?(Bundler.bundle_path.to_s)
      STABLE
    elsif expanded_path.start_with?(RUBY_LIBDIR) && !expanded_path.start_with?(RUBY_SITEDIR)
      STABLE
    else
      VOLATILE
    end
  end
end