byebug 4.0.5 → 5.0.0

data/lib/byebug/commands/catch.rb

@@ -42,21 +42,15 @@ module Byebug
       errmsg pr('catch.errors.off', off: cmd)
     end
 
-    class << self
-      def names
-        %w(catch)
-      end
-
-      def description
-        prettify <<-EOD
-          cat[ch][ (off|<exception>[ off])]
-
-          "catch" lists catchpoints.
-          "catch off" deletes all catchpoints.
-          "catch <exception>" enables handling <exception>.
-          "catch <exception> off" disables handling <exception>.
-        EOD
-      end
+    def description
+      <<-EOD
+        cat[ch][ (off|<exception>[ off])]
+
+        "catch" lists catchpoints.
+        "catch off" deletes all catchpoints.
+        "catch <exception>" enables handling <exception>.
+        "catch <exception> off" disables handling <exception>.
+      EOD
     end
   end
 end

data/lib/byebug/commands/condition.rb

@@ -1,4 +1,5 @@
 require 'byebug/command'
+require 'byebug/helpers/parse'
 
 module Byebug
   #
@@ -7,6 +8,8 @@ module Byebug
   # Adds the ability to stop on breakpoints only under certain conditions.
   #
   class ConditionCommand < Command
+    include Helpers::ParseHelper
+
     self.allow_in_post_mortem = false
 
     def regexp
@@ -14,7 +17,7 @@ module Byebug
     end
 
     def execute
-      return puts(self.class.help) unless @match[1]
+      return puts(help) unless @match[1]
 
       breakpoints = Byebug.breakpoints.sort_by(&:id)
       return errmsg(pr('condition.errors.no_breakpoints')) if breakpoints.empty?
@@ -32,21 +35,15 @@ module Byebug
       breakpoint.expr = @match[2]
     end
 
-    class << self
-      def names
-        %w(condition)
-      end
-
-      def description
-        prettify <<-EOD
-          cond[ition] <n>[ expr]
+    def description
+      <<-EOD
+        cond[ition] <n>[ expr]
 
-          Specify breakpoint number <n> to break only if <expr> is true. <n> is
-          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
-      end
+        Specify breakpoint number <n> to break only if <expr> is true. <n> is
+        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
     end
   end
 end

data/lib/byebug/commands/continue.rb

@@ -1,4 +1,5 @@
 require 'byebug/command'
+require 'byebug/helpers/parse'
 
 module Byebug
   #
@@ -8,6 +9,8 @@ module Byebug
   # specific line number or until program termination.
   #
   class ContinueCommand < Command
+    include Helpers::ParseHelper
+
     def regexp
       /^\s* c(?:ont(?:inue)?)? (?:\s+(\S+))? \s*$/x
     end
@@ -28,18 +31,12 @@ module Byebug
       @state.proceed
     end
 
-    class << self
-      def names
-        %w(continue)
-      end
-
-      def description
-        prettify <<-EOD
-          c[ont[inue]][ <n>]
+    def description
+      <<-EOD
+        c[ont[inue]][ <n>]
 
-          Run until program ends, hits a breakpoint or reaches line <n>.
-        EOD
-      end
+        Run until program ends, hits a breakpoint or reaches line <n>.
+      EOD
     end
   end
 end

data/lib/byebug/commands/delete.rb

@@ -1,10 +1,13 @@
 require 'byebug/command'
+require 'byebug/helpers/parse'
 
 module Byebug
   #
   # Implements breakpoint deletion.
   #
   class DeleteCommand < Command
+    include Helpers::ParseHelper
+
     self.allow_in_post_mortem = false
     self.allow_in_control = true
 
@@ -32,19 +35,13 @@ module Byebug
       end
     end
 
-    class << self
-      def names
-        %w(delete)
-      end
-
-      def description
-        prettify <<-EOD
-          del[ete][ nnn...]
+    def description
+      <<-EOD
+        del[ete][ nnn...]
 
-          Without and argument, deletes all breakpoints. With integer
-          arguments, it deletes specific breakpoints.
-        EOD
-      end
+        Without and argument, deletes all breakpoints. With integer arguments,
+        it deletes specific breakpoints.
+      EOD
     end
   end
 end

data/lib/byebug/commands/disable.rb

