byebug 3.0.0 → 3.1.0

data/test/show_test.rb

@@ -1,230 +1,97 @@
-class TestShow < TestDsl::TestCase
-  describe 'args' do
-    temporary_change_hash Byebug.settings, :argv, %w{foo bar}
-
-    describe 'default behaviour' do
-      it 'must show args' do
-        enter 'show args'
-        debug_file 'show'
-        check_output_includes 'Argument list to give program being debugged ' \
-                              'when it is started is "foo bar".'
+module ShowTest
+  class ShowTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        byebug
       end
     end
 
-    describe 'when BYEBUG_SCRIPT is defined' do
-      temporary_change_const Byebug, 'BYEBUG_SCRIPT', 'bla'
+    [:autoeval, :autolist, :autoreload, :autosave, :basename, :forcestep,
+     :fullpath, :post_mortem, :stack_on_error, :testing, :linetrace,
+     :tracing_plus].each do |setting|
+      describe "showing disabled boolean setting #{setting}" do
+        temporary_change_hash Byebug::Setting, setting, false
 
-      it 'must not show the first arg' do
-        enter 'show args'
-        debug_file 'show'
-        check_output_includes 'Argument list to give program being debugged ' \
-                              'when it is started is "bar".'
+        it 'must show default value' do
+          enter "show #{setting}"
+          debug_proc(@example)
+          check_output_includes "#{setting} is off"
+        end
       end
-    end
-  end
-
-  describe 'autolist' do
-    it 'must show default value' do
-      enter 'show autolist'
-      debug_file 'show'
-      check_output_includes 'autolist is on.'
-    end
-  end
-
-  describe 'autoeval' do
-    it 'must show default value' do
-      enter 'show autoeval'
-      debug_file 'show'
-      check_output_includes 'autoeval is on.'
-    end
-  end
-
-  describe 'autoreload' do
-    it 'must show default value' do
-      enter 'show autoreload'
-      debug_file 'show'
-      check_output_includes 'autoreload is on.'
-    end
-  end
-
-  describe 'autoirb' do
-    before { Byebug::IrbCommand.any_instance.stubs(:execute) }
-
-    it 'must show default value' do
-      enter 'show autoirb'
-      debug_file 'show'
-      check_output_includes 'autoirb is off.'
-    end
-  end
-
-  describe 'basename' do
-    it 'must show default value' do
-      enter 'show basename'
-      debug_file 'show'
-      check_output_includes 'basename is off.'
-    end
-  end
-
-  describe 'callstyle' do
-    it 'must show default value' do
-      enter 'show callstyle'
-      debug_file 'show'
-      check_output_includes 'Frame call-display style is long.'
-    end
-  end
-
-  describe 'forcestep' do
-    it 'must show default value' do
-      enter 'show forcestep'
-      debug_file 'show'
-      check_output_includes 'force-stepping is off.'
-    end
-  end
-
-  describe 'fullpath' do
-    it 'must show default value' do
-      enter 'show fullpath'
-      debug_file 'show'
-      check_output_includes 'Displaying frame\'s full file names is on.'
-    end
-  end
-
-  describe 'linetrace' do
-    it 'must show default value' do
-      enter 'show linetrace'
-      debug_file 'show'
-      check_output_includes 'line tracing is off.'
-    end
-  end
-
-  describe 'linetrace_plus' do
-    it 'must show default value' do
-      enter 'show linetrace_plus'
-      debug_file 'show'
-      check_output_includes 'line tracing style is different consecutive lines.'
-    end
-  end
 
-  describe 'listsize' do
-    it 'must show listsize' do
-      enter 'show listsize'
-      debug_file 'show'
-      check_output_includes 'Number of source lines to list is 10.'
-    end
-  end
+      describe "showing enabled boolean setting #{setting}" do
+        temporary_change_hash Byebug::Setting, setting, true
 
