byebug 3.0.0 → 3.1.0

data/test/eval_test.rb

@@ -1,103 +1,119 @@
-class EvalTest
-  def sum(a,b)
-    a + b
-  end
+module EvalTest
+  class Example
+    def sum(a,b)
+      a + b
+    end
 
-  def inspect
-    raise "Broken"
+    def inspect
+      raise "Broken"
+    end
   end
-end
 
-class TestEval < TestDsl::TestCase
-  it 'must evaluate an expression' do
-    enter 'eval 3 + 2'
-    debug_file 'eval'
-    check_output_includes '5'
-  end
+  class EvalTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        byebug
+        @foo = Example.new
+        @foo.sum(1, 2)
+      end
+    end
 
-  it 'must work with shortcut' do
-    enter 'e 3 + 2'
-    debug_file 'eval'
-    check_output_includes '5'
-  end
+    it 'must evaluate an expression' do
+      enter 'eval 3 + 2'
+      debug_proc(@example)
+      check_output_includes '5'
+    end
 
-  it 'must work with another syntax' do
-    enter 'p 3 + 2'
-    debug_file 'eval'
-    check_output_includes '5'
-  end
+    it 'must evaluate expression that calls Timeout::timeout' do
+      enter 'eval Timeout::timeout(60) { 1 }'
+      debug_proc(@example)
+      check_output_includes '1'
+    end
 
-  it 'must work when inspect raises an exception' do
-    enter 'c 4', 'p @foo'
-    debug_file('eval') { state.line.must_equal 4 }
-    check_output_includes 'RuntimeError Exception: Broken'
-  end
+    it 'must work with shortcut' do
+      enter 'e 3 + 2'
+      debug_proc(@example)
+      check_output_includes '5'
+    end
 
-  describe 'autoeval' do
-    it 'must be set by default' do
-      enter '[5,6,7].inject(&:+)'
-      debug_file 'eval'
-      check_output_includes '18'
+    it 'must work with another syntax' do
+      enter 'p 3 + 2'
+      debug_proc(@example)
+      check_output_includes '5'
     end
 
-    it 'can be turned off and back on' do
-      enter 'set noautoeval', '[5,6,7].inject(&:+)',
-            'set autoeval',   '[1,2,3].inject(&:+)'
-      debug_file 'eval'
-      check_output_doesnt_include '18'
-      check_output_includes '6'
+    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'
     end
-  end
 
-  describe 'stack trace on error' do
-    describe 'when enabled' do
-      temporary_change_hash Byebug.settings, :stack_on_error, true
+    describe 'autoeval' do
+      it 'must be set by default' do
+        enter '[5, 6 , 7].inject(&:+)'
+        debug_proc(@example)
+        check_output_includes '18'
+      end
 
