module Bootsnap::CompileCache

Constants

Error
UNCOMPILABLE

Public Class Methods

setup(cache_dir:, iseq:, yaml:, json: (json_unset = true), readonly: false, revalidation: false) click to toggle source
# File lib/bootsnap/compile_cache.rb, line 12
def self.setup(cache_dir:, iseq:, yaml:, json: (json_unset = true), readonly: false, revalidation: false)
  unless json_unset
    warn("Bootsnap::CompileCache.setup `json` argument is deprecated and has no effect")
  end

  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 supported? && defined?(Bootsnap::CompileCache::Native)
    Bootsnap::CompileCache::Native.readonly = readonly
    Bootsnap::CompileCache::Native.revalidation = revalidation
  end
end
supported?() click to toggle source
# File lib/bootsnap/compile_cache.rb, line 41
def self.supported?
  # only enable on 'ruby' (MRI) and TruffleRuby for POSIX (darwin, linux, *bsd), Windows (RubyInstaller2)
  %w[ruby truffleruby].include?(RUBY_ENGINE) &&
    RUBY_PLATFORM.match?(/darwin|linux|bsd|mswin|mingw|cygwin/)
end