byebug 1.1.0 → 1.1.1

data/lib/byebug/command.rb

@@ -13,29 +13,6 @@ module Byebug
         string[Command.settings[:width]-3 .. -1] = "..."
       end
     end
-  end
-
-  # Root dir for byebug
-  BYEBUG_DIR = File.expand_path(File.dirname(__FILE__)) unless
-    defined?(BYEBUG_DIR)
-
-  class Command
-    SubcmdStruct = Struct.new(:name, :min, :short_help, :long_help) unless
-      defined?(SubcmdStruct)
-
-    ##
-    # Print list of subcmds
-    #
-    def format_subcmds(subcmds)
-      cmd_name = self.class.name[/Byebug::(.*)Command/, 1].downcase
-      s = "\n"                                     \
-          "--\n"                                   \
-          "List of \"#{cmd_name}\" subcommands:\n" \
-          "--\n"
-      for subcmd in subcmds do
-        s += "#{cmd_name} #{subcmd.name} -- #{subcmd.short_help}\n"
-      end
-    end
 
     ##
     # Find param in subcmds.
@@ -54,6 +31,31 @@ module Byebug
       return nil
     end
 
+    ##
+    # Build formatted list of subcmds
+    #
+    def format_subcmds(subcmds)
+      cmd_name = self.class.names.join("|")
+      s = "\n"                                     \
+          "--\n"                                   \
+          "List of \"#{cmd_name}\" subcommands:\n" \
+          "--\n"
+      for subcmd in subcmds do
+        s += "#{cmd_name} #{subcmd.name} -- #{subcmd.short_help}\n"
+      end
+      return s
+    end
+
+  end
+
+  # Root dir for byebug
+  BYEBUG_DIR = File.expand_path(File.dirname(__FILE__)) unless
+    defined?(BYEBUG_DIR)
+
+  class Command
+    SubcmdStruct = Struct.new(:name, :min, :short_help, :long_help) unless
+      defined?(SubcmdStruct)
+
     class << self
       def commands
         @commands ||= []
@@ -66,6 +68,13 @@ module Byebug
                       unknown:              false,
                       need_context:         false } unless defined?(DEF_OPTIONS)
 
+      def help(args)
+        output = description.split("\n").map{|l| l.gsub(/^ +/, '')}
+        output.shift if output.first && output.first.empty?
+        output.pop if output.last && output.last.empty?
+        output.join("\n") + "\n"
+      end
+
       def inherited(klass)
         DEF_OPTIONS.each do |o, v|
           klass.options[o] = v if klass.options[o].nil?
@@ -140,7 +149,7 @@ module Byebug
     # Register default settings
     register_setting_var(:basename, false)
     register_setting_var(:callstyle, :last)
-    register_setting_var(:byebugtesting, false)
+    register_setting_var(:testing, false)
     register_setting_var(:force_stepping, false)
     register_setting_var(:full_path, true)
     register_setting_var(:listsize, 10)
@@ -202,11 +211,8 @@ module Byebug
       end
 
       def get_binding
-        @state.context.frame_binding(@state.frame_pos)
-      end
-
-      def get_context(thnum)
-        Byebug.contexts.find{|c| c.thnum == thnum}
+        @state.context ? @state.context.frame_binding(@state.frame_pos) :
+          TOPLEVEL_BINDING
       end
   end
 

data/lib/byebug/commands/breakpoints.rb

@@ -14,6 +14,9 @@ module Byebug
     end
 
     def execute
+      return print AddBreakpoint.help(nil) if
+        AddBreakpoint.names.include?(@match[0])
+
       if @match[1]
         line, _, _, expr = @match.captures
       else
@@ -95,15 +98,16 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'break'
+      def names
+        %w(break)
       end
 
