byebug 9.1.0 → 10.0.0

data/lib/byebug/processors/control_processor.rb

@@ -1,14 +1,12 @@
-require 'byebug/processors/command_processor'
+# frozen_string_literal: true
+
+require "byebug/processors/command_processor"
 
 module Byebug
   #
   # Processes commands when there's not program running
   #
   class ControlProcessor < CommandProcessor
-    def initialize(context = nil)
-      @context = context
-    end
-
     #
     # Available commands
     #
@@ -20,7 +18,7 @@ module Byebug
     # Prompt shown before reading a command.
     #
     def prompt
-      '(byebug:ctrl) '
+      "(byebug:ctrl) "
     end
   end
 end

data/lib/byebug/processors/post_mortem_processor.rb

@@ -1,4 +1,6 @@
-require 'byebug/processors/command_processor'
+# frozen_string_literal: true
+
+require "byebug/processors/command_processor"
 
 module Byebug
   #
@@ -10,7 +12,7 @@ module Byebug
     end
 
     def prompt
-      '(byebug:post_mortem) '
+      "(byebug:post_mortem) "
     end
   end
 end

data/lib/byebug/processors/script_processor.rb

@@ -1,4 +1,6 @@
-require 'byebug/processors/command_processor'
+# frozen_string_literal: true
+
+require "byebug/processors/command_processor"
 
 module Byebug
   #
@@ -24,6 +26,8 @@ module Byebug
     end
 
     def after_repl
+      super
+
       interface.close
     end
 
@@ -31,14 +35,14 @@ module Byebug
     # Prompt shown before reading a command.
     #
     def prompt
-      '(byebug:ctrl) '
+      "(byebug:ctrl) "
     end
 
     private
 
     def without_exceptions
       yield
-    rescue
+    rescue StandardError
       nil
     end
   end

data/lib/byebug/remote.rb

@@ -1,11 +1,13 @@
-require 'socket'
-require 'byebug/processors/control_processor'
+# frozen_string_literal: true
+
+require "socket"
+require "byebug/processors/control_processor"
+require "byebug/remote/server"
+require "byebug/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.zero? ? 0 : port + 1)
 
-      mutex = Mutex.new
-      proceed = ConditionVariable.new
-
-      server = TCPServer.new(host, port)
-      self.actual_port = server.addr[1]
-
-      yield if block_given?
-
-      @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/remote/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "socket"
+
+module Byebug
+  module Remote
+    #
+    # Client for remote debugging
+    #
+    class Client
+      attr_reader :interface, :socket
+
+      def initialize(interface)
+        @interface = interface
+        @socket = nil
+      end
+
+      #
+      # Connects to the remote byebug
+      #
+      def start(host = "localhost", port = PORT)
+        connect_at(host, port)
+
+        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
+            interface.puts line
+          end
+        end
+
+        socket.close
+      end
+
+      def started?
+        !socket.nil?
+      end
+
+      private
+
+      def connect_at(host, port)
+        interface.puts "Connecting to byebug server at #{host}:#{port}..."
+        @socket = TCPSocket.new(host, port)
+        interface.puts "Connected."
+      end
+    end
+  end
+end

data/lib/byebug/remote/server.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "socket"
+
+module Byebug
+  module Remote
+    #
+    # Server for remote debugging
+    #
+    class Server
+      attr_reader :actual_port, :wait_connection
+
+      def initialize(wait_connection:, &block)
+        @thread = nil
+        @wait_connection = wait_connection
+        @main_loop = block
+      end
+
+      #
+      # Start the remote debugging server
+      #
+      def start(host, port)
+        return if @thread
+
+        if wait_connection
+          mutex = Mutex.new
+          proceed = ConditionVariable.new
+        end
+
+        server = TCPServer.new(host, port)
+        @actual_port = server.addr[1]
+
+        yield if block_given?
+
+        @thread = DebugThread.new do
+          while (session = server.accept)
+            @main_loop.call(session)
+
+            mutex.synchronize { proceed.signal } if wait_connection
+          end
+        end
+
+        mutex.synchronize { proceed.wait(mutex) } if wait_connection
+      end
+    end
+  end
+end

data/lib/byebug/runner.rb

@@ -1,12 +1,14 @@
-require 'optparse'
-require 'English'
-require 'byebug/core'
-require 'byebug/version'
-require 'byebug/helpers/bin'
-require 'byebug/helpers/parse'
-require 'byebug/helpers/string'
-require 'byebug/option_setter'
-require 'byebug/processors/control_processor'
+# frozen_string_literal: true
+
+require "optparse"
+require "English"
+require "byebug/core"
+require "byebug/version"
+require "byebug/helpers/bin"
+require "byebug/helpers/parse"
+require "byebug/helpers/string"
+require "byebug/option_setter"
+require "byebug/processors/control_processor"
 
 module Byebug
   #
@@ -58,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)
@@ -75,11 +79,11 @@ module Byebug
     # Usage banner.
     #
     def banner
-      prettify <<-EOB
+      prettify <<-BANNER
         byebug #{Byebug::VERSION}
 
         Usage: byebug [options] <script.rb> -- <script.rb parameters>
-      EOB
+      BANNER
     end
 
     #
@@ -100,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
 
     #
@@ -124,7 +126,12 @@ module Byebug
     def program
       @program ||= begin
                      candidate = which($ARGV.shift)
-                     candidate == which('ruby') ? which($ARGV.shift) : candidate
+
+                     if [which("ruby"), RbConfig.ruby].include?(candidate)
+                       which($ARGV.shift)
+                     else
+                       candidate
+                     end
                    end
     end
 
@@ -148,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
 
@@ -168,7 +175,7 @@ module Byebug
     def invalid_script?
       return false if syntax_valid?(File.read(program))
 
-      print_error('The script has incorrect syntax')
+      print_error("The script has incorrect syntax")
       true
     end
 

data/lib/byebug/setting.rb

@@ -1,4 +1,6 @@
-require 'byebug/helpers/string'
+# frozen_string_literal: true
+
+require "byebug/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
 
@@ -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