byebug 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6541893328ba036ff5ed811670bfc940b9fa1222
-  data.tar.gz: 1f61523cfd0e13a95a2a051a7b259ac1635c36c6
+  metadata.gz: 544a00d567861047f8cf035bf512491bb07f1fd9
+  data.tar.gz: e039ab4629df9d2b91e27af76678d234895bef3e
 SHA512:
-  metadata.gz: bff6dbb90362f18ef5ccc5bc5e64d5d60d420932dfd9ac71a1fcdaa5f263c91a9bbe987044410d9f49c1c82e9e7ce43c9f3ce67d45263f135d58fe15323644df
-  data.tar.gz: bdffa66981b5155c2327719fd25bb1ab0c154e4006be076577128670c5765f711b2b7b18178e2f69fb54cb9c2934c5aeb670ebeed43c6cbaedcb59bdaa166a9a
+  metadata.gz: 9e93823cb12a8f356ebd30f481661f296c82ced481d845c140fc399d07ed4aad8af44ab7e269a7b22b41b5f6d1627ab3bb505c695d7352dc0747778544e8ced7
+  data.tar.gz: 2b40aaa1e2e0b7d468fc1435d077328068c4d5cbfc218f87067bf377bffc30484fd38704ab04e9970656bcacf9a0764e86df9f6ddae64fec8ca6bec68bd5fca9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.3.0
+
+* Compatibility with Phusion Passenger Enterprise (thanks @FooBarWidget)
+* More minimalist help system
+
+
 # 2.2.2
 
 * Fix another compilation issue in 64 bit systems

data/README.md

@@ -68,7 +68,7 @@ placed at the end of a block or method call.
 
 ## Semantic Versioning
 
-Byebug tries to follow [semantic versioning](semver.org). Backwards
+Byebug tries to follow [semantic versioning](http://semver.org). Backwards
 compatibility doesn't seem like a critic issue for a debugger because it's not
 supposed to be used permanently by any program, let alone in production
 environments. However, I still like the idea of giving some meaning to version

data/lib/byebug/command.rb

@@ -16,7 +16,7 @@ module Byebug
   end
 
   class Command
-    Subcmd = Struct.new(:name, :min, :short_help, :long_help)
+    Subcmd = Struct.new(:name, :min, :help)
 
     class << self
       def commands
@@ -31,14 +31,13 @@ module Byebug
                       need_context:         false } unless defined?(DEF_OPTIONS)
 
       def help(args)
-        output = description.gsub(/^ +/, '') + "\n"
-
-        if defined? self::Subcommands
-          return output += format_subcmds unless args and args[1]
-          output += format_subcmd(args[1])
+        if args && args[1]
+          output = format_subcmd(args[1])
+        else
+          output = description.gsub(/^ +/, '') + "\n"
+          output += format_subcmds if defined? self::Subcommands
         end
-
-        return output
+        output
       end
 
       def find(subcmds, param)
@@ -57,8 +56,7 @@ module Byebug
         return "Invalid \"#{names.join("|")}\" " \
                "subcommand \"#{args[1]}\"." unless subcmd
 
-        return "#{subcmd.short_help}.\n" \
-               "#{subcmd.long_help || '' }"
+        return "#{subcmd.help}.\n"
       end
 
       def format_subcmds
@@ -67,10 +65,9 @@ module Byebug
             "--\n"                                   \
             "List of \"#{cmd_name}\" subcommands:\n" \
             "--\n"
-        width = self::Subcommands.map(&:name).max_by(&:size).size
+        w = self::Subcommands.map(&:name).max_by(&:size).size
         for subcmd in self::Subcommands do
-          s += sprintf \
-            "%s %-#{width}s -- %s\n", cmd_name, subcmd.name, subcmd.short_help
+          s += sprintf "%s %-#{w}s -- %s\n", cmd_name, subcmd.name, subcmd.help
         end
         return s
       end
