zeitwerk 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e3caf01e7af10f0f12922ebbe41f400a27eee1fa8d47a1d580ba1bb421393b
-  data.tar.gz: 6b76087bdc7abec95aa7a70ee5c5b70cb7567e7b02c8dbb290852a3bda523089
+  metadata.gz: a7e867060d3bf347938f153335a463ddbb48995f70f3aed8472a6641e2592a71
+  data.tar.gz: af10438f14e119bf184133b1c1734e01fbe61954ce2128805a1ab941125dc4cf
 SHA512:
-  metadata.gz: 31aabb9e4c66028674508efa6dad871ece2893a3bb78e9c53d24be6721dbbd1a9f0960348ca5c7b33dc3e16670bd2c8b37eea3d813f6ce045b63410a73033a66
-  data.tar.gz: dc9f42aecb424d7695d48e831ec0ef70159538ded7abf470cc0a26195087aa8a3ce0d3a3a83c8978a88dda8fccb747013db60b0b1b2169e5a6c9ff1b30e94bb8
+  metadata.gz: a744a32914b0bd02c07842b448770512d6a8aad66b5524bbe9bb6ef854faeea1ce11e2090bc9a968aebb3501d54de54f65f7927f9d26d4f365a13ad806920e38
+  data.tar.gz: 032c50fd06d88be03ee5fae4d7fd6bdbd34780b5dc1f978a8a63a3a9bdda960d417dcb91b40bb82865d3c58b6751cf58506c1bed2454c65c14c6c1d2b5f7bdc7

data/README.md

@@ -216,7 +216,14 @@ Zeitwerk instances are able to eager load their managed files:
 loader.eager_load
 ```
 
-That skips ignored files and directories.
+That skips [ignored files and directories](#ignoring-parts-of-the-project), and you can also tell Zeitwerk that certain files or directories are autoloadable, but should not be eager loaded:
+
+```ruby
+db_adapters = "#{__dir__}/my_gem/db_adapters"
+loader.do_not_eager_load(db_adapters)
+loader.setup
+loader.eager_load # won't eager load the database adapters
+```
 
 Eager loading is synchronized and idempotent.
 

data/lib/zeitwerk/explicit_namespace.rb

@@ -57,6 +57,10 @@ module Zeitwerk
     @cpaths = {}
     @mutex  = Mutex.new
     @tracer = TracePoint.new(:class) do |event|
+      # If the class is a singleton class, we won't do anything with it so we can bail out immediately.
+      # This is several orders of magnitude faster than accessing `Module#name`.
+      next if event.self.singleton_class?
+
       # Note that it makes sense to compute the hash code unconditionally,
       # because the trace point is disabled if cpaths is empty.
       if loader = cpaths.delete(event.self.name)

data/lib/zeitwerk/loader.rb

@@ -57,7 +57,7 @@ module Zeitwerk
     #
     # A shadowed file is a file managed by this autoloader that is skipped
     # because its matching constant path has already been seen. Think $LOAD_PATH
-    # + require, only the first occurrence of a given relative name is loaded.
+    # and require, only the first occurrence of a given relative name is loaded.
     #
     # If the existing occurrence is an autoload, we map the file name to the
     # shadowing autoload path. If the existing occurrence is an already defined
@@ -66,7 +66,7 @@ module Zeitwerk
     #
     # @private
     # @return [{String => String}]
-    attr_reader :shadowed
+    attr_reader :shadowed_files
 
     # Maps real absolute paths for which an autoload has been set to their
     # corresponding parent class or module and constant name.
@@ -83,7 +83,7 @@ module Zeitwerk
     #
     # @private
     # @return [Set<String>]
-    attr_reader :loaded
+    attr_reader :loaded_cpaths
 
     # Maps constant paths of namespaces to arrays of corresponding directories.
     #
@@ -103,6 +103,12 @@ module Zeitwerk
     # @return [{String => <String>}]
     attr_reader :lazy_subdirs
 
+    # Absolute paths of files or directories not to be eager loaded.
+    #
+    # @private
+    # @return [Set<String>]
+    attr_reader :eager_load_exclusions
+
     # @private
     # @return [Mutex]
     attr_reader :mutex
@@ -114,14 +120,15 @@ module Zeitwerk
       @inflector = Inflector.new
       @logger    = self.class.default_logger
 
