bootsnap 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40e594cf459a80b9e118cf8cdb6d9f306228fe682e3c2af3a1c2b70432f47890
-  data.tar.gz: c120e3c24944e9c0568615a0b6ec23d422e949755339c8ffa118f0265e85755b
+  metadata.gz: 6f2b4691e78336f28b1f78e9751235bc558b0f6ad86dee541acd478fc23ef510
+  data.tar.gz: 51eb44a77465f49db0d15425536e17d94f8d3fe77433ab48260b4c81613d9c72
 SHA512:
-  metadata.gz: 45c52711bd2fbf273f93d27ea4a8ee71d04c81b7444f0f49aa9b672e131544103b74d3326afe5228122dc52844b681c1e18bbb59fe429b2a2216e182e90ac5e7
-  data.tar.gz: ad78b4da53ffc8d6653f74ed777bae1987704de2a76062bbebc2b1d3977baeca900b36066994957adf3cefbda446b4393dd18e41637d1a39f9adac42878b6732
+  metadata.gz: 64e98271863cf3dec676eea43ecaecf4d97a543ba5c0d840160d9862b4f212906910e3654263db49457320b5783150c719a8ef479266be96df5243a04addc43b
+  data.tar.gz: 46aa01dff95699d6148ed539c8a56e1d749801ee89e953a37f32b4a3974f1da99fe594c4fb1b04c99a42f030cb4b12bd6dd892fac5b00af4de1f7a560cb420ba

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Unreleased
 
+# 1.14.0
+
+* Require Ruby 2.6.
+* Add a way to skip directories during load path scanning.
+  If you have large non-ruby directories in the middle of your load path, it can severly slow down scanning.
+  Typically this is a problem with `node_modules`. See #277.
+* Fix `Bootsnap.unload_cache!`, it simply wouldn't work at all becaue of a merge mistake. See #421.
+
 # 1.13.0
 
 * Stop decorating `Kernel.load`. This used to be very useful in development because the Rails "classic" autoloader

data/README.md

