zeitwerk 1.1.0 → 1.2.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce0c3d755356cd98361bd89b27925a3083632a8e2f25191808e987d0f5a0c40e
-  data.tar.gz: fb21b9d8e59e12b672a464e748157814c265898da26a71225229f29d9ea9023f
+  metadata.gz: '08f2b427ddbb6d8f7b995820ebafc52933ae2682fd19779097b6ab8c95205644'
+  data.tar.gz: 16b8e508f9026e87f2a66ecfe587a4b19dcc213e3393743b00d82e560ea601fb
 SHA512:
-  metadata.gz: b3fa972c877ed3c36efc98224088869ec383370bbf002761e0f379550ce31e50cf387a729890fd36e4768d99929a566ef3587a717208aa7d6e8e7abb1c29df1b
-  data.tar.gz: ab0b2b3e11d46e21ce3605f8dcf8dcb6a579ca6ce7438c58d6b87d07f1431f4c346bdc07d5c1ae9601a577d5c592e938f07a56fe583b8fa27a308371afca4fea
+  metadata.gz: 1a41b015721362e40fdc5ae4402e388dfd38814d642a87e89aa4a90f36dca863cb562be68b11269817269a58862bf89761f1b671ff9be8b24dd220114a85298e
+  data.tar.gz: b2f7d5b6f61ee132a0608550f1e18bc58c8b2eff7eba154534742945373c4409e82eb7556a09a4179aca903d9b0c2136d2833902e2a3ea1743f4ade792902c91

data/README.md

