zeitwerk 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69ab50936501a8a78e6be01014ac8e97890297955088fdac78cf1d5adeea7e78
-  data.tar.gz: 2afe0ae004e102604e2b23133ef683bad6753479bd9be0ef37379676d5c47a09
+  metadata.gz: 172e4bb51ab526d5f4f606f0c4099cd9d4b8bdfe15a2ec851ed58e7095018f07
+  data.tar.gz: 74b2d3f010de6374d919e7cae4d759a86490d91bfb7cd3f743b314e10569d2e9
 SHA512:
-  metadata.gz: 51ceaebc945976ba34a6025d225099ab69e337287a3577c1f1e484d0fc1e4d6efec00e2e132a9cb794d91101f1f484dc154ef6e97c3b0a392f16a9ec5c340bdb
-  data.tar.gz: ab59de0733cdbb0496d75ddb72ffbb744a4258ca7bca73ad0817312a07ac0e715d490c906cc24307dfb719bf3a4ac7cbf7fd9396c98ba66b224789dd987830d1
+  metadata.gz: 57531ede94526489ffb47235b0113ff6cb290c5d21c4b03dbbdea79a55b0e6b74d685b8f5d57f5b0bf9ec85986e731368bd57b9f5dd0ccfdc40033e5b570bbaa
+  data.tar.gz: d50a101226b04214af4bcc6961422501044a4b9bede6d18bc06a622736bedd7d19fa9b8b9191b8f08042382d0bebcfb8e0162aa7aef37eddd2e17dbcdc6ee8a6

data/lib/zeitwerk/kernel.rb

@@ -14,17 +14,17 @@ module Kernel
     if loader = Zeitwerk::Registry.loader_for(path)
       if path.end_with?(".rb")
         zeitwerk_original_require(path).tap do |required|
-          loader.on_file_loaded(path) if required
+          loader.on_file_autoloaded(path) if required
         end
       else
-        loader.on_dir_loaded(path)
+        loader.on_dir_autoloaded(path)
       end
     else
       zeitwerk_original_require(path).tap do |required|
         if required
           realpath = $LOADED_FEATURES.last
           if loader = Zeitwerk::Registry.loader_for(realpath)
-            loader.on_file_loaded(realpath)
+            loader.on_file_autoloaded(realpath)
           end
         end
       end

data/lib/zeitwerk/loader.rb

@@ -5,6 +5,9 @@ require "securerandom"
 
 module Zeitwerk
   class Loader
+    require_relative "loader/callbacks"
+    include Callbacks
+
     # @return [String]
     attr_reader :tag
 
@@ -117,11 +120,7 @@ module Zeitwerk
       @eager_loaded = false
 
       @tracer = TracePoint.new(:class) do |tp|
-        unless lazy_subdirs.empty? # do not even compute the hash key if not needed
-          if subdirs = lazy_subdirs.delete(tp.self.name)
-            subdirs.each { |subdir| set_autoloads_in_dir(subdir, tp.self) }
-          end
-        end
+        on_namespace_loaded(tp.self)
       end
 
       Registry.register_loader(self)
@@ -147,14 +146,12 @@ module Zeitwerk
     # @param path [<String, Pathname>]
     # @return [void]
     def push_dir(path)
-      self.class.mutex.synchronize do
-        abspath = File.expand_path(path)
-        if dir?(abspath)
-          raise_if_conflicting_directory(abspath)
-          root_dirs[abspath] = true
-        else
-          raise ArgumentError, "the root directory #{abspath} does not exist"
-        end
+      abspath = File.expand_path(path)
+      if dir?(abspath)
+        raise_if_conflicting_directory(abspath)
+        root_dirs[abspath] = true
+      else
+        raise ArgumentError, "the root directory #{abspath} does not exist"
       end
     end
 
@@ -192,12 +189,13 @@ module Zeitwerk
     # @return [void]
     def setup
       mutex.synchronize do
-        unless @setup
-          expand_ignored_glob_patterns
-          non_ignored_root_dirs.each { |root_dir| set_autoloads_in_dir(root_dir, Object) }
-          do_preload
-          @setup = true
-        end
+        break if @setup
+
+        expand_ignored_glob_patterns
+        non_ignored_root_dirs.each { |root_dir| set_autoloads_in_dir(root_dir, Object) }
+        do_preload
+
+        @setup = true
       end
     end
 
@@ -226,6 +224,7 @@ module Zeitwerk
           # array lookups, since directories are not stored in $LOADED_FEATURES.
           $LOADED_FEATURES.delete(path) if ruby?(path)
         end
+
         autoloads.clear
         loaded.clear
         lazy_subdirs.clear
@@ -274,7 +273,7 @@ module Zeitwerk
       end
     end
 
-    # Says if the given constant path as been loaded.
+    # Says if the given constant path has been loaded.
     #
     # @param cpath [String]
     # @return [Boolean]
@@ -285,7 +284,7 @@ module Zeitwerk
     # --- Class methods ---------------------------------------------------------------------------
 
     class << self
