byebug 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb2fb8a1795fb10ac0b9a08f34c9384590f2ed68
-  data.tar.gz: ddcc06fdb4be593c69905dc4a0277ea5bf2d945e
+  metadata.gz: 16eb83030dd348fff8d681d7fc1cb7afdbbcfe93
+  data.tar.gz: c22e24de059a48c698e5fa8a68adef55902cfbb2
 SHA512:
-  metadata.gz: bd5bec3e835cec6a85de603e4437e013f86fa5e9f239a243fcfa9540b17324a27a075b3a7c78520d2390d8a32e698f8939006e46fbe7f56e547bd008ceb73958
-  data.tar.gz: de559dec1bf1265a8e8cacb7431b1617a53ad10dafb24c4ae728714116c5d80580d52e180665fe46632578e8bb198bc9fe8240f989e815f56a80240883c5cad9
+  metadata.gz: 06281b839a4a394cbf7eb4c1ea708fce8c2ba5754b0248b716e424a01843391da5e11545c255b9e6fa221f3c9c2d095fa3272150663b1044340767d6d1eb7bd3
+  data.tar.gz: f728e9648771220b3312224d8d31def9cfc9d1e6ad756ba6beff701a15ae434635378fc68b2c7f613cd939459afff9bc9fbc2ba44d10e32b68c514f3eeda24cb

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.1.0
+
+* Fix bug in remote debugging display
+* Fix bug where eval would crash when inspect raised an exception (reported by
+@iblue)
+* `enable breakpoints` now enables every breakpoint
+* `disable breakpoints` now disables every breakpoint
+
+
 # 2.0.0
 
 * Various bug fixes

data/GUIDE.md

@@ -1153,3 +1153,36 @@ available only if the nodewrap gem is installed_.
 * `method <class-or-module>`. Show methods of the class or module
 `<class-or-module>`. Basically this is the same as running
 `ps <class-or-module>.methods`.
+
+### Examining Program Source Files (`list`)
+
+`byebug` can print parts of your script's source.  When your script stops,
+`byebug` spontaneously lists the source code around the line where it stopped
+that line. It does that when you change the current stack frame as well.
+Implicitly there is a default line location. Each time a list command is run
+that implicit location is updated, so that running several list commands in
+succession shows a contiguous block of program text.
+
+If you don't need code context displayed every time, you can issue the `set
+noautolist` command. Now whenever you want code listed, you can explicitly issue
+the `list` command or its abbreviation `l`. Notice that when a second listing is
+displayed, we continue listing from the place we last left off. When the
+beginning or end of the file is reached, the line range to be shown is adjusted
+so "it doesn't overflow". You can set the `noautolist` option by default by
+dropping `set noautolist` in byebug's startup file `.byebugrc`.
+
+If you want to set how many lines to be printed by default rather than use the
+initial number of lines, 10, use the `set listsize` command ([listsize()). To
+see the entire program in one shot, give an explicit starting and ending line
+number. You can print other portions of source files by giving explicit position
+as a parameter to the list command.
+
+There are several ways to specify what part of the file you want to print. `list
+nnn` prints lines centered around line number `nnn` in the current source file.
+`l` prints more lines, following the last lines printed. `list -` prints lines
+just before the lines last printed. `list nnn-mmm` prints lines between `nnn`
+and `mmm` inclusive. `list =` prints lines centered around where the script is
+stopped. Repeating a `list` command with `RET` discards the argument, so it is
+equivalent to typing just `list`.  This is more useful than listing the same
+lines again. An exception is made for an argument of `-`: that argument is
+preserved in repetition so that each repetition moves up in the source file.

data/README.md

@@ -23,13 +23,7 @@ effects of one bug and go on to learn about another.
 
 ## Install
 
-Just drop
-
-    gem 'byebug'
-
-in your Gemfile and run
-
-    bundle install
+    $ gem install byebug
 
 **Please upgrade your ruby to 2.0.0-p247 or higher** - a bug in ruby core was
 directly affecting byebug and a fix for it has been released with this

data/lib/byebug/command.rb

@@ -197,14 +197,15 @@ module Byebug
           eval(str, b)
         rescue StandardError, ScriptError => e
           if Command.settings[:stack_trace_on_error]
-            at = eval("caller(1)", b)
-            print "#{at.shift}:#{e.to_s.sub(/\(eval\):1:(in `.*?':)?/, '')}"
+            at = eval("Thread.current.backtrace_locations(1)", b)
+            print "#{at.shift}: #{e.class} Exception(#{e.message})\n"
             for i in at
               print "\tfrom #{i}\n"
             end
           else
             print "#{e.class} Exception: #{e.message}\n"
           end
