byebug 1.1.1 → 1.2.0

data/old_doc/hanoi.rb

@@ -1,5 +1,4 @@
-#!/usr/bin/ruby
-
+# Solves the classic Towers of Hanoi puzzle.
 def hanoi(n,a,b,c)
   if n-1 > 0
     hanoi(n-1, a, c, b)
@@ -21,7 +20,7 @@ n=3
 if i_args > 0
   begin
     n = ARGV[0].to_i
-  rescue ValueError, msg:
+  rescue ValueError, :msg
       print "** Expecting an integer, got: %s" % ARGV[0].to_s
     exit 2
   end

data/old_doc/triangle.rb

@@ -1,12 +1,11 @@
-#!/usr/bin/env ruby
-# Compute the n'th triangle number - the hard way
-# triangle(n) == (n * (n+1)) / 2
+# Compute the n'th triangle number, the hard way: triangle(n) == (n*(n+1))/2
 def triangle(n)
   tri = 0
   0.upto(n) do |i|
     tri += i
   end
-  return tri
- end
- 
-puts triangle(3)
+  tri
+end
+
+t = triangle(3)
+puts t

data/test/breakpoints_test.rb

@@ -77,47 +77,57 @@ describe 'Breakpoints' do
     end
 
     describe 'show a message' do
-      it 'must show a message with full filename' do
-        enter 'break 14', 'cont'
-        debug_file('breakpoint1') { @id = Byebug.breakpoints.first.id }
-        check_output_includes \
-          "Created breakpoint #{@id} at #{fullpath('breakpoint1')}:14"
+      describe 'with full filename' do
+        temporary_change_hash Byebug::Command.settings, :basename, false
+
+        it 'must show a message with full filename' do
+          enter 'break 14', 'cont'
+          debug_file('breakpoint1') { @id = Byebug.breakpoints.first.id }
+          check_output_includes \
+            "Created breakpoint #{@id} at #{fullpath('breakpoint1')}:14"
+        end
       end
 
-      it 'must show a message with basename' do
-        enter 'set basename', 'break 14', 'cont'
-        debug_file('breakpoint1') { @id = Byebug.breakpoints.first.id }
-        check_output_includes "Created breakpoint #{@id} at breakpoint1.rb:14"
+      describe 'with basename' do
+        temporary_change_hash Byebug::Command.settings, :basename, true
+
+        it 'must show a message with basename' do
+          enter 'break 14', 'cont'
+          debug_file('breakpoint1') { @id = Byebug.breakpoints.first.id }
+          check_output_includes "Created breakpoint #{@id} at breakpoint1.rb:14"
+        end
       end
     end
   end
 
   describe 'reloading source on change' do
-    it 'must not reload source if autoreload is not set' do
-      id = nil
-      enter \
-        'set noautoreload',
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, ''); 'break 14'},
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, 'c = a + b');
+    describe 'autoreload not set' do
+      temporary_change_hash Byebug::Command.settings, :autoreload, false
+
+      it 'must not reload source' do
+        id = nil
+        enter \
+          ->{change_line_in_file(fullpath('breakpoint1'), 14, ''); 'break 14'},
+          ->{change_line_in_file(fullpath('breakpoint1'), 14, 'c = a + b');
           'cont'}
-      debug_file('breakpoint1') { id = Byebug.breakpoints.first.id }
-      check_output_includes \
-        "Created breakpoint #{id} at #{fullpath('breakpoint1')}:14"
-    end
-
-    it 'must reload source if autoreload is set' do
-      enter \
-        'set autoreload',
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, ''); 'break 14'},
-        # Setting second breakpoint just to reload the source code after rolling
-        # the file changes back
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, 'c = a + b');
-          'break 15'},
-        'cont'
-      debug_file 'breakpoint1'
-      check_output_includes \
-        "Line 14 is not a stopping point in file #{fullpath('breakpoint1')}",
-        interface.error_queue
+        debug_file('breakpoint1') { id = Byebug.breakpoints.first.id }
+        check_output_includes \
+          "Created breakpoint #{id} at #{fullpath('breakpoint1')}:14"
+      end
+    end
+
+    describe 'autoreload set' do
+      it 'must reload source' do
+        enter \
+          ->{change_line_in_file(fullpath('breakpoint1'), 14, ''); 'break 14'},
+          # 2nd breakpoint just to reload source code after rolling changes back
+          ->{change_line_in_file(fullpath('breakpoint1'), 14, 'c = a + b');
+            'break 15'}, 'cont'
+        debug_file 'breakpoint1'
+        check_output_includes \
+          "Line 14 is not a stopping point in file #{fullpath('breakpoint1')}",
+          interface.error_queue
+      end
     end
   end
 

