ruby-on-rails - rails 6 : Automatically reload local gem on change

Question

我正在并行开发一个 Rails 6 应用程序和一个 Gem。

过去，我使用 require_reloader Gem，以便 Rails 在 Gem 的本地目录中更改任何文件时重新加载 Gem。

随着 Zeitwerk 成为 Rails 6 中的新加载器，这个 Gem 似乎不再起作用了。

所以我的问题是:并行开发 Gem 和 Rails 6 应用程序以便在 Rails 中自动显示对 Gem 文件所做的更改的规范方法是什么？

Answer 1

我也没有找到这个问题的规范解决方案，但是，在 Rails: Auto-reload gem files used in dummy app 的上下文中, 找到了解决方法:

假设，gem文件夹是

~/rails/foo_gem

rails-6-app 文件夹是:

~/rails/bar_app

要在文件系统更改时重新加载应用程序中的 gem 代码，我需要执行三个步骤:

1. 取消注册 foo_gem.rb 中定义的 zeitwerk 加载器，该加载器负责加载不同的 gem 文件。
2. 在配置了 enable_reloading 的应用程序的 development.rb 中定义一个新的 zeitwerk 加载器。
3. 设置文件系统观察器并在 gem 文件更改时触发重新加载。

Zeitwerk::Loader 在 foo_gem.rb

# ~/rails/foo_gem/lib/foo_gem.rb

# require 'foo_gem/bar`  # Did not work. Instead:

# (a) use zeitwerk:
require "zeitwerk"
loader = Zeitwerk::Loader.new
loader.push_dir File.join(__dir__)
loader.tag = "foo_gem"
loader.setup

# or (b) use autoload:
module FooGem
  autoload :Bar, "foo_gem/bar"
end

注意:

• 过去，我只是从一种名为 gem 的索引文件中使用 require 加载 gem 的所有 ruby​​ 文件，这里是:foo_gem.rb。这在这里不起作用，因为 zeitwerk 似乎忽略了以前使用 require 加载的文件。相反，我需要为 gem 创建一个单独的 zeitwerk 加载程序。
• 此加载程序没有enable_reloading，否则，无论何时使用 gem，都会为该 gem 启用重新加载，而不仅仅是在开发 gem 时。
• 我已经为加载器提供了一个标签，它允许稍后在Zeitwerk::Registry 中找到这个加载器以便注销它。
• 除了在 foo_gem.rb 中使用 zeitwerk，还可以在那里使用 autoload like the devise gem does .如果您想支持早于 6 的 rails 版本，这是最好的方法，因为 zeitwerk 需要 rails 6+。在此处使用 autoload 还可以使下一节中的第 1 步变得不必要。

Zeitwerk::Loader 在应用程序的development.rb

# ~/rails/bar_app/config/environments/development.rb

# 1. Unregister the zeitwerk loader defined in foo_gem.rb that handles loading
#    the different gem files.
#
Zeitwerk::Registry.loaders.detect { |l| l.tag == "foo_gem" }.unregister

# 2. Define a new zeitwerk loader in the development.rb of the app
#    that is configured with enable_reloading.
#
gem_root_path = Pathname.new(Gem.loaded_specs["foo_gem"].full_gem_path)
gem_loader = Zeitwerk::Loader.new
gem_loader.push_dir gem_root_path.join("lib")
gem_loader.enable_reloading
gem_loader.setup

# 3. Setup a file-system watcher and trigger a reload when a gem file changes.
#
Listen.to gem_root_path.join("lib"), only: /\.rb$/ do
  gem_loader.reload
end.start

注意:

• Zeitwerk 不允许两个加载程序管理相同的文件。因此，我需要注销之前定义的标记为 “foo_gem” 的加载程序。
• 应用中使用的新加载器具有enable_reloading。因此，当将应用程序与 rails server、rails console 一起使用时，或者在运行规范时，可以重新加载 gem 文件。
• zeitwerk 不会自动重新加载 gem 文件。需要一个文件系统观察器来触发文件系统更改的重新加载。我没能得到 ActiveSupport::FileUpdateChecker在职的。相反，我使用了 listen gem 作为文件系统观察器。

通过此设置，当使用 rails server、rails console 或 bar_app 的规范时，foo_gem 的 gem 文件在编辑后重新加载，这意味着不再需要重新启动 rails 服务器 来获取更改。

但是，我觉得这个解决方法不是很方便。