refactor: move reloadable require internal state out of IRB.conf

Author: ahogappa

lib/irb/init.rb

@@ -4,8 +4,6 @@
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
-require 'set'
-
 module IRB # :nodoc:
   @CONF = {}
   @INITIALIZED = false
@@ -201,8 +199,6 @@ def IRB.init_config(ap_path)
     @CONF[:COPY_COMMAND] = ENV.fetch("IRB_COPY_COMMAND", nil)
 
     @CONF[:RELOADABLE_REQUIRE] = false
-    @CONF[:__RELOADABLE_FILES__] = Set.new
-    @CONF[:__AUTOLOAD_FILES__] = Set.new
   end
 
   def IRB.set_measure_callback(type = nil, arg = nil, &block)

lib/irb/reloadable_require.rb

@@ -4,6 +4,8 @@
   raise "ReloadableRequire requires Ruby::Box to be enabled"
 end
 
+require 'set'
+
 module IRB
   # Provides reload-aware require functionality for IRB.
   #
@@ -15,28 +17,6 @@ module IRB
   #
   # This feature requires Ruby::Box (Ruby 4.0+).
 
-  class << self
-    def track_and_load_files(source, current_box)
-      before = source.dup
-      result = yield
-      new_files = source - before
-
-      return result if new_files.empty?
-
-      ruby_files, native_extensions = new_files.partition { |path| path.end_with?('.rb') }
-
-      native_extensions.each { |path| current_box.require(path) }
-
-      IRB.conf[:__RELOADABLE_FILES__].merge(ruby_files)
-
-      main_loaded_features = current_box.eval('$LOADED_FEATURES')
-      main_loaded_features.concat(ruby_files - main_loaded_features)
-      ruby_files.each { |path| current_box.load(path) }
-
-      result
-    end
-  end
-
   unless Ruby::Box.method_defined?(:__irb_original_require__)
     Ruby::Box.class_eval do
       alias_method :__irb_original_require__, :require
@@ -45,14 +25,13 @@ def track_and_load_files(source, current_box)
   end
 
   Ruby::Box.class_eval do
-
     def __irb_reloadable_require__(feature)
-      unless IRB.conf[:__AUTOLOAD_FILES__].include?(feature)
+      unless IRB::ReloadableRequire.autoload_files.include?(feature)
         return __irb_original_require__(feature)
       end
 
-      IRB.conf[:__AUTOLOAD_FILES__].delete(feature)
-      IRB.track_and_load_files($LOADED_FEATURES, Ruby::Box.main) { __irb_original_require__(feature) }
+      IRB::ReloadableRequire.autoload_files.delete(feature)
+      IRB::ReloadableRequire.track_and_load_files($LOADED_FEATURES, Ruby::Box.main) { __irb_original_require__(feature) }
     end
 
     def __irb_reloadable_require_relative__(feature)
@@ -61,7 +40,12 @@ def __irb_reloadable_require_relative__(feature)
   end
 
   module ReloadableRequire
+    @reloadable_files = Set.new
+    @autoload_files = Set.new
+
     class << self
+      attr_reader :reloadable_files, :autoload_files
+
       def extended(base)
         apply_autoload_hook
       end
@@ -72,6 +56,26 @@ def apply_autoload_hook
           alias_method :require_relative, :__irb_reloadable_require_relative__
         end
       end
+
+      def track_and_load_files(source, current_box)
+        before = source.dup
+        result = yield
+        new_files = source - before
+
+        return result if new_files.empty?
+
+        ruby_files, native_extensions = new_files.partition { |path| path.end_with?('.rb') }
+
+        native_extensions.each { |path| current_box.require(path) }
+
+        @reloadable_files.merge(ruby_files)
+
+        main_loaded_features = current_box.eval('$LOADED_FEATURES')
+        main_loaded_features.concat(ruby_files - main_loaded_features)
+        ruby_files.each { |path| current_box.load(path) }
+
+        result
+      end
     end
 
     private
@@ -81,7 +85,7 @@ def reloadable_require_internal(feature, caller_box)
       box.eval("$LOAD_PATH.concat(#{caller_box.eval('$LOAD_PATH')})")
       box.eval("$LOADED_FEATURES.concat(#{caller_box.eval('$LOADED_FEATURES')})")
 
-      IRB.track_and_load_files(box.eval('$LOADED_FEATURES'), caller_box) { box.__irb_original_require__(feature) }
+      ReloadableRequire.track_and_load_files(box.eval('$LOADED_FEATURES'), caller_box) { box.__irb_original_require__(feature) }
     end
 
     def require(feature)
@@ -108,7 +112,7 @@ def require_relative(feature)
     end
 
     def autoload(const, feature)
