byebug 9.1.0 → 10.0.0

data/lib/byebug.rb

@@ -1 +1,3 @@
-require 'byebug/attacher'
+# frozen_string_literal: true
+
+require "byebug/attacher"

data/lib/byebug/attacher.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 #
 # Main Container for all of Byebug's code
 #
 module Byebug
   #
-  # Enters byebug right before (or right after if _before_ is false) return
-  # events occur. Before entering byebug the init script is read.
+  # Starts byebug, and stops at the first line of user's code.
   #
   def self.attach
-    require 'byebug/core'
+    require "byebug/core"
 
     unless started?
       self.mode = :attached
@@ -18,6 +19,13 @@ module Byebug
 
     current_context.step_out(3, true)
   end
+
+  def self.spawn(host = "localhost", port = nil)
+    require "byebug/core"
+
+    self.wait_connection = true
+    start_server(host, port || PORT)
+  end
 end
 
 #
@@ -30,5 +38,11 @@ module Kernel
     Byebug.attach
   end
 
+  def remote_byebug(host = "localhost", port = nil)
+    Byebug.spawn(host, port)
+
+    Byebug.attach
+  end
+
   alias debugger byebug
 end

data/lib/byebug/breakpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Implements breakpoints
@@ -49,12 +51,30 @@ module Byebug
     #
     def self.potential_lines(filename)
       name = "#{Time.new.to_i}_#{rand(2**31)}"
-      lines = {}
       iseq = RubyVM::InstructionSequence.compile(File.read(filename), name)
 
+      if iseq.respond_to?(:each_child)
+        potential_lines_with_trace_points(iseq, {})
+      else
+        potential_lines_without_trace_points(iseq, {})
+      end
+    end
+
+    def self.potential_lines_with_trace_points(iseq, lines)
+      iseq.trace_points.each { |(line, _)| lines[line] = true }
+      iseq.each_child do |child|
+        potential_lines_with_trace_points(child, lines)
+      end
+
+      lines.keys.sort
+    end
+
+    private_class_method :potential_lines_with_trace_points
+
+    def self.potential_lines_without_trace_points(iseq, lines)
       iseq.disasm.each_line do |line|
         res = /^\d+ (?<insn>\w+)\s+.+\(\s*(?<lineno>\d+)\)$/.match(line)
-        next unless res && res[:insn] == 'trace'
+        next unless res && res[:insn] == "trace"
 
         lines[res[:lineno].to_i] = true
       end
@@ -62,6 +82,8 @@ module Byebug
       lines.keys
     end
 
+    private_class_method :potential_lines_without_trace_points
+
     #
     # Returns true if a breakpoint could be set in line number +lineno+ in file
     # name +filename.
@@ -82,7 +104,7 @@ module Byebug
     #
     def inspect
       meths = %w[id pos source expr hit_condition hit_count hit_value enabled?]
-      values = meths.map { |field| "#{field}: #{send(field)}" }.join(', ')
+      values = meths.map { |field| "#{field}: #{send(field)}" }.join(", ")
       "#<Byebug::Breakpoint #{values}>"
     end
   end

data/lib/byebug/command.rb

@@ -1,5 +1,7 @@
-require 'forwardable'
-require 'byebug/helpers/string'
+# frozen_string_literal: true
+
+require "forwardable"
+require "byebug/helpers/string"
 
 module Byebug
   #
@@ -16,11 +18,11 @@ module Byebug
   #   end
   #
   #   def self.description
-  #     'Custom long desc'
+  #     "Custom long desc"
   #   end
   #
   #   def.short_description
-  #     'Custom short desc'
+  #     "Custom short desc"
   #   end
   #
   #   def execute
@@ -47,16 +49,16 @@ module Byebug
     end
 
     def arguments
-      @match[0].split(' ').drop(1).join(' ')
+      @match[0].split(" ").drop(1).join(" ")
     end
 
-    def_delegators :'self.class', :help, :match
+    def_delegators "self.class", :help, :match
 
-    def_delegator :'processor.printer', :print, :pr
-    def_delegator :'processor.printer', :print_collection, :prc
-    def_delegator :'processor.printer', :print_variables, :prv
+    def_delegator "processor.printer", :print, :pr
+    def_delegator "processor.printer", :print_collection, :prc
+    def_delegator "processor.printer", :print_variables, :prv
 
-    def_delegators :'processor.interface', :errmsg, :puts, :print, :confirm
+    def_delegators "processor.interface", :errmsg, :puts, :print, :confirm
 
     class << self
       include Helpers::StringHelper
@@ -77,14 +79,18 @@ module Byebug
       #
       def to_s
         name
-          .split('::')
-          .map { |n| n.gsub(/Command$/, '').downcase if n =~ /Command$/ }
+          .split("::")
+          .map { |n| n.gsub(/Command$/, "").downcase if n =~ /Command$/ }
           .compact
