module Bootsnap::CompileCache

Constants

Error
PermissionError
UNCOMPILABLE

Public Class Methods

permission_error(path) click to toggle source
# File lib/bootsnap/compile_cache.rb, line 41
def self.permission_error(path)
  cpath = Bootsnap::CompileCache::ISeq.cache_dir
  raise(
    PermissionError,
    "bootsnap doesn't have permission to write cache entries in '#{cpath}' " \
    "(or, less likely, doesn't have permission to read '#{path}')",
  )
end
setup(cache_dir:, iseq:, yaml:, json:) click to toggle source
# File lib/bootsnap/compile_cache.rb, line 12
def self.setup(cache_dir:, iseq:, yaml:, json:)
  if iseq
    if supported?
      require_relative("compile_cache/iseq")
      Bootsnap::CompileCache::ISeq.install!(cache_dir)
    elsif $VERBOSE
      warn("[bootsnap/setup] bytecode caching is not supported on this implementation of Ruby")
    end
  end

  if yaml
    if supported?
      require_relative("compile_cache/yaml")
      Bootsnap::CompileCache::YAML.install!(cache_dir)
    elsif $VERBOSE
      warn("[bootsnap/setup] YAML parsing caching is not supported on this implementation of Ruby")
    end
  end

  if json
    if supported?
      require_relative("compile_cache/json")
      Bootsnap::CompileCache::JSON.install!(cache_dir)
    elsif $VERBOSE
      warn("[bootsnap/setup] JSON parsing caching is not supported on this implementation of Ruby")
    end
  end
end
supported?() click to toggle source
# File lib/bootsnap/compile_cache.rb, line 50
def self.supported?
  # only enable on 'ruby' (MRI), POSIX (darwin, linux, *bsd), Windows (RubyInstaller2) and >= 2.3.0
  RUBY_ENGINE == "ruby" &&
    RUBY_PLATFORM =~ /darwin|linux|bsd|mswin|mingw|cygwin/ &&
    Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.3.0")
end