byebug 3.1.2 → 3.2.0

data/test/help_test.rb

@@ -1,59 +1,49 @@
-module HelpTest
-  class HelpTestCase < TestDsl::TestCase
+module Byebug
+  class HelpTestCase < TestCase
     include Columnize
 
-    before do
+    def setup
       @example = -> do
         byebug
       end
-    end
 
-    let(:available_cmds) do
-      Byebug::Command.commands.map(&:names).flatten.uniq.sort
+      super
     end
 
-    describe 'when typed alone' do
-      temporary_change_hash Byebug::Setting, :width, 50
+    def available_cmds
+      @available_cmds ||=
+        Command.commands.map(&:names).flatten.uniq.sort
+    end
 
-      it 'must show self help when typed alone' do
-        enter 'help'
+    %w(help h).each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_help_for_help_command_itself") do
+        enter 'set width 50', cmd_alias
         debug_proc(@example)
         check_output_includes \
           'Type "help <command-name>" for help on a specific command',
           'Available commands:', columnize(available_cmds, 50)
       end
-
-      it 'must work when shortcut used' do
-        enter 'h'
-        debug_proc(@example)
-        check_output_includes \
-          'Type "help <command-name>" for help on a specific command'
-      end
     end
 
-    describe 'when typed with a command'  do
-      it 'must show an error if an undefined command is specified' do
-        enter 'help foobar'
-        debug_proc(@example)
-        check_error_includes 'Undefined command: "foobar". Try "help".'
-      end
+    def test_help_with_specific_command_shows_help_for_it
+      enter 'help break'
+      debug_proc(@example)
+      check_output_includes \
+        "b[reak] file:line [if expr]\n" \
+        "b[reak] class(.|#)method [if expr]\n\n" \
+        "Set breakpoint to some position, (optionally) if expr == true\n"
+    end
 
-      it "must show a command's help" do
-        enter 'help break'
-        debug_proc(@example)
-        check_output_includes \
-          "b[reak] file:line [if expr]\n" \
-          "b[reak] class(.|#)method [if expr]\n\n" \
-          "Set breakpoint to some position, (optionally) if expr == true\n"
-      end
+    def test_help_with_undefined_command_shows_an_error
+      enter 'help foobar'
+      debug_proc(@example)
+      check_error_includes 'Undefined command: "foobar". Try "help".'
     end
 
-    describe 'when typed with command and subcommand' do
-      it "must show subcommand's help" do
-        enter 'help info breakpoints'
-        debug_proc(@example)
-        check_output_includes "Status of user-settable breakpoints.\n"
-      end
+    def test_help_with_command_and_subcommand_shows_subcommands_help
+      enter 'help info breakpoints'
+      debug_proc(@example)
+      check_output_includes "Status of user-settable breakpoints.\n"
     end
   end
 end

data/test/history_test.rb

@@ -1,54 +1,45 @@
-module HistoryTest
-  class HistoryTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class HistoryTestCase < TestCase
+    def setup
       @example = -> do
         byebug
       end
-    end
 
-    describe 'history command' do
-      temporary_change_const Readline, 'HISTORY', %w(aaa bbb ccc ddd)
+      super
 
-      describe 'with autosave disabled' do
-        temporary_change_hash Byebug::Setting, :autosave, false
+      @old_readline = Readline::HISTORY
+      force_set_const(Readline, 'HISTORY', %w(aaa bbb ccc ddd))
+    end
 
-        it 'must not show records from readline' do
-          enter 'history'
-          debug_proc(@example)
-          check_error_includes "Not currently saving history. " \
-                               'Enable it with "set autosave"'
-        end
-      end
+    def teardown
+      force_set_const(Readline, 'HISTORY', @old_readline)
+    end
 
-      describe 'with autosave enabled' do
-        temporary_change_hash Byebug::Setting, :autosave, true
+    def test_history_displays_latest_records_from_readline_history
+      enter 'set histsize 3', 'history'
+      debug_proc(@example)
+      check_output_includes(/2  bbb\n    3  ccc\n    4  ddd/)
+      check_output_doesnt_include(/1  aaa/)
+    end
 
