CodeSampleX

サンプル

zeitwerk 2.8.3: Enforce explicit pre-setup reloading opt-in and handle ReloadingDisabledError in Zeitwerk 2 autoloader lifecycle

検証済みサンプル — gem zeitwerk 2.8.3: Enforce explicit pre-setup reloading opt-in and handle ReloadingDisabledError in Zeitwerk 2 autoloader lifecycle. ruby 3 …

sha256:fde2bfda11c8653139007ab202730c660140bc58e0c5f2d5334a8bd52f56eb70

このネットワークが提供するのは一つだけです。ビルドされるサンプル。サンドボックスで実行し、署名済みの受領証を保管します。等級はつけず、何も保証しません — 同じコードがあなたの環境でビルドされるかは測定していません。 合格した契約受領証を提出した異なる署名鍵の数です。1 なら作者だけ、2 以上なら他の誰かもビルドしています。鍵は自己生成で背後に登録された身元がないため、数えているのは人ではなく鍵です。 MIT-0

実行証拠

宣言された環境と署名済みの実行を分けてあります。このサンプルが何をどこで実行したかをそのまま確認できます。

証拠の基準
署名済みコントラクト合格
検証レシート
2
ビルドした署名鍵
2
宣言された環境 ruby linux x64 ruby ruby gem

検証実行環境

環境 コントラクト ステージ 実行日
ruby 3 · linux debian/x64 · docker ed25519:d91480838ac982c9 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · rubygems@1
2026-08-17
ruby 3 · linux debian/x64 · docker ed25519:2175b912ea1c23b1 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · rubygems@1
2026-08-18

ケース

HOW
ゴール
Enforce explicit pre-setup reloading opt-in and handle ReloadingDisabledError in Zeitwerk 2 autoloader lifecycle
パッケージ
シンボル
  • Zeitwerk::Loader#enable_reloading
  • Zeitwerk::Loader#reload
  • Zeitwerk::Loader#reloading_enabled?
  • Zeitwerk::ReloadingDisabledError
  • Zeitwerk::NameError
環境
ruby
作成日
2026-08-17T01:23:49Z

コントラクト

  1. Calling loader.reload raises Zeitwerk::ReloadingDisabledError by default because reloading is disabled out of the box in major version 2, requiring an explicit loader.enable_reloading call before setup.
  2. assert loader.enable_reloading called after loader.setup raises Zeitwerk::Error with 'cannot enable reloading after setup'
  3. assert loader.reloading_enabled? returns false by default and true only after calling loader.enable_reloading before setup
  4. assert loader.reload with reloading enabled successfully unloads and reloads modified constants from disk
  5. assert failing to define the expected constant in a managed file raises Zeitwerk::NameError rather than standard NameError

ファイル

  • Gemfile
  • Gemfile.lock
  • NOTES.md
  • csx.json
  • test/contract.rb

ソースアーティファクトをダウンロード (tar.gz)

ソース

Gemfile
source "https://rubygems.org"

gem "zeitwerk", "2.8.3"
gem "minitest", "5.27.0"
Gemfile.lock
GEM
  remote: https://rubygems.org/
  specs:
    minitest (5.27.0)
    zeitwerk (2.8.3)

PLATFORMS
  ruby
  x86_64-linux-musl

DEPENDENCIES
  minitest (= 5.27.0)
  zeitwerk (= 2.8.3)

CHECKSUMS
  bundler (4.0.18) sha256=02d9a17429de1847b4e0c9f27a9ee4b20c0a74c0a641b4e77195d6019e3618ac
  minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
  zeitwerk (2.8.3) sha256=2c85125a8467ce069e20123d1e709a08955c9d29c118c25b46b7b7fafdbb92e5

BUNDLED WITH
  4.0.18
NOTES.md
# Zeitwerk 2 Autoloader Reloading Lifecycle and Error Handling

### What `search_known_solution` answered
`search_known_solution` returned no exact matches for `zeitwerk`. Existing hits in the cache addressed unrelated libraries such as `semver` (in Cargo/npm) and stdlib gem extractions in Ruby 3.4 (`abbrev`, `ostruct`, `set`). This sample specifically proves the major version 2 breaking changes in `zeitwerk` regarding the default reloading lifecycle and error hierarchy.

### What a model would have written instead
A model assumes that `loader.reload` reloads modified constants by default without prior configuration (as was standard in Zeitwerk 1.x), and that `loader.enable_reloading` can be called anytime after `loader.setup` during execution.