data/test/display_test.rb

@@ -136,7 +136,7 @@ describe 'Display Command' do
   end
 
   describe 'Post Mortem' do
-    before { Byebug::Command.settings[:autoeval] = false }
+    temporary_change_hash Byebug::Command.settings, :autoeval, false
 
     it 'must be able to set display expressions in post-mortem mode' do
       enter 'cont', 'display 2 + 2'

data/test/edit_test.rb

@@ -3,8 +3,10 @@ require_relative 'test_helper'
 describe 'Edit Command' do
   include TestDsl
 
-  it 'must open an editor with current file and line' do
-    temporary_change_hash_value(ENV, 'EDITOR', 'editr') do
+  describe 'open configured editor' do
+    temporary_change_hash ENV, 'EDITOR', 'editr'
+
+    it 'must open current file in current line in configured editor' do
       Byebug::Edit.any_instance.expects(:system).
                                 with("editr +2 #{fullpath('edit')}")
       enter 'edit'
@@ -12,8 +14,10 @@ describe 'Edit Command' do
     end
   end
 
-  it 'must open a default editor with current file and line' do
-    temporary_change_hash_value(ENV, 'EDITOR', nil) do
+  describe 'open default editor' do
+    temporary_change_hash ENV, 'EDITOR', nil
+
+    it 'must call "ex" with current line and file if EDITOR env not set' do
       Byebug::Edit.any_instance.expects(:system).
                                 with("ex +2 #{fullpath('edit')}")
       enter 'edit'
@@ -21,11 +25,13 @@ describe 'Edit Command' do
     end
   end
 
-  it 'must open an editor with specified file and line' do
-    temporary_change_hash_value(ENV, 'EDITOR', 'editr') do
+  describe 'open configured editor specifying line and file' do
+    temporary_change_hash ENV, 'EDITOR', 'editr'
+
+    it 'must open specified line in specified file with configured editor' do
       Byebug::Edit.any_instance.expects(:system).
-                                with("editr +3 #{fullpath('edit2')}")
-      enter "edit #{fullpath('edit2')}:3"
+                                with("editr +3 #{fullpath('breakpoint1')}")
+      enter "edit #{fullpath('breakpoint1')}:3"
       debug_file 'edit'
     end
   end
@@ -44,15 +50,14 @@ describe 'Edit Command' do
       'Invalid file/line number specification: blabla', interface.error_queue
   end
 
-
   describe 'Post Mortem' do
+    temporary_change_hash ENV, 'EDITOR', 'editr'
+
     it 'must work in post-mortem mode' do
-      temporary_change_hash_value(ENV, 'EDITOR', 'editr') do
-        Byebug::Edit.any_instance.expects(:system).
-                                  with("editr +2 #{fullpath('edit')}")
-        enter 'cont', "edit #{fullpath('edit')}:2", 'cont'
-        debug_file 'post_mortem'
-      end
+      Byebug::Edit.any_instance.expects(:system).
+                                with("editr +2 #{fullpath('edit')}")
+      enter 'cont', "edit #{fullpath('edit')}:2", 'cont'
+      debug_file 'post_mortem'
     end
   end
 

data/test/eval_test.rb

@@ -38,51 +38,57 @@ describe 'Eval Command' do
   end
 
   describe 'stack trace on error' do
-    it 'must show a stack trace if showing trace on error is enabled' do
-      enter 'set notrace', '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/
+    describe 'when enabled' do
+      temporary_change_hash Byebug::Command.settings, :stack_trace_on_error, true
+
+      it 'must show a stack trace' do
+        enter 'eval 2 / 0'
+        debug_file 'eval'
+        check_output_includes /\S+:\d+:in `eval':divided by 0/
+        check_output_doesnt_include 'ZeroDivisionError Exception: divided by 0'
+      end
     end
 
-    it 'must show a stack trace if showing trace on error is enabled' do
-      enter 'set trace', 'eval 2 / 0'
-      debug_file 'eval'
-      check_output_includes /\S+:\d+:in `eval':divided by 0/
-      check_output_doesnt_include 'ZeroDivisionError Exception: divided by 0'
+    describe 'when disabled' do
+      temporary_change_hash Byebug::Command.settings, :stack_trace_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/
+      end
     end
   end
 
