zeitwerk 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afbe6dc64c3c97a4a2f2872d4e500374fc67ddae36a515d8791e3f8122a2447d
-  data.tar.gz: 470325ed5fe48da426cfb86fd35f20d9377fe9b41515aa4146e310a85843cce5
+  metadata.gz: e458722eb922aa69f1c49c077b9cfa0bb8c0fa14d7a12f295b7375e5f31d6d33
+  data.tar.gz: 414f3bbe461b6081c39eff4640fda5eae0ea7d2e1649a981f84759ba6db538a7
 SHA512:
-  metadata.gz: caca8ed04aa94078f1e1af395c7e4afda10047a436694a5c5b9f4769a7829e7277d1243cd470618c8027f250ea288c82781ae64cd7d5d0771dac27b288a4350b
-  data.tar.gz: 507bbdb688e9b9412d908f784a902e807b90dd403df9939646c6d2d732367f9b8333b836354aa7b659425c1dc871c9bcf2f0fbe97a6522e444b968d2c5e12521
+  metadata.gz: fc0a61c385d372cdba449e80473d793133e71fc502cbda1f504d64759f6ff9e1ea65ebdcead21c472b89c84951915d687de2a3e71bff8307b91e2e4bd29339d5
+  data.tar.gz: 5b851f501b91740176047eb1fca04c3b5de04c482b055dc7605a15cbf571b719e4bb9e11bc939521411e1965ef07e539a023dc83b40eb059234b86fe41bf73d5

data/lib/zeitwerk/inflector.rb

@@ -4,9 +4,10 @@ module Zeitwerk
   class Inflector # :nodoc:
     # Very basic snake case -> camel case conversion.
     #
-    #   Zeitwerk::Inflector.camelize("post", ...)             # => "Post"
-    #   Zeitwerk::Inflector.camelize("users_controller", ...) # => "UsersController"
-    #   Zeitwerk::Inflector.camelize("api", ...)              # => "Api"
+    #   inflector = Zeitwerk::Inflector.new
+    #   inflector.camelize("post", ...)             # => "Post"
+    #   inflector.camelize("users_controller", ...) # => "UsersController"
+    #   inflector.camelize("api", ...)              # => "Api"
     #
     # @param basename [String]
     # @param _abspath [String]

data/lib/zeitwerk/loader.rb

@@ -74,12 +74,12 @@ module Zeitwerk
     # 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"]
+    #   "/Users/fxn/blog/app/models/user.rb"          => [Object, :User],
+    #   "/Users/fxn/blog/app/models/hotel/pricing.rb" => [Hotel, :Pricing]
     #   ...
     #
     # @private
-    # @return [{String => (Module, String)}]
+    # @return [{String => (Module, Symbol)}]
     attr_reader :autoloads
 
     # We keep track of autoloaded directories to remove them from the registry
@@ -92,12 +92,20 @@ module Zeitwerk
     # @return [<String>]
     attr_reader :autoloaded_dirs
 
-    # 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.
+    # Stores metadata needed for unloading. Its entries look like this:
+    #
+    #   "Admin::Role" => [".../admin/role.rb", [Admin, :Role]]
+    #
+    # The constant path as key helps implementing to_unload? The real file name
+    # is stored in order to be able to delete it from $LOADED_FEATURES, and the
+    # pair [Module, Symbol] is used to remove_const the constant from the class
+    # or module object.
+    #
+    # If reloading is enabled, this hash is filled as constants are autoloaded
+    # or eager loaded. Otherwise, the collection remains empty.
     #
     # @private
-    # @return [{String => (String, (Module, String))}]
+    # @return [{String => (String, (Module, Symbol))}]
     attr_reader :to_unload
 
     # Maps constant paths of namespaces to arrays of corresponding directories.
@@ -176,7 +184,11 @@ module Zeitwerk
       root_dirs.keys.freeze
     end
 
-    # Pushes `paths` to the list of root directories.
+    # Pushes `path` to the list of root directories.
+    #
+    # Raises `Zeitwerk::Error` if `path` does not exist, or if another loader in
+    # the same process already manages that directory or one of its ascendants
+    # or descendants.
     #
     # @param path [<String, Pathname>]
     # @raise [Zeitwerk::Error]
@@ -413,7 +425,7 @@ module Zeitwerk
       #
       # @return [Zeitwerk::Loader]
       def for_gem
-        called_from = caller[0].split(':')[0]
+        called_from = caller_locations.first.path
         Registry.loader_for_gem(called_from)
       end
 
@@ -447,7 +459,7 @@ module Zeitwerk
     # @return [void]
     def set_autoloads_in_dir(dir, parent)
       each_abspath(dir) do |abspath|
-        cname = inflector.camelize(File.basename(abspath, ".rb"), abspath)
+        cname = inflector.camelize(File.basename(abspath, ".rb"), abspath).to_sym
         if ruby?(abspath)
           autoload_file(parent, cname, abspath)
         elsif dir?(abspath)
@@ -463,7 +475,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @param subdir [String]
     # @return [void]
     def autoload_subdir(parent, cname, subdir)
@@ -486,7 +498,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @param file [String]
     # @return [void]
     def autoload_file(parent, cname, file)
@@ -514,7 +526,7 @@ module Zeitwerk
     # @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]
+    # @param cname [Symbol]
     # @return [void]
     def promote_namespace_from_implicit_to_explicit(dir:, file:, parent:, cname:)
       autoloads.delete(dir)
@@ -525,7 +537,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @param abspath [String]
     # @return [void]
     def set_autoload(parent, cname, abspath)
@@ -552,7 +564,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @return [String, nil]
     def autoload_for?(parent, cname)
       strict_autoload_path(parent, cname) || Registry.inception?(cpath(parent, cname))
@@ -575,17 +587,10 @@ module Zeitwerk
     # We need a way to strictly check in parent ignoring ancestors.
     #
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @return [String, nil]
     def strict_autoload_path(parent, cname)
-      if autoload_path = parent.autoload?(cname)
-        # Due to the use cases we have, we are done if parent is a Module.
-        return autoload_path unless parent.is_a?(Class)
-        # Since file and constant names match, if both parent and one of its
-        # ancestors have an autoload for the same cname, their autoload paths
-        # cannot be equal.
-        return autoload_path unless parent.superclass.autoload?(cname) == autoload_path
-      end
+      parent.autoload?(cname) if cdef?(parent, cname)
     end
 
     # This method is called this way because I prefer `preload` to be the method
@@ -624,10 +629,10 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @return [String]
     def cpath(parent, cname)
-      parent.equal?(Object) ? cname : "#{parent.name}::#{cname}"
+      parent.equal?(Object) ? cname.to_s : "#{parent.name}::#{cname}"
     end
 
     # @param dir [String]
@@ -693,7 +698,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @return [void]
     def unload_autoload(parent, cname)
       parent.send(:remove_const, cname)
@@ -701,7 +706,7 @@ module Zeitwerk
     end
 
     # @param parent [Module]
-    # @param cname [String]
+    # @param cname [Symbol]
     # @return [void]
     def unload_cref(parent, cname)
       parent.send(:remove_const, cname)

data/lib/zeitwerk/version.rb

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

metadata

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