module Bootsnap

Ruby C extensions are initialized by calling Init_<extname>.

This sets up the module hierarchy and attaches functions as methods.

We also populate some semi-static information about the current OS and so on.

Constants

InvalidConfiguration
VERSION

Attributes

logger[R]

Public Class Methods

_instrument(event, path) click to toggle source

# File lib/bootsnap.rb, line 34
def _instrument(event, path)
  @instrumentation.call(event, path)
end

absolute_path?(path) click to toggle source

# File lib/bootsnap.rb, line 118
def absolute_path?(path)
  path[1] == ":"
end

default_setup() click to toggle source

# File lib/bootsnap.rb, line 70
def default_setup
  env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || ENV["ENV"]
  development_mode = ["", nil, "development"].include?(env)

  unless ENV["DISABLE_BOOTSNAP"]
    cache_dir = ENV["BOOTSNAP_CACHE_DIR"]
    unless cache_dir
      config_dir_frame = caller.detect do |line|
        line.include?("/config/")
      end

      unless config_dir_frame
        $stderr.puts("[bootsnap/setup] couldn't infer cache directory! Either:")
        $stderr.puts("[bootsnap/setup]   1. require bootsnap/setup from your application's config directory; or")
        $stderr.puts("[bootsnap/setup]   2. Define the environment variable BOOTSNAP_CACHE_DIR")

        raise("couldn't infer bootsnap cache directory")
      end

      path = config_dir_frame.split(/:\d+:/).first
      path = File.dirname(path) until File.basename(path) == "config"
      app_root = File.dirname(path)

      cache_dir = File.join(app_root, "tmp", "cache")
    end

    ignore_directories = if ENV.key?("BOOTSNAP_IGNORE_DIRECTORIES")
      ENV["BOOTSNAP_IGNORE_DIRECTORIES"].split(",")
    end

    setup(
      cache_dir: cache_dir,
      development_mode: development_mode,
      load_path_cache: !ENV["DISABLE_BOOTSNAP_LOAD_PATH_CACHE"],
      compile_cache_iseq: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
      compile_cache_yaml: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
      compile_cache_json: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
      readonly: !!ENV["BOOTSNAP_READONLY"],
      ignore_directories: ignore_directories,
    )

    if ENV["BOOTSNAP_LOG"]
      log!
    end
  end
end

instrumentation=(callback) click to toggle source

# File lib/bootsnap.rb, line 27
def instrumentation=(callback)
  @instrumentation = callback
  if respond_to?(:instrumentation_enabled=, true)
    self.instrumentation_enabled = !!callback
  end
end

instrumentation_enabled=(p1) click to toggle source

static VALUE
bs_instrumentation_enabled_set(VALUE self, VALUE enabled)
{
  instrumentation_enabled = RTEST(enabled);
  return enabled;
}

log!() click to toggle source

# File lib/bootsnap.rb, line 14
def log!
  self.logger = $stderr.method(:puts)
end

logger=(logger) click to toggle source

# File lib/bootsnap.rb, line 18
def logger=(logger)
  @logger = logger
  self.instrumentation = if logger.respond_to?(:debug)
    ->(event, path) { @logger.debug("[Bootsnap] #{event} #{path}") }
  else
    ->(event, path) { @logger.call("[Bootsnap] #{event} #{path}") }
  end
end

rb_get_path(p1) click to toggle source

Allow the C extension to redefine `rb_get_path` without warning.

static VALUE
bs_rb_get_path(VALUE self, VALUE fname)
{
    return rb_get_path(fname);
}

Also aliased as: rb_get_path

setup( cache_dir:, development_mode: true, load_path_cache: true, ignore_directories: nil, readonly: false, compile_cache_iseq: true, compile_cache_yaml: true, compile_cache_json: true ) click to toggle source

# File lib/bootsnap.rb, line 38
def setup(
  cache_dir:,
  development_mode: true,
  load_path_cache: true,
  ignore_directories: nil,
  readonly: false,
  compile_cache_iseq: true,
  compile_cache_yaml: true,
  compile_cache_json: true
)
  if load_path_cache
    Bootsnap::LoadPathCache.setup(
      cache_path: "#{cache_dir}/bootsnap/load-path-cache",
      development_mode: development_mode,
      ignore_directories: ignore_directories,
      readonly: readonly,
    )
  end

  Bootsnap::CompileCache.setup(
    cache_dir: "#{cache_dir}/bootsnap/compile-cache",
    iseq: compile_cache_iseq,
    yaml: compile_cache_yaml,
    json: compile_cache_json,
    readonly: readonly,
  )
end

unload_cache!() click to toggle source

# File lib/bootsnap.rb, line 66
def unload_cache!
  LoadPathCache.unload!
end

Public Instance Methods

bundler?() click to toggle source

# File lib/bootsnap/bundler.rb, line 6
def bundler?
  return false unless defined?(::Bundler)

  # Bundler environment variable
  %w(BUNDLE_BIN_PATH BUNDLE_GEMFILE).each do |current|
    return true if ENV.key?(current)
  end

  false
end