From bede04c14add158c2df3a94999a359075bb84a88 Mon Sep 17 00:00:00 2001
From: Stan Lo <stan.lo@shopify.com>
Date: Mon, 12 Dec 2022 21:04:58 +0000
Subject: [PATCH] Group show_doc tests and update the expectation (#479)

---
 test/irb/test_cmd.rb | 66 +++++++++++++++++++++++---------------------
 1 file changed, 34 insertions(+), 32 deletions(-)

diff --git a/test/irb/test_cmd.rb b/test/irb/test_cmd.rb
index 3602b7c33..719a2bbf8 100644
--- a/test/irb/test_cmd.rb
+++ b/test/irb/test_cmd.rb
@@ -376,38 +376,6 @@ def test_irb_source_without_argument
       assert_match(/Please specify the file name./, out)
     end
 
-    def test_help_and_show_doc
-      ["help", "show_doc"].each do |cmd|
-        out, _ = execute_lines(
-          "#{cmd} String#gsub\n",
-          "\n",
-        )
-
-        # the former is what we'd get without document content installed, like on CI
-        # the latter is what we may get locally
-        possible_rdoc_output = [/Nothing known about String#gsub/, /str.gsub\(pattern\)/]
-        assert(possible_rdoc_output.any? { |output| output.match?(out) }, "Expect the `#{cmd}` command to match one of the possible outputs")
-      end
-    ensure
-      # this is the only way to reset the redefined method without coupling the test with its implementation
-      EnvUtil.suppress_warning { load "irb/cmd/help.rb" }
-    end
-
-    def test_help_without_rdoc
-      out, _ = without_rdoc do
-        execute_lines(
-          "help 'String#gsub'\n",
-          "\n",
-        )
-      end
-
-      # if it fails to require rdoc, it only returns the command object
-      assert_match(/=> IRB::ExtendCommand::Help\n/, out)
-    ensure
-      # this is the only way to reset the redefined method without coupling the test with its implementation
-      EnvUtil.suppress_warning { load "irb/cmd/help.rb" }
-    end
-
     def test_irb_load
       File.write("#{@tmpdir}/a.rb", "a = 'hi'\n")
       out, err = execute_lines(
@@ -612,6 +580,40 @@ def test_show_cmds
       assert_match(/Start the debugger of debug\.gem/, out)
     end
 
+    class ShowDocTest < CommandTestCase
+      def test_help_and_show_doc
+        ["help", "show_doc"].each do |cmd|
+          out, _ = execute_lines(
+            "#{cmd} String#gsub\n",
+            "\n",
+          )
+
+          # the former is what we'd get without document content installed, like on CI
+          # the latter is what we may get locally
+          possible_rdoc_output = [/Nothing known about String#gsub/, /gsub\(pattern\)/]
+          assert(possible_rdoc_output.any? { |output| output.match?(out) }, "Expect the `#{cmd}` command to match one of the possible outputs. Got:\n#{out}")
+        end
+      ensure
+        # this is the only way to reset the redefined method without coupling the test with its implementation
+        EnvUtil.suppress_warning { load "irb/cmd/help.rb" }
+      end
+
+      def test_show_doc_without_rdoc
+        out, _ = without_rdoc do
+          execute_lines(
+            "show_doc String#gsub\n",
+            "\n",
+          )
+        end
+
+        # if it fails to require rdoc, it only returns the command object
+        assert_match(/=> IRB::ExtendCommand::Help\n/, out)
+      ensure
+        # this is the only way to reset the redefined method without coupling the test with its implementation
+        EnvUtil.suppress_warning { load "irb/cmd/help.rb" }
+      end
+    end
+
     class EditTest < CommandTestCase
       def setup
         @original_editor = ENV["EDITOR"]