Provide a base test class and let tests restore encodings conveniently (#429)

* Create a base TestIRB::TestCase class

* Save/restore encodings for tests that initializes InputMethod classes

Because `RelineInputMethod#initializes` calls `set_encoding`, which
changes stdio/out/err and Encoding's default encoding values, we need to
make sure any test that directly or indirectly (e.g. through Context)
initializes `RelineInputMethod` restores encodings.

`ReadlineInputMethod` also changes encodings but currently no tests
cover it.

* Remove unnecessary TestHelper module

Since we now have a base TestCase, without_rdoc can just live there.

Author: st0012

test/irb/helper.rb

@@ -1,6 +1,22 @@
-module IRB
-  module TestHelper
-    def self.without_rdoc(&block)
+require "test/unit"
+
+module TestIRB
+  class TestCase < Test::Unit::TestCase
+    def save_encodings
+      @default_encoding = [Encoding.default_external, Encoding.default_internal]
+      @stdio_encodings = [STDIN, STDOUT, STDERR].map {|io| [io.external_encoding, io.internal_encoding] }
+    end
+
+    def restore_encodings
+      EnvUtil.suppress_warning do
+        Encoding.default_external, Encoding.default_internal = *@default_encoding
+        [STDIN, STDOUT, STDERR].zip(@stdio_encodings) do |io, encs|
+          io.set_encoding(*encs)
+        end
+      end
+    end
+
+    def without_rdoc(&block)
       ::Kernel.send(:alias_method, :old_require, :require)
 
       ::Kernel.define_method(:require) do |name|

test/irb/test_cmd.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: false
-require "test/unit"
 require "irb"
 require "irb/extend-command"
 
 require_relative "helper"
 
 module TestIRB
-  class ExtendCommand < Test::Unit::TestCase
+  class ExtendCommand < TestCase
     class TestInputMethod < ::IRB::InputMethod
       attr_reader :list, :line_no
 
@@ -46,8 +45,7 @@ def setup
       @home_backup = ENV["HOME"]
       ENV["HOME"] = @tmpdir
       @xdg_config_home_backup = ENV.delete("XDG_CONFIG_HOME")
-      @default_encoding = [Encoding.default_external, Encoding.default_internal]
-      @stdio_encodings = [STDIN, STDOUT, STDERR].map {|io| [io.external_encoding, io.internal_encoding] }
+      save_encodings
       IRB.instance_variable_get(:@CONF).clear
       @is_win = (RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/)
     end
@@ -57,12 +55,7 @@ def teardown
       ENV["HOME"] = @home_backup
       Dir.chdir(@pwd)
       FileUtils.rm_rf(@tmpdir)
-      EnvUtil.suppress_warning {
-        Encoding.default_external, Encoding.default_internal = *@default_encoding
-        [STDIN, STDOUT, STDERR].zip(@stdio_encodings) do |io, encs|
-          io.set_encoding(*encs)
-        end
-      }
+      restore_encodings
     end
 
     def test_irb_info_multiline
@@ -450,7 +443,7 @@ def test_help_without_rdoc
       IRB.conf[:VERBOSE] = false
       irb = IRB::Irb.new(IRB::WorkSpace.new(self), input)
       out, _ = capture_output do
-        IRB::TestHelper.without_rdoc do
+        without_rdoc do
           irb.eval_input
         end
       end

test/irb/test_color.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: false
-require 'test/unit'
 require 'irb/color'
 require 'rubygems'
 require 'stringio'
 
+require_relative "helper"
+
 module TestIRB
-  class TestColor < Test::Unit::TestCase
+  class TestColor < TestCase
     CLEAR     = "\e[0m"
     BOLD      = "\e[1m"
     UNDERLINE = "\e[4m"

test/irb/test_color_printer.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: false
-require 'test/unit'
 require 'irb/color_printer'
 require 'rubygems'
 require 'stringio'
 
+require_relative "helper"
+
 module TestIRB
-  class TestColorPrinter < Test::Unit::TestCase
+  class TestColorPrinter < TestCase
     CLEAR     = "\e[0m"
     BOLD      = "\e[1m"
     RED       = "\e[31m"

test/irb/test_completion.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: false
-require "test/unit"
 require "pathname"
 require "irb"
 
 require_relative "helper"
 
 module TestIRB
-  class TestCompletion < Test::Unit::TestCase
+  class TestCompletion < TestCase
     def setup
       # make sure require completion candidates are not cached
       IRB::InputCompletor.class_variable_set(:@@files_from_load_path, nil)
@@ -276,7 +275,7 @@ def test_perfect_matching_stops_without_rdoc
         result = nil
 
         out, err = capture_output do
-          IRB::TestHelper.without_rdoc do
+          without_rdoc do
             result = IRB::InputCompletor::PerfectMatchedProc.("String", bind: binding)
           end
         end

test/irb/test_context.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: false
-require 'test/unit'
 require 'tempfile'
 require 'irb'
 require 'rubygems' if defined?(Gem)
 
+require_relative "helper"
+
 module TestIRB
-  class TestContext < Test::Unit::TestCase
+  class TestContext < TestCase
     class TestInputMethod < ::IRB::InputMethod
       attr_reader :list, :line_no
 

test/irb/test_history.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: false
-require 'test/unit'
 require 'irb'
 require 'irb/ext/save-history'
 require 'readline'
 
+require_relative "helper"
+
 module TestIRB
-  class TestHistory < Test::Unit::TestCase
+  class TestHistory < TestCase
     def setup
       IRB.conf[:RC_NAME_GENERATOR] = nil
     end

test/irb/test_init.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: false
-require "test/unit"
 require "irb"
 require "fileutils"
 
+require_relative "helper"
+
 module TestIRB
-  class TestInit < Test::Unit::TestCase
+  class TestInit < TestCase
     def setup
       # IRBRC is for RVM...
       @backup_env = %w[HOME XDG_CONFIG_HOME IRBRC].each_with_object({}) do |env, hash|

test/irb/test_input_method.rb

@@ -1,34 +1,20 @@
 # frozen_string_literal: false
 
-require "test/unit"
 require "irb"
 
 require_relative "helper"
 
 module TestIRB
-  class TestRelineInputMethod < Test::Unit::TestCase
+  class TestRelineInputMethod < TestCase
     def setup
       @conf_backup = IRB.conf.dup
       IRB.conf[:LC_MESSAGES] = IRB::Locale.new
-
-      # RelineInputMethod#initialize calls IRB.set_encoding, which mutates standard input/output's encoding
-      # so we need to make sure we set them back
-      @original_io_encodings = {
-        STDIN => [STDIN.external_encoding, STDIN.internal_encoding],
-        STDOUT => [STDOUT.external_encoding, STDOUT.internal_encoding],
-        STDERR => [STDERR.external_encoding, STDERR.internal_encoding],
-      }
-      @original_default_encodings = [Encoding.default_external, Encoding.default_internal]
+      save_encodings
     end
 
     def teardown
       IRB.conf.replace(@conf_backup)
-
-      @original_io_encodings.each do |io, (external_encoding, internal_encoding)|
-        io.set_encoding(external_encoding, internal_encoding)
-      end
-
-      EnvUtil.suppress_warning { Encoding.default_external, Encoding.default_internal = @original_default_encodings }
+      restore_encodings
     end
 
     def test_initialization
@@ -78,7 +64,7 @@ def test_initialization_with_use_autocomplete_but_without_rdoc
 
       IRB.conf[:USE_AUTOCOMPLETE] = true
 
-      IRB::TestHelper.without_rdoc do
+      without_rdoc do
         IRB::RelineInputMethod.new
       end
 

test/irb/test_option.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: false
-require 'test/unit'
+require_relative "helper"
 
 module TestIRB
-  class TestOption < Test::Unit::TestCase
+  class TestOption < TestCase
     def test_end_of_option
       bug4117 = '[ruby-core:33574]'
       bundle_exec = ENV.key?('BUNDLE_GEMFILE') ? ['-rbundler/setup'] : []