byebug 3.2.0 → 3.3.0

data/lib/byebug/settings/callstyle.rb

@@ -1,8 +1,11 @@
 module Byebug
+  #
+  # Setting to customize the verbosity level for stack frames.
+  #
   class CallstyleSetting < Setting
     DEFAULT = 'long'
 
-    def help
+    def banner
       'Set how you want method call parameters to be displayed'
     end
 

data/lib/byebug/settings/forcestep.rb

@@ -1,11 +1,14 @@
 module Byebug
+  #
+  # Setting to force changing lines when executing step or next commands.
+  #
   class ForcestepSetting < Setting
-    def help
-      'If true, next/step commands always move to a new line'
+    def banner
+      'Force next/step commands to always move to a new line'
     end
 
     def print
-      "forced-stepping is #{self.getter}"
+      "forced-stepping is #{getter}"
     end
   end
 end

data/lib/byebug/settings/fullpath.rb

@@ -1,9 +1,12 @@
 module Byebug
+  #
+  # Setting to display full paths in backtraces.
+  #
   class FullpathSetting < Setting
     DEFAULT = true
 
-    def help
-      'Display full file names in frames'
+    def banner
+      'Display full file names in backtraces'
     end
   end
 end

data/lib/byebug/settings/histfile.rb

@@ -1,10 +1,12 @@
 module Byebug
+  #
+  # Setting to customize the file where byebug's history is saved.
+  #
   class HistfileSetting < Setting
     DEFAULT = File.expand_path("#{ENV['HOME'] || '.'}/.byebug_hist")
 
-    def help
-      "Customize file where history is loaded from and saved to. By default, " \
-      "~/.byebug_hist"
+    def banner
+      'File where cmd history is saved to. Default: ~/.byebug_hist'
     end
 
     def to_s

data/lib/byebug/settings/histsize.rb

@@ -1,10 +1,12 @@
 module Byebug
+  #
+  # Setting to customize the number of byebug commands to be saved in history.
+  #
   class HistsizeSetting < Setting
     DEFAULT = 256
 
-    def help
-      "Customize maximum number of commands that can be stored in byebug's " \
-      "history record. By default, #{DEFAULT}"
+    def banner
+      'Maximum number of commands that can be stored in byebug history'
     end
 
     def to_s

data/lib/byebug/settings/linetrace.rb

@@ -1,6 +1,9 @@
 module Byebug
+  #
+  # Setting to enable/disable linetracing.
+  #
   class LinetraceSetting < Setting
-    def help
+    def banner
       'Enable line execution tracing'
     end
 

data/lib/byebug/settings/listsize.rb

@@ -1,8 +1,12 @@
 module Byebug
+  #
+  # Setting to customize the number of source code lines to be displayed every
+  # time the "list" command is invoked.
+  #
   class ListsizeSetting < Setting
     DEFAULT = 10
 
-    def help
+    def banner
       'Set number of source lines to list by default'
     end
 

data/lib/byebug/settings/post_mortem.rb

@@ -1,28 +1,36 @@
 module Byebug
+  #
+  # Setting to enable/disable post_mortem mode, i.e., a debugger prompt after
+  # program termination by unhandled exception.
+  #
   class PostMortemSetting < Setting
-    def help
+    def initialize
+      Byebug.post_mortem = DEFAULT
+    end
+
+    def banner
       'Enable/disable post-mortem mode'
     end
 
     def value=(v)
       Byebug.post_mortem = v
-      at_exit { handle_post_mortem if Byebug.post_mortem? }
     end
 
     def value
       Byebug.post_mortem?
     end
+  end
 
-    private
-      #
-      # Saves information about the unhandled exception and gives a byebug
-      # prompt back to the user before program termination.
-      #
-      def handle_post_mortem
-        context = Byebug.raised_exception.__bb_context
-        file    = Byebug.raised_exception.__bb_file
-        line    = Byebug.raised_exception.__bb_line
-        Byebug.handler.at_line(context, file, line)
-      end
+  #
+  # Saves information about the unhandled exception and gives a byebug
+  # prompt back to the user before program termination.
+  #
+  def self.handle_post_mortem
+    context = Byebug.raised_exception.__bb_context
+    file    = Byebug.raised_exception.__bb_file
+    line    = Byebug.raised_exception.__bb_line
+    Byebug.handler.at_line(context, file, line)
   end
+
+  at_exit { Byebug.handle_post_mortem if Byebug.post_mortem? }
 end

data/lib/byebug/settings/stack_on_error.rb

@@ -1,7 +1,11 @@
 module Byebug
+  #
+  # Setting to enable/disable the display of backtraces when evaluations raise
+  # errors.
+  #
   class StackOnErrorSetting < Setting
