zeitwerk 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 071170ec551e69be67c517af6e04ae2788d6f81f6451a7da0dfab49be8f0c52b
-  data.tar.gz: 96fd655043bee86c5f57567a01b5f5282e315b72bde7e5ca370ee8fd5e7917fb
+  metadata.gz: f6f3971296735d2ad5ae2d2621b5f26d6f480e7b69fde7e6eb21679a2b0c795c
+  data.tar.gz: 41ce43ff32412f63d21fb5bd9f45dc070e48e96f03be1e49eb2a5c6c5ef107ba
 SHA512:
-  metadata.gz: 2b74298014af2753fbb19ad36f2a5d484cfbe364beb6aa583fe43d1f2cdf2fc3135bd5aaa16bedeb45a4a4ecbae95fc9d2e62aae5b59fd3df7cf5422693a947f
-  data.tar.gz: 242710104b8d2fba905cb65d1382080d098f4ff6c3d8b982d1cf53e9ea877612b22ee07b9d3f8f155a17b354e8412f2f350d835e7418f6eef7cf33a324a5ea4a
+  metadata.gz: 2b543e2a0db16c3dcdf8318faeaae7e1a72b0001b6116fa0081fa991266fbcc75da8ebdecaf9cf17568d9b169688810f411fb5d578a6ce7f5fad60a5fea37380
+  data.tar.gz: 021343c474a12a015071b20eaff22c53fdf9d0a49e606ee460be809fd731be065e72573ffb082bfab19b14f432000b309cc3e8e44e75669b97d91fa5b275519a

data/README.md

@@ -305,8 +305,8 @@ loader.nsfile = 'ns.rb' # must be set before setup
 you can alternatively define the explicit namespace inside its directory:
 
 ```
-my_component/ns.rb     # MyComponent
-my_component/widget.rb # MyComponent::Widget
+my_component/ns.rb     -> MyComponent
+my_component/widget.rb -> MyComponent::Widget
 ```
 
 This may be handy for self-contained units for which a `my_component.rb` file in the parent directory would feel unnatural.
@@ -316,19 +316,19 @@ A loader's nsfile has to be a non-hidden basename with a `.rb` extension, as in
 Collapsed directories work as expected. For example, if we assume that `src` is collapsed, and that `assets` and `tests` are ignored, you could have the code organized this way:
 
 ```
-my_component/src/ns.rb     # MyComponent
-my_component/src/widget.rb # MyComponent::Widget
+my_component/src/ns.rb            -> MyComponent
+my_component/src/widget.rb        -> MyComponent::Widget
 my_component/assets/widget.js
 my_component/tests/test_widget.rb
 ```
 
-Loaders with an nsfile configured also support explicit namespaces defined in ordinary files. The styles are not exclusive. Some parts of the project may be component-oriented, while in other parts ordinary files may feel more natural. That works.
+Loaders with an nsfile configured also support explicit namespaces defined in ordinary files. The conventions are not exclusive project-wide. Some parts may be component-oriented, while in other parts ordinary files may feel more natural. That works.
 
 However, attempting to define the same namespace using an ordinary file and an nsfile is an error condition that raises `Zeitwerk::ConflictingNamespaceDefinitionError`.
 
 Nsfiles in root directories raise `Zeitwerk::ConflictingNamespaceDefinitionError` too, since the namespace in a root directory is externally defined.
 
-A project file whose basename is equal to the nsfile is always considered to be an nsfile. You cannot opt out. Therefore, if we have:
+Non-ignored files whose basename is equal to the nsfile are always considered to be nsfiles. You cannot opt out. Therefore, if we have:
 
 ```ruby
 loader.nsfile = 'index.rb'
@@ -336,12 +336,6 @@ loader.nsfile = 'index.rb'
 
 there is no way `foo/index.rb` can define `Foo::Index` in any part of the project, it must define `Foo`.
 
-While configurable, `ns.rb` is the recommended convention:
-
-* `ns.rb` is short.
-* `ns.rb` suggests "namespace".
-* Needing an `Ns` constant is unlikely.
-
 <a id="markdown-collapsing-directories" name="collapsing-directories"></a>
 ### Collapsing directories
 

data/lib/zeitwerk/loader/file_system.rb

@@ -27,7 +27,7 @@ class Zeitwerk::Loader::FileSystem # :nodoc:
   # path, and file type, which can only be :file or :directory.
   #
   #: (String) { (String, String, Symbol) -> void } -> void
-  def ls(dir, collapse: true, &)
+  def ls(dir, collapse: true, &block)
     children = relevant_dir_entries(dir)
 
     # The order in which a directory is listed depends on the file system.
@@ -43,7 +43,7 @@ class Zeitwerk::Loader::FileSystem # :nodoc:
           @loader.__log { "directory #{abspath} is ignored because it has no Ruby files" }
           next
         elsif collapse && @loader.__collapse?(abspath)
-          ls(abspath, collapse: collapse, &)
+          ls(abspath, collapse: collapse, &block)
           next
         end
       end

data/lib/zeitwerk/registry/loaders.rb

@@ -6,8 +6,8 @@ module Zeitwerk::Registry
     end
 
     #: ({ (Zeitwerk::Loader) -> void }) -> void
-    def each(&)
-      @loaders.each(&)
+    def each(&block)
+      @loaders.each(&block)
     end
 
     #: (Zeitwerk::Loader) -> void

data/lib/zeitwerk/version.rb

@@ -2,5 +2,5 @@
 
 module Zeitwerk
   #: String
-  VERSION = '2.8.0'
+  VERSION = '2.8.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeitwerk
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Xavier Noria