byebug 3.1.2 → 3.2.0

data/test/save_test.rb

@@ -1,83 +1,67 @@
-module SaveTest
-  class SaveTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class SaveTestCase < TestCase
+    def setup
       @example = -> do
         byebug
         a = 2
         a = 3
       end
-    end
-
-    describe 'successful saving' do
-      let(:file_name) { 'save_output.txt' }
-      let(:file_contents) { File.read(file_name) }
-      before do
-        enter 'break 2', 'break 3 if true', 'catch NoMethodError',
-              'display 2 + 3', 'display 5 + 6', "save #{file_name}"
-        debug_proc(@example)
-      end
-      after do
-        File.delete(file_name)
-      end
 
-      it 'must save usual breakpoints' do
-        file_contents.must_include "break #{__FILE__}:2"
-      end
+      super
 
-      it 'must save conditinal breakpoints' do
-        file_contents.must_include "break #{__FILE__}:3 if true"
-      end
-
-      it 'must save catchpoints' do
-        file_contents.must_include 'catch NoMethodError'
-      end
+      enter 'break 2', 'break 3 if true', 'catch NoMethodError',
+            'display 2 + 3', 'save save_output.txt'
+      debug_proc(@example)
+    end
 
-      it 'must save displays' do
-        file_contents.must_include 'display 2 + 3'
-      end
+    def teardown
+      File.delete('save_output.txt')
+    end
 
-      describe 'saving settings' do
-        it 'must save autoeval' do
-          file_contents.must_include 'set autoeval true'
-        end
+    def file_contents
+      @file_contents ||= File.read('save_output.txt')
+    end
 
-        it 'must save basename' do
-          file_contents.must_include 'set basename false'
-        end
+    def test_save_records_regular_breakpoints
+      assert_includes file_contents, "break #{__FILE__}:2"
+    end
 
-        it 'must save testing' do
-          file_contents.must_include 'set testing true'
-        end
+    def test_save_records_conditional_breakpoints
+      assert_includes file_contents, "break #{__FILE__}:3 if true"
+    end
 
-        it 'must save autolist' do
-          file_contents.must_include 'set autolist true'
-        end
+    def test_save_records_catchpoints
+      assert_includes file_contents, 'catch NoMethodError'
+    end
 
-        it 'must save autoirb' do
-          file_contents.must_include 'set autoirb false'
-        end
-      end
+    def test_save_records_displays
+      assert_includes file_contents, 'display 2 + 3'
+    end
 
-      it 'must show a message about successful saving' do
-        check_output_includes "Saved to '#{file_name}'"
-      end
+    def test_save_records_current_state_of_settings
+      assert_includes file_contents, 'set autoeval true'
+      assert_includes file_contents, 'set basename false'
+      assert_includes file_contents, 'set testing true'
+      assert_includes file_contents, 'set autolist false'
+      assert_includes file_contents, 'set autoirb false'
     end
 
-    describe 'without filename' do
-      let(:file_contents) { File.read(interface.restart_file) }
-      after { FileUtils.rm(interface.restart_file) }
+    def test_save_shows_a_success_message
+      check_output_includes "Saved to 'save_output.txt'"
+    end
 
-      it 'must fabricate a filename if not provided' do
-        enter 'save'
-        debug_proc(@example)
-        file_contents.must_include 'set autoirb'
-      end
+    def test_save_without_a_filename_uses_a_default_file
+      enter 'save'
+      debug_proc(@example)
+      assert_includes File.read(interface.restart_file), 'set autoirb false'
+      FileUtils.rm(interface.restart_file)
+    end
 
-      it 'must show a message where the file is saved' do
-        enter 'save'
-        debug_proc(@example)
-        check_output_includes "Saved to '#{interface.restart_file}'"
-      end
+    def test_save_without_a_filename_shows_a_message_with_the_file_used
+      enter 'save'
+      debug_proc(@example)
+      check_output_includes "Saved to '#{interface.restart_file}'"
+      FileUtils.rm(interface.restart_file)
     end
   end
 end

data/test/set_test.rb

@@ -1,183 +1,132 @@
-module SetTest
-  class SetTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class SetTestCase < TestCase
+    def setup
       @example = -> do
         byebug
         a = 2
         a += 1
       end
