byebug 1.4.1 → 1.4.2

data/lib/byebug/command.rb

@@ -13,23 +13,6 @@ module Byebug
         string[Command.settings[:width]-3 .. -1] = "..."
       end
     end
-
-    ##
-    # Find param in subcmds.
-    #
-    # @param is downcased and can be abbreviated to the minimum length listed in
-    # the subcommands.
-    #
-    def find(subcmds, param)
-      param.downcase!
-      for try_subcmd in subcmds do
-        if (param.size >= try_subcmd.min) and
-            (try_subcmd.name[0..param.size-1] == param)
-          return try_subcmd
-        end
-      end
-      return nil
-    end
   end
 
   # Root dir for byebug
@@ -53,10 +36,7 @@ module Byebug
                       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 = output.join("\n") + "\n"
+        output = description.gsub(/^ +/, '')
 
         if defined? self::Subcommands
           return output += format_subcmds unless args and args[1]
@@ -66,6 +46,17 @@ module Byebug
         return output
       end
 
+      def find(subcmds, param)
+        param.downcase!
+        for try_subcmd in subcmds do
+          if (param.size >= try_subcmd.min) and
+              (try_subcmd.name[0..param.size-1] == param)
+            return try_subcmd
+          end
+        end
+        return nil
+      end
+
       def format_subcmd(subcmd_name)
         subcmd = find(self::Subcommands, subcmd_name)
         return "Invalid \"#{names.join("|")}\" " \

data/lib/byebug/commands/breakpoints.rb

@@ -14,7 +14,7 @@ module Byebug
     end
 
     def execute
-      return print self.class.help(nil) if self.class.names.include?(@match[0])
+      return print BreakCommand.help(nil) if BreakCommand.names.include?(@match[0])
 
       if @match[1]
         line, _, _, expr = @match.captures
@@ -95,12 +95,10 @@ module Byebug
       end
 
       def description
