byebug 3.0.0 → 3.1.0

data/test/help_test.rb

@@ -1,50 +1,59 @@
-class TestHelp < TestDsl::TestCase
-  include Columnize
+module HelpTest
+  class HelpTestCase < TestDsl::TestCase
+    include Columnize
 
-  let(:available_commands) {
-    Byebug::Command.commands.map(&:names).flatten.uniq.sort }
-
-  describe 'when typed alone' do
-    temporary_change_hash Byebug.settings, :width, 50
-
-    it 'must show self help when typed alone' do
-      enter 'help'
-      debug_file 'help'
-      check_output_includes \
-        'Type "help <command-name>" for help on a specific command',
-        'Available commands:', columnize(available_commands, 50)
+    before do
+      @example = -> do
+        byebug
+      end
     end
 
-    it 'must work when shortcut used' do
-      enter 'h'
-      debug_file 'help'
-      check_output_includes \
-        'Type "help <command-name>" for help on a specific command'
+    let(:available_cmds) do
+      Byebug::Command.commands.map(&:names).flatten.uniq.sort
     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_file 'help'
-      check_error_includes 'Undefined command: "foobar". Try "help".'
+    describe 'when typed alone' do
+      temporary_change_hash Byebug::Setting, :width, 50
+
+      it 'must show self help when typed alone' do
+        enter 'help'
+        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
 
-    it "must show a command's help" do
-      enter 'help break'
-      debug_file 'help'
-      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"
+    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
+
+      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
     end
-  end
 
-  describe 'when typed with command and subcommand' do
-    it "must show subcommand's help" do
-      enter 'help info breakpoints'
-      debug_file 'help'
-      check_output_includes "Status of user-settable breakpoints.\n"
+    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
     end
   end
 end

data/test/history_test.rb

@@ -0,0 +1,54 @@
+module HistoryTest
+  class HistoryTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        byebug
+      end
+    end
+
+    describe 'history command' do
+      temporary_change_const Readline, 'HISTORY', %w(aaa bbb ccc ddd)
+
+      describe 'with autosave disabled' do
+        temporary_change_hash Byebug::Setting, :autosave, false
+
+        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
+
+      describe 'with autosave enabled' do
+        temporary_change_hash Byebug::Setting, :autosave, true
+
+        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
+
+        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
+
+        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
+    end
+  end
+end

data/test/info_test.rb

@@ -1,307 +1,320 @@
-class InfoExample
-  def initialize
-    @foo = "bar"
-    @bla = "blabla"
-  end
-
-  def a(y, z)
-    w = "1" * 30
-    x = 2
-    w + x.to_s + y + z + @foo
-  end
-
-  def c
-    a = BasicObject.new
-    a
-  end
-
-  def b
-    a('a', 'b')
-    e = "%.2f"
-    e
-  end
-
-  def d
-    raise "bang"
-  rescue
-  end
-end
-
-class TestInfo < TestDsl::TestCase
-  include Columnize
-
-  describe 'Args info' do
-    it 'must show info about all args' do
-      enter "break #{__FILE__}:10", 'cont', 'info args'
-      debug_file 'info'
-      check_output_includes 'y = "a"', 'z = "b"'
-    end
-  end
-
-  describe 'Breakpoints info' do
-    it 'must show info about all breakpoints' do
-      enter 'break 4', 'break 5 if y == z', 'info breakpoints'
-      debug_file 'info'
-      check_output_includes 'Num Enb What',
-                            /\d+ +y   at #{fullpath('info')}:4/,
-                            /\d+ +y   at #{fullpath('info')}:5 if y == z/
-    end
-
-    it 'must show info about specific breakpoint' do
-      enter 'break 4', 'break 5',
-            ->{ "info breakpoints #{Byebug.breakpoints.first.id}" }
-      debug_file 'info'
-      check_output_includes 'Num Enb What', /\d+ +y   at #{fullpath('info')}:4/
-      check_output_doesnt_include(/\d+ +y   at #{fullpath('info')}:5/)
-    end
-
-    it 'must show an error if no breakpoints are found' do
-      enter 'info breakpoints'
-      debug_file 'info'
-      check_output_includes 'No breakpoints.'
-    end
-
-    it 'must show an error if no breakpoints are found' do
-      enter 'break 4', 'info breakpoints 123'
-      debug_file 'info'
-      check_error_includes 'No breakpoints found among list given.'
-    end
-
-    it 'must show hit count' do
-      enter 'break 5', 'cont', 'info breakpoints'
-      debug_file 'info'
-      check_output_includes(
-        /\d+ +y   at #{fullpath('info')}:5/, 'breakpoint already hit 1 time')
-    end
-  end
-
-  describe 'Display info' do
-    it 'must show all display expressions' do
-      enter 'display 3 + 3', 'display a + b', 'info display'
-      debug_file 'info'
-      check_output_includes "Auto-display expressions now in effect:\n" \
-                            'Num Enb Expression',
-                            '1: y  3 + 3',
-                            '2: y  a + b'
-    end
-
-    it 'must show a message if there are no display expressions created' do
-      enter 'info display'
-      debug_file 'info'
-      check_output_includes 'There are no auto-display expressions now.'
-    end
-  end
-
-  describe 'Files info' do
-    let(:files) { SCRIPT_LINES__.keys.uniq.sort }
-
-    it 'must show all files read in' do
-      enter 'info files'
-      debug_file 'info'
-      check_output_includes files.map { |f| "File #{f}" }
-    end
-
-    it 'must show all files read in using "info file" too' do
-      enter 'info file'
-      debug_file 'info'
-      check_output_includes files.map { |f| "File #{f}" }
-    end
-
-    it 'must show explicitly loaded files' do
-      enter 'info files stat'
-      debug_file 'info'
-      check_output_includes "File #{fullpath('info')}",
-                            LineCache.stat(fullpath('info')).mtime.to_s
-    end
-  end
-
-  describe 'File info' do
-    let(:file)     { fullpath('info') }
-    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.settings[:width]) }
-
-    it 'must show basic info about the file' do
-      enter "info file #{file} basic"
-      debug_file 'info'
-      check_output_includes filename, lines
-      check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
-    end
-
-    it 'must show number of lines' do
-      enter "info file #{file} lines"
-      debug_file 'info'
-      check_output_includes filename, lines
-      check_output_doesnt_include breakpoint_line_numbers, mtime, sha1
+module InfoTest
+  class Example
+    def initialize
+      @foo = 'bar'
+      @bla = 'blabla'
     end
 
