byebug 9.0.5 → 11.1.3

data/lib/byebug/interface.rb

@@ -1,6 +1,8 @@
-require 'byebug/setting'
-require 'byebug/history'
-require 'byebug/helpers/file'
+# frozen_string_literal: true
+
+require_relative "setting"
+require_relative "history"
+require_relative "helpers/file"
 
 #
 # Namespace for all of byebug's code
@@ -20,7 +22,7 @@ module Byebug
     def initialize
       @command_queue = []
       @history = History.new
-      @last_line = ''
+      @last_line = ""
     end
 
     def last_if_empty(input)
@@ -97,7 +99,7 @@ module Byebug
     # Confirms user introduced an affirmative response to the input stream.
     #
     def confirm(prompt)
-      readline(prompt) == 'y'
+      readline(prompt) == "y"
     end
 
     def close
@@ -124,7 +126,7 @@ module Byebug
     # array of commands: [cmd1, cmd2, ..., cmdN]
     #
     def split_commands(cmd_line)
-      return [''] if cmd_line.empty?
+      return [""] if cmd_line.empty?
 
       cmd_line.split(/;/).each_with_object([]) do |v, m|
         if m.empty? || m.last[-1] != '\\'
@@ -132,13 +134,13 @@ module Byebug
           next
         end
 
-        m.last[-1, 1] = ''
-        m.last << ';' << v
+        m.last[-1, 1] = ""
+        m.last << ";" << v
       end
     end
   end
 end
 
-require 'byebug/interfaces/local_interface'
-require 'byebug/interfaces/script_interface'
-require 'byebug/interfaces/remote_interface'
+require_relative "interfaces/local_interface"
+require_relative "interfaces/script_interface"
+require_relative "interfaces/remote_interface"

data/lib/byebug/interfaces/local_interface.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 module Byebug
   #
   # Interface class for standard byebug use.
   #
   class LocalInterface < Interface
-    EOF_ALIAS = 'continue'.freeze
+    EOF_ALIAS = "continue"
 
     def initialize
       super()
@@ -20,9 +21,7 @@ module Byebug
     # @param prompt Prompt to be displayed.
     #
     def readline(prompt)
-      with_repl_like_sigint do
-        Readline.readline(prompt, false) || EOF_ALIAS
-      end
+      with_repl_like_sigint { without_readline_completion { Readline.readline(prompt) || EOF_ALIAS } }
     end
 
     #
@@ -33,13 +32,32 @@ module Byebug
     # @note Any external 'INT' traps are overriden during this method.
     #
     def with_repl_like_sigint
-      orig_handler = trap('INT') { raise Interrupt }
+      orig_handler = trap("INT") { raise Interrupt }
       yield
     rescue Interrupt
-      puts('^C')
+      puts("^C")
       retry
     ensure
-      trap('INT', orig_handler)
+      trap("INT", orig_handler)
+    end
+
+    #
+    # Disable any Readline completion procs.
+    #
+    # Other gems, for example, IRB could've installed completion procs that are
+    # dependent on them being loaded. Disable those while byebug is the REPL
+    # making use of Readline.
+    #
+    def without_readline_completion
+      orig_completion = Readline.completion_proc
+      return yield unless orig_completion
+
+      begin
+        Readline.completion_proc = ->(_) { nil }
+        yield
+      ensure
+        Readline.completion_proc = orig_completion
+      end
     end
   end
 end

data/lib/byebug/interfaces/remote_interface.rb

@@ -1,4 +1,6 @@
-require 'byebug/history'
+# frozen_string_literal: true
+
+require_relative "../history"
 
 module Byebug
   #
@@ -14,25 +16,35 @@ module Byebug
 
     def read_command(prompt)
       super("PROMPT #{prompt}")
+    rescue Errno::EPIPE, Errno::ECONNABORTED
+      "continue"
     end
 
     def confirm(prompt)
       super("CONFIRM #{prompt}")
+    rescue Errno::EPIPE, Errno::ECONNABORTED
+      false
+    end
+
+    def print(message)
+      super(message)
+    rescue Errno::EPIPE, Errno::ECONNABORTED
+      nil
+    end
+
+    def puts(message)
+      super(message)
+    rescue Errno::EPIPE, Errno::ECONNABORTED
+      nil
     end
 
     def close
       output.close
-    rescue IOError
-      errmsg('Error closing the interface...')
     end
 
     def readline(prompt)
-      output.puts(prompt)
-
-      result = input.gets
-      raise IOError unless result
-
-      result.chomp
+      puts(prompt)
+      (input.gets || "continue").chomp
     end
   end
 end

data/lib/byebug/interfaces/script_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Interface class for command execution from script files.
@@ -22,7 +24,8 @@ module Byebug
     def readline(*)
       while (result = input.gets)
         output.puts "+ #{result}" if @verbose
-        next if result =~ /^\s*#/
+        next if /^\s*#/.match?(result)
+
         return result.chomp
       end
     end

