ruby-debug 0.10.0 → 0.10.1

data/doc/rdebug.1

@@ -1,4 +1,4 @@
-.\" $Id: rdebug.1 461 2007-12-22 11:18:14Z rockyb $
+.\" $Id: rdebug.1 516 2007-12-31 05:55:24Z rockyb $
 .TH rdebug 1 
 .SH NAME
 rdebug \- Fast Ruby debugger
@@ -165,6 +165,11 @@ Port used for control commands.
 Set $DEBUG true.
 .TP
 .B \-\-emacs
+Activates full GNU Emacs mode. Is the equivalent of setting the
+options \-\-emacs\-basic, \-\-annotate=3, \-\-no-stop, \-\-no\-control
+and \-\-post\-mortem.
+.TP
+.B \-\-emacs-basic
 Activates GNU Emacs mode. Debugger prompts are prefaced with two octal
 032 characters.
 .TP
@@ -180,7 +185,7 @@ Activate post-mortem mode.
 .B \-\-no-control
 Do not automatically start control thread.
 .TP
-.B \-n | \-\-no\-stop
+.B \-\-no\-stop
 Do not stop when script is loaded.
 .TP
 .B \-p | \-\-port=PORT

data/rdbg.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+# $Id: rdbg.rb 756 2008-03-13 02:15:04Z rockyb $
+
+# Use this to run rdebug without installing it.  We assume that the
+# library directories are stored at the same level the directory
+# this program. 
+module RDebugRunner
+  def runner(stdout=nil)
+
+    # Add libraries to load path.
+    dirname=File.dirname(__FILE__)
+    libs = %w(ext lib cli)
+    libs.each { |lib| $:.unshift File.join(dirname, lib) }
+
+    rdebug=ENV['RDEBUG'] || File.join(dirname, 'bin', 'rdebug')
+    if stdout
+      old_stdout = $stdout
+      $stdout.reopen(stdout)
+    else
+      old_stdout = nil
+    end
+    load(rdebug, true)
+    $stdout.reopen(old_stdout) if old_stdout
+    
+    # Remove those libraries we just added.
+    1.upto(libs.size) {$:.shift}
+  end
+  module_function :runner
+end
+if __FILE__ == $0 
+  RDebugRunner.runner
+end

data/test/{test-ruby-debug-base.rb → base/base.rb}

@@ -1,75 +1,73 @@
 #!/usr/bin/env ruby
-require "test/unit"
+require 'test/unit'
 
-$: << File.expand_path(File.dirname(__FILE__)) + '/../ext'
-$: << File.expand_path(File.dirname(__FILE__)) + '/../lib'
-require "ruby_debug"
-
-# Test of C extension ruby_debug.so
+# Some tests of Debugger module in C extension ruby_debug 
 class TestRubyDebug < Test::Unit::TestCase
-  include Debugger
+  $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'ext')
+  require 'ruby_debug'
+  $:.shift
 
   # test current_context
   def test_current_context
     assert_equal(false, Debugger.started?, 
-                 "debugger should not initially be started.")
-    Debugger.start
+                 'debugger should not initially be started.')
+    Debugger.start_
     assert(Debugger.started?, 
-           "debugger should now be started.")
-    assert_equal(19, Debugger.current_context.frame_line)
+           'debugger should now be started.')
+    assert_equal(__LINE__, Debugger.current_context.frame_line)
     assert_equal(nil, Debugger.current_context.frame_args_info,
-                 "no frame args info.")
+                 'no frame args info.')
     assert_equal(Debugger.current_context.frame_file, 
                  Debugger.current_context.frame_file(0))
-    assert_equal("test-ruby-debug-base.rb",
+    assert_equal(File.basename(__FILE__),
                  File.basename(Debugger.current_context.frame_file))
     assert_raises(ArgumentError) {Debugger.current_context.frame_file(1, 2)}
     assert_raises(ArgumentError) {Debugger.current_context.frame_file(10)}
     assert_equal(1, Debugger.current_context.stack_size)
     assert_equal(TestRubyDebug, Debugger.current_context.frame_class)
-    assert_equal(false, Debugger.current_context.dead?, "Not dead yet!")
+    assert_equal(false, Debugger.current_context.dead?, 'Not dead yet!')
     Debugger.stop
     assert_equal(false, Debugger.started?, 
-                 "Debugger should no longer be started.")
+                 'Debugger should no longer be started.')
   end
 
   # Test initial variables and setting/getting state.
   def test_debugger_base
     assert_equal(false, Debugger.started?, 
-                 "Debugger should not initially be started.")
-    Debugger.start
+                 'Debugger should not initially be started.')
+    Debugger.start_
     assert(Debugger.started?, 
-           "Debugger should now be started.")
+           'Debugger should now be started.')
     assert_equal(false, Debugger.debug,
-                 "Debug variable should not be set.")
+                 'Debug variable should not be set.')
     assert_equal(false, Debugger.post_mortem?,
-                 "Post mortem debugging should not be set.")
+                 'Post mortem debugging should not be set.')
     a = Debugger.contexts
     assert_equal(1, a.size, 
-                 "There should only be one context.")
+                 'There should only be one context.')
     assert_equal(Array, a.class, 
-                 "Context should be an array.")
+                 'Context should be an array.')
     Debugger.stop
     assert_equal(false, Debugger.started?, 
-                 "debugger should no longer be started.")
+                 'debugger should no longer be started.')
   end
 
   # Test breakpoint handling
   def test_breakpoints
