byebug 9.0.5 → 11.1.3

data/lib/byebug/remote.rb

@@ -1,11 +1,13 @@
-require 'socket'
-require 'byebug/processors/control_processor'
+# frozen_string_literal: true
+
+require "socket"
+require_relative "processors/control_processor"
+require_relative "remote/server"
+require_relative "remote/client"
 
 #
 # Remote debugging functionality.
 #
-# @todo Refactor & add tests
-#
 module Byebug
   # Port number used for remote debugging
   PORT = 8989 unless defined?(PORT)
@@ -15,8 +17,14 @@ module Byebug
     attr_accessor :wait_connection
 
     # The actual port that the server is started at
-    attr_accessor :actual_port
-    attr_reader :actual_control_port
+    def actual_port
+      server.actual_port
+    end
+
+    # The actual port that the control server is started at
+    def actual_control_port
+      control.actual_port
+    end
 
     #
     # Interrupts the current thread
@@ -26,80 +34,52 @@ module Byebug
     end
 
     #
-    # Starts a remote byebug
+    # Starts the remote server main thread
     #
     def start_server(host = nil, port = PORT)
-      return if @thread
-
-      Context.interface = nil
-      start
-
-      start_control(host, port == 0 ? 0 : port + 1)
+      start_control(host, port.zero? ? 0 : port + 1)
 
-      yield if block_given?
-
-      mutex = Mutex.new
-      proceed = ConditionVariable.new
-
-      server = TCPServer.new(host, port)
-      self.actual_port = server.addr[1]
-
-      @thread = DebugThread.new do
-        while (session = server.accept)
-          Context.interface = RemoteInterface.new(session)
-          mutex.synchronize { proceed.signal } if wait_connection
-        end
-      end
+      server.start(host, port)
+    end
 
-      mutex.synchronize { proceed.wait(mutex) } if wait_connection
+    #
+    # Starts the remote server control thread
+    #
+    def start_control(host = nil, port = PORT + 1)
+      control.start(host, port)
     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]
+    #
+    # Connects to the remote byebug
+    #
+    def start_client(host = "localhost", port = PORT)
+      client.start(host, port)
+    end
 
-      @control_thread = DebugThread.new do
-        while (session = server.accept)
-          Context.interface = RemoteInterface.new(session)
+    def parse_host_and_port(host_port_spec)
+      location = host_port_spec.split(":")
+      location[1] ? [location[0], location[1].to_i] : ["localhost", location[0]]
+    end
 
-          ControlProcessor.new(Byebug.current_context).process_commands
-        end
-      end
+    private
 
-      @actual_control_port
+    def client
+      @client ||= Remote::Client.new(Context.interface)
     end
 
-    #
-    # Connects to the remote byebug
-    #
-    def start_client(host = 'localhost', port = PORT)
-      interface = LocalInterface.new
-      puts 'Connecting to byebug server...'
-      socket = TCPSocket.new(host, port)
-      puts 'Connected.'
-
-      while (line = socket.gets)
-        case line
-        when /^PROMPT (.*)$/
-          input = interface.read_command(Regexp.last_match[1])
-          break unless input
-          socket.puts input
-        when /^CONFIRM (.*)$/
-          input = interface.readline(Regexp.last_match[1])
-          break unless input
-          socket.puts input
-        else
-          puts line
-        end
+    def server
+      @server ||= Remote::Server.new(wait_connection: wait_connection) do |s|
+        Context.interface = RemoteInterface.new(s)
       end
-
-      socket.close
     end
 
-    def parse_host_and_port(host_port_spec)
-      location = host_port_spec.split(':')
-      location[1] ? [location[0], location[1].to_i] : ['localhost', location[0]]
+    def control
+      @control ||= Remote::Server.new(wait_connection: false) do |s|
+        context = Byebug.current_context
+        interface = RemoteInterface.new(s)
+
+        ControlProcessor.new(context, interface).process_commands
+      end
     end
   end
 end

data/lib/byebug/runner.rb

@@ -1,17 +1,23 @@
-require 'optparse'
-require 'English'
-require 'byebug/core'
-require 'byebug/version'
-require 'byebug/helpers/parse'
-require 'byebug/option_setter'
-require 'byebug/processors/control_processor'
+# frozen_string_literal: true
+
+require "optparse"
+require "English"
+require_relative "core"
+require_relative "version"
+require_relative "helpers/bin"
+require_relative "helpers/parse"
+require_relative "helpers/string"
+require_relative "option_setter"
+require_relative "processors/control_processor"
 
 module Byebug
   #
   # Responsible for starting the debugger when started from the command line.
   #
   class Runner
+    include Helpers::BinHelper
     include Helpers::ParseHelper
+    include Helpers::StringHelper
 
     #
     # Special working modes that don't actually start the debugger.
@@ -54,7 +60,9 @@ module Byebug
     def version=(number)
       @version ||= number
 
-      interface.puts("\n  Running byebug #{number}\n")
+      interface.puts prettify <<-VERSION
+        Running byebug #{number}
+      VERSION
     end
 
     def remote=(host_and_port)
