byebug 3.2.0 → 3.3.0

data/lib/byebug/processors/control_command_processor.rb

@@ -1,37 +1,39 @@
 module Byebug
-
+  #
+  # Processes commands in 'control' mode, when there's no program running
+  #
   class ControlCommandProcessor < Processor
-    def initialize(interface)
+    def initialize(interface = LocalInterface.new)
       super(interface)
       @context_was_dead = false # Assume we haven't started.
     end
 
-    def process_commands(verbose=false)
+    def process_commands(verbose = false)
       control_cmds = Command.commands.select do |cmd|
         cmd.allow_in_control
       end
       state = State.new(@interface, control_cmds)
-      commands = control_cmds.map{|cmd| cmd.new(state) }
+      commands = control_cmds.map { |cmd| cmd.new(state) }
 
       if @context_was_dead
-        print "The program finished.\n"
+        puts 'The program finished.'
         @context_was_dead = false
       end
 
-      while input = @interface.read_command(prompt(nil))
-        print "+#{input}" if verbose
-        catch(:debug_error) do
-          if cmd = commands.find{|c| c.match(input) }
-            cmd.execute
-          else
-            errmsg "Unknown command\n"
-          end
-        end
+      while (input = @interface.read_command(prompt(nil)))
+        puts("+#{input}") if verbose
+
+        cmd = commands.find { |c| c.match(input) }
+        return errmsg('Unknown command') unless cmd
+
+        cmd.execute
       end
     rescue IOError, SystemCallError
     rescue
-      print "INTERNAL ERROR!!! #{$!}\n" rescue nil
-      print $!.backtrace.map{|l| "\t#{l}"}.join("\n") rescue nil
+      without_exceptions do
+        puts "INTERNAL ERROR!!! #{$ERROR_INFO}"
+        puts $ERROR_INFO.backtrace.map { |l| "\t#{l}" }.join("\n")
+      end
     ensure
       @interface.close
     end
@@ -39,8 +41,8 @@ module Byebug
     #
     # Prompt shown before reading a command.
     #
-    def prompt(context)
-      return '(byebug:ctrl) '
+    def prompt(_context)
+      '(byebug:ctrl) '
     end
 
     class State
@@ -55,9 +57,9 @@ module Byebug
       end
 
       extend Forwardable
-      def_delegators :@interface, :errmsg, :print
+      def_delegators :@interface, :errmsg, :puts
 
-      def confirm(*args)
+      def confirm(*_args)
         'y'
       end
 
@@ -66,10 +68,8 @@ module Byebug
       end
 
       def file
-        errmsg "No filename given.\n"
-        throw :debug_error
+        errmsg 'No filename given.'
       end
     end
   end
-
 end

data/lib/byebug/remote.rb

@@ -1,12 +1,10 @@
 require 'socket'
 
 module Byebug
-
   # Port number used for remote debugging
   PORT = 8989 unless defined?(PORT)
 
   class << self
-
     # If in remote mode, wait for the remote connection
     attr_accessor :wait_connection
 
@@ -42,31 +40,24 @@ module Byebug
       @thread = DebugThread.new do
         while (session = server.accept)
           self.interface = RemoteInterface.new(session)
-          if wait_connection
-            mutex.synchronize do
-              proceed.signal
-            end
-          end
-        end
-      end
-      if wait_connection
-        mutex.synchronize do
-          proceed.wait(mutex)
+          mutex.synchronize { proceed.signal } if wait_connection
         end
       end
+
+      mutex.synchronize { proceed.wait(mutex) } if wait_connection
     end
 
     def start_control(host = nil, ctrl_port = PORT + 1)
-       return @actual_control_port if @control_thread
-       server = TCPServer.new(host, ctrl_port)
-       @actual_control_port = server.addr[1]
-       @control_thread = DebugThread.new do
-         while (session = server.accept)
-           interface = RemoteInterface.new(session)
-           ControlCommandProcessor.new(interface).process_commands
-         end
-       end
-       @actual_control_port
+      return @actual_control_port if @control_thread
+      server = TCPServer.new(host, ctrl_port)
+      @actual_control_port = server.addr[1]
+      @control_thread = DebugThread.new do
+        while (session = server.accept)
+          interface = RemoteInterface.new(session)
+          ControlCommandProcessor.new(interface).process_commands
+        end
+      end
+      @actual_control_port
     end
 
     #
