byebug 3.1.2 → 3.2.0

data/test/continue_test.rb

@@ -1,50 +1,47 @@
-module ContinueTest
-  class Example
+module Byebug
+  class ContinueExample
     def self.a(num)
       num + 4
     end
   end
 
-  class ContinueTestCase < TestDsl::TestCase
-    before do
-      @example = lambda do
+  class ContinueTestCase < TestCase
+    def setup
+      @example = -> do
         byebug
 
         b = 5
         c = b + 5
-        Example.a(c)
+        ContinueExample.a(c)
       end
-    end
 
-    describe 'successful' do
-      it 'must continue up to breakpoint if no line specified' do
-        enter 'break 14', 'continue'
-        debug_proc(@example) { state.line.must_equal 14 }
-      end
+      super
+    end
 
-      it 'must work in abbreviated mode too' do
-        enter 'break 14', 'cont'
-        debug_proc(@example) { state.line.must_equal 14 }
-      end
+    def test_continues_up_to_breakpoint_if_no_line_specified
+      enter 'break 14', 'continue'
+      debug_proc(@example) { assert_equal 14, state.line }
+    end
 
-      it 'must continue up to specified line' do
-        enter 'cont 14'
-        debug_proc(@example) { state.line.must_equal 14 }
-      end
+    def test_works_in_abbreviated_mode_too
+      enter 'break 14', 'cont'
+      debug_proc(@example) { assert_equal 14, state.line }
     end
 
-    describe 'unsuccessful' do
-      before { enter 'cont 100' }
+    def test_continues_up_to_the_specified_line
+      enter 'cont 14'
+      debug_proc(@example) { assert_equal 14, state.line }
+    end
 
-      it 'must ignore the command if specified line is not valid' do
-        debug_proc(@example) { state.line.must_equal 13 }
-      end
+    def test_ignores_the_command_if_specified_line_is_not_valid
+      enter 'cont 100'
+      debug_proc(@example) { assert_equal 13, state.line }
+    end
 
-      it 'must show error if specified line is not valid' do
-        debug_proc(@example)
-        check_error_includes \
-          "Line 100 is not a stopping point in file \"#{__FILE__}\""
-      end
+    def test_shows_error_if_specified_line_is_not_valid
+      enter 'cont 100'
+      debug_proc(@example)
+      check_error_includes 'Line 100 is not a valid stopping point in file'
     end
   end
 end

data/test/debugger_alias_test.rb

@@ -1,7 +1,7 @@
-module DebuggerAliasTest
-  class DebuggerAliasSpec < MiniTest::Spec
-    it 'aliases "debugger" to "byebug"' do
-      Kernel.method(:debugger).must_equal(Kernel.method(:byebug))
+module DebuggerAlias
+  class DebuggerAliasTest < Minitest::Test
+    def test_aliases_debugger_to_byebug
+      assert_equal Kernel.method(:byebug), Kernel.method(:debugger)
     end
   end
 end

data/test/delete_test.rb

@@ -0,0 +1,26 @@
+module Byebug
+  class DeleteTestCase < TestCase
+    def setup
+      @example = -> do
+        byebug
+        x = 1
+        x += 1
+        return x
+      end
+
+      super
+    end
+
+    def test_deleting_a_breakpoint_removes_it_from_breakpoints_list
+      enter 'break 7', -> { "delete #{first_brkpt.id}" }
+
+      debug_proc(@example) { assert_empty Byebug.breakpoints }
+    end
+
+    def test_does_not_stop_at_the_deleted_breakpoint
+      enter 'break 7', 'break 8', -> { "delete #{first_brkpt.id}" }, 'cont'
+
+      debug_proc(@example) { assert_equal 8, state.line }
+    end
+  end
+end

data/test/display_test.rb

@@ -1,135 +1,113 @@
-module DisplayTest
-  class DisplayTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class DisplayTestCase < TestCase
+    def setup
       @example = -> do
+        d = 0
         byebug
-        d = 4
-        d = d + 2
         d = d + 3
         d = d + 6
       end
+
+      super
     end
 