@@ -71,22 +79,24 @@ module Byebug
     # Usage banner.
     #
     def banner
-      <<-EOB.gsub(/^ {6}/, '')
-
+      prettify <<-BANNER
         byebug #{Byebug::VERSION}
 
         Usage: byebug [options] <script.rb> -- <script.rb parameters>
-
-      EOB
+      BANNER
     end
 
     #
     # Starts byebug to debug a program.
     #
     def run
+      Byebug.mode = :standalone
+
       option_parser.order!($ARGV)
       return if non_script_option? || error_in_script?
 
+      $PROGRAM_NAME = program
+
       Byebug.run_init_script if init_script
 
       loop do
@@ -94,14 +104,12 @@ module Byebug
 
         break if quit
 
-        ControlProcessor.new.process_commands
+        ControlProcessor.new(nil, interface).process_commands
       end
     end
 
-    attr_writer :interface
-
     def interface
-      @interface ||= LocalInterface.new
+      @interface ||= Context.interface
     end
 
     #
@@ -115,6 +123,18 @@ module Byebug
       end
     end
 
+    def program
+      @program ||= begin
+                     candidate = which($ARGV.shift)
+
+                     if [which("ruby"), RbConfig.ruby].include?(candidate)
+                       which($ARGV.shift)
+                     else
+                       candidate
+                     end
+                   end
+    end
+
     #
     # An option that doesn't need a script specified was given
     #
@@ -135,7 +155,7 @@ module Byebug
     def no_script?
       return false unless $ARGV.empty?
 
-      print_error('You must specify a program to debug')
+      print_error("You must specify a program to debug")
       true
     end
 
@@ -143,27 +163,19 @@ module Byebug
     # Extracts debugged program from command line args.
     #
     def non_existing_script?
-      Byebug.mode = :standalone
+      return false if program
 
-      program = which($ARGV.shift)
-      program = which($ARGV.shift) if program == which('ruby')
-
-      if program
-        $PROGRAM_NAME = program
-        false
-      else
-        print_error("The script doesn't exist")
-        true
-      end
+      print_error("The script doesn't exist")
+      true
     end
 
     #
     # Checks the debugged script has correct syntax
     #
     def invalid_script?
-      return false if syntax_valid?(File.read($PROGRAM_NAME))
+      return false if syntax_valid?(File.read(program))
 
-      print_error('The script has incorrect syntax')
+      print_error("The script has incorrect syntax")
       true
     end
 
@@ -171,28 +183,10 @@ module Byebug
     # Debugs a script only if syntax checks okay.
     #
     def debug_program
-      error = Byebug.debug_load($PROGRAM_NAME, stop)
+      error = Byebug.debug_load(program, stop)
       puts "#{error}\n#{error.backtrace}" if error
     end
 
-    #
-    # Cross-platform way of finding an executable in the $PATH.
-    # Borrowed from: http://stackoverflow.com/questions/2108727
-    #
-    def which(cmd)
-      return File.expand_path(cmd) if File.exist?(cmd)
-
-      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-        exts.each do |ext|
-          exe = File.join(path, "#{cmd}#{ext}")
-          return exe if File.executable?(exe) && !File.directory?(exe)
-        end
-      end
-
-      nil
-    end
-
     #
     # Prints an error message and a help string
     #

data/lib/byebug/setting.rb

@@ -1,4 +1,6 @@
-require 'byebug/helpers/string'
+# frozen_string_literal: true
+
+require_relative "helpers/string"
 
 module Byebug
   #
@@ -28,7 +30,7 @@ module Byebug
     end
 
     def to_sym
-      name = self.class.name.gsub(/^Byebug::/, '').gsub(/Setting$/, '')
+      name = self.class.name.gsub(/^Byebug::/, "").gsub(/Setting$/, "")
       name.gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym
     end
 
@@ -50,7 +52,7 @@ module Byebug
       end
 
       def find(shortcut)
-        abbr = shortcut =~ /^no/ ? shortcut[2..-1] : shortcut
+        abbr = /^no/.match?(shortcut) ? shortcut[2..-1] : shortcut
         matches = settings.select do |key, value|
           key =~ (value.boolean? ? /#{abbr}/ : /#{shortcut}/)
         end
@@ -63,8 +65,12 @@ module Byebug
       def help_all
         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)
+        settings.each_value do |sett|
+          output += format(
+            "  %<name>-#{width}s -- %<description>s\n",
+            name: sett.to_sym,
+            description: sett.banner
+          )
         end
         output + "\n"
       end

data/lib/byebug/settings/autoirb.rb

@@ -1,5 +1,7 @@
-require 'byebug/setting'
-require 'byebug/commands/irb'
+# frozen_string_literal: true
+
+require_relative "../setting"
+require_relative "../commands/irb"
 
 module Byebug
   #
@@ -13,11 +15,11 @@ module Byebug
     end
 
     def banner
-      'Invoke IRB on every stop'
+      "Invoke IRB on every stop"
     end
 
-    def value=(v)
-      IrbCommand.always_run = v ? 1 : 0
+    def value=(val)
+      IrbCommand.always_run = val ? 1 : 0
     end
 
     def value

