byebug 3.1.2 → 3.2.0

data/test/method_test.rb

@@ -1,85 +1,52 @@
-module MethodTest
-  class Example
+module Byebug
+  class MethodExample
     def initialize
       @a = 'b'
       @c = 'd'
     end
+
     def self.foo
-      "asdf"
+      'asdf'
     end
+
     def bla
-      "asdf"
+      'asdf'
     end
   end
 
-  class MethodTestCase < TestDsl::TestCase
-    before do
-      Byebug::Setting[:autolist] = false
+  class MethodTestCase < TestCase
+    def setup
       @example = -> do
         byebug
-        a = Example.new
+        a = MethodExample.new
         a.bla
       end
-    end
 
-    after do
-      Byebug::Setting[:autolist] = true
+      super
     end
 
-    describe 'show instance method of a class' do
-      before { enter 'break 4', 'cont' }
-
-      it 'must show using full command name' do
-        enter 'method Example'
+    %w(method m).each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_instance_methods_of_a_class") do
+        enter 'break 4', 'cont', "#{cmd_alias} MethodExample"
         debug_proc(@example)
         check_output_includes(/bla/)
         check_output_doesnt_include(/foo/)
       end
-
-      it 'must show using shortcut' do
-        enter 'm Example'
-        debug_proc(@example)
-        check_output_includes(/bla/)
-      end
-
-      it 'must show an error if specified object is not a class or module' do
-        enter 'm a'
-        debug_proc(@example)
-        check_output_includes 'Should be Class/Module: a'
-      end
     end
 
-    describe 'show methods of an object' do
-      before { enter 'break 21', 'cont' }
+    def test_m_shows_an_error_if_specified_object_is_not_a_class_or_module
+      enter 'm a'
+      debug_proc(@example)
+      check_output_includes 'Should be Class/Module: a'
+    end
 
-      it 'must show using full command name' do
-        enter 'method instance a'
+    ['method instance', 'm i'].each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_shows_methods_of_object") do
+        enter 'break 22', 'cont', "#{cmd_alias} a"
         debug_proc(@example)
         check_output_includes(/bla/)
         check_output_doesnt_include(/foo/)
       end
-
-      it 'must show using shortcut' do
-        enter 'm i a'
-        debug_proc(@example)
-        check_output_includes(/bla/)
-      end
-    end
-
-    describe 'show instance variables of an object' do
-      before { enter 'break 21', 'cont' }
-
-      it 'must show using full name command' do
-        enter 'method iv a'
-        debug_proc(@example)
-        check_output_includes '@a = "b"', '@c = "d"'
-      end
-
-      it 'must show using shortcut' do
-        enter 'm iv a'
-        debug_proc(@example)
-        check_output_includes '@a = "b"', '@c = "d"'
-      end
     end
   end
 end

data/test/post_mortem_test.rb

@@ -1,5 +1,5 @@
-module PostMortemTest
-  class Example
+module Byebug
+  class PostMortemExample
     def a
       z = 4
       raise 'blabla'
@@ -8,69 +8,67 @@ module PostMortemTest
     end
   end
 
-  class PostMortemTestCase < TestDsl::TestCase
-    before do
+  class PostMortemTestCase < TestCase
+    def setup
       @example = -> do
         byebug
-        c = Example.new
+        c = PostMortemExample.new
         c.a
       end
+
+      super
     end
 
-    describe 'Features' do
-      before { enter 'set post_mortem', 'cont' }
-      after { Byebug.post_mortem = false }
+    def teardown
+      Byebug.post_mortem = false
+    end
 
-      it 'is rising right before exiting' do
-        assert_raises(RuntimeError) do
-          debug_proc(@example)
-        end
+    def test_rises_before_exit_in_post_mortem_mode
+      enter 'set post_mortem', 'cont'
+      assert_raises(RuntimeError) do
+        debug_proc(@example)
       end
+    end
 
-      it 'sets post_mortem to true' do
-        begin
-          debug_proc(@example)
-        rescue
-          Byebug.post_mortem?.must_equal true
-        end
+    def test_post_mortem_mode_sets_post_mortem_flag_to_true
+      enter 'set post_mortem', 'cont'
+      begin
+        debug_proc(@example)
+      rescue
+        assert_equal true, Byebug.post_mortem?
       end