-        describe 'must show records from readline' do
-          it 'displays last max_size records from readline history' do
-            enter 'set histsize 3', 'history'
-            debug_proc(@example)
-            check_output_includes(/2  bbb\n    3  ccc\n    4  ddd/)
-            check_output_doesnt_include(/1  aaa/)
-          end
-        end
+    def test_history_displays_whole_history_if_max_size_is_bigger_than_readline
+      enter 'set histsize 7', 'history'
+      debug_proc(@example)
+      check_output_includes(/1  aaa\n    2  bbb\n    3  ccc\n    4  ddd/)
+    end
 
-        describe 'max records' do
-          it 'displays whole history if max_size is bigger than Readline::HISTORY' do
-            enter 'set histsize 7', 'history'
-            debug_proc(@example)
-            check_output_includes(/1  aaa\n    2  bbb\n    3  ccc\n    4  ddd/)
-          end
-        end
+    def test_history_n_displays_lastest_n_records_from_readline_history
+      enter 'history 2'
+      debug_proc(@example)
+      check_output_includes(/3  ccc\n    4  ddd/)
+      check_output_doesnt_include(/1  aaa\n    2  bbb/)
+    end
 
-        describe 'with specified size' do
-          it 'displays the specified number of entries most recent first' do
-            enter 'history 2'
-            debug_proc(@example)
-            check_output_includes(/3  ccc\n    4  ddd/)
-            check_output_doesnt_include(/1  aaa\n    2  bbb/)
-          end
-        end
-      end
+    def test_history_with_autosave_disabled_does_not_show_records_from_readline
+      enter 'set noautosave', 'history'
+      debug_proc(@example)
+      check_error_includes "Not currently saving history. " \
+                           'Enable it with "set autosave"'
     end
   end
 end

data/test/info_test.rb

@@ -1,12 +1,12 @@
-module InfoTest
-  class Example
+module Byebug
+  class InfoExample
     def initialize
       @foo = 'bar'
       @bla = 'blabla'
     end
 
     def a(y, z)
-      w = '1' * 30
+      w = '1' * 45
       x = 2
       w + x.to_s + y + z + @foo
     end
@@ -28,293 +28,261 @@ module InfoTest
     end
   end
 
-  class InfoTestCase < TestDsl::TestCase
+  class InfoTestCase < TestCase
     include Columnize
 
-    before do
+    def setup
       @example = -> do
         byebug
-        i = Example.new
+        i = InfoExample.new
         i.b
         i.c
         i.d
       end
-    end
 
-    describe 'Args info' do
-      it 'must show info about all args' do
-        enter 'break 11', 'cont', 'info args'
-        debug_proc(@example)
-        check_output_includes 'y = "a"', 'z = "b"'
-      end
+      super
     end
 
-    describe 'Breakpoints info' do
-      it 'must show info about all breakpoints' do
-        enter 'break 38', 'break 39 if y == z', 'info breakpoints'
-        debug_proc(@example)
-        check_output_includes 'Num Enb What',
-                              /\d+ +y   at #{__FILE__}:38/,
-                              /\d+ +y   at #{__FILE__}:39 if y == z/
-      end
+    def test_info_about_all_args
+      enter 'break 11', 'cont', 'info args'
+      debug_proc(@example)
+      check_output_includes 'y = "a"', 'z = "b"'
+    end
 