-    it 'must show expressions' do
-      enter 'break 7', 'cont', 'display d + 1'
+    def test_shows_expressions
+      enter 'display d + 1'
       debug_proc(@example)
-      check_output_includes '1: ', 'd + 1 = 5'
+      check_output_includes '1: ', 'd + 1 = 1'
     end
 
-    it 'must work with shortcut' do
-      enter 'break 7', 'cont', 'disp d + 1'
+    def test_works_when_using_a_shortcut
+      enter 'disp d + 1'
       debug_proc(@example)
-      check_output_includes '1: ', 'd + 1 = 5'
+      check_output_includes '1: ', 'd + 1 = 1'
     end
 
-    it 'must save displayed expressions' do
+    def test_saves_displayed_expressions
       enter 'display d + 1'
-      debug_proc(@example) { state.display.must_equal [[true, 'd + 1']] }
+      debug_proc(@example) { assert_equal [[true, 'd + 1']], state.display }
     end
 
-    it 'displays all expressions available' do
-      enter 'break 7', 'cont', -> do
-        Byebug.handler.display.concat([[true, 'abc'], [true, 'd']]); 'display'
-      end
+    def test_displays_all_expressions_available
+      enter 'display d', 'display d + 1', 'display'
       debug_proc(@example)
-      check_output_includes '1: ', 'abc = nil', '2: ', 'd = 4'
+      check_output_includes '1: ', 'd = 0', '2: ', 'd + 1 = 1'
     end
+  end
 
-    describe 'undisplay' do
-      describe 'undisplay all' do
-        before do
-          enter 'break 7', 'cont', -> do
-            Byebug.handler.display.concat([[true, 'abc'], [true, 'd']])
-            'undisplay'
-          end, confirm_response, 'display'
-        end
-
-        describe 'confirmation is successful' do
-          let(:confirm_response) { 'y' }
-
-          it 'must ask about confirmation' do
-            debug_proc(@example)
-            check_output_includes \
-              'Clear all expressions? (y/n)', interface.confirm_queue
-          end
-
-          it 'must set all expressions saved to "false"' do
-            debug_proc(@example) { state.display.must_equal [[false, 'abc'],
-                                                              [false, 'd']] }
-          end
-
-          it 'must not show any output' do
-            debug_proc(@example)
-            check_output_doesnt_include '1: ', 'abc = nil', '2: ', 'd = 4'
-          end
-        end
-
-        describe 'confirmation is unsuccessful' do
-          let(:confirm_response) { 'n' }
-
-          it 'must set all expressions saved to "false"' do
-            debug_proc(@example) { state.display.must_equal [[true, 'abc'],
-                                                              [true, 'd']] }
-          end
-
-          it 'must not show any output' do
-            debug_proc(@example)
-            check_output_includes '1: ', 'abc = nil', '2: ', 'd = 4'
-          end
-        end
+  class UndisplayTestCase < TestCase
+    def setup
+      @example = -> do
+        d = 0
+        byebug
+        d = d + 3
+        d = d + 6
       end
 
-      describe 'undisplay specific position' do
-        before do
-          enter 'break 7', 'cont', -> do
-            Byebug.handler.display.concat([[true, 'abc'], [true, 'd']])
-            'undisplay 1'
-          end, 'display'
-        end
-
-        it 'must set inactive positions' do
-          debug_proc(@example) { state.display.must_equal [[nil, 'abc'],
-                                                            [true, 'd']] }
-        end
-
-        it 'must display only the active position' do
-          debug_proc(@example)
-          check_output_includes '2: ', 'd = 4'
-        end
-
-        it 'must not display the disabled position' do
-          debug_proc(@example)
-          check_output_doesnt_include '1: ', 'abc'
-        end
-      end
+      super
     end
 
-    describe 'disable' do
-      it 'must disable a position' do
-        enter 'display d', 'disable display 1'
-        debug_proc(@example) { state.display.must_equal [[false, 'd']] }
-      end
+    def test_asks_for_confirmation
+      enter 'display d', 'display d + 1', 'undisplay'
+      debug_proc(@example)
+      check_output_includes \
+        'Clear all expressions? (y/n)', interface.confirm_queue
+    end
 
