zeitwerk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c90642ff8bbe719548f2a2162ef64b04361721aa065672bacc725888bfb8acc2
-  data.tar.gz: e384c4c48e4ed72d3a0159db2c12da95e39758f6949dafd61e480323a9fe0cc7
+  metadata.gz: ce0c3d755356cd98361bd89b27925a3083632a8e2f25191808e987d0f5a0c40e
+  data.tar.gz: fb21b9d8e59e12b672a464e748157814c265898da26a71225229f29d9ea9023f
 SHA512:
-  metadata.gz: aee756c82fbb8de50d7a1e5f44f9b4fcb64bde85793f9dbdf17b4c903a9a8df131c85afa55832bcbb677673731f9425bea9925af883c717e47b0cca1735fdae5
-  data.tar.gz: 9057fddb2d0ee012e7d2591e01515db4bc0cddbdc67e267e4b844d984d555f7e2ed918f3c24076f93820c66bc21d5ec1f7c3b7898e03fd2672fc660ba995190a
+  metadata.gz: b3fa972c877ed3c36efc98224088869ec383370bbf002761e0f379550ce31e50cf387a729890fd36e4768d99929a566ef3587a717208aa7d6e8e7abb1c29df1b
+  data.tar.gz: ab0b2b3e11d46e21ce3605f8dcf8dcb6a579ca6ce7438c58d6b87d07f1431f4c346bdc07d5c1ae9601a577d5c592e938f07a56fe583b8fa27a308371afca4fea

data/README.md

