Zeitwerk：将引擎/宝石目录添加到父母铁路应用程序的自动加载路径

Question

我正在尝试在现有的旧宝石（Rails ::引擎）中切换到Zeitwerk。到目前为止，所有文件均已手动需要 d和自动加载 ed。再加上引擎的LIB折叠器通过config.autoload_paths +=路径[“ lib”]。to_a in 类myEngine＆lt; Rails ::引擎。

使用Zeitwerk的开关通过 readme ：

require "zeitwerk"
loader = Zeitwerk::Loader.for_gem
.
. --> more project specific stuff here
.
loader.setup # ready!

太好了！现在，我想在Rails应用程序中使用GEM，然后将发动机的目录添加到Rails应用程序的AutoLoad_Path中。以前通过上述config.autoload_paths进行了正常工作。如果我现在这样做，则会失败以下错误消息：

Zeitwerk::Error:
  loader

#<Zeitwerk::Loader:0x00000001094d4bd0
...

wants to manage directory /gems/<NameOfGem>/lib, which is already managed by

#<Zeitwerk::Loader:0x0000000106b2d728
...

将引擎的LIB目录添加到Rails应用程序的自动加载路径中的正确方法是什么？

谢谢你！

Answer 1

rails 设置两个加载程序main and 一旦：

Rails.autoloaders.main
Rails.autoloaders.once

这些只是zeitwerk :: Loader的实例。 rails 还为您提供了一个配置，将根目录添加到这些加载程序中：

config.autoload_paths         # main
config.autoload_once_paths    # once

当Gem的lib目录通过以下一种配置之一添加到自动加载到AutoLoad， lib 成为根目录：

# config.autoload_paths += paths["lib"].to_a

>> Rails.autoloaders.main.root_dirs
=> 
...                    
 "/home/alex/code/stackoverflow/my_engine/lib"=>Object,
...

当称为GEM的类时， zeitwerk 使用注册的加载程序查找并加载与此类相对应的文件。

如果GEM然后设置自己的加载程序：

require "zeitwerk"
loader = Zeitwerk::Loader.for_gem
loader.setup

zeitwerk :: Loader的另一个实例是用自己的根目录创建的：

>> Zeitwerk::Registry.loaders.detect { |z| z.tag == "my_engine" }
=> 
#<Zeitwerk::GemLoader:0x00007fe5e53e0f80
...
 @root_dirs={"/home/alex/code/stackoverflow/my_engine/lib"=>Object},
...

# NOTE: these are the two loaders registered by rails
>> Zeitwerk::Registry.loaders.select { |z| z.tag =~ /rails/ }.count
=> 2

zeitwerk 不允许两个加载程序具有共享目录并提出一个错误，显示两个冲突的装载机。

因为宝石是a rails :: Engine 最好的选择是让 rails manage zeitwerk 加载器，然后删除 zeitwerk :: loader。 for_gem 设置。

# only use rails config
config.autoload_paths += paths["lib"].to_a

另一方面，已经设置了GEM Loader，并且不需要 config.autoload_paths 。

# NOTE: without any loaders
>> MyEngine::Test
# (irb):1:in `<main>': uninitialized constant MyEngine::Test (NameError)                                            
# MyEngine::Test                                
#         ^^^^^^

# NOTE: with gem loader
#
#   require "zeitwerk"
#   loader = Zeitwerk::Loader.for_gem
#   loader.setup                           
#
>> MyEngine::Test
=> MyEngine::Test

# NOTE: with rails `main` loader
#
#   config.autoload_paths += paths["lib"].to_a
#
>> MyEngine::Test
=> MyEngine::Test

# NOTE: with gem loader and rails loader
$ bin/rails c
# /home/alex/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/gems/zeitwerk-2.6.0/lib/zeitwerk/loader.rb:480:in
# `block (3 levels) in raise_if_conflicting_directory':
# loader (Zeitwerk::Error)

更新

# Use rails loaders
# config.autoload_path          .->  Zeitwerk::Loader(@tag=rails.main)
# config.autoload_once_path     |->  Zeitwerk::Loader(@tag=rails.once)
#                               |
# Or create a new loader        |
# Zeitwerk::Loader.for_gem      |->  Zeitwerk::GemLoader(@tag=my_engine)
#                               |
# my_engine/lib can only be in one of these

zeitwerk 进行加载和重新加载。 rails 在这里只是另一个宝石。

如果您不使用Rails Config，则 zeitwerk 将通过zeitwerk :: gemloader（@tag = my_engine） 找到文件。

如果您使用Rails Config， Zeitwerk 将通过Zeitwerk :: Loader（@tag = rails.main）找到文件（Make Gemloader

如果 lib 是任何现有加载程序中的根目录，则无需在 lib 目录中具有任何需要或自动加载文件。除了在 zeitwerk 启动之前需要的东西，例如 myEngine ::引擎 from lib/my_engine/Engine.rb 。