-  describe 'stack_on_error' do
-    it 'must show stack_on_error' do
-      enter 'show stack_on_error'
-      debug_file 'show'
-      check_output_includes 'Displaying stack trace is off.'
-    end
-  end
-
-  describe 'version' do
-    it 'must show version' do
-      enter 'show version'
-      debug_file 'show'
-      check_output_includes "Byebug #{Byebug::VERSION}"
-    end
-  end
-
-  describe 'width' do
-    let(:cols) { `stty size`.scan(/\d+/)[1].to_i }
-
-    it 'must show default width' do
-      enter 'show width'
-      debug_file 'show'
-      check_output_includes "Width is #{cols}."
-    end
-  end
-
-  describe 'unknown command' do
-    it 'must show a message' do
-      enter 'show bla'
-      debug_file 'show'
-      check_output_includes 'Unknown show command bla'
+        it 'must show default value' do
+          enter "show #{setting}"
+          debug_proc(@example)
+          check_output_includes "#{setting} is on"
+        end
+      end
     end
-  end
 
-  describe 'autosave' do
-    it 'must show default value' do
-      enter 'show autosave'
-      debug_file 'show'
-      check_output_includes 'Saving history is on.'
+    describe 'callstyle' do
+      it 'must show default value' do
+        enter 'show callstyle'
+        debug_proc(@example)
+        check_output_includes 'Frame display callstyle is :long'
+      end
     end
-  end
 
-  describe 'histfile' do
-    before { @filename = Byebug::History::DEFAULT_FILE }
-
-    it 'must show history filename' do
-      enter 'show histfile'
-      debug_file 'show'
-      check_output_includes "The command history file is \"#{@filename}\""
+    describe 'listsize' do
+      it 'must show listsize' do
+        enter 'show listsize'
+        debug_proc(@example)
+        check_output_includes 'Number of source lines to list is 10'
+      end
     end
-  end
 
-  describe 'histsize' do
-    before { @max_size = Byebug::History::DEFAULT_MAX_SIZE }
+    describe 'width' do
+      let(:cols) { `stty size`.scan(/\d+/)[1].to_i }
 
-    it "must show history's max size" do
-      enter 'show histsize'
-      debug_file 'show'
-      check_output_includes "Byebug history's maximum size is #{@max_size}"
+      it 'must show default width' do
+        enter 'show width'
+        debug_proc(@example)
+        check_output_includes "Maximum width of byebug's output is #{cols}"
+      end
     end
-  end
-
-  describe 'commands' do
-    temporary_change_const Readline, 'HISTORY', %w(aaa bbb ccc ddd)
 
-    describe 'with history disabled' do
-      temporary_change_hash Byebug.settings, :autosave, false
-
-      it 'must not show records from readline' do
-        enter 'show commands'
-        debug_file 'show'
-        check_output_includes "Not currently saving history. " \
-                              'Enable it with "set autosave"'
+    describe 'unknown command' do
+      it 'must show a message' do
+        enter 'show bla'
+        debug_proc(@example)
+        check_output_includes 'Unknown setting :bla'
       end
     end
 
-    describe 'with history enabled' do
-      temporary_change_hash Byebug.settings, :autosave, true
+    describe 'histfile' do
+      before { @filename = Byebug::Setting[:histfile] }
 
-      describe 'show records' do
-        it 'displays last max_size records from readline history' do
-          enter 'set histsize 3', 'show commands'
-          debug_file 'show'
-          check_output_includes(/2  bbb\n    3  ccc\n    4  ddd/)
-          check_output_doesnt_include(/1  aaa/)
-        end
+      it 'must show history filename' do
+        enter 'show histfile'
+        debug_proc(@example)
+        check_output_includes "The command history file is #{@filename}"
       end
+    end
 
-      describe 'max records' do
-        it 'displays whole history if max_size is bigger than Readline::HISTORY' do
-          enter 'set histsize 7', 'show commands'
-          debug_file 'show'
-          check_output_includes(/1  aaa\n    2  bbb\n    3  ccc\n    4  ddd/)
-        end
-      end
+    describe 'histsize' do
+      before { @max_size = Byebug::Setting[:histsize] }
 
-      describe 'with specified size' do
-        it 'displays the specified number of entries most recent first' do
-          enter 'show commands 2'
-          debug_file 'show'
-          check_output_includes(/3  ccc\n    4  ddd/)
-          check_output_doesnt_include(/1  aaa\n    2  bbb/)
-        end
+      it "must show history's max size" do
+        enter 'show histsize'
+        debug_proc(@example)
+        check_output_includes \
+          "Maximum size of byebug's command history is #{@max_size}"
       end
     end
