debugger 1.2.4 → 1.3.0

data/.gitignore

@@ -0,0 +1,14 @@
+tmp
+vendor/bundle
+
+.rvmrc
+.gdbinit
+.gdb_history
+.bundle
+
+lib/ruby_debug.bundle
+ext/ruby_debug/breakpoint.c
+ext/ruby_debug/ruby_debug.c
+ext/ruby_debug/ruby_debug.h
+
+Gemfile.lock

data/.travis.yml

@@ -1,4 +1,3 @@
-before_install: bundle init --gemspec=debugger.gemspec
 before_script: rake compile
 rvm:
 - 1.9.2

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.3.0 - thanks to @astashov 
+* New and improved test suite
+* Fix line tracing
+* Fix source reloading
+* Fix error message of jump command
+* Fix trace and trace all commands
+* Fix -d flag to irb command
+* Fix method command being detected
+
 ## 1.2.4
 * Bump ruby_core_source dependency
 

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -91,6 +91,7 @@ tutorial](http://bashdb.sourceforge.net/ruby-debug/rdebug-emacs.html)
   * No downloading ruby source during install - was behavior of old ruby_core_source dependency
   * Fix LocalJumpError caused by using proc in extconf.rb
   * Fix where command failing at top level
+  * A new and improved test suite
   * Passing tests are up on travis-ci
 * Minor
   * The gem name matches the module namespace, Debugger, and main required file, debugger.
@@ -126,6 +127,7 @@ Let's keep this working for the ruby community!
 ## Credits
 
 * Thanks to the original authors: Kent Sibilev and Mark Moseley
+* Thanks to astashov for bringing in a new and improved test suite and various bug fixes.
 * Contributors: ericpromislow, jnimety, adammck, hipe, FooBarWidget
 * Fork started on awesome @relevance fridays!
 

data/Rakefile

@@ -7,62 +7,10 @@ Rake::ExtensionTask.new('ruby_debug')
 
 SO_NAME = "ruby_debug.so"
 
-COMMON_FILES = FileList[
-  'AUTHORS',
-  'CHANGES',
-  'LICENSE',
-  'README',
-  'Rakefile',
-]
-
-CLI_TEST_FILE_LIST = FileList['test/lib/commands/unit/*.rb',
-                              'test/lib/commands/*_test.rb',
-                              'test/lib/**/*_test.rb',
-                              'test/test-remote.rb']
-                              # disabled until requires fixed and tests pass
-                              # 'test/test-*.rb']
-CLI_FILES = COMMON_FILES + FileList[
-  "lib/**/*",
-  'ChangeLog',
-  'bin/*',
-  'doc/rdebug.1',
-  'test/**/data/*.cmd',
-  'test/**/data/*.right',
-  'test/**/*.rb',
-  'rdbg.rb',
-   CLI_TEST_FILE_LIST
-]
-
-BASE_TEST_FILE_LIST = %w(
-  test/base/base.rb
-  test/base/binding.rb
-  test/base/catchpoint.rb)
-BASE_FILES = COMMON_FILES + FileList[
-  'ext/ruby_debug/breakpoint.c',
-  'ext/ruby_debug/extconf.rb',
-  'ext/ruby_debug/ruby_debug.c',
-  'ext/ruby_debug/ruby_debug.h',
-  'ext/win32/*',
-  'lib/**/*',
-  BASE_TEST_FILE_LIST,
-]
-
-desc "Test everything."
-task :test => :test_base do
+desc "Run new MiniTest tests."
+task :test do
   Rake::TestTask.new(:test) do |t|
-    t.libs << './ext'
-    t.libs << './lib'
-    t.test_files = CLI_TEST_FILE_LIST
-    t.verbose = true
-  end
-end
-
-desc "Test ruby-debug-base."
-task :test_base => :lib do
-  Rake::TestTask.new(:test_base) do |t|
-    t.libs << './ext'
-    t.libs << './lib'
-    t.test_files = FileList[BASE_TEST_FILE_LIST]
+    t.test_files = FileList["test/*_test.rb"]
     t.verbose = true
   end
 end

data/debugger.gemspec

@@ -24,4 +24,6 @@ handling, bindings for stack frames among other things.
   s.add_dependency "debugger-linecache", '~> 1.1.1'
   s.add_development_dependency 'rake', '~> 0.9.2.2'
   s.add_development_dependency 'rake-compiler', '~> 0.8.0'
+  s.add_development_dependency 'minitest', '~> 2.12.1'
+  s.add_development_dependency 'mocha', '~> 0.13.0'
 end

data/lib/debugger/version.rb

@@ -1,5 +1,5 @@
 module Debugger
   # TODO: remove version from C ext
   send :remove_const, :VERSION if const_defined? :VERSION
-  VERSION = '1.2.4'
+  VERSION = '1.3.0'
 end

data/lib/ruby-debug-base.rb

@@ -46,7 +46,7 @@ module Debugger
     end
 
     def at_tracing(file, line)
-      @tracing_started = true if File.identical?(file, File.join(Debugger::INITIAL_DIR, Debugger::PROG_SCRIPT))
+      @tracing_started = File.identical?(file, Debugger::PROG_SCRIPT)
       handler.at_tracing(self, file, line) if @tracing_started
     end
 
@@ -91,6 +91,8 @@ module Debugger
     end
 
     def source_reload
+      Object.send(:remove_const, "SCRIPT_LINES__") if Object.const_defined?("SCRIPT_LINES__")
+      Object.const_set("SCRIPT_LINES__", {})
       LineCache::clear_file_cache
     end
 

data/lib/ruby-debug/commands/irb.rb

@@ -72,7 +72,7 @@ module Debugger
         throw :IRB_EXIT, :cont if $rdebug_in_irb
       end
 
-      add_debugging = @match.is_a?(Array) && '-d' == @match[1]
+      add_debugging = @match.is_a?(MatchData) && '-d' == @match[1]
       $rdebug_state = @state if add_debugging
       $rdebug_in_irb = true
       cont = IRB.start_session(get_binding)

data/lib/ruby-debug/commands/jump.rb

@@ -23,7 +23,7 @@ module Debugger
         return
       end
       if !numeric?(@match[1])
-        puts "Bad line number: " + @match[1]
+        errmsg "Bad line number: " + @match[1]
         return
       end
       line = @match[1].to_i

data/lib/ruby-debug/commands/method.rb

@@ -42,7 +42,7 @@ module Debugger
   # Implements the debugger 'method' command.
   class MethodCommand < Command
     def regexp
-      /^\s*m(?:ethod)?\s+((iv)|(i(:?nstance\s+)?)\s+)?/
+      /^\s*m(?:ethod)?\s+((iv)|(i(:?nstance)?)\s+)?/
     end
 
     def execute

data/lib/ruby-debug/commands/show.rb

@@ -68,7 +68,7 @@ module Debugger
             i += 1
           end
         else
-          s='No readline suport'
+          s='No readline support'
         end
         return s
       when /^debuggertesting$/

data/lib/ruby-debug/commands/trace.rb

@@ -11,10 +11,10 @@ module Debugger
       if @match[1] =~ /on|off/
         onoff = 'on' == @match[1] 
         if @match[2]
-          Debugger.current_context.tracing = onoff
+          Debugger.tracing = onoff
           print "Tracing %s all threads.\n" % (onoff ? 'on' : 'off')
         else
-          Debugger.tracing = onoff
+          Debugger.current_context.tracing = onoff
           print "Tracing %s on current thread.\n"  % (onoff ? 'on' : 'off')
         end
       elsif @match[1] =~ /var(?:iable)?/

data/lib/ruby-debug/commands/variables.rb

@@ -4,10 +4,10 @@ module Debugger
       ary.sort!
       for v in ary
         begin
-          s = debug_eval(v, b).inspect
+          s = debug_eval(v.to_s, b).inspect
         rescue
           begin
-            s = debug_eval(v, b).to_s
+            s = debug_eval(v.to_s, b).to_s
           rescue
             s = "*Error in evaluation*"
           end
@@ -78,7 +78,7 @@ module Debugger
 
       def help(cmd)
         %{
-          v[ar] c[onst] <object>\t\tshow constants of object
+          v[ar] co[nst] <object>\t\tshow constants of object
         }
       end
     end

data/test/breakpoints_test.rb

@@ -0,0 +1,365 @@
+require_relative 'test_helper'
+
+describe "Breakpoints" do
+  include TestDsl
+
+  describe "setting breakpoint in the current file" do
+    before { enter 'break 10' }
+    subject { breakpoint }
+
+    def check_subject(field, value)
+      debug_file("breakpoint1") { subject.send(field).must_equal value }
+    end
+
+    it("must have correct pos") { check_subject(:pos, 10) }
+    it("must have correct source") { check_subject(:source, fullpath("breakpoint1")) }
+    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('breakpoint1') { id = subject.id }
+      check_output_includes "Breakpoint #{id} file #{fullpath('breakpoint1')}, line 10"
+    end
+  end
+
+
+  describe "using shortcut for the command" do
+    before { enter 'b 10' }
+    it "must set a breakpoint" do
+      debug_file("breakpoint1") { Debugger.breakpoints.size.must_equal 1 }
+    end
+  end
+
+
+  describe "setting breakpoint to unexisted line" do
+    before { enter 'break 100' }
+
+    it "must not create a breakpoint" do
+      debug_file("breakpoint1") { Debugger.breakpoints.must_be_empty }
+    end
+
+    it "must show an error" do
+      debug_file("breakpoint1")
+      check_output_includes "There are only #{LineCache.size(fullpath('breakpoint1'))} lines in file \"breakpoint1.rb\".", interface.error_queue
+    end
+  end
+
+
+  describe "setting breakpoint to incorrect line" do
+    before { enter 'break 8' }
+
+    it "must not create a breakpoint" do
+      debug_file("breakpoint1") { Debugger.breakpoints.must_be_empty }
+    end
+
+    it "must show an error" do
+      debug_file("breakpoint1")
+      check_output_includes 'Line 8 is not a stopping point in file "breakpoint1.rb".', interface.error_queue
+    end
+  end
+
+
+  describe "stopping at breakpoint" do
+    it "must stop at the correct line" do
+      enter 'break 14', 'cont'
+      debug_file("breakpoint1") { state.line.must_equal 14 }
+    end
+
+    it "must stop at the correct file" do
+      enter 'break 14', 'cont'
+      debug_file("breakpoint1") { state.file.must_equal fullpath("breakpoint1") }
+    end
+
+    describe "show a message" do
+      temporary_change_hash_value(Debugger::Command.settings, :basename, false)
+
+      it "must show a message with full filename" do
+        enter 'break 14', 'cont'
+        debug_file("breakpoint1")
+        check_output_includes "Breakpoint 1 at #{fullpath('breakpoint1')}:14"
+      end
+
+      it "must show a message with basename" do
+        enter 'set basename', 'break 14', 'cont'
+        debug_file("breakpoint1")
+        check_output_includes "Breakpoint 1 at breakpoint1.rb:14"
+      end
+    end
+  end
+
+
+  describe "reloading source on change" do
+    temporary_change_hash_value(Debugger::Command.settings, :reload_source_on_change, false)
+
+    it "must not reload source if autoreload is not set" do
+      enter(
+        'set noautoreload',
+        ->{change_line_in_file(fullpath('breakpoint1'), 14, ''); 'break 14'},
+        ->{change_line_in_file(fullpath('breakpoint1'), 14, 'c = a + b'); 'cont'}
+      )
+      debug_file "breakpoint1"
+      check_output_includes "Breakpoint 1 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 \"breakpoint1.rb\".", interface.error_queue
+    end
+  end
+
+
+  describe "set breakpoint in a file" do
+    describe "successfully" do
+      before do
+        enter "break #{fullpath('breakpoint2')}:3", 'cont'
+      end
+
+      it "must stop at the correct line" do
+        debug_file("breakpoint1") { state.line.must_equal 3 }
+      end
+
+      it "must stop at the correct file" do
+        debug_file("breakpoint1") { state.file.must_equal fullpath("breakpoint2") }
+      end
+    end
+
+    describe "when setting breakpoint to unexisted file" do
+      before do
+        enter "break asf:324"
+        debug_file("breakpoint1")
+      end
+      it "must show an error" do
+        check_output_includes "No source file named asf", interface.error_queue
+      end
+
+      it "must ask about setting breakpoint anyway" do
+        check_output_includes "Set breakpoint anyway? (y/n)", interface.confirm_queue
+      end
+    end
+  end
+
+
+  describe "set breakpoint to a method" do
+    describe "set breakpoint to an instance method" do
+      before do
+        enter 'break A#b', 'cont'
+      end
+
+      it "must stop at the correct line" do
+        debug_file("breakpoint1") { state.line.must_equal 5 }
+      end
+
+      it "must stop at the correct file" do
+        debug_file("breakpoint1") { state.file.must_equal fullpath("breakpoint1") }
+      end
+    end
+
+    describe "set breakpoint to a class method" do
+      before do
+        enter 'break A.a', 'cont'
+      end
+
+      it "must stop at the correct line" do
+        debug_file("breakpoint1") { state.line.must_equal 2 }
+      end
+
+      it "must stop at the correct file" do
+        debug_file("breakpoint1") { state.file.must_equal fullpath("breakpoint1") }
+      end
+    end
+
+    describe "set breakpoint to unexisted class" do
+      it "must show an error" do
+        enter "break B.a"
+        debug_file("breakpoint1")
+        check_output_includes "Unknown class B.", interface.error_queue
+      end
+    end
+  end
+
+
+  describe "set breakpoint to an invalid location" do
+    before { enter "break foo" }
+
+    it "must not create a breakpoint" do
+      debug_file("breakpoint1") { Debugger.breakpoints.must_be_empty }
+    end
+
+    it "must show an error" do
+      debug_file("breakpoint1")
+      check_output_includes 'Invalid breakpoint location: foo.', interface.error_queue
+    end
+  end
+
+
+  describe "disabling a breakpoint" do
+    describe "successfully" do
+      before { enter "break 14" }
+
+      describe "short syntax" do
+        before { enter ->{"disable #{breakpoint.id}"}, "break 15" }
+        it "must have a breakpoint with #enabled? returning false" do
+          debug_file("breakpoint1") { breakpoint.enabled?.must_equal false }
+        end
+
+        it "must not stop on the disabled breakpoint" do
+          enter "cont"
+          debug_file("breakpoint1") { state.line.must_equal 15 }
+        end
+      end
+
+      describe "full syntax" do
+        before { enter ->{"disable breakpoints #{breakpoint.id}"}, "break 15" }
+        it "must have a breakpoint with #enabled? returning false" do
+          debug_file("breakpoint1") { breakpoint.enabled?.must_equal false }
+        end
+      end
+    end
+
+    describe "errors" do
+      it "must show an error if syntax is incorrect" do
+        enter "disable"
+        debug_file("breakpoint1")
+        check_output_includes(
+          '"disable" must be followed "display", "breakpoints" or breakpoint numbers.',
+          interface.error_queue
+        )
+      end
+
+      it "must show an error if no breakpoints is set" do
+        enter "disable 1"
+        debug_file("breakpoint1")
+        check_output_includes 'No breakpoints have been set.', interface.error_queue
+      end
+
+      it "must show an error if not a number is provided as an argument to 'disable' command" do
+        enter "break 14", "disable foo"
+        debug_file("breakpoint1")
+        check_output_includes "Disable breakpoints argument 'foo' needs to be a number."
+      end
+    end
+  end
+
+
+  describe "enabling a breakpoint" do
+    describe "successfully" do
+      before { enter "break 14" }
+      describe "short syntax" do
+        before { enter ->{"enable #{breakpoint.id}"}, "break 15" }
+
+        it "must have a breakpoint with #enabled? returning true" do
+          debug_file("breakpoint1") { breakpoint.enabled?.must_equal true }
+        end
+
+        it "must stop on the enabled breakpoint" do
+          enter "cont"
+          debug_file("breakpoint1") { state.line.must_equal 14 }
+        end
+      end
+
+      describe "full syntax" do
+        before { enter ->{"enable breakpoints #{breakpoint.id}"}, "break 15" }
+
+        it "must have a breakpoint with #enabled? returning true" do
+          debug_file("breakpoint1") { breakpoint.enabled?.must_equal true }
+        end
+      end
+    end
+
+    describe "errors" do
+      it "must show an error if syntax is incorrect" do
+        enter "enable"
+        debug_file("breakpoint1")
+        check_output_includes(
+          '"enable" must be followed "display", "breakpoints" or breakpoint numbers.',
+          interface.error_queue
+        )
+      end
+    end
+  end
+
+
+  describe "deleting a breakpoint" do
+    before { enter "break 14", ->{"delete #{breakpoint.id}"}, "break 15" }
+
+    it "must have only one breakpoint" do
+      debug_file("breakpoint1") { Debugger.breakpoints.size.must_equal 1 }
+    end
+
+    it "must not stop on the disabled breakpoint" do
+      enter "cont"
+      debug_file("breakpoint1") { state.line.must_equal 15 }
+    end
+  end
+
+
+  describe "Conditional breakpoints" do
+    it "must stop if the condition is correct" do
+      enter "break 14 if b == 5", "break 15", "cont"
+      debug_file("breakpoint1") { state.line.must_equal 14 }
+    end
+
+    it "must skip if the condition is incorrect" do
+      enter "break 14 if b == 3", "break 15", "cont"
+      debug_file("breakpoint1") { state.line.must_equal 15 }
+    end
+
+    it "must show an error when conditional syntax is wrong" do
+      enter "break 14 ifa b == 3", "break 15", "cont"
+      debug_file("breakpoint1") { state.line.must_equal 15 }
+      check_output_includes "Expecting 'if' in breakpoint condition; got: ifa b == 3.", interface.error_queue
+    end
+
+    describe "enabling with wrong conditional syntax" do
+      before do
+        enter(
+          "break 14",
+          ->{"disable #{breakpoint.id}"},
+          ->{"cond #{breakpoint.id} b -=( 3"},
+          ->{"enable #{breakpoint.id}"}
+        )
+      end
+
+      it "must not enable a breakpoint" do
+        debug_file("breakpoint1") { breakpoint.enabled?.must_equal false }
+      end
+
+      it "must show an error" do
+        debug_file("breakpoint1")
+        check_output_includes(
+          'Expression "b -=( 3" syntactically incorrect; breakpoint remains disabled.',
+          interface.error_queue
+        )
+      end
+    end
+
+    it "must show an error if no file or line is specified" do
+      enter "break ifa b == 3", "break 15", "cont"
+      debug_file("breakpoint1") { state.line.must_equal 15 }
+      check_output_includes "Invalid breakpoint location: ifa b == 3.", interface.error_queue
+    end
+
+    it "must show an error if expression syntax is invalid" do
+      enter "break if b -=) 3", "break 15", "cont"
+      debug_file("breakpoint1") { state.line.must_equal 15 }
+      check_output_includes 'Expression "b -=) 3" syntactically incorrect; breakpoint disabled.', interface.error_queue
+    end
+  end
+
+
+  describe "Post Mortem" do
+    it "must be able to set breakpoints in post-mortem mode" do
+      enter 'cont', 'break 12', 'cont'
+      debug_file("post_mortem") { state.line.must_equal 12 }
+    end
+  end
+
+end