+          nil
         end
       end
 

data/lib/byebug/commands/enable.rb

@@ -3,30 +3,29 @@ module Byebug
   # Mix-in module to assist in command parsing.
   module EnableDisableFunctions
     def enable_disable_breakpoints(is_enable, args)
-      breakpoints = Byebug.breakpoints.sort_by{|b| b.id }
-      largest = breakpoints.inject(0) do |tally, b|
-        tally = b.id if b.id > tally
-      end
-      if 0 == largest
-        errmsg "No breakpoints have been set.\n"
-        return
+      return errmsg "No breakpoints have been set." if Byebug.breakpoints.empty?
+
+      all_breakpoints = Byebug.breakpoints.sort_by {|b| b.id }
+      if !args
+        selected_breakpoints = all_breakpoints
+      else
+        selected_ids = []
+        args.each do |pos|
+          pos = get_int(pos, "#{is_enable} breakpoints", 1, all_breakpoints.last.id)
+          return nil unless pos
+          selected_ids << pos
+        end
+        selected_breakpoints = all_breakpoints.select {
+          |b| selected_ids.include?(b.id) }
       end
-      args.each do |pos|
-        pos = get_int(pos, "#{is_enable} breakpoints", 1, largest)
-        return nil unless pos
-        breakpoints.each do |b|
-          if b.id == pos
-            enabled = ('enable' == is_enable)
-            if enabled
-              unless syntax_valid?(b.expr)
-                errmsg "Expression \"#{b.expr}\" syntactically incorrect; " \
-                       "breakpoint remains disabled.\n"
-                break
-              end
-            end
-            b.enabled = ('enable' == is_enable)
-            break
-          end
+
+      selected_breakpoints.each do |b|
+        enabled = ('enable' == is_enable)
+        if enabled && !syntax_valid?(b.expr)
+          errmsg "Expression \"#{b.expr}\" syntactically incorrect; " \
+                 "breakpoint remains disabled.\n"
+        else
+          b.enabled = enabled
         end
       end
     end
@@ -47,9 +46,10 @@ module Byebug
   class EnableCommand < Command
     Subcommands =
       [
-       ['breakpoints', 2, 'Enable specified breakpoints',
-        'Give breakpoint numbers (separated by spaces) as arguments. This is ' \
-        'used to cancel the effect of the "disable" command.'],
+       ['breakpoints', 2, 'Enable breakpoints',
+        'This is used to cancel the effect of the "disable" command. Give ' \
+        'breakpoint numbers (separated by spaces) as arguments or no '      \
+        'argument at all if you want to reenable every breakpoint'],
        ['display', 2,
         'Enable some expressions to be displayed when program stops',
         'Arguments are the code numbers of the expressions to resume '   \
@@ -93,8 +93,7 @@ module Byebug
       def description
         %{Enable breakpoints or displays.
 
-          This is used to cancel the effect of the "disable" command.
-         }
+          This is used to cancel the effect of the "disable" command.}
       end
     end
   end
@@ -102,11 +101,13 @@ module Byebug
   class DisableCommand < Command
     Subcommands =
       [
-       ['breakpoints', 1, 'Disable some breakpoints',
-        'Arguments are breakpoint numbers with spaces in between. A disabled ' \
-        'breakpoint is not forgotten, but has no effect until reenabled.'],
+       ['breakpoints', 1, 'Disable breakpoints',
+        'A disabled breakpoint is not forgotten, but has no effect until ' \
+        'reenabled. Give breakpoint numbers (separated by spaces) as '     \
+        'arguments or no argument at all if you want to disable every '    \
+        'breakpoint'],
        ['display', 1, 'Disable some display expressions when program stops',
-        'Arguments are the code numbers of the expressions to stop '       \
+        'Arguments are the code numbers of the expressions to stop '     \
         'displaying. Do "info display" to see the current list of code ' \
         'numbers.'],
       ].map do |name, min, short_help, long_help|
@@ -148,8 +149,7 @@ module Byebug
         %{Disable breakpoints or displays.
 
           A disabled item is not forgotten, but has no effect until reenabled.
-          Use the "enable" command to have it take effect again.
-         }
+          Use the "enable" command to have it take effect again.}
       end
     end
   end