-  end
 
-  describe 'Help' do
-    it 'must show help when typing just "show"' do
-      enter 'show', 'cont'
-      debug_file 'show'
-      check_output_includes(/List of "show" subcommands:/)
+    describe 'Help' do
+      it 'must show help when typing just "show"' do
+        enter 'show', 'cont'
+        debug_proc(@example)
+        check_output_includes(/Generic command for showing byebug settings./)
+        check_output_includes(/List of settings supported in byebug/)
+      end
     end
   end
 end

data/test/source_test.rb

@@ -1,39 +1,49 @@
-class TestSource < TestDsl::TestCase
-  let(:filename) { 'source_example.txt' }
+module SourceTest
+  class SourceTestCase < TestDsl::TestCase
+    let(:filename) { 'source_example.txt' }
 
-  before { File.open(filename, 'w') do |f|
-             f.puts 'break 2'
-             f.puts 'break 3 if true'
-           end }
+    before do
+      @example = -> do
+        byebug
+        a = 2
+        a = 3
+      end
 
-  after { FileUtils.rm(filename) }
+      File.open(filename, 'w') do |f|
+        f.puts 'break 2'
+        f.puts 'break 3 if true'
+      end
+    end
+
+    after { FileUtils.rm(filename) }
 
-  it 'must run commands from file' do
-    enter "source #{filename}"
-    debug_file 'source' do
-      Byebug.breakpoints[0].pos.must_equal 2
-      Byebug.breakpoints[1].pos.must_equal 3
-      Byebug.breakpoints[1].expr.must_equal 'true'
+    it 'must run commands from file' do
+      enter "source #{filename}"
+      debug_proc(@example) do
+        Byebug.breakpoints[0].pos.must_equal 2
+        Byebug.breakpoints[1].pos.must_equal 3
+        Byebug.breakpoints[1].expr.must_equal 'true'
+      end
     end
-  end
 
-  it 'must be able to use shortcut' do
-    enter "so #{filename}"
-    debug_file('source') { Byebug.breakpoints[0].pos.must_equal 2 }
-  end
+    it 'must be able to use shortcut' do
+      enter "so #{filename}"
+      debug_proc(@example) { Byebug.breakpoints[0].pos.must_equal 2 }
+    end
 
-  it 'must show an error if file is not found' do
-    enter 'source blabla'
-    debug_file 'source'
-    check_error_includes(/File ".*blabla" not found/)
-  end
+    it 'must show an error if file is not found' do
+      enter 'source blabla'
+      debug_proc(@example)
+      check_error_includes(/File ".*blabla" not found/)
+    end
 
-  describe 'Help' do
-    it 'must show help when used without arguments' do
-      enter 'source'
-      debug_file 'source'
-      check_output_includes \
-        "source FILE\texecutes a file containing byebug commands"
+    describe 'Help' do
+      it 'must show help when used without arguments' do
+        enter 'source'
+        debug_proc(@example)
+        check_output_includes \
+          "source FILE\texecutes a file containing byebug commands"
+      end
     end
   end
 end

data/test/stepping_test.rb

@@ -1,183 +1,210 @@
-class SteppingExample
-  def self.a(num)
-    num += 2
-    b(num)
-  end
-
-  def self.b(num)
-    v2 = 5 if 1 == num ; [1, 2, v2].map { |t| t.to_f }
-    c(num)
-  end
-
-  def self.c(num)
-    num += 4
-    num
-  end
-end
-
-class SteppingRaiseFromRubyMethodExample
-  def a
-    b
-  rescue
-    1
-  end
-
-  def b
-    c
-  end
-
-  def c
-    raise 'bang'
-  end
-end
-
-class SteppingRaiseFromCMethodExample
-  def a
-    b
-  rescue NameError
-    1
-  end
+module SteppingTest
+  class Example
+    def self.a(num)
+      num += 2
+      b(num)
+    end
 
-  def b
-    c
-  end
+    def self.b(num)
+      v2 = 5 if 1 == num ; [1, 2, v2].map { |t| t.to_f }
+      c(num)
+    end
 