-      it 'must show a stack trace' do
-        enter 'eval 2 / 0'
-        debug_file 'eval'
-        check_output_includes(/\s*from \S+:in \`eval\'/)
-        check_output_doesnt_include 'ZeroDivisionError Exception: divided by 0'
+      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
     end
 
-    describe 'when disabled' do
-      temporary_change_hash Byebug.settings, :stack_on_error, false
+    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_file 'eval'
-        check_output_includes 'ZeroDivisionError Exception: divided by 0'
-        check_output_doesnt_include(/\S+:\d+:in `eval':divided by 0/)
+        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
     end
-  end
 
-  describe 'pp' do
-    it 'must pretty print the expression result' do
-      enter 'pp {a: \'3\' * 40, b: \'4\' * 30}'
-      debug_file 'eval'
-      check_output_includes "{:a=>\"#{'3' * 40}\",\n :b=>\"#{'4' * 30}\"}"
+    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
     end
-  end
 
-  describe 'putl' do
-    temporary_change_hash Byebug.settings, :width, 20
+    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_file 'eval'
-      check_output_includes "1  3  5  8  6\n2  4  9  7"
+      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
     end
-  end
 
-  describe 'ps' do
-    temporary_change_hash Byebug.settings, :width, 20
+    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_file 'eval'
-      check_output_includes "1  3  5  7  9\n2  4  6  8"
+      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
     end
   end
 end

data/test/finish_test.rb

@@ -1,53 +1,64 @@
-class FinishExample
-  def a
-    b
-  end
-  def b
-    c
-    2
-  end
-  def c
-    d
-    3
-  end
-  def d
-    5
-  end
-end
+module FinishTest
+  class Example
+    def a
+      b
+    end
 
-class TestFinish < TestDsl::TestCase
-  before { enter "break #{__FILE__}:14", 'cont' }
+    def b
+      c
+      2
+    end
 
-  it 'must stop after current frame is finished when without arguments' do
-    enter 'finish'
-    debug_file('finish') { state.line.must_equal 11 }
-  end
+    def c
+      d
+      3
+    end
 
-  it 'must stop before current frame finishes if 0 specified as argument' do
-    enter 'finish 0'
-    debug_file('finish') { state.line.must_equal 15 }
+    def d
+      5
+    end
   end
 
-  it 'must stop after current frame is finished if 1 specified as argument' do
-    enter 'finish 1'
-    debug_file('finish') { state.line.must_equal 11 }
-  end
+  class FinishTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        byebug
+        Example.new.a
+      end
+      enter 'break 18', 'cont'
+    end
 
-  it 'must behave consistenly even if current frame has been changed' do
-    enter 'up', 'finish'
-    debug_file('finish') { state.line.must_equal 7 }
-  end
+    it 'must stop after current frame is finished when without arguments' do
+      enter 'finish'
+      debug_proc(@example) { state.line.must_equal 14 }
+    end
 
-  describe 'not a number is specified for frame' do
-    before { enter 'finish foo' }
+    it 'must stop before current frame finishes if 0 specified as argument' do
+      enter 'finish 0'
+      debug_proc(@example) { state.line.must_equal 19 }
+    end
 
-    it 'must show an error' do
-      debug_file('finish')
-      check_output_includes '"finish" argument "foo" needs to be a number.'
+    it 'must stop after current frame is finished if 1 specified as argument' do
+      enter 'finish 1'
+      debug_proc(@example) { state.line.must_equal 14 }
     end
 
-    it 'must be on the same line' do
-      debug_file('finish') { state.line.must_equal 14 }
+    it 'must behave consistenly even if current frame has been changed' do
+      enter 'up', 'finish'
+      debug_proc(@example) { state.line.must_equal 9 }
+    end
+
+    describe 'not a number is specified for frame' do
+      before { enter 'finish foo' }
+
+      it 'must show an error' do
+        debug_proc(@example)
+        check_output_includes '"finish" argument "foo" needs to be a number'
+      end
+
+      it 'must be on the same line' do
+        debug_proc(@example) { state.line.must_equal 18 }
+      end
     end
   end
 end

data/test/frame_test.rb

@@ -1,228 +1,241 @@
-class FrameExample
-  def initialize(f)
-    @f = f
-  end
-
-  def a
-    b
-  end
-
-  def b
-    c
-    2
-  end
-
-  def c
-    d('a')
-    3
-  end
-
-  def d(e)
-    5
+module FrameTest
+  class Example
+    def initialize(f)
+      @f = f
+    end
+    def a
+      b
+    end
+    def b
+      c
+      2
+    end
+    def c
+      d('a')
+      3
+    end
+    def d(e)
+      5
+    end
   end
-end
 
-class FrameDeepExample
-  def a
-    z = 1
-    z += b
-  end
-  def b
-    z = 2
-    z += c
-  end
-  def c
-    z = 3
-    byebug
-    z += d('a')
-  end
-  def d(e)
-    4
+  class DeepExample
+    def a
+      z = 1
+      z += b
+    end
+    def b
+      z = 2
+      z += c
+    end
+    def c
+      z = 3
+      byebug
+      z += d('a')
+    end
+    def d(e)
+      4
+    end
   end
-end
 
-class TestFrame < TestDsl::TestCase
-  describe 'when byebug started at the beginning' do
+  class FrameTestCase < TestDsl::TestCase
     before do
-      @tst_file = fullpath('frame')
-      enter "break #{__FILE__}:21", 'cont'
+      @example = -> do
+        byebug
+        fr_ex = Example.new('f')
+        fr_ex.a()
+      end
     end
 
-    it 'must go up' do
-      enter 'up'
-      debug_file('frame') { state.line.must_equal 16 }
-    end
+    describe 'when byebug started at the beginning' do
+      before do
+        enter "break #{__FILE__}:18", 'cont'
+      end
 
-    it 'must go up by specific number of frames' do
-      enter 'up 2'
-      debug_file('frame') { state.line.must_equal 11 }
-    end
+      it 'must go up' do
+        enter 'up'
+        debug_proc(@example) { state.line.must_equal 14 }
+      end
 
-    it 'must go down' do
-      enter 'up', 'down'
-      debug_file('frame') { state.line.must_equal 21 }
-    end
+      it 'must go up by specific number of frames' do
+        enter 'up 2'
+        debug_proc(@example) { state.line.must_equal 10 }
+      end
 
-    it 'must go down by specific number of frames' do
-      enter 'up 3', 'down 2'
-      debug_file('frame') { state.line.must_equal 16 }
-    end
+      it 'must go down' do
+        enter 'up', 'down'
+        debug_proc(@example) { state.line.must_equal 18 }
+      end
 
-    it 'must set frame' do
-      enter 'frame 2'
-      debug_file('frame') { state.line.must_equal 11 }
-    end
+      it 'must go down by specific number of frames' do
+        enter 'up 3', 'down 2'
+        debug_proc(@example) { state.line.must_equal 14 }
+      end
 
-    it 'must print current stack frame when without arguments' do
-      enter 'up', 'frame'
-      debug_file('frame')
-      check_output_includes(/#1  FrameExample\.c\s+at #{__FILE__}:16/)
-    end
+      it 'must set frame' do
+        enter 'frame 2'
+        debug_proc(@example) { state.line.must_equal 10 }
+      end
 
-    it 'must set frame to the first one' do
-      enter 'up', 'frame 0'
-      debug_file('frame') { state.line.must_equal 21 }
-    end
+      it 'must print current stack frame when without arguments' do
+        enter 'up', 'frame'
+        debug_proc(@example)
+        check_output_includes(/#1  FrameTest::Example\.c\s+at #{__FILE__}:14/)
+      end
 
-    it 'must set frame to the last one' do
-      enter 'frame -1'
-      debug_file('frame') { File.basename(state.file).must_equal 'test_helper.rb' }
-    end
+      it 'must set frame to the first one' do
+        enter 'up', 'frame 0'
+        debug_proc(@example) { state.line.must_equal 18 }
+      end
 
-    it 'must not set frame if the frame number is too low' do
-      enter 'down'
-      debug_file('frame') { state.line.must_equal 21 }
-      check_output_includes \
-        "Can't navigate beyond the newest frame", interface.error_queue
-    end
+      it 'must set frame to the last one' do
+        enter 'frame -1'
+        debug_proc(@example) { File.basename(state.file).must_equal 'test_helper.rb' }
+      end
 
-    it 'must not set frame if the frame number is too high' do
-      enter 'up 100'
-      debug_file('frame') { state.line.must_equal 21 }
-      check_output_includes \
-        "Can't navigate beyond the oldest frame", interface.error_queue
-    end
+      it 'must not set frame if the frame number is too low' do
+        enter 'down'
+        debug_proc(@example) { state.line.must_equal 18 }
+        check_output_includes \
+          "Can't navigate beyond the newest frame", interface.error_queue
+      end
 
-    describe 'fullpath' do
-      describe 'when set' do
-        temporary_change_hash Byebug.settings, :fullpath, true
-
-        it 'must display current backtrace with fullpaths' do
-          enter 'where'
-          debug_file 'frame'
-          check_output_includes(
-            /--> #0  FrameExample\.d\(e#String\)\s+at #{__FILE__}:21/,
-                /#1  FrameExample\.c\s+at #{__FILE__}:16/,
-                /#2  FrameExample\.b\s+at #{__FILE__}:11/)
-        end
+      it 'must not set frame if the frame number is too high' do
+        enter 'up 100'
+        debug_proc(@example) { state.line.must_equal 18 }
+        check_output_includes \
+          "Can't navigate beyond the oldest frame", interface.error_queue
       end
 
-      describe 'when unset' do
-        temporary_change_hash Byebug.settings, :fullpath, false
+      describe 'fullpath' do
+        describe 'when set' do
+          temporary_change_hash Byebug::Setting, :fullpath, true
 
-        it 'must display current backtrace with shortpaths' do
-          enter 'where'
-          debug_file 'frame'
-          check_output_includes(
-            /--> #0  FrameExample\.d\(e#String\)\s+at #{shortpath(__FILE__)}:21/,
-                /#1  FrameExample\.c\s+at #{shortpath(__FILE__)}:16/,
-                /#2  FrameExample\.b\s+at #{shortpath(__FILE__)}:11/,
-                /#3  FrameExample\.a\s+at #{shortpath(__FILE__)}:7/)
+          it 'must display current backtrace with fullpaths' do
+            enter 'where'
+            debug_proc(@example)
+            check_output_includes(
+              /--> #0  FrameTest::Example\.d\(e#String\)\s+at #{__FILE__}:18/,
+                  /#1  FrameTest::Example\.c\s+at #{__FILE__}:14/,
+                  /#2  FrameTest::Example\.b\s+at #{__FILE__}:10/,
+                  /#3  FrameTest::Example\.a\s+at #{__FILE__}:7/)
+          end
         end
-      end
-    end
 
-    describe 'callstyle' do
-      describe 'long' do
-        temporary_change_hash Byebug.settings, :callstyle, :long
-
-        it 'displays current backtrace with callstyle "long"' do
-          enter 'where'
-          debug_file 'frame'
-          check_output_includes(
-            /--> #0  FrameExample\.d\(e#String\)\s+at #{__FILE__}:21/,
-                /#1  FrameExample\.c\s+at #{__FILE__}:16/,
-                /#2  FrameExample\.b\s+at #{__FILE__}:11/,
-                /#3  FrameExample\.a\s+at #{__FILE__}:7/)
+        describe 'when unset' do
+          temporary_change_hash Byebug::Setting, :fullpath, false
+
+          it 'must display current backtrace with shortpaths' do
+            path = shortpath(__FILE__)
+            enter 'where'
+            debug_proc(@example)
+            check_output_includes(
+              /--> #0  FrameTest::Example\.d\(e#String\)\s+at #{path}:18/,
+                  /#1  FrameTest::Example\.c\s+at #{path}:14/,
+                  /#2  FrameTest::Example\.b\s+at #{path}:10/,
+                  /#3  FrameTest::Example\.a\s+at #{path}:7/)
+          end
         end
       end
 
-      describe 'short' do
-        temporary_change_hash Byebug.settings, :callstyle, :short
+      describe 'callstyle' do
+        describe 'long' do
+          temporary_change_hash Byebug::Setting, :callstyle, :long
 
-        it 'displays current backtrace with callstyle "short"' do
+          it 'displays current backtrace with callstyle "long"' do
             enter 'where'
-            debug_file 'frame'
-            check_output_includes(/--> #0  d\(e\)\s+at #{__FILE__}:21/,
-                                      /#1  c\s+at #{__FILE__}:16/,
-                                      /#2  b\s+at #{__FILE__}:11/,
-                                      /#3  a\s+at #{__FILE__}:7/)
+            debug_proc(@example)
+            check_output_includes(
+              /--> #0  FrameTest::Example\.d\(e#String\)\s+at #{__FILE__}:18/,
+                  /#1  FrameTest::Example\.c\s+at #{__FILE__}:14/,
+                  /#2  FrameTest::Example\.b\s+at #{__FILE__}:10/,
+                  /#3  FrameTest::Example\.a\s+at #{__FILE__}:7/)
+          end
+        end
+
+        describe 'short' do
+          temporary_change_hash Byebug::Setting, :callstyle, :short
+
+          it 'displays current backtrace with callstyle "short"' do
+              enter 'where'
+              debug_proc(@example)
+              check_output_includes(/--> #0  d\(e\)\s+at #{__FILE__}:18/,
+                                        /#1  c\s+at #{__FILE__}:14/,
+                                        /#2  b\s+at #{__FILE__}:10/,
+                                        /#3  a\s+at #{__FILE__}:7/)
+          end
         end
       end
     end
-  end
 
-  describe 'when byebug is started deep in the callstack' do
-    before { enter "break #{__FILE__}:40", 'cont' }
+    describe 'when byebug is started deep in the callstack' do
+      before do
+        @deep_example = -> do
+          DeepExample.new.a
+        end
+        enter "break #{__FILE__}:37", 'cont'
+      end
 
-    it 'must print backtrace' do
-      enter 'where'
-      debug_file 'frame_deep'
-      check_output_includes(
-        /--> #0  FrameDeepExample\.d\(e#String\)\s+at #{__FILE__}:40/,
-            /#1  FrameDeepExample\.c\s+at #{__FILE__}:37/,
-            /#2  FrameDeepExample\.b\s+at #{__FILE__}:32/)
-    end
+      it 'must print backtrace' do
+        enter 'where'
+        debug_proc(@deep_example)
+        check_output_includes(
+          /--> #0  FrameTest::DeepExample\.d\(e#String\)\s+at #{__FILE__}:37/,
+              /#1  FrameTest::DeepExample\.c\s+at #{__FILE__}:34/,
+              /#2  FrameTest::DeepExample\.b\s+at #{__FILE__}:29/)
+      end
 
-    it 'must go up' do
-      enter 'up'
-      debug_file('frame_deep') { state.line.must_equal 37 }
-    end
+      it 'must go up' do
+        enter 'up'
+        debug_proc(@deep_example) { state.line.must_equal 34 }
+      end
 
-    it 'must go down' do
-      enter 'up', 'down'
-      debug_file('frame_deep') { state.line.must_equal 40 }
-    end
+      it 'must go down' do
+        enter 'up', 'down'
+        debug_proc(@deep_example) { state.line.must_equal 37 }
+      end
 
-    it 'must set frame' do
-      enter 'frame 2'
-      debug_file('frame_deep') { state.line.must_equal 32 }
-    end
+      it 'must set frame' do
+        enter 'frame 2'
+        debug_proc(@deep_example) { state.line.must_equal 29 }
+      end
 
-    it 'must eval properly when scaling the stack' do
-      enter 'p z', 'up', 'p z', 'up', 'p z'
-      debug_file('frame_deep')
-      check_output_includes 'nil', '3', '2'
+      it 'must eval properly when scaling the stack' do
+        enter 'p z', 'up', 'p z', 'up', 'p z'
+        debug_proc(@deep_example)
+        check_output_includes 'nil', '3', '2'
+      end
     end
-  end
 
-  describe 'c-frames' do
-    it 'must mark c-frames when printing the stack' do
-      enter "break #{__FILE__}:3", 'cont', 'where'
-      enter 'where'
-      debug_file 'frame'
-      check_output_includes(
-        /--> #0  FrameExample.initialize\(f#String\)\s+at #{__FILE__}:3/,
-            /ͱ-- #1  Class.new\(\*args\)\s+at #{fullpath('frame')}:3/,
-            /#2  <top \(required\)>\s+at #{fullpath('frame')}:3/)
-    end
+    describe 'c-frames' do
+      it 'must mark c-frames when printing the stack' do
+        file = __FILE__
+        enter "break #{__FILE__}:4", 'cont', 'where'
+        enter 'where'
+        debug_proc(@example)
+        check_output_includes(
+          /--> #0  FrameTest::Example.initialize\(f#String\)\s+at #{file}:4/,
+              /ͱ-- #1  Class.new\(\*args\)\s+at #{file}:45/,
+              /#2  block \(2 levels\) in <class:FrameTestCase>\s+at #{file}:45/)
+      end
 
-    it '"up" skips c-frames' do
-      enter "break #{__FILE__}:7", 'cont', 'up', 'eval fr_ex.class.to_s'
-      debug_file 'frame'
-      check_output_includes '"FrameExample"'
-    end
+      it '"up" skips c-frames' do
+        enter "break #{__FILE__}:7", 'cont', 'up', 'eval fr_ex.class.to_s'
+        debug_proc(@example)
+        check_output_includes '"FrameTest::Example"'
+      end
 
-    it '"down" skips c-frames' do
-      enter "break #{__FILE__}:7", 'cont', 'up', 'down', 'eval @f'
-      debug_file 'frame'
-      check_output_includes '"f"'
-    end
+      it '"down" skips c-frames' do
+        enter "break #{__FILE__}:7", 'cont', 'up', 'down', 'eval @f'
+        debug_proc(@example)
+        check_output_includes '"f"'
+      end
 
-    it 'must not jump straigh to c-frames' do
-      enter "break #{__FILE__}:3", 'cont', 'frame 1'
-      debug_file 'frame'
-      check_output_includes "Can't navigate to c-frame", interface.error_queue
+      it 'must not jump straigh to c-frames' do
+        enter "break #{__FILE__}:4", 'cont', 'frame 1'
+        debug_proc(@example)
+        check_output_includes "Can't navigate to c-frame", interface.error_queue
+      end
     end
   end
 end