data/lib/byebug/settings/autolist.rb

@@ -1,5 +1,7 @@
-require 'byebug/setting'
-require 'byebug/commands/list'
+# frozen_string_literal: true
+
+require_relative "../setting"
+require_relative "../commands/list"
 
 module Byebug
   #
@@ -13,11 +15,11 @@ module Byebug
     end
 
     def banner
-      'Invoke list command on every stop'
+      "Invoke list command on every stop"
     end
 
-    def value=(v)
-      ListCommand.always_run = v ? 1 : 0
+    def value=(val)
+      ListCommand.always_run = val ? 1 : 0
     end
 
     def value

data/lib/byebug/settings/autopry.rb

@@ -1,5 +1,7 @@
-require 'byebug/setting'
-require 'byebug/commands/pry'
+# frozen_string_literal: true
+
+require_relative "../setting"
+require_relative "../commands/pry"
 
 module Byebug
   #
@@ -13,11 +15,11 @@ module Byebug
     end
 
     def banner
-      'Invoke Pry on every stop'
+      "Invoke Pry on every stop"
     end
 
-    def value=(v)
-      PryCommand.always_run = v ? 1 : 0
+    def value=(val)
+      PryCommand.always_run = val ? 1 : 0
     end
 
     def value

data/lib/byebug/settings/autosave.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -9,7 +11,7 @@ module Byebug
     DEFAULT = true
 
     def banner
-      'Automatically save command history record on exit'
+      "Automatically save command history record on exit"
     end
   end
 end

data/lib/byebug/settings/basename.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -8,7 +10,7 @@ module Byebug
   #
   class BasenameSetting < Setting
     def banner
-      '<file>:<line> information after every stop uses short paths'
+      "<file>:<line> information after every stop uses short paths"
     end
   end
 end

data/lib/byebug/settings/callstyle.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
-require 'byebug/setting'
+
+require_relative "../setting"
 
 module Byebug
   #
   # Setting to customize the verbosity level for stack frames.
   #
   class CallstyleSetting < Setting
-    DEFAULT = 'long'.freeze
+    DEFAULT = "long"
 
     def banner
-      'Set how you want method call parameters to be displayed'
+      "Set how you want method call parameters to be displayed"
     end
 
     def to_s

data/lib/byebug/settings/fullpath.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -8,7 +10,7 @@ module Byebug
     DEFAULT = true
 
     def banner
-      'Display full file names in backtraces'
+      "Display full file names in backtraces"
     end
   end
 end

data/lib/byebug/settings/histfile.rb

@@ -1,14 +1,16 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
   # Setting to customize the file where byebug's history is saved.
   #
   class HistfileSetting < Setting
-    DEFAULT = File.expand_path('.byebug_history')
+    DEFAULT = File.expand_path(".byebug_history")
 
     def banner
-      'File where cmd history is saved to. Default: ./.byebug_history'
+      "File where cmd history is saved to. Default: ./.byebug_history"
     end
 
     def to_s

data/lib/byebug/settings/histsize.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -8,7 +10,7 @@ module Byebug
     DEFAULT = 256
 
     def banner
-      'Maximum number of commands that can be stored in byebug history'
+      "Maximum number of commands that can be stored in byebug history"
     end
 
     def to_s

data/lib/byebug/settings/linetrace.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -6,11 +8,11 @@ module Byebug
   #
   class LinetraceSetting < Setting
     def banner
-      'Enable line execution tracing'
+      "Enable line execution tracing"
     end
 
-    def value=(v)
-      Byebug.tracing = v
+    def value=(val)
+      Byebug.tracing = val
     end
 
     def value

data/lib/byebug/settings/listsize.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -9,7 +11,7 @@ module Byebug
     DEFAULT = 10
 
     def banner
-      'Set number of source lines to list by default'
+      "Set number of source lines to list by default"
     end
 
     def to_s

data/lib/byebug/settings/post_mortem.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -11,11 +13,11 @@ module Byebug
     end
 
     def banner
-      'Enable/disable post-mortem mode'
+      "Enable/disable post-mortem mode"
     end
 
-    def value=(v)
-      Byebug.post_mortem = v
+    def value=(val)
+      Byebug.post_mortem = val
     end
 
     def value

data/lib/byebug/settings/savefile.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -8,7 +10,7 @@ module Byebug
     DEFAULT = File.expand_path("#{ENV['HOME'] || '.'}/.byebug_save")
 
     def banner
-      'File where settings are saved to. Default: ~/.byebug_save'
+      "File where settings are saved to. Default: ~/.byebug_save"
     end
 
     def to_s

data/lib/byebug/settings/stack_on_error.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #
@@ -7,7 +9,7 @@ module Byebug
   #
   class StackOnErrorSetting < Setting
     def banner
-      'Display stack trace when `eval` raises an exception'
+      "Display stack trace when `eval` raises an exception"
     end
   end
 end

data/lib/byebug/settings/width.rb

@@ -1,4 +1,6 @@
-require 'byebug/setting'
+# frozen_string_literal: true
+
+require_relative "../setting"
 
 module Byebug
   #