zeitwerk 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc51c080dd7eb9b63e869a04b6eeeb14c0098b64de32d0ef872bba22a6d85d2
-  data.tar.gz: 0d1f743c91aefa0dd073f8f9d05c97991849cd5aa2552633048c15e93269015c
+  metadata.gz: 5a765d51697ca7909b3c4f5ff379c5bda9f15c83ecaeda5becd3f1a3ff8399a4
+  data.tar.gz: 9e156a434cb867d0abd4b5e2863b389b80f8112a77be753931d6f935e69a4bba
 SHA512:
-  metadata.gz: 05fba3abfe897598b45650dd837bb8e7fe4ae19f8ddd43bac1e934e2da18d1374bec14c13c46e43ad37f5cc31f991ddd9c9e429455aa7014bc4e6760b690a03d
-  data.tar.gz: 9ae4f99de1c0e2ace6be146c80fb7384cc893f57f2ec4e6970b44b85ce80d9cf2aa95300b2aac18cb87bc56dfd07c3d155b6b7898c21216b303a1ebc24575414
+  metadata.gz: 7b207559245f9b6c89dedb37bb36395fbf766cca8a947f841b2017d745ddd924edabe42c1708ee2d02e07ea1ce9017f0cbfb09ce97f8cfe939606c137b8fc35a
+  data.tar.gz: 24a76c3eab195b90b496c69c915105128d658c696122aeb8c0ffda47bfa33432273a53740eb889d4309cac05d1092a2053d2019c98dd37c8f9a629a0d17598a1

data/README.md