-      @root_dirs     = {}
-      @preloads      = []
-      @ignored       = Set.new
-      @ignored_paths = Set.new
-      @autoloads     = {}
-      @loaded        = Set.new
-      @lazy_subdirs  = {}
-      @shadowed      = {}
+      @root_dirs             = {}
+      @preloads              = []
+      @ignored               = Set.new
+      @ignored_paths         = Set.new
+      @autoloads             = {}
+      @loaded_cpaths         = Set.new
+      @lazy_subdirs          = {}
+      @shadowed_files        = {}
+      @eager_load_exclusions = Set.new
 
       @mutex        = Mutex.new
       @setup        = false
@@ -230,9 +237,9 @@ module Zeitwerk
         end
 
         autoloads.clear
-        loaded.clear
+        loaded_cpaths.clear
         lazy_subdirs.clear
-        shadowed.clear
+        shadowed_files.clear
 
         Registry.on_unload(self)
         ExplicitNamespace.unregister(self)
@@ -255,18 +262,21 @@ module Zeitwerk
 
     # Eager loads all files in the root directories, recursively. Files do not
     # need to be in `$LOAD_PATH`, absolute file names are used. Ignored files
-    # are not eager loaded.
+    # are not eager loaded. You can opt-out specifically in specific files and
+    # directories with `do_not_eager_load`.
     #
     # @return [void]
     def eager_load
       mutex.synchronize do
         break if @eager_loaded
 
-        queue = non_ignored_root_dirs
+        queue = non_ignored_root_dirs.reject { |dir| eager_load_exclusions.member?(dir) }
         while dir = queue.shift
           each_abspath(dir) do |abspath|
+            next if eager_load_exclusions.member?(abspath)
+
             if ruby?(abspath)
-              require abspath unless shadowed.key?(abspath)
+              require abspath unless shadowed_files.key?(abspath)
             elsif dir?(abspath)
               queue << abspath
             end
@@ -277,12 +287,21 @@ module Zeitwerk
       end
     end
 
+    # Let eager load ignore the given files or directories. The constants
+    # defined in those files are still autoloadable.
+    #
+    # @param paths [<String, Pathname, <String, Pathname>>]
+    # @return [void]
+    def do_not_eager_load(*paths)
+      mutex.synchronize { eager_load_exclusions.merge(expand_paths(paths)) }
+    end
+
     # Says if the given constant path has been loaded.
     #
     # @param cpath [String]
     # @return [Boolean]
     def loaded?(cpath)
-      loaded.member?(cpath)
+      loaded_cpaths.member?(cpath)
     end
 
     # --- Class methods ---------------------------------------------------------------------------
@@ -387,7 +406,7 @@ module Zeitwerk
     def autoload_file(parent, cname, file)
       if autoload_path = autoload_for?(parent, cname)
         # First autoload for a Ruby file wins, just ignore subsequent ones.
-        shadowed[file] = autoload_path and return if ruby?(autoload_path)
+        shadowed_files[file] = autoload_path and return if ruby?(autoload_path)
 
         # Override autovivification, we want the namespace to become the
         # class/module defined in this file.
@@ -397,7 +416,7 @@ module Zeitwerk
         set_autoload(parent, cname, file)
         register_explicit_namespace(cpath(parent, cname))
       elsif cdef?(parent, cname)
-        shadowed[file] = cpath(parent, cname)
+        shadowed_files[file] = cpath(parent, cname)
       else
         set_autoload(parent, cname, file)
       end

data/lib/zeitwerk/loader/callbacks.rb

@@ -6,7 +6,7 @@ module Zeitwerk::Loader::Callbacks
   # @return [void]
   def on_file_autoloaded(file)
     parent, cname = autoloads[file]
-    loaded.add(cpath(parent, cname))
+    loaded_cpaths.add(cpath(parent, cname))
     log("constant #{cpath(parent, cname)} loaded from file #{file}") if logger
   end
 
@@ -22,7 +22,7 @@ module Zeitwerk::Loader::Callbacks
     autovivified_module = parent.const_set(cname, Module.new)
     log("module #{autovivified_module.name} autovivified from directory #{dir}") if logger
 
-    loaded.add(autovivified_module.name)
+    loaded_cpaths.add(autovivified_module.name)
     on_namespace_loaded(autovivified_module)
   end
 

data/lib/zeitwerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zeitwerk
-  VERSION = "1.3.4"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeitwerk
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Xavier Noria
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Zeitwerk implements constant autoloading with Ruby semantics. Each gem