bootsnap 1.0.0 → 1.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77b33ef59e01f0ddaa1de86a002ce286018b870d
-  data.tar.gz: 958ec1e45c50803261866ade91f9300dd6975d03
+  metadata.gz: eb4f1c7a20afd5550cb29063940865fa1b7cf1a6
+  data.tar.gz: 1309c503d7c4fedbd07a30efc8fbe1cdb7fd44c7
 SHA512:
-  metadata.gz: bcb190169610158178bff1fbf16ed6d43a4f986d06c7e07c16c5199aa658512749490b43e42b1e2e431a1099aa5ebd50e5905a35a0170f75e2cc2d468037eca1
-  data.tar.gz: 17fe5e20e585fce572bc39a47febe146abba4ec0aea70934c9d39f88fd271f158b3dd0fc3b0fe103e3060c97ade3bd890cf9e74d28f7ba4fb6b7836a401dac14
+  metadata.gz: 712729db38aedc0316e4d2043dc3eb3f72cd6560915052ee3bf9fc19de74a5c6534716d2607ac312bb074f8df529f76a9fdfd584d746356280dc96c43fb8de3c
+  data.tar.gz: a978d40c13d3b665910571224d378d75ec7d6c1779e8fc535bf88efc3c290e948d681f055a2ae1fcd0d6ae84df0e8ef501714c4e12c2e420357de4e7995f9dae

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.1.0
+
+* Add `bootsnap/setup`
+* Support jruby (without compile caching features)
+
 # 1.0.0
 
 * (none)

data/README.md

@@ -20,19 +20,26 @@ Add `bootsnap` to your `Gemfile`:
 gem 'bootsnap'
 ```
 
-Next, add this to your boot setup immediately after `require 'bundler/setup'` (i.e. as early as
-possible: the sooner this is loaded, the sooner it can start optimizing things)
+If you are using rails, add this to `config/boot.rb` immediately after `require 'bundler/setup'`:
+
+```ruby
+require 'bootsnap/setup'
+```
+
+If you are not using rails, or if you are but want more control over things, add this to your
+application setup immediately after `require 'bundler/setup'` (i.e. as early as possible: the sooner
+this is loaded, the sooner it can start optimizing things)
 
 ```ruby
 require 'bootsnap'
 Bootsnap.setup(
-  cache_dir:            'tmp/cache', # Path to your cache
-  development_mode:     ENV['MY_ENV'] == 'development',
-  load_path_cache:      true,        # Should we optimize the LOAD_PATH with a cache?
-  autoload_paths_cache: true,        # Should we optimize ActiveSupport autoloads with cache?
-  disable_trace:        false,       # Sets `RubyVM::InstructionSequence.compile_option = { trace_instruction: false }`
-  compile_cache_iseq:   true,        # Should compile Ruby code into ISeq cache?
-  compile_cache_yaml:   true         # Should compile YAML into a cache?
+  cache_dir:            'tmp/cache',                       # Path to your cache
+  development_mode:     ENV['RAILS_ENV'] == 'development', # This should be set to whatever evaluates your current working environment, e.g. RACK_ENV, RAILS_ENV, etc
+  load_path_cache:      true,                              # Should we optimize the LOAD_PATH with a cache?
+  autoload_paths_cache: true,                              # Should we optimize ActiveSupport autoloads with cache?
+  disable_trace:        false,                             # Sets `RubyVM::InstructionSequence.compile_option = { trace_instruction: false }`
+  compile_cache_iseq:   true,                              # Should compile Ruby code into ISeq cache?
+  compile_cache_yaml:   true                               # Should compile YAML into a cache?
 )
 ```
 
@@ -262,7 +269,7 @@ open    /c/nope.bundle -> -1
 We use the `*_path_cache` features in production and haven't experienced any issues in a long time.
 
 The `compile_cache_*` features work well for us in development on macOS. It should work on Linux,
-and we intend to deploy it in production, but haven't we haven't yet.
+and we intend to deploy it in production, but we haven't yet.
 
 `disable_trace` should be completely safe, but we don't really use it because some people like to
 use tools that make use of `trace` instructions.

data/bootsnap.gemspec

@@ -18,12 +18,16 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.extensions    = ['ext/bootsnap/extconf.rb']
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.0.0'
+
+  if RUBY_PLATFORM =~ /java/
+    spec.platform = 'java'
+  else
+    spec.platform    = Gem::Platform::RUBY
+    spec.extensions  = ['ext/bootsnap/extconf.rb']
+  end
 
   spec.add_development_dependency "bundler", '~> 1'
   spec.add_development_dependency 'rake', '~> 10.0'

data/ext/bootsnap/bootsnap.c

@@ -316,7 +316,7 @@ open_cache_file(const char * path, struct bs_cache_key * key)
 {
   int fd, res;
 
-  fd = open(path, O_RDWR, 0644);
+  fd = open(path, O_RDONLY);
   if (fd < 0) {
     if (errno == ENOENT) return CACHE_MISSING_OR_INVALID;
     return ERROR_WITH_ERRNO;

data/lib/bootsnap/compile_cache.rb

@@ -1,14 +1,13 @@
-require_relative 'compile_cache/iseq'
-require_relative 'compile_cache/yaml'
-
 module Bootsnap
   module CompileCache
     def self.setup(cache_dir:, iseq:, yaml:)
       if iseq
+        require_relative 'compile_cache/iseq'
         Bootsnap::CompileCache::ISeq.install!(cache_dir)
       end
 
       if yaml
+        require_relative 'compile_cache/yaml'
         Bootsnap::CompileCache::YAML.install!(cache_dir)
       end
     end

data/lib/bootsnap/compile_cache/yaml.rb

@@ -1,3 +1,5 @@
+require 'bootsnap/bootsnap'
+
 module Bootsnap
   module CompileCache
     module YAML

data/lib/bootsnap/setup.rb

@@ -0,0 +1,47 @@
+require_relative '../bootsnap'
+
+env = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['ENV']
+development_mode = ['', nil, 'development'].include?(env)
+
+# only enable on 'ruby' (MRI), POSIX (darin, linux, *bsd), and >= 2.3.0
+enable_cc = \
+  RUBY_ENGINE == 'ruby' && \
+  RUBY_PLATFORM =~ /darwin|linux|bsd/ && \
+  RUBY_VERSION                    # "1.9.3"
+    .split('.')                   # ["1", "9", "3"]
+    .map(&:to_i)                  # [1, 9, 3]
+    .zip([2, 3, -1])              # [[1, 2], [9, 3], [3, -1]]
+    .map { |a, b| a <=> b }       # [-1, 1, 1]
+    .detect { |e| !e.zero? }      # -1
+    .==(1)                        # false
+
+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
+
+Bootsnap.setup(
+  cache_dir:            cache_dir,
+  development_mode:     development_mode,
+  load_path_cache:      true,
+  autoload_paths_cache: true, # assume rails. open to PRs to impl. detection
+  disable_trace:        false,
+  compile_cache_iseq:   enable_cc,
+  compile_cache_yaml:   enable_cc
+)

data/lib/bootsnap/version.rb

@@ -1,3 +1,3 @@
 module Bootsnap
-  VERSION = "1.0.0"
+  VERSION = "1.1.0.pre"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,6 +146,7 @@ files:
 - lib/bootsnap/load_path_cache/path.rb
 - lib/bootsnap/load_path_cache/path_scanner.rb
 - lib/bootsnap/load_path_cache/store.rb
+- lib/bootsnap/setup.rb
 - lib/bootsnap/version.rb
 homepage: https://github.com/Shopify/bootsnap
 licenses:
@@ -159,12 +160,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.10