+    end
 
-      it 'stops at the correct line' do
-        begin
-          debug_proc(@example)
-        rescue
-          Byebug.raised_exception.__bb_line.must_equal 5
-        end
+    def test_execution_is_stop_at_the_correct_line_after_exception
+      enter 'set post_mortem', 'cont'
+      begin
+        debug_proc(@example)
+      rescue
+        assert_equal 5, Byebug.raised_exception.__bb_line
       end
     end
 
-    describe 'Unavailable commands' do
-      temporary_change_hash Byebug::Setting, :autoeval, false
-
-      %w(step next finish break condition display reload).each do |cmd|
-        define_method "test_#{cmd}_is_forbidden_in_post_mortem_mode" do
-          enter "#{cmd}"
-          state.context.stubs(:dead?).returns(:true)
-          begin
-            debug_proc(@example)
-          rescue RuntimeError
-            check_error_includes 'Command unavailable in post mortem mode.'
-          end
+    %w(step next finish break condition display reload).each do |cmd|
+      define_method "test_#{cmd}_is_forbidden_in_post_mortem_mode" do
+        enter 'set noautoeval', cmd
+        state.context.stubs(:dead?).returns(:true)
+        begin
+          debug_proc(@example)
+        rescue RuntimeError
+          check_error_includes 'Command unavailable in post mortem mode.'
         end
       end
     end
 
-    describe 'Available commands' do
-      ['restart', 'frame', 'quit', 'edit', 'info', 'irb', 'source', 'help',
-       'var class', 'list', 'method', 'kill', 'eval', 'set', 'save', 'show',
-       'trace', 'thread list'].each do |cmd|
-        define_method "test_#{cmd}_is_permitted_in_post_mortem_mode" do
-          enter "#{cmd}"
-          class_name = cmd.gsub(/(^| )\w/) { |b| b[-1,1].upcase } + 'Command'
+    ['restart', 'frame', 'quit', 'edit', 'info', 'irb', 'source', 'help',
+     'var class', 'list', 'method', 'kill', 'eval', 'set', 'save', 'show',
+     'trace', 'thread list'].each do |cmd|
+      define_method "test_#{cmd}_is_permitted_in_post_mortem_mode" do
+        enter "#{cmd}"
+        class_name = cmd.gsub(/(^| )\w/) { |b| b[-1,1].upcase } + 'Command'
 
-          Byebug.const_get(class_name).any_instance.stubs(:execute)
-          assert_raises(RuntimeError) { debug_proc(@example) }
-        end
+        Byebug.const_get(class_name).any_instance.stubs(:execute)
+        assert_raises(RuntimeError) { debug_proc(@example) }
       end
     end
   end

data/test/pry_test.rb

@@ -0,0 +1,42 @@
+begin
+  require 'pry'
+  has_pry = true
+rescue LoadError
+  has_pry = false
+end
+
+module Byebug
+  class PryTestCase < TestCase
+    def setup
+      @example = -> do
+        byebug
+        a = 2
+        a = 3
+        a = 4
+        a = 5
+        a = 6
+      end
+
+      super
+
+      interface.stubs(:kind_of?).with(LocalInterface).returns(true)
+      PryCommand.any_instance.expects(:pry)
+    end
+
+    def test_pry_supports_next_command
+      skip 'TODO'
+    end
+
+    def test_pry_supports_step_command
+      skip 'TODO'
+    end
+
+    def test_pry_supports_cont_command
+      skip 'TODO'
+    end
+
+    def test_autopry_calls_pry_automatically_after_every_stop
+      skip 'TODO'
+    end
+  end
+end if has_pry

data/test/quit_test.rb

@@ -1,49 +1,51 @@
-module QuitTest
-  class QuitTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class QuitTestCase < TestCase
+    def setup
       @example = -> do
         byebug
         Object.new
       end
+
+      super
     end
 
-    it 'must quit if user confirmed' do
-      Byebug::QuitCommand.any_instance.expects(:exit!)
+    def test_finishes_byebug_if_user_confirms
+      QuitCommand.any_instance.expects(:exit!)
       enter 'quit', 'y'
       debug_proc(@example)
       check_output_includes 'Really quit? (y/n)', interface.confirm_queue
     end
 