@@ -23,6 +23,9 @@
             - [Custom inflector](#custom-inflector)
         - [Logging](#logging)
         - [Ignoring parts of the project](#ignoring-parts-of-the-project)
+            - [Files that do not follow the conventions](#files-that-do-not-follow-the-conventions)
+            - [The adapter pattern](#the-adapter-pattern)
+            - [Test files mixed with implementation files](#test-files-mixed-with-implementation-files)
         - [Edge cases](#edge-cases)
     - [Pronunciation](#pronunciation)
     - [Supported Ruby versions](#supported-ruby-versions)
@@ -296,7 +299,17 @@ If your project has namespaces, you'll notice in the traces Zeitwerk sets autolo
 
 ### Ignoring parts of the project
 
-Sometimes it might be convenient to tell Zeitwerk to completely ignore some particular file or directory. For example, let's suppose that your gem decorates something in `Kernel`:
+Zeitwerk ignores automatically any file or directory whose name starts with a dot, and any files that do not have extension ".rb".
+
+However, sometimes it might still be convenient to tell Zeitwerk to completely ignore some particular Ruby file or directory. That is possible with `ignore`, which accepts an arbitrary number of strings or `Pathname` objects, and also an array of them.
+
+You can ignore file names, directory names, and glob patterns. Glob patterns are expanded on setup and on reload.
+
+Let's see some use cases.
+
+#### Files that do not follow the conventions
+
+Let's suppose that your gem decorates something in `Kernel`:
 
 ```ruby
 # lib/my_gem/core_ext/kernel.rb
@@ -306,20 +319,20 @@ Kernel.module_eval do
 end
 ```
 
-That file does not follow the conventions and you need to tell Zeitwerk:
+That file does not define a constant path after the path name and you need to tell Zeitwerk:
 
 ```ruby
-kernel_ext = File.expand_path("my_gem/core_ext/kernel.rb", __dir__)
+kernel_ext = "#{__dir__}/my_gem/core_ext/kernel.rb"
 loader.ignore(kernel_ext)
 loader.setup
 ```
 
-You can pass several arguments to this method, also an array of strings. And you can call `ignore` multiple times too.
+#### The adapter pattern
 
 Another use case for ignoring files is the adapter pattern. Let's imagine your project talks to databases, supports several, and has adapters for each one of them. Those adapters may have top-level `require` calls that load their respective drivers, but you don't want your users to install them all, only the one they are going to use. On the other hand, if your code is eager loaded by you or a parent project (with `Zeitwerk::Loader.eager_load_all`), those `require` calls are going to be executed. Ignoring the adapters prevents that:
 
 ```ruby
-db_adapters = File.expand_path("my_gem/db_adapters", __dir__)
+db_adapters = "#{__dir__}/my_gem/db_adapters"
 loader.ignore(db_adapters)
 loader.setup
 ```
@@ -330,6 +343,16 @@ The chosen adapter, then, has to be loaded by hand somehow:
 require "my_gem/db_adapters/#{config[:db_adapter]}"
 ```
 
+#### 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:
+
+```ruby
+tests = "#{__dir__}/**/*_test.rb"
+loader.ignore(tests)
+loader.setup
+```
+
 ### Edge cases
 
 A class or module that acts as a namespace:
@@ -360,7 +383,7 @@ This only affects explicit namespaces, those idioms work well for any other ordi
 
 ## Pronunciation
 
-"Zeitwerk" is pronounced [this way](https://raw.githubusercontent.com/fxn/zeitwerk/master/extras/zeitwerk_pronunciation.mp3).
+"Zeitwerk" is pronounced [this way](http://share.hashref.com/zeitwerk/zeitwerk_pronunciation.mp3).
 
 ## Supported Ruby versions
 
@@ -376,7 +399,9 @@ On the other hand, autoloading in Rails is based on `const_missing`, which lacks
 
 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.
 
-Also would like to thank [@Shopify](https://github.com/Shopify), [@rafaelfranca](https://github.com/rafaelfranca), and [@dylanahsmith](https://github.com/dylanahsmith), for sharing [this PoC](https://github.com/Shopify/autoload_reloader). The technique Zeitwerk uses to support explicit namespaces was copied from that project.
+Also, would like to thank [@Shopify](https://github.com/Shopify), [@rafaelfranca](https://github.com/rafaelfranca), and [@dylanahsmith](https://github.com/dylanahsmith), for sharing [this PoC](https://github.com/Shopify/autoload_reloader). The technique Zeitwerk uses to support explicit namespaces was copied from that project.
+
+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. 💯
 
 ## License
 

data/lib/zeitwerk/loader.rb

@@ -10,19 +10,20 @@ module Zeitwerk
     # @return [#call, nil]
     attr_accessor :logger
 
-    # Absolute paths of directories from which you want to load constants. This
-    # is a private attribute, client code should use `push_dir`.
-    #
-    # Stored in a hash to preserve order, easily handle duplicates, and also be
-    # able to have a fast lookup, needed for detecting nested paths.
+    # Absolute paths of the root directories. Stored in a hash to preserve
+    # order, easily handle duplicates, and also be able to have a fast lookup,
+    # needed for detecting nested paths.
     #
     #   "/Users/fxn/blog/app/assets"   => true,
     #   "/Users/fxn/blog/app/channels" => true,
     #   ...
     #
+    # This is a private collection maintained by the loader. The public
+    # interface for it is `push_dir` and `dirs`.
+    #
     # @private
     # @return [{String => true}]
-    attr_reader :dirs
+    attr_reader :root_dirs
 
     # Absolute paths of files or directories that have to be preloaded.
     #
@@ -30,12 +31,21 @@ module Zeitwerk
     # @return [<String>]
     attr_reader :preloads
 
-    # Absolute paths of files or directories to be totally ignored.
+    # Absolute paths of files, directories, of glob patterns to be totally
+    # ignored.
     #
     # @private
     # @return [Set<String>]
     attr_reader :ignored
 
+    # The actual collection of absolute file and directory names at the time the
+    # ignored glob patterns were expanded. Computed on setup, and recomputed on
+    # reload.
+    #
+    # @private
+    # @return [Set<String>]
+    attr_reader :ignored_paths
+
     # Maps real absolute paths for which an autoload has been set to their
     # corresponding parent class or module and constant name.
     #
@@ -47,6 +57,12 @@ module Zeitwerk
     # @return [{String => (Module, String)}]
     attr_reader :autoloads
 
+    # Constant paths loaded so far.
+    #
+    # @private
+    # @return [Set<String>]
+    attr_reader :loaded
+
     # Maps constant paths of namespaces to arrays of corresponding directories.
     #
     # For example, given this mapping:
@@ -80,11 +96,13 @@ module Zeitwerk
     def initialize
       self.inflector = Inflector.new
 
-      @dirs         = {}
-      @preloads     = []
-      @ignored      = Set.new
-      @autoloads    = {}
-      @lazy_subdirs = {}
+      @root_dirs     = {}
+      @preloads      = []
+      @ignored       = Set.new
+      @ignored_paths = Set.new
+      @autoloads     = {}
+      @loaded        = Set.new
+      @lazy_subdirs  = {}
 
       @mutex        = Mutex.new
       @setup        = false
@@ -101,6 +119,14 @@ module Zeitwerk
       Registry.register_loader(self)
     end
 
+    # Absolute paths of the root directories. This is a read-only collection,
+    # please push here via `push_dir`.
+    #
+    # @return [<String>]
+    def dirs
+      root_dirs.keys.freeze
+    end
+
     # Pushes `paths` to the list of root directories.
     #
     # @param path [<String, Pathname>]
@@ -109,7 +135,7 @@ module Zeitwerk
       abspath = File.expand_path(path)
       mutex.synchronize do
         if dir?(abspath)
-          dirs[abspath] = true
+          root_dirs[abspath] = true
         else
           raise ArgumentError, "the root directory #{abspath} does not exist"
         end
@@ -135,7 +161,7 @@ module Zeitwerk
       end
     end
 
-    # Files or directories to be totally ignored.
+    # Configure files, directories, or glob patterns to be totally ignored.
     #
     # @param paths [<String, Pathname, <String, Pathname>>]
     # @return [void]
@@ -143,13 +169,22 @@ module Zeitwerk
       mutex.synchronize { ignored.merge(expand_paths(paths)) }
     end
 
+    # @private
+    # @return [void]
+    def expand_ignored_glob_patterns
+      # Note that Dir.glob works with regular file names just fine. That is,
+      # glob patterns technically need no wildcards.
+      ignored_paths.replace(ignored.flat_map { |path| Dir.glob(path) })
+    end
+
     # Sets autoloads in the root namespace and preloads files, if any.
     #
     # @return [void]
     def setup
       mutex.synchronize do
         unless @setup
-          actual_dirs.each { |dir| set_autoloads_in_dir(dir, Object) }
+          expand_ignored_glob_patterns
+          non_ignored_root_dirs.each { |dir| set_autoloads_in_dir(dir, Object) }
           do_preload
           @setup = true
         end
@@ -171,7 +206,7 @@ module Zeitwerk
           if parent.autoload?(cname)
             parent.send(:remove_const, cname)
             log("autoload for #{cpath(parent, cname)} removed") if logger
-          elsif parent.const_defined?(cname, false)
+          elsif cdef?(parent, cname)
             parent.send(:remove_const, cname)
             log("#{cpath(parent, cname)} unloaded") if logger
           end
@@ -182,6 +217,7 @@ module Zeitwerk
           $LOADED_FEATURES.delete(path) if ruby?(path)
         end
         autoloads.clear
+        loaded.clear
         lazy_subdirs.clear
 
         Registry.on_unload(self)
@@ -211,13 +247,21 @@ module Zeitwerk
     def eager_load
       mutex.synchronize do
         unless @eager_loaded
-          actual_dirs.each { |dir| eager_load_dir(dir) }
+          non_ignored_root_dirs.each { |dir| eager_load_dir(dir) }
           disable_tracer
           @eager_loaded = true
         end
       end
     end
 
+    # Says if the given constant path as been loaded.
+    #
+    # @param cpath [String]
+    # @return [Boolean]
+    def loaded?(cpath)
+      loaded.member?(cpath)
+    end
+
     # --- Class methods ---------------------------------------------------------------------------
 
     # This is a shortcut for
@@ -230,9 +274,6 @@ module Zeitwerk
     # except that this method returns the same object in subsequent calls from
     # the same file, in the unlikely case the gem wants to be able to reload.
     #
-    # `Zeitwerk::GemInflector` is a subclass of `Zeitwerk::Inflector` that
-    # camelizes "lib/my_gem/version.rb" as "MyGem::VERSION".
-    #
     # @return [Zeitwerk::Loader]
     def self.for_gem
       called_from = caller[0].split(':')[0]
@@ -246,6 +287,14 @@ module Zeitwerk
       Registry.loaders.each(&:eager_load)
     end
 
+    # Returns an array with the absolute paths of the root directories of all
+    # registered loaders. This is a read-only collection.
+    #
+    # @return [<String>]
+    def self.all_dirs
+      Registry.loaders.flat_map(&:dirs).freeze
+    end
+
     # --- Callbacks -------------------------------------------------------------------------------
 
     # Callback invoked from Kernel when a managed file is loaded.
@@ -254,10 +303,9 @@ module Zeitwerk
     # @param file [String]
     # @return [void]
     def on_file_loaded(file)
-      if logger
-        parent, cname = autoloads[file]
-        log("constant #{cpath(parent, cname)} loaded from file #{file}")
-      end
+      parent, cname = autoloads[file]
+      loaded.add(cpath(parent, cname))
+      log("constant #{cpath(parent, cname)} loaded from file #{file}") if logger
     end
 
     # Callback invoked from Kernel when a managed directory is loaded.
@@ -267,6 +315,7 @@ module Zeitwerk
     # @return [void]
     def on_dir_loaded(dir)
       parent, cname = autoloads[dir]
+      loaded.add(cpath(parent, cname))
       autovivified = parent.const_set(cname, Module.new)
       log("module #{cpath(parent, cname)} autovivified from directory #{dir}") if logger
 
@@ -278,8 +327,8 @@ module Zeitwerk
     private # -------------------------------------------------------------------------------------
 
     # @return [<String>]
-    def actual_dirs
-      dirs.keys.delete_if { |dir| ignored.member?(dir) }
+    def non_ignored_root_dirs
+      root_dirs.keys.delete_if { |dir| ignored_paths.member?(dir) }
     end
 
     # @param dir [String]
@@ -297,7 +346,7 @@ 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 dirs.key?(abspath)
+          autoload_subdir(parent, cname, abspath) unless root_dirs.key?(abspath)
         end
       end
     end
@@ -307,13 +356,13 @@ module Zeitwerk
     # @param subdir [String]
     # @return [void]
     def autoload_subdir(parent, cname, subdir)
-      if autoload = autoload_for?(parent, cname)
-        enable_tracer if ruby?(autoload)
+      if autoload_path = autoload_for?(parent, cname)
+        enable_tracer if ruby?(autoload_path)
         # We do not need to issue another autoload, the existing one is enough
         # no matter if it is for a file or a directory. Just remember the
         # subdirectory has to be visited if the namespace is used.
         (lazy_subdirs[cpath(parent, cname)] ||= []) << subdir
-      elsif !parent.const_defined?(cname, false)
+      elsif !cdef?(parent, cname)
         # First time we find this namespace, set an autoload for it.
         (lazy_subdirs[cpath(parent, cname)] ||= []) << subdir
         set_autoload(parent, cname, subdir)
@@ -340,7 +389,7 @@ module Zeitwerk
 
         set_autoload(parent, cname, file)
         enable_tracer
-      elsif !parent.const_defined?(cname, false)
+      elsif !cdef?(parent, cname)
         set_autoload(parent, cname, file)
       end
     end
@@ -382,11 +431,14 @@ module Zeitwerk
     # @param dir [String]
     # @return [void]
     def eager_load_dir(dir)
-      each_abspath(dir) do |abspath|
-        if ruby?(abspath)
-          require abspath
-        elsif dir?(abspath)
-          eager_load_dir(abspath)
+      queue = [dir]
+      while dir = queue.shift
+        each_abspath(dir) do |abspath|
+          if ruby?(abspath)
+            require abspath
+          elsif dir?(abspath)
+            queue << abspath
+          end
         end
       end
     end
@@ -438,7 +490,7 @@ module Zeitwerk
       Dir.foreach(dir) do |entry|
         next if entry.start_with?(".")
         abspath = File.join(dir, entry)
-        yield abspath unless ignored.member?(abspath)
+        yield abspath unless ignored_paths.member?(abspath)
       end
     end
 
@@ -475,5 +527,9 @@ module Zeitwerk
     def disable_tracer
       tracer.disable if tracer.enabled?
     end
+
+    def cdef?(parent, cname)
+      parent.const_defined?(cname, false)
+    end
   end
 end

data/lib/zeitwerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zeitwerk
-  VERSION = "1.0.0.beta2"
+  VERSION = "1.0.0.beta3"
 end

metadata

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