+
+      super
     end
 
     [:autoeval, :autolist, :autoreload, :autosave, :basename, :forcestep,
-     :fullpath, :post_mortem, :stack_on_error, :testing, :linetrace,
-     :tracing_plus].each do |setting|
-      describe "setting boolean #{setting} to on" do
-        temporary_change_hash Byebug::Setting, setting, false
-
-        it "must set #{setting} to on using on" do
-          enter "set #{setting} on"
-          debug_proc(@example)
-          Byebug::Setting[setting].must_equal true
-        end
-
-        it "must set #{setting} to on using 1" do
-          enter "set #{setting} 1"
-          debug_proc(@example)
-          Byebug::Setting[setting].must_equal true
-        end
-
-        it "must set #{setting} to on by default" do
-          enter "set #{setting}"
+     :fullpath, :post_mortem, :stack_on_error, :testing,
+     :tracing_plus].each do |set|
+      ['on', '1', 'true', ''].each do |key|
+        define_method(:"test_enable_boolean_setting_#{set}_using_#{key}") do
+          Setting[set] = false
+          enter "set #{set} #{key}"
           debug_proc(@example)
-          Byebug::Setting[setting].must_equal true
+          assert_equal true, Setting[set]
         end
       end
 
-      describe "setting boolean #{setting} to off" do
-        temporary_change_hash Byebug::Setting, setting, true
-
-        it "must set #{setting} to off using off" do
-          enter "set #{setting} off"
-          debug_proc(@example)
-          Byebug::Setting[setting].must_equal false
-        end
-
-        it "must set #{setting} to on using 0" do
-          enter "set #{setting} 0"
+      ['off', '0', 'false'].each do |key|
+        define_method(:"test_disable_boolean_setting_#{set}_using_#{key}") do
+          Setting[set] = true
+          enter "set #{set} #{key}"
           debug_proc(@example)
-          Byebug::Setting[setting].must_equal false
-        end
-
-        it "must set #{setting} to off using 'no' prefix" do
-          enter "set no#{setting}"
-          debug_proc(@example)
-          Byebug::Setting[setting].must_equal false
+          assert_equal false, Setting[set]
         end
       end
-    end
 
-    describe 'shortcuts' do
-      describe 'setting' do
-        temporary_change_hash Byebug::Setting, :autosave, false
-
-        it 'must set setting if shortcut not ambiguous' do
-          enter 'set autos'
-          debug_proc(@example)
-          Byebug::Setting[:autosave].must_equal true
-        end
-
-        it 'must not set setting if shortcut is ambiguous' do
-          enter 'set auto'
-          debug_proc(@example)
-          Byebug::Setting[:autosave].must_equal false
-        end
-      end
-
-      describe 'unsetting' do
-        temporary_change_hash Byebug::Setting, :autosave, true
-
-        it 'must unset setting if shortcut not ambiguous' do
-          enter 'set noautos'
-          debug_proc(@example)
-          Byebug::Setting[:autosave].must_equal false
-        end
-
-        it 'must not set setting to off if shortcut ambiguous' do
-          enter 'set noauto'
-          debug_proc(@example)
-          Byebug::Setting[:autosave].must_equal true
-        end
+      define_method(:"test_disable_boolean_setting_#{set}_using_no_prefix") do
+        Setting[set] = true
+        enter "set no#{set}"
+        debug_proc(@example)
+        assert_equal false, Setting[set]
       end
     end
 
-    describe 'testing' do
-      describe 'state' do
-        describe 'when setting "testing" to on' do
-          temporary_change_hash Byebug::Setting, :testing, false
-
-          it 'must get set' do
-            enter 'set testing', 'break 7', 'cont'
-            debug_proc(@example) {
-              state.must_be_kind_of Byebug::CommandProcessor::State }
-          end
-        end
-
-        describe 'when setting "testing" to off' do
-          temporary_change_hash Byebug::Setting, :testing, true
-
-          it 'must get unset' do
-            enter 'set notesting', 'break 7', 'cont'
-            debug_proc(@example) { state.must_be_nil }
-          end
-        end
-      end
+    def test_set_enables_a_setting_using_shorcut_when_not_ambiguous
+      Setting[:forcestep] = false
+      enter 'set fo'
+      debug_proc(@example)
+      assert_equal true, Setting[:forcestep]
     end
 
-    describe 'histsize' do
-      temporary_change_hash Byebug::Setting, :histsize, 1
+    def test_set_does_not_enable_a_setting_using_shorcut_when_ambiguous
+      Setting[:forcestep] = false
+      Setting[:fullpath] = false
+      enter 'set f'
+      debug_proc(@example)
+      assert_equal false, Setting[:forcestep]
+      assert_equal false, Setting[:fullpath]
+    end
 