@@ -75,21 +66,21 @@ module Byebug
     def start_client(host = 'localhost', port = PORT)
       interface = LocalInterface.new
       socket = TCPSocket.new(host, port)
-      puts "Connected."
+      puts 'Connected.'
 
       catch(:exit) do
         while (line = socket.gets)
           case line
           when /^PROMPT (.*)$/
-            input = interface.read_command($1)
+            input = interface.read_command(Regexp.last_match[1])
             throw :exit unless input
             socket.puts input
           when /^CONFIRM (.*)$/
-            input = interface.confirm($1)
+            input = interface.confirm(Regexp.last_match[1])
             throw :exit unless input
             socket.puts input
           else
-            print line
+            puts line
           end
         end
       end

data/lib/byebug/runner.rb

@@ -0,0 +1,100 @@
+require 'slop'
+require 'ostruct'
+require 'English'
+require 'byebug/core'
+require 'byebug/options'
+
+module Byebug
+  #
+  # Responsible for starting the debugger when started from the command line.
+  #
+  class Runner
+    BYEBUG_SCRIPT = File.expand_path('../../../../bin/byebug')
+    IGNORED_FILES << BYEBUG_SCRIPT
+
+    #
+    # Debug a script only if syntax checks okay.
+    #
+    def debug_program(options)
+      output = `ruby -c "#{Byebug::PROG_SCRIPT}" 2>&1`
+      if $CHILD_STATUS.exitstatus != 0
+        Byebug.puts output
+        exit $CHILD_STATUS.exitstatus
+      end
+
+      status = Byebug.debug_load(Byebug::PROG_SCRIPT, options[:stop])
+      Byebug.puts "#{status}\n#{status.backtrace}" if status
+    end
+
+    #
+    # Do a shell-like path lookup for prog_script and return the results. If we
+    # can't find anything return prog_script.
+    #
+    def whence_file(prog_script)
+      if prog_script.index(File::SEPARATOR)
+        # Don't search since this name has path separator components
+        return prog_script
+      end
+
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |dirname|
+        prog_script_try = File.join(dirname, prog_script)
+        return prog_script_try if File.exist?(prog_script_try)
+      end
+
+      # Failure
+      prog_script
+    end
+
+    #
+    # Starts byebug to debug a program
+    #
+    def run
+      opts = Byebug::Options.parse
+
+      return Byebug.puts("\n  Running byebug #{VERSION}\n") if opts[:version]
+      return Byebug.puts("#{opts.help}\n") if opts[:help]
+
+      if opts[:remote]
+        port, host = opts[:remote].pop.to_i, opts[:remote].pop || 'localhost'
+        Byebug.puts "Connecting to byebug server #{host}:#{port}..."
+        Byebug.start_client(host, port)
+        return
+      end
+
+      if ARGV.empty?
+        Byebug.puts 'You must specify a program to debug...'
+        abort
+      end
+
+      # Save debugged program
+      prog_script = ARGV.pop
+      prog_script = whence_file(prog_script) unless File.exist?(prog_script)
+
+      if Byebug.const_defined?('PROG_SCRIPT')
+        Byebug.send(:remove_const, 'PROG_SCRIPT')
+      end
+      Byebug.const_set('PROG_SCRIPT', File.expand_path(prog_script))
+
+      # Set up trace hook for byebug
+      Byebug.start
+
+      # load initrc script (e.g. .byebugrc)
+      Byebug.run_init_script(StringIO.new) if opts[:rc]
+
+      # Post Mortem mode status
+      Byebug::Setting[:post_mortem] = opts[:'post-mortem']
+
+      # Line Tracing Status
+      Byebug::Setting[:linetrace] = opts[:trace]
+
+      loop do
+        debug_program(opts)
+
+        break if opts[:quit]
+
+        processor = Byebug::ControlCommandProcessor.new
+        processor.process_commands
+      end
+    end
+  end
+end

data/lib/byebug/setting.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Parent class for all byebug settings.
+  #
   class Setting
     attr_accessor :value
 
@@ -34,8 +37,9 @@ module Byebug
     end
 
     def integer?
