zeitwerk 2.1.5 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89de8ad7897a95ccc14f71e1688eb826c7e01f2c0c9381e09de5dd8815d1974
-  data.tar.gz: 11bf19ab1b396399afc3110e8122cb783d2a2d64a889fa5ac7e506e65a8cc9be
+  metadata.gz: 43750607caaaa5d4fff5bd52204cafb98fbd5109b51a24d9099ba83c6a2a4990
+  data.tar.gz: 8ad3251fd93af9e66a9102c13556beff5805a38660d69e4c5de37e2808e76d8f
 SHA512:
-  metadata.gz: b9a3e74bde3eec64186834b010f3c047d0b1c849a95c89747c6195b3a5fef974d4b1018cf4fca64a46e27aa5768c543d73b6203af80b170c20dab108544833e0
-  data.tar.gz: 2055af7e3b74fa7c6c3e0c1e7dc6bb1888736c5d8204106ed0504b83a3cba74f7db2a24a72a0e2afc995cf780d4ebcd5965c74262150bb9c90fc3abf4ae97310
+  metadata.gz: e6e87877104078f564686a15b81882a8e20a560a36999e0f8b9916aa520dd46fe1a2b7f65cacdb7b6c62d252472b6ce1370939054f026a335e21652881820814
+  data.tar.gz: 3641d412ab4b9176861b9ed9b28ea7964b6a814ebb72804c96967e511562fb87f424c48d7780345be8ccd2c53bdacfe095e3e5173e166a4185bf389740258ca6

data/README.md

@@ -338,7 +338,15 @@ This needs to be done before calling `setup`.
 <a id="markdown-logging" name="logging"></a>
 ### Logging
 