-    it 'must not quit if user didn\'t confirm' do
-      Byebug::QuitCommand.any_instance.expects(:exit!).never
+    def test_does_not_quit_if_user_did_not_confirm
+      QuitCommand.any_instance.expects(:exit!).never
       enter 'quit', 'n'
       debug_proc(@example)
       check_output_includes 'Really quit? (y/n)', interface.confirm_queue
     end
 
-    it 'must quit immediatly if used with !' do
-      Byebug::QuitCommand.any_instance.expects(:exit!)
+    def test_quits_inmediately_if_used_with_bang
+      QuitCommand.any_instance.expects(:exit!)
       enter 'quit!'
       debug_proc(@example)
       check_output_doesnt_include 'Really quit? (y/n)', interface.confirm_queue
     end
 
-    it 'must quit immediatly if used with "unconditionally"' do
-      Byebug::QuitCommand.any_instance.expects(:exit!)
+    def test_quits_inmediately_if_used_with_unconditionally
+      QuitCommand.any_instance.expects(:exit!)
       enter 'quit unconditionally'
       debug_proc(@example)
       check_output_doesnt_include 'Really quit? (y/n)', interface.confirm_queue
     end
 
-    it 'must close interface before quitting' do
-      Byebug::QuitCommand.any_instance.stubs(:exit!)
+    def test_closes_interface_before_quitting
+      QuitCommand.any_instance.stubs(:exit!)
       interface.expects(:close)
       enter 'quit!'
       debug_proc(@example)
     end
 
-    it 'must quit if used "exit" alias' do
-      Byebug::QuitCommand.any_instance.expects(:exit!)
+    def test_quits_if_used_with_exit_alias
+      QuitCommand.any_instance.expects(:exit!)
       enter 'exit!'
       debug_proc(@example)
     end

data/test/reload_test.rb

@@ -1,6 +1,6 @@
-module ReloadTest
-  class ReloadTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class ReloadTestCase < TestCase
+    def setup
       @example = -> do
         byebug
         a = 6
@@ -9,36 +9,31 @@ module ReloadTest
         a = 9
         a = 10
       end
-    end
-
-    describe 'autoreloading' do
-      after { Byebug::Setting[:autoreload] = true }
 
-      it 'must notify that automatic reloading is on by default' do
-        enter 'reload'
-        debug_proc(@example)
-        check_output_includes \
-          'Source code is reloaded. Automatic reloading is on.'
-      end
+      super
+    end
 
-      it 'must notify that automatic reloading is off if setting changed' do
-        enter 'set noautoreload', 'reload'
-        debug_proc(@example)
-        check_output_includes \
-          'Source code is reloaded. Automatic reloading is off.'
-      end
+    def test_reload_notifies_about_default_setting
+      enter 'reload'
+      debug_proc(@example)
+      check_output_includes \
+        'Source code was reloaded. Automatic reloading is on'
     end
 
-    describe 'reloading' do
-      after { change_line_in_file(__FILE__, 8, '        a = 8') }
+    def test_reload_notifies_that_automatic_reloading_is_off_is_setting_changed
+      enter 'set noautoreload', 'reload'
+      debug_proc(@example)
+      check_output_includes \
+        'Source code was reloaded. Automatic reloading is off'
+    end
 
-      it 'must reload the code' do
-        enter 'break 7', 'cont', 'l 8-8',
-          -> { change_line_in_file(__FILE__, 8, '        a = 100'); 'reload' },
-          'l 8-8'
-        debug_proc(@example)
-        check_output_includes '8:         a = 100'
-      end
+    def test_reload_properly_reloads_source_code
+      enter 'break 7', 'cont', 'l 8-8',
+        -> { change_line_in_file(__FILE__, 8, '        a = 100'); 'reload' },
+        'l 8-8'
+      debug_proc(@example)
+      check_output_includes '8:         a = 100'
+      change_line_in_file(__FILE__, 8, '        a = 8')
     end
   end
 end

data/test/restart_test.rb