@@ -22,6 +22,7 @@
             - [Zeitwerk::GemInflector](#zeitwerkgeminflector)
             - [Custom inflector](#custom-inflector)
         - [Logging](#logging)
+            - [Loader tag](#loader-tag)
         - [Ignoring parts of the project](#ignoring-parts-of-the-project)
             - [Files that do not follow the conventions](#files-that-do-not-follow-the-conventions)
             - [The adapter pattern](#the-adapter-pattern)
@@ -297,8 +298,34 @@ loader.logger = method(:puts)
 
 If there is a logger configured, the loader is going to print traces when autoloads are set, files loaded, and modules autovivified. While reloading, removed autoloads and unloaded objects are also traced.
 
+It is possible to set a global default this way:
+
+```ruby
+Zeitwerk::Loader.default_logger = method(:puts)
+```
+
 If your project has namespaces, you'll notice in the traces Zeitwerk sets autoloads for _directories_. That's a technique used to be able to descend into subdirectories on demand, avoiding that way unnecessary tree walks.
 
+#### Loader tag
+
+Loaders have a tag that is printed in traces in order to be able to distinguish them in globally logged activity:
+
+```
+Zeitwerk@9fa54b: autoload set for User, to be loaded from ...
+```
+
+By default, a random tag like the one above is assigned, but you can change it:
+
+```
+loader.tag = "grep_me"
+```
+
+The tag of a loader returned by `for_gem` is the basename of the root file without extension:
+
+```
+Zeitwerk@my_gem: constant MyGem::Foo loaded from ...
+```
+
 ### Ignoring parts of the project
 
 Zeitwerk ignores automatically any file or directory whose name starts with a dot, and any files that do not have extension ".rb".

data/lib/zeitwerk/loader.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require "set"
+require "securerandom"
 
 module Zeitwerk
   class Loader
+    # @return [String]
+    attr_reader :tag
+
     # @return [#camelize]
     attr_accessor :inflector
 
@@ -94,7 +98,9 @@ module Zeitwerk
     attr_reader :tracer
 
     def initialize
-      self.inflector = Inflector.new
+      @tag       = SecureRandom.hex(3)
+      @inflector = Inflector.new
+      @logger    = self.class.default_logger
 
       @root_dirs     = {}
       @preloads      = []
@@ -119,6 +125,13 @@ module Zeitwerk
       Registry.register_loader(self)
     end
 
+    # Sets a tag for the loader, useful for logging.
+    #
+    # @return [void]
+    def tag=(tag)
+      @tag = tag.to_s
+    end
+
     # Absolute paths of the root directories. This is a read-only collection,
     # please push here via `push_dir`.
     #
@@ -150,13 +163,7 @@ module Zeitwerk
       mutex.synchronize do
         expand_paths(paths).each do |abspath|
           preloads << abspath
-          if @setup
-            if ruby?(abspath)
-              do_preload_file(abspath)
-            elsif dir?(abspath)
-              do_preload_dir(abspath)
-            end
-          end
+          do_preload_abspath(abspath) if @setup
         end
       end
     end
@@ -264,35 +271,40 @@ module Zeitwerk
 
     # --- Class methods ---------------------------------------------------------------------------
 
-    # This is a shortcut for
-    #
-    #   require "zeitwerk"
-    #   loader = Zeitwerk::Loader.new
-    #   loader.inflector = Zeitwerk::GemInflector.new
-    #   loader.push_dir(__dir__)
-    #
-    # except that this method returns the same object in subsequent calls from
-    # the same file, in the unlikely case the gem wants to be able to reload.
-    #
-    # @return [Zeitwerk::Loader]
-    def self.for_gem
-      called_from = caller[0].split(':')[0]
-      Registry.loader_for_gem(called_from)
-    end
+    class << self
+      # @return [#call, nil]
+      attr_accessor :default_logger
+
+      # This is a shortcut for
+      #
+      #   require "zeitwerk"
+      #   loader = Zeitwerk::Loader.new
+      #   loader.inflector = Zeitwerk::GemInflector.new
+      #   loader.push_dir(__dir__)
+      #
+      # except that this method returns the same object in subsequent calls from
+      # the same file, in the unlikely case the gem wants to be able to reload.
+      #
+      # @return [Zeitwerk::Loader]
+      def for_gem
+        called_from = caller[0].split(':')[0]
+        Registry.loader_for_gem(called_from)
+      end
 
-    # Broadcasts `eager_load` to all loaders.
-    #
-    # @return [void]
-    def self.eager_load_all
-      Registry.loaders.each(&:eager_load)
-    end
+      # Broadcasts `eager_load` to all loaders.
+      #
+      # @return [void]
+      def eager_load_all
+        Registry.loaders.each(&:eager_load)
+      end
 
-    # Returns an array with the absolute paths of the root directories of all
-    # registered loaders. This is a read-only collection.
-    #
-    # @return [<String>]
-    def self.all_dirs
-      Registry.loaders.flat_map(&:dirs).freeze
+      # Returns an array with the absolute paths of the root directories of all
+      # registered loaders. This is a read-only collection.
+      #
+      # @return [<String>]
+      def all_dirs
+        Registry.loaders.flat_map(&:dirs).freeze
+      end
     end
 
     # --- Callbacks -------------------------------------------------------------------------------
@@ -352,7 +364,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @paran cname [String]
+    # @param cname [String]
     # @param subdir [String]
     # @return [void]
     def autoload_subdir(parent, cname, subdir)
@@ -374,7 +386,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @paran cname [String]
+    # @param cname [String]
     # @param file [String]
     # @return [void]
     def autoload_file(parent, cname, file)
@@ -449,11 +461,17 @@ module Zeitwerk
     # @return [void]
     def do_preload
       preloads.each do |abspath|
-        if ruby?(abspath)
-          do_preload_file(abspath)
-        elsif dir?(abspath)
-          do_preload_dir(abspath)
-        end
+        do_preload_abspath(abspath)
+      end
+    end
+
+    # @param abspath [String]
+    # @return [void]
+    def do_preload_abspath(abspath)
+      if ruby?(abspath)
+        do_preload_file(abspath)
+      elsif dir?(abspath)
+        do_preload_dir(abspath)
       end
     end
 
@@ -461,11 +479,7 @@ module Zeitwerk
     # @return [void]
     def do_preload_dir(dir)
       each_abspath(dir) do |abspath|
-        if ruby?(abspath)
-          do_preload_file(abspath)
-        elsif dir?(abspath)
-          do_preload_dir(abspath)
-        end
+        do_preload_abspath(abspath)
       end
     end
 
@@ -515,7 +529,7 @@ module Zeitwerk
     # @param message [String]
     # @return [void]
     def log(message)
-      logger.call("Zeitwerk: #{message}")
+      logger.call("Zeitwerk@#{tag}: #{message}")
     end
 
     def enable_tracer

data/lib/zeitwerk/registry.rb

@@ -83,6 +83,7 @@ module Zeitwerk
       def loader_for_gem(root_file)
         loaders_managing_gems[root_file] ||= begin
           Loader.new.tap do |loader|
+            loader.tag = File.basename(root_file, ".rb")
             loader.inflector = GemInflector.new(root_file)
             loader.push_dir(File.dirname(root_file))
           end

data/lib/zeitwerk/version.rb

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

metadata

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