byebug 11.0.1

data/lib/byebug/commands/debug.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/eval"
+
+module Byebug
+  #
+  # Spawns a subdebugger and evaluates the given expression
+  #
+  class DebugCommand < Command
+    include Helpers::EvalHelper
+
+    def self.regexp
+      /^\s* debug (?:\s+(\S+))? \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        debug <expression>
+
+        #{short_description}
+
+        Allows, for example, setting breakpoints on expressions evaluated from
+        the debugger's prompt.
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Spawns a subdebugger"
+    end
+
+    def execute
+      return puts(help) unless @match[1]
+
+      puts safe_inspect(separate_thread_eval(@match[1]))
+    end
+  end
+end

data/lib/byebug/commands/delete.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/parse"
+
+module Byebug
+  #
+  # Implements breakpoint deletion.
+  #
+  class DeleteCommand < Command
+    include Helpers::ParseHelper
+
+    self.allow_in_control = true
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^\s* del(?:ete)? (?:\s+(.*))?$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        del[ete][ nnn...]
+
+        #{short_description}
+
+        Without and argument, deletes all breakpoints. With integer arguments,
+        it deletes specific breakpoints.
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Deletes breakpoints"
+    end
+
+    def execute
+      unless @match[1]
+        Byebug.breakpoints.clear if confirm(pr("break.confirmations.delete_all"))
+
+        return
+      end
+
+      @match[1].split(/ +/).each do |number|
+        pos, err = get_int(number, "Delete", 1)
+
+        return errmsg(err) unless pos
+
+        if Breakpoint.remove(pos)
+          puts(pr("break.messages.breakpoint_deleted", pos: pos))
+        else
+          errmsg(pr("break.errors.no_breakpoint_delete", pos: pos))
+        end
+      end
+    end
+  end
+end

data/lib/byebug/commands/disable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "byebug/subcommands"
+
+require "byebug/commands/disable/breakpoints"
+require "byebug/commands/disable/display"
+
+module Byebug
+  #
+  # Disabling custom display expressions or breakpoints.
+  #
+  class DisableCommand < Command
+    include Subcommands
+
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^\s* dis(?:able)? (?:\s+ (.+))? \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        dis[able][[ breakpoints| display)][ n1[ n2[ ...[ nn]]]]]
+
+        #{short_description}
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Disables breakpoints or displays"
+    end
+  end
+end

data/lib/byebug/commands/disable/breakpoints.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/toggle"
+
+module Byebug
+  #
+  # Reopens the +disable+ command to define the +breakpoints+ subcommand
+  #
+  class DisableCommand < Command
+    #
+    # Disables all or specific breakpoints
+    #
+    class BreakpointsCommand < Command
+      include Helpers::ToggleHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* b(?:reakpoints)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          dis[able] b[reakpoints][ <id1> <id2> .. <idn>]
+
+          #{short_description}
+
+          Give breakpoint numbers (separated by spaces) as arguments or no
+          argument at all if you want to disable every breakpoint.
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Disable all or specific breakpoints."
+      end
+
+      def execute
+        enable_disable_breakpoints("disable", @match[1])
+      end
+    end
+  end
+end

data/lib/byebug/commands/disable/display.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/toggle"
+
+module Byebug
+  #
+  # Reopens the +disable+ command to define the +display+ subcommand
+  #
+  class DisableCommand < Command
+    #
+    # Enables all or specific displays
+    #
+    class DisplayCommand < Command
+      include Helpers::ToggleHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* d(?:isplay)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          dis[able] d[isplay][ <id1> <id2> .. <idn>]
+
+          #{short_description}
+
+          Arguments are the code numbers of the expressions to disable. Do "info
+          display" to see the current list of code numbers. If no arguments are
+          specified, all displays are disabled.
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Disables expressions to be displayed when program stops."
+      end
+
+      def execute
+        enable_disable_display("disable", @match[1])
+      end
+    end
+  end
+end