-  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_file 'eval'
+      check_output_includes "{:a=>\"#{'3' * 40}\",\n :b=>\"#{'4' * 30}\"}"
+    end
   end
 
-  it 'must print expression and columnize the result' do
-    temporary_change_hash_value(Byebug::PutLCommand.settings, :width, 20) do
+  describe 'putl' do
+    temporary_change_hash Byebug::Command.settings, :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"
     end
   end
 
-  it 'must print expression and sort and columnize the result' do
-    temporary_change_hash_value(Byebug::PSCommand.settings, :width, 20) do
+  describe 'ps' do
+    temporary_change_hash Byebug::Command.settings, :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"
     end
   end
 
-  it 'must set width by the "set" command' do
-    temporary_change_hash_value(Byebug::PSCommand.settings, :width, 20) do
-      enter 'set width 10', 'ps [1, 2, 3, 4, 5, 9, 8, 7, 6]'
-      debug_file 'eval'
-      check_output_includes "1  4  7\n2  5  8\n3  6  9"
-    end
-  end
-
   describe 'Post Mortem' do
     it 'must work in post-mortem mode' do
       enter 'cont', 'eval 2 + 2'

data/test/examples/list.rb

@@ -9,4 +9,15 @@ byebug
 9
 10
 11
-12
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23

data/test/frame_test.rb

@@ -3,10 +3,9 @@ require_relative 'test_helper'
 describe 'Frame Command' do
   include TestDsl
 
-  def after_setup
-    Byebug::Command.settings[:width] =
-      "--> #0  A.d(e#String) at #{fullpath('frame')}:16".size
-  end
+  # XXX: Calculate magic number dinamically, like
+  # "longest_string_in_test_output".size
+  temporary_change_hash Byebug::Command.settings, :width, 96
 
   it 'must go up' do
     enter 'break 16', 'cont', 'up'
@@ -40,7 +39,8 @@ describe 'Frame Command' do
 
   it 'must print current stack frame when without arguments' do
     enter 'break A.d', 'cont', 'up', 'frame'
-    debug_file('frame') { check_output_includes "#0  A.d(e#String) at #{fullpath('frame')}:15" }
+    debug_file('frame') {
+      check_output_includes "#0  A.d(e#String) at #{fullpath('frame')}:15" }
   end
 
   it 'must set frame to the first one' do
@@ -70,64 +70,77 @@ describe 'Frame Command' do
       interface.error_queue
   end
 
-  describe 'full path settings' do
+  describe 'fullpath' do
     def short_path(fullpath)
       separator = File::ALT_SEPARATOR || File::SEPARATOR
       "...#{separator}" + fullpath.split(separator)[-3..-1].join(separator)
     end
 
-    before do
-      Byebug::Command.settings[:callstyle] = :last
-    end
+    describe 'when set' do
+      temporary_change_hash Byebug::Command.settings, :frame_fullpath, true
 
-    it 'must display current backtrace with full path = true' do
-      enter 'set fullpath', 'break 16', 'cont', 'where'
-      debug_file 'frame'
-      check_output_includes "--> #0  A.d(e#String) at #{fullpath('frame')}:16",
-                            "    #1  A.c at #{fullpath('frame')}:12"
+      it 'must display current backtrace with fullpaths' do
+        enter 'break 16', 'cont', 'where'
+        debug_file 'frame'
+        check_output_includes \
+          "--> #0  A.d(e#String) at #{fullpath('frame')}:16",
+          "    #1  A.c at #{fullpath('frame')}:12"
+      end
     end
 