-        %{
-          b[reak] file:line [if expr]
+        %{b[reak] file:line [if expr]
           b[reak] class(.|#)method [if expr]
 
-          Set breakpoint to some position, (optionally) if expr == true
-        }
+          Set breakpoint to some position, (optionally) if expr == true}
       end
     end
   end
@@ -134,12 +132,10 @@ module Byebug
       end
 
       def description
-        %{
-          del[ete][ nnn...]
+        %{del[ete][ nnn...]
 
           Without and argument, deletes all breakpoints. With integer arguments,
-          it deletes specific breakpoints.
-        }
+          it deletes specific breakpoints.}
       end
     end
   end

data/lib/byebug/commands/catchpoint.rb

@@ -39,13 +39,11 @@ module Byebug
       end
 
       def description
-        %{
-          cat[ch]\t\tsame as "info catch"
+        %{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.
-          cat[ch] off\tdelete all catchpoints
-        }
+          cat[ch] off\tdelete all catchpoints}
       end
     end
   end

data/lib/byebug/commands/condition.rb

@@ -1,6 +1,6 @@
 module Byebug
 
-  class ConditionCommand < Command # :nodoc:
+  class ConditionCommand < Command
 
     def regexp
       /^\s* cond(?:ition)? (?:\s+(\d+)\s*(.*))?$/ix
@@ -31,16 +31,14 @@ module Byebug
       end
 
       def description
-        %{
-          cond[ition] nnn[ expr]
+        %{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.
-        }
+          removed.}
       end
     end
   end
 
-end # module Byebug
+end

data/lib/byebug/commands/continue.rb

@@ -28,11 +28,9 @@ module Byebug
       end
 
       def description
-        %{
-          c[ont[inue]][ nnn]
+        %{c[ont[inue]][ nnn]
 
-          Run until program ends, hits a breakpoint or reaches line nnn
-        }
+          Run until program ends, hits a breakpoint or reaches line nnn}
       end
     end
   end

data/lib/byebug/commands/control.rb

@@ -60,12 +60,10 @@ module Byebug
       end
 
       def description
-        %{
-          restart|R [args]
+        %{restart|R [args]
 
           Restart the program. This is a re-exec - all byebug state
-          is lost. If command arguments are passed those are used.
-        }
+          is lost. If command arguments are passed those are used.}
       end
     end
   end

data/lib/byebug/commands/display.rb

@@ -39,9 +39,7 @@ module Byebug
       end
 
       def description
-        %{
-          disp[lay] <expression>\tadd expression into display expression list
-        }
+        %{disp[lay] <expression>\tadd expression into display expression list}
       end
     end
   end
@@ -70,9 +68,7 @@ module Byebug
       end
 
       def description
-        %{
-          disp[lay]\t\tdisplay expression list
-        }
+        %{disp[lay]\t\tdisplay expression list}
       end
     end
   end
@@ -106,15 +102,13 @@ module Byebug
       end
 
       def description
-        %{
-          undisp[lay][ nnn]
+        %{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
-          the current list of code numbers.
-        }
+          the current list of code numbers.}
       end
     end
   end

data/lib/byebug/commands/edit.rb

@@ -35,13 +35,11 @@ module Byebug
       end
 
       def description
-        %{
-          edit[ file:lineno]\tEdit specified file.
+        %{edit[ file:lineno]\tEdit specified 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.
-        }
+          line in a specific file.}
       end
     end
   end

data/lib/byebug/commands/enable.rb

@@ -69,7 +69,7 @@ module Byebug
 
       args = @match[1].split(/[ \t]+/)
       param = args.shift
-      subcmd = find(Subcommands, param)
+      subcmd = Command.find(Subcommands, param)
       if subcmd
         send("enable_#{subcmd.name}", args)
       else
@@ -91,10 +91,8 @@ module Byebug
       end
 
       def description
-        %{
-          Enable some things.
-          This is used to cancel the effect of the "disable" command.
-        }
+        %{Enable some things.
+          This is used to cancel the effect of the "disable" command.}
       end
     end
   end
@@ -123,7 +121,7 @@ module Byebug
 
       args = @match[1].split(/[ \t]+/)
       param = args.shift
-      subcmd = find(Subcommands, param)
+      subcmd = Command.find(Subcommands, param)
       if subcmd
         send("disable_#{subcmd.name}", args)
       else
@@ -145,12 +143,10 @@ module Byebug
       end
 
       def description
-        %{
-          Disable some things.
+        %{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.
-         }
+          Use the "enable" command to have it take effect again.}
       end
     end
   end

data/lib/byebug/commands/eval.rb

@@ -58,10 +58,11 @@ module Byebug
       end
 
       def description
-        %{
-          (p|e[val]) expression\tevaluate expression and print its value
-          * NOTE - to turn on autoeval, use 'set autoeval'
-         }
+        %{(p|e[val]) expression
+
+          Evaluate expression and print its value
+          * NOTE - unknown input is automatically evaluated, to turn this off
+          use 'set noautoeval'}
       end
     end
   end
@@ -89,9 +90,7 @@ module Byebug
       end
 
       def description
-        %{
-          pp expression\tevaluate expression and pretty-print its value
-        }
+        %{pp expression\tevaluate expression and pretty-print its value}
       end
     end
   end
@@ -126,9 +125,9 @@ module Byebug
       end
 
       def description
-        %{
-          putl expression\tevaluate expression, an array, and columnize its value
-        }
+        %{putl expression
+
+          Evaluate expression, an array, and columnize its value}
       end
     end
   end
@@ -165,9 +164,9 @@ module Byebug
       end
 
       def description
-        %{
-          ps expression\tevaluate expression, an array, sort and columnize its value
-        }
+        %{ps expression
+
+          Evaluate expression, an array, sort and columnize its value}
       end
     end
   end

data/lib/byebug/commands/finish.rb

@@ -28,16 +28,14 @@ module Byebug
       end
 
       def description
-        %{
-          fin[ish][ frame-number]\tExecute until selected stack frame returns.
+        %{fin[ish][ frame-number]\tExecute until selected stack frame returns.
 
           If no frame number is given, we run until the currently selected frame
           returns. The currently selected frame starts out the most-recent frame
           or 0 if no frame positioning (e.g "up", "down" or "frame") has been
           performed.
 
-          If a frame number is given we run until that frame returns.
-        }
+          If a frame number is given we run until that frame returns.}
       end
     end
   end

data/lib/byebug/commands/frame.rb

@@ -157,7 +157,6 @@ module Byebug
       end
       return nil
     end
-
   end
 
   # Implements byebug "where" or "backtrace" command.
@@ -180,14 +179,12 @@ module Byebug
       end
 
       def description
-        %{
-          w[here]|bt|backtrace\tdisplay stack frames
+        %{w[here]|bt|backtrace\tdisplay stack frames
 
           Print the entire stack frame. Each frame is numbered, the most recent
           frame is 0. frame number can be referred to in the "frame" command;
           "up" and "down" add or subtract respectively to frame numbers shown.
-          The position of the current frame is marked with -->.
-        }
+          The position of the current frame is marked with -->.}
       end
     end
   end
@@ -209,9 +206,7 @@ module Byebug
       end
 
       def description
-        %{
-          up[ count]\tmove to higher frame
-        }
+        %{up[ count]\tmove to higher frame}
       end
     end
   end
@@ -233,9 +228,7 @@ module Byebug
       end
 
       def description
-        %{
-          down[ count]\tmove to lower frame
-        }
+        %{down[ count]\tmove to lower frame}
       end
     end
   end
@@ -264,8 +257,7 @@ module Byebug
       end
 
       def description
-        %{
-          f[rame][ frame-number]
+        %{f[rame][ frame-number]
 
           Move the current frame to the specified frame number, or the 0 if no
           frame-number has been given.
@@ -275,8 +267,7 @@ module Byebug
 
           Without an argument, the command prints the current stack frame. Since
           the current position is redisplayed, it may trigger a resyncronization
-          if there is a front end also watching over things.
-        }
+          if there is a front end also watching over things.}
       end
     end
   end

data/lib/byebug/commands/help.rb

@@ -41,10 +41,9 @@ module Byebug
       end
 
       def description
-        %{
-          h[elp]\t\tprint this help
+        %{h[elp]\t\tprint this help
           h[elp] command\tprint help on command
-        }
+          h[elp] command subcommand\tprint help on subcommand}
       end
     end
   end

data/lib/byebug/commands/info.rb

@@ -71,7 +71,7 @@ module Byebug
 
       args = @match[1].split(/[ \t]+/)
       param = args.shift
-      subcmd = find(Subcommands, param)
+      subcmd = Command.find(Subcommands, param)
       if subcmd
         send("info_#{subcmd.name}", *args)
       else
@@ -174,7 +174,7 @@ module Byebug
 
       param =  args[1] || 'basic'
 
-      subcmd = find(InfoFileSubcommands, param)
+      subcmd = Command.find(InfoFileSubcommands, param)
       return errmsg "Invalid parameter #{param}\n" unless subcmd
 
       unless LineCache::cached?(args[0])
@@ -309,11 +309,9 @@ module Byebug
       end
 
       def description
-        %{
-          info[ subcommand]
+        %{info[ subcommand]
 
-          Generic command for showing things about the program being debugged.
-        }
+          Generic command for showing things about the program being debugged.}
       end
 
       def help(args)
@@ -322,7 +320,7 @@ module Byebug
         return format_subcmd(args[1]) unless 'file' == args[1] and args[2]
 
         str = subcmd.short_help + '.'
-        subsubcmd = find(InfoFileSubcommands, args[2])
+        subsubcmd = Command.find(InfoFileSubcommands, args[2])
         if subsubcmd
           str += "\nInvalid \"file\" attribute \"#{args[2]}\"."
         else