-      it 'must show an error if no displays are set' do
-        enter 'disable display 1'
-        debug_proc(@example)
-        check_output_includes \
-          'No display expressions have been set.', interface.error_queue
+    def test_removes_all_expressions_from_list_if_confirmed
+      enter 'display d', 'display d + 1', 'undisplay', 'y', 'next'
+      debug_proc(@example) do
+        assert_equal [[false, 'd'], [false, 'd + 1']], state.display
       end
+      check_output_doesnt_include '1: ', 'd = 3', '2: ', 'd + 1 = 4'
+    end
 
-      it 'must show an error if there is no such display position' do
-        enter 'display d', 'disable display 4'
-        debug_proc(@example)
-        check_output_includes \
-          '"disable display" argument "4" needs to be at most 1'
+    def test_does_not_remove_all_expressions_from_list_unless_confirmed
+      enter 'display d', 'display d + 1', 'undisplay', 'n', 'display'
+      debug_proc(@example) do
+        assert_equal [[true, 'd'], [true, 'd + 1']], state.display
       end
+
+      check_output_includes '1: ', 'd = 0', '2: ', 'd + 1 = 1'
     end
 
-    describe 'enable' do
-      it 'must enable a position' do
-        enter 'display d', 'disable display 1', 'enable display 1'
-        debug_proc(@example) { state.display.must_equal [[true, 'd']] }
+    def test_marks_specific_expression_from_list_as_inactive
+      enter 'display d', 'display d + 1', 'undisplay 1'
+
+      debug_proc(@example) do
+        assert_equal [[nil, 'd'], [true, 'd + 1']], state.display
       end
     end
+
+    def test_displays_only_the_active_position
+      enter 'display d', 'display d + 1', 'undisplay 1', 'next'
+      debug_proc(@example)
+      check_output_includes '2: ', 'd + 1 = 4'
+      check_output_doesnt_include '1: ', 'd = 3'
+    end
+
+    def test_disable_display_removes_the_expression_from_display_list
+      enter 'display d', 'disable display 1'
+      debug_proc(@example) { assert_equal [[false, 'd']], state.display }
+    end
+
+    def test_disable_display_shows_an_error_if_no_displays_are_set
+      enter 'disable display 1'
+      debug_proc(@example)
+      check_output_includes \
+        'No display expressions have been set', interface.error_queue
+    end
+
+    def test_disable_display_shows_an_error_if_theres_no_such_display_position
+      enter 'display d', 'disable display 4'
+      debug_proc(@example)
+      check_output_includes \
+        '"disable display" argument "4" needs to be at most 1'
+    end
+
+    def test_enable_display_set_display_flag_to_true_in_display_list
+      enter 'display d', 'disable display 1', 'enable display 1'
+      debug_proc(@example) { assert_equal [[true, 'd']], state.display }
+    end
   end
 end

data/test/edit_test.rb

@@ -1,52 +1,49 @@
-module EditTest
-  class EditTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class EditTestCase < TestCase
+    def setup
       @example = -> do
         byebug
         Object.new
       end
-    end
-
-    describe 'open configured editor' do
-      temporary_change_hash ENV, 'EDITOR', 'editr'
 
-      it 'must open current file in current line in configured editor' do
-        file = __FILE__
-        Byebug::EditCommand.any_instance.expects(:system).with("editr +6 #{file}")
-        enter 'edit'
-        debug_proc(@example)
-      end
+      super
     end
 
-    describe 'open default editor' do
-      temporary_change_hash ENV, 'EDITOR', nil
+    def after
+      ENV['EDITOR'] = @previous_editor
+    end
 
-      it 'must call "vim" with current line and file if EDITOR env not set' do
-        file = __FILE__
-        Byebug::EditCommand.any_instance.expects(:system).with("vim +6 #{file}")
-        enter 'edit'
-        debug_proc(@example)
-      end
+    def test_edit_opens_current_file_in_current_line_in_configured_editor
+      ENV['EDITOR'] = 'edi'
+      file = __FILE__
+      EditCommand.any_instance.expects(:system).with("edi +6 #{file}")
+      enter 'edit'
+      debug_proc(@example)
     end
 
