zeitwerk 2.7.1 → 2.7.3

data/lib/zeitwerk/loader.rb

@@ -18,7 +18,7 @@ module Zeitwerk
     include Config
     include EagerLoad
 
-    MUTEX = Mutex.new
+    MUTEX = Mutex.new #: Mutex
     private_constant :MUTEX
 
     # Maps absolute paths for which an autoload has been set ---and not
@@ -28,72 +28,79 @@ module Zeitwerk
     #   "/Users/fxn/blog/app/models/hotel/pricing.rb" => #<Zeitwerk::Cref:... @mod=Hotel, @cname=:Pricing, ...>,
     #   ...
     #
-    # @sig Hash[String, Zeitwerk::Cref]
+    #: Hash[String, Zeitwerk::Cref]
     attr_reader :autoloads
     internal :autoloads
 
+    # When the path passed to Module#autoload is in the stack of features being
+    # loaded at the moment, Ruby passes. For example, Module#autoload? returns
+    # `nil` even if the autoload has not been attempted. See
+    #
+    #     https://bugs.ruby-lang.org/issues/21035
+    #
+    # We call these "inceptions".
+    #
+    # A common case is the entry point of gems managed by Zeitwerk. Their main
+    # file is normally required and, while doing so, the loader sets an autoload
+    # on the gem namespace. That autoload hits this edge case.
+    #
+    # There is some logic that neeeds to know if an autoload for a given
+    # constant already exists. We check Module#autoload? first, and fallback to
+    # the inceptions just in case.
+    #
+    # This map keeps track of pairs (cref, autoload_path) found by the loader.
+    # The object Zeitwerk::Registry.inceptions, on the other hand, acts as a
+    # global registry for them.
+    #
+    #: Zeitwerk::Cref::Map[String]
+    attr_reader :inceptions
+    internal :inceptions
+
     # We keep track of autoloaded directories to remove them from the registry
     # at the end of eager loading.
     #
     # Files are removed as they are autoloaded, but directories need to wait due
     # to concurrency (see why in Zeitwerk::Loader::Callbacks#on_dir_autoloaded).
     #
-    # @sig Array[String]
+    #: Array[String]
     attr_reader :autoloaded_dirs
     internal :autoloaded_dirs
 
-    # Stores metadata needed for unloading. Its entries look like this:
-    #
-    #   "Admin::Role" => [
-    #     ".../admin/role.rb",
-    #     #<Zeitwerk::Cref:... @mod=Admin, @cname=:Role, ...>
-    #   ]
-    #
-    # The cpath as key helps implementing unloadable_cpath? The file name is
-    # stored in order to be able to delete it from $LOADED_FEATURES, and the
-    # cref is used to remove the constant from the parent class or module.
+    # If reloading is enabled, this collection maps autoload paths to their
+    # autoloaded crefs.
     #
-    # If reloading is enabled, this hash is filled as constants are autoloaded
-    # or eager loaded. Otherwise, the collection remains empty.
+    # On unload, the autoload paths are passed to callbacks, files deleted from
+    # $LOADED_FEATURES, and the crefs are deleted.
     #
-    # @sig Hash[String, [String, Zeitwerk::Cref]]
+    #: Hash[String, Zeitwerk::Cref]
     attr_reader :to_unload
     internal :to_unload
 
-    # Maps namespace constant paths to their respective directories.
+    # Maps namespace crefs to the directories that conform the namespace.
     #
-    # For example, given this mapping:
+    # When these crefs get defined we know their children are spread over those
+    # directories. We'll visit them to set up the corresponding autoloads.
     #
-    #   "Admin" => [
-    #     "/Users/fxn/blog/app/controllers/admin",
-    #     "/Users/fxn/blog/app/models/admin",
-    #     ...
-    #   ]
-    #
-    # when `Admin` gets defined we know that it plays the role of a namespace
-    # and that its children are spread over those directories. We'll visit them
-    # to set up the corresponding autoloads.
-    #
-    # @sig Hash[String, Array[String]]
+    #: Zeitwerk::Cref::Map[String]
     attr_reader :namespace_dirs
     internal :namespace_dirs
 
     # A shadowed file is a file managed by this loader that is ignored when
     # setting autoloads because its matching constant is already taken.
     #
