debugger 1.4.0 → 1.5.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.5.0
+* Add support for any output adapters e.g. xml
+* Bump debugger-linecache dependency
+
 ## 1.4.0
 * Partial support for 2.0.0
 

data/README.md

@@ -89,16 +89,20 @@ tutorial](http://bashdb.sourceforge.net/ruby-debug/rdebug-emacs.html)
     * 1.9.3 points to ruby-debug-base19-0.11.26 headers
   * Install painlessly for rvm and rbenv rubies i.e. no compiler flags needed
   * 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
+  * Add output adapters, Printers, to support output besides plain text e.g. xml
   * A new and improved test suite
   * Passing tests are up on travis-ci
+  * Fix several bugs
+    * Fix LocalJumpError caused by using proc in extconf.rb
+    * Fix where command failing at top level
+    * See changelog for more
 * Minor
   * The gem name matches the module namespace, Debugger, and main required file, debugger.
   * ruby-debug-base19 and ruby-debug19 are released as one gem
   * Rake tasks have been updated
   * No more $LOAD_PATH manipulation or runtime code outside of lib
   * man page available via gem-man
+  * Test helpers for third-party debugger libraries can be accessed from debugger/test. See debugger-xml for an example
 
 ## Issues
 Please report them [on github](http://github.com/cldwalker/debugger/issues).
@@ -117,6 +121,8 @@ Let's keep this working for the ruby community!
 
 * [debugger-completion](https://github.com/cldwalker/debugger-completion) - autocompletion for
   debugger commands and more
+* [debugger-xml](https://github.com/astashov/debugger-xml) - XML interface for debugger, compatible
+  with ruby-debug-ide
 * [debugger-pry](https://github.com/pry/debugger-pry) - using pry within debugger
 * [pry-debugger](https://github.com/nixme/pry-debugger) - using debugger within pry
 * [ruby-debug-passenger](https://github.com/davejamesmiller/ruby-debug-passenger) - rake task to
@@ -128,7 +134,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.
+* Thanks to astashov for bringing in a new and improved test suite, adding printers support and various bug fixes.
 * Thanks to windwiny for porting to 2.0.0
 * Contributors: ericpromislow, jnimety, adammck, hipe, FooBarWidget, aghull
 * Fork started on awesome @relevance fridays!

data/debugger.gemspec

@@ -21,7 +21,7 @@ handling, bindings for stack frames among other things.
   s.executables = ["rdebug"]
   s.add_dependency "columnize", ">= 0.3.1"
   s.add_dependency "debugger-ruby_core_source", '~> 1.2.0'
-  s.add_dependency "debugger-linecache", '~> 1.1.1'
+  s.add_dependency "debugger-linecache", '~> 1.2.0'
   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'

data/ext/ruby_debug/192/ruby_debug.c

@@ -1787,8 +1787,13 @@ context_frame_id(int argc, VALUE *argv, VALUE self)
     frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
-    id = GET_FRAME->info.runtime.cfp->iseq->defined_method_id;
-    return id ? ID2SYM(id): Qnil;
+    rb_iseq_t *iseq = GET_FRAME->info.runtime.cfp->iseq;
+    if (iseq) {
+        id = iseq->defined_method_id;
+        return id ? ID2SYM(id): Qnil;
+    } else {
+        return Qnil;
+    }
 }
 
 /*
@@ -1815,7 +1820,7 @@ context_frame_line(int argc, VALUE *argv, VALUE self)
     cfp = GET_FRAME->info.runtime.cfp;
     while (cfp >= th->cfp)
     {
-        if ((cfp->iseq != NULL) && (pc >= cfp->iseq->iseq_encoded) && (pc < cfp->iseq->iseq_encoded + cfp->iseq->iseq_size))
+        if ((cfp->iseq) && (pc >= cfp->iseq->iseq_encoded) && (pc < cfp->iseq->iseq_encoded + cfp->iseq->iseq_size))
             return(INT2FIX(rb_vm_get_sourceline(cfp)));
         cfp = RUBY_VM_NEXT_CONTROL_FRAME(cfp);
     }
@@ -1839,7 +1844,12 @@ context_frame_file(int argc, VALUE *argv, VALUE self)
     frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
-    return(GET_FRAME->info.runtime.cfp->iseq->filename);
+    rb_iseq_t *iseq = GET_FRAME->info.runtime.cfp->iseq;
+    if (iseq) {
+        return iseq->filename;
+    } else {
+        return Qnil;
+    }
 }
 
 static int
@@ -2058,11 +2068,13 @@ context_frame_class(int argc, VALUE *argv, VALUE self)
 
     debug_frame = GET_FRAME;
 
-    cfp = debug_frame->info.runtime.cfp;
-
-    klass = real_class(cfp->iseq->klass);
-    if(TYPE(klass) == T_CLASS || TYPE(klass) == T_MODULE)
-        return klass;
+    rb_iseq_t *iseq = debug_frame->info.runtime.cfp->iseq;
+    if (iseq) {
+        klass = real_class(iseq->klass);
+        if (TYPE(klass) == T_CLASS || TYPE(klass) == T_MODULE) {
+            return klass;
+        }
+    }
     return Qnil;
 }
 

data/ext/ruby_debug/193/ruby_debug.c

@@ -1764,12 +1764,17 @@ context_frame_id(int argc, VALUE *argv, VALUE self)
     Data_Get_Struct(self, debug_context_t, debug_context);
 
     cfp = GET_FRAME->info.runtime.cfp;
+    rb_iseq_t *iseq = cfp->iseq;
+    if (iseq) {
 #if defined HAVE_RB_CONTROL_FRAME_T_METHOD_ID
-    frame_id = RUBYVM_CFUNC_FRAME_P(cfp) ? cfp->method_id : cfp->iseq->defined_method_id;
+        frame_id = RUBYVM_CFUNC_FRAME_P(cfp) ? cfp->method_id : cfp->iseq->defined_method_id;
 #elif defined HAVE_RB_METHOD_ENTRY_T_CALLED_ID
-    frame_id = RUBYVM_CFUNC_FRAME_P(cfp) ? cfp->me->called_id : cfp->iseq->defined_method_id;
+        frame_id = RUBYVM_CFUNC_FRAME_P(cfp) ? cfp->me->called_id : cfp->iseq->defined_method_id;
 #endif
-    return frame_id ? ID2SYM(frame_id) : Qnil;
+      return frame_id ? ID2SYM(frame_id) : Qnil;
+    } else {
+        return Qnil;
+    }
 }
 
 /*
@@ -1796,7 +1801,7 @@ context_frame_line(int argc, VALUE *argv, VALUE self)
     cfp = GET_FRAME->info.runtime.cfp;
     while (cfp >= th->cfp)
     {
-        if ((cfp->iseq != NULL) && (pc >= cfp->iseq->iseq_encoded) && (pc < cfp->iseq->iseq_encoded + cfp->iseq->iseq_size))
+        if ((cfp->iseq) && (pc >= cfp->iseq->iseq_encoded) && (pc < cfp->iseq->iseq_encoded + cfp->iseq->iseq_size))
             return(INT2FIX(rb_vm_get_sourceline(cfp)));
         cfp = RUBY_VM_NEXT_CONTROL_FRAME(cfp);
     }
@@ -1820,7 +1825,12 @@ context_frame_file(int argc, VALUE *argv, VALUE self)
     frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
-    return(GET_FRAME->info.runtime.cfp->iseq->filename);
+    rb_iseq_t *iseq = GET_FRAME->info.runtime.cfp->iseq;
+    if (iseq) {
+        return iseq->filename;
+    } else {
+        return Qnil;
+    }
 }
 
 static int

data/lib/debugger/test.rb

@@ -0,0 +1,6 @@
+require 'mocha/setup'
+require 'pathname'
+
+Debugger::Command.settings[:debuggertesting] = true
+# $debugger_test_dir must be specified, it should point to the test/ directory
+Dir.glob(File.expand_path("../test/*.rb", __FILE__)).each { |f| require f }

data/{test/support → lib/debugger/test}/mocha_extensions.rb

@@ -40,7 +40,7 @@ module Mocha
           message = UnexpectedInvocation.new(self, symbol, *arguments).to_s
           require 'mocha/mockery'
           message << Mockery.instance.mocha_inspect
-          raise ExpectationError.new(message, caller)
+          raise ExpectationError.new(message)
         end
       end
     end

data/lib/debugger/test/printer_helpers.rb

@@ -0,0 +1,8 @@
+module PrinterHelpers
+  def yaml_file_path(filename)
+    File.expand_path(
+      File.join($debugger_test_dir, "..", "lib", "ruby-debug", "printers", "texts", "#{filename}.yml"),
+      __FILE__
+    )
+  end
+end

data/{test/support → lib/debugger/test}/test_dsl.rb

@@ -1,7 +1,7 @@
 module TestDsl
   module Shared
     def fullpath(filename)
-      (Pathname.new(__FILE__) + "../../examples/#{filename}.rb").cleanpath.to_s
+      File.join($debugger_test_dir, "examples", "#{filename}.rb")
     end
   end
   include Shared
@@ -70,7 +70,7 @@ module TestDsl
       end
     end
     Debugger.start do
-      load fullpath(filename)
+      Debugger.debug_load(fullpath(filename))
       debug_completed = true
     end
     flunk "Debug block was not completed" unless debug_completed
@@ -114,6 +114,10 @@ module TestDsl
     state.context
   end
 
+  def binding
+    context.frame_binding(state.frame_pos)
+  end
+
   def breakpoint
     Debugger.breakpoints.first
   end
@@ -161,6 +165,22 @@ module TestDsl
     end
   end
 
+  def pi
+    puts
+    puts "Output Queue:"
+    puts interface.output_queue.join("")
+    puts
+    puts "Error Queue:"
+    puts interface.error_queue.join("")
+    puts
+    puts "Confirm Queue:"
+    puts interface.confirm_queue.join("")
+    puts
+    puts "Print Queue:"
+    puts interface.print_queue.join("")
+    puts
+  end
+
   module ClassMethods
     include Shared
 

data/{test/support → lib/debugger/test}/test_interface.rb

@@ -44,6 +44,10 @@ class TestInterface < Debugger::Interface
   def close
   end
 
+  def empty?
+    [input_queue, output_queue, error_queue, confirm_queue, print_queue].all?(&:empty?)
+  end
+
   def inspect
     [
       "input_queue: #{input_queue.inspect}",

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.4.0'
+  VERSION = '1.5.0'
 end

data/lib/ruby-debug.rb

@@ -4,6 +4,7 @@ require 'socket'
 require 'thread'
 require 'ruby-debug-base'
 require 'ruby-debug/processor'
+Dir.glob(File.expand_path("../ruby-debug/printers/**/*.rb", __FILE__)).each { |f| require f }
 
 module Debugger
   self.handler = CommandProcessor.new
@@ -35,13 +36,14 @@ module Debugger
     # if the call stack is truncated.
     attr_accessor :start_sentinal
 
+    attr_accessor :printer
+
     attr_reader :thread, :control_thread, :cmd_port, :ctrl_port
 
     def interface=(value) # :nodoc:
       handler.interface = value
     end
 
-    #
     # Starts a remote debugger.
     #
     def start_remote(host = nil, port = PORT)
@@ -150,6 +152,7 @@ module Debugger
       processor.process_commands(verbose)
     end
   end
+  self.printer ||= Printers::Plain.new
 end
 
 module Kernel

data/lib/ruby-debug/command.rb

@@ -1,4 +1,5 @@
 require 'columnize'
+require 'forwardable'
 require 'ruby-debug/helper'
 
 module Debugger
@@ -11,6 +12,11 @@ module Debugger
 
     include Columnize
 
+    extend Forwardable
+    def_delegator :"Debugger.printer", :print, :pr
+    def_delegator :"Debugger.printer", :print_collection, :prc
+    def_delegator :"Debugger.printer", :print_variables, :prv
+
     # Find param in subcmds. param id downcased and can be abbreviated
     # to the minimum length listed in the subcommands
     def find(subcmds, param)
@@ -164,23 +170,29 @@ module Debugger
       @state.print(*args)
     end
 
+    def print_debug(*args)
+      @state.print_debug(*args)
+    end
+
     def confirm(msg)
       @state.confirm(msg) == 'y'
     end
 
+    # TODO: Add optional timeout
     def debug_eval(str, b = get_binding)
       begin
         val = eval(str, b)
       rescue StandardError, ScriptError => e
-        if Command.settings[:stack_trace_on_error]
+        text_message = if Command.settings[:stack_trace_on_error]
           at = eval("caller(1)", b)
-          print "%s:%s\n", at.shift, e.to_s.sub(/\(eval\):1:(in `.*?':)?/, '')
-          for i in at
-            print "\tfrom %s\n", i
-          end
+          backtraces = []
+          backtraces << "#{at.shift}:#{e.to_s.sub(/\(eval\):1:(in `.*?':)?/, '')}"
+          backtraces += at.map { |i| "\tfrom #{i}" }
+          backtraces.join("\n")
         else
-          print "#{e.class} Exception: #{e.message}\n"
+          "#{e.class} Exception: #{e.message}\n"
         end
+        errmsg pr("eval.exception", text_message: text_message, class: e.class, value: e.to_s)
         throw :debug_error
       end
     end

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

@@ -3,7 +3,7 @@ module Debugger
   # Implements debugger "break" command.
   class AddBreakpoint < Command
     self.allow_in_control = true
-    
+
     def regexp
       / ^\s*
         b(?:reak)?
@@ -13,18 +13,22 @@ module Debugger
       /x
     end
 
+    def pr(path, *args)
+      super("breakpoints.#{path}", *args)
+    end
+
     def execute
       if @match[1]
         line, _, _, expr = @match.captures
       else
         _, file, line, expr = @match.captures
       end
-      if expr 
+      if expr
         if expr !~ /^\s*if\s+(.+)/
           if file or line
-            errmsg "Expecting 'if' in breakpoint condition; got: #{expr}.\n"
+            errmsg pr("errors.if", expr: expr)
           else
-            errmsg "Invalid breakpoint location: #{expr}.\n"
+            errmsg pr("errors.location", expr: expr)
           end
           return
         else
@@ -35,12 +39,12 @@ module Debugger
       brkpt_filename = nil
       if file.nil?
         unless @state.context
-          errmsg "We are not in a state that has an associated file.\n"
-          return 
+          errmsg pr("errors.state_add")
+          return
         end
         brkpt_filename = @state.file
         file = File.basename(@state.file)
-        if line.nil? 
+        if line.nil?
           # Set breakpoint at current line
           line = @state.line.to_s
         end
@@ -50,7 +54,7 @@ module Debugger
         if klass && klass.kind_of?(Module)
           class_name = klass.name if klass
         else
-          errmsg "Unknown class #{file}.\n"
+          errmsg pr("errors.class", file: file)
           throw :debug_error
         end
       else
@@ -59,38 +63,34 @@ module Debugger
         File::ALT_SEPARATOR && file.index(File::ALT_SEPARATOR)
         brkpt_filename = file
       end
-      
+
       if line =~ /^\d+$/
         line = line.to_i
         if LineCache.cache(brkpt_filename, Command.settings[:reload_source_on_change])
           last_line = LineCache.size(brkpt_filename)
           if line > last_line
-            errmsg("There are only %d lines in file \"%s\".\n", last_line, file) 
-            return
-          end
-          unless LineCache.trace_line_numbers(brkpt_filename).member?(line)
-            errmsg("Line %d is not a stopping point in file \"%s\".\n", line, file) 
+            errmsg pr("errors.far_line", lines: last_line, file: file)
             return
           end
         else
-          errmsg("No source file named %s\n" % file)
-          return unless confirm("Set breakpoint anyway? (y/n) ")
+          errmsg pr("errors.source", file: file)
+          return unless confirm(pr("confirmations.set_breakpoint"))
         end
 
-        unless @state.context
-          errmsg "We are not in a state we can add breakpoints.\n"
-          return 
+        if file.nil? && !@state.context
+          errmsg pr("errors.state")
+          return
         end
         b = Debugger.add_breakpoint brkpt_filename, line, expr
-        print "Breakpoint %d file %s, line %s\n", b.id, brkpt_filename, line.to_s
+        print pr("set_breakpoint_to_line", id: b.id, file: brkpt_filename, line: line)
         unless syntax_valid?(expr)
-          errmsg("Expression \"#{expr}\" syntactically incorrect; breakpoint disabled.\n")
+          errmsg pr("errors.expression", expr: expr)
           b.enabled = false
         end
       else
         method = line.intern.id2name
         b = Debugger.add_breakpoint class_name, method, expr
-        print "Breakpoint %d at %s::%s\n", b.id, class_name, method.to_s
+        print pr("set_breakpoint_to_method", id: b.id, class: class_name, method: method)
       end
     end
 
@@ -118,21 +118,19 @@ module Debugger
     end
 
     def execute
-      unless @state.context
-        errmsg "We are not in a state we can delete breakpoints.\n"
-        return 
-      end
       brkpts = @match[1]
       unless brkpts
-        if confirm("Delete all breakpoints? (y or n) ")
+        if confirm(pr("breakpoints.confirmations.delete_all"))
           Debugger.breakpoints.clear
         end
       else
         brkpts.split(/[ \t]+/).each do |pos|
           pos = get_int(pos, "Delete", 1)
           return unless pos
-          unless Debugger.remove_breakpoint(pos)
-            errmsg "No breakpoint number %d\n", pos
+          if Debugger.remove_breakpoint(pos)
+            print pr("breakpoints.delete", id: pos)
+          else
+            errmsg pr("breakpoints.errors.no_breakpoint", id: pos)
           end
         end
       end