-    def help
-      'Display stack trace when "eval" raises an exception'
+    def banner
+      'Display stack trace when `eval` raises an exception'
     end
   end
 end

data/lib/byebug/settings/testing.rb

@@ -1,6 +1,11 @@
 module Byebug
+  #
+  # Special setting to flag that byebug is being tested.
+  #
+  # FIXME: make this private.
+  #
   class TestingSetting < Setting
-    def help
+    def banner
       'Used when testing byebug'
     end
   end

data/lib/byebug/settings/tracing_plus.rb

@@ -1,6 +1,10 @@
 module Byebug
+  #
+  # Setting to allow consecutive repeated lines to be displayed when line
+  # tracing is enabled.
+  #
   class TracingPlusSetting < Setting
-    def help
+    def banner
       'Set line execution tracing to always show different lines'
     end
   end

data/lib/byebug/settings/verbose.rb

@@ -1,7 +1,18 @@
 module Byebug
+  #
+  # Setting to show verbose output about TracePoint API events.
+  #
   class VerboseSetting < Setting
-    def help
-     'Enable verbose output of TracePoint API events'
+    def banner
+      'Enable verbose output of TracePoint API events'
+    end
+
+    def value=(v)
+      Byebug.verbose = v
+    end
+
+    def value
+      Byebug.verbose?
     end
   end
 end

data/lib/byebug/settings/width.rb

@@ -1,8 +1,11 @@
 module Byebug
+  #
+  # Setting to customize the maximum width of byebug's output.
+  #
   class WidthSetting < Setting
     DEFAULT = 160
 
-    def help
+    def banner
       "Number of characters per line in byebug's output"
     end
 

data/lib/byebug/version.rb

@@ -1,3 +1,3 @@
 module Byebug
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/test/{break_test.rb → commands/break_test.rb}

@@ -27,12 +27,12 @@ module Byebug
       enter 'break 19'
 
       debug_proc(@example) do
-        assert_equal 19, first_brkpt.pos
-        assert_equal __FILE__, first_brkpt.source
-        assert_equal nil, first_brkpt.expr
-        assert_equal 0, first_brkpt.hit_count
-        assert_equal 0, first_brkpt.hit_value
-        assert_equal true, first_brkpt.enabled?
+        assert_equal 19, Breakpoint.first.pos
+        assert_equal __FILE__, Breakpoint.first.source
+        assert_equal nil, Breakpoint.first.expr
+        assert_equal 0, Breakpoint.first.hit_count
+        assert_equal 0, Breakpoint.first.hit_value
+        assert_equal true, Breakpoint.first.enabled?
       end
     end
 
@@ -144,26 +144,26 @@ module Byebug
     end
 
     def test_disabling_breakpoints_with_short_syntax_sets_enabled_to_false
-      enter 'break 19', 'break 20', -> { "disable #{first_brkpt.id}" }
+      enter 'break 19', 'break 20', -> { "disable #{Breakpoint.first.id}" }
 
-      debug_proc(@example) { assert_equal false, first_brkpt.enabled? }
+      debug_proc(@example) { assert_equal false, Breakpoint.first.enabled? }
     end
 
     def test_disabling_breakpoints_with_short_syntax_properly_ignores_them
-      enter 'break 19', 'break 20', -> { "disable #{first_brkpt.id}" } , 'cont'
+      enter 'b 19', 'b 20', -> { "disable #{Breakpoint.first.id}" } , 'cont'
 
       debug_proc(@example) { assert_equal 20, state.line }
     end
 
     def test_disabling_breakpoints_with_full_syntax_sets_enabled_to_false
-      enter 'b 19', 'b 20', -> { "disable breakpoints #{first_brkpt.id}" }
+      enter 'b 19', 'b 20', -> { "disable breakpoints #{Breakpoint.first.id}" }
 
-      debug_proc(@example) { assert_equal false, first_brkpt.enabled? }
+      debug_proc(@example) { assert_equal false, Breakpoint.first.enabled? }
     end
 
     def test_disabling_breakpoints_with_full_syntax_properly_ignores_them
-      enter 'b 19', 'b 20', -> { "disable breakpoints #{first_brkpt.id}" },
-            'cont'
+      enter 'break 19', 'break 20',
+            -> { "disable breakpoints #{Breakpoint.first.id}" }, 'cont'
 
       debug_proc(@example) { assert_equal 20, state.line }
     end
@@ -172,8 +172,8 @@ module Byebug
       enter 'break 19', 'break 20', 'disable breakpoints'
 
       debug_proc(@example) do
