zeitwerk 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d964999444d0bc99d003d604cb2634d2753c579a4aebcce4fccb4c9ded78530
-  data.tar.gz: 95fc0030faf0472c8359c3665a09fa68dc3c79bff1d813e55d0f03f68c6f5282
+  metadata.gz: 2af29bb519da160c83620c23a1f1c119c7b534a3e3db308b2635b344b435dfa1
+  data.tar.gz: ec2dc810c74887befea3550b3305b0b096610cbb06a2983dad0c041c9bed34dc
 SHA512:
-  metadata.gz: 81f2ac76566c1cda996eeac723fa7579dba24011f32fab94458ced0faf5eb7fe920ee2e016ce45ec83fc0d7b17244a1bf98764d71e667cbe067fa8ee87f01ca3
-  data.tar.gz: a90efd80c7caba53d6ec12bc20ee1a76f8d49a6a2e59a82b60a646486eac758348ff1250eee42585dbb2294718a41d59d97c9254ee51b802cddd1ce7add46ead
+  metadata.gz: 8cafd96d9f21546ea8dcb58f8b589d59b5de994492a2f89f6cd4eb2701d673e58c888884b672ddd47580778090f4af918c908e6325d5690ce8297b0e152eb391
+  data.tar.gz: e1fba9ebf4e35fa10c2577bdb4a19124ee26e3d09a85b2382a5bc0c83688130b14a0c8e9900e6572f25efe86c388b54139d9ca82d7053cfc415b39a618d1ec16

data/lib/zeitwerk/loader.rb

@@ -68,8 +68,9 @@ module Zeitwerk
     # @return [{String => String}]
     attr_reader :shadowed_files
 
-    # Maps real absolute paths for which an autoload has been set to their
-    # corresponding parent class or module and constant name.
+    # Maps real absolute paths for which an autoload has been set ---and not
+    # executed--- to their corresponding parent class or module and constant
+    # name.
     #
     #   "/Users/fxn/blog/app/models/user.rb"          => [Object, "User"],
     #   "/Users/fxn/blog/app/models/hotel/pricing.rb" => [Hotel, "Pricing"]
@@ -84,13 +85,18 @@ module Zeitwerk
     #
     # Files are removed as they are autoloaded, but directories need to wait due
     # to concurrency (see why in Zeitwerk::Loader::Callbacks#on_dir_autoloaded).
+    #
+    # @private
+    # @return [<String>]
     attr_reader :autoloaded_dirs
 
-    # Constant paths loaded so far.
+    # Constants paths that would be unloaded if you would reload. If reloading
+    # is enabled, this hash is filled as constants are autoloaded or eager
+    # loaded. Otherwise, the collection remains empty.
     #
     # @private
-    # @return [Set<String>]
-    attr_reader :loaded_cpaths
+    # @return [{String => (String, (Module, String))}]
+    attr_reader :to_unload
 
     # Maps constant paths of namespaces to arrays of corresponding directories.
     #
@@ -137,7 +143,7 @@ module Zeitwerk
       @ignored_paths         = Set.new
       @autoloads             = {}
       @autoloaded_dirs       = []
-      @loaded_cpaths         = Set.new
+      @to_unload             = {}
       @lazy_subdirs          = {}
       @shadowed_files        = {}
       @eager_load_exclusions = Set.new
@@ -270,19 +276,21 @@ module Zeitwerk
 
         autoloads.each do |realpath, (parent, cname)|
           if parent.autoload?(cname)
-            parent.send(:remove_const, cname)
-            log("autoload for #{cpath(parent, cname)} removed") if logger
+            unload_autoload(parent, cname)
           else
-            if cdef?(parent, cname)
-              parent.send(:remove_const, cname)
-              log("#{cpath(parent, cname)} unloaded") if logger
-            else
-              # Already unloaded somehow, that is fine.
-            end
+            # Could happen if loaded with require_relative. require_relative is
+            # not supported, and the cpath would escape `to_unload?`. This is
+            # just defensive code to clean things up as much as we are able to.
+            unload_cref(parent, cname)   if cdef?(parent, cname)
             unloaded_files.add(realpath) if ruby?(realpath)
           end
         end
 
+        to_unload.each_value do |(realpath, (parent, cname))|
+          unload_cref(parent, cname)   if cdef?(parent, cname)
+          unloaded_files.add(realpath) if ruby?(realpath)
+        end
+
         unless unloaded_files.empty?
           # Bootsnap decorates Kernel#require to speed it up using a cache and
           # this optimization does not check if $LOADED_FEATURES has the file.