-      # @return [#call, nil]
+      # @return [#call, #debug, nil]
       attr_accessor :default_logger
 
       # @private
@@ -296,6 +295,7 @@ module Zeitwerk
       #
       #   require "zeitwerk"
       #   loader = Zeitwerk::Loader.new
+      #   loader.tag = File.basename(__FILE__, ".rb")
       #   loader.inflector = Zeitwerk::GemInflector.new
       #   loader.push_dir(__dir__)
       #
@@ -326,37 +326,6 @@ module Zeitwerk
 
     self.mutex = Mutex.new
 
-    # --- Callbacks -------------------------------------------------------------------------------
-
-    # Callback invoked from Kernel when a managed file is loaded.
-    #
-    # @private
-    # @param file [String]
-    # @return [void]
-    def on_file_loaded(file)
-      parent, cname = autoloads[file]
-      loaded.add(cpath(parent, cname))
-      log("constant #{cpath(parent, cname)} loaded from file #{file}") if logger
-    end
-
-    # Callback invoked from Kernel when a managed directory is loaded.
-    #
-    # @private
-    # @param dir [String]
-    # @return [void]
-    def on_dir_loaded(dir)
-      parent, cname = autoloads[dir]
-
-      autovivified_module = parent.const_set(cname, Module.new)
-      log("module #{autovivified_module.name} autovivified from directory #{dir}") if logger
-
-      loaded.add(autovivified_module.name)
-
-      if subdirs = lazy_subdirs[autovivified_module.name]
-        subdirs.each { |subdir| set_autoloads_in_dir(subdir, autovivified_module) }
-      end
-    end
-
     private # -------------------------------------------------------------------------------------
 
     # @return [<String>]
@@ -554,16 +523,18 @@ module Zeitwerk
     end
 
     def raise_if_conflicting_directory(dir)
-      Registry.loaders.each do |loader|
-        next if loader == self
-
-        loader.dirs.each do |already_managed_dir|
-          if dir.start_with?(already_managed_dir) || already_managed_dir.start_with?(dir)
-            require "pp"
-            raise ConflictingDirectory,
-              "loader\n\n#{pretty_inspect}\n\nwants to manage directory #{dir}," \
-              " which is already managed by\n\n#{loader.pretty_inspect}\n"
-            EOS
+      self.class.mutex.synchronize do
+        Registry.loaders.each do |loader|
+          next if loader == self
+
+          loader.dirs.each do |already_managed_dir|
+            if dir.start_with?(already_managed_dir) || already_managed_dir.start_with?(dir)
+              require "pp"
+              raise ConflictingDirectory,
+                "loader\n\n#{pretty_inspect}\n\nwants to manage directory #{dir}," \
+                " which is already managed by\n\n#{loader.pretty_inspect}\n"
+              EOS
+            end
           end
         end
       end

data/lib/zeitwerk/loader/callbacks.rb

@@ -0,0 +1,43 @@
+module Zeitwerk::Loader::Callbacks
+  # Invoked from our decorated Kernel#require when a managed file is autoloaded.
+  #
+  # @private
+  # @param file [String]
+  # @return [void]
+  def on_file_autoloaded(file)
+    parent, cname = autoloads[file]
+    loaded.add(cpath(parent, cname))
+    log("constant #{cpath(parent, cname)} loaded from file #{file}") if logger
+  end
+
+  # Invoked from our decorated Kernel#require when a managed directory is
+  # autoloaded.
+  #
+  # @private
+  # @param dir [String]
+  # @return [void]
+  def on_dir_autoloaded(dir)
+    parent, cname = autoloads[dir]
+
+    autovivified_module = parent.const_set(cname, Module.new)
+    log("module #{autovivified_module.name} autovivified from directory #{dir}") if logger
+
+    loaded.add(autovivified_module.name)
+    on_namespace_loaded(autovivified_module)
+  end
+
+  # Invoked when a class or module is created or reopened, either from the
+  # tracer or from module autovivification. If the namespace has matching
+  # subdirectories, we descend into them now.
+  #
+  # @private
+  # @param namespace [Module]
+  # @return [void]
+  def on_namespace_loaded(namespace)
+    if subdirs = lazy_subdirs.delete(namespace.name)
+      subdirs.each do |subdir|
+        set_autoloads_in_dir(subdir, namespace)
+      end
+    end
+  end
+end

data/lib/zeitwerk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeitwerk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Xavier Noria
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-02-23 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Zeitwerk implements constant autoloading with Ruby semantics. Each gem
@@ -27,6 +27,7 @@ files:
 - lib/zeitwerk/inflector.rb
 - lib/zeitwerk/kernel.rb
 - lib/zeitwerk/loader.rb
+- lib/zeitwerk/loader/callbacks.rb
 - lib/zeitwerk/registry.rb
 - lib/zeitwerk/version.rb
 homepage: https://github.com/fxn/zeitwerk