-Zeitwerk is silent by default, but you can configure a callable as logger:
+Zeitwerk is silent by default, but you can ask loaders to trace their activity. Logging is meant just for troubleshooting, shouldn't normally be enabled.
+
+The `log!` mehtod is a quick shortcut to let the loader log to `$stdout`:
+
+```
+loader.log!
+```
+
+If you want more control, a logger can be configured as a callable
 
 ```ruby
 loader.logger = method(:puts)

data/lib/zeitwerk/loader.rb

@@ -53,6 +53,23 @@ module Zeitwerk
     # @return [Set<String>]
     attr_reader :ignored_paths
 
+    # A _shadowed file_ is a file managed by this loader that is ignored when
+    # setting autoloads because its matching constant is taken. Either the
+    # constant is already defined, or there exists an autoload for it.
+    #
+    # Think $LOAD_PATH and require, only the first occurrence of a given
+    # relative name is loaded.
+    #
+    # This set keeps track of the absolute path of shadowed files, to be able to
+    # skip them while eager loading.
+    #
+    # Note this cannot be implemented with do_not_eager_load because these
+    # files are not autoloadable.
+    #
+    # @private
+    # @return [Set<String>]
+    attr_reader :shadowed_files
+
     # Maps real absolute paths for which an autoload has been set ---and not
     # executed--- to their corresponding parent class or module and constant
     # name.
@@ -138,6 +155,7 @@ module Zeitwerk
       @autoloaded_dirs       = []
       @to_unload             = {}
       @lazy_subdirs          = {}
+      @shadowed_files        = Set.new
       @eager_load_exclusions = Set.new
 
       # TODO: find a better name for these mutexes.
@@ -306,6 +324,7 @@ module Zeitwerk
         autoloaded_dirs.clear
         to_unload.clear
         lazy_subdirs.clear
+        shadowed_files.clear
 
         Registry.on_unload(self)
         ExplicitNamespace.unregister(self)
@@ -343,19 +362,19 @@ module Zeitwerk
 
         queue = actual_root_dirs.reject { |dir| eager_load_exclusions.member?(dir) }
         while dir = queue.shift
-          const_get_if_autoload(dir)
-
-          each_abspath(dir) do |abspath|
+          ls(dir) do |_basename, abspath|
             next if eager_load_exclusions.member?(abspath)
 
             if ruby?(abspath)
-              const_get_if_autoload(abspath)
+              require abspath unless shadowed_files.member?(abspath)
             elsif dir?(abspath)
               queue << abspath
             end
           end
         end
 
+        shadowed_files.clear
+
         autoloaded_dirs.each do |autoloaded_dir|
           Registry.unregister_autoload(autoloaded_dir)
         end
@@ -391,6 +410,13 @@ module Zeitwerk
       to_unload.keys.freeze
     end
 
+    # Logs to `$stdout`, handy shortcut for debugging.
+    #
+    # @return [void]
+    def log!
+      @logger = ->(msg) { puts msg }
+    end
+
     # --- Class methods ---------------------------------------------------------------------------
 
     class << self
@@ -414,7 +440,7 @@ module Zeitwerk
       #
       # @return [Zeitwerk::Loader]
       def for_gem
-        called_from = caller_locations.first.path
+        called_from = caller_locations(1, 1).first.path
         Registry.loader_for_gem(called_from)
       end
 
@@ -449,9 +475,10 @@ module Zeitwerk
     # @param parent [Module]
     # @return [void]
     def set_autoloads_in_dir(dir, parent)
-      each_abspath(dir) do |abspath|
-        cname = inflector.camelize(File.basename(abspath, ".rb"), abspath).to_sym
-        if ruby?(abspath)
+      ls(dir) do |basename, abspath|
+        if ruby?(basename)
+          basename.slice!(-3, 3)
+          cname = inflector.camelize(basename, abspath).to_sym
           autoload_file(parent, cname, abspath)
         elsif dir?(abspath)
           # In a Rails application, `app/models/concerns` is a subdirectory of
@@ -460,7 +487,10 @@ module Zeitwerk
           # To resolve the ambiguity file name -> constant path this introduces,
           # the `app/models/concerns` directory is totally ignored as a namespace,
           # it counts only as root. The guard checks that.
-          autoload_subdir(parent, cname, abspath) unless root_dirs.key?(abspath)
+          unless root_dirs.key?(abspath)
+            cname = inflector.camelize(basename, abspath).to_sym
+            autoload_subdir(parent, cname, abspath)
+          end
         end
       end
     end
@@ -496,6 +526,7 @@ module Zeitwerk
       if autoload_path = autoload_for?(parent, cname)
         # First autoload for a Ruby file wins, just ignore subsequent ones.
         if ruby?(autoload_path)
+          shadowed_files.add(file)
           log("file #{file} is ignored because #{autoload_path} has precedence") if logger
         else
           promote_namespace_from_implicit_to_explicit(
@@ -506,6 +537,7 @@ module Zeitwerk
           )
         end
       elsif cdef?(parent, cname)
+        shadowed_files.add(file)
         log("file #{file} is ignored because #{cpath(parent, cname)} is already defined") if logger
       else
         set_autoload(parent, cname, file)
@@ -605,7 +637,7 @@ module Zeitwerk
     # @param dir [String]
     # @return [void]
     def do_preload_dir(dir)
-      each_abspath(dir) do |abspath|
+      ls(dir) do |_basename, abspath|
         do_preload_abspath(abspath)
       end
     end
@@ -625,13 +657,13 @@ module Zeitwerk
     end
 
     # @param dir [String]
-    # @yieldparam path [String]
+    # @yieldparam path [String, String]
     # @return [void]
-    def each_abspath(dir)
-      Dir.foreach(dir) do |entry|
-        next if entry.start_with?(".")
-        abspath = File.join(dir, entry)
-        yield abspath unless ignored_paths.member?(abspath)
+    def ls(dir)
+      Dir.foreach(dir) do |basename|
+        next if basename.start_with?(".")
+        abspath = File.join(dir, basename)
+        yield basename, abspath unless ignored_paths.member?(abspath)
       end
     end
 
@@ -664,12 +696,6 @@ module Zeitwerk
       parent.const_defined?(cname, false)
     end
 
-    def const_get_if_autoload(abspath)
-      if cref = autoloads[File.realpath(abspath)]
-        cref[0].const_get(cref[1], false)
-      end
-    end
-
     def register_explicit_namespace(cpath)
       ExplicitNamespace.register(cpath, self)
     end

data/lib/zeitwerk/version.rb

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

metadata

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