@@ -91,10 +88,10 @@ module Byebug
 
       def method_missing(meth, *args, &block)
         if meth.to_s =~ /^(.+?)=$/
-          @options[$1.intern] = args.first
+          options[$1.intern] = args.first
         else
-          if @options.has_key?(meth)
-            @options[meth]
+          if options.has_key?(meth)
+            options[meth]
           else
             super
           end
@@ -192,36 +189,25 @@ module Byebug
         @state.confirm(msg) == 'y'
       end
 
-      def debug_eval(str, b = get_binding)
+      def bb_eval(str, b = get_binding)
         begin
           eval(str, b)
         rescue StandardError, ScriptError => e
-          if Command.settings[:stack_on_error]
-            at = eval("Thread.current.backtrace_locations", b)
-            print "#{at.shift}: #{e.class} Exception(#{e.message})\n"
-            for i in at
-              print "\tfrom #{i}\n"
-            end
-          else
-            print "#{e.class} Exception: #{e.message}\n"
+          at = eval("Thread.current.backtrace_locations", b)
+          print "#{at.shift}: #{e.class} Exception(#{e.message})\n"
+          for i in at
+            print "\tfrom #{i}\n"
           end
           nil
         end
       end
 
-      def debug_silent_eval(str, b = get_binding)
-        begin
-          eval(str, b)
-        rescue StandardError, ScriptError
-          nil
-        end
-      end
-
-      def debug_warning_eval(str, b = get_binding)
+      def bb_warning_eval(str, b = get_binding)
         begin
           eval(str, b)
         rescue StandardError, ScriptError => e
           print "#{e.class} Exception: #{e.message}\n"
+          nil
         end
       end
 

data/lib/byebug/commands/breakpoints.rb

@@ -42,7 +42,7 @@ module Byebug
         end
       elsif line !~ /^\d+$/
         # See if "line" is a method/function name
-        klass = debug_silent_eval(file)
+        klass = bb_warning_eval(file)
         if klass && klass.kind_of?(Module)
           class_name = klass.name if klass
         else

data/lib/byebug/commands/catchpoint.rb

@@ -17,7 +17,7 @@ module Byebug
             confirm("Delete all catchpoints? (y or n) ")
         else
           print "Warning #{@match[1]} is not known to be a Class\n" unless
-            debug_eval "#{@match[1]}.is_a?(Class)", get_binding
+            bb_eval "#{@match[1]}.is_a?(Class)", get_binding
           Byebug.add_catchpoint @match[1]
           print "Catch exception #{@match[1]}.\n"
         end

data/lib/byebug/commands/display.rb

@@ -2,7 +2,7 @@ module Byebug
 
   module DisplayFunctions
     def display_expression(exp)
-      print "#{exp} = #{debug_silent_eval(exp).inspect}\n"
+      print "#{exp} = #{bb_warning_eval(exp).inspect}\n"
     end
 
     def active_display_expressions?

data/lib/byebug/commands/enable.rb

@@ -44,19 +44,18 @@ module Byebug
   end
 
   class EnableCommand < Command
-    Subcommands =
-      [
-       ['breakpoints', 2, 'Enable breakpoints',
-        'This is used to cancel the effect of the "disable" command. Give ' \
-        'breakpoint numbers (separated by spaces) as arguments or no '      \
-        'argument at all if you want to reenable every breakpoint'],
-       ['display', 2,
-        'Enable some expressions to be displayed when program stops',
-        'Arguments are the code numbers of the expressions to resume '   \
-        'displaying. Do "info display" to see the current list of code ' \
-        'numbers.'],
-      ].map do |name, min, short_help, long_help|
-        Subcmd.new(name, min, short_help, long_help)
+    Subcommands = [
+      ['breakpoints', 2, 'Enable breakpoints. This is used to cancel the '  \
+                         'effect of the "disable" command. Give breakpoint' \
+                         ' numbers (separated by spaces) as arguments or '  \
+                         'no argument at all if you want to reenable '      \
+                         'every breakpoint'                                   ],
+      ['display'    , 2, 'Enable some expressions to be displayed when '    \
+                         'program stops. Arguments are the code numbers of' \
+                         ' the expressions to resume displaying. Do "info ' \
+                         'display" to see the current list of code numbers'   ]
+    ].map do |name, min, help|
+      Subcmd.new(name, min, help)
     end unless defined?(Subcommands)
 
     def regexp
