zeitwerk 2.7.2 → 2.7.3

data/lib/zeitwerk/loader/config.rb

@@ -7,10 +7,10 @@ module Zeitwerk::Loader::Config
   extend Zeitwerk::Internal
   include Zeitwerk::RealModName
 
-  # @sig #camelize
+  #: camelize(String, String) -> String
   attr_accessor :inflector
 
-  # @sig #call | #debug | nil
+  #: call(String) -> void | debug(String) -> void | nil
   attr_accessor :logger
 
   # Absolute paths of the root directories, mapped to their respective root namespaces:
@@ -25,14 +25,13 @@ module Zeitwerk::Loader::Config
   # This is a private collection maintained by the loader. The public
   # interface for it is `push_dir` and `dirs`.
   #
-  # @sig Hash[String, Module]
+  #: Hash[String, Module]
   attr_reader :roots
   internal :roots
 
-  # Absolute paths of files, directories, or glob patterns to be totally
-  # ignored.
+  # Absolute paths of files, directories, or glob patterns to be ignored.
   #
-  # @sig Set[String]
+  #: Set[String]
   attr_reader :ignored_glob_patterns
   private :ignored_glob_patterns
 
@@ -40,46 +39,46 @@ module Zeitwerk::Loader::Config
   # ignored glob patterns were expanded. Computed on setup, and recomputed on
   # reload.
   #
-  # @sig Set[String]
+  #: Set[String]
   attr_reader :ignored_paths
   private :ignored_paths
 
   # Absolute paths of directories or glob patterns to be collapsed.
   #
-  # @sig Set[String]
+  #: Set[String]
   attr_reader :collapse_glob_patterns
   private :collapse_glob_patterns
 
   # The actual collection of absolute directory names at the time the collapse
   # glob patterns were expanded. Computed on setup, and recomputed on reload.
   #
-  # @sig Set[String]
+  #: Set[String]
   attr_reader :collapse_dirs
   private :collapse_dirs
 
   # Absolute paths of files or directories not to be eager loaded.
   #
-  # @sig Set[String]
+  #: Set[String]
   attr_reader :eager_load_exclusions
   private :eager_load_exclusions
 
   # User-oriented callbacks to be fired on setup and on reload.
   #
-  # @sig Array[{ () -> void }]
+  #: Array[{ () -> void }]
   attr_reader :on_setup_callbacks
   private :on_setup_callbacks
 
   # User-oriented callbacks to be fired when a constant is loaded.
   #
-  # @sig Hash[String, Array[{ (top, String) -> void }]]
-  #      Hash[Symbol, Array[{ (String, top, String) -> void }]]
+  #: Hash[String, Array[{ (top, String) -> void }]]
+  #| Hash[Symbol, Array[{ (String, top, String) -> void }]]
   attr_reader :on_load_callbacks
   private :on_load_callbacks
 
   # User-oriented callbacks to be fired before constants are removed.
   #
-  # @sig Hash[String, Array[{ (top, String) -> void }]]
-  #      Hash[Symbol, Array[{ (String, top, String) -> void }]]
+  #: Hash[String, Array[{ (top, String) -> void }]]
+  #| Hash[Symbol, Array[{ (String, top, String) -> void }]]
   attr_reader :on_unload_callbacks
   private :on_unload_callbacks
 
@@ -106,8 +105,7 @@ module Zeitwerk::Loader::Config
   # the same process already manages that directory or one of its ascendants or
   # descendants.
   #
-  # @raise [Zeitwerk::Error]
-  # @sig (String | Pathname, Module) -> void
+  #: (String | Pathname, namespace: Module) -> void ! Zeitwerk::Error
   def push_dir(path, namespace: Object)
     unless namespace.is_a?(Module) # Note that Class < Module.
       raise Zeitwerk::Error, "#{namespace.inspect} is not a class or module object, should be"
@@ -131,14 +129,14 @@ module Zeitwerk::Loader::Config
   # Implemented as a method instead of via attr_reader for symmetry with the
   # writer below.
   #
-  # @sig () -> String
+  #: () -> String
   def tag
     @tag
   end
 
   # Sets a tag for the loader, useful for logging.
   #
-  # @sig (#to_s) -> void
+  #: (to_s() -> String) -> void
   def tag=(tag)
     @tag = tag.to_s
   end
@@ -152,7 +150,7 @@ module Zeitwerk::Loader::Config
   #
   # These are read-only collections, please add to them with `push_dir`.
   #
-  # @sig () -> Array[String] | Hash[String, Module]
+  #: (?namespaces: boolish, ?ignored: boolish) -> Array[String] | Hash[String, Module]
   def dirs(namespaces: false, ignored: false)
     if namespaces
       if ignored || ignored_paths.empty?
@@ -172,8 +170,7 @@ module Zeitwerk::Loader::Config
   # You need to call this method before setup in order to be able to reload.
   # There is no way to undo this, either you want to reload or you don't.
   #
-  # @raise [Zeitwerk::Error]
-  # @sig () -> void
+  #: () -> void ! Zeitwerk::Error
   def enable_reloading
     mutex.synchronize do
       break if @reloading_enabled
