byebug 0.0.1 → 1.0.0

data/lib/byebug/commands/catchpoint.rb

@@ -1,6 +1,6 @@
 module Byebug
 
-  class CatchCommand < Command # :nodoc:
+  class CatchCommand < Command
     self.allow_in_control = true
 
     def regexp

data/lib/byebug/commands/control.rb

@@ -28,7 +28,7 @@ module Byebug
           print "Ruby program #{Byebug::PROG_SCRIPT} not executable... " \
                 "We'll add a call to Ruby.\n"
           ruby = begin defined?(Gem) ? Gem.ruby : "ruby" rescue "ruby" end
-          rdebug_script = "#{ruby} -I#{$:.join(' -I')} #{prog_script}"
+          rdebug_script = "#{ruby} -I#{$:.join(' -I')} #{Byebug::PROG_SCRIPT}"
         else
           rdebug_script = Byebug::PROG_SCRIPT
         end
@@ -52,11 +52,9 @@ module Byebug
           argv = Command.settings[:argv]
         end
       end
-      args = argv.join(' ')
+      cmd = "#{rdebug_script} #{argv.compact.join(' ')}"
 
       # An execv would be preferable to the "exec" below.
-      cmd = "#{rdebug_script} #{args}"
-      p "cmd: #{cmd}"
       print "Re exec'ing:\n\t#{cmd}\n"
       exec cmd
     rescue Errno::EOPNOTSUPP

data/lib/byebug/commands/finish.rb

@@ -1,6 +1,6 @@
 module Byebug
 
-  # Implements the byebug 'finish' command.
+  # Implements byebug's 'finish' command.
   class FinishCommand < Command
     self.allow_in_post_mortem = false
     self.need_context         = true

data/lib/byebug/commands/frame.rb

@@ -1,7 +1,7 @@
 module Byebug
 
   # Mix-in module to assist in command parsing.
-  module FrameFunctions # :nodoc:
+  module FrameFunctions
 
     def adjust_frame(frame_pos, absolute, context=@state.context)
       @state.frame_pos = 0 if context != @state.context
@@ -33,7 +33,6 @@ module Byebug
       print_frame(@state.frame_pos, true)
     end
 
-    # XXX: Implement args and locals for this to be used...
     def get_frame_call(prefix, pos, context)
       id = context.frame_method(pos)
       klass = context.frame_class(pos)
@@ -92,23 +91,22 @@ module Byebug
         end
       end
 
-      frame_num = "#%d " % pos
-      #call_str = get_frame_call(frame_num, pos, context)
-      file_line = "at line %s:%d\n" % [CommandProcessor.canonic_file(file), line]
+      frame_num = "##{pos}"
+      call_str = get_frame_call(frame_num, pos, context)
+      file_line = "at line #{CommandProcessor.canonic_file(file)}:#{line}\n"
       print frame_num
-      #unless call_str.empty?
-      #  print call_str
-      #  print ' '
-      #  if call_str.size + frame_num.size + file_line.size > self.class.settings[:width]
-      #    print "\n       "
-      #  end
-      #end
-      print file_line
-      if ENV['EMACS'] && adjust
-        fmt = (Byebug.annotate.to_i > 1 ?
-               "\032\032source %s:%d\n" : "\032\032%s:%d\n")
-        print fmt % [CommandProcessor.canonic_file(file), line]
+      unless call_str.empty?
+        print call_str
+        if call_str.size + frame_num.size + file_line.size > self.class.settings[:width]
+          print "\n       "
+        end
       end
+      print file_line
+      #if ENV['EMACS'] && adjust
+      #  fmt = (Byebug.annotate.to_i > 1 ?
+      #         "\032\032source %s:%d\n" : "\032\032%s:%d\n")
+      #  print fmt % [CommandProcessor.canonic_file(file), line]
+      #end
     end
 
     # Check if call stack is truncated.  This can happen if

data/lib/byebug/commands/info.rb

@@ -1,16 +1,15 @@
 module Byebug
-  module InfoFunctions # :nodoc:
+
+  module InfoFunctions
     def info_catch(*args)
       unless @state.context
         print "No frame selected.\n"
         return
       end
       if Byebug.catchpoints and not Byebug.catchpoints.empty?
-        # FIXME: show whether Exception is valid or not
-        # print "Exception: is_a?(Class)\n"
         Byebug.catchpoints.each do |exception, hits|
-          # print "#{exception}: #{exception.is_a?(Class)}\n"
-           print "#{exception}\n"
+          print "#{exception}: #{exception.is_a?(Class)}\n"
+          #print "#{exception}\n"
         end
       else
         print "No exceptions set to be caught.\n"
@@ -24,15 +23,15 @@ module Byebug
     Subcommands =
       [
        ['args', 1, 'Argument variables of current stack frame'],
-       ['breakpoints', 1, 'Status of user-settable breakpoints','
-Without argument, list info about all breakpoints.  With an integer argument,
-list info on that breakpoint.'],
+       ['breakpoints', 1, 'Status of user-settable breakpoints',
+        'Without argument, list info about all breakpoints.  With an integer ' \
+        'argument, list info on that breakpoint.'],
        ['catch', 3, 'Exceptions that can be caught in the current stack frame'],
        ['display', 2, 'Expressions to display when program stops'],
-       ['file', 4, 'Info about a particular file read in','
-After the file name is supplied, you can list file attributes that you wish to
-see. Attributes include: "all", "basic", "breakpoint", "lines", "mtime", "path"
-and "sha1".'],
+       ['file', 4, 'Info about a particular file read in',
+        'After the file name is supplied, you can list file attributes that ' \
+        'you wish to see. Attributes include: "all", "basic", "breakpoint", ' \
+        '"lines", "mtime", "path" and "sha1".'],
        ['files', 5, 'File names and timestamps of files read in'],
        ['global_variables', 2, 'Global variables'],
        ['instance_variables', 2,
@@ -42,16 +41,18 @@ and "sha1".'],
        ['locals', 2, 'Local variables of the current stack frame'],
        ['program', 2, 'Execution status of the program'],
        ['stack', 2, 'Backtrace of the stack'],
-#      ['thread', 6,  'List info about thread NUM', '
-#If no thread number is given, we list info for all threads. \'terse\' and
-#\'verbose\' options are possible. If \'terse\', just give summary thread name
-#information. See "help info threads" for more detail about this summary
-#information. If \'verbose\' appended to the end of the command, then the entire
-#stack trace is given for each thread.'],
-#       ['threads', 7, 'information of currently-known threads', '
-#This information includes whether the thread is the current thread (+), is
-#suspended ($) or is ignored (!), plus the thread number and the top stack item.
-#If \'verbose\' is given then the entire stack frame is shown.'],
+#      ['thread', 6,  'List info about thread NUM',
+#       'If no thread number is given, we list info for all threads. '         \
+#       '\'terse\' and \'verbose\' options are possible. If \'terse\', just '  \
+#       'give summary thread name information. See "help info threads" for '   \
+#       'more detail about this summary information. If \'verbose\' appended ' \
+#       'to the end of the command, then the entire stack trace is given for ' \
+#       'each thread.'],
+#      ['threads', 7, 'information of currently-known threads',
+#       'This information includes whether the thread is the current thread ' \
+#       '(+), it\'s suspended ($) or it\'s ignored (!), plus the thread '     \
+#       'number and the top stack item. If \'verbose\' is given then the '    \
+#       'entire stack frame is shown.'],
        ['variables', 1,
         'Local and instance variables of the current stack frame']
       ].map do |name, min, short_help, long_help|
@@ -60,11 +61,11 @@ and "sha1".'],
 
     InfoFileSubcommands =
       [
-       ['all', 1, 'All file information available - breakpoints, lines, mtime,
-path and sha1'],
+       ['all', 1, 'All file information available - breakpoints, lines, mtime' \
+         ', path and sha1'],
        ['basic', 2, 'basic information - path, number of lines'],
-       ['breakpoints', 2, 'Show trace line numbers', '
-These are the line number where a breakpoint can be set.'],
+       ['breakpoints', 2, 'Show trace line numbers',
+        'These are the line number where a breakpoint can be set.'],
        ['lines', 1, 'Show number of lines in the file'],
        ['mtime', 1, 'Show modification time of file'],
        ['path', 4, 'Show full file path name for file'],
@@ -197,7 +198,7 @@ These are the line number where a breakpoint can be set.'],
         LineCache::cache(file, Command.settings[:reload_source_on_change])
       end
 
-      print "File %s", file
+      print "File #{file}"
       path = LineCache.path(file)
       if %w(all basic path).member?(subcmd.name) and path != file
         print " - %s\n", path
@@ -390,7 +391,7 @@ These are the line number where a breakpoint can be set.'],
       end
       obj = debug_eval('self')
       locals = @state.context.frame_locals(@state.frame_pos)
-      locals['self'] = @state.context.frame_self(@state.frame_pos)
+      locals[:self] = @state.context.frame_self(@state.frame_pos)
       locals.keys.sort.each do |name|
         next if name =~ /^__dbg_/ # skip byebug pollution
         ### FIXME: make a common routine

data/lib/byebug/commands/irb.rb

@@ -1,18 +1,19 @@
 require 'irb'
 
-module IRB # :nodoc:
-  module ExtendCommand # :nodoc:
-    class Continue # :nodoc:
+module IRB
+
+  module ExtendCommand
+    class Continue
       def self.execute(conf)
         throw :IRB_EXIT, :cont
       end
     end
-    class Next # :nodoc:
+    class Next
       def self.execute(conf)
         throw :IRB_EXIT, :next
       end
     end
-    class Step # :nodoc:
+    class Step
       def self.execute(conf)
         throw :IRB_EXIT, :step
       end
@@ -21,7 +22,7 @@ module IRB # :nodoc:
   ExtendCommandBundle.def_extend_command "cont", :Continue
   ExtendCommandBundle.def_extend_command "n", :Next
   ExtendCommandBundle.def_extend_command "step", :Step
-  
+
   def self.start_session(binding)
     unless @__initialized
       args = ARGV.dup
@@ -30,7 +31,7 @@ module IRB # :nodoc:
       ARGV.replace(args)
       @__initialized = true
     end
-    
+
     workspace = WorkSpace.new(binding)
 
     irb = Irb.new(workspace)
@@ -44,12 +45,13 @@ module IRB # :nodoc:
   end
 end
 
+
 module Byebug
 
-  # Implements byebug "irb" command.
+  # Implements byebug's "irb" command.
   class IRBCommand < Command
 
-    register_setting_get(:autoirb) do 
+    register_setting_get(:autoirb) do
       IRBCommand.always_run
     end
     register_setting_set(:autoirb) do |value|
@@ -61,7 +63,7 @@ module Byebug
         (?:\s+(-d))?
         \s*$/x
     end
-    
+
     def execute
       unless @state.interface.kind_of?(LocalInterface)
         print "Command is available only in local mode.\n"
@@ -73,20 +75,20 @@ module Byebug
       end
 
       add_debugging = @match.is_a?(MatchData) && '-d' == @match[1]
-      $rdebug_state = @state if add_debugging
+      $byebug_state = @state if add_debugging
       $rdebug_in_irb = true
       cont = IRB.start_session(get_binding)
       case cont
       when :cont
-        @state.proceed 
+        @state.proceed
       when :step
         force = Command.settings[:force_stepping]
-        @state.context.step(1, force)
-        @state.proceed 
+        @state.context.step 1, force
+        @state.proceed
       when :next
         force = Command.settings[:force_stepping]
-        @state.context.step_over(1, @state.frame_pos, force)
-        @state.proceed 
+        @state.context.step_over 1, @state.frame_pos, force
+        @state.proceed
       else
         file = @state.context.frame_file(0)
         line = @state.context.frame_line(0)
@@ -96,10 +98,10 @@ module Byebug
 
     ensure
       $rdebug_in_irb = nil
-      $rdebug_state = nil if add_debugging
+      $byebug_state = nil if add_debugging
       trap("SIGINT", save_trap) if save_trap
     end
-    
+
     class << self
       def help_command
         'irb'
@@ -109,10 +111,10 @@ module Byebug
         %{
           irb [-d]\tstarts an Interactive Ruby (IRB) session.
 
-If -d is added you can get access to byebug state via the global variable
-$RDEBUG_state. 
+If -d is added you can get access to byebug's state via the global variable
+$byebug_state.
 
-irb is extended with methods "cont", "n" and "step" which 
+irb is extended with methods "cont", "n" and "step" which
 run the corresponding byebug commands. In contrast to the real byebug
 commands these commands don't allow command arguments.
         }

data/lib/byebug/commands/method.rb

@@ -7,7 +7,7 @@ module Byebug
     have_methodsig = false
   end
 
-  # Implements the byebug 'method sig' command.
+  # Implements byebug's 'method sig' command.
   class MethodSigCommand < Command
     def regexp
       /^\s*m(?:ethod)?\s+sig(?:nature)?\s+(\S+)\s*$/
@@ -39,7 +39,7 @@ module Byebug
     end
   end if have_methodsig
 
-  # Implements the byebug 'method' command.
+  # Implements byebug's 'method' command.
   class MethodCommand < Command
     def regexp
       /^\s*m(?:ethod)?\s+((iv)|(i(:?nstance)?)\s+)?/
@@ -53,14 +53,14 @@ module Byebug
         end
       elsif @match[1]
         obj = debug_eval(@match.post_match)
-        print "%s\n", columnize(obj.methods.sort(), 
+        print "%s\n", columnize(obj.methods.sort(),
                                 self.class.settings[:width])
       else
         obj = debug_eval(@match.post_match)
         unless obj.kind_of? Module
           print "Should be Class/Module: %s\n", @match.post_match
         else
-          print "%s\n", columnize(obj.instance_methods(false).sort(), 
+          print "%s\n", columnize(obj.instance_methods(false).sort(),
                                   self.class.settings[:width])
         end
       end

data/lib/byebug/commands/reload.rb

@@ -1,30 +1,32 @@
 module Byebug
+
   # Implements byebug "reload" command.
   class ReloadCommand < Command
     self.allow_in_control = true
 
-    register_setting_get(:reload_source_on_change) do 
+    register_setting_get(:reload_source_on_change) do
       Byebug.reload_source_on_change
     end
+
     register_setting_set(:reload_source_on_change) do |value|
       Byebug.reload_source_on_change = value
     end
-    
+
     def regexp
       /^\s*r(?:eload)?$/
     end
-    
+
     def execute
       Byebug.source_reload
       print "Source code is reloaded. Automatic reloading is #{source_reloading}.\n"
     end
-    
+
     private
-    
+
     def source_reloading
       Byebug.reload_source_on_change ? 'on' : 'off'
     end
-    
+
     class << self
       def help_command
         'reload'

data/lib/byebug/commands/set.rb

@@ -1,4 +1,5 @@
 module Byebug
+
   # Implements byebug "set" command.
   class SetCommand < Command
     SubcmdStruct2=Struct.new(:name, :min, :is_bool, :short_help,
@@ -6,33 +7,34 @@ module Byebug
     Subcommands =
       [
         ['annotate', 2, false, "Set annotation level",
-"0 == normal
-2 == output annotated suitably for use by programs that control byebug."],
+         '0 == normal. '                                                    \
+         '2 == output annotated suitably for use by programs that control ' \
+         'byebug.'],
         ['args', 2, false,
-       "Set argument list to give program being debugged when it is started",
-"Follow this command with any number of args, to be passed to the program."],
+         'Set argument list to give program being debugged when it is started'],
         ['autoeval', 4, true, "Evaluate every unrecognized command"],
         ['autolist', 4, true, "Execute 'list' command on every breakpoint"],
         ['autoirb', 4, true, "Invoke IRB on every stop"],
         ['autoreload', 4, true, "Reload source code when changed"],
         ['basename', 1, true, "Report file basename only showing file names"],
         ['callstyle', 2, false, "Set how you want call parameters displayed"],
-        ['byebugtesting', 8, false, "Used when testing the byebug"],
+        ['byebugtesting', 8, false, "Used when testing byebug"],
         ['forcestep', 2, true,
-"Make sure 'next/step' commands always move to a new line"],
+         'Make sure \'next/step\' commands always move to a new line'],
         ['fullpath', 2, true, "Display full file names in frames"],
         ['history', 2, false,
-"Generic command for setting command history parameters",
-"set history filename -- Set the filename in which to record the command history
-set history save -- Set saving of the history record on exit
-set history size -- Set the size of the command history"],
+         'Generic command for setting command history parameters',
+         'set history filename -- Set the filename in which to record the ' \
+         'command history. '                                                \
+         'set history save -- Set saving of the history record on exit. '   \
+         'set history size -- Set the size of the command history'],
         ['linetrace+', 10, true,
-"Set line execution tracing to show different lines"],
+         'Set line execution tracing to show different lines'],
         ['linetrace', 3, true, "Set line execution tracing"],
         ['listsize', 3, false, "Set number of source lines to list by default"],
         ['trace', 1, true, "Display stack trace when 'eval' raises exception"],
         ['width', 1, false,
-"Number of characters the byebug thinks are in a line"]
+         'Number of characters per line for byebug\'s output']
       ].map do |name, min, is_bool, short_help, long_help|
       SubcmdStruct2.new(name, min, is_bool, short_help, long_help)
     end unless defined?(Subcommands)
@@ -96,14 +98,13 @@ set history size -- Set the size of the command history"],
                 if args[0]
                   arg = args[0].downcase.to_sym
                   case arg
-                  when :short, :last
+                  when :short, :last, :tracked
                     Command.settings[:callstyle] = arg
-                    print "%s\n" % show_setting(try_subcmd.name)
-                    return
+                  else
+                    print "Invalid call style #{arg}. Should be one of: " \
+                          "'short', 'last' or 'tracked'.\n"
                   end
                 end
-                print "Invalid call style #{arg}. Should be one of: " +
-                  "'short' or 'last'.\n"
               when /^trace$/
                 Command.settings[:stack_trace_on_error] = set_on
               when /^fullpath$/
@@ -126,15 +127,18 @@ set history size -- Set the size of the command history"],
                   when /^save$/
                     interface.history_save = get_onoff(args[1])
                   when /^size$/
-                    interface.history_length = get_int(args[1],
-                                                       "Set history size")
+                    interface.history_length =
+                      get_int(args[1], "Set history size")
                   when /^filename$/
-                    interface.histfile = File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", args[1])
+                    interface.histfile =
+                      File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", args[1])
                   else
-                    print "Invalid history parameter #{args[0]}. Should be 'filename', 'save' or 'size'.\n"
+                    print "Invalid history parameter #{args[0]}. Should be " \
+                          "'filename', 'save' or 'size'.\n"
                   end
                 else
-                  print "Need two parameters for 'set history'; got #{args.size}.\n"
+                  print "Need two parameters for 'set history'; got " \
+                        "#{args.size}.\n"
                   return
                 end
               when /^linetrace\+$/
@@ -160,7 +164,7 @@ set history size -- Set the size of the command history"],
                 print "Unknown setting #{@match[1]}.\n"
                 return
               end
-              print "%s\n" % show_setting(try_subcmd.name)
+              print "#{show_setting(try_subcmd.name)}\n"
               return
             rescue RuntimeError
               return