@@ -24,9 +24,9 @@
         - [Logging](#logging)
             - [Loader tag](#loader-tag)
         - [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)
+            - [Use case: Files that do not follow the conventions](#use-case-files-that-do-not-follow-the-conventions)
+            - [Use case: The adapter pattern](#use-case-the-adapter-pattern)
+            - [Use case: Test files mixed with implementation files](#use-case-test-files-mixed-with-implementation-files)
         - [Edge cases](#edge-cases)
     - [Pronunciation](#pronunciation)
     - [Supported Ruby versions](#supported-ruby-versions)
@@ -336,7 +336,7 @@ You can ignore file names, directory names, and glob patterns. Glob patterns are
 
 Let's see some use cases.
 
-#### Files that do not follow the conventions
+#### Use case: Files that do not follow the conventions
 
 Let's suppose that your gem decorates something in `Kernel`:
 
@@ -356,9 +356,28 @@ loader.ignore(kernel_ext)
 loader.setup
 ```
 
-#### The adapter pattern
+You can also ignore the whole directory:
 
-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
+core_ext = "#{__dir__}/my_gem/core_ext"
+loader.ignore(core_ext)
+loader.setup
+```
+
+#### Use case: 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:
+
+```ruby
+# my_gem/db_adapters/postgresql.rb
+require "pg"
+```
+
+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 = "#{__dir__}/my_gem/db_adapters"
@@ -372,7 +391,7 @@ 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
+#### 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:
 

data/lib/zeitwerk.rb

@@ -6,4 +6,5 @@ module Zeitwerk
   require_relative "zeitwerk/inflector"
   require_relative "zeitwerk/gem_inflector"
   require_relative "zeitwerk/kernel"
+  require_relative "zeitwerk/conflicting_directory"
 end

data/lib/zeitwerk/conflicting_directory.rb

@@ -0,0 +1,2 @@
+class Zeitwerk::ConflictingDirectory < StandardError
+end

data/lib/zeitwerk/loader.rb

@@ -145,9 +145,10 @@ module Zeitwerk
     # @param path [<String, Pathname>]
     # @return [void]
     def push_dir(path)
-      abspath = File.expand_path(path)
-      mutex.synchronize do
+      self.class.mutex.synchronize do
+        abspath = File.expand_path(path)
         if dir?(abspath)
+          raise_if_conflicting_directory(abspath)
           root_dirs[abspath] = true
         else
           raise ArgumentError, "the root directory #{abspath} does not exist"
@@ -191,7 +192,7 @@ module Zeitwerk
       mutex.synchronize do
         unless @setup
           expand_ignored_glob_patterns
-          non_ignored_root_dirs.each { |dir| set_autoloads_in_dir(dir, Object) }
+          non_ignored_root_dirs.each { |root_dir| set_autoloads_in_dir(root_dir, Object) }
           do_preload
           @setup = true
         end
@@ -253,11 +254,21 @@ module Zeitwerk
     # @return [void]
     def eager_load
       mutex.synchronize do
-        unless @eager_loaded
-          non_ignored_root_dirs.each { |dir| eager_load_dir(dir) }
-          disable_tracer
-          @eager_loaded = true
+        break if @eager_loaded
+
+        queue = non_ignored_root_dirs
+        while dir = queue.shift
+          each_abspath(dir) do |abspath|
+            if ruby?(abspath)
+              require abspath
+            elsif dir?(abspath)
+              queue << abspath
+            end
+          end
         end
+
+        disable_tracer
+        @eager_loaded = true
       end
     end
 
@@ -275,6 +286,10 @@ module Zeitwerk
       # @return [#call, nil]
       attr_accessor :default_logger
 
+      # @private
+      # @return [Mutex]
+      attr_accessor :mutex
+
       # This is a shortcut for
       #
       #   require "zeitwerk"
@@ -307,6 +322,8 @@ module Zeitwerk
       end
     end
 
+    self.mutex = Mutex.new
+
     # --- Callbacks -------------------------------------------------------------------------------
 
     # Callback invoked from Kernel when a managed file is loaded.
@@ -327,12 +344,14 @@ 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
 
-      if subdirs = lazy_subdirs[cpath(parent, cname)]
-        subdirs.each { |subdir| set_autoloads_in_dir(subdir, autovivified) }
+      autovivified_module = parent.const_set(cname, Module.new)
+      log("module #{autovivified_module.name} autovivified from directory #{dir}") if logger
+
+      loaded.add(autovivified_module.name)
+
+      if subdirs = lazy_subdirs[autovivified_module.name]
+        subdirs.each { |subdir| set_autoloads_in_dir(subdir, autovivified_module) }
       end
     end
 
@@ -340,7 +359,7 @@ module Zeitwerk
 
     # @return [<String>]
     def non_ignored_root_dirs
-      root_dirs.keys.delete_if { |dir| ignored_paths.member?(dir) }
+      root_dirs.keys.delete_if { |root_dir| ignored_paths.member?(root_dir) }
     end
 
     # @param dir [String]
@@ -440,21 +459,6 @@ module Zeitwerk
       parent.autoload?(cname) || Registry.inception?(cpath(parent, cname))
     end
 
-    # @param dir [String]
-    # @return [void]
-    def eager_load_dir(dir)
-      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
-
     # This method is called this way because I prefer `preload` to be the method
     # name to configure preloads in the public interface.
     #
@@ -545,5 +549,20 @@ module Zeitwerk
     def cdef?(parent, cname)
       parent.const_defined?(cname, false)
     end
+
+    def raise_if_conflicting_directory(dir)
+      Registry.loaders.each do |loader|
+        next if loader == self
+
+        loader.dirs.each do |already_managed_dir|
+          if dir.start_with?(already_managed_dir) || already_managed_dir.start_with?(dir)
+            raise ConflictingDirectory,
+              "loader\n\n\t#{inspect}\n\nwants to manage directory #{dir}," \
+              " which is already managed by\n\n\t#{loader.inspect}"
+            EOS
+          end
+        end
+      end
+    end
   end
 end

data/lib/zeitwerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zeitwerk
-  VERSION = "1.1.0"
+  VERSION = "1.2.0.beta"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeitwerk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0.beta
 platform: ruby
 authors:
 - Xavier Noria
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-02-17 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Zeitwerk implements constant autoloading with Ruby semantics. Each gem
@@ -22,6 +22,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/zeitwerk.rb
+- lib/zeitwerk/conflicting_directory.rb
 - lib/zeitwerk/gem_inflector.rb
 - lib/zeitwerk/inflector.rb
 - lib/zeitwerk/kernel.rb
@@ -43,9 +44,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.1
 signing_key: