byebug 5.0.0 → 6.0.0

data/lib/byebug/processors/control_processor.rb

@@ -0,0 +1,20 @@
+module Byebug
+  #
+  # Processes commands when there's not program running
+  #
+  class ControlProcessor < CommandProcessor
+    #
+    # Available commands
+    #
+    def commands
+      super.select(&:allow_in_control)
+    end
+
+    #
+    # Prompt shown before reading a command.
+    #
+    def prompt
+      '(byebug:ctrl) '
+    end
+  end
+end

data/lib/byebug/processors/post_mortem_processor.rb

@@ -0,0 +1,16 @@
+require 'byebug/processors/command_processor'
+
+module Byebug
+  #
+  # Processes commands in post_mortem mode
+  #
+  class PostMortemProcessor < CommandProcessor
+    def commands
+      super.select(&:allow_in_post_mortem)
+    end
+
+    def prompt
+      '(byebug:post_mortem) '
+    end
+  end
+end

data/lib/byebug/processors/script_processor.rb

@@ -0,0 +1,49 @@
+module Byebug
+  #
+  # Processes commands from a file
+  #
+  class ScriptProcessor < CommandProcessor
+    #
+    # Available commands
+    #
+    def commands
+      super.select(&:allow_in_control)
+    end
+
+    def process_commands
+      while (input = interface.read_command(prompt))
+        command = command_list.match(input)
+
+        if command
+          command.new(self).execute
+        else
+          errmsg('Unknown command')
+        end
+      end
+
+      interface.close
+    rescue IOError, SystemCallError
+      interface.close
+    rescue
+      without_exceptions do
+        puts "INTERNAL ERROR!!! #{$ERROR_INFO}"
+        puts $ERROR_INFO.backtrace.map { |l| "\t#{l}" }.join("\n")
+      end
+    end
+
+    #
+    # Prompt shown before reading a command.
+    #
+    def prompt
+      '(byebug:ctrl) '
+    end
+
+    private
+
+    def without_exceptions
+      yield
+    rescue
+      nil
+    end
+  end
+end

data/lib/byebug/remote.rb

@@ -1,5 +1,10 @@
 require 'socket'
 
+#
+# Remote debugging functionality.
+#
+# TODO: Refactor & add tests
+#
 module Byebug
   # Port number used for remote debugging
   PORT = 8989 unless defined?(PORT)
@@ -25,7 +30,7 @@ module Byebug
     def start_server(host = nil, port = PORT)
       return if @thread
 
-      handler.interface = nil
+      Context.interface = nil
       start
 
       start_control(host, port == 0 ? 0 : port + 1)
@@ -40,7 +45,7 @@ module Byebug
 
       @thread = DebugThread.new do
         while (session = server.accept)
-          handler.interface = RemoteInterface.new(session)
+          Context.interface = RemoteInterface.new(session)
           mutex.synchronize { proceed.signal } if wait_connection
         end
       end
@@ -55,8 +60,9 @@ module Byebug
 
       @control_thread = DebugThread.new do
         while (session = server.accept)
-          handler.interface = RemoteInterface.new(session)
-          ControlCommandProcessor.new(handler.interface).process_commands
+          Context.interface = RemoteInterface.new(session)
+
+          ControlCommandProcessor.new(Byebug.current_context).process_commands
         end
       end
 
@@ -67,7 +73,7 @@ module Byebug
     # Connects to the remote byebug
     #
     def start_client(host = 'localhost', port = PORT)
-      handler.interface = LocalInterface.new
+      Context.interface = LocalInterface.new
       puts 'Connecting to byebug server...'
       socket = TCPSocket.new(host, port)
       puts 'Connected.'
@@ -76,11 +82,11 @@ module Byebug
         while (line = socket.gets)
           case line
           when /^PROMPT (.*)$/
-            input = handler.interface.read_command(Regexp.last_match[1])
+            input = Context.interface.read_command(Regexp.last_match[1])
             throw :exit unless input
             socket.puts input
           when /^CONFIRM (.*)$/
-            input = handler.interface.confirm(Regexp.last_match[1])
+            input = Context.interface.confirm(Regexp.last_match[1])
             throw :exit unless input
             socket.puts input
           else

data/lib/byebug/runner.rb

@@ -1,7 +1,10 @@
 require 'optparse'
 require 'English'
 require 'byebug/core'
+require 'byebug/version'
 require 'byebug/helpers/parse'
+require 'byebug/option_setter'
+require 'byebug/processors/control_processor'
 
 module Byebug
   #
@@ -11,24 +14,29 @@ module Byebug
     include Helpers::ParseHelper
 
     #
-    # Error class signaling absence of a script to debug
+    # Error class signaling absence of a script to debug.
     #
     class NoScript < StandardError; end
 
     #
-    # Error class signaling a non existent script to debug
+    # Error class signaling a non existent script to debug.
     #
     class NonExistentScript < StandardError; end
 
     #
-    # Error class signaling a script with invalid Ruby syntax
+    # Error class signaling a script with invalid Ruby syntax.
     #
     class InvalidScript < StandardError; end
 
     #
     # Special working modes that don't actually start the debugger.
     #
-    attr_accessor :help, :version, :remote
+    attr_reader :help, :version, :remote
+
+    #
+    # Signals that we should exit after the debugged program is finished.
+    #
+    attr_accessor :quit
 
     #
     # @param stop [Boolean] Whether the runner should stop right before
@@ -42,6 +50,22 @@ module Byebug
       @quit = quit
     end
 
+    def help=(text)
+      @help ||= text
+
+      interface.puts("\n#{text}\n")
+    end
+
+    def version=(number)
+      @version ||= number
+
+      interface.puts("\n  Running byebug #{number}\n")
+    end
+
+    def remote=(host_and_port)
+      @remote ||= Byebug.parse_host_and_port(host_and_port)
+    end
+
     #
     # Usage banner.
     #
@@ -56,20 +80,11 @@ module Byebug
     end
 
     #
-    # Starts byebug to debug a program
+    # Starts byebug to debug a program.
     #
     def run
       prepare_options.order!($ARGV)
-
-      if version
-        Byebug.puts("\n  Running byebug #{version}\n")
-        return
-      end
-
-      if help
-        Byebug.puts("#{help}\n")
-        return
-      end
+      return if version || help
 
       if remote
         Byebug.start_client(*remote)
@@ -81,70 +96,29 @@ module Byebug
       loop do
         debug_program
 
-        break if @quit
+        break if quit
 
-        processor = Byebug::ControlCommandProcessor.new
-        processor.process_commands
+        ControlProcessor.new.process_commands
       end
     end
 
-    private
+    def interface
+      @interface ||= LocalInterface.new
+    end
 
     #
-    # Processes options passed from the command line
+    # Processes options passed from the command line.
     #
     def prepare_options
       OptionParser.new(banner, 25) do |opts|
         opts.banner = banner
 
-        opts.on '-d', '--debug', 'Set $DEBUG=true' do
-          $DEBUG = true
-        end
-
-        opts.on('-I', '--include list', 'Add to paths to $LOAD_PATH') do |list|
-          $LOAD_PATH.push(list.split(':')).flatten!
-        end
-
-        opts.on '-m', '--[no-]post-mortem', 'Use post-mortem mode' do |v|
-          Setting[:post_mortem] = v
-        end
-
-        opts.on '-q', '--[no-]quit', 'Quit when script finishes' do |v|
-          @quit = v
-        end
-
-        opts.on '-x', '--[no-]rc', 'Run byebug initialization file' do |v|
-          Byebug.run_init_script if v
-        end
-
-        opts.on '-s', '--[no-]stop', 'Stop when script is loaded' do |v|
-          @stop = v
-        end
-
-        opts.on '-r', '--require file', 'Require library before script' do |lib|
-          require lib
-        end
-
-        opts.on '-R', '--remote [host:]port', 'Remote debug [host:]port' do |p|
-          self.remote = Byebug.parse_host_and_port(p)
-        end
-
-        opts.on '-t', '--[no-]trace', 'Turn on line tracing' do |v|
-          Setting[:linetrace] = v
-        end
-
-        opts.on '-v', '--version', 'Print program version' do
-          self.version = VERSION
-        end
-
-        opts.on('-h', '--help', 'Display this message') do
-          self.help = opts.help
-        end
+        OptionSetter.new(self, opts).setup
       end
     end
 
     #
-    # Extracts debugged program from command line args
+    # Extracts debugged program from command line args.
     #
     def setup_cmd_line_args
       Byebug.mode = :standalone
@@ -166,7 +140,7 @@ module Byebug
       fail(InvalidScript, 'The script has incorrect syntax') unless ok
 
       error = Byebug.debug_load($PROGRAM_NAME, @stop)
-      Byebug.puts "#{status}\n#{status.backtrace}" if error
+      puts "#{error}\n#{error.backtrace}" if error
     end
 
     #

data/lib/byebug/setting.rb

@@ -57,8 +57,11 @@ module Byebug
         matches.size == 1 ? matches.values.first : nil
       end
 
+      #
+      # TODO: DRY this up. Very similar code exists in the CommandList class
+      #
       def help_all
-        output = "  List of settings supported in byebug:\n  --\n"
+        output = "  List of supported settings:\n\n"
         width = settings.keys.max_by(&:size).size
         settings.values.each do |sett|
           output << format("  %-#{width}s -- %s\n", sett.to_sym, sett.banner)

data/lib/byebug/settings/post_mortem.rb

@@ -22,20 +22,4 @@ module Byebug
       Byebug.post_mortem?
     end
   end
-
-  #
-  # Saves information about the unhandled exception and gives a byebug
-  # prompt back to the user before program termination.
-  #
-  def self.handle_post_mortem
-    return unless Byebug.raised_exception
-
-    context = Byebug.raised_exception.__bb_context
-    file = Byebug.raised_exception.__bb_file
-    line = Byebug.raised_exception.__bb_line
-
-    Byebug.handler.at_line(context, file, line)
-  end
-
-  at_exit { Byebug.handle_post_mortem if Byebug.post_mortem? }
 end

data/lib/byebug/settings/savefile.rb

@@ -8,10 +8,7 @@ module Byebug
     DEFAULT = File.expand_path("#{ENV['HOME'] || '.'}/.byebug_save")
 
     def banner
-      <<-EOB
-        File where save commands saves current settings to. Default:
-        ~/.byebug_save
-      EOB
+      'File where settings are saved to. Default: ~/.byebug_save'
     end
 
     def to_s

data/lib/byebug/subcommands.rb

@@ -1,53 +1,51 @@
-require 'byebug/command'
-require 'byebug/subcommand_list'
+require 'forwardable'
+
+require 'byebug/helpers/reflection'
+require 'byebug/command_list'
 
 module Byebug
   #
   # Subcommand additions.
   #
   module Subcommands
-    #
-    # Summarized description of a subcommand
-    #
-    def short_description
-      fail(NotImplementedError, 'Your custom subcommand needs to define this')
+    def self.included(command)
+      command.extend(ClassMethods)
     end
 
+    extend Forwardable
+    def_delegators :'self.class', :subcommand_list
+
     #
     # Delegates to subcommands or prints help if no subcommand specified.
     #
     def execute
       return puts(help) unless @match[1]
 
-      subcmd = subcommands.find(@match[1])
-      return errmsg("Unknown subcommand '#{@match[1]}'\n") unless subcmd
+      subcmd = subcommand_list.match(@match[1])
+      fail CommandNotFound.new(@match[1], self.class) unless subcmd
 
-      subcmd.execute
+      subcmd.new(processor, arguments).execute
     end
 
     #
-    # Default help text for a command with subcommands
+    # Class methods added to subcommands
     #
-    def help
-      prettify <<-EOH
-        #{description}
-
-        List of "#{to_name}" subcommands:
+    module ClassMethods
+      include Helpers::ReflectionHelper
 
-        --
-        #{subcommands}
-      EOH
-    end
-
-    #
-    # Command's subcommands.
-    #
-    def subcommands
-      subcmd_klasses = self.class.subcommands
-      return nil unless subcmd_klasses.any?
+      #
+      # Default help text for a command with subcommands
+      #
+      def help
+        super + subcommand_list.to_s
+      end
 
-      subcmd_list = subcmd_klasses.map { |cmd| cmd.new(@state) }
-      SubcommandList.new(subcmd_list, self.class.name)
+      #
+      # Command's subcommands.
+      #
+      def subcommand_list
+        @subcommand_list ||= CommandList.new(commands)
+      end
     end
   end
 end