data/lib/byebug/interfaces/test_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Custom interface for easier assertions
@@ -41,9 +43,9 @@ module Byebug
 
     def inspect
       [
-        'Input:', input.join("\n"),
-        'Output:', output.join("\n"),
-        'Error:', error.join("\n")
+        "Input:", input.join("\n"),
+        "Output:", output.join("\n"),
+        "Error:", error.join("\n")
       ].join("\n")
     end
 

data/lib/byebug/option_setter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Handles byebug's command line options
@@ -25,67 +27,67 @@ module Byebug
     private
 
     def debug
-      @opts.on '-d', '--debug', 'Set $DEBUG=true' do
+      @opts.on "-d", "--debug", "Set $DEBUG=true" do
         $DEBUG = true
       end
     end
 
     def include_flag
-      @opts.on '-I', '--include list', 'Add to paths to $LOAD_PATH' do |list|
-        $LOAD_PATH.push(list.split(':')).flatten!
+      @opts.on "-I", "--include list", "Add to paths to $LOAD_PATH" do |list|
+        $LOAD_PATH.push(list.split(":")).flatten!
       end
     end
 
     def post_mortem
-      @opts.on '-m', '--[no-]post-mortem', 'Use post-mortem mode' do |v|
+      @opts.on "-m", "--[no-]post-mortem", "Use post-mortem mode" do |v|
         Setting[:post_mortem] = v
       end
     end
 
     def quit
-      @opts.on '-q', '--[no-]quit', 'Quit when script finishes' do |v|
+      @opts.on "-q", "--[no-]quit", "Quit when script finishes" do |v|
         @runner.quit = v
       end
     end
 
     def rc
-      @opts.on '-x', '--[no-]rc', 'Run byebug initialization file' do |v|
+      @opts.on "-x", "--[no-]rc", "Run byebug initialization file" do |v|
         @runner.init_script = v
       end
     end
 
     def stop
-      @opts.on '-s', '--[no-]stop', 'Stop when script is loaded' do |v|
+      @opts.on "-s", "--[no-]stop", "Stop when script is loaded" do |v|
         @runner.stop = v
       end
     end
 
     def require_flag
-      @opts.on '-r', '--require file', 'Require library before script' do |lib|
+      @opts.on "-r", "--require file", "Require library before script" do |lib|
         require lib
       end
     end
 
     def remote
-      @opts.on '-R', '--remote [host:]port', 'Remote debug [host:]port' do |p|
+      @opts.on "-R", "--remote [host:]port", "Remote debug [host:]port" do |p|
         @runner.remote = p
       end
     end
 
     def trace
-      @opts.on '-t', '--[no-]trace', 'Turn on line tracing' do |v|
+      @opts.on "-t", "--[no-]trace", "Turn on line tracing" do |v|
         Setting[:linetrace] = v
       end
     end
 
     def version
-      @opts.on '-v', '--version', 'Print program version' do
+      @opts.on "-v", "--version", "Print program version" do
         @runner.version = Byebug::VERSION
       end
     end
 
     def help
-      @opts.on '-h', '--help', 'Display this message' do
+      @opts.on "-h", "--help", "Display this message" do
         @runner.help = @opts.help
       end
     end

data/lib/byebug/printers/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'yaml'
+
+require "yaml"
 
 module Byebug
   module Printers
@@ -10,33 +11,32 @@ module Byebug
       class MissedPath < StandardError; end
       class MissedArgument < StandardError; end
 
-      SEPARATOR = '.'.freeze
+      SEPARATOR = "."
 
       def type
-        self.class.name.split('::').last.downcase
+        self.class.name.split("::").last.downcase
       end
 
       private
 
       def locate(path)
         result = nil
-        contents.each do |_, contents|
+        contents.each_value do |contents|
           result = parts(path).reduce(contents) do |r, part|
-            r && r.key?(part) ? r[part] : nil
+            r&.key?(part) ? r[part] : nil
           end
           break if result
         end
         raise MissedPath, "Can't find part path '#{path}'" unless result
+
         result
       end
 
       def translate(string, args = {})
         # they may contain #{} string interpolation