data/lib/byebug/commands/display.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/eval"
+
+module Byebug
+  #
+  # Custom expressions to be displayed every time the debugger stops.
+  #
+  class DisplayCommand < Command
+    include Helpers::EvalHelper
+
+    self.allow_in_post_mortem = false
+    self.always_run = 2
+
+    def self.regexp
+      /^\s* disp(?:lay)? (?:\s+ (.+))? \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        disp[lay][ <expression>]
+
+        #{short_description}
+
+        If <expression> specified, adds <expression> into display expression
+        list. Otherwise, it lists all expressions.
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Evaluates expressions every time the debugger stops"
+    end
+
+    def execute
+      return print_display_expressions unless @match && @match[1]
+
+      Byebug.displays.push [true, @match[1]]
+      display_expression(@match[1])
+    end
+
+    private
+
+    def display_expression(exp)
+      print pr("display.result", n: Byebug.displays.size,
+                                 exp: exp,
+                                 result: eval_expr(exp))
+    end
+
+    def print_display_expressions
+      result = prc("display.result", Byebug.displays) do |item, index|
+        active, exp = item
+
+        { n: index + 1, exp: exp, result: eval_expr(exp) } if active
+      end
+
+      print result
+    end
+
+    def eval_expr(expression)
+      error_eval(expression).inspect
+    rescue StandardError
+      "(undefined)"
+    end
+  end
+end

data/lib/byebug/commands/down.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "byebug/command"
+require "byebug/helpers/frame"
+require "byebug/helpers/parse"
+
+module Byebug
+  #
+  # Move the current frame down in the backtrace.
+  #
+  class DownCommand < Command
+    include Helpers::FrameHelper
+    include Helpers::ParseHelper
+
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^\s* down (?:\s+(\S+))? \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        down[ count]
+
+        #{short_description}
+
+        Use the "bt" command to find out where you want to go.
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Moves to a lower frame in the stack trace"
+    end
+
+    def execute
+      pos, err = parse_steps(@match[1], "Down")
+      return errmsg(err) unless pos
+
+      jump_frames(-pos)
+
+      ListCommand.new(processor).execute if Setting[:autolist]
+    end
+  end
+end

data/lib/byebug/commands/edit.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "byebug/command"
+
+module Byebug
+  #
+  # Edit a file from byebug's prompt.
+  #
+  class EditCommand < Command
+    self.allow_in_control = true
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^\s* ed(?:it)? (?:\s+(\S+))? \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        edit[ file:lineno]
+
+        #{short_description}
+
+        With no argumnt, edits file containing most re line listed. Editing
+        targets can also be specified to start editing at a specific line in a
+        specific file
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Edits source files"
+    end
+
+    def execute
+      file, line = location(@match[1])
+      return edit_error("not_exist", file) unless File.exist?(file)
+      return edit_error("not_readable", file) unless File.readable?(file)
+
+      cmd = line ? "#{editor} +#{line} #{file}" : "#{editor} #{file}"
+
+      Kernel.system(cmd)
+    end
+
+    private
+
+    def location(matched)
+      if matched.nil?
+        file = frame.file
+        return errmsg(pr("edit.errors.state")) unless file
+
+        line = frame.line
+      elsif (@pos_match = /([^:]+)[:]([0-9]+)/.match(matched))
+        file, line = @pos_match.captures
+      else
+        file = matched
+        line = nil
+      end
+
+      [File.expand_path(file), line]
+    end
+
+    def editor
+      ENV["EDITOR"] || "vim"
+    end
+
+    def edit_error(type, file)
+      errmsg(pr("edit.errors.#{type}", file: file))
+    end
+  end
+end

data/lib/byebug/commands/enable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "byebug/subcommands"
+
+require "byebug/commands/enable/breakpoints"
+require "byebug/commands/enable/display"
+
+module Byebug
+  #
+  # Enabling custom display expressions or breakpoints.
+  #
+  class EnableCommand < Command
+    include Subcommands
+
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^\s* en(?:able)? (?:\s+ (.+))? \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        en[able][[ b[reakpoints]| d[isplay])][ n1[ n2[ ...[ nn]]]]]
+
+        #{short_description}
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Enables breakpoints or displays"
+    end
+  end
+end

data/lib/byebug/commands/enable/breakpoints.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/toggle"
+
+module Byebug
+  #
+  # Reopens the +enable+ command to define the +breakpoints+ subcommand
+  #
+  class EnableCommand < Command
+    #
+    # Enables all or specific breakpoints
+    #
+    class BreakpointsCommand < Command
+      include Helpers::ToggleHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* b(?:reakpoints)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          en[able] b[reakpoints][ <ids>]
+
+          #{short_description}
+
+          Give breakpoint numbers (separated by spaces) as arguments or no
+          argument at all if you want to enable every breakpoint.
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Enable all or specific breakpoints"
+      end
+
+      def execute
+        enable_disable_breakpoints("enable", @match[1])
+      end
+    end
+  end
+end