byebug 2.7.0 → 3.0.0

data/lib/byebug/commands/set.rb

@@ -23,41 +23,29 @@ module Byebug
         end
       when /^verbose$/
         Byebug.verbose = setting_value
-      when /^history$/
-        try_subcmd = setting_args[0]
-        subcmd = Command.find(SetCommand::SetHistorySubcommands, try_subcmd)
-        return print "Invalid history parameter #{try_subcmd}. Should be" \
-                     ' "filename", "save" or "size"' unless subcmd
-
-        sub_sub_cmd = setting_args[1]
-        iface = @state.interface
-        case subcmd.name
-        when /^save$/
-          iface.history_save = sub_sub_cmd ? get_onoff(sub_sub_cmd) : true
-        when /^size$/
-          return print 'You need to specify the history size' unless sub_sub_cmd
-          iface.history_length = get_int(sub_sub_cmd, "Set history size")
-        when /^filename$/
-          return print 'You need to specify a filename' unless sub_sub_cmd
-          iface.histfile = File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", sub_sub_cmd)
-        end
+      when /^histfile$/
+        return print 'You need to specify a filename' unless setting_args[0]
+        Byebug::History.file = File.expand_path(setting_args[0])
+      when /^histsize$/
+        return print 'You need to specify the history size' unless setting_args[0]
+        Byebug::History.max_size = get_int(setting_args[0], "Set histsize")
       when /^linetrace$/
         Byebug.tracing = setting_value
       when /^listsize$/
-        listsize = get_int(setting_args[0], "Set listsize", 1, nil, 10)
+        listsize = get_int(setting_args[0], 'Set listsize', 1, nil, 10)
         return unless listsize
         Command.settings[:listsize] = listsize
       when /^width$/
-        return unless width = get_int(setting_args[0], "Set width", 10, nil, 80)
+        return unless width = get_int(setting_args[0], 'Set width', 10, nil, 80)
         Command.settings[:width] = width
       when /^post_mortem$/
         if setting_value == true
           Byebug.post_mortem
         else
-          return print 'Sorry... not implemented yet. Restart byebug'
+          Byebug.post_mortem = false
         end
-      when /^autoeval|autoreload|basename|forcestep|fullpath|linetrace_plus|
-             testing|stack_on_error$/x
+      when /^autoeval|autoreload|autosave|basename|forcestep|fullpath|
+             linetrace_plus|testing|stack_on_error$/x
         Command.settings[setting_name.to_sym] = setting_value
       else
         return print "Unknown setting #{@match[1]}.\n"
@@ -72,21 +60,25 @@ module Byebug
     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 '     \
+      ['autoeval'      , 5 , true , 'Evaluate every unrecognized command'     ],
+      ['autolist'      , 5 , true , 'Execute "list" command on every '     \
                                     'breakpoint'                              ],
-      ['autoirb'       , 4 , true , 'Invoke IRB on every stop'                ],
-      ['autoreload'    , 4 , true , 'Reload source code when changed'         ],
+      ['autoirb'       , 5 , true , 'Invoke IRB on every stop'                ],
+      ['autoreload'    , 5 , true , 'Reload source code when changed'         ],
+      ['autosave'      , 5 , true , 'Automatically save command history '  \
+                                    'record on exit'                          ],
       ['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"'                       ],
+      ['histfile'      , 5 , false, 'Customize file where history is '      \
+                                    'loaded from and saved to. By '         \
+                                    'default, .byebug_hist'                   ],
+      ['histsize'      , 5 , false, 'Customize maximum number of commands ' \
+                                    'that are stored in byebug history '    \
+                                    'record. By default, 256'                 ],
       ['linetrace'     , 3 , true , 'Enable line execution tracing'           ],
       ['linetrace_plus', 10, true , 'Set line execution tracing to show'    \
                                     'different lines'                         ],
@@ -95,6 +87,7 @@ module Byebug
       ['post_mortem'   , 2 , true , 'Enable post-mortem mode'                 ],
       ['stack_on_error', 1 , true , 'Display stack trace when "eval" '      \
                                     'raises exception'                        ],