-      it 'must show info about specific breakpoint' do
-        enter 'break 38', 'break 39',
-              -> { "info breakpoints #{Byebug.breakpoints.first.id}" }
-        debug_proc(@example)
-        check_output_includes 'Num Enb What', /\d+ +y   at #{__FILE__}:38/
-        check_output_doesnt_include(/\d+ +y   at #{__FILE__}:39/)
-      end
+    def test_info_about_all_breakpoints
+      enter 'break 38', 'break 39 if y == z', 'info breakpoints'
+      debug_proc(@example)
+      check_output_includes 'Num Enb What',
+                            /\d+ +y   at #{__FILE__}:38/,
+                            /\d+ +y   at #{__FILE__}:39 if y == z/
+    end
 
-      it 'must show an error if no breakpoints are found' do
-        enter 'info breakpoints'
-        debug_proc(@example)
-        check_output_includes 'No breakpoints.'
-      end
+    def test_info_about_specific_breakpoints
+      enter 'break 38', 'break 39',
+            -> { "info breakpoints #{first_brkpt.id}" }
+      debug_proc(@example)
+      check_output_includes 'Num Enb What', /\d+ +y   at #{__FILE__}:38/
+      check_output_doesnt_include(/\d+ +y   at #{__FILE__}:39/)
+    end
 
-      it 'must show an error if no breakpoints are found' do
-        enter 'break 38', 'info breakpoints 100'
-        debug_proc(@example)
-        check_error_includes 'No breakpoints found among list given.'
-      end
+    def test_info_breakpoints_shows_a_message_when_no_breakpoints_found
+      enter 'info breakpoints'
+      debug_proc(@example)
+      check_output_includes 'No breakpoints.'
+    end
 
-      it 'must show hit count' do
-        enter 'break 39', 'cont', 'info breakpoints'
-        debug_proc(@example)
-        check_output_includes(
-          /\d+ +y   at #{__FILE__}:39/, 'breakpoint already hit 1 time')
-      end
+    def test_info_breakpoints_shows_error_if_specific_breakpoint_do_not_exist
+      enter 'break 38', 'info breakpoints 100'
+      debug_proc(@example)
+      check_error_includes 'No breakpoints found among list given.'
     end
 
-    describe 'Display info' do
-      it 'must show all display expressions' do
-        enter 'display 3 + 3', 'display a + b', 'info display'
-        debug_proc(@example)
-        check_output_includes "Auto-display expressions now in effect:\n" \
-                              'Num Enb Expression',
-                              '1: y  3 + 3',
-                              '2: y  a + b'
-      end
+    def test_info_breakpoints_shows_hit_counts
+      enter 'break 39', 'cont', 'info breakpoints'
+      debug_proc(@example)
+      check_output_includes(
+        /\d+ +y   at #{__FILE__}:39/, 'breakpoint already hit 1 time')
+    end
 
-      it 'must show a message if there are no display expressions created' do
-        enter 'info display'
-        debug_proc(@example)
-        check_output_includes 'There are no auto-display expressions now.'
-      end
+    def test_info_display_shows_all_display_expressions
+      enter 'display 3 + 3', 'display a + b', 'info display'
+      debug_proc(@example)
+      check_output_includes "Auto-display expressions now in effect:\n" \
+                            'Num Enb Expression',
+                            '1: y  3 + 3',
+                            '2: y  a + b'
     end
 
-    describe 'Files info' do
-      let(:files) { SCRIPT_LINES__.keys.uniq.sort }
+    def test_info_display_shows_a_message_when_no_display_expressions_found
+      enter 'info display'
+      debug_proc(@example)
+      check_output_includes 'There are no auto-display expressions now.'
+    end
 
-      it 'must show all files read in' do
-        enter 'info files'
-        debug_proc(@example)
-        check_output_includes files.map { |f| "File #{f}" }
-      end
+    def files
+      @files ||= SCRIPT_LINES__.keys.uniq.sort
+    end
 
-      it 'must show all files read in using "info file" too' do
-        enter 'info file'
+    %w(file files).each do |subcmd_alias|
+      define_method(:"test_info_#{subcmd_alias}_shows_all_files_read_in") do
+        enter 'list' # list command explicitly reloads current file into cache
+        enter "info #{subcmd_alias}"
         debug_proc(@example)
-        check_output_includes files.map { |f| "File #{f}" }
+        check_output_includes "File #{__FILE__}", File.stat(__FILE__).mtime.to_s
       end
+    end
 
-      it 'must show explicitly loaded files' do
-        enter 'info files stat'
-        debug_proc(@example)
-        check_output_includes "File #{__FILE__}",
-                              LineCache.stat(__FILE__).mtime.to_s
-      end
+    def filename
+      @filename ||= "File #{__FILE__}"
     end
 
-    describe 'File info' do
-      let(:file)     { __FILE__ }
-      let(:filename) { "File #{file}" }
-      let(:lines)    { "#{LineCache.size(file)} lines" }
-      let(:mtime)    { LineCache.stat(file).mtime.to_s }
-      let(:sha1)     { LineCache.sha1(file) }
-      let(:breakpoint_line_numbers) {
-        columnize(LineCache.trace_line_numbers(file).to_a.sort,
-                  Byebug::Setting[:width]) }
+    def lines
+      @lines ||= "#{File.foreach(__FILE__).count} lines"
+    end
 
-      it 'must show basic info about the file' do
-        enter "info file #{file} basic"
-        debug_proc(@example)
-        check_output_includes filename, lines
-        check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
-      end
+    def mtime
+      @mtime ||= File.stat(__FILE__).mtime.to_s
+    end
 
-      it 'must show number of lines' do
-        enter "info file #{file} lines"
-        debug_proc(@example)
-        check_output_includes filename, lines
-        check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
-      end
+    def sha1
+      @sha1 ||= Digest::SHA1.hexdigest(__FILE__)
+    end
 
-      it 'must show mtime of the file' do
-        enter "info file #{file} mtime"
-        debug_proc(@example)
-        check_output_includes filename, mtime
-        check_output_doesnt_include lines, breakpoint_line_numbers, sha1
-      end
+    def breakpoint_line_numbers
+      @breakpoint_line_numbers ||=
+        columnize(LineCache.trace_line_numbers(__FILE__).to_a.sort,
+                  Setting[:width])
+    end
 
-      it 'must show sha1 of the file' do
-        enter "info file #{file} sha1"
-        debug_proc(@example)
-        check_output_includes filename, sha1
-        check_output_doesnt_include lines, breakpoint_line_numbers, mtime
-      end
+    def test_info_file_basic_shows_basic_info_about_a_specific_file
+      enter "info file #{__FILE__} basic"
+      debug_proc(@example)
+      check_output_includes filename, lines
+      check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
+    end
 
-      it 'must show breakpoints in the file' do
-        enter 'break 38', 'break 39', "info file #{file} breakpoints"
-        debug_proc(@example)
-        check_output_includes(/Created breakpoint \d+ at #{file}:38/,
-                              /Created breakpoint \d+ at #{file}:39/,
-                              filename,
-                              'breakpoint line numbers:', breakpoint_line_numbers)
-        check_output_doesnt_include lines, mtime, sha1
-      end
+    def test_info_file_lines_shows_number_of_lines_in_a_specific_file
+      enter "info file #{__FILE__} lines"
+      debug_proc(@example)
+      check_output_includes filename, lines
+      check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
+    end
 
-      it 'must show all info about the file' do
-        enter "info file #{file} all"
-        debug_proc(@example)
-        check_output_includes \
-          filename, lines, breakpoint_line_numbers, mtime, sha1
-      end
+    def test_info_file_mtime_shows_mtime_of_a_specific_file
+      enter "info file #{__FILE__} mtime"
+      debug_proc(@example)
+      check_output_includes filename, mtime
+      check_output_doesnt_include lines, breakpoint_line_numbers, sha1
+    end
 
-      it 'must not show any info if the parameter is invalid' do
-        enter "info file #{file} blabla"
-        debug_proc(@example)
-        check_error_includes 'Invalid parameter blabla'
-      end
+    def test_info_file_sha1_shows_sha1_signature_of_a_specific_file
+      enter "info file #{__FILE__} sha1"
+      debug_proc(@example)
+      check_output_includes filename, sha1
+      check_output_doesnt_include lines, breakpoint_line_numbers, mtime
     end
 
-    describe 'Instance variables info' do
-      it 'must show instance variables' do
-        enter 'break 11', 'cont', 'info instance_variables'
-        debug_proc(@example)
-        check_output_includes '@bla = "blabla"', '@foo = "bar"'
-      end
+    def test_info_file_breakpoints_shows_breakpoints_in_a_specific_file
+      enter 'break 38', 'break 39', "info file #{__FILE__} breakpoints"
+      debug_proc(@example)
+      check_output_includes(
+        /Created breakpoint \d+ at #{__FILE__}:38/,
+        /Created breakpoint \d+ at #{__FILE__}:39/,
+        filename,
+        'breakpoint line numbers:', breakpoint_line_numbers)
+      check_output_doesnt_include lines, mtime, sha1
     end
 
-    describe 'Line info' do
-      it 'must show the current line' do
-        enter 'break 11', 'cont', 'info line'
-        debug_proc(@example)
-        check_output_includes "Line 11 of \"#{__FILE__}\""
-      end
+    def test_info_file_all_shows_all_available_info_about_a_specific_file
+      enter "info file #{__FILE__} all"
+      debug_proc(@example)
+      check_output_includes \
+        filename, lines, breakpoint_line_numbers, mtime, sha1
     end
 
-    describe 'Locals info' do
-      temporary_change_hash Byebug::Setting, :width, 28
+    def test_info_file_does_not_show_any_info_if_parameter_is_invalid
+      enter "info file #{__FILE__} blabla"
+      debug_proc(@example)
+      check_error_includes 'Invalid parameter blabla'
+    end
 
-      it 'must show the current local variables' do
-        enter 'break 11', 'cont', 'info locals'
-        debug_proc(@example)
-        check_output_includes 'w = "11111111111111111111...', 'x = 2'
-      end
+    def test_info_instance_variables_shows_instance_variables
+      enter 'break 11', 'cont', 'info instance_variables'
+      debug_proc(@example)
+      check_output_includes '@bla = "blabla"', '@foo = "bar"'
+    end
 
-      it 'must fail if local variable doesn\'t respond to #to_s or to #inspect' do
-        enter 'break 16', 'cont', 'info locals'
-        debug_proc(@example)
-        check_output_includes 'a = *Error in evaluation*'
-      end
+    def test_info_line_shows_info_about_the_current_line
+      enter 'break 11', 'cont', 'info line'
+      debug_proc(@example)
+      check_output_includes "Line 11 of \"#{__FILE__}\""
     end
 
-    describe 'Program info' do
-      it 'must show the initial stop reason' do
-        enter 'info program'
-        debug_proc(@example)
-        check_output_includes \
-          "It stopped after stepping, next'ing or initial start."
-      end
+    def test_info_locals_shows_info_about_the_current_local_variables
+      enter 'break 11', 'cont', 'set width 28', 'info locals'
+      debug_proc(@example)
+      check_output_includes 'w = "11111111111111111111...', 'x = 2'
+    end
 
-      it 'must show the step stop reason' do
-        enter 'step', 'info program'
-        debug_proc(@example)
-        check_output_includes \
-          'Program stopped.',
-          "It stopped after stepping, next'ing or initial start."
-      end
+    def test_info_locals_fail_if_local_variable_does_not_have_to_s_or_inspect
+      enter 'break 16', 'cont', 'info locals'
+      debug_proc(@example)
+      check_output_includes 'a = *Error in evaluation*'
+    end
 
-      it 'must show the breakpoint stop reason' do
-        enter 'break 38', 'cont', 'info program'
-        debug_proc(@example)
-        check_output_includes 'Program stopped.', 'It stopped at a breakpoint.'
-      end
+    def test_info_program_shows_the_initial_stop_reason
+      enter 'info program'
+      debug_proc(@example)
+      check_output_includes \
+        "It stopped after stepping, next'ing or initial start."
+    end
 
-      it 'must show the catchpoint stop reason' do
-        enter 'catch Exception', 'cont', 'info program'
-        debug_proc(@example)
-        check_output_includes 'Program stopped.', 'It stopped at a catchpoint.'
-      end
+    def test_info_program_shows_the_step_stop_reason
+      enter 'step', 'info program'
+      debug_proc(@example)
+      check_output_includes \
+        'Program stopped.',
+        "It stopped after stepping, next'ing or initial start."
+    end
 
-      it 'must show the unknown stop reason' do
-        enter 'break 39', 'cont',
-               ->{ context.stubs(:stop_reason).returns('blabla'); 'info program' }
-        debug_proc(@example)
-        check_output_includes 'Program stopped.', 'unknown reason: blabla'
-      end
+    def test_info_program_shows_the_breakpoint_stop_reason
+      enter 'break 38', 'cont', 'info program'
+      debug_proc(@example)
+      check_output_includes 'Program stopped.', 'It stopped at a breakpoint.'
+    end
 
-      it 'must show an error if the program is crashed' do
-        skip('TODO')
-      end
+    def test_info_program_shows_the_catchpoint_stop_reason
+      enter 'catch Exception', 'cont', 'info program'
+      debug_proc(@example)
+      check_output_includes 'Program stopped.', 'It stopped at a catchpoint.'
     end
 
-    describe 'Stack info' do
-      it 'must show stack info' do
-        file = __FILE__
-        enter 'set fullpath', 'break 9', 'cont', 'info stack'
-        debug_proc(@example)
-        check_output_includes(
-          /--> #0  InfoTest::Example.a\(y#String, z#String\)\s+at #{file}:9/,
-              /#1  InfoTest::Example.b\s+at #{file}:20/,
-              /#2  block \(2 levels\) in <class:InfoTestCase>\s+at #{file}:38/)
-      end
+    def test_info_program_shows_the_unknown_stop_reason
+      enter 'break 39', 'cont',
+             ->{ context.stubs(:stop_reason).returns('blabla'); 'info program' }
+      debug_proc(@example)
+      check_output_includes 'Program stopped.', 'unknown reason: blabla'
     end
 
-    describe 'Global Variables info' do
-      it 'must show global variables' do
-        enter 'info global_variables'
-        debug_proc(@example)
-        check_output_includes "$$ = #{Process.pid}"
-      end
+    def test_shows_an_error_if_the_program_is_crashed
+      skip('TODO')
     end
 
-    describe 'Variables info' do
-      temporary_change_hash Byebug::Setting, :width, 30
+    def test_info_global_variables_shows_global_variables
+      enter 'info global_variables'
+      debug_proc(@example)
+      check_output_includes "$$ = #{Process.pid}"
+    end
 
-      it 'must show all variables' do
-        enter 'break 11', 'cont', 'info variables'
-        debug_proc(@example)
-        check_output_includes(/self = #<InfoTest::Example:\S*.../,
-                              'w = "1111111111111111111111...',
-                              'x = 2',
-                              '@bla = "blabla"',
-                              '@foo = "bar"')
-      end
+    def test_info_variables_shows_all_variables
+      enter 'break 11', 'cont', 'set width 45', 'info variables'
+      debug_proc(@example)
+      check_output_includes(/self = #<Byebug::InfoExample:\S*.../,
+                            'w = "1111111111111111111111111111111111111...',
+                            'x = 2',
+                            '@bla = "blabla"',
+                            '@foo = "bar"')
+    end
 
-      it 'must fail if the variable doesn\'t respond to #to_s or to #inspect' do
-        enter 'break 16', 'cont', 'info variables'
-        debug_proc(@example)
-        check_output_includes 'a = *Error in evaluation*',
-                              /self = #<InfoTest::Example:\S*.../,
-                              '@bla = "blabla"',
-                              '@foo = "bar"'
-      end
+    def test_info_variables_fails_if_variables_has_no_to_s_or_inspect_methods
+      enter 'break 16', 'cont', 'info variables'
+      debug_proc(@example)
+      check_output_includes 'a = *Error in evaluation*',
+                            /self = #<Byebug::InfoExample:\S*.../,
+                            '@bla = "blabla"',
+                            '@foo = "bar"'
+    end
 
-      it 'must correctly print variables containing % sign' do
-        enter 'break 22', 'cont', 'info variables'
-        debug_proc(@example)
-        check_output_includes 'e = "%.2f"'
-      end
+    def test_info_variables_correctly_print_variables_containing_percentage
+      enter 'break 22', 'cont', 'info variables'
+      debug_proc(@example)
+      check_output_includes 'e = "%.2f"'
     end
 
-    describe 'Help' do
-      it 'must show help when typing just "info"' do
-        enter 'info', 'cont'
-        debug_proc(@example)
-        check_output_includes(/List of "info" subcommands:/)
-      end
+    def test_shows_help_when_typing_just_info
+      enter 'info', 'cont'
+      debug_proc(@example)
+      check_output_includes(/List of "info" subcommands:/)
     end
   end
 end