-    Debugger.start
+    Debugger.start_
     assert_equal(0, Debugger.breakpoints.size,
-                 "There should not be any breakpoints set.")
+                 'There should not be any breakpoints set.')
     brk = Debugger.add_breakpoint(__FILE__, 1)
     assert_equal(Debugger::Breakpoint, brk.class,
-                 "Breakpoint should have been set and returned.")
+                 'Breakpoint should have been set and returned.')
     assert_equal(1, Debugger.breakpoints.size,
-                 "There should now be one breakpoint set.")
+                 'There should now be one breakpoint set.')
     Debugger.remove_breakpoint(0)
     assert_equal(1, Debugger.breakpoints.size,
-                 "There should still be one breakpoint set.")
+                 'There should still be one breakpoint set.')
     Debugger.remove_breakpoint(1)
     assert_equal(0, Debugger.breakpoints.size,
-                 "There should no longer be any breakpoints set.")
+                 'There should no longer be any breakpoints set.')
     Debugger.stop
   end
 end

data/test/base/binding.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+
+# Test binding_n command
+class TestBinding < Test::Unit::TestCase
+
+  SRC_DIR = File.expand_path(File.dirname(__FILE__)) unless 
+    defined?(SRC_DIR)
+  %w(ext lib).each do |dir|
+    $:.unshift File.join(SRC_DIR, '..', '..', dir)
+  end
+  require File.join(SRC_DIR, '..', '..', 'lib', 'ruby-debug-base')
+  $:.shift; $:.shift
+
+  def test_basic
+    def inside_fn
+      s = 'some other string'
+      b2 = Kernel::binding_n(1)
+      y2 = eval('s', b2)
+      assert_equal('this is a test', y2)
+    end
+    s = 'this is a test'
+    Debugger.start
+    b = Kernel::binding_n(0)
+    y = eval('s', b)
+    assert_equal(y, s)
+    inside_fn
+    Debugger.stop
+  end
+end

data/test/base/catchpoint.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+
+# Test catchpoint in C ruby_debug extension.
+  
+class TestRubyDebugCatchpoint < Test::Unit::TestCase
+
+  $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'ext')
+  require 'ruby_debug'
+  $:.shift
+
+  # test current_context
+  def test_catchpoints
+    assert_raise(RuntimeError) {Debugger.catchpoints}
+    Debugger.start_
+    assert_equal({}, Debugger.catchpoints)
+    Debugger.add_catchpoint('ZeroDivisionError')
+    assert_equal({'ZeroDivisionError' => 0}, Debugger.catchpoints)
+    Debugger.add_catchpoint('RuntimeError')
+    assert_equal(['RuntimeError', 'ZeroDivisionError'], 
+                 Debugger.catchpoints.keys.sort)
+    Debugger.stop
+  end
+
+end
+

data/test/base/load.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+
+# Test of Debugger.debug_load in C extension ruby_debug.so
+class TestDebugLoad < Test::Unit::TestCase
+
+  @@src_dir = File.dirname(__FILE__)
+  $:.unshift File.join(@@src_dir, '..', '..', 'ext')
+  require 'ruby_debug'
+  $:.shift
+  
+  class  << self
+    def at_line(file, line)
+      @@at_line = [File.basename(file), line]
+    end
+  end
+
+  Debugger::PROG_SCRIPT = File.join(@@src_dir, '..', 'gcd.rb')
+
+  class Debugger::Context
+    def at_line(file, line)
+      TestDebugLoad::at_line(file, line)
+    end
+  end
+
+  def test_debug_load
+    # Without stopping
+    bt = Debugger.debug_load(Debugger::PROG_SCRIPT, false)
+    assert_equal(nil, bt)
+    # With stopping
+    bt = Debugger.debug_load(Debugger::PROG_SCRIPT, true)
+    assert_equal(nil, bt)
+    assert_equal(['gcd.rb', 4], @@at_line)
+
+    # Test that we get a proper backtrace on a script that raises 'abc'
+    prog_script = File.join(@@src_dir, '..', 'raise.rb')
+    bt = Debugger.debug_load(prog_script, false)
+    assert_equal(bt.to_s, 'abc')
+  end
+end