@@ -99,19 +98,18 @@ module Byebug
   end
 
   class DisableCommand < Command
-    Subcommands =
-      [
-       ['breakpoints', 1, 'Disable breakpoints',
-        'A disabled breakpoint is not forgotten, but has no effect until ' \
-        'reenabled. Give breakpoint numbers (separated by spaces) as '     \
-        'arguments or no argument at all if you want to disable every '    \
-        'breakpoint'],
-       ['display', 1, 'Disable some display expressions when program stops',
-        'Arguments are the code numbers of the expressions to stop '     \
-        'displaying. Do "info display" to see the current list of code ' \
-        'numbers.'],
-      ].map do |name, min, short_help, long_help|
-      Subcmd.new(name, min, short_help, long_help)
+    Subcommands = [
+      ['breakpoints', 1, 'Disable breakpoints. A disabled breakpoint is '   \
+                         'not forgotten, but has no effect until '          \
+                         'reenabled. Give breakpoint numbers (separated by' \
+                         'spaces) as arguments or no argument at all if '   \
+                         'you want to disable every breakpoint'               ],
+      ['display'    , 1, 'Disable some display expressions when program '   \
+                         'stops. Arguments are the code numbers of the '    \
+                         'expressions to stop displaying. Do "info '        \
+                         'display" to see the current list of code numbers.'  ]
+    ].map do |name, min, help|
+      Subcmd.new(name, min, help)
     end unless defined?(Subcommands)
 
     def regexp

data/lib/byebug/commands/eval.rb

@@ -33,7 +33,11 @@ module Byebug
     def execute
       expr = @match ? @match.post_match : @input
       run_with_binding do |b|
-        print "#{debug_eval(expr, b).inspect}\n"
+        if Command.settings[:stack_on_error]
+          print "#{bb_eval(expr, b).inspect}\n"
+        else
+          print "#{bb_warning_eval(expr, b).inspect}\n"
+        end
       end
     rescue
       print "#{$!.class} Exception: #{$!.message}\n"
@@ -64,7 +68,11 @@ module Byebug
     def execute
       out = StringIO.new
       run_with_binding do |b|
-        PP.pp(debug_eval(@match.post_match, b), out)
+        if Command.settings[:stack_on_error]
+          PP.pp(bb_eval(@match.post_match, b), out)
+        else
+          PP.pp(bb_warning_eval(@match.post_match, b), out)
+        end
       end
       print out.string
     rescue
@@ -93,7 +101,11 @@ module Byebug
     def execute
       out = StringIO.new
       run_with_binding do |b|
-        vals = debug_eval(@match.post_match, b)
+        if Command.settings[:stack_on_error]
+          vals = bb_eval(@match.post_match, b)
+        else
+          vals = bb_warning_eval(@match.post_match, b)
+        end
         if vals.is_a?(Array)
           vals = vals.map{|item| item.to_s}
           print "#{columnize(vals, Command.settings[:width])}\n"
@@ -130,7 +142,11 @@ module Byebug
     def execute
       out = StringIO.new
       run_with_binding do |b|
-        vals = debug_eval(@match.post_match, b)
+        if Command.settings[:stack_on_error]
+          vals = bb_eval(@match.post_match, b)
+        else
+          vals = bb_warning_eval(@match.post_match, b)
+        end
         if vals.is_a?(Array)
           vals = vals.map{|item| item.to_s}
           print "#{columnize(vals.sort!, Command.settings[:width])}\n"