-      def help(cmd)
+      def description
         %{
           b[reak] file:line [if expr]
           b[reak] class(.|#)method [if expr]
-          \tset breakpoint to some position, (optionally) if expr == true
+
+          Set breakpoint to some position, (optionally) if expr == true
         }
       end
     end
@@ -118,10 +122,7 @@ module Byebug
     end
 
     def execute
-      unless @state.context
-        errmsg "We are not in a state we can delete breakpoints.\n"
-        return
-      end
+      return errmsg "We are not in a state we can delete breakpoints.\n" unless @state.context
       brkpts = @match[1]
       unless brkpts
         if confirm("Delete all breakpoints? (y or n) ")
@@ -139,15 +140,19 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'delete'
+      def names
+        %w(delete)
       end
 
-      def help(cmd)
+      def description
         %{
-          del[ete][ nnn...]\tdelete some or all breakpoints
+          del[ete][ nnn...]
+
+          Without argumen, deletes all breakpoints. With integer numbers,
+          deletes specific breakpoints.
         }
       end
     end
   end
+
 end

data/lib/byebug/commands/catchpoint.rb

@@ -38,16 +38,16 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'catch'
+      def names
+        %w(catch)
       end
 
-      def help(cmd)
+      def description
         %{
           cat[ch]\t\tsame as "info catch"
           cat[ch] <exception-name> [on|off]
-\tIntercept <exception-name> when there would otherwise be no handler.
-\tWith an "on" or "off", turn handling the exception on or off.
+          \tIntercept <exception-name> when there would otherwise be no handler.
+          \tWith an "on" or "off", turn handling the exception on or off.
           cat[ch] off\tdelete all catchpoints
         }
       end

data/lib/byebug/commands/condition.rb

@@ -31,16 +31,18 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'condition'
+      def names
+        %w(condition)
       end
 
-      def help(cmd)
+      def description
         %{
-          Condition breakpoint-number expression
-Specify breakpoint number N to break only if COND is true. N is an integer and
-COND is an expression to be evaluated whenever breakpoint N is reached. If the
-empty string is used, the condition is removed.
+          cond[ition] nnn[ expr]
+
+          Specify breakpoint number nnn to break only if expr is true. nnn is an
+          integer and expr is an expression to be evaluated whenever breakpoint
+          nnn is reached. If no expression is specified, the condition is
+          removed.
         }
       end
     end

data/lib/byebug/commands/continue.rb

@@ -4,6 +4,7 @@ module Byebug
   class ContinueCommand < Command
     self.allow_in_post_mortem = true
     self.need_context         = false
+
     def regexp
       /^\s* c(?:ont(?:inue)?)? (?:\s+(.*))? $/x
     end
@@ -24,13 +25,15 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'continue'
+      def names
+        %w(continue)
       end
 
-      def help(cmd)
+      def description
         %{
-          c[ont[inue]][ nnn]\trun until program ends, hits a breakpoint or reaches line nnn
+          c[ont[inue]][ nnn]
+
+          Run until program ends, hits a breakpoint or reaches line nnn
         }
       end
     end

data/lib/byebug/commands/control.rb

@@ -55,13 +55,14 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'restart'
+      def names
+        %w(restart)
       end
 
-      def help(cmd)
+      def description
         %{
           restart|R [args]
+
           Restart the program. This is a re-exec - all byebug state
           is lost. If command arguments are passed those are used.
         }
@@ -69,33 +70,4 @@ module Byebug
     end
   end
 
-  class InterruptCommand < Command
-    self.allow_in_control     = true
-    self.allow_in_post_mortem = false
-    self.event                = false
-    self.need_context         = true
-
-    def regexp
-      /^\s*i(?:nterrupt)?\s*$/
-    end
-
-    def execute
-      unless Byebug.interrupt_last
-        context = Byebug.thread_context(Thread.main)
-        context.interrupt
-      end
-    end
-
-    class << self
-      def help_command
-        'interrupt'
-      end
-
-      def help(cmd)
-        %{
-          i[nterrupt]\tinterrupt the program
-        }
-      end
-    end
-  end
 end

data/lib/byebug/commands/display.rb

@@ -34,11 +34,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'display'
+      def names
+        %w(display)
       end
 
-      def help(cmd)
+      def description
         %{
           disp[lay] <expression>\tadd expression into display expression list
         }
@@ -65,11 +65,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'display'
+      def names
+        %w(display)
       end
 
-      def help(cmd)
+      def description
         %{
           disp[lay]\t\tdisplay expression list
         }
@@ -101,18 +101,19 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'undisplay'
+      def names
+        %w(undisplay)
       end
 
-      def help(cmd)
+      def description
         %{
           undisp[lay][ nnn]
-          Cancel some expressions to be displayed when program stops.
-          Arguments are the code numbers of the expressions to stop displaying.
-          No argument means cancel all automatic-display expressions.
-          "delete display" has the same effect as this command.
-          Do "info display" to see current list of code numbers.
+
+          Cancel some expressions to be displayed when program stops. Arguments
+          are the code numbers of the expressions to stop displaying. No
+          argument means cancel all automatic-display expressions. "delete
+          display" has the same effect as this command. Do "info display" to see
+          the current list of code numbers.
         }
       end
     end

data/lib/byebug/commands/edit.rb

@@ -1,15 +1,17 @@
 module Byebug
-  class Edit < Command # :nodoc:
+
+  class Edit < Command
     self.allow_in_control = true
+
     def regexp
       /^\s* ed(?:it)? (?:\s+(.*))?$/ix
     end
-    
+
     def execute
       if not @match[1] or @match[1].strip.empty?
         unless @state.context
           errmsg "We are not in a state that has an associated file.\n"
-          return 
+          return
         end
         file = @state.file
         line_number = @state.line
@@ -26,23 +28,22 @@ module Byebug
         errmsg "File \"#{file}\" is not readable.\n"
       end
     end
-    
+
     class << self
-      def help_command
-        'edit'
+      def names
+        %w(edit)
       end
 
-      def help(cmd)
+      def description
         %{
-          Edit specified file.
+          edit[ file:lineno]\tEdit specified file.
 
-With no argument, edits file containing most recent line listed.
-Editing targets can also be specified in this:
-  FILE:LINENUM, to edit at that line in that file,
+          With no argument, edits file containing most recent line listed.
+          Editing targets can also be specified to start editing at a specific
+          line in a specific file.
         }
       end
     end
   end
 
-
-end # module Byebug
+end

data/lib/byebug/commands/enable.rb

@@ -42,7 +42,6 @@ module Byebug
         @state.display[pos-1][0] = ('Enable' == is_enable)
       end
     end
-
   end
 
   class EnableCommand < Command
@@ -88,28 +87,27 @@ module Byebug
       enable_disable_display('Enable', args)
     end
 
-    class << self
-      def help_command
-        'enable'
+    def help
+      if args[1]
+        subcmd = find(Subcommands, args[1])
+        return "Invalid \"enable\" subcommand \"#{args[1]}\"." unless subcmd
+        str = subcmd.short_help + '.'
+        str += '\n' + subcmd.long_help if subcmd.long_help
+        return str
       end
+      EnableCommand.description + format_subcmds(Subcommands)
+    end
 
-      def help(args)
-        # specific subcommand help
-        if args[1]
-          subcmd = find(Subcommands, args[1])
-          return "Invalid \"enable\" subcommand \"#{args[1]}\"." unless subcmd
-
-          str = subcmd.short_help + '.'
-          str += '\n' + subcmd.long_help if subcmd.long_help
-          return str
-        end
+    class << self
+      def names
+        %w(enable)
+      end
 
-        # general help
-        str = %{
+      def description
+        %{
           Enable some things.
           This is used to cancel the effect of the "disable" command.
         }
-        str += format_subcmds(Subcommands)
       end
     end
   end
@@ -156,32 +154,32 @@ module Byebug
       enable_disable_display('Disable', args)
     end
 
-    class << self
-      def help_command
-        'disable'
-      end
+    def help(args)
+      if args[1]
+        subcmd = find(Subcommands, args[1])
+        return "Invalid \"disable\" subcommand \"#{args[1]}\"." unless subcmd
 
-      def help(args)
-        # specific subcommand help
-        if args[1]
-          subcmd = find(Subcommands, args[1])
-          return "Invalid \"disable\" subcommand \"#{args[1]}\"." unless subcmd
+        str = subcmd.short_help + '.'
+        str += '\n' + subcmd.long_help if subcmd.long_help
+        return str
+      end
+      DisableCommand.description + format_subcmds(Subcommads)
+    end
 
-          str = subcmd.short_help + '.'
-          str += '\n' + subcmd.long_help if subcmd.long_help
-          return str
-        end
+    class << self
+      def names
+        %w(disable)
+      end
 
-        # general help
-        str = %{
+      def description
+        %{
           Disable some things.
 
           A disabled item is not forgotten, but has no effect until reenabled.
           Use the "enable" command to have it take effect again.
-        }
-        str += format_subcmds(Subcommads)
+         }
       end
     end
   end
 
-end # module Byebug
+end