-      it 'must set maximum history size' do
-        enter 'set histsize 250'
-        debug_proc(@example)
-        Byebug::Setting[:histsize].must_equal 250
-      end
+    def test_set_disables_a_setting_using_shorcut_when_not_ambiguous
+      Setting[:forcestep] = true
+      enter 'set nofo'
+      debug_proc(@example)
+      assert_equal false, Setting[:forcestep]
+    end
 
-      it 'must show a message' do
-        enter 'set histsize 250'
-        debug_proc(@example)
-        check_output_includes "Maximum size of byebug's command history is 250"
-      end
+    def test_set_does_not_disable_a_setting_using_shorcut_when_ambiguous
+      Setting[:forcestep] = true
+      Setting[:fullpath] = true
+      enter 'set nof'
+      debug_proc(@example)
+      assert_equal true, Setting[:forcestep]
+      assert_equal true, Setting[:fullpath]
+    end
 
-      it 'must show an error message if no size provided' do
-        enter 'set histsize'
-        debug_proc(@example)
-        check_output_includes 'You must specify a value for setting :histsize'
+    def test_set_testing_sets_the_thread_state_variable
+      Setting[:testing] = false
+      enter 'set testing', 'break 7', 'cont'
+      debug_proc(@example) do
+        assert_kind_of CommandProcessor::State, state
       end
     end
 
-    describe 'histfile' do
-      let(:filename) { File.expand_path('.custom-byebug-hist') }
-
-      temporary_change_hash Byebug::Setting, :histfile, File.expand_path('.byebug-hist')
-
-      it 'must set history filename' do
-        enter "set histfile #{filename}"
-        debug_proc(@example)
-        Byebug::Setting[:histfile].must_equal filename
-      end
+    def test_set_notesting_unsets_the_thread_state_variable
+      Setting[:testing] = true
+      enter 'set notesting', 'break 7', 'cont'
+      debug_proc(@example) { assert_nil state }
+    end
 
-      it 'must show a message' do
-        enter "set histfile #{filename}"
-        debug_proc(@example)
-        check_output_includes "The command history file is #{filename}"
-      end
+    def test_set_histsize_sets_maximum_history_size
+      Setting[:histsize] = 1
+      enter 'set histsize 250'
+      debug_proc(@example)
+      assert_equal 250, Setting[:histsize]
+      check_output_includes "Maximum size of byebug's command history is 250"
+    end
 
-      it 'must show an error message if no filename provided' do
-        enter 'set histfile'
-        debug_proc(@example)
-        check_output_includes 'You must specify a value for setting :histfile'
-      end
+    def test_set_histsize_shows_an_error_message_if_no_size_is_provided
+      enter 'set histsize'
+      debug_proc(@example)
+      check_output_includes 'You must specify a value for setting :histsize'
     end
 
-    [:listsize, :width].each do |setting|
-      describe "setting integer setting #{setting}" do
-        temporary_change_hash Byebug::Setting, setting, 80
+    def test_set_histfile_sets_command_history_file
+      filename = File.expand_path('.custom-byebug-hist')
+      enter "set histfile #{filename}"
+      debug_proc(@example)
+      assert_equal filename, Setting[:histfile]
+      check_output_includes "The command history file is #{filename}"
+    end
 
-        it 'must get correctly set' do
-          enter "set #{setting} 120"
-          debug_proc(@example)
-          Byebug::Setting[setting].must_equal 120
-        end
-      end
+    def test_set_histfile_shows_an_error_message_if_no_filename_is_provided
+      enter 'set histfile'
+      debug_proc(@example)
+      check_output_includes 'You must specify a value for setting :histfile'
     end
 
-    describe 'Help' do
-      it 'must show help when typing just "set"' do
-        enter 'set', 'cont'
+    [:listsize, :width].each do |set|
+      define_method(:"test_set_#{set}_changes_integer_setting_#{set}") do
+        Setting[set] = 80
+        enter "set #{set} 120"
         debug_proc(@example)
-        check_output_includes(/Modifies parts of byebug environment./)
-        check_output_includes(/List of settings supported in byebug/)
+        assert_equal 120, Setting[set]
       end
     end
+
+    def test_set_without_arguments_shows_help_for_set_command
+      enter 'set'
+      debug_proc(@example)
+      check_output_includes(/Modifies parts of byebug environment./)
+      check_output_includes(/List of settings supported in byebug/)
+    end
   end
 end

data/test/show_test.rb

@@ -1,97 +1,76 @@
-module ShowTest
-  class ShowTestCase < TestDsl::TestCase
-    before do
+module Byebug
+  class ShowTestCase < TestCase
+    def setup
       @example = -> do
         byebug
       end