data/lib/byebug/commands/info.rb

@@ -19,48 +19,49 @@ module Byebug
     include Columnize
     self.allow_in_control = true
 
-    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.'],
-       ['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".'],
-       ['files', 5, 'File names and timestamps of files read in'],
-       ['global_variables', 2, 'Global variables'],
-       ['instance_variables', 2,
-        'Instance variables of the current stack frame'],
-       ['line', 2,
-        'Line number and file name of current position in source file'],
-       ['locals', 2, 'Local variables of the current stack frame'],
-       ['program', 2, 'Execution status of the program'],
-       ['stack', 2, 'Backtrace of the stack'],
-       ['variables', 1,
-        'Local and instance variables of the current stack frame']
-      ].map do |name, min, short_help, long_help|
-        Subcmd.new(name, min, short_help, long_help)
+    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.'              ],
+       ['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".'                                ],
+       ['files'             , 5, 'File names and timestamps of files read in' ],
+       ['global_variables'  , 2, 'Global variables'                           ],
+       ['instance_variables', 2, 'Instance variables in current stack frame'  ],
+       ['line'              , 2, 'Line number and file name of current '    \
+                                 'position in source file'                    ],
+       ['locals'            , 2, 'Local variables of the current stack frame' ],
+       ['program'           , 2, 'Execution status of the program'            ],
+       ['stack'             , 2, 'Backtrace of the stack'                     ],
+       ['variables'         , 1, 'Local and instance variables of the '     \
+                                 'current stack frame'                        ]
+    ].map do |name, min, help|
+      Subcmd.new(name, min, help)
     end unless defined?(Subcommands)
 
-    InfoFileSubcommands =
-      [
-       ['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.'],
-       ['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'],
-       ['sha1', 1, 'Show SHA1 hash of contents of the file']
-      ].map do |name, min, short_help, long_help|
-        Subcmd.new(name, min, short_help, long_help)
-      end unless defined?(InfoFileSubcommands)
+    InfoFileSubcommands = [
+      ['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.'                                        ],
+      ['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'                  ],
+      ['sha1'       , 1, 'Show SHA1 hash of contents of the file'             ]
+    ].map do |name, min, help|
+      Subcmd.new(name, min, help)
+    end unless defined?(InfoFileSubcommands)
 
     def regexp
       /^\s* i(?:nfo)? (?:\s+(.+))? \s*$/x
@@ -194,7 +195,7 @@ module Byebug
     end
 
     def info_instance_variables(*args)
-      obj = debug_eval('self')
+      obj = bb_eval('self')
       var_list(obj.instance_variables)
     end
 
@@ -260,7 +261,7 @@ module Byebug
       locals[:self] = @state.context.frame_self(@state.frame_pos)
       print_hash(locals)
 
-      obj = debug_eval('self')
+      obj = bb_eval('self')
       var_list(obj.instance_variables, obj.instance_eval{binding()})
       var_class_self
     end

data/lib/byebug/commands/method.rb

@@ -14,7 +14,7 @@ module Byebug
     end
 
     def execute
-      obj = debug_eval('method(:%s)' % @match[1])
+      obj = bb_eval('method(:%s)' % @match[1])
       if obj.is_a?(Method)
         begin
           print "%s\n", obj.signature.to_s
@@ -46,7 +46,7 @@ module Byebug
     end
 
     def execute
-      obj = debug_eval(@match.post_match)
+      obj = bb_eval(@match.post_match)
       if @match[1] == "iv"
         obj.instance_variables.sort.each do |v|
           print "#{v} = #{obj.instance_variable_get(v).inspect}\n"

data/lib/byebug/commands/set.rb

@@ -63,51 +63,49 @@ module Byebug
 
   # Implements byebug "set" command.
   class SetCommand < Command
