zeitwerk 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af29bb519da160c83620c23a1f1c119c7b534a3e3db308b2635b344b435dfa1
-  data.tar.gz: ec2dc810c74887befea3550b3305b0b096610cbb06a2983dad0c041c9bed34dc
+  metadata.gz: 346ac927810dc8ce5b206e4d90e3db572328fa500039ad4af19144bd2d193c0b
+  data.tar.gz: ca4c317c9acfc26898260ae331da60a1bbd6d2c384556fb15d205487936feeb2
 SHA512:
-  metadata.gz: 8cafd96d9f21546ea8dcb58f8b589d59b5de994492a2f89f6cd4eb2701d673e58c888884b672ddd47580778090f4af918c908e6325d5690ce8297b0e152eb391
-  data.tar.gz: e1fba9ebf4e35fa10c2577bdb4a19124ee26e3d09a85b2382a5bc0c83688130b14a0c8e9900e6572f25efe86c388b54139d9ca82d7053cfc415b39a618d1ec16
+  metadata.gz: f4e98230152289f2a52dae3fd4de94c25436325eade87cbd46bf78b60cc4f2480907a3ad19def25a15c6e8d07ed92b4e324244e17513c891648ac5fb31a0cb84
+  data.tar.gz: ea6f69fe9463d847dfbf790ee6dbf22b5574b4bbb473f4acd998a58e905fc2aeb103ec5988f79fd8eaa0a7f641d6c10f428c06e53d526c2a0fe5456a2f5426a1

data/lib/zeitwerk/loader.rb

@@ -53,19 +53,21 @@ module Zeitwerk
     # @return [Set<String>]
     attr_reader :ignored_paths
 
-    # Keeps track of shadowed files.
+    # 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.
     #
-    # A shadowed file is a file managed by this autoloader that is skipped
-    # because its matching constant path has already been seen. Think $LOAD_PATH
-    # and require, only the first occurrence of a given relative name is loaded.
+    # Think $LOAD_PATH and require, only the first occurrence of a given
+    # relative name is loaded.
     #
-    # If the existing occurrence is an autoload, we map the file name to the
-    # shadowing autoload path. If the existing occurrence is an already defined
-    # constant, the file name is mapped to the constant path, meaning it was
-    # loaded elsewhere.
+    # 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 [{String => String}]
+    # @return [Set<String>]
     attr_reader :shadowed_files
 
     # Maps real absolute paths for which an autoload has been set ---and not
@@ -145,7 +147,7 @@ module Zeitwerk
       @autoloaded_dirs       = []
       @to_unload             = {}
       @lazy_subdirs          = {}
-      @shadowed_files        = {}
+      @shadowed_files        = Set.new
       @eager_load_exclusions = Set.new
 
       # TODO: find a better name for these mutexes.
@@ -352,13 +354,15 @@ module Zeitwerk
             next if eager_load_exclusions.member?(abspath)
 
             if ruby?(abspath)
-              require abspath unless shadowed_files.key?(abspath)
+              require abspath unless shadowed_files.member?(abspath)
             elsif dir?(abspath)
               queue << abspath
             end
           end
         end
 
+        shadowed_files.clear
+
         autoloaded_dirs.each do |dir|
           Registry.unregister_autoload(dir)
         end
@@ -488,22 +492,38 @@ module Zeitwerk
     def autoload_file(parent, cname, file)
       if autoload_path = autoload_for?(parent, cname)
         # First autoload for a Ruby file wins, just ignore subsequent ones.
-        shadowed_files[file] = autoload_path and return if ruby?(autoload_path)
-
-        # Override autovivification, we want the namespace to become the
-        # class/module defined in this file.
-        autoloads.delete(autoload_path)
-        Registry.unregister_autoload(autoload_path)
-
-        set_autoload(parent, cname, file)
-        register_explicit_namespace(cpath(parent, cname))
+        if ruby?(autoload_path)
+          log("file #{file} is ignored because #{autoload_path} has precedence") if logger
+          shadowed_files.add(file)
+        else
+          promote_namespace_from_implicit_to_explicit(
+            dir:    autoload_path,
+            file:   file,
+            parent: parent,
+            cname:  cname
+          )
+        end
       elsif cdef?(parent, cname)
-        shadowed_files[file] = cpath(parent, cname)
+        log("file #{file} is ignored because #{cpath(parent, cname)} is already defined") if logger
+        shadowed_files.add(file)
       else
         set_autoload(parent, cname, file)
       end
     end
 
+    # @param dir [String] directory that would have autovivified a module
+    # @param file [String] the file where the namespace is explictly defined
+    # @param parent [Module]
+    # @param cname [String]
+    # @return [void]
+    def promote_namespace_from_implicit_to_explicit(dir:, file:, parent:, cname:)
+      autoloads.delete(dir)
+      Registry.unregister_autoload(dir)
+
+      set_autoload(parent, cname, file)
+      register_explicit_namespace(cpath(parent, cname))
+    end
+
     # @param parent [Module]
     # @param cname [String]
     # @param abspath [String]

data/lib/zeitwerk/version.rb

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

metadata

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