-        string.gsub(/\|\w+$/, '').gsub(/([^#]?){([^}]*)}/) do
+        string.gsub(/\|\w+$/, "").gsub(/([^#]?){([^}]*)}/) do
           key = Regexp.last_match[2].to_s
-          unless args.key?(key.to_sym)
-            raise MissedArgument, "Missed argument #{key} for '#{string}'"
-          end
+          raise MissedArgument, "Missed argument #{key} for '#{string}'" unless args.key?(key.to_sym)
 
           "#{Regexp.last_match[1]}#{args[key.to_sym]}"
         end
@@ -61,7 +61,7 @@ module Byebug
       end
 
       def contents_files
-        [File.expand_path(File.join('..', 'texts', 'base.yml'), __FILE__)]
+        [File.join(__dir__, "texts", "base.yml")]
       end
     end
   end

data/lib/byebug/printers/plain.rb

@@ -1,4 +1,6 @@
-require 'byebug/printers/base'
+# frozen_string_literal: true
+
+require_relative "base"
 
 module Byebug
   module Printers
@@ -8,7 +10,7 @@ module Byebug
     class Plain < Base
       def print(path, args = {})
         message = translate(locate(path), args)
-        tail = parts(path).include?('confirmations') ? ' (y/n) ' : "\n"
+        tail = parts(path).include?("confirmations") ? " (y/n) " : "\n"
         message << tail
       end
 
@@ -20,12 +22,12 @@ module Byebug
         lines.join
       end
 
-      def print_variables(variables, *_)
-        print_collection('variable.variable', variables) do |(key, value), _|
-          value = value.nil? ? 'nil' : value.to_s
+      def print_variables(variables, *_unused)
+        print_collection("variable.variable", variables) do |(key, value), _|
+          value = value.nil? ? "nil" : value.to_s
           if "#{key} = #{value}".size > Setting[:width]
             key_size = "#{key} = ".size
-            value = value[0..Setting[:width] - key_size - 4] + '...'
+            value = value[0..Setting[:width] - key_size - 4] + "..."
           end
 
           { key: key, value: value }
@@ -35,8 +37,7 @@ module Byebug
       private
 
       def contents_files
-        [File.expand_path(File.join('..', 'texts', 'plain.yml'), __FILE__)] +
-          super
+        [File.join(__dir__, "texts", "plain.yml")] + super
       end
     end
   end

data/lib/byebug/printers/texts/base.yml

@@ -1,10 +1,10 @@
 base:
   errors:
-    only_local: 'Command is available only in local mode.'
+    only_local: "Command is available only in local mode."
 
 break:
   errors:
-    line: "Line {line} is not a valid breakpoint in file {file}"
+    line: "Line {line} is not a valid breakpoint in file {file}.\n\nValid break points are:\n{valid_breakpoints}"
     location: "Invalid breakpoint location"
     state: "We are not in a state that has an associated file"
     class: "Unknown class {klass}"
@@ -16,6 +16,8 @@ break:
     not_changed: "Incorrect expression \"{expr}\", breakpoint not changed"
   confirmations:
     delete_all: "Delete all breakpoints?"
+  messages:
+    breakpoint_deleted: "Deleted breakpoint {pos}"
 
 catch:
   added: "Catching exception {exception}."
@@ -60,7 +62,7 @@ info:
 
 pry:
   errors:
-    not_installed: 'You need to install pry in order to run this command'
+    not_installed: "You need to install pry in order to run this command"
 
 quit:
   confirmations:
@@ -97,6 +99,8 @@ toggle:
     no_display: "No display expressions have been set"
     syntax: "\"{toggle}\" must be followed by \"display\", \"breakpoints\" or breakpoint ids"
     expression: "Expression \"{expr}\" syntactically incorrect; breakpoint remains disabled."
+  messages:
+    toggled: "Breakpoint {bpnum} {endis}abled"
 
 parse:
   errors:

data/lib/byebug/printers/texts/plain.yml

@@ -1,5 +1,5 @@
 break:
-  created: "Successfully created breakpoint with id {id}"
+  created: "Created breakpoint {id} at {file}:{line}"
 
 display:
   result: "{n}: {exp} = {result}"

data/lib/byebug/processors/command_processor.rb

@@ -1,7 +1,9 @@
-require 'forwardable'
+# frozen_string_literal: true
 
-require 'byebug/helpers/eval'
-require 'byebug/errors'
+require "forwardable"
+
+require_relative "../helpers/eval"
+require_relative "../errors"
 
 module Byebug
   #
@@ -16,19 +18,16 @@ module Byebug
     include Helpers::EvalHelper
 
     attr_accessor :prev_line
-    attr_reader :context
+    attr_reader :context, :interface
 
-    def initialize(context)
+    def initialize(context, interface = LocalInterface.new)
       @context = context
+      @interface = interface
 
       @proceed = false
       @prev_line = nil
     end
 
-    def interface
-      @interface ||= Context.interface
-    end
-
     def printer
       @printer ||= Printers::Plain.new
     end
@@ -106,7 +105,7 @@ module Byebug
     # Prompt shown before reading a command.
     #
     def prompt
-      '(byebug) '
+      "(byebug) "
     end
 
     def before_repl
@@ -129,7 +128,7 @@ module Byebug
         cmd = interface.read_command(prompt)
         return if cmd.nil?
 
-        next if cmd == ''
+        next if cmd == ""
 
         run_cmd(cmd)
       end
@@ -167,7 +166,7 @@ module Byebug
 
     def safely
       yield
-    rescue => e
+    rescue StandardError => e
       errmsg(e.message)
     end
   end

data/lib/byebug/processors/control_processor.rb

@@ -1,14 +1,12 @@
-require 'byebug/processors/command_processor'
+# frozen_string_literal: true
+
+require_relative "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_relative "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_relative "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/client.rb

@@ -0,0 +1,57 @@
+# 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