@@ -1,90 +1,62 @@
-module RestartTest
-  class Example
+module Byebug
+  class RestartExample
     def concat_args(a, b, c)
       a.to_s + b.to_s + c.to_s
     end
   end
 
-  class RestartTestCase < TestDsl::TestCase
-    before do
+  class RestartTestCase < TestCase
+    def setup
       @example = -> do
         byebug
         a = ARGV[0]
         b = ARGV[1]
         c = ARGV[2]
-        Example.new.concat_args(a, b, c)
+        RestartExample.new.concat_args(a, b, c)
       end
+
+      super
     end
 
     def must_restart(cmd = nil)
-      expectation = Byebug::RestartCommand.any_instance.expects(:exec)
+      expectation = RestartCommand.any_instance.expects(:exec)
       expectation = expectation.with(cmd) if cmd
       expectation
     end
 
-    describe 'usual restarting' do
-      temporary_change_const Byebug, 'BYEBUG_SCRIPT', 'byebug_script'
-
-      it 'must be restarted with arguments' do
-        cmd = "#{Byebug::BYEBUG_SCRIPT} #{Byebug::PROG_SCRIPT} 1 2 3"
-        must_restart(cmd)
-        enter 'restart 1 2 3'
-        debug_proc(@example)
-        check_output_includes "Re exec'ing:\n\t#{cmd}"
-      end
+    def test_restarts_with_manual_arguments
+      force_set_const(Byebug, 'BYEBUG_SCRIPT', 'byebug_script')
+      cmd = "#{BYEBUG_SCRIPT} #{PROG_SCRIPT} 1 2 3"
+      must_restart(cmd)
+      enter 'restart 1 2 3'
+      debug_proc(@example)
+      check_output_includes "Re exec'ing:\n\t#{cmd}"
     end
 
-    describe 'no script specified' do
-      temporary_change_const Byebug, 'PROG_SCRIPT', :__undefined__
-
-      it 'must not restart and show error messages instead' do
-        must_restart.never
-        enter 'restart'
-        debug_proc(@example)
-        check_error_includes 'Don\'t know name of debugged program'
-      end
+    def test_does_not_restart_when_no_script_specified
+      force_unset_const(Byebug, 'PROG_SCRIPT')
+      must_restart.never
+      enter 'restart'
+      debug_proc(@example)
+      check_error_includes "Don't know name of debugged program"
     end
 
-    describe 'no script at the specified path' do
-      temporary_change_const Byebug, 'PROG_SCRIPT', 'blabla'
-
-      it 'must not restart' do
-        must_restart.never
-        enter 'restart'
-        debug_proc(@example)
-      end
-
-      it 'must show an error message' do
-        enter 'restart'
-        debug_proc(@example)
-        check_error_includes 'Ruby program blabla doesn\'t exist'
-      end
+    def test_does_not_restart_when_script_specified_does_not_exist
+      force_set_const(Byebug, 'PROG_SCRIPT', 'blabla')
+      must_restart.never
+      enter 'restart'
+      debug_proc(@example)
+      check_error_includes 'Ruby program blabla doesn\'t exist'
     end
 
-    describe 'when no runner script specified' do
-      temporary_change_const Byebug, 'BYEBUG_SCRIPT', :__undefined__
-
-      describe 'restarting' do
-        before do
-          must_restart
-          enter 'restart'
-        end
-
-        it 'must restart anyways' do
-          debug_proc(@example)
-        end
-
-        it 'must show a warning message' do
-          debug_proc(@example)
-          check_output_includes 'Byebug was not called from the outset...'
-        end
-
-        it 'must show a warning message when prog script is not executable' do
-          debug_proc(@example)
-          check_output_includes "Ruby program #{Byebug::PROG_SCRIPT} not " \
-                                "executable... We'll wrap it in a ruby call"
-        end
-      end
+    def test_still_restarts_when_byebug_attached_to_running_program
+      force_unset_const(Byebug, 'BYEBUG_SCRIPT')
+      must_restart
+      enter 'restart'
+      debug_proc(@example)
+      check_output_includes 'Byebug was not called from the outset...'
+      check_output_includes "Ruby program #{PROG_SCRIPT} not executable... " \
+                            "We'll wrap it in a ruby call"
     end
   end
 end