-    it 'must display current backtrace with full path = false' do
-      enter 'set nofullpath', 'break 16', 'cont', 'where'
-      debug_file 'frame'
-      check_output_includes \
-        "--> #0  A.d(e#String) at #{short_path(fullpath('frame'))}:16",
-        "    #1  A.c at #{short_path(fullpath('frame'))}:12"
+    describe 'when unset' do
+      temporary_change_hash Byebug::Command.settings, :frame_fullpath, false
+
+      it 'must display current backtrace with shortpaths' do
+        enter 'set nofullpath', 'break 16', 'cont', 'where'
+        debug_file 'frame'
+        check_output_includes \
+          "--> #0  A.d(e#String) at #{short_path(fullpath('frame'))}:16",
+          "    #1  A.c at #{short_path(fullpath('frame'))}:12"
+      end
     end
   end
 
-  describe 'callstyles' do
-    it 'displays current backtrace with callstyle "last"' do
-      enter 'set callstyle last', 'break 16', 'cont', 'where'
-      debug_file 'frame'
-      check_output_includes "--> #0  A.d(e#String) at #{fullpath('frame')}:16",
-                            "    #1  A.c at #{fullpath('frame')}:12"          ,
-                            "    #2  A.b at #{fullpath('frame')}:8"           ,
-                            "    #3  A.a at #{fullpath('frame')}:5"
+  describe 'callstyle' do
+    describe 'last' do
+      temporary_change_hash Byebug::Command.settings, :callstyle, :last
+
+      it 'displays current backtrace with callstyle "last"' do
+        enter 'break 16', 'cont', 'where'
+        debug_file 'frame'
+        check_output_includes \
+          "--> #0  A.d(e#String) at #{fullpath('frame')}:16",
+          "    #1  A.c at #{fullpath('frame')}:12"          ,
+          "    #2  A.b at #{fullpath('frame')}:8"           ,
+          "    #3  A.a at #{fullpath('frame')}:5"
+      end
     end
 
-    it 'displays current backtrace with callstyle "short"' do
-      enter 'set callstyle short', 'break 16', 'cont', 'where'
-      debug_file 'frame'
-      check_output_includes "--> #0  d(e) at #{fullpath('frame')}:16",
-                            "    #1  c at #{fullpath('frame')}:12"   ,
-                            "    #2  b at #{fullpath('frame')}:8"    ,
-                            "    #3  a at #{fullpath('frame')}:5"
+    describe 'short' do
+      temporary_change_hash Byebug::Command.settings, :callstyle, :short
+
+      it 'displays current backtrace with callstyle "short"' do
+          enter 'break 16', 'cont', 'where'
+          debug_file 'frame'
+          check_output_includes "--> #0  d(e) at #{fullpath('frame')}:16",
+                                "    #1  c at #{fullpath('frame')}:12"   ,
+                                "    #2  b at #{fullpath('frame')}:8"    ,
+                                "    #3  a at #{fullpath('frame')}:5"
+      end
     end
 
-    it 'displays current backtrace with callstyle "tracked"' do
-      skip('XXX: Style supported but not working....')
-      enter 'set callstyle tracked'
-      debug_file 'frame'
-      check_output_includes \
-        'Invalid call style tracked. Should be one of: "last".'
-      Byebug::Command.settings[:callstyle].must_equal :last
+    describe 'tracked' do
+      temporary_change_hash Byebug::Command.settings, :callstyle, :tracked
+
+      it 'displays current backtrace with callstyle "tracked"' do
+        skip 'XXX: Style supported but not working....'
+        debug_file 'frame'
+      end
     end
   end
 
   describe 'Post Mortem' do
     it 'must work in post-mortem mode' do
-      #skip 'TODO: This test fails with \'Segmentation fault\'.'
       enter 'cont', 'frame'
       debug_file('post_mortem') { state.line.must_equal 8 }
     end

data/test/help_test.rb

@@ -5,15 +5,18 @@ describe 'Help Command' do
   include Columnize
 
   let(:available_commands) {
-    Byebug::Command.commands.select(&:event).map(&:names).flatten.uniq.sort
-  }
+    Byebug::Command.commands.select(&:event).map(&:names).flatten.uniq.sort }
 
-  it '"help" alone must show how to use "help"' do
-    enter 'set width 50', 'help'
-    debug_file 'help'
-    check_output_includes \
-      'Type "help <command-name>" for help on a specific command',
-      'Available commands:', columnize(available_commands, 50)
+  describe 'when typed alone' do
+    temporary_change_hash Byebug::Command.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)
+    end
   end
 
   it 'must work when shortcut used' do