-         assert_equal false, first_brkpt.enabled?
-         assert_equal false, last_brkpt.enabled?
+         assert_equal false, Breakpoint.first.enabled?
+         assert_equal false, Breakpoint.last.enabled?
       end
     end
 
@@ -188,8 +188,8 @@ module Byebug
       enter 'disable'
 
       debug_proc(@example)
-      check_error_includes \
-        '"disable" must be followed by "display", "breakpoints" or breakpoint ids'
+      check_error_includes '"disable" must be followed by "display", ' \
+                           '"breakpoints" or breakpoint ids'
     end
 
     def test_disabling_breakpoints_shows_an_error_if_no_breakpoints_are_set
@@ -203,20 +203,20 @@ module Byebug
       enter 'break 5', 'disable foo'
 
       debug_proc(@example)
-      check_output_includes \
+      check_error_includes \
         '"disable breakpoints" argument "foo" needs to be a number'
     end
 
     def test_enabling_breakpoints_with_short_syntax_sets_enabled_to_true
       enter 'b 19', 'b 20', 'disable breakpoints',
-            -> { "enable #{first_brkpt.id}" }
+            -> { "enable #{Breakpoint.first.id}" }
 
-      debug_proc(@example) { assert_equal true, first_brkpt.enabled? }
+      debug_proc(@example) { assert_equal true, Breakpoint.first.enabled? }
     end
 
     def test_enabling_breakpoints_with_short_syntax_stops_at_enabled_breakpoint
       enter 'break 19', 'break 20', 'disable breakpoints',
-            -> { "enable #{first_brkpt.id}" }, 'cont'
+            -> { "enable #{Breakpoint.first.id}" }, 'cont'
 
       debug_proc(@example) { assert_equal 19, state.line }
     end
@@ -225,8 +225,8 @@ module Byebug
       enter 'break 19', 'break 20', 'disable breakpoints', 'enable breakpoints'
 
       debug_proc(@example) do
-         assert_equal true, first_brkpt.enabled?
-         assert_equal true, last_brkpt.enabled?
+         assert_equal true, Breakpoint.first.enabled?
+         assert_equal true, Breakpoint.last.enabled?
       end
     end
 
@@ -245,14 +245,14 @@ module Byebug
 
     def test_enabling_breakpoints_with_full_syntax_sets_enabled_to_false
       enter 'break 19', 'break 20', 'disable breakpoints',
-            -> { "enable breakpoints #{last_brkpt.id}" }
+            -> { "enable breakpoints #{Breakpoint.last.id}" }
 
-      debug_proc(@example) { assert_equal false, first_brkpt.enabled? }
+      debug_proc(@example) { assert_equal false, Breakpoint.first.enabled? }
     end
 
     def test_enabling_breakpoints_with_full_syntax_stops_at_enabled_breakpoint
       enter 'break 19', 'break 20', 'disable breakpoints',
-            -> { "enable breakpoints #{last_brkpt.id}" }, 'cont'
+            -> { "enable breakpoints #{Breakpoint.last.id}" }, 'cont'
 
       debug_proc(@example) { assert_equal 20, state.line }
     end
@@ -261,8 +261,8 @@ module Byebug
       enter 'enable'
 
       debug_proc(@example)
-      check_error_includes \
-        '"enable" must be followed by "display", "breakpoints" or breakpoint ids'
+      check_error_includes '"enable" must be followed by "display", ' \
+                           '"breakpoints" or breakpoint ids'
     end
 
     def test_conditional_breakpoint_stops_if_condition_is_true
@@ -303,7 +303,7 @@ module Byebug
   module FilenameTests
     def test_setting_breakpoint_prints_confirmation_message
       enter 'break 19'
-      debug_proc(@example) { @id = first_brkpt.id }
+      debug_proc(@example) { @id = Breakpoint.first.id }
       check_output_includes "Created breakpoint #{@id} at #{@filename}:19"
     end
 
@@ -342,35 +342,23 @@ module Byebug
     include FilenameTests
   end
 
-  class BreakTestCaseAutoreload < BreakTestCase
-    def setup
-      super
-      enter 'set autoreload'
+  def test_setting_breakpoint_with_autoreload_uses_new_source
+    enter 'set autoreload', -> do
+      change_line_in_file(__FILE__, 19, '')
+      'break 19'
     end
 
-    def test_setting_breakpoint_with_autoreload_uses_new_source
-      enter -> do
-        change_line_in_file(__FILE__, 19, '')
-        'break 19'
-      end
-      debug_proc(@example) { assert_empty Byebug.breakpoints }
-      change_line_in_file(__FILE__,19, '        BreakExample.new.b')
-    end
+    debug_proc(@example) { assert_empty Byebug.breakpoints }
+    change_line_in_file(__FILE__,19, '        BreakExample.new.b')
   end
 