-          .join(' ')
+          .join(" ")
       end
 
       def columnize(width)
-        format("  %-#{width}s -- %s\n", to_s, short_description)
+        format(
+          "  %-<name>#{width}s -- %<description>s\n",
+          name: to_s,
+          description: short_description
+        )
       end
 
       #

data/lib/byebug/command_list.rb

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

data/lib/byebug/commands.rb

@@ -1,37 +1,39 @@
-require 'byebug/commands/break'
-require 'byebug/commands/catch'
-require 'byebug/commands/condition'
-require 'byebug/commands/continue'
-require 'byebug/commands/debug'
-require 'byebug/commands/delete'
-require 'byebug/commands/disable'
-require 'byebug/commands/display'
-require 'byebug/commands/down'
-require 'byebug/commands/edit'
-require 'byebug/commands/enable'
-require 'byebug/commands/finish'
-require 'byebug/commands/frame'
-require 'byebug/commands/help'
-require 'byebug/commands/history'
-require 'byebug/commands/info'
-require 'byebug/commands/interrupt'
-require 'byebug/commands/irb'
-require 'byebug/commands/kill'
-require 'byebug/commands/list'
-require 'byebug/commands/method'
-require 'byebug/commands/next'
-require 'byebug/commands/pry'
-require 'byebug/commands/quit'
-require 'byebug/commands/restart'
-require 'byebug/commands/save'
-require 'byebug/commands/set'
-require 'byebug/commands/show'
-require 'byebug/commands/source'
-require 'byebug/commands/step'
-require 'byebug/commands/thread'
-require 'byebug/commands/tracevar'
-require 'byebug/commands/undisplay'
-require 'byebug/commands/untracevar'
-require 'byebug/commands/up'
-require 'byebug/commands/var'
-require 'byebug/commands/where'
+# frozen_string_literal: true
+
+require "byebug/commands/break"
+require "byebug/commands/catch"
+require "byebug/commands/condition"
+require "byebug/commands/continue"
+require "byebug/commands/debug"
+require "byebug/commands/delete"
+require "byebug/commands/disable"
+require "byebug/commands/display"
+require "byebug/commands/down"
+require "byebug/commands/edit"
+require "byebug/commands/enable"
+require "byebug/commands/finish"
+require "byebug/commands/frame"
+require "byebug/commands/help"
+require "byebug/commands/history"
+require "byebug/commands/info"
+require "byebug/commands/interrupt"
+require "byebug/commands/irb"
+require "byebug/commands/kill"
+require "byebug/commands/list"
+require "byebug/commands/method"
+require "byebug/commands/next"
+require "byebug/commands/pry"
+require "byebug/commands/quit"
+require "byebug/commands/restart"
+require "byebug/commands/save"
+require "byebug/commands/set"
+require "byebug/commands/show"
+require "byebug/commands/source"
+require "byebug/commands/step"
+require "byebug/commands/thread"
+require "byebug/commands/tracevar"
+require "byebug/commands/undisplay"
+require "byebug/commands/untracevar"
+require "byebug/commands/up"
+require "byebug/commands/var"
+require "byebug/commands/where"

data/lib/byebug/commands/break.rb

@@ -1,7 +1,10 @@
-require 'byebug/command'
-require 'byebug/helpers/eval'
-require 'byebug/helpers/file'
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/eval"
+require "byebug/helpers/file"
+require "byebug/helpers/parse"
+require "byebug/source_file_formatter"
 
 module Byebug
   #