@@ -186,7 +183,7 @@ module Zeitwerk::Loader::Config
     end
   end
 
-  # @sig () -> bool
+  #: () -> bool
   def reloading_enabled?
     @reloading_enabled
   end
@@ -194,14 +191,14 @@ module Zeitwerk::Loader::Config
   # Let eager load ignore the given files or directories. The constants defined
   # in those files are still autoloadable.
   #
-  # @sig (*(String | Pathname | Array[String | Pathname])) -> void
+  #: (*(String | Pathname | Array[String | Pathname])) -> void
   def do_not_eager_load(*paths)
     mutex.synchronize { eager_load_exclusions.merge(expand_paths(paths)) }
   end
 
   # Configure files, directories, or glob patterns to be totally ignored.
   #
-  # @sig (*(String | Pathname | Array[String | Pathname])) -> void
+  #: (*(String | Pathname | Array[String | Pathname])) -> void
   def ignore(*glob_patterns)
     glob_patterns = expand_paths(glob_patterns)
     mutex.synchronize do
@@ -212,7 +209,7 @@ module Zeitwerk::Loader::Config
 
   # Configure directories or glob patterns to be collapsed.
   #
-  # @sig (*(String | Pathname | Array[String | Pathname])) -> void
+  #: (*(String | Pathname | Array[String | Pathname])) -> void
   def collapse(*glob_patterns)
     glob_patterns = expand_paths(glob_patterns)
     mutex.synchronize do
@@ -224,7 +221,7 @@ module Zeitwerk::Loader::Config
   # Configure a block to be called after setup and on each reload.
   # If setup was already done, the block runs immediately.
   #
-  # @sig () { () -> void } -> void
+  #: () { () -> void } -> void
   def on_setup(&block)
     mutex.synchronize do
       on_setup_callbacks << block
@@ -246,9 +243,7 @@ module Zeitwerk::Loader::Config
   #     # ...
   #   end
   #
-  # @raise [TypeError]
-  # @sig (String) { (top, String) -> void } -> void
-  #      (:ANY) { (String, top, String) -> void } -> void
+  #: (String?) { (top, String) -> void } -> void ! TypeError
   def on_load(cpath = :ANY, &block)
     raise TypeError, "on_load only accepts strings" unless cpath.is_a?(String) || cpath == :ANY
 
@@ -271,9 +266,7 @@ module Zeitwerk::Loader::Config
   #     # ...
   #   end
   #
-  # @raise [TypeError]
-  # @sig (String) { (top) -> void } -> void
-  #      (:ANY) { (String, top) -> void } -> void
+  #: (String?) { (top, String) -> void } -> void ! TypeError
   def on_unload(cpath = :ANY, &block)
     raise TypeError, "on_unload only accepts strings" unless cpath.is_a?(String) || cpath == :ANY
 
@@ -284,7 +277,7 @@ module Zeitwerk::Loader::Config
 
   # Logs to `$stdout`, handy shortcut for debugging.
   #
-  # @sig () -> void
+  #: () -> void
   def log!
     @logger = ->(msg) { puts msg }
   end
@@ -292,7 +285,7 @@ module Zeitwerk::Loader::Config
   # Returns true if the argument has been configured to be ignored, or is a
   # descendant of an ignored directory.
   #
-  # @sig (String) -> bool
+  #: (String) -> bool
   internal def ignores?(abspath)
     # Common use case.
     return false if ignored_paths.empty?
@@ -305,24 +298,24 @@ module Zeitwerk::Loader::Config
     false
   end
 
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def ignored_path?(abspath)
     ignored_paths.member?(abspath)
   end
 
-  # @sig () -> Array[String]
+  #: () -> Array[String]
   private def actual_roots
     roots.reject do |root_dir, _root_namespace|
       !dir?(root_dir) || ignored_path?(root_dir)
     end
   end
 
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def root_dir?(dir)
     roots.key?(dir)
   end
 
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def excluded_from_eager_load?(abspath)
     # Optimize this common use case.
     return false if eager_load_exclusions.empty?
@@ -335,29 +328,29 @@ module Zeitwerk::Loader::Config
     false
   end
 
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def collapse?(dir)
     collapse_dirs.member?(dir)
   end
 
-  # @sig (String | Pathname | Array[String | Pathname]) -> Array[String]
+  #: (String | Pathname | Array[String | Pathname]) -> Array[String]
   private def expand_paths(paths)
     paths.flatten.map! { |path| File.expand_path(path) }
   end
 
-  # @sig (Array[String]) -> Array[String]
+  #: (Array[String]) -> Array[String]
   private def expand_glob_patterns(glob_patterns)
     # Note that Dir.glob works with regular file names just fine. That is,
     # glob patterns technically need no wildcards.
     glob_patterns.flat_map { |glob_pattern| Dir.glob(glob_pattern) }
   end
 
-  # @sig () -> void
+  #: () -> void
   private def recompute_ignored_paths
     ignored_paths.replace(expand_glob_patterns(ignored_glob_patterns))
   end
 