-    # This private set is populated as we descend. For example, if the loader
-    # has only scanned the top-level, `shadowed_files` does not have shadowed
-    # files that may exist deep in the project tree yet.
+    # This private set is populated lazily, as we descend. For example, if the
+    # loader has only scanned the top-level, `shadowed_files` does not have the
+    # shadowed files that may exist deep in the project tree.
     #
-    # @sig Set[String]
+    #: Set[String]
     attr_reader :shadowed_files
     internal :shadowed_files
 
-    # @sig Mutex
+    #: Mutex
     attr_reader :mutex
     private :mutex
 
-    # @sig Monitor
+    #: Monitor
     attr_reader :dirs_autoload_monitor
     private :dirs_autoload_monitor
 
@@ -101,9 +108,10 @@ module Zeitwerk
       super
 
       @autoloads       = {}
+      @inceptions      = Zeitwerk::Cref::Map.new
       @autoloaded_dirs = []
       @to_unload       = {}
-      @namespace_dirs  = Hash.new { |h, cpath| h[cpath] = [] }
+      @namespace_dirs  = Zeitwerk::Cref::Map.new
       @shadowed_files  = Set.new
       @setup           = false
       @eager_loaded    = false
@@ -111,12 +119,12 @@ module Zeitwerk
       @mutex = Mutex.new
       @dirs_autoload_monitor = Monitor.new
 
-      Registry.register_loader(self)
+      Registry.loaders.register(self)
     end
 
     # Sets autoloads in the root namespaces.
     #
-    # @sig () -> void
+    #: () -> void
     def setup
       mutex.synchronize do
         break if @setup
@@ -142,7 +150,7 @@ module Zeitwerk
     # means `unload` + `setup`. This one is available to be used together with
     # `unregister`, which is undocumented too.
     #
-    # @sig () -> void
+    #: () -> void
     def unload
       mutex.synchronize do
         raise SetupRequired unless @setup
@@ -167,7 +175,7 @@ module Zeitwerk
           end
         end
 
-        to_unload.each do |cpath, (abspath, cref)|
+        to_unload.each do |abspath, cref|
           unless on_unload_callbacks.empty?
             begin
               value = cref.get
@@ -176,7 +184,7 @@ module Zeitwerk
               # autoload failed to define the expected constant but the user
               # rescued the exception.
             else
-              run_on_unload_callbacks(cpath, value, abspath)
+              run_on_unload_callbacks(cref, value, abspath)
             end
           end
 
@@ -205,8 +213,10 @@ module Zeitwerk
         namespace_dirs.clear
         shadowed_files.clear
 
-        Registry.on_unload(self)
-        ExplicitNamespace.__unregister_loader(self)
+        unregister_inceptions
+        unregister_explicit_namespaces
+
+        Registry.autoloads.unregister_loader(self)
 
         @setup        = false
         @eager_loaded = false
@@ -219,8 +229,7 @@ module Zeitwerk
     # This method is not thread-safe, please see how this can be achieved by
     # client code in the README of the project.
     #
-    # @raise [Zeitwerk::Error]
-    # @sig () -> void
+    #: () -> void ! Zeitwerk::Error
     def reload
       raise ReloadingDisabledError unless reloading_enabled?
       raise SetupRequired unless @setup
@@ -234,7 +243,7 @@ module Zeitwerk
     # Returns a hash that maps the absolute paths of the managed files and
     # directories to their respective expected constant paths.
     #
-    # @sig () -> Hash[String, String]
+    #: () -> Hash[String, String]
     def all_expected_cpaths
       result = {}
 
@@ -264,7 +273,7 @@ module Zeitwerk
       result
     end
 
-    # @sig (String | Pathname) -> String?
+    #: (String | Pathname) -> String?
     def cpath_expected_at(path)
       abspath = File.expand_path(path)
 
@@ -294,7 +303,7 @@ module Zeitwerk
         basename = File.basename(dir)
         return if hidden?(basename)
 
-        paths << [basename, abspath] unless collapse?(dir)
+        paths << [basename, dir] unless collapse?(dir)
       end
 
       return unless root_namespace