-    it 'must show mtime of the file' do
-      enter "info file #{file} mtime"
-      debug_file 'info'
-      check_output_includes filename, mtime
-      check_output_doesnt_include lines, breakpoint_line_numbers, sha1
+    def a(y, z)
+      w = '1' * 30
+      x = 2
+      w + x.to_s + y + z + @foo
     end
 
-    it 'must show sha1 of the file' do
-      enter "info file #{file} sha1"
-      debug_file 'info'
-      check_output_includes filename, sha1
-      check_output_doesnt_include lines, breakpoint_line_numbers, mtime
-    end
-
-    it 'must show breakpoints in the file' do
-      enter 'break 4', 'break 5', "info file #{file} breakpoints"
-      debug_file 'info'
-      check_output_includes(/Created breakpoint \d+ at #{file}:4/,
-                            /Created breakpoint \d+ at #{file}:5/,
-                            filename,
-                            'breakpoint line numbers:', breakpoint_line_numbers)
-      check_output_doesnt_include lines, mtime, sha1
-    end
-
-    it 'must show all info about the file' do
-      enter "info file #{file} all"
-      debug_file 'info'
-      check_output_includes \
-        filename, lines, breakpoint_line_numbers, mtime, sha1
-    end
-
-    it 'must not show any info if the parameter is invalid' do
-      enter "info file #{file} blabla"
-      debug_file 'info'
-      check_error_includes 'Invalid parameter blabla'
-    end
-  end
-
-  describe 'Instance variables info' do
-    it 'must show instance variables' do
-      enter "break #{__FILE__}:10", 'cont', 'info instance_variables'
-      debug_file 'info'
-      check_output_includes '@bla = "blabla"', '@foo = "bar"'
-    end
-  end
-
-  describe 'Line info' do
-    it 'must show the current line' do
-      enter "break #{__FILE__}:10", 'cont', 'info line'
-      debug_file 'info'
-      check_output_includes "Line 10 of \"#{__FILE__}\""
-    end
-  end
-
-  describe 'Locals info' do
-    temporary_change_hash Byebug.settings, :width, 28
-
-    it 'must show the current local variables' do
-      enter "break #{__FILE__}:10", 'cont', 'info locals'
-      debug_file 'info'
-      check_output_includes 'w = "11111111111111111111...', 'x = 2'
-    end
-
-    it 'must fail if local variable doesn\'t respond to #to_s or to #inspect' do
-      enter "break #{__FILE__}:15", 'cont', 'info locals'
-      debug_file 'info'
-      check_output_includes 'a = *Error in evaluation*'
-    end
-  end
-
-  describe 'Program info' do
-    it 'must show the initial stop reason' do
-      enter 'info program'
-      debug_file 'info'
-      check_output_includes \
-        'It stopped after stepping, next\'ing or initial start.'
-    end
-
-    it 'must show the step stop reason' do
-      enter 'step', 'info program'
-      debug_file 'info'
-      check_output_includes \
-        'Program stopped.',
-        'It stopped after stepping, next\'ing or initial start.'
-    end
-
-    it 'must show the breakpoint stop reason' do
-      enter 'break 4', 'cont', 'info program'
-      debug_file 'info'
-      check_output_includes 'Program stopped.', 'It stopped at a breakpoint.'
-    end
-
-    it 'must show the catchpoint stop reason' do
-      enter 'catch Exception', 'cont', 'info program'
-      debug_file 'info'
-      check_output_includes 'Program stopped.', 'It stopped at a catchpoint.'
-    end
-
-    it 'must show the unknown stop reason' do
-      enter 'break 5', 'cont',
-             ->{ context.stubs(:stop_reason).returns('blabla'); 'info program' }
-      debug_file 'info'
-      check_output_includes 'Program stopped.', 'unknown reason: blabla'
-    end
-
-    it 'must show an error if the program is crashed' do
-      skip('TODO')
-    end
-  end
-
-  describe 'Stack info' do
-    it 'must show stack info' do
-      enter 'set fullpath', "break #{__FILE__}:8", 'cont', 'info stack'
-      debug_file 'info'
-      check_output_includes(
-        /--> #0  InfoExample.a\(y\#String, z\#String\)\s+at #{__FILE__}:8/,
-            /#1  InfoExample.b\s+at #{__FILE__}:19/,
-            /#2  <top \(required\)>\s+at #{fullpath('info')}:4/)
-    end
-  end
-
-  describe 'Global Variables info' do
-    it 'must show global variables' do
-      enter 'info global_variables'
-      debug_file 'info'
-      check_output_includes "$$ = #{Process.pid}"
-    end
-  end
-
-  describe 'Variables info' do
-    temporary_change_hash Byebug.settings, :width, 30
-
-    it 'must show all variables' do
-      enter "break #{__FILE__}:10", 'cont', 'info variables'
-      debug_file 'info'
-      check_output_includes(/self = #<InfoExample:\S+.../,
-                            'w = "1111111111111111111111...',
-                            'x = 2',
-                            '@bla = "blabla"',
-                            '@foo = "bar"')
+    def c
+      a = BasicObject.new
+      a
     end
 
-    it 'must fail if the variable doesn\'t respond to #to_s or to #inspect' do
-      enter "break #{__FILE__}:15", 'cont', 'info variables'
-      debug_file 'info'
-      check_output_includes 'a = *Error in evaluation*',
-                            /self = #<InfoExample:\S+.../,
-                            '@bla = "blabla"',
-                            '@foo = "bar"'
+    def b
+      a('a', 'b')
+      e = "%.2f"
+      e
     end
 
-    it 'must correctly print variables containing % sign' do
-      enter "break #{__FILE__}:21", 'cont', 'info variables'
-      debug_file 'info'
-      check_output_includes 'e = "%.2f"'
+    def d
+      raise 'bang'
+    rescue
     end
   end
 
-  describe 'Help' do
-    it 'must show help when typing just "info"' do
-      enter 'info', 'cont'
-      debug_file 'info'
-      check_output_includes(/List of "info" subcommands:/)
+  class InfoTestCase < TestDsl::TestCase
+    include Columnize
+
+    before do
+      @example = -> do
+        byebug
+        i = Example.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
+    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
+
+      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
+
+      it 'must show an error if no breakpoints are found' do
+        enter 'info breakpoints'
+        debug_proc(@example)
+        check_output_includes 'No breakpoints.'
+      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
+
+      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
+    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
+
+      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
+    end
+
+    describe 'Files info' do
+      let(:files) { SCRIPT_LINES__.keys.uniq.sort }
+
+      it 'must show all files read in' do
+        enter 'info files'
+        debug_proc(@example)
+        check_output_includes files.map { |f| "File #{f}" }
+      end
+
+      it 'must show all files read in using "info file" too' do
+        enter 'info file'
+        debug_proc(@example)
+        check_output_includes files.map { |f| "File #{f}" }
+      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
+    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]) }
+
+      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
+
+      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
+
+      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
+
+      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
+
+      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
+
+      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
+
+      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
+    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
+    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
+    end
+
+    describe 'Locals info' do
+      temporary_change_hash Byebug::Setting, :width, 28
+
+      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
+
+      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
+    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
+
+      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
+
+      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
+
+      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
+
+      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
+
+      it 'must show an error if the program is crashed' do
+        skip('TODO')
+      end
+    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
+    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
+    end
+
+    describe 'Variables info' do
+      temporary_change_hash Byebug::Setting, :width, 30
+
+      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
+
+      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
+
+      it 'must correctly print variables containing % sign' do
+        enter 'break 22', 'cont', 'info variables'
+        debug_proc(@example)
+        check_output_includes 'e = "%.2f"'
+      end
+    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
     end
   end
 end