@@ -52,10 +52,11 @@ require 'bootsnap'
 env = ENV['RAILS_ENV'] || "development"
 Bootsnap.setup(
   cache_dir:            'tmp/cache',          # Path to your cache
+  ignored_directories   ['node_modules'],     # Directory names to skip.
   development_mode:     env == 'development', # Current working environment, e.g. RACK_ENV, RAILS_ENV, etc
   load_path_cache:      true,                 # Optimize the LOAD_PATH with a cache
   compile_cache_iseq:   true,                 # Compile Ruby code into ISeq cache, breaks coverage reporting.
-  compile_cache_yaml:   true                  # Compile YAML into a cache
+  compile_cache_yaml:   true,                 # Compile YAML into a cache
 )
 ```
 
@@ -77,6 +78,9 @@ well together, and are both included in a newly-generated Rails applications by
 - `DISABLE_BOOTSNAP_LOAD_PATH_CACHE` allows to disable load path caching.
 - `DISABLE_BOOTSNAP_COMPILE_CACHE` allows to disable ISeq and YAML caches.
 - `BOOTSNAP_LOG` configure bootsnap to log all caches misses to STDERR.
+- `BOOTSNAP_IGNORE_DIRECTORIES` a comma separated list of directories that shouldn't be scanned.
+  Useful when you have large directories of non-ruby files inside `$LOAD_PATH`.
+  It default to ignore any directory named `node_modules`.
 
 ### Environments
 

data/lib/bootsnap/load_path_cache/change_observer.rb

@@ -66,7 +66,7 @@ module Bootsnap
       end
 
       def self.unregister(arr)
-        return unless arr.instance_variable_get(:@lpc_observer)
+        return unless arr.instance_variable_defined?(:@lpc_observer) && arr.instance_variable_get(:@lpc_observer)
 
         ArrayMixin.instance_methods.each do |method_name|
           arr.singleton_class.send(:remove_method, method_name)

data/lib/bootsnap/load_path_cache/loaded_features_index.rb

@@ -40,7 +40,7 @@ module Bootsnap
 
             # /a/b/lib/my/foo.rb
             #          ^^^^^^^^^
-            short = feat[(lpe.length + 1)..-1]
+            short = feat[(lpe.length + 1)..]
             stripped = strip_extension_if_elidable(short)
             @lfi[short] = hash
             @lfi[stripped] = hash
@@ -76,7 +76,7 @@ module Bootsnap
       end
 
       def identify(short, cursor)
-        $LOADED_FEATURES[cursor..-1].detect do |feat|
+        $LOADED_FEATURES[cursor..].detect do |feat|
           offset = 0
           while (offset = feat.index(short, offset))
             if feat.index(".", offset + 1) && !feat.index("/", offset + 2)

data/lib/bootsnap/load_path_cache/path_scanner.rb

@@ -15,7 +15,11 @@ module Bootsnap
         ""
       end
 
+      @ignored_directories = %w(node_modules)
+
       class << self
+        attr_accessor :ignored_directories
+
         def call(path)
           path = File.expand_path(path.to_s).freeze
           return [[], []] unless File.directory?(path)
@@ -50,6 +54,8 @@ module Bootsnap
 
             absolute_path = "#{absolute_dir_path}/#{name}"
             if File.directory?(absolute_path)
+              next if ignored_directories.include?(name)
+
               if yield relative_path, absolute_path, true
                 walk(absolute_path, relative_path, &block)
               end

data/lib/bootsnap/load_path_cache.rb

@@ -28,7 +28,7 @@ module Bootsnap
       alias_method :enabled?, :enabled
       remove_method(:enabled)
 
-      def setup(cache_path:, development_mode:)
+      def setup(cache_path:, development_mode:, ignore_directories:)
         unless supported?
           warn("[bootsnap/setup] Load path caching is not supported on this implementation of Ruby") if $VERBOSE
           return
@@ -39,6 +39,7 @@ module Bootsnap
         @loaded_features_index = LoadedFeaturesIndex.new
 
         @load_path_cache = Cache.new(store, $LOAD_PATH, development_mode: development_mode)
+        PathScanner.ignored_directories = ignore_directories if ignore_directories
         @enabled = true
         require_relative("load_path_cache/core_ext/kernel_require")
         require_relative("load_path_cache/core_ext/loaded_features")
@@ -50,7 +51,6 @@ module Bootsnap
         @realpath_cache = nil
         @load_path_cache = nil
         ChangeObserver.unregister($LOAD_PATH)
-        ::Kernel.alias_method(:require_relative, :require_relative_without_bootsnap)
       end
 
       def supported?

data/lib/bootsnap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bootsnap
-  VERSION = "1.13.0"
+  VERSION = "1.14.0"
 end

data/lib/bootsnap.rb

@@ -39,32 +39,16 @@ module Bootsnap
       cache_dir:,
       development_mode: true,
       load_path_cache: true,
-      autoload_paths_cache: nil,
-      disable_trace: nil,
+      ignore_directories: nil,
       compile_cache_iseq: true,
       compile_cache_yaml: true,
       compile_cache_json: true
     )
-      unless autoload_paths_cache.nil?
-        warn "[DEPRECATED] Bootsnap's `autoload_paths_cache:` option is deprecated and will be removed. " \
-             "If you use Zeitwerk this option is useless, and if you are still using the classic autoloader " \
-             "upgrading is recommended."
-      end
-
-      unless disable_trace.nil?
-        warn "[DEPRECATED] Bootsnap's `disable_trace:` option is deprecated and will be removed. " \
-             "If you use Ruby 2.5 or newer this option is useless, if not upgrading is recommended."
-      end
-
-      if compile_cache_iseq && !iseq_cache_supported?
-        warn "Ruby 2.5 has a bug that break code tracing when code is loaded from cache. It is recommened " \
-             "to turn `compile_cache_iseq` off on Ruby 2.5"
-      end
-
       if load_path_cache
         Bootsnap::LoadPathCache.setup(
           cache_path: "#{cache_dir}/bootsnap/load-path-cache",
           development_mode: development_mode,
+          ignore_directories: ignore_directories,
         )
       end
 
@@ -76,17 +60,10 @@ module Bootsnap
       )
     end
 
-    def self.unload_cache!
+    def unload_cache!
       LoadPathCache.unload!
     end
 
-    def iseq_cache_supported?
-      return @iseq_cache_supported if defined? @iseq_cache_supported
-
-      ruby_version = Gem::Version.new(RUBY_VERSION)
-      @iseq_cache_supported = ruby_version < Gem::Version.new("2.5.0") || ruby_version >= Gem::Version.new("2.6.0")
-    end
-
     def default_setup
       env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || ENV["ENV"]
       development_mode = ["", nil, "development"].include?(env)
@@ -113,13 +90,18 @@ module Bootsnap
           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"] && iseq_cache_supported?,
+          compile_cache_iseq: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
           compile_cache_yaml: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
           compile_cache_json: !ENV["DISABLE_BOOTSNAP_COMPILE_CACHE"],
+          ignore_directories: ignore_directories,
         )
 
         if ENV["BOOTSNAP_LOG"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="