@@ -0,0 +1,32 @@
+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
+
+    def regexp
+      /^\s* dis(?:able)? (?:\s+ (.+))? \s*$/x
+    end
+
+    def description
+      <<-EOD
+        dis[able][[ breakpoints| display)][ n1[ n2[ ...[ nn]]]]]
+
+        Disables breakpoints or displays.
+
+        "disable" by itself shows this help
+        "disable breakpoints" disables all breakpoints.
+        "disable displays" disables all displays.
+
+        You can also specify a space separated list of breakpoint or display
+        numbers to disable only specific breakpoints or displays.
+       EOD
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'byebug/helpers/toggle'
+
+module Byebug
+  #
+  # Reopens the +disable+ command to define the +breakpoints+ subcommand
+  #
+  class DisableCommand < Command
+    #
+    # Disables all or specific breakpoints
+    #
+    class BreakpointsSubcommand < Command
+      include Helpers::ToggleHelper
+
+      def regexp
+        /^\s* b(?:reakpoints)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def execute
+        enable_disable_breakpoints('disable', @match[1])
+      end
+
+      def short_description
+        'Disable all or specific breakpoints.'
+      end
+
+      def description
+        <<-EOD
+          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.
+        EOD
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'byebug/helpers/toggle'
+
+module Byebug
+  #
+  # Reopens the +disable+ command to define the +display+ subcommand
+  #
+  class DisableCommand < Command
+    #
+    # Enables all or specific displays
+    #
+    class DisplaySubcommand < Command
+      include Helpers::ToggleHelper
+
+      def regexp
+        /^\s* d(?:isplay)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def execute
+        enable_disable_display('disable', @match[1])
+      end
+
+      def short_description
+        'Disables expressions to be displayed when program stops.'
+      end
+
+      def description
+        <<-EOD
+          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.
+        EOD
+      end
+    end
+  end
+end

data/lib/byebug/commands/display.rb

@@ -2,34 +2,33 @@ require 'byebug/command'
 
 module Byebug
   #
-  # Implements the functionality of adding custom expressions to be displayed
-  # every time the debugger stops.
+  # Custom expressions to be displayed every time the debugger stops.
   #
-  class AddDisplayCommand < Command
+  class DisplayCommand < Command
     self.allow_in_post_mortem = false
 
+    def self.always_run
+      2
+    end
+
     def regexp
-      /^\s* disp(?:lay)? \s+ (.+) \s*$/x
+      /^\s* disp(?:lay)? (?:\s+ (.+))? \s*$/x
     end
 
     def execute
-      exp = @match[1]
-      @state.display.push [true, exp]
-      display_expression(exp)
-    end
+      return print_display_expressions unless @match && @match[1]
 
-    class << self
-      def names
-        %w(display)
-      end
+      @state.display.push [true, @match[1]]
+      display_expression(@match[1])
+    end
 
-      def description
-        prettify <<-EOD
-          disp[lay] <expression>
+    def description
+      <<-EOD
+        disp[lay][ <expression>]
 
-          Add <expression> into display expression list.
-        EOD
-      end
+        If <expression> specified, adds <expression> into display expression
+        list. Otherwise, it lists all expressions.
+      EOD
     end
 
     private
@@ -40,39 +39,6 @@ module Byebug
                exp: exp,
                result: bb_warning_eval(exp).inspect)
     end
-  end
-
-  #
-  # Displays the value of enabled expressions.
-  #
-  class DisplayCommand < Command
-    self.allow_in_post_mortem = false
-
-    def self.always_run
-      2
-    end
-
-    def regexp
-      /^\s* disp(?:lay)? \s*$/x
-    end
-
-    def execute
-      print_display_expressions
-    end
-
-    class << self
-      def names
-        %w(display)
-      end
-
-      def description
-        prettify <<-EOD
-          disp[lay] Display expression list.
-        EOD
-      end
-    end
-
-    private
 
     def print_display_expressions
       result = prc('display.result', @state.display) do |item, index|
@@ -83,6 +49,7 @@ module Byebug
             result: bb_warning_eval(expression).inspect }
         end
       end
+
       print result
     end
   end

data/lib/byebug/commands/down.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+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
+
+    def regexp
+      /^\s* down (?:\s+(\S+))? \s*$/x
+    end
+
+    def execute
+      pos, err = parse_steps(@match[1], 'Down')
+      return errmsg(err) unless pos
+
+      adjust_frame(-pos, false)
+
+      ListCommand.new(@state).execute if Setting[:autolist]
+    end
+
+    def description
+      <<-EOD
+        down[ count]
+
+        Move to a lower frame in the stack trace.
+
+        Use the "bt" command to find out where you want to go.
+      EOD
+    end
+  end
+end

data/lib/byebug/commands/edit.rb

@@ -37,20 +37,14 @@ module Byebug
       system(cmd)
     end
 
-    class << self
-      def names
-        %w(edit)
-      end
-
-      def description
-        prettify <<-EOD
-          edit[ file:lineno] Edit specified files.
-
-          With no argument, edits file containing most recent line listed.
-          Editing targets can also be specified to start editing at a specific
-          line in a specific file.
-        EOD
-      end
+    def description
+      <<-EOD
+        edit[ file:lineno] Edit specified files.
+
+        With no argument, edits file containing most recent line listed. Editing
+        targets can also be specified to start editing at a specific line in a
+        specific file.
+      EOD
     end
   end
 end

data/lib/byebug/commands/enable.rb

@@ -0,0 +1,25 @@
+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
+
+    def regexp
+      /^\s* en(?:able)? (?:\s+ (.+))? \s*$/x
+    end
+
+    def description
+      <<-EOD
+        en[able][[ b[reakpoints]| d[isplay])][ n1[ n2[ ...[ nn]]]]]
+
+        Enables breakpoints or displays.
+      EOD
+    end
+  end
+end