-      integer = Integer(value) rescue nil
-      integer ? true : false
+      Integer(value) ? true : false
+    rescue ArgumentError
+      false
     end
 
     def self.exists?(name)
@@ -61,18 +65,39 @@ module Byebug
       matches.size == 1 ? matches.keys.first : nil
     end
 
-    def self.format()
-      output = "List of settings supported in byebug:\n"
+    def self.help_all
+      output = "  List of settings supported in byebug:\n  --\n"
       width = settings.keys.max_by(&:size).size
-      settings.values.each do |setting|
-        output << sprintf("%-#{width}s -- %s\n", setting.to_sym, setting.help)
+      settings.values.each do |sett|
+        output << format("  %-#{width}s -- %s\n", sett.to_sym, sett.banner)
       end
-      output
+      output + "\n"
+    end
+
+    def self.help(cmd, subcmd)
+      if subcmd
+        camelized = subcmd.split('_').map { |w| w.capitalize }.join
+        setting = Byebug.const_get("#{camelized}Setting").new
+        <<-EOH.gsub(/^ {8}/, '')
+
+          #{cmd} #{setting.to_sym} <value>
+
+          #{setting.banner}.
+
+        EOH
+      else
+        command = Byebug.const_get("#{cmd.capitalize}Command")
+        command.description + help_all
+      end
+    end
+
+    def help
+      "\n  #{banner}.\n\n"
     end
 
     def to_sym
       name = self.class.name.gsub(/^Byebug::/, '').gsub(/Setting$/, '')
-      name.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym
+      name.gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym
     end
 
     def to_s

data/lib/byebug/settings/autoeval.rb

@@ -1,22 +1,12 @@
 module Byebug
+  #
+  # Setting for automatic evaluation of unknown commands.
+  #
   class AutoevalSetting < Setting
     DEFAULT = true
 
-    def initialize
-      EvalCommand.unknown = DEFAULT
-    end
-
-    def help
-      'If true, byebug will evaluate every unrecognized command. If false, ' \
-      'need to use the `eval` command to evaluate stuff'
-    end
-
-    def value=(v)
-      EvalCommand.unknown = v
-    end
-
-    def value
-      EvalCommand.unknown
+    def banner
+      'Automatically evaluate unrecognized commands'
     end
   end
 end

data/lib/byebug/settings/autoirb.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Setting for automatically invoking IRB on every stop.
+  #
   class AutoirbSetting < Setting
     DEFAULT = 0
 
@@ -6,7 +9,7 @@ module Byebug
       IrbCommand.always_run = DEFAULT
     end
 
-    def help
+    def banner
       'Invoke IRB on every stop'
     end
 

data/lib/byebug/settings/autolist.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Setting for automatically listing source code on every stop.
+  #
   class AutolistSetting < Setting
     DEFAULT = 1
 
@@ -6,8 +9,8 @@ module Byebug
       ListCommand.always_run = DEFAULT
     end
 
-    def help
-      'If true, `list` command is run everytime byebug stops'
+    def banner
+      'Invoke list command on every stop'
     end
 
     def value=(v)

data/lib/byebug/settings/autoreload.rb

@@ -1,9 +1,12 @@
 module Byebug
+  #
+  # Setting for automatically reloading source code when it is changed.
+  #
   class AutoreloadSetting < Setting
     DEFAULT = true
 
-    def help
-      'Reload source code when changed'
+    def banner
+      'Automatically reload source code when it is changed'
     end
   end
 end

data/lib/byebug/settings/autosave.rb

@@ -1,9 +1,13 @@
 module Byebug
+  #
+  # Setting for automatically saving previously entered commands to history
+  # when exiting the debugger.
+  #
   class AutosaveSetting < Setting
     DEFAULT = true
 
-    def help
-      'If true, command history record is saved on exit'
+    def banner
+      'Automatically save command history record on exit'
     end
   end
 end

data/lib/byebug/settings/basename.rb

@@ -1,7 +1,12 @@
 module Byebug
+  #
+  # Command to display short paths in file names.
+  #
+  # For example, when displaying source code information.
+  #
   class BasenameSetting < Setting
-    def help
-      'Filename display style.'
+    def banner
+      '<file>:<line> information after every stop uses short paths'
     end
   end
 end