@@ -302,7 +311,7 @@ module Zeitwerk
       if paths.empty?
         real_mod_name(root_namespace)
       else
-        cnames = paths.reverse_each.map { |b, a| cname_for(b, a) }
+        cnames = paths.reverse_each.map { cname_for(_1, _2) }
 
         if root_namespace == Object
           cnames.join("::")
@@ -315,32 +324,41 @@ module Zeitwerk
     # Says if the given constant path would be unloaded on reload. This
     # predicate returns `false` if reloading is disabled.
     #
-    # @sig (String) -> bool
+    # This is an undocumented method that I wrote to help transition from the
+    # classic autoloader in Rails. Its usage was removed from Rails in 7.0.
+    #
+    #: (String) -> bool
     def unloadable_cpath?(cpath)
-      to_unload.key?(cpath)
+      unloadable_cpaths.include?(cpath)
     end
 
     # Returns an array with the constant paths that would be unloaded on reload.
     # This predicate returns an empty array if reloading is disabled.
     #
-    # @sig () -> Array[String]
+    # This is an undocumented method that I wrote to help transition from the
+    # classic autoloader in Rails. Its usage was removed from Rails in 7.0.
+    #
+    #: () -> Array[String]
     def unloadable_cpaths
-      to_unload.keys.freeze
+      to_unload.values.map(&:path)
     end
 
     # This is a dangerous method.
     #
     # @experimental
-    # @sig () -> void
+    #: () -> void
     def unregister
+      unregister_inceptions
+      unregister_explicit_namespaces
+      Registry.loaders.unregister(self)
+      Registry.autoloads.unregister_loader(self)
       Registry.unregister_loader(self)
-      ExplicitNamespace.__unregister_loader(self)
     end
 
     # The return value of this predicate is only meaningful if the loader has
     # scanned the file. This is the case in the spots where we use it.
     #
-    # @sig (String) -> Boolean
+    #: (String) -> bool
     internal def shadowed_file?(file)
       shadowed_files.member?(file)
     end
@@ -350,7 +368,7 @@ module Zeitwerk
     class << self
       include RealModName
 
-      # @sig #call | #debug | nil
+      #: call(String) -> void | debug(String) -> void | nil
       attr_accessor :default_logger
 
       # This is a shortcut for
@@ -368,7 +386,7 @@ module Zeitwerk
       # This method returns a subclass of Zeitwerk::Loader, but the exact type
       # is private, client code can only rely on the interface.
       #
-      # @sig (bool) -> Zeitwerk::GemLoader
+      #: (?warn_on_extra_files: boolish) -> Zeitwerk::GemLoader
       def for_gem(warn_on_extra_files: true)
         called_from = caller_locations(1, 1).first.path
         Registry.loader_for_gem(called_from, namespace: Object, warn_on_extra_files: warn_on_extra_files)
@@ -389,7 +407,7 @@ module Zeitwerk
       # This method returns a subclass of Zeitwerk::Loader, but the exact type
       # is private, client code can only rely on the interface.
       #
-      # @sig (bool) -> Zeitwerk::GemLoader
+      #: (Module) -> Zeitwerk::GemLoader
       def for_gem_extension(namespace)
         unless namespace.is_a?(Module) # Note that Class < Module.
           raise Zeitwerk::Error, "#{namespace.inspect} is not a class or module object, should be"
@@ -406,7 +424,7 @@ module Zeitwerk
       # Broadcasts `eager_load` to all loaders. Those that have not been setup
       # are skipped.
       #
-      # @sig () -> void
+      #: () -> void
       def eager_load_all
         Registry.loaders.each do |loader|
           begin
@@ -420,7 +438,7 @@ module Zeitwerk
       # Broadcasts `eager_load_namespace` to all loaders. Those that have not
       # been setup are skipped.
       #
-      # @sig (Module) -> void
+      #: (Module) -> void
       def eager_load_namespace(mod)
         Registry.loaders.each do |loader|
           begin
@@ -434,13 +452,17 @@ module Zeitwerk
       # Returns an array with the absolute paths of the root directories of all
       # registered loaders. This is a read-only collection.
       #
-      # @sig () -> Array[String]
+      #: () -> Array[String]
       def all_dirs