data/lib/byebug/commands/eval.rb

@@ -51,6 +51,8 @@ module Byebug
       run_with_binding do |b|
         print "#{debug_eval(expr, b).inspect}\n"
       end
+    rescue
+      print "#{$!.class} Exception: #{$!.message}\n"
     end
 
     class << self

data/lib/byebug/commands/frame.rb

@@ -106,7 +106,7 @@ module Byebug
       if Byebug.post_mortem?
         realsize = @state.context.stack_size
       else
-        realsize = Thread.current.backtrace_locations.
+        realsize = Thread.current.backtrace_locations(1).
           drop_while{ |l| IGNORED_FILES.include?(l.path) || l.path == '(eval)' }.
           take_while{ |l| !IGNORED_FILES.include?(l.path) }.size
         size = @state.context.stack_size

data/lib/byebug/commands/threads.rb

@@ -18,9 +18,10 @@ module Byebug
           file = @state.context.frame_file(0)
           line = @state.context.frame_line(0)
         else
-          if context.thread.backtrace_locations && context.thread.backtrace_locations[0]
-            file = context.thread.backtrace_locations[0].path
-            line = context.thread.backtrace_locations[0].lineno
+          if context.thread.backtrace_locations(1) &&
+             context.thread.backtrace_locations(1)[0]
+            file = context.thread.backtrace_locations(1)[0].path
+            line = context.thread.backtrace_locations(1)[0].lineno
           end
         end
         file_line = "#{file}:#{line}"

data/lib/byebug/interface.rb

@@ -157,7 +157,7 @@ module Byebug
     end
 
     def print(*args)
-      @socket.printf(*args)
+      @socket.printf(escape(format(*args)))
     end
 
     private

data/lib/byebug/version.rb

@@ -1,3 +1,3 @@
 module Byebug
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/test/breakpoints_test.rb

@@ -15,12 +15,13 @@ class TestBreakpoints < TestDsl::TestCase
       debug_file('breakpoint') { subject.send(field).must_equal value }
     end
 
-    it('must have correct pos') { check_subject(:pos, 10) }
-    it('must have correct source') { check_subject(:source, @tst_file) }
-    it('must have correct expression') { check_subject(:expr, nil) }
-    it('must have correct hit count') { check_subject(:hit_count, 0) }
-    it('must have correct hit value') { check_subject(:hit_value, 0) }
-    it('must be enabled') { check_subject(:enabled?, true) }
+    it('must have correct pos')        { check_subject(:pos, 10)           }
+    it('must have correct source')     { check_subject(:source, @tst_file) }
+    it('must have correct expression') { check_subject(:expr, nil)         }
+    it('must have correct hit count')  { check_subject(:hit_count, 0)      }
+    it('must have correct hit value')  { check_subject(:hit_value, 0)      }
+    it('must be enabled')              { check_subject(:enabled?, true)    }
+
     it('must return right response') do
       id = nil
       debug_file('breakpoint') { id = subject.id }
@@ -203,13 +204,12 @@ class TestBreakpoints < TestDsl::TestCase
     end
   end
 
-  describe 'disabling a breakpoint' do
+  describe 'disabling breakpoints' do
     describe 'successfully' do
-      before { enter 'break 14' }
+      before { enter 'break 14', 'break 15' }
 
       describe 'short syntax' do