-    describe 'open configured editor specifying line and file' do
-      temporary_change_hash ENV, 'EDITOR', 'editr'
+    def test_edit_calls_vim_if_no_EDITOR_environment_variable_is_set
+      ENV['EDITOR'] = nil
+      file = __FILE__
+      EditCommand.any_instance.expects(:system).with("vim +6 #{file}")
+      enter 'edit'
+      debug_proc(@example)
+    end
 
-      it 'must open specified line in specified file with configured editor' do
-        file = File.expand_path('test/test_helper.rb')
-        Byebug::EditCommand.any_instance.expects(:system).with("editr +3 #{file}")
-        enter "edit #{file}:3"
-        debug_proc(@example)
-      end
+    def test_edit_opens_configured_editor_at_specific_line_and_file
+      ENV['EDITOR'] = 'edi'
+      file = File.expand_path('test/test_helper.rb')
+      EditCommand.any_instance.expects(:system).with("edi +3 #{file}")
+      enter "edit #{file}:3"
+      debug_proc(@example)
     end
 
-    it 'must show an error if there is no such file' do
+    def test_edit_shows_an_error_if_file_specified_does_not_exists
       enter "edit no_such_file:6"
       debug_proc(@example)
       check_error_includes 'File "no_such_file" is not readable.'
     end
 
-    it 'must show an error if there is incorrect syntax' do
+    def test_edit_shows_an_error_if_incorrect_syntax_is_used
       enter 'edit blabla'
       debug_proc(@example)
       check_error_includes 'Invalid file[:line] number specification: blabla'

data/test/eval_test.rb

@@ -1,119 +1,89 @@
-module EvalTest
-  class Example
+module Byebug
+  class EvalExample
     def sum(a,b)
       a + b
     end
 
     def inspect
-      raise "Broken"
+      raise 'Broken'
     end
   end
 
-  class EvalTestCase < TestDsl::TestCase
-    before do
+  class EvalTestCase < TestCase
+    def setup
       @example = -> do
         byebug
-        @foo = Example.new
+        @foo = EvalExample.new
         @foo.sum(1, 2)
       end
+
+      super
     end
 
-    it 'must evaluate an expression' do
-      enter 'eval 3 + 2'
-      debug_proc(@example)
-      check_output_includes '5'
+    %w(eval e p).each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_properly_evaluates_expressions") do
+        enter 'eval 3 + 2'
+        debug_proc(@example)
+        check_output_includes '5'
+      end
     end
 
-    it 'must evaluate expression that calls Timeout::timeout' do
+    def test_eval_properly_evaluates_an_expression_using_timeout
       enter 'eval Timeout::timeout(60) { 1 }'
       debug_proc(@example)
       check_output_includes '1'
     end
 
-    it 'must work with shortcut' do
-      enter 'e 3 + 2'
-      debug_proc(@example)
-      check_output_includes '5'
+    def test_eval_works_when_inspect_raises_an_exception
+      enter 'c 17', 'p @foo'
+      debug_proc(@example) { assert_equal 17, state.line }
+      check_output_includes 'RuntimeError Exception: Broken'
     end
 
-    it 'must work with another syntax' do
-      enter 'p 3 + 2'
+    def test_autoeval_works_by_default
+      enter '[5, 6 , 7].inject(&:+)'
       debug_proc(@example)
-      check_output_includes '5'
+      check_output_includes '18'
     end
 
-    it 'must work when inspect raises an exception' do
-      enter 'c 17', 'p @foo'
-      debug_proc(@example) { state.line.must_equal 17 }
-      check_output_includes 'RuntimeError Exception: Broken'
+    def test_auto_eval_can_be_turned_off_and_back_on
+      enter 'set noautoeval', '[5, 6, 7].inject(&:+)',
+            'set autoeval',   '[1, 2, 3].inject(&:+)'
+      debug_proc(@example)
+      check_output_doesnt_include '18'
+      check_output_includes '6'
     end
 
