zeitwerk 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff8931860945782c104aae3e03599df5c84dfdfd05aa422b3b467f227fabb23
-  data.tar.gz: aca07442b309c1d842ebcc9351c4c489c601331832308aee6f8f5bb49a43e4bc
+  metadata.gz: e89de8ad7897a95ccc14f71e1688eb826c7e01f2c0c9381e09de5dd8815d1974
+  data.tar.gz: 11bf19ab1b396399afc3110e8122cb783d2a2d64a889fa5ac7e506e65a8cc9be
 SHA512:
-  metadata.gz: e42fb0efc142bae7da85f21d3d8650c5ef8a24f5f07b3b673ca6f4e74b952c90d7d935f4d2fd1c8efa217d0e19476472435df6ee7547f6c76f190796fc87c202
-  data.tar.gz: 1ced31f03716433f32e534952c2811bee84885c6e376c5e5e227ce695bd891154fa8464747b4e0844a74dd1e9a2d196dd3cace12835312e340ae424834b58433
+  metadata.gz: b9a3e74bde3eec64186834b010f3c047d0b1c849a95c89747c6195b3a5fef974d4b1018cf4fca64a46e27aa5768c543d73b6203af80b170c20dab108544833e0
+  data.tar.gz: 2055af7e3b74fa7c6c3e0c1e7dc6bb1888736c5d8204106ed0504b83a3cba74f7db2a24a72a0e2afc995cf780d4ebcd5965c74262150bb9c90fc3abf4ae97310

data/README.md