-  # @sig () -> void
+  #: () -> void
   private def recompute_collapse_dirs
     collapse_dirs.replace(expand_glob_patterns(collapse_glob_patterns))
   end

data/lib/zeitwerk/loader/eager_load.rb

@@ -5,7 +5,7 @@ module Zeitwerk::Loader::EagerLoad
   # specific files and directories with `do_not_eager_load`, and that can be
   # overridden passing `force: true`.
   #
-  # @sig (true | false) -> void
+  #: (?force: boolish) -> void
   def eager_load(force: false)
     mutex.synchronize do
       break if @eager_loaded
@@ -18,7 +18,7 @@ module Zeitwerk::Loader::EagerLoad
       end
 
       autoloaded_dirs.each do |autoloaded_dir|
-        Zeitwerk::Registry.unregister_autoload(autoloaded_dir)
+        Zeitwerk::Registry.autoloads.unregister(autoloaded_dir)
       end
       autoloaded_dirs.clear
 
@@ -28,7 +28,7 @@ module Zeitwerk::Loader::EagerLoad
     end
   end
 
-  # @sig (String | Pathname) -> void
+  #: (String | Pathname) -> void
   def eager_load_dir(path)
     raise Zeitwerk::SetupRequired unless @setup
 
@@ -70,7 +70,7 @@ module Zeitwerk::Loader::EagerLoad
     actual_eager_load_dir(abspath, namespace)
   end
 
-  # @sig (Module) -> void
+  #: (Module) -> void
   def eager_load_namespace(mod)
     raise Zeitwerk::SetupRequired unless @setup
 
@@ -112,7 +112,7 @@ module Zeitwerk::Loader::EagerLoad
   # The method is implemented as `constantize` for files, in a sense, to be able
   # to descend orderly and make sure the file is loadable.
   #
-  # @sig (String | Pathname) -> void
+  #: (String | Pathname) -> void
   def load_file(path)
     abspath = File.expand_path(path)
 
@@ -156,7 +156,7 @@ module Zeitwerk::Loader::EagerLoad
   # The caller is responsible for making sure `namespace` is the namespace that
   # corresponds to `dir`.
   #
-  # @sig (String, Module, Boolean) -> void
+  #: (String, Module, ?force: boolish) -> void
   private def actual_eager_load_dir(dir, namespace, force: false)
     honour_exclusions = !force
     return if honour_exclusions && excluded_from_eager_load?(dir)
@@ -189,7 +189,7 @@ module Zeitwerk::Loader::EagerLoad
   # In order to invoke this method, the caller has to ensure `child` is a
   # strict namespace descendant of `root_namespace`.
   #
-  # @sig (Module, String, Module, Boolean) -> void
+  #: (Module, String, String, Module) -> void
   private def eager_load_child_namespace(child, child_name, root_dir, root_namespace)
     suffix = child_name
     unless root_namespace.equal?(Object)

data/lib/zeitwerk/loader/helpers.rb

@@ -3,7 +3,7 @@
 module Zeitwerk::Loader::Helpers
   # --- Logging -----------------------------------------------------------------------------------
 
-  # @sig (String) -> void
+  #: (to_s() -> String) -> void
   private def log(message)
     method_name = logger.respond_to?(:debug) ? :debug : :call
     logger.send(method_name, "Zeitwerk@#{tag}: #{message}")
@@ -11,7 +11,7 @@ module Zeitwerk::Loader::Helpers
 
   # --- Files and directories ---------------------------------------------------------------------
 
-  # @sig (String) { (String, String) -> void } -> void
+  #: (String) { (String, String, Symbol) -> void } -> void
   private def ls(dir)
     children = Dir.children(dir)
 
@@ -52,7 +52,7 @@ module Zeitwerk::Loader::Helpers
   # important to list as less directories as possible and return fast in the
   # common case in which there are Ruby files.
   #
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def has_at_least_one_ruby_file?(dir)
     to_visit = [dir]
 
@@ -74,22 +74,22 @@ module Zeitwerk::Loader::Helpers
     false
   end
 
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def ruby?(path)
     path.end_with?(".rb")
   end
 
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def dir?(path)
     File.directory?(path)
   end
 
-  # @sig (String) -> bool
+  #: (String) -> bool
   private def hidden?(basename)
     basename.start_with?(".")
   end
 
-  # @sig (String) { (String) -> void } -> void
+  #: (String) { (String) -> void } -> void
   private def walk_up(abspath)
     loop do
       yield abspath
@@ -100,11 +100,10 @@ module Zeitwerk::Loader::Helpers
 
   # --- Inflection --------------------------------------------------------------------------------
 
-  CNAME_VALIDATOR = Module.new
+  CNAME_VALIDATOR = Module.new #: Module
   private_constant :CNAME_VALIDATOR
 
-  # @raise [Zeitwerk::NameError]
-  # @sig (String, String) -> Symbol
+  #: (String, String) -> Symbol ! Zeitwerk::NameError
   private def cname_for(basename, abspath)
     cname = inflector.camelize(basename, abspath)