-  class BreakTestCaseNoAutoreload < BreakTestCase
-    def setup
-      super
-      enter 'set noautoreload'
+  def test_setting_breakpoint_with_noautoreload_uses_old_source
+    enter 'set noautoreload', -> do
+      change_line_in_file(__FILE__, 19, '')
+      'break 19'
     end
 
-    def test_setting_breakpoint_with_autoreload_uses_new_source
-      enter -> do
-        change_line_in_file(__FILE__, 19, '')
-        'break 19'
-      end
-      debug_proc(@example) { assert_equal 1, Byebug.breakpoints.size }
-      change_line_in_file(__FILE__,19, '        BreakExample.new.b')
-    end
+    debug_proc(@example) { assert_equal 1, Byebug.breakpoints.size }
+    change_line_in_file(__FILE__,19, '        BreakExample.new.b')
   end
 end

data/test/{condition_test.rb → commands/condition_test.rb}

@@ -12,27 +12,27 @@ module Byebug
     end
 
     def test_setting_condition_w_short_syntax_assigns_expression_to_breakpoint
-      enter 'break 7', -> { "cond #{first_brkpt.id} b == 5" }
+      enter 'break 7', -> { "cond #{Breakpoint.first.id} b == 5" }
 
-      debug_proc(@example) { assert_equal 'b == 5', first_brkpt.expr }
+      debug_proc(@example) { assert_equal 'b == 5', Breakpoint.first.expr }
     end
 
     def test_setting_condition_w_full_syntax_assigns_expression_to_breakpoint
-      enter 'break 7', -> { "condition #{first_brkpt.id} b == 5" }
+      enter 'break 7', -> { "condition #{Breakpoint.first.id} b == 5" }
 
-      debug_proc(@example) { assert_equal 'b == 5', first_brkpt.expr }
+      debug_proc(@example) { assert_equal 'b == 5', Breakpoint.first.expr }
     end
 
     def test_setting_condition_w_wrong_syntax_does_not_enable_breakpoint
-      enter 'break 7', -> { "disable #{first_brkpt.id}" },
-                       -> { "cond #{first_brkpt.id} b ==" }
+      enter 'break 7', -> { "disable #{Breakpoint.first.id}" },
+                       -> { "cond #{Breakpoint.first.id} b ==" }
 
-      debug_proc(@example) { assert_equal false, first_brkpt.enabled? }
+      debug_proc(@example) { assert_equal false, Breakpoint.first.enabled? }
     end
 
     def test_setting_condition_w_wrong_syntax_shows_error
-      enter 'break 7', -> { "disable #{first_brkpt.id}" },
-                       -> { "cond #{first_brkpt.id} b ==" }
+      enter 'break 7', -> { "disable #{Breakpoint.first.id}" },
+                       -> { "cond #{Breakpoint.first.id} b ==" }
 
       debug_proc(@example)
       check_error_includes \
@@ -40,28 +40,28 @@ module Byebug
     end
 
     def test_execution_stops_when_condition_is_true
-      enter 'break 7', -> { "cond #{first_brkpt.id} b == 5" }, 'cont'
+      enter 'break 7', -> { "cond #{Breakpoint.first.id} b == 5" }, 'cont'
 
       debug_proc(@example) { assert_equal 7, state.line }
     end
 
     def test_execution_does_not_stop_when_condition_is_false
-      enter 'b 7', 'b 8', -> { "cond #{first_brkpt.id} b == 3" }, 'cont'
+      enter 'b 7', 'b 8', -> { "cond #{Breakpoint.first.id} b == 3" }, 'cont'
 
       debug_proc(@example) { assert_equal 8, state.line }
     end
 
     def test_conditions_with_wrong_syntax_are_ignored
-      enter 'break 7', 'break 8', -> { "cond #{first_brkpt.id} b ==" },  'cont'
+      enter 'b 7', 'b 8', -> { "cond #{Breakpoint.first.id} b ==" }, 'cont'
 
       debug_proc(@example) { assert_equal 7, state.line }
     end
 
     def test_empty_condition_means_removing_any_conditions
-      enter 'b 7 if b == 3', 'b 8', -> { "cond #{first_brkpt.id}" }, 'cont'
+      enter 'b 7 if b == 3', 'b 8', -> { "cond #{Breakpoint.first.id}" }, 'c'
 
       debug_proc(@example) do
-        assert_nil first_brkpt.expr
+        assert_nil Breakpoint.first.expr
         assert_equal 7, state.line
       end
     end