@@ -300,7 +308,7 @@ module Zeitwerk
 
         autoloads.clear
         autoloaded_dirs.clear
-        loaded_cpaths.clear
+        to_unload.clear
         lazy_subdirs.clear
         shadowed_files.clear
 
@@ -369,12 +377,13 @@ module Zeitwerk
       mutex.synchronize { eager_load_exclusions.merge(expand_paths(paths)) }
     end
 
-    # Says if the given constant path has been loaded.
+    # Says if the given constant path would be unloaded on reload. This
+    # predicate returns `false` if reloading is disabled.
     #
     # @param cpath [String]
     # @return [Boolean]
-    def loaded?(cpath)
-      loaded_cpaths.member?(cpath)
+    def to_unload?(cpath)
+      to_unload.key?(cpath)
     end
 
     # --- Class methods ---------------------------------------------------------------------------
@@ -662,5 +671,21 @@ module Zeitwerk
         end
       end
     end
+
+    # @param parent [Module]
+    # @param cname [String]
+    # @return [void]
+    def unload_autoload(parent, cname)
+      parent.send(:remove_const, cname)
+      log("autoload for #{cpath(parent, cname)} removed") if logger
+    end
+
+    # @param parent [Module]
+    # @param cname [String]
+    # @return [void]
+    def unload_cref(parent, cname)
+      parent.send(:remove_const, cname)
+      log("#{cpath(parent, cname)} unloaded") if logger
+    end
   end
 end

data/lib/zeitwerk/loader/callbacks.rb

@@ -5,10 +5,10 @@ module Zeitwerk::Loader::Callbacks
   # @param file [String]
   # @return [void]
   def on_file_autoloaded(file)
-    parent, cname = cref_autoloaded_from(file)
-    loaded_cpaths.add(cpath(parent, cname))
+    cref = autoloads.delete(file)
+    to_unload[cpath(*cref)] = [file, cref] if reloading_enabled?
     Zeitwerk::Registry.unregister_autoload(file)
-    log("constant #{cpath(parent, cname)} loaded from file #{file}") if logger
+    log("constant #{cpath(*cref)} loaded from file #{file}") if logger
   end
 
   # Invoked from our decorated Kernel#require when a managed directory is
@@ -25,23 +25,25 @@ module Zeitwerk::Loader::Callbacks
     # autovivifies the module, and while autoloads for its children are being
     # set, thread t2 autoloads the same namespace.
     #
-    # Without the mutex and short-circuiting break, t2 would reset the module.
+    # Without the mutex and subsequent delete call, t2 would reset the module.
     # That not only would reassign the constant (undesirable per se) but, worse,
     # the module object created by t2 wouldn't have any of the autoloads for its
     # children, since t1 would have correctly deleted its lazy_subdirs entry.
     mutex2.synchronize do
-      parent, cname = cref_autoloaded_from(dir)
-      # If reloading is disabled and there are several threads autoloading the
-      # same namespace at the same time, the parent is going to bbe nil for all
-      # except the first one.
-      break if parent.nil? || loaded_cpaths.include?(cpath(parent, cname))
+      if cref = autoloads.delete(dir)
+        autovivified_module = cref[0].const_set(cref[1], Module.new)
+        log("module #{autovivified_module.name} autovivified from directory #{dir}") if logger
 
-      autovivified_module = parent.const_set(cname, Module.new)
-      log("module #{autovivified_module.name} autovivified from directory #{dir}") if logger
+        to_unload[autovivified_module.name] = [dir, cref] if reloading_enabled?
 
-      loaded_cpaths.add(autovivified_module.name)
-      autoloaded_dirs << dir
-      on_namespace_loaded(autovivified_module)
+        # We don't unregister `dir` in the registry because concurrent threads
+        # wouldn't find a loader associated to it in Kernel#require and would
+        # try to require the directory. Instead, we are going to keep track of
+        # these to be able to unregister later if eager loading.
+        autoloaded_dirs << dir
+
+        on_namespace_loaded(autovivified_module)
+      end
     end
   end
 
@@ -59,10 +61,4 @@ module Zeitwerk::Loader::Callbacks
       end
     end
   end
-
-  # @private
-  # @return [(Module, String)]
-  def cref_autoloaded_from(path)
-    reloading_enabled? ? autoloads[path] : autoloads.delete(path)
-  end
 end

data/lib/zeitwerk/version.rb

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

metadata

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