@@ -3,7 +3,7 @@
 
 
 [![Gem Version](https://img.shields.io/gem/v/zeitwerk.svg?style=for-the-badge)](https://rubygems.org/gems/zeitwerk)
-[![Build Status](https://img.shields.io/travis/com/fxn/zeitwerk.svg?style=for-the-badge)](https://travis-ci.com/fxn/zeitwerk)
+[![Build Status](https://img.shields.io/travis/com/fxn/zeitwerk.svg?style=for-the-badge&branch=master)](https://travis-ci.com/fxn/zeitwerk)
 
 <!-- TOC -->
 
@@ -37,6 +37,7 @@
 
 <!-- /TOC -->
 
+<a id="markdown-introduction" name="introduction"></a>
 ## Introduction
 
 Zeitwerk is an efficient and thread-safe code loader for Ruby.
@@ -51,6 +52,7 @@ Zeitwerk is also able to reload code, which may be handy for web applications. C
 
 Finally, in some production setups it may be optimal to eager load all code upfront. Zeitwerk is able to do that too.
 
+<a id="markdown-synopsis" name="synopsis"></a>
 ## Synopsis
 
 Main interface for gems:
@@ -101,6 +103,7 @@ It is also possible to broadcast `eager_load` to all instances:
 Zeitwerk::Loader.eager_load_all
 ```
 
+<a id="markdown-file-structure" name="file-structure"></a>
 ## File structure
 
 To have a file structure Zeitwerk can work with, just name files and directories after the name of the classes and modules they define:
@@ -126,6 +129,7 @@ app/models/user.rb                        -> User
 app/controllers/admin/users_controller.rb -> Admin::UsersController
 ```
 
+<a id="markdown-implicit-namespaces" name="implicit-namespaces"></a>
 ### Implicit namespaces
 
 Directories without a matching Ruby file get modules autovivified automatically by Zeitwerk. For example, in
@@ -136,6 +140,7 @@ app/controllers/admin/users_controller.rb -> Admin::UsersController
 
 `Admin` is autovivified as a module on demand, you do not need to define an `Admin` class or module in an `admin.rb` file explicitly.
 
+<a id="markdown-explicit-namespaces" name="explicit-namespaces"></a>
 ### Explicit namespaces
 
 Classes and modules that act as namespaces can also be explicitly defined, though. For instance, consider
@@ -158,6 +163,7 @@ end
 
 An explicit namespace must be managed by one single loader. Loaders that reopen namespaces owned by other projects are responsible for loading their constants before setup.
 
+<a id="markdown-nested-root-directories" name="nested-root-directories"></a>
 ### Nested root directories
 
 Root directories should not be ideally nested, but Zeitwerk supports them because in Rails, for example, both `app/models` and `app/models/concerns` belong to the autoload paths.
@@ -170,8 +176,10 @@ app/models/concerns/geolocatable.rb
 
 should define `Geolocatable`, not `Concerns::Geolocatable`.
 
+<a id="markdown-usage" name="usage"></a>
 ## Usage
 
+<a id="markdown-setup" name="setup"></a>
 ### Setup
 
 Loaders are ready to load code right after calling `setup` on them:
@@ -194,6 +202,7 @@ The loader returned by `Zeitwerk::Loader.for_gem` has the directory of the calle
 
 Zeitwerk works internally only with absolute paths to avoid costly file searches in `$LOAD_PATH`. Indeed, the root directories do not even need to belong to `$LOAD_PATH`, everything just works by design if they don't.
 
+<a id="markdown-reloading" name="reloading"></a>
 ### Reloading
 
 Zeitwer is able to reload code, but you need to enable this feature:
@@ -221,6 +230,7 @@ In order for reloading to be thread-safe, you need to implement some coordinatio
 
 On reloading, client code has to update anything that would otherwise be storing a stale object. For example, if the routing layer of a web framework stores controller class objects or instances in internal structures, on reload it has to refresh them somehow, possibly reevaluating routes.
 
+<a id="markdown-eager-loading" name="eager-loading"></a>
 ### Eager loading
 
 Zeitwerk instances are able to eager load their managed files:
@@ -250,6 +260,7 @@ This may be handy in top-level services, like web applications.
 
 Note that thanks to idempotence `Zeitwerk::Loader.eager_load_all` won't eager load twice if any of the instances already eager loaded.
 
+<a id="markdown-preloading" name="preloading"></a>
 ### Preloading
 
 Zeitwerk instances are able to preload files and directories.
@@ -265,10 +276,12 @@ This is a feature specifically thought for STIs in Rails, preloading the leafs o
 
 The example above depicts several calls are supported, but `preload` accepts multiple arguments and arrays of strings as well.
 
+<a id="markdown-inflection" name="inflection"></a>
 ### Inflection
 
 Each individual loader needs an inflector to figure out which constant path would a given file or directory map to. Zeitwerk ships with two basic inflectors.
 
+<a id="markdown-zeitwerkinflector" name="zeitwerkinflector"></a>
 #### Zeitwerk::Inflector
 
 This is a very basic inflector that converts snake case to camel case:
@@ -283,10 +296,12 @@ There are no inflection rules or global configuration that can affect this infle
 
 This is the default inflector.
 
+<a id="markdown-zeitwerkgeminflector" name="zeitwerkgeminflector"></a>
 #### Zeitwerk::GemInflector
 
 The loader instantiated behind the scenes by `Zeitwerk::Loader.for_gem` gets assigned by default an inflector that is like the basic one, except it expects `lib/my_gem/version.rb` to define `MyGem::VERSION`.
 
+<a id="markdown-custom-inflector" name="custom-inflector"></a>
 #### Custom inflector
 
 The inflectors that ship with Zeitwerk are deterministic and simple. But you can configure your own:
@@ -320,6 +335,7 @@ loader.inflector = MyInflector.new
 
 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:
@@ -348,6 +364,7 @@ If there is a logger configured, you'll see traces when autoloads are set, files
 
 As a curiosity, 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.
 
+<a id="markdown-loader-tag" name="loader-tag"></a>
 #### Loader tag
 
 Loaders have a tag that is printed in traces in order to be able to distinguish them in globally logged activity:
@@ -368,6 +385,7 @@ The tag of a loader returned by `for_gem` is the basename of the root file witho
 Zeitwerk@my_gem: constant MyGem::Foo loaded from ...
 ```
 
+<a id="markdown-ignoring-parts-of-the-project" name="ignoring-parts-of-the-project"></a>
 ### 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".
@@ -378,6 +396,7 @@ You can ignore file names, directory names, and glob patterns. Glob patterns are
 
 Let's see some use cases.
 
+<a id="markdown-use-case-files-that-do-not-follow-the-conventions" name="use-case-files-that-do-not-follow-the-conventions"></a>
 #### Use case: Files that do not follow the conventions
 
 Let's suppose that your gem decorates something in `Kernel`:
@@ -406,6 +425,7 @@ loader.ignore(core_ext)
 loader.setup
 ```
 
+<a id="markdown-use-case-the-adapter-pattern" name="use-case-the-adapter-pattern"></a>
 #### Use case: The adapter pattern
 
 Another use case for ignoring files is the adapter pattern.
@@ -433,6 +453,7 @@ The chosen adapter, then, has to be loaded by hand somehow:
 require "my_gem/db_adapters/#{config[:db_adapter]}"
 ```
 
+<a id="markdown-use-case-test-files-mixed-with-implementation-files" name="use-case-test-files-mixed-with-implementation-files"></a>
 #### Use case: Test files mixed with implementation files
 
 There are project layouts that put implementation files and test files together. To ignore the test files, you can use a glob pattern like this:
@@ -443,6 +464,7 @@ loader.ignore(tests)
 loader.setup
 ```
 
+<a id="markdown-edge-cases" name="edge-cases"></a>
 ### Edge cases
 
 A class or module that acts as a namespace:
@@ -471,20 +493,24 @@ Trip = Struct.new { ... } # NOT SUPPORTED
 
 This only affects explicit namespaces, those idioms work well for any other ordinary class or module.
 
+<a id="markdown-pronunciation" name="pronunciation"></a>
 ## Pronunciation
 
 "Zeitwerk" is pronounced [this way](http://share.hashref.com/zeitwerk/zeitwerk_pronunciation.mp3).
 
+<a id="markdown-supported-ruby-versions" name="supported-ruby-versions"></a>
 ## Supported Ruby versions
 
 Zeitwerk works with MRI 2.4.4 and above.
 
+<a id="markdown-motivation" name="motivation"></a>
 ## Motivation
 
 Since `require` has global side-effects, and there is no static way to verify that you have issued the `require` calls for code that your file depends on, in practice it is very easy to forget some. That introduces bugs that depend on the load order. Zeitwerk provides a way to forget about `require` in your own code, just name things following conventions and done.
 
 On the other hand, autoloading in Rails is based on `const_missing`, which lacks fundamental information like the nesting and the resolution algorithm that was being used. Because of that, Rails autoloading is not able to match Ruby's semantics and that introduces a series of gotchas. The original goal of this project was to bring a better autoloading mechanism for Rails 6.
 
+<a id="markdown-thanks" name="thanks"></a>
 ## Thanks
 
 I'd like to thank [@matthewd](https://github.com/matthewd) for the discussions we've had about this topic in the past years, I learned a couple of tricks used in Zeitwerk from him.
@@ -493,6 +519,7 @@ Also, would like to thank [@Shopify](https://github.com/Shopify), [@rafaelfranca
 
 Finally, many thanks to [@schurig](https://github.com/schurig) for recording an [audio file](http://share.hashref.com/zeitwerk/zeitwerk_pronunciation.mp3) with the pronunciation of "Zeitwerk" in perfect German. 💯
 
+<a id="markdown-license" name="license"></a>
 ## License
 
 Released under the MIT License, Copyright (c) 2019–<i>ω</i> Xavier Noria.

data/lib/zeitwerk/loader.rb

@@ -53,23 +53,6 @@ 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.
@@ -155,7 +138,6 @@ 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.
@@ -324,7 +306,6 @@ module Zeitwerk
         autoloaded_dirs.clear
         to_unload.clear
         lazy_subdirs.clear
-        shadowed_files.clear
 
         Registry.on_unload(self)
         ExplicitNamespace.unregister(self)
@@ -362,19 +343,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|
             next if eager_load_exclusions.member?(abspath)
 
             if ruby?(abspath)
-              require abspath unless shadowed_files.member?(abspath)
+              const_get_if_autoload(abspath)
             elsif dir?(abspath)
               queue << abspath
             end
           end
         end
 
-        shadowed_files.clear
-
         autoloaded_dirs.each do |autoloaded_dir|
           Registry.unregister_autoload(autoloaded_dir)
         end
@@ -516,7 +497,6 @@ module Zeitwerk
         # First autoload for a Ruby file wins, just ignore subsequent ones.
         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,
@@ -527,7 +507,6 @@ module Zeitwerk
         end
       elsif cdef?(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
@@ -685,6 +664,12 @@ 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/loader/callbacks.rb

@@ -8,7 +8,12 @@ module Zeitwerk::Loader::Callbacks
     cref = autoloads.delete(file)
     to_unload[cpath(*cref)] = [file, cref] if reloading_enabled?
     Zeitwerk::Registry.unregister_autoload(file)
-    log("constant #{cpath(*cref)} loaded from file #{file}") if logger
+
+    if logger && cdef?(*cref)
+      log("constant #{cpath(*cref)} loaded from file #{file}")
+    elsif !cdef?(*cref)
+      raise NameError, "expected file #{file} to define constant #{cpath(*cref)}, but didn't"
+    end
   end
 
   # Invoked from our decorated Kernel#require when a managed directory is

data/lib/zeitwerk/version.rb

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

metadata

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