-        Registry.loaders.flat_map(&:dirs).freeze
+        dirs = []
+        Registry.loaders.each do |loader|
+          dirs.concat(loader.dirs)
+        end
+        dirs.freeze
       end
     end
 
-    # @sig (String, Module) -> void
+    #: (String, Module) -> void
     private def define_autoloads_for_dir(dir, parent)
       ls(dir) do |basename, abspath, ftype|
         if ftype == :file
@@ -458,7 +480,7 @@ module Zeitwerk
       end
     end
 
-    # @sig (Module, Symbol, String) -> void
+    #: (Zeitwerk::Cref, String) -> void
     private def autoload_subdir(cref, subdir)
       if autoload_path = autoload_path_set_by_me_for?(cref)
         if ruby?(autoload_path)
@@ -474,22 +496,22 @@ module Zeitwerk
         # If the existing autoload points to a file, it has to be preserved, if
         # not, it is fine as it is. In either case, we do not need to override.
         # Just remember the subdirectory conforms this namespace.
-        namespace_dirs[cref.path] << subdir
+        namespace_dirs.get_or_set(cref) { [] } << subdir
       elsif !cref.defined?
         # First time we find this namespace, set an autoload for it.
-        namespace_dirs[cref.path] << subdir
+        namespace_dirs.get_or_set(cref) { [] } << subdir
         define_autoload(cref, subdir)
       else
         # For whatever reason the constant that corresponds to this namespace has
         # already been defined, we have to recurse.
-        log("the namespace #{cref.path} already exists, descending into #{subdir}") if logger
+        log("the namespace #{cref} already exists, descending into #{subdir}") if logger
         define_autoloads_for_dir(subdir, cref.get)
       end
     end
 
-    # @sig (Module, Symbol, String) -> void
+    #: (Zeitwerk::Cref, String) -> void
     private def autoload_file(cref, file)
-      if autoload_path = cref.autoload? || Registry.inception?(cref.path)
+      if autoload_path = cref.autoload? || Registry.inceptions.registered?(cref)
         # First autoload for a Ruby file wins, just ignore subsequent ones.
         if ruby?(autoload_path)
           shadowed_files << file
@@ -499,7 +521,7 @@ module Zeitwerk
         end
       elsif cref.defined?
         shadowed_files << file
-        log("file #{file} is ignored because #{cref.path} is already defined") if logger
+        log("file #{file} is ignored because #{cref} is already defined") if logger
       else
         define_autoload(cref, file)
       end
@@ -508,12 +530,12 @@ module Zeitwerk
     # `dir` is the directory that would have autovivified a namespace. `file` is
     # the file where we've found the namespace is explicitly defined.
     #
-    # @sig (dir: String, file: String, cref: Zeitwerk::Cref) -> void
+    #: (dir: String, file: String, cref: Zeitwerk::Cref) -> void
     private def promote_namespace_from_implicit_to_explicit(dir:, file:, cref:)
       autoloads.delete(dir)
-      Registry.unregister_autoload(dir)
+      Registry.autoloads.unregister(dir)
 
-      log("earlier autoload for #{cref.path} discarded, it is actually an explicit namespace defined in #{file}") if logger
+      log("earlier autoload for #{cref} discarded, it is actually an explicit namespace defined in #{file}") if logger
 
       # Order matters: When Module#const_added is triggered by the autoload, we
       # don't want the namespace to be registered yet.
@@ -521,42 +543,58 @@ module Zeitwerk
       register_explicit_namespace(cref)
     end
 
-    # @sig (Module, Symbol, String) -> void
+    #: (Zeitwerk::Cref, String) -> void
     private def define_autoload(cref, abspath)
       cref.autoload(abspath)
 
       if logger
         if ruby?(abspath)
-          log("autoload set for #{cref.path}, to be loaded from #{abspath}")
+          log("autoload set for #{cref}, to be loaded from #{abspath}")
         else
-          log("autoload set for #{cref.path}, to be autovivified from #{abspath}")
+          log("autoload set for #{cref}, to be autovivified from #{abspath}")
         end
       end
 
       autoloads[abspath] = cref
-      Registry.register_autoload(self, abspath)
+      Registry.autoloads.register(abspath, self)
 