-  def c
-    d
+    def self.c(num)
+      num += 4
+      num
+    end
   end
-end
-
-class TestStepping < TestDsl::TestCase
 
-  describe 'Next Command' do
+  class SteppingTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        byebug
 
-    describe 'method call behaviour' do
-      before { enter "break #{__FILE__}:8", 'cont' }
-
-      it 'must leave on the same line by default' do
-        enter 'next'
-        debug_file('stepping') { state.line.must_equal 8 }
-      end
-
-      it 'must go to the next line if forced by "plus" sign' do
-        enter 'next+'
-        debug_file('stepping') { state.line.must_equal 9 }
-      end
+        ex = Example.a(7)
+        2.times do
+          ex += 1
+        end
 
-      it 'must leave on the same line if forced by "minus" sign' do
-        enter 'next-'
-        debug_file('stepping') { state.line.must_equal 8 }
+        Example.b(ex)
       end
+    end
 
-      describe 'when forcestep is set' do
-        temporary_change_hash Byebug.settings, :forcestep, true
+    describe 'Next Command' do
+      describe 'method call behaviour' do
+        before { enter 'break 9', 'cont' }
 
-        it 'must go to the next line' do
+        it 'must leave on the same line by default' do
           enter 'next'
-          debug_file('stepping') { state.line.must_equal 9 }
+          debug_proc(@example) { state.line.must_equal 9 }
         end
 
-        it 'must go to the next line (by shortcut)' do
-          enter 'n'
-          debug_file('stepping') { state.line.must_equal 9 }
+        it 'must go to the next line if forced by "plus" sign' do
+          enter 'next+'
+          debug_proc(@example) { state.line.must_equal 10 }
         end
 
-        it 'must go the specified number of lines forward by default' do
-          enter 'next 2'
-          debug_file('stepping') { state.line.must_equal 4 }
+        it 'must leave on the same line if forced by "minus" sign' do
+          enter 'next-'
+          debug_proc(@example) { state.line.must_equal 9 }
         end
 
-        it 'must inform when not staying in the same frame' do
-          enter 'next 2'
-          debug_file('stepping')
-          check_output_includes \
-            'Next went up a frame because previous frame finished'
-        end
+        describe 'when forcestep is set' do
+          temporary_change_hash Byebug::Setting, :forcestep, true
 
+          it 'must go to the next line' do
+            enter 'next'
+            debug_proc(@example) { state.line.must_equal 10 }
+          end
 
-        it 'must ignore it if "minus" is specified' do
-          enter 'next-'
-          debug_file('stepping') { state.line.must_equal 8 }
-        end
-      end
-    end
+          it 'must go to the next line (by shortcut)' do
+            enter 'n'
+            debug_proc(@example) { state.line.must_equal 10 }
+          end
 
-    describe 'block behaviour' do
-      before { enter 'break 4', 'cont' }
+          it 'must go the specified number of lines forward by default' do
+            enter 'next 2'
+            debug_proc(@example) { state.line.must_equal 25 }
+          end
 
-      it 'must step over blocks' do
-        enter 'next'
-        debug_file('stepping') { state.line.must_equal 8 }
-      end
-    end
+          it 'must inform when not staying in the same frame' do
+            enter 'next 2'
+            debug_proc(@example)
+            check_output_includes \
+              'Next went up a frame because previous frame finished'
+          end
 
-    describe 'raise/rescue behaviour' do
-      describe 'from c method' do
-        before { enter "break #{__FILE__}:36", 'cont' }
 
-        it 'must step over rescue' do
-          enter 'next'
-          debug_file('stepping_raise_from_c_method') { state.line.must_equal 38 }
+          it 'must ignore it if "minus" is specified' do
+            enter 'next-'
+            debug_proc(@example) { state.line.must_equal 9 }
+          end
         end
       end
 
-      describe 'from ruby method' do
-        before { enter "break #{__FILE__}:20", 'cont' }
+      describe 'block behaviour' do
+        before { enter 'break 57', 'cont' }
 
-        it 'must step over rescue' do
+        it 'must step over blocks' do
           enter 'next'
