debugger 1.0.1 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.1.0
+* Point to new debugger-ruby_core_source API
+* General cleanup
+* fix rdebug version
+
 ## 1.0.1
 * Fix ruby-debug not being loaded from debugger.rb
 

data/README.md

@@ -14,15 +14,15 @@ For Windows install instructions, see OLD\_README.
 
 ## Usage
 
-To use in your Rails app, drop in your Gemfile:
-
-    gem 'debugger'
-
 Wherever you need a debugger, simply:
 ```ruby
 require 'debugger'; debugger
 ```
 
+To use in your Rails app, drop in your Gemfile:
+
+    gem 'debugger'
+
 ## Reason for Fork
 
 * ruby-debug19 maintainer isn't maintaining:
@@ -37,16 +37,20 @@ require 'debugger'; debugger
 
 ## What's different from ruby-debug19
 
-* Works on 1.9.2 and 1.9.3
-  * 1.9.2 points to ruby-debug-base19-0.11.25 headers
-  * 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
-* Tests are up on travis-ci
-* The gem name matches the module namespace, Debugger, and main required file, debugger.
-* Rake tasks have been updated
-* ruby-debug-base19 and ruby-debug19 are released as one gem
-* No downloading ruby source during install - was behavior of old ruby_core_source dependency
-* Fix LocalJumpError caused by using proc in extconf.rb
+* Major
+  * Works on 1.9.2 and 1.9.3
+    * 1.9.2 points to ruby-debug-base19-0.11.25 headers
+    * 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
+  * Passing tests are up on travis-ci
+* 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
 
 ## Issues
 Please report them [on github](http://github.com/cldwalker/debugger/issues).
@@ -65,4 +69,3 @@ Let's keep this working for the ruby community!
 
 * Fix test/test-*.rb
 * Work with others willing to tackle jruby, rubinius or windows support
-* Clean up (merge) lib + cli as separate runtime paths for ruby-debug-base19 and ruby-debug19

data/bin/rdebug

@@ -2,7 +2,7 @@
 
 #=== Summary
 #
-#A command-line front-end to the Ruby debugger, <tt>ruby-debug</tt>, the
+#A command-line front-end to the Ruby debugger, <tt>debugger</tt>, the
 #Fast Ruby Debugger.
 #
 #Command invocation:
@@ -104,7 +104,7 @@
 
 require 'optparse'
 require 'ostruct'
-require 'ruby-debug'
+require 'debugger'
 
 def debug_program(options)
   # Make sure Ruby script syntax checks okay.
@@ -225,7 +225,7 @@ EOB
     opts.on('-r', '--require SCRIPT', String,
             'Require the library, before executing your script') do |name|
       if name == 'debug'
-        puts "ruby-debug is not compatible with Ruby's 'debug' library. This option is ignored."
+        puts "debugger is not compatible with Ruby's 'debug' library. This option is ignored."
       else
         require name
       end
@@ -262,7 +262,7 @@ EOB
     end
     opts.on_tail('--version',
                  'Print the version') do
-      puts "ruby-debug #{Debugger::VERSION}"
+      puts "debugger #{Debugger::VERSION}"
       exit
     end
     opts.on('--verbose', 'Turn on verbose mode') do
@@ -271,7 +271,7 @@ EOB
     end
     opts.on_tail('-v',
                  'Print version number, then turn on verbose mode') do
-      puts "ruby-debug #{Debugger::VERSION}"
+      puts "debugger #{Debugger::VERSION}"
       $VERBOSE = true
     end
   end

data/debugger.gemspec

@@ -20,8 +20,8 @@ handling, bindings for stack frames among other things.
   s.extensions << "ext/ruby_debug/extconf.rb"
   s.executables = ["rdebug"]
   s.add_dependency "columnize", ">= 0.3.1"
-  s.add_dependency "debugger-ruby_core_source"
-  s.add_dependency "debugger-linecache"
+  s.add_dependency "debugger-ruby_core_source", '~> 1.1'
+  s.add_dependency "debugger-linecache", '~> 1.1'
   s.add_development_dependency 'rake', '~> 0.9.2.2'
   s.add_development_dependency 'rake-compiler', '~> 0.8.0'
 end

data/ext/ruby_debug/extconf.rb

@@ -10,7 +10,7 @@ elsif bindir =~ %r{(^.*/\.rvm/rubies)/([^/]+)/bin$}
 end
 
 require "mkmf"
-require "ruby_core_source"
+require "debugger/ruby_core_source"
 require 'fileutils'
 
 if RUBY_VERSION < "1.9"
@@ -55,7 +55,7 @@ current_dir = File.dirname(__FILE__)
 end
 
 dir_config("ruby")
-if !Ruby_core_source::create_makefile_with_core(hdrs, "ruby_debug")
+if !Debugger::RubyCoreSource.create_makefile_with_core(hdrs, "ruby_debug")
   STDERR.print("Makefile creation failed\n")
   STDERR.print("*************************************************************\n\n")
   STDERR.print("  NOTE: If your headers were not found, try passing\n")

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.0.1'
+  VERSION = '1.1.0'
 end

data/lib/ruby-debug.rb

@@ -3,11 +3,11 @@ require 'stringio'
 require 'socket'
 require 'thread'
 require 'ruby-debug-base'
-require_relative 'ruby-debug/processor'
+require 'ruby-debug/processor'
 
 module Debugger
   self.handler = CommandProcessor.new
-  
+
   # the port number used for remote debugging
   PORT = 8989 unless defined?(PORT)
 
@@ -16,31 +16,31 @@ module Debugger
     if RUBY_PLATFORM =~ /mswin/
       # Of course MS Windows has to be different
       INITFILE = 'rdebug.ini'
-      HOME_DIR =  (ENV['HOME'] || 
+      HOME_DIR =  (ENV['HOME'] ||
                    ENV['HOMEDRIVE'].to_s + ENV['HOMEPATH'].to_s).to_s
     else
       INITFILE = '.rdebugrc'
       HOME_DIR = ENV['HOME'].to_s
     end
   end
-  
+
   class << self
     # gdb-style annotation mode. Used in GNU Emacs interface
     attr_accessor :annotate
 
-    # in remote mode, wait for the remote connection 
+    # in remote mode, wait for the remote connection
     attr_accessor :wait_connection
 
     # If set, a string to look for in caller() and is used to see
     # if the call stack is truncated.
-    attr_accessor :start_sentinal 
-    
+    attr_accessor :start_sentinal
+
     attr_reader :thread, :control_thread
 
     def interface=(value) # :nodoc:
       handler.interface = value
     end
-    
+
     #
     # Starts a remote debugger.
     #
@@ -57,12 +57,12 @@ module Debugger
       end
 
       start_control(host, ctrl_port)
-      
+
       yield if block_given?
-      
+
       mutex = Mutex.new
       proceed = ConditionVariable.new
-      
+
       @thread = DebugThread.new do
         server = TCPServer.new(host, cmd_port)
         while (session = server.accept)
@@ -77,11 +77,11 @@ module Debugger
       if wait_connection
         mutex.synchronize do
           proceed.wait(mutex)
-        end 
+        end
       end
     end
     alias start_server start_remote
-    
+
     def start_control(host = nil, ctrl_port = PORT + 1) # :nodoc:
       return if defined?(@control_thread) && @control_thread
       @control_thread = DebugThread.new do
@@ -93,7 +93,7 @@ module Debugger
         end
       end
     end
-    
+
     #
     # Connects to the remote debugger
     #
@@ -102,10 +102,10 @@ module Debugger
       interface = Debugger::LocalInterface.new
       socket = TCPSocket.new(host, port)
       puts "Connected."
-      
+
       catch(:exit) do
         while (line = socket.gets)
-          case line 
+          case line
           when /^PROMPT (.*)$/
             input = interface.read_command($1)
             throw :exit unless input
@@ -121,7 +121,7 @@ module Debugger
       end
       socket.close
     end
-    
+
     # Runs normal debugger initialization scripts
     # Reads and executes the commands from init file (if any) in the
     # current working directory.  This is only done if the current
@@ -134,7 +134,7 @@ module Debugger
       run_script(cwd_script_file, out) if File.exists?(cwd_script_file)
 
       home_script_file = File.expand_path(File.join(HOME_DIR, INITFILE))
-      run_script(home_script_file, out) if File.exists?(home_script_file) and 
+      run_script(home_script_file, out) if File.exists?(home_script_file) and
         cwd_script_file != home_script_file
     end
 

data/lib/ruby-debug/command.rb

@@ -1,5 +1,5 @@
 require 'columnize'
-require_relative 'helper'
+require 'ruby-debug/helper'
 
 module Debugger
   RUBY_DEBUG_DIR = File.expand_path(File.dirname(__FILE__)) unless

data/lib/ruby-debug/processor.rb

@@ -1,5 +1,5 @@
-require_relative 'interface'
-require_relative 'command'
+require 'ruby-debug/interface'
+require 'ruby-debug/command'
 
 module Debugger
 
@@ -11,12 +11,12 @@ module Debugger
     def afmt(msg, newline="\n")
       "\032\032#{msg}#{newline}"
     end
-    
+
     def aprint(msg)
       print afmt(msg) if Debugger.annotate.to_i > 2
     end
 
-    # FIXME: use delegate? 
+    # FIXME: use delegate?
     def errmsg(*args)
       @interface.errmsg(*args)
     end
@@ -30,7 +30,7 @@ module Debugger
     def print(*args)
       @interface.print(*args)
     end
-    
+
   end
 
   class CommandProcessor < Processor # :nodoc:
@@ -38,12 +38,12 @@ module Debugger
 
     # FIXME: get from Command regexp method.
     @@Show_breakpoints_postcmd = [
-                                  /^\s*b(?:reak)?/, 
+                                  /^\s*b(?:reak)?/,
                                   /^\s* cond(?:ition)? (?:\s+(\d+)\s*(.*))?$/ix,
                                   /^\s*del(?:ete)?(?:\s+(.*))?$/ix,
                                   /^\s* dis(?:able)? (?:\s+(.*))?$/ix,
                                   /^\s* en(?:able)? (?:\s+(.*))?$/ix,
-                                  # "tbreak", "clear", 
+                                  # "tbreak", "clear",
                                  ]
     @@Show_annotations_run     = [
                                   /^\s*c(?:ont(?:inue)?)?(?:\s+(.*))?$/,
@@ -57,11 +57,11 @@ module Debugger
                                   /^\s* f(?:rame)? (?:\s+ (.*))? \s*$/x,
                                   /^\s* u(?:p)? (?:\s+(.*))?$/x
                                  ]
-    
+
     def initialize(interface = LocalInterface.new)
       @interface = interface
       @display = []
-      
+
       @mutex = Mutex.new
       @last_cmd = nil
       @last_file = nil   # Filename the last time we stopped
@@ -70,22 +70,22 @@ module Debugger
       @debugger_displays_were_empty = true # No display 1st time
       @debugger_context_was_dead = true # Assume we haven't started.
     end
-    
+
     def interface=(interface)
       @mutex.synchronize do
         @interface.close if @interface
         @interface = interface
       end
     end
-    
+
     require 'pathname'  # For cleanpath
-    
-    # Regularize file name. 
-    # This is also used as a common funnel place if basename is 
-    # desired or if we are working remotely and want to change the 
+
+    # Regularize file name.
+    # This is also used as a common funnel place if basename is
+    # desired or if we are working remotely and want to change the
     # basename. Or we are eliding filenames.
     def self.canonic_file(filename)
-      # For now we want resolved filenames 
+      # For now we want resolved filenames
       if Command.settings[:basename]
         File.basename(filename)
       else
@@ -95,7 +95,7 @@ module Debugger
     end
 
     def self.print_location_and_text(file, line)
-      file_line = "%s:%s\n%s" % [canonic_file(file), line, 
+      file_line = "%s:%s\n%s" % [canonic_file(file), line,
                                  Debugger.line_at(file, line)]
       # FIXME: use annotations routines
       if Debugger.annotate.to_i > 2
@@ -105,7 +105,7 @@ module Debugger
       end
       print file_line
     end
-  
+
     def self.protect(mname)
       alias_method "__#{mname}", mname
       module_eval %{
@@ -124,7 +124,7 @@ module Debugger
         end
       }
     end
-    
+
     def at_breakpoint(context, breakpoint)
       aprint 'stopped' if Debugger.annotate.to_i > 2
       n = Debugger.breakpoints.index(breakpoint) + 1
@@ -136,7 +136,7 @@ module Debugger
       print "Breakpoint %d at %s:%s\n", n, file, line
     end
     protect :at_breakpoint
-    
+
     def at_catchpoint(context, excpt)
       aprint 'stopped' if Debugger.annotate.to_i > 2
       file = CommandProcessor.canonic_file(context.frame_file(0))
@@ -152,13 +152,13 @@ module Debugger
       end
     end
     protect :at_catchpoint
-    
+
     def at_tracing(context, file, line)
-      return if defined?(Debugger::RDEBUG_FILE) && 
+      return if defined?(Debugger::RDEBUG_FILE) &&
         Debugger::RDEBUG_FILE == file # Don't trace ourself
       @last_file = CommandProcessor.canonic_file(file)
       file = CommandProcessor.canonic_file(file)
-      unless file == @last_file and @last_line == line and 
+      unless file == @last_file and @last_line == line and
           Command.settings[:tracing_plus]
         print "Tracing(%d):%s:%s %s",
         context.thnum, file, line, Debugger.line_at(file, line)
@@ -173,18 +173,18 @@ module Debugger
       process_commands(context, file, line)
     end
     protect :at_line
-    
+
     def at_return(context, file, line)
       context.stop_frame = -1
       process_commands(context, file, line)
     end
-    
+
     private
 
     # The prompt shown before reading a command.
     def prompt(context)
       p = '(rdb:%s) ' % (context.dead?  ? 'post-mortem' : context.thnum)
-      p = afmt("pre-prompt")+p+"\n"+afmt("prompt") if 
+      p = afmt("pre-prompt")+p+"\n"+afmt("prompt") if
         Debugger.annotate.to_i > 2
       return p
     end
@@ -197,7 +197,7 @@ module Debugger
       event_cmds = Command.commands.select{|cmd| cmd.event }
 
       # Remove some commands in post-mortem
-      event_cmds = event_cmds.find_all do |cmd| 
+      event_cmds = event_cmds.find_all do |cmd|
         cmd.allow_in_post_mortem
       end if context.dead?
 
@@ -211,11 +211,11 @@ module Debugger
         s.commands = event_cmds
       end
       @interface.state = state if @interface.respond_to?('state=')
-      
+
       # Bind commands to the current state.
       commands = event_cmds.map{|cmd| cmd.new(state)}
 
-      commands.select do |cmd| 
+      commands.select do |cmd|
         cmd.class.always_run >= run_level
       end.each {|cmd| cmd.execute}
       return state, commands
@@ -240,10 +240,10 @@ module Debugger
           m
         end
       end
-      
+
       preloop(commands, context)
       CommandProcessor.print_location_and_text(file, line)
-      while !state.proceed? 
+      while !state.proceed?
         input = if @interface.command_queue.empty?
                   @interface.read_command(prompt(context))
                 else
@@ -265,7 +265,7 @@ module Debugger
       end
       postloop(commands, context)
     end # process_commands
-    
+
     def one_cmd(commands, context, input)
       if cmd = commands.find{ |c| c.match(input) }
         if context.dead? && cmd.class.need_context
@@ -283,14 +283,14 @@ module Debugger
         end
       end
     end
-    
+
     def preloop(commands, context)
       aprint('stopped') if Debugger.annotate.to_i > 2
       if context.dead?
         unless @debugger_context_was_dead
           if Debugger.annotate.to_i > 2
-            aprint('exited') 
-            print "The program finished.\n" 
+            aprint('exited')
+            print "The program finished.\n"
           end
           @debugger_context_was_dead = true
         end
@@ -307,7 +307,7 @@ module Debugger
           context.dead?
       end
     end
-    
+
     def postcmd(commands, context, cmd)
       if Debugger.annotate.to_i > 0
         cmd = @last_cmd unless cmd
@@ -315,7 +315,7 @@ module Debugger
           @@Show_breakpoints_postcmd.find{|pat| cmd =~ pat}
         display_annotations(commands, context)
         if @@Show_annotations_postcmd.find{|pat| cmd =~ pat}
-          annotation('stack', commands, context, "where") if 
+          annotation('stack', commands, context, "where") if
             context.stack_size > 0
           annotation('variables', commands, context, "info variables") unless
             context.dead?
@@ -340,14 +340,14 @@ module Debugger
 
     def breakpoint_annotations(commands, context)
       unless Debugger.breakpoints.empty? and @debugger_breakpoints_were_empty
-        annotation('breakpoints', commands, context, "info breakpoints") 
+        annotation('breakpoints', commands, context, "info breakpoints")
         @debugger_breakpoints_were_empty = Debugger.breakpoints.empty?
       end
     end
 
     def display_annotations(commands, context)
       return if display.empty?
-#       have_display = display.find{|d| d[0]} 
+#       have_display = display.find{|d| d[0]}
 #       return unless have_display and @debugger_displays_were_empty
 #       @debugger_displays_were_empty = have_display
       annotation('display', commands, context, "display")
@@ -366,7 +366,7 @@ module Debugger
         yield self
       end
 
-      # FIXME: use delegate? 
+      # FIXME: use delegate?
       def errmsg(*args)
         @interface.errmsg(*args)
       end
@@ -388,25 +388,25 @@ module Debugger
       end
     end
   end
-  
+
   class ControlCommandProcessor < Processor # :nodoc:
     def initialize(interface)
       super()
       @interface = interface
       @debugger_context_was_dead = true # Assume we haven't started.
     end
-    
+
     def process_commands(verbose=false)
-      control_cmds = Command.commands.select do |cmd| 
-        cmd.allow_in_control 
+      control_cmds = Command.commands.select do |cmd|
+        cmd.allow_in_control
       end
       state = State.new(@interface, control_cmds)
       commands = control_cmds.map{|cmd| cmd.new(state) }
 
       unless @debugger_context_was_dead
         if Debugger.annotate.to_i > 2
-          aprint 'exited'  
-          print "The program finished.\n" 
+          aprint 'exited'
+          print "The program finished.\n"
         end
         @debugger_context_was_dead = true
       end
@@ -433,34 +433,34 @@ module Debugger
     # Note: have an unused 'context' parameter to match the local interface.
     def prompt(context)
       p = '(rdb:ctrl) '
-      p = afmt("pre-prompt")+p+"\n"+afmt("prompt") if 
+      p = afmt("pre-prompt")+p+"\n"+afmt("prompt") if
         Debugger.annotate.to_i > 2
       return p
     end
 
     class State # :nodoc:
       attr_reader :commands, :interface
-      
+
       def initialize(interface, commands)
         @interface = interface
         @commands = commands
       end
-      
+
       def proceed
       end
-      
+
       def errmsg(*args)
         @interface.print(*args)
       end
-      
+
       def print(*args)
         @interface.print(*args)
       end
-      
+
       def confirm(*args)
         'y'
       end
-      
+
       def context
         nil
       end