-      # See why in the documentation of Zeitwerk::Registry.inceptions.
-      unless cref.autoload?
-        Registry.register_inception(cref.path, abspath, self)
-      end
+      register_inception(cref, abspath) unless cref.autoload?
     end
 
-    # @sig (Module, Symbol) -> String?
+    #: (Zeitwerk::Cref) -> String?
     private def autoload_path_set_by_me_for?(cref)
       if autoload_path = cref.autoload?
         autoload_path if autoloads.key?(autoload_path)
       else
-        Registry.inception?(cref.path, self)
+        inceptions[cref]
       end
     end
 
-    # @sig (Zeitwerk::Cref) -> void
+    #: (Zeitwerk::Cref) -> void
     private def register_explicit_namespace(cref)
-      ExplicitNamespace.__register(cref, self)
+      Registry.explicit_namespaces.register(cref, self)
+    end
+
+    #: () -> void
+    private def unregister_explicit_namespaces
+      Registry.explicit_namespaces.unregister_loader(self)
+    end
+
+    #: (Zeitwerk::Cref, String) -> void
+    private def register_inception(cref, abspath)
+      inceptions[cref] = abspath
+      Registry.inceptions.register(cref, abspath)
+    end
+
+    #: () -> void
+    private def unregister_inceptions
+      inceptions.each_key do |cref|
+        Registry.inceptions.unregister(cref)
+      end
+      inceptions.clear
     end
 
-    # @sig (String) -> void
+    #: (String) -> void
     private def raise_if_conflicting_directory(dir)
       MUTEX.synchronize do
         dir_slash = dir + "/"
@@ -580,20 +618,20 @@ module Zeitwerk
       end
     end
 
-    # @sig (String, Object, String) -> void
-    private def run_on_unload_callbacks(cpath, value, abspath)
+    #: (String, top, String) -> void
+    private def run_on_unload_callbacks(cref, value, abspath)
       # Order matters. If present, run the most specific one.
-      on_unload_callbacks[cpath]&.each { |c| c.call(value, abspath) }
-      on_unload_callbacks[:ANY]&.each { |c| c.call(cpath, value, abspath) }
+      on_unload_callbacks[cref.path]&.each { |c| c.call(value, abspath) }
+      on_unload_callbacks[:ANY]&.each { |c| c.call(cref.path, value, abspath) }
     end
 
-    # @sig (Module, Symbol) -> void
+    #: (Zeitwerk::Cref) -> void
     private def unload_autoload(cref)
       cref.remove
-      log("autoload for #{cref.path} removed") if logger
+      log("autoload for #{cref} removed") if logger
     end
 
-    # @sig (Module, Symbol) -> void
+    #: (Zeitwerk::Cref) -> void
     private def unload_cref(cref)
       # Let's optimistically remove_const. The way we use it, this is going to
       # succeed always if all is good.
@@ -602,7 +640,7 @@ module Zeitwerk
       # There are a few edge scenarios in which this may happen. If the constant
       # is gone, that is OK, anyway.
     else
-      log("#{cref.path} unloaded") if logger
+      log("#{cref} unloaded") if logger
     end
   end
 end

data/lib/zeitwerk/null_inflector.rb

@@ -1,4 +1,5 @@
 class Zeitwerk::NullInflector
+  #: (String, String) -> String
   def camelize(basename, _abspath)
     basename
   end

data/lib/zeitwerk/real_mod_name.rb

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
 module Zeitwerk::RealModName
+  #: UnboundMethod
   UNBOUND_METHOD_MODULE_NAME = Module.instance_method(:name)
   private_constant :UNBOUND_METHOD_MODULE_NAME
 
-  # Returns the real name of the class or module, as set after the first
-  # constant to which it was assigned (or nil).
+  # Returns the real name of the class or module.
   #
-  # The name method can be overridden, hence the indirection in this method.
+  # We need this indirection becasue the `name` method can be overridden, and
+  # because in practice what we really need is the constant paths of modules
+  # with a permanent name, not so much what the user considers to be the name of
+  # a certain class or module of theirs.
   #
-  # @sig (Module) -> String?
+  #: (Module) -> String?
   def real_mod_name(mod)
     UNBOUND_METHOD_MODULE_NAME.bind_call(mod)
   end