-      IRB.conf[:__AUTOLOAD_FILES__] << feature
+      ReloadableRequire.autoload_files << feature
       Ruby::Box.main.eval("Kernel.autoload(:#{const}, #{feature.dump})")
     end
   end

test/irb/test_reloadable_require.rb

@@ -203,6 +203,20 @@ def test_reload_preserves_loaded_features
       assert_equal 2, output.scan("=> true").count
     end
 
+    def test_require_native_extension
+      write_ruby <<~'RUBY'
+        binding.irb
+      RUBY
+
+      output = run_ruby_file do
+        type "require 'etc'"
+        type "Etc.getlogin"
+        type "exit!"
+      end
+
+      assert_include output, "=> true"
+    end
+
     def test_require_does_not_modify_load_path
       write_ruby <<~'RUBY'
         binding.irb
@@ -267,9 +281,11 @@ def create_pwd_file(name, content)
     end
   end
 
-  class ReloadCommandTest < TestCase
+  class BoxReloadCommandTest < TestCase
     def setup
       super
+      omit "BoxReload requires Ruby::Box" if !defined?(Ruby::Box) || !Ruby::Box.enabled?
+
       @tmpdir = Dir.mktmpdir
       @valid_file = File.join(@tmpdir, "valid.rb")
       File.write(@valid_file, "VALID = true\n")
@@ -279,25 +295,28 @@ def setup
       require "irb/command/reload"
       IRB.setup(__FILE__, argv: [])
       @original_reloadable = IRB.conf[:RELOADABLE_REQUIRE]
-      @original_files = IRB.conf[:__RELOADABLE_FILES__]
       IRB.conf[:RELOADABLE_REQUIRE] = true
-      IRB.conf[:__RELOADABLE_FILES__] = Set.new
+
+      @saved_files = IRB::ReloadableRequire.reloadable_files.dup
+      IRB::ReloadableRequire.reloadable_files.clear
     end
 
     def teardown
       super
-      FileUtils.rm_rf(@tmpdir)
-      IRB.conf[:RELOADABLE_REQUIRE] = @original_reloadable
-      IRB.conf[:__RELOADABLE_FILES__] = @original_files
+      FileUtils.rm_rf(@tmpdir) if @tmpdir
+      if defined?(IRB::ReloadableRequire) && @saved_files
+        IRB.conf[:RELOADABLE_REQUIRE] = @original_reloadable
+        IRB::ReloadableRequire.reloadable_files.replace(@saved_files)
+      end
     end
 
     def test_reload_file_preserves_loaded_features_on_syntax_error
       $LOADED_FEATURES << @valid_file
 
       File.write(@valid_file, "def broken(")
 
-      cmd = IRB::Command::Reload.new(nil)
-      IRB.conf[:__RELOADABLE_FILES__] << @valid_file
+      cmd = IRB::Command::BoxReload.new(nil)
+      IRB::ReloadableRequire.reloadable_files << @valid_file
       cmd.execute(nil)
 
       assert_equal true, $LOADED_FEATURES.include?(@valid_file)
@@ -309,8 +328,8 @@ def test_reload_file_preserves_loaded_features_on_load_error
       missing_file = File.join(@tmpdir, "missing.rb")
       $LOADED_FEATURES << missing_file
 
-      cmd = IRB::Command::Reload.new(nil)
-      IRB.conf[:__RELOADABLE_FILES__] << missing_file
+      cmd = IRB::Command::BoxReload.new(nil)
+      IRB::ReloadableRequire.reloadable_files << missing_file
       cmd.execute(nil)
 
       assert_equal true, $LOADED_FEATURES.include?(missing_file)
@@ -319,33 +338,6 @@ def test_reload_file_preserves_loaded_features_on_load_error
     end
   end
 
-  class ReloadableRequireMonkeyPatchTest < TestCase
-    def setup
-      super
-      omit "ReloadableRequire requires Ruby::Box" if !defined?(Ruby::Box) || !Ruby::Box.enabled?
-      require "irb/reloadable_require"
-      @saved_original_require = Ruby::Box.instance_method(:__irb_original_require__)
-    end
-
-    def teardown
-      super
-      saved = @saved_original_require
-      if saved
-        Ruby::Box.define_method(:__irb_original_require__, saved)
-      end
-    end
-
-    def test_original_require_alias_preserved_on_double_load
-      IRB::ReloadableRequire.apply_autoload_hook
-
-      # Double-loading the file should not overwrite __irb_original_require__
-      # with the already-patched require method.
-      load File.expand_path("../../lib/irb/reloadable_require.rb", __dir__)
-
-      assert_equal @saved_original_require, Ruby::Box.instance_method(:__irb_original_require__)
-    end
-  end
-
   class ReloadableRequireDisabledTest < IntegrationTestCase
     def setup
       super