-    describe 'autoeval' do
-      it 'must be set by default' do
-        enter '[5, 6 , 7].inject(&:+)'
-        debug_proc(@example)
-        check_output_includes '18'
-      end
-
-      it 'can be turned off and back on' do
-        enter 'set noautoeval', '[5, 6, 7].inject(&:+)',
-              'set autoeval',   '[1, 2, 3].inject(&:+)'
-        debug_proc(@example)
-        check_output_doesnt_include '18'
-        check_output_includes '6'
-      end
+    def test_eval_shows_backtrace_on_error_if_stack_on_error_enabled
+      enter 'set stack_on_error', 'eval 2 / 0'
+      debug_proc(@example)
+      check_output_includes(/\s*from \S+:in \`eval\'/)
+      check_output_doesnt_include 'ZeroDivisionError Exception: divided by 0'
     end
 
-    describe 'stack trace on error' do
-      describe 'when enabled' do
-        temporary_change_hash Byebug::Setting, :stack_on_error, true
-
-        it 'must show a stack trace' do
-          enter 'eval 2 / 0'
-          debug_proc(@example)
-          check_output_includes(/\s*from \S+:in \`eval\'/)
-          check_output_doesnt_include 'ZeroDivisionError Exception: divided by 0'
-        end
-      end
-
-      describe 'when disabled' do
-        temporary_change_hash Byebug::Setting, :stack_on_error, false
-
-        it 'must only show exception' do
-          enter 'eval 2 / 0'
-          debug_proc(@example)
-          check_output_includes 'ZeroDivisionError Exception: divided by 0'
-          check_output_doesnt_include(/\S+:\d+:in `eval':divided by 0/)
-        end
-      end
+    def test_eval_shows_only_exception_if_stack_on_error_disabled
+      enter 'set stack_on_error off', 'eval 2 / 0'
+      debug_proc(@example)
+      check_output_includes 'ZeroDivisionError Exception: divided by 0'
+      check_output_doesnt_include(/\S+:\d+:in `eval':divided by 0/)
     end
 
-    describe 'pp' do
-      it 'must pretty print the expression result' do
-        enter 'pp {a: \'3\' * 40, b: \'4\' * 30}'
-        debug_proc(@example)
-        check_output_includes "{:a=>\"#{'3' * 40}\",\n :b=>\"#{'4' * 30}\"}"
-      end
+    def test_pp_pretty_print_the_expressions_result
+      enter "pp { a: '3' * 40, b: '4' * 30 }"
+      debug_proc(@example)
+      check_output_includes "{:a=>\"#{'3' * 40}\",\n :b=>\"#{'4' * 30}\"}"
     end
 
-    describe 'putl' do
-      temporary_change_hash Byebug::Setting, :width, 20
-
-      it 'must print expression and columnize the result' do
-        enter 'putl [1, 2, 3, 4, 5, 9, 8, 7, 6]'
-        debug_proc(@example)
-        check_output_includes "1  3  5  8  6\n2  4  9  7"
-      end
+    def test_putl_prints_expression_and_columnize_the_result
+      enter 'set width 20', 'putl [1, 2, 3, 4, 5, 9, 8, 7, 6]'
+      debug_proc(@example)
+      check_output_includes "1  3  5  8  6\n2  4  9  7"
     end
 
-    describe 'ps' do
-      temporary_change_hash Byebug::Setting, :width, 20
-
-      it 'must print expression and sort and columnize the result' do
-        enter 'ps [1, 2, 3, 4, 5, 9, 8, 7, 6]'
-        debug_proc(@example)
-        check_output_includes "1  3  5  7  9\n2  4  6  8"
-      end
+    def test_putl_prints_expression_and_sorts_and_columnize_the_result
+      enter 'set width 20', 'ps [1, 2, 3, 4, 5, 9, 8, 7, 6]'
+      debug_proc(@example)
+      check_output_includes "1  3  5  7  9\n2  4  6  8"
     end
   end
 end