data/lib/zeitwerk/registry/autoloads.rb

@@ -0,0 +1,38 @@
+module Zeitwerk::Registry
+  class Autoloads # :nodoc:
+    #: () -> void
+    def initialize
+      @autoloads = {} #: Hash[String, Zeitwerk::Loader]
+    end
+
+    #: (String, Zeitwerk::Loader) -> Zeitwerk::Loader
+    def register(abspath, loader)
+      @autoloads[abspath] = loader
+    end
+
+    #: (String) -> Zeitwerk::Loader?
+    def registered?(path)
+      @autoloads[path]
+    end
+
+    #: (String) -> Zeitwerk::Loader?
+    def unregister(abspath)
+      @autoloads.delete(abspath)
+    end
+
+    #: (Zeitwerk::Loader) -> void
+    def unregister_loader(loader)
+      @autoloads.delete_if { _2 == loader }
+    end
+
+    #: () -> bool
+    def empty? # for tests
+      @autoloads.empty?
+    end
+
+    #: () -> void
+    def clear # for tests
+      @autoloads.clear
+    end
+  end
+end

data/lib/zeitwerk/registry/explicit_namespaces.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Zeitwerk::Registry
+  # A registry for explicit namespaces.
+  #
+  # When a loader determines that a certain file should define an explicit
+  # namespace, it registers it here, associating its cref with itself.
+  #
+  # If the namespace is autoloaded, our const_added callback retrieves its
+  # loader by calling loader_for. That way, the loader is able to scan the
+  # subdirectories that conform the namespace and set autoloads for their
+  # expected constants just in time.
+  #
+  # Once autoloaded, the namespace is unregistered.
+  #
+  # The implementation assumes an explicit namespace is managed by one loader.
+  # Loaders that reopen namespaces owned by other projects are responsible for
+  # loading their constant before setup. This is documented.
+  #
+  # **This is a private module.**
+  class ExplicitNamespaces # :nodoc: all
+    #: () -> void
+    def initialize
+      # Maps crefs of explicit namespaces with their corresponding loader.
+      #
+      # Entries are added as the namespaces are found, and removed as they are
+      # autoloaded.
+      @loaders = Zeitwerk::Cref::Map.new
+    end
+
+    # Registers `cref` as being the constant path of an explicit namespace
+    # managed by `loader`.
+    #
+    #: (Zeitwerk::Cref, Zeitwerk::Loader) -> void
+    def register(cref, loader)
+      @loaders[cref] = loader
+    end
+
+    #: (Module, Symbol) -> Zeitwerk::Loader?
+    def loader_for(mod, cname)
+      @loaders.delete_mod_cname(mod, cname)
+    end
+
+    #: (Zeitwerk::Loader) -> void
+    def unregister_loader(loader)
+      @loaders.delete_by_value(loader)
+    end
+
+    # This is an internal method only used by the test suite.
+    #
+    #: (Zeitwerk::Cref) -> Zeitwerk::Loader?
+    def registered?(cref)
+      @loaders[cref]
+    end
+
+    #: () -> void
+    def clear # for tests
+      @loaders.clear
+    end
+  end
+end

data/lib/zeitwerk/registry/inceptions.rb

@@ -0,0 +1,31 @@
+module Zeitwerk::Registry
+  # Loaders know their own inceptions, but there is a use case in which we need
+  # to know if a given cpath is an inception globally. This is what this
+  # registry is for.
+  class Inceptions # :nodoc:
+    #: () -> void
+    def initialize
+      @inceptions = Zeitwerk::Cref::Map.new #: Zeitwerk::Cref::Map[String]
+    end
+
+    #: (Zeitwerk::Cref, String) -> void
+    def register(cref, abspath)
+      @inceptions[cref] = abspath
+    end
+
+    #: (Zeitwerk::Cref) -> String?
+    def registered?(cref)
+      @inceptions[cref]
+    end
+
+    #: (Zeitwerk::Cref) -> void
+    def unregister(cref)
+      @inceptions.delete(cref)
+    end
+
+    #: () -> void
+    def clear # for tests
+      @inceptions.clear
+    end
+  end
+end