-    SubcmdStruct2 = Struct.new(:name,
-                               :min,
-                               :is_bool,
-                               :short_help,
-                               :long_help) unless defined?(SubcmdStruct2)
-
-    Subcommands =
-      [
-       ['args', 2, false,
-        'Set argument list to the 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, 'Set filename display style'],
-       ['callstyle', 2, false, 'Set how you want call parameters displayed'],
-       ['testing', 2, false, 'Used when testing byebug'],
-       ['forcestep', 2, true,
-        'Make sure "next/step" commands always move to a new line'],
-       ['fullpath', 2, true, 'Display full file names in frames'],
-       ['history', 2, false, 'Command for setting command history parameters',
-        'History parameters are "filename", "save" and "size"'],
-       ['linetrace', 3, true, 'Enable line execution tracing'],
-       ['linetrace_plus', 10, true,
-        'Set line execution tracing to show different lines'],
-       ['listsize', 3, false, 'Set number of source lines to list by default'],
-       ['post_mortem', 2, true, 'Enable post-mortem mode'],
-       ['stack_on_error', 1, true,
-        'Display stack trace when "eval" raises exception'],
-       ['verbose', 1, true,
-        'Enable verbose output of TracePoint API events is enabled'],
-       ['width', 1, false,
-        '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)
+    Subcmd2 = Struct.new(:name, :min, :is_bool, :help) unless defined?(Subcmd2)
+
+    Subcommands = [
+      ['args'          , 2 , false, 'Set argument list to the 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 , 'Set filename display style'              ],
+      ['callstyle'     , 2 , false, 'Set how you want call parameters '    \
+                                    'displayed'                               ],
+      ['testing'       , 2 , false, 'Used when testing byebug'                ],
+      ['forcestep'     , 2 , true , 'Make sure "next/step" commands always' \
+                                    'move to a new line'                      ],
+      ['fullpath'      , 2 , true , 'Display full file names in frames'       ],
+      ['history'       , 2 , false, 'Command for setting command history '  \
+                                    'parameters, namely, "filename", '      \
+                                    '"save" and "size"'                       ],
+      ['linetrace'     , 3 , true , 'Enable line execution tracing'           ],
+      ['linetrace_plus', 10, true , 'Set line execution tracing to show'    \
+                                    'different lines'                         ],
+      ['listsize'      , 3 , false, 'Set number of source lines to list by' \
+                                    'default'                                 ],
+      ['post_mortem'   , 2 , true , 'Enable post-mortem mode'                 ],
+      ['stack_on_error', 1 , true , 'Display stack trace when "eval" '      \
+                                    'raises exception'                        ],
+      ['verbose'       , 1 , true , 'Enable verbose output of TracePoint '  \
+                                    'API events is enabled'                   ],
+      ['width'         , 1 , false, 'Number of characters per line for '    \
+                                    'byebug\'s output'                        ]
+    ].map do |name, min, is_bool, help|
+      Subcmd2.new(name, min, is_bool, help)
     end unless defined?(Subcommands)
 
-    SetHistorySubcommands =
-      [
-       ['filename', 1, 'Set the filename in which to record command history'],
-       ['save', 1, 'Set saving of the history record on exit'],
-       ['size', 1, 'Set the size of the command history']
-      ].map do |name, min, short_help, long_help|
-        Subcmd.new(name, min, short_help, long_help)
-      end unless defined?(SetHistorySubcommands)
+    SetHistorySubcommands = [
+      ['filename', 1, 'Set the filename in which to record command history'],
+      ['save'    , 1, 'Set saving of the history record on exit'           ],
+      ['size'    , 1, 'Set the size of the command history'                ]
+    ].map do |name, min, help|
+      Subcmd.new(name, min, help)
+    end unless defined?(SetHistorySubcommands)
 
     self.allow_in_control = true
 
@@ -152,6 +150,6 @@ module Byebug
           or 0. You can see these environment settings with the "show" command.}
       end
     end
-
   end
+
 end