-          debug_file('stepping_raise_from_ruby_method') { state.line.must_equal 22 }
+          debug_proc(@example) { state.line.must_equal 24 }
         end
       end
-    end
-  end
-
-  describe 'Step Command' do
-
-    describe 'method call behaviour' do
-      before { enter "break #{__FILE__}:8", 'cont' }
 
-      it 'must leave on the same line if forced by a setting' do
-        enter 'step'
-        debug_file('stepping') { state.line.must_equal 8 }
-      end
+      describe 'raise/rescue behaviour' do
+        describe 'from c method' do
+          before do
+            @example_raise = -> do
+              byebug
+
+              class RaiseFromCMethodExample
+                def a
+                  b
+                rescue NameError
+                  1
+                end
+
+                def b
+                  c
+                end
+
+                def c
+                  d
+                end
+              end
+
+              RaiseFromCMethodExample.new.a
+            end
+            enter 'break 102', 'cont'
+          end
+
+          it 'must step over rescue' do
+            enter 'next'
+            debug_proc(@example_raise) { state.line.must_equal 104 }
+          end
+        end
 
-      it 'must go to the step line if forced to do that by "plus" sign' do
-        enter 'step+'
-        debug_file('stepping') { state.line.must_equal 9 }
+        describe 'from ruby method' do
+          before do
+            @example_raise = -> do
+              byebug
+
+              class RaiseFromRubyMethodExample
+                def a
+                  b
+                rescue
+                  1
+                end
+
+                def b
+                  c
+                end
+
+                def c
+                  raise 'bang'
+                end
+              end
+
+              RaiseFromRubyMethodExample.new.a
+            end
+            enter 'break 134', 'cont'
+          end
+
+          it 'must step over rescue' do
+            enter 'next'
+            debug_proc(@example_raise) { state.line.must_equal 136 }
+          end
+        end
       end
+    end
 
-      it 'must leave on the same line if forced to do that by "minus" sign' do
-        enter 'step-'
-        debug_file('stepping') { state.line.must_equal 8 }
-      end
+    describe 'Step Command' do
 
-      describe 'when forcestep is set' do
-        temporary_change_hash Byebug.settings, :forcestep, true
+      describe 'method call behaviour' do
+        before { enter 'break 9', 'cont' }
 
-        it 'must go to the step line if forced by a setting' do
+        it 'must leave on the same line if forced by a setting' do
           enter 'step'
-          debug_file('stepping') { state.line.must_equal 9 }
+          debug_proc(@example) { state.line.must_equal 9 }
         end
 
-        it 'must go to the next line if forced by a setting (by shortcut)' do
-          enter 's'
-          debug_file('stepping') { state.line.must_equal 9 }
+        it 'must go to the step line if forced to do that by "plus" sign' do
+          enter 'step+'
+          debug_proc(@example) { state.line.must_equal 10 }
         end
 
-        it 'must go the specified number of lines forward by default' do
-          enter 'step 2'
-          debug_file('stepping') { state.line.must_equal 13 }
+        it 'must leave on the same line if forced to do that by "minus" sign' do
+          enter 'step-'
+          debug_proc(@example) { state.line.must_equal 9 }
+        end
+
+        describe 'when forcestep is set' do
+          temporary_change_hash Byebug::Setting, :forcestep, true
+
+          it 'must go to the step line if forced by a setting' do
+            enter 'step'
+            debug_proc(@example) { state.line.must_equal 10 }
+          end
+
+          it 'must go to the next line if forced by a setting (by shortcut)' do
+            enter 's'
+            debug_proc(@example) { state.line.must_equal 10 }
+          end
+
+          it 'must go the specified number of lines forward by default' do
+            enter 'step 2'
+            debug_proc(@example) { state.line.must_equal 14 }
+          end
         end
       end
-    end
 
-    describe 'block behaviour' do
-      before { enter 'break 4', 'cont' }
+      describe 'block behaviour' do
+        before { enter 'break 25', 'cont' }
 
-      it 'must step into blocks' do
-        enter 'step'
-        debug_file('stepping') { state.line.must_equal 5 }
+        it 'must step into blocks' do
+          enter 'step'
+          debug_proc(@example) { state.line.must_equal 26 }
+        end
       end
     end
   end