-        before { enter ->{"disable #{Byebug.breakpoints.first.id}"},
-                       'break 15' }
+        before { enter ->{ "disable #{Byebug.breakpoints.first.id}" } }
 
         it 'must have a breakpoint with #enabled? returning false' do
           debug_file('breakpoint') {
@@ -223,17 +223,36 @@ class TestBreakpoints < TestDsl::TestCase
       end
 
       describe 'full syntax' do
-        before { enter ->{"disable breakpoints #{Byebug.breakpoints.first.id}"},
-                       'break 15' }
+        describe 'with no args' do
+          before { enter 'disable breakpoints' }
+
+          it 'must have all breakoints with #enabled? returning false' do
+            debug_file('breakpoint') do
+              Byebug.breakpoints.first.enabled?.must_equal false
+              Byebug.breakpoints.last.enabled?.must_equal false
+            end
+          end
+
+          it 'must not stop on any disabled breakpoint' do
+            enter 'cont'
+            debug_file('breakpoint') { $state.line.must_be nil }
+          end
+        end
 
-        it 'must have a breakpoint with #enabled? returning false' do
-          debug_file('breakpoint') {
-            Byebug.breakpoints.first.enabled?.must_equal false }
+        describe 'with specific breakpoint' do
+          before do
+            enter ->{ "disable breakpoints #{Byebug.breakpoints.first.id}" }
+          end
+
+          it 'must have a breakpoint with #enabled? returning false' do
+            debug_file('breakpoint') {
+              Byebug.breakpoints.first.enabled?.must_equal false }
+          end
         end
       end
     end
 
-    describe 'errors' do
+    describe 'unsuccesfully' do
       it 'must show an error if syntax is incorrect' do
         enter 'disable'
         debug_file('breakpoint')
@@ -241,7 +260,7 @@ class TestBreakpoints < TestDsl::TestCase
                              '"breakpoints" or breakpoint numbers.'
       end
 
-      it 'must show an error if no breakpoints is set' do
+      it 'must show an error if no breakpoints are set' do
         enter 'disable 1'
         debug_file('breakpoint')
         check_error_includes 'No breakpoints have been set.'
@@ -256,13 +275,12 @@ class TestBreakpoints < TestDsl::TestCase
     end
   end
 
-  describe 'enabling a breakpoint' do
-
+  describe 'enabling breakpoints' do
     describe 'successfully' do
-      before { enter 'break 14' }
+      before { enter 'break 14', 'break 15', 'disable breakpoints' }
 
       describe 'short syntax' do
-        before { enter ->{"enable #{Byebug.breakpoints.first.id}"}, 'break 15' }
+        before { enter ->{ "enable #{Byebug.breakpoints.first.id}" } }
 
         it 'must have a breakpoint with #enabled? returning true' do
           debug_file('breakpoint') {
@@ -276,12 +294,41 @@ class TestBreakpoints < TestDsl::TestCase
       end
 
       describe 'full syntax' do
-        before { enter ->{"enable breakpoints #{Byebug.breakpoints.first.id}"},
-                       'break 15' }
+        describe 'with no args' do
+          before { enter 'enable breakpoints' }
+
+          it 'must have all breakoints with #enabled? returning true' do
+            debug_file('breakpoint') do
+              Byebug.breakpoints.first.enabled?.must_equal true
+              Byebug.breakpoints.last.enabled?.must_equal true
+            end
+          end
+
+          it 'must stop on the first breakpoint' do
+            enter 'cont'
+            debug_file('breakpoint') { $state.line.must_be 14 }
+          end
+
+          it 'must stop on the last breakpoint' do
+            enter 'cont', 'cont'
+            debug_file('breakpoint') { $state.line.must_be 15 }
+          end
+        end
 
-        it 'must have a breakpoint with #enabled? returning true' do
-          debug_file('breakpoint') {
-            Byebug.breakpoints.first.enabled?.must_equal true }
+        describe 'with specific breakpoint' do
+          before do
+            enter ->{ "enable breakpoints #{Byebug.breakpoints.last.id}" }
+          end
+
+          it 'must have a breakpoint with #enabled? returning true' do
+            debug_file('breakpoint') {
+              Byebug.breakpoints.first.enabled?.must_equal true }
+          end
+
+          it 'must not stop on the enabled breakpoint' do
+            enter 'cont'
+            debug_file('breakpoint') { $state.line.must_be 15 }
+          end
         end
       end
     end

data/test/eval_test.rb

@@ -20,6 +20,12 @@ class TestEval < TestDsl::TestCase
     check_output_includes '5'
   end
 
+  it 'must work when inspect raises an exception' do
+    enter 'c 14', 'p @foo'
+    debug_file('eval') { $state.line.must_equal 14 }
+    check_output_includes 'RuntimeError Exception: Broken'
+  end
+
   describe 'autoeval' do
     it 'must be set by default' do
       enter '[5,6,7].inject(&:+)'
@@ -43,7 +49,7 @@ class TestEval < TestDsl::TestCase
       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_includes /\s*from \S+:in \`eval\'/
         check_output_doesnt_include 'ZeroDivisionError Exception: divided by 0'
       end
     end

data/test/examples/eval.rb

@@ -1,4 +1,14 @@
 byebug
+
 b = 5
 c = b + 5
 c
+
+class EvalTest
+  def inspect
+    raise "Broken"
+  end
+end
+
+@foo = EvalTest.new
+b = 6

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: byebug
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - David Rodriguez
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: columnize