data/test/data/annotate.cmd

@@ -0,0 +1,29 @@
+# ********************************************************
+# This tests annotations
+# ********************************************************
+set debuggertesting on
+set callstyle last
+set force off
+set annotate 3
+# Get into gcd
+step 2
+# "break" should trigger break annotation
+break 10
+# "delete" should trigger break annotation
+delete 1
+# p should not trigger a breakpoint annotation
+p a
+# "up" should trigger annotations
+up
+# "b" should trigger like "break"
+b 12
+# "display" should trigger display annotation
+display 1+2
+# undisplay should trigger display annotation
+undisplay 1
+step
+# Test error annotations
+up 10
+frame 100
+break bogus:5
+quit

data/test/data/annotate.right

@@ -0,0 +1,137 @@
+gcd.rb:4
+def gcd(a, b)
+# # ********************************************************
+# # This tests annotations
+# # ********************************************************
+# set debuggertesting on
+Currently testing the debugger is on.
+# set callstyle last
+Frame call-display style is last.
+# set force off
+force-stepping is off.
+# set annotate 3
+Annotation level is 3
+# # Get into gcd
+# step 2
+starting
+stopped
+breakpoints
+No breakpoints.
+
+stack
+--> #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:6
+    #1 at line gcd.rb:18
+
+variables
+a = 3
+b = 5
+self = main
+
+source gcd.rb:6
+if a > b
+# # "break" should trigger break annotation
+# break 10
+Breakpoint 1 file ./gcd.rb, line 10
+breakpoints
+Num Enb What
+  1 y   at gcd.rb:10
+
+# # "delete" should trigger break annotation
+# delete 1
+breakpoints
+No breakpoints.
+
+# # p should not trigger a breakpoint annotation
+# p a
+3
+# # "up" should trigger annotations
+# up
+#1 at line gcd.rb:18
+stack
+    #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:6
+--> #1 at line gcd.rb:18
+
+variables
+self = main
+
+# # "b" should trigger like "break"
+# b 12
+Breakpoint 2 file ./gcd.rb, line 12
+breakpoints
+Num Enb What
+  2 y   at gcd.rb:12
+
+# # "display" should trigger display annotation
+# display 1+2
+1: 1+2 = 3
+display
+1: 1+2 = 3
+
+# # undisplay should trigger display annotation
+# undisplay 1
+display
+
+# step
+display
+
+starting
+stopped
+breakpoints
+Num Enb What
+  2 y   at gcd.rb:12
+
+display
+
+stack
+--> #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:6
+    #1 at line gcd.rb:18
+
+variables
+a = 3
+b = 5
+self = main
+
+source gcd.rb:6
+if a > b
+# # Test error annotations
+# up 10
+error-begin
+Adjusting would put us beyond the oldest (initial) frame.
+
+display
+
+stack
+--> #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:6
+    #1 at line gcd.rb:18
+
+variables
+a = 3
+b = 5
+self = main
+
+# frame 100
+error-begin
+Adjusting would put us beyond the oldest (initial) frame.
+
+display
+
+stack
+--> #0 Object.gcd(a#Fixnum, b#Fixnum) at line gcd.rb:6
+    #1 at line gcd.rb:18
+
+variables
+a = 3
+b = 5
+self = main
+
+# break bogus:5
+error-begin
+No source file named bogus
+
+breakpoints
+Num Enb What
+  2 y   at gcd.rb:12
+
+display
+
+# quit

data/test/data/break_bad.cmd

@@ -0,0 +1,18 @@
+# ********************************************************
+# This tests mostly invalid breakpoints.
+# We have some valid ones too.
+# ********************************************************
+set debuggertesting on
+set callstyle last
+set autoeval off
+# There aren't 100 lines in gcd.rb.
+break 100
+break gcd.rb:100
+# Line one isn't a valid stopping point.
+# It is a comment.
+break gcd.rb:1
+# This line is okay
+break gcd.rb:4
+# No class Foo.
+break Foo.bar
+quit