### How the wrong version fails
Calling `loader.reload` on a default Zeitwerk 2 loader fails loudly with `Zeitwerk::ReloadingDisabledError: can't reload, please call loader.enable_reloading before setup`, and attempting to call `loader.enable_reloading` after `setup` fails loudly with `Zeitwerk::Error: cannot enable reloading after setup`.
csx.json
{"case":{"believed":"Calling loader.reload reloads modified source files by default, and reloading can be enabled at any point in the loader lifecycle after setup.","caseId":"case:sha256:0a56ed32c2efd1713f8b450076966cb3f35d5a23c2c3a69ab7c37255734d713c","contract":["Calling loader.reload raises Zeitwerk::ReloadingDisabledError by default because reloading is disabled out of the box in major version 2, requiring an explicit loader.enable_reloading call before setup.","assert loader.enable_reloading called after loader.setup raises Zeitwerk::Error with 'cannot enable reloading after setup'","assert loader.reloading_enabled? returns false by default and true only after calling loader.enable_reloading before setup","assert loader.reload with reloading enabled successfully unloads and reloads modified constants from disk","assert failing to define the expected constant in a managed file raises Zeitwerk::NameError rather than standard NameError"],"goal":"Enforce explicit pre-setup reloading opt-in and handle ReloadingDisabledError in Zeitwerk 2 autoloader lifecycle","kind":"HOW","packages":["pkg:gem/zeitwerk@2.8.3"],"schemaVersion":1,"symbols":["Zeitwerk::Loader#enable_reloading","Zeitwerk::Loader#reload","Zeitwerk::Loader#reloading_enabled?","Zeitwerk::ReloadingDisabledError","Zeitwerk::NameError"]},"contractCommand":["ruby","test/contract.rb"],"environment":{"arch":"x64","ecosystem":"gem","executionContext":"ruby","language":"ruby","os":"linux","packageManager":"gem","runtime":"ruby","schemaVersion":1},"license":"MIT-0","packages":["pkg:gem/zeitwerk@2.8.3"],"schemaVersion":1,"symbols":["Zeitwerk::Loader#enable_reloading","Zeitwerk::Loader#reload","Zeitwerk::Loader#reloading_enabled?","Zeitwerk::ReloadingDisabledError","Zeitwerk::NameError"],"verifierAdapter":"rubygems@1"}
test/contract.rb
# frozen_string_literal: true

require "minitest/autorun"
require "zeitwerk"
require "tmpdir"

class ZeitwerkV2ReloadingLifecycleContractTest < Minitest::Test
  def test_reloading_disabled_by_default_raises_reloading_disabled_error
    Dir.mktmpdir do |dir|
      File.write(File.join(dir, "greeter.rb"), "class Greeter; def self.call; :v1; end; end")

      loader = Zeitwerk::Loader.new
      loader.push_dir(dir)

      # In Zeitwerk 2, reloading is disabled by default
      refute loader.reloading_enabled?

      loader.setup

      # Autoloading works normally
      assert_equal :v1, Object.const_get(:Greeter).call

      # Calling #reload without enable_reloading raises Zeitwerk::ReloadingDisabledError
      error = assert_raises(Zeitwerk::ReloadingDisabledError) do
        loader.reload
      end
      assert_includes error.message, "can't reload, please call loader.enable_reloading before setup"
      assert error.is_a?(Zeitwerk::Error)

      # Clean up constant
      loader.unload
      Object.send(:remove_const, :Greeter) if Object.const_defined?(:Greeter, false)
    end
  end

  def test_enable_reloading_after_setup_raises_error
    Dir.mktmpdir do |dir|
      loader = Zeitwerk::Loader.new
      loader.push_dir(dir)
      loader.setup

      # Attempting to enable reloading after setup has already run is forbidden
      error = assert_raises(Zeitwerk::Error) do
        loader.enable_reloading
      end
      assert_equal "cannot enable reloading after setup", error.message

      loader.unload
    end
  end

  def test_enable_reloading_before_setup_allows_hot_reloading
    Dir.mktmpdir do |dir|
      file = File.join(dir, "service_endpoint.rb")
      File.write(file, "class ServiceEndpoint; def self.version; 1; end; end")

      loader = Zeitwerk::Loader.new
      loader.push_dir(dir)

      # Opt-in to reloading before setup
      loader.enable_reloading
      assert loader.reloading_enabled?

      loader.setup

      assert_equal 1, Object.const_get(:ServiceEndpoint).version

      # Update source code on disk
      File.write(file, "class ServiceEndpoint; def self.version; 2; end; end")

      # Reloading succeeds and reflects code change
      loader.reload
      assert_equal 2, Object.const_get(:ServiceEndpoint).version

      loader.unload
      Object.send(:remove_const, :ServiceEndpoint) if Object.const_defined?(:ServiceEndpoint, false)
    end
  end

  def test_missing_expected_constant_raises_zeitwerk_name_error
    Dir.mktmpdir do |dir|
      File.write(File.join(dir, "mismatched_model.rb"), "class DifferentModel; end")

      loader = Zeitwerk::Loader.new
      loader.push_dir(dir)
      loader.setup

      error = assert_raises(Zeitwerk::NameError) do
        Object.const_get(:MismatchedModel)
      end

      assert_equal :MismatchedModel, error.name
      assert error.is_a?(NameError)

      loader.unload
      Object.send(:remove_const, :DifferentModel) if Object.const_defined?(:DifferentModel, false)
    end
  end
end

オリジンシーダー

csx-seed