-    end
-
-    [:autoeval, :autolist, :autoreload, :autosave, :basename, :forcestep,
-     :fullpath, :post_mortem, :stack_on_error, :testing, :linetrace,
-     :tracing_plus].each do |setting|
-      describe "showing disabled boolean setting #{setting}" do
-        temporary_change_hash Byebug::Setting, setting, false
-
-        it 'must show default value' do
-          enter "show #{setting}"
-          debug_proc(@example)
-          check_output_includes "#{setting} is off"
-        end
-      end
-
-      describe "showing enabled boolean setting #{setting}" do
-        temporary_change_hash Byebug::Setting, setting, true
 
-        it 'must show default value' do
-          enter "show #{setting}"
-          debug_proc(@example)
-          check_output_includes "#{setting} is on"
-        end
-      end
+      super
     end
 
-    describe 'callstyle' do
-      it 'must show default value' do
-        enter 'show callstyle'
+    [:autoeval, :autolist, :autoreload, :autosave, :basename, :forcestep,
+     :fullpath, :post_mortem, :stack_on_error, :testing,
+     :tracing_plus].each do |set|
+      define_method(:"test_show_#{set}_shows_disabled_bool_setting_#{set}") do
+        Setting[set] = false
+        enter "show #{set}"
         debug_proc(@example)
-        check_output_includes 'Frame display callstyle is :long'
+        check_output_includes "#{set} is off"
       end
-    end
 
-    describe 'listsize' do
-      it 'must show listsize' do
-        enter 'show listsize'
+      define_method(:"test_show_#{set}_shows_enabled_bool_setting_#{set}") do
+        Setting[set] = true
+        enter "show #{set}"
         debug_proc(@example)
-        check_output_includes 'Number of source lines to list is 10'
+        check_output_includes "#{set} is on"
       end
     end
 
-    describe 'width' do
-      let(:cols) { `stty size`.scan(/\d+/)[1].to_i }
-
-      it 'must show default width' do
-        enter 'show width'
-        debug_proc(@example)
-        check_output_includes "Maximum width of byebug's output is #{cols}"
-      end
+    def test_show_callstyle
+      enter 'show callstyle'
+      debug_proc(@example)
+      check_output_includes "Frame display callstyle is 'long'"
     end
 
-    describe 'unknown command' do
-      it 'must show a message' do
-        enter 'show bla'
-        debug_proc(@example)
-        check_output_includes 'Unknown setting :bla'
-      end
+    def test_show_listsize
+      enter 'show listsize'
+      debug_proc(@example)
+      check_output_includes 'Number of source lines to list is 10'
     end
 
-    describe 'histfile' do
-      before { @filename = Byebug::Setting[:histfile] }
+    def test_show_width
+      width = Setting[:width]
+      enter 'show width'
+      debug_proc(@example)
+      check_output_includes "Maximum width of byebug's output is #{width}"
+    end
 
-      it 'must show history filename' do
-        enter 'show histfile'
-        debug_proc(@example)
-        check_output_includes "The command history file is #{@filename}"
-      end
+    def test_show_unknown_setting
+      enter 'show bla'
+      debug_proc(@example)
+      check_output_includes 'Unknown setting :bla'
     end
 
-    describe 'histsize' do
-      before { @max_size = Byebug::Setting[:histsize] }
+    def test_show_histfile
+      filename = Setting[:histfile]
+      enter 'show histfile'
+      debug_proc(@example)
+      check_output_includes "The command history file is #{filename}"
+    end
 
-      it "must show history's max size" do
-        enter 'show histsize'
-        debug_proc(@example)
-        check_output_includes \
-          "Maximum size of byebug's command history is #{@max_size}"
-      end
+    def test_show_histsize
+      max_size = Setting[:histsize]
+      enter 'show histsize'
+      debug_proc(@example)
+      check_output_includes \
+        "Maximum size of byebug's command history is #{max_size}"
     end
 
-    describe 'Help' do
-      it 'must show help when typing just "show"' do
-        enter 'show', 'cont'
-        debug_proc(@example)
-        check_output_includes(/Generic command for showing byebug settings./)
-        check_output_includes(/List of settings supported in byebug/)
-      end
+    def test_show_without_arguments_displays_help_for_the_show_command
+      enter 'show'
+      debug_proc(@example)
+      check_output_includes(/Generic command for showing byebug settings./)
+      check_output_includes(/List of settings supported in byebug/)
     end
   end
 end