@@ -19,7 +22,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         b[reak] [file:]line [if expr]
         b[reak] [module::...]class(.|#)method [if expr]
 
@@ -27,24 +30,24 @@ module Byebug
         for conditionally enabled breakpoints.
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Sets breakpoints in the source code'
+      "Sets breakpoints in the source code"
     end
 
     def execute
       return puts(help) unless @match[1]
 
       b = line_breakpoint(@match[1]) || method_breakpoint(@match[1])
-      return errmsg(pr('break.errors.location')) unless b
+      return errmsg(pr("break.errors.location")) unless b
 
       if syntax_valid?(@match[2])
-        return puts(pr('break.created', id: b.id, file: b.source, line: b.pos))
+        return puts(pr("break.created", id: b.id, file: b.source, line: b.pos))
       end
 
-      errmsg(pr('break.errors.expression', expr: @match[2]))
+      errmsg(pr("break.errors.expression", expr: @match[2]))
       b.enabled = false
     end
 
@@ -74,25 +77,40 @@ module Byebug
       k = error_eval(str)
 
       k && k.is_a?(Module) ? k.name : str
-    rescue
-      errmsg('Warning: breakpoint source is not yet defined')
+    rescue StandardError
+      errmsg("Warning: breakpoint source is not yet defined")
       str
     end
 
     def add_line_breakpoint(file, line)
-      raise(pr('break.errors.source', file: file)) unless File.exist?(file)
+      raise(pr("break.errors.source", file: file)) unless File.exist?(file)
 
       fullpath = File.realpath(file)
 
       if line > n_lines(file)
-        raise(pr('break.errors.far_line', lines: n_lines(file), file: fullpath))
+        raise(pr("break.errors.far_line", lines: n_lines(file), file: fullpath))
       end
 
       unless Breakpoint.potential_line?(fullpath, line)
-        raise(pr('break.errors.line', file: fullpath, line: line))
+        msg = pr(
+          "break.errors.line",
+          file: fullpath,
+          line: line,
+          valid_breakpoints: valid_breakpoints_for(fullpath, line)
+        )
+
+        raise(msg)
       end
 
       Breakpoint.add(fullpath, line, @match[2])
     end
+
+    def valid_breakpoints_for(path, line)
+      potential_lines = Breakpoint.potential_lines(path)
+      annotator = ->(n) { potential_lines.include?(n) ? "[B]" : "   " }
+      source_file_formatter = SourceFileFormatter.new(path, annotator)
+
+      source_file_formatter.lines_around(line).join.chomp
+    end
   end
 end

data/lib/byebug/commands/catch.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/helpers/eval'
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/eval"
 
 module Byebug
   #
@@ -17,7 +19,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         cat[ch][ (off|<exception>[ off])]
 
         #{short_description}
@@ -26,19 +28,19 @@ module Byebug
         catch off             -- deletes all catchpoints
         catch <exception>     -- enables handling <exception>
         catch <exception> off -- disables handling <exception>
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Handles exception catchpoints'
+      "Handles exception catchpoints"
     end
 
     def execute
       return info unless @match[1]
 
-      return @match[1] == 'off' ? clear : add(@match[1]) unless @match[2]
+      return @match[1] == "off" ? clear : add(@match[1]) unless @match[2]
 
-      return errmsg pr('catch.errors.off', off: cmd) unless @match[2] == 'off'
+      return errmsg pr("catch.errors.off", off: cmd) unless @match[2] == "off"
 
       remove(@match[1])
     end
@@ -47,33 +49,33 @@ module Byebug
 
     def remove(exception)
       unless Byebug.catchpoints.member?(exception)
-        return errmsg pr('catch.errors.not_found', exception: exception)
+        return errmsg pr("catch.errors.not_found", exception: exception)
       end
 
-      puts pr('catch.removed', exception: exception)
+      puts pr("catch.removed", exception: exception)
       Byebug.catchpoints.delete(exception)
     end
 
     def add(exception)
       if warning_eval(exception.is_a?(Class).to_s)
-        errmsg pr('catch.errors.not_class', class: exception)
+        errmsg pr("catch.errors.not_class", class: exception)
       end
 
-      puts pr('catch.added', exception: exception)
+      puts pr("catch.added", exception: exception)
       Byebug.add_catchpoint(exception)
     end
 
     def clear
-      Byebug.catchpoints.clear if confirm(pr('catch.confirmations.delete_all'))
+      Byebug.catchpoints.clear if confirm(pr("catch.confirmations.delete_all"))
     end
 
     def info
       if Byebug.catchpoints && !Byebug.catchpoints.empty?
-        Byebug.catchpoints.each do |exception, _hits|
+        Byebug.catchpoints.each_key do |exception|
           puts("#{exception}: #{exception.is_a?(Class)}")
         end
       else
-        puts 'No exceptions set to be caught.'
+        puts "No exceptions set to be caught."
       end
     end
   end

data/lib/byebug/commands/condition.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/parse"
 
 module Byebug
   #
@@ -17,7 +19,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         cond[ition] <n>[ expr]
 
         #{short_description}
@@ -26,27 +28,27 @@ module Byebug
         an integer and <expr> is an expression to be evaluated whenever
         breakpoint <n> is reached. If no expression is specified, the condition
         is removed.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Sets conditions on breakpoints'
+      "Sets conditions on breakpoints"
     end
 
     def execute
       return puts(help) unless @match[1]
 
       breakpoints = Byebug.breakpoints.sort_by(&:id)
-      return errmsg(pr('condition.errors.no_breakpoints')) if breakpoints.empty?
+      return errmsg(pr("condition.errors.no_breakpoints")) if breakpoints.empty?
 
-      pos, err = get_int(@match[1], 'Condition', 1)
+      pos, err = get_int(@match[1], "Condition", 1)
       return errmsg(err) if err
 
       breakpoint = breakpoints.find { |b| b.id == pos }
-      return errmsg(pr('break.errors.no_breakpoint')) unless breakpoint
+      return errmsg(pr("break.errors.no_breakpoint")) unless breakpoint
 
       unless syntax_valid?(@match[2])
-        return errmsg(pr('break.errors.not_changed', expr: @match[2]))
+        return errmsg(pr("break.errors.not_changed", expr: @match[2]))
       end
 
       breakpoint.expr = @match[2]