+      ['testing'       , 2 , false, 'Used when testing byebug'                ],
       ['verbose'       , 1 , true , 'Enable verbose output of TracePoint '  \
                                     'API events is enabled'                   ],
       ['width'         , 1 , false, 'Number of characters per line for '    \
@@ -103,14 +96,6 @@ module Byebug
       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, help|
-      Subcmd.new(name, min, help)
-    end unless defined?(SetHistorySubcommands)
-
     self.allow_in_control = true
 
     def regexp

data/lib/byebug/commands/show.rb

@@ -17,129 +17,60 @@ module Byebug
         else
           args = ''
         end
-        return "Argument list to give program being debugged when it is started is \"#{args}\"."
+        "Argument list to give program being debugged when it is started is \"#{args}\"."
       when /^autolist$/
-        on_off = Command.settings[:autolist] > 0
-        return "autolist is #{show_onoff(on_off)}."
-      when /^autoeval$/
-        on_off = Command.settings[:autoeval]
-        return "autoeval is #{show_onoff(on_off)}."
-      when /^autoreload$/
-        on_off = Command.settings[:autoreload]
-        return "autoreload is #{show_onoff(on_off)}."
+        "autolist is #{show_onoff(Command.settings[:autolist] > 0)}."
       when /^autoirb$/
-        on_off = Command.settings[:autoirb] > 0
-        return "autoirb is #{show_onoff(on_off)}."
-      when /^basename$/
-        on_off = Command.settings[:basename]
-        return "basename is #{show_onoff(on_off)}."
+        "autoirb is #{show_onoff(Command.settings[:autoirb] > 0)}."
+      when /^autosave$/
+        "Saving history is #{show_onoff(Command.settings[:autosave])}."
       when /^callstyle$/
-        style = Command.settings[:callstyle]
-        return "Frame call-display style is #{style}."
+        "Frame call-display style is #{Command.settings[:callstyle]}."
       when /^commands(:?\s+(\d+))?$/
-        if @state.interface.readline_support?
-          s = '';
+        if Command.settings[:autosave]
+          history = Byebug::History
           args = @match[1].split
           if args[1]
-            first_line = args[1].to_i - 4
-            last_line  = first_line + 10 - 1
-            if first_line > Readline::HISTORY.length
-              first_line = last_line = Readline::HISTORY.length
-            elsif first_line <= 0
-              first_line = 1
-            end
-            if last_line > Readline::HISTORY.length
-              last_line = Readline::HISTORY.length
-            end
-            i = first_line
-            commands = Readline::HISTORY.to_a[first_line..last_line]
-          else
-            if Readline::HISTORY.length > 10
-              commands = Readline::HISTORY.to_a[-10..-1]
-              i = Readline::HISTORY.length - 10
-            else
-              commands = Readline::HISTORY.to_a
-              i = 1
-            end
-          end
-          commands.each do |cmd|
-            s += ("%5d  %s\n" % [i, cmd])
-            i += 1
+            size = get_int(args[1], 'show commands', 1, history.max_size)
           end
+          size ? history.to_s(size) : history.to_s
         else
-          s='No readline support'
+          'Not currently saving history. Enable it with "set autosave"'
         end
-        return s
       when /^testing$/
-        on_off = Command.settings[:testing]
-        return "Currently testing byebug is #{show_onoff(on_off)}."
+        "Currently testing byebug is #{show_onoff(Command.settings[:testing])}."
       when /^forcestep$/
-        on_off = Command.settings[:forcestep]
-        return "force-stepping is #{show_onoff(on_off)}."
+        "force-stepping is #{show_onoff(Command.settings[:forcestep])}."
       when /^fullpath$/
-        on_off = Command.settings[:fullpath]
-        return "Displaying frame's full file names is #{show_onoff(on_off)}."
-      when /^history(:?\s+(filename|save|size))?$/
-        args = @match[1].split
-        interface = @state.interface
-        if args[1]
-          show_save = show_size = show_filename = false
-          prefix = false
-          if args[1] == "save"
-            show_save = true
-          elsif args[1] == "size"
-            show_size = true
-          elsif args[1] == "filename"
-            show_filename = true
-          end
-        else
-          show_save = show_size = show_filename = true
-          prefix = true
-        end
-        s = []
-        if show_filename
-          msg = "#{prefix ? 'filename:' : ''} The command history file is " \
-                "#{interface.histfile.inspect}"
-          s << msg
-        end
-        if show_save
-          msg = (prefix ? "save: " : "") +
-            "Saving of history save is #{show_onoff(interface.history_save)}."
-          s << msg
-        end
-        if show_size
-          msg = (prefix ? "size: " : "") +
-            "Byebug history size is #{interface.history_length}"
-          s << msg
-        end
-        return s.join("\n")
+        "Displaying frame's full file names is #{show_onoff(Command.settings[:fullpath])}."
+      when /^histfile$/
+        "The command history file is \"#{Byebug::History.file}\""
+      when /^histsize$/
+        "Byebug history's maximum size is #{Byebug::History.max_size}"
       when /^linetrace$/
-        on_off = Byebug.tracing?
-        return "line tracing is #{show_onoff(on_off)}."
+        "line tracing is #{show_onoff(Byebug.tracing?)}."
       when /^linetrace_plus$/
         if Command.settings[:linetrace_plus]
-          return "line tracing style is every line."
+          'line tracing style is every line.'
         else
-          return "line tracing style is different consecutive lines."
+          'line tracing style is different consecutive lines.'
         end
       when /^listsize$/
-        listlines = Command.settings[:listsize]
-        return "Number of source lines to list is #{listlines}."
+        "Number of source lines to list is #{Command.settings[:listsize]}."
       when /^post_mortem$/
-        on_off = Byebug.post_mortem?
-        return "post-mortem mode is #{show_onoff(on_off)}"
+        "Post-mortem mode is #{show_onoff(Byebug.post_mortem?)}"
       when /^stack_on_error$/
-        on_off = Command.settings[:stack_on_error]
-        return "Displaying stack trace is #{show_onoff(on_off)}."
+        "Displaying stack trace is #{show_onoff(Command.settings[:stack_on_error])}."
       when /^verbose$/
-        on_off = Byebug.verbose
-        return "Verbose output of TracePoint API events is #{show_onoff(on_off)}."
+        "Verbose output of TracePoint API events is #{show_onoff(Byebug.verbose)}."
       when /^version$/
-        return "Byebug #{Byebug::VERSION}"
+        "Byebug #{Byebug::VERSION}"
       when /^width$/
-        return "width is #{Command.settings[:width]}."
+        "Width is #{Command.settings[:width]}."
+      when /^autoeval|autoreload|basename$/x
+        "#{setting_name} is #{show_onoff(Command.settings[setting_name.to_sym])}."
       else
-        return "Unknown show subcommand #{setting_name}."
+        "Unknown show subcommand #{setting_name}."
       end
     end
   end
@@ -150,12 +81,14 @@ module Byebug
     Subcommands = [
       ['args'          , 2 , 'Show argument list to the program being '     \
                              'debugged when it is started'                    ],
-      ['autoeval'      , 4 , 'Show whether unrecognized commands are '      \
+      ['autoeval'      , 5 , 'Show whether unrecognized commands are '      \
                              'evaluated'                                      ],
-      ['autolist'      , 4 , 'Show whether "list" command is run on stopping' ],
-      ['autoirb'       , 4 , 'Show whether IRB is invoked on stopping'        ],
-      ['autoreload'    , 4 , 'Show whether source code is reloaded when '   \
+      ['autolist'      , 5 , 'Show whether "list" command is run on stopping' ],
+      ['autoirb'       , 5 , 'Show whether IRB is invoked on stopping'        ],
+      ['autoreload'    , 5 , 'Show whether source code is reloaded when '   \
                              'changed'                                        ],
+      ['autosave'      , 5 , 'Show whether command history is '             \
+                             'automatically saved on exit'                    ],
       ['basename'      , 1 , 'Show whether basename is used when reporting' \
                              ' files'                                         ],
       ['callstyle'     , 2 , 'Show parameter style used when showing call'  \
@@ -165,7 +98,9 @@ module Byebug
       ['forcestep'     , 1 , 'Show whether "next/step" commands are set to' \
                              ' always move to a line'                         ],
       ['fullpath'      , 2 , 'Show whether full paths are displayed in frames'],
-      ['history'       , 2 , 'Show command history configurations. '          ],
+      ['histfile'      , 5 , 'File where byebug save history of commands'     ],
+      ['histsize'      , 5 , 'Maximum number of commands stored in '        \
+                             'byebug\'s history'                              ],
       ['linetrace'     , 3 , 'Show line execution tracing status'             ],
       ['linetrace_plus', 10, 'Show whether different consecutive lines are' \
                              ' shown in tracing'                              ],
@@ -183,14 +118,6 @@ module Byebug
       Subcmd.new(name, min, help)
     end unless defined?(Subcommands)
 
-    ShowHistorySubcommands = [
-      ['filename', 1, 'Show the filename in which to record command history' ],
-      ['save'    , 1, 'Show whether history record should be saved on exit'  ],
-      ['size'    , 1, 'Show 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
 
     def regexp

data/lib/byebug/commands/stepping.rb

@@ -18,7 +18,6 @@ module Byebug
   # Implements byebug "next" command.
   class NextCommand < Command
     self.allow_in_post_mortem = false
-    self.need_context         = true
 
     def regexp
       /^\s* n(?:ext)?([+-])? (?:\s+(\S+))? \s*$/x
@@ -48,7 +47,6 @@ module Byebug
   # Implements byebug "step" command.
   class StepCommand < Command
     self.allow_in_post_mortem = false
-    self.need_context         = true
 
     def regexp
       /^\s* s(?:tep)?([+-]) ?(?:\s+(\S+))? \s*$/x

data/lib/byebug/commands/threads.rb

@@ -90,8 +90,6 @@ module Byebug
   end
 
   class ThreadCurrentCommand < Command
-    self.need_context = true
-
     def regexp
       /^\s* th(?:read)? \s+ (?:cur(?:rent)?)? \s*$/x
     end
@@ -114,7 +112,6 @@ module Byebug
   class ThreadStopCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
-    self.need_context         = true
 
     def regexp
       /^\s* th(?:read)? \s+ stop \s* (\S*) \s*$/x
@@ -141,7 +138,6 @@ module Byebug
   class ThreadResumeCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
-    self.need_context         = true
 
     def regexp
       /^\s* th(?:read)? \s+ resume \s* (\S*) \s*$/x
@@ -172,7 +168,6 @@ module Byebug
   class ThreadSwitchCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
-    self.need_context         = true
 
     def regexp
       /^\s* th(?:read)? \s+ (?:sw(?:itch)?\s+)? (\S+) \s*$/x

data/lib/byebug/commands/trace.rb

@@ -19,7 +19,7 @@ module Byebug
           if @match[3] && @match[3] !~ /(:?no)?stop/
             errmsg "expecting \"stop\" or \"nostop\"; got \"#{@match[3]}\"\n"
           else
-            dbg_cmd = (@match[3] && @match[3] !~ /nostop/) ? 'byebug(1,0)' : ''
+            dbg_cmd = (@match[3] && @match[3] !~ /nostop/) ? 'byebug(1, false)' : ''
           end
           eval("trace_var(:\"\$#{varname}\") do |val|
                   print \"traced global variable '#{varname}' has value '\#{val}'\"\n

data/lib/byebug/commands/variables.rb

@@ -27,7 +27,7 @@ module Byebug
   end
 
   # Implements byebug's 'var class' command
-  class VarClassVarCommand < Command
+  class VarClassCommand < Command
     def regexp
       /^\s* v(?:ar)? \s+ cl(?:ass)? \s*/x
     end

data/lib/byebug/context.rb

@@ -3,24 +3,20 @@ module Byebug
   class Context
 
     class << self
-      def stack_size
+      def stack_size(byebug_frames = false)
         if backtrace = Thread.current.backtrace_locations(0)
-          backtrace.drop_while { |l| !ignored(l.path) }
-                   .drop_while { |l|  ignored(l.path) }
-                   .take_while { |l| !ignored(l.path) }
-                   .size
+          unless byebug_frames
+            backtrace = backtrace.drop_while { |l| !ignored(l.path) }
+                                 .drop_while { |l|  ignored(l.path) }
+                                 .take_while { |l| !ignored(l.path) }
+          end
+          backtrace.size
         else
-          print 'No backtrace available!!'
+          print 'WARNING: No backtrace available!!'
           0
         end
       end
 
-      def real_stack_size
-        if backtrace = Thread.current.backtrace_locations(0)
-          backtrace.size
-        end
-      end
-
       def ignored(path)
         IGNORED_FILES.include?(path)
       end

data/lib/byebug/helper.rb

@@ -61,7 +61,7 @@ module Byebug
     # Return true if code is syntactically correct for Ruby.
     def syntax_valid?(code)
       eval("BEGIN {return true}\n#{code}", nil, "", 0)
-    rescue Exception
+    rescue SyntaxError
       false
     end
 

data/lib/byebug/history.rb

@@ -0,0 +1,46 @@
+require 'readline'
+
+module Byebug
+  class History
+    DEFAULT_FILE = File.expand_path("#{ENV['HOME']||'.'}/.byebug_hist")
+    DEFAULT_MAX_SIZE = 256
+
+    @file = DEFAULT_FILE
+    @max_size = DEFAULT_MAX_SIZE
+
+    class << self
+      attr_accessor :file, :max_size
+
+      def load
+        open(@file, 'r') do |file|
+          file.each do |line|
+            line.chomp!
+            Readline::HISTORY << line
+          end
+        end if File.exist?(@file)
+      end
+
+      def save
+        open(@file, 'w') do |file|
+          Readline::HISTORY.to_a.last(@max_size).each do |line|
+            file.puts line unless line.strip.empty?
+          end
+        end
+      end
+
+      def to_s(size = @max_size)
+        n_entries = Readline::HISTORY.length < size ? Readline::HISTORY.length : size
+
+        first = Readline::HISTORY.length - n_entries
+        commands = Readline::HISTORY.to_a.last(n_entries)
+
+        s = ''
+        commands.each_with_index do |command, index|
+          s += ("%5d  %s\n" % [first + index + 1, command])
+        end
+
+        return s
+      end
+    end
+  end
+end