Contents

module Bootsnap
  module CompileCache
    Error           = Class.new(StandardError)
    PermissionError = Class.new(Error)

    def self.setup(cache_dir:, iseq:, yaml:)
      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
    end

    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 permisison to read '#{path}')",
      )
    end

    def self.supported?
      # only enable on 'ruby' (MRI), POSIX (darwin, linux, *bsd), and >= 2.3.0
      RUBY_ENGINE == 'ruby' &&
      RUBY_PLATFORM =~ /darwin|linux|bsd/ &&
      Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.3.0")
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
bootsnap-1.4.4-java	lib/bootsnap/compile_cache.rb
bootsnap-1.4.4	lib/bootsnap/compile_cache.rb
bootsnap-1.4.3-java	lib/bootsnap/compile_cache.rb
bootsnap-1.4.3	lib/bootsnap/compile_cache.rb
bootsnap-1.4.2-java	lib/bootsnap/compile_cache.rb
bootsnap-1.4.2	lib/bootsnap/compile_cache.rb
bootsnap-1.4.2.rc3	lib/bootsnap/compile_cache.rb
bootsnap-1.4.2.rc2-java	lib/bootsnap/compile_cache.rb
bootsnap-1.4.2.rc2	lib/bootsnap/compile_cache.rb
bootsnap-1.4.2.rc1-java	lib/bootsnap/compile_cache.rb
bootsnap-1.4.2.rc1	lib/bootsnap/compile_cache.rb