byebug 3.0.0 → 3.1.0

data/test/restart_test.rb

@@ -1,59 +1,36 @@
-class RestartExample
-  def concat_args(a, b, c)
-    a.to_s + b.to_s + c.to_s
-  end
-end
-
-class TestRestart < TestDsl::TestCase
-  describe 'usual restarting' do
-    temporary_change_const Byebug, 'BYEBUG_SCRIPT', 'byebug_script'
-
-    it 'must be restarted with arguments' do
-      Byebug::RestartCommand.any_instance.expects(:exec).
-        with("#{Byebug::BYEBUG_SCRIPT} #{Byebug::PROG_SCRIPT} 1 2 3")
-      enter 'restart 1 2 3'
-      debug_file 'restart'
+module RestartTest
+  class Example
+    def concat_args(a, b, c)
+      a.to_s + b.to_s + c.to_s
     end
+  end
 
-    describe 'when arguments have spaces' do
-      temporary_change_hash Byebug.settings, :argv, ['argv1', 'argv 2']
-
-      it 'must be correctly escaped' do
-        Byebug::RestartCommand.any_instance.expects(:exec).with \
-          "#{Byebug::BYEBUG_SCRIPT} #{Byebug::PROG_SCRIPT} argv1 argv\\ 2"
-        enter 'restart'
-        debug_file 'restart'
+  class RestartTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        byebug
+        a = ARGV[0]
+        b = ARGV[1]
+        c = ARGV[2]
+        Example.new.concat_args(a, b, c)
       end
     end
 
-    describe 'when arguments specified by set command' do
-      temporary_change_hash Byebug.settings, :argv, []
-
-      it 'must specify arguments by "set" command' do
-        Byebug::RestartCommand.any_instance.expects(:exec).
-          with("#{Byebug::BYEBUG_SCRIPT} #{Byebug::PROG_SCRIPT} 1 2 3")
-        enter 'set args 1 2 3', 'restart'
-        debug_file 'restart'
-      end
+    def must_restart(cmd = nil)
+      expectation = Byebug::RestartCommand.any_instance.expects(:exec)
+      expectation = expectation.with(cmd) if cmd
+      expectation
     end
-  end
-
-  describe 'messaging' do
-    before { enter 'restart' }
 
-    describe 'reexecing' do
+    describe 'usual restarting' do
       temporary_change_const Byebug, 'BYEBUG_SCRIPT', 'byebug_script'
 
-      describe 'with set args' do
-        temporary_change_hash Byebug.settings, :argv, ['argv']
-
-        it 'must restart and show a message about reexecing' do
-          must_restart
-          debug_file 'restart'
-          check_output_includes \
-            "Re exec'ing:\n"    \
-            "\t#{Byebug::BYEBUG_SCRIPT} #{Byebug::PROG_SCRIPT} argv"
-        end
+      it 'must be restarted with arguments' do
+        cmd = "#{Byebug::BYEBUG_SCRIPT} #{Byebug::PROG_SCRIPT} 1 2 3"
+        must_restart(cmd)
+        enter 'restart 1 2 3'
+        debug_proc(@example)
+        check_output_includes "Re exec'ing:\n\t#{cmd}"
       end
     end
 
@@ -62,9 +39,9 @@ class TestRestart < TestDsl::TestCase
 
       it 'must not restart and show error messages instead' do
         must_restart.never
-        debug_file 'restart'
-        check_output_includes 'Don\'t know name of debugged program',
-                                interface.error_queue
+        enter 'restart'
+        debug_proc(@example)
+        check_error_includes 'Don\'t know name of debugged program'
       end
     end
 
@@ -73,32 +50,40 @@ class TestRestart < TestDsl::TestCase
 
       it 'must not restart' do
         must_restart.never
-        debug_file 'restart'
+        enter 'restart'
+        debug_proc(@example)
       end
 
       it 'must show an error message' do
-        debug_file 'restart'
-        check_output_includes 'Ruby program blabla doesn\'t exist',
-                              interface.error_queue
+        enter 'restart'
+        debug_proc(@example)
+        check_error_includes 'Ruby program blabla doesn\'t exist'
       end
     end
 
-    describe 'byebug runner script is not specified' do
-      before { must_restart }
+    describe 'when no runner script specified' do
+      temporary_change_const Byebug, 'BYEBUG_SCRIPT', :__undefined__
 
-      it 'must restart anyway' do
-        debug_file 'restart'
-      end
+      describe 'restarting' do
+        before do
+          must_restart
+          enter 'restart'
+        end
 
-      it 'must show a warning message' do
-        debug_file 'restart'
-        check_output_includes 'Byebug was not called from the outset...'
-      end
+        it 'must restart anyways' do
+          debug_proc(@example)
+        end
+
+        it 'must show a warning message' do
+          debug_proc(@example)
+          check_output_includes 'Byebug was not called from the outset...'
+        end
 
-      it 'must show a warning message when prog script is not executable' do
-        debug_file 'restart'
-        check_output_includes "Ruby program #{Byebug::PROG_SCRIPT} not " \
-                              "executable... We'll add a call to Ruby."
+        it 'must show a warning message when prog script is not executable' do
+          debug_proc(@example)
+          check_output_includes "Ruby program #{Byebug::PROG_SCRIPT} not " \
+                                "executable... We'll wrap it in a ruby call"
+        end
       end
     end
 
@@ -107,12 +92,14 @@ class TestRestart < TestDsl::TestCase
 
       it 'must restart anyway' do
         must_restart
-        debug_file 'restart'
+        enter 'restart'
+        debug_proc(@example)
       end
 
       it 'must show an error message ' do
         must_restart
-        debug_file 'restart'
+        enter 'restart'
+        debug_proc(@example)
         check_output_includes \
           'Failed to change initial directory /unexistent/path'
       end

data/test/save_test.rb

@@ -1,74 +1,83 @@
-class TestSave < TestDsl::TestCase
-
-  describe 'successful saving' do
-    let(:file_name) { 'save_output.txt' }
-    let(:file_contents) { File.read(file_name) }
+module SaveTest
+  class SaveTestCase < TestDsl::TestCase
     before do
-      enter 'break 2', 'break 3 if true', 'catch NoMethodError',
-            'display 2 + 3', 'display 5 + 6', "save #{file_name}"
-      debug_file 'save'
-    end
-    after do
-      File.delete(file_name)
-    end
-
-    it 'must save usual breakpoints' do
-      file_contents.must_include "break #{fullpath('save')}:2"
-    end
-
-    it 'must save conditinal breakpoints' do
-      file_contents.must_include "break #{fullpath('save')}:3 if true"
-    end
-
-    it 'must save catchpoints' do
-      file_contents.must_include 'catch NoMethodError'
+      @example = -> do
+        byebug
+        a = 2
+        a = 3
+      end
     end
 
-    it 'must save displays' do
-      file_contents.must_include 'display 2 + 3'
-    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
 
-    describe 'saving settings' do
-      it 'must save autoeval' do
-        file_contents.must_include 'set autoeval on'
+      it 'must save usual breakpoints' do
+        file_contents.must_include "break #{__FILE__}:2"
       end
 
-      it 'must save basename' do
-        file_contents.must_include 'set basename off'
+      it 'must save conditinal breakpoints' do
+        file_contents.must_include "break #{__FILE__}:3 if true"
       end
 
-      it 'must save testing' do
-        file_contents.must_include 'set testing on'
+      it 'must save catchpoints' do
+        file_contents.must_include 'catch NoMethodError'
       end
 
-      it 'must save autolist' do
-        file_contents.must_include 'set autolist on'
+      it 'must save displays' do
+        file_contents.must_include 'display 2 + 3'
       end
 
-      it 'must save autoirb' do
-        file_contents.must_include 'set autoirb off'
+      describe 'saving settings' do
+        it 'must save autoeval' do
+          file_contents.must_include 'set autoeval true'
+        end
+
+        it 'must save basename' do
+          file_contents.must_include 'set basename false'
+        end
+
+        it 'must save testing' do
+          file_contents.must_include 'set testing true'
+        end
+
+        it 'must save autolist' do
+          file_contents.must_include 'set autolist true'
+        end
+
+        it 'must save autoirb' do
+          file_contents.must_include 'set autoirb false'
+        end
       end
-    end
 
-    it 'must show a message about successful saving' do
-      check_output_includes "Saved to '#{file_name}'"
+      it 'must show a message about successful saving' do
+        check_output_includes "Saved to '#{file_name}'"
+      end
     end
-  end
 
-  describe 'without filename' do
-    let(:file_contents) { File.read(interface.restart_file) }
-    after { FileUtils.rm(interface.restart_file) }
+    describe 'without filename' do
+      let(:file_contents) { File.read(interface.restart_file) }
+      after { FileUtils.rm(interface.restart_file) }
 
-    it 'must fabricate a filename if not provided' do
-      enter 'save'
-      debug_file 'save'
-      file_contents.must_include 'set autoirb'
-    end
+      it 'must fabricate a filename if not provided' do
+        enter 'save'
+        debug_proc(@example)
+        file_contents.must_include 'set autoirb'
+      end
 
-    it 'must show a message where the file is saved' do
-      enter 'save'
-      debug_file 'save'
-      check_output_includes "Saved to '#{interface.restart_file}'"
+      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
     end
   end
 end

data/test/set_test.rb

@@ -1,161 +1,183 @@
-class TestSet < TestDsl::TestCase
+module SetTest
+  class SetTestCase < TestDsl::TestCase
+    before do
+      @example = -> do
+        byebug
+        a = 2
+        a += 1
+      end
+    end
 
-  [:autoeval, :autoreload, :autosave, :basename, :forcestep, :fullpath,
-   :linetrace_plus, :stack_on_error].each do |setting|
+    [: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
 
-    describe "setting #{setting} to on" do
-      temporary_change_hash Byebug.settings, 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 on" do
-        enter "set #{setting} on"
-        debug_file 'set'
-        Byebug.settings[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 using 1" do
-        enter "set #{setting} 1"
-        debug_file 'set'
-        Byebug.settings[setting].must_equal true
+        it "must set #{setting} to on by default" do
+          enter "set #{setting}"
+          debug_proc(@example)
+          Byebug::Setting[setting].must_equal true
+        end
       end
 
-      it "must set #{setting} to on by default" do
-        enter "set #{setting}"
-        debug_file 'set'
-        Byebug.settings[setting].must_equal true
-      end
+      describe "setting boolean #{setting} to off" do
+        temporary_change_hash Byebug::Setting, setting, true
 
-      it "must set #{setting} using shortcut" do
-        skip 'it for now until I make it work'
-        enter "set autol"
-        debug_file 'set'
-        Byebug.settings[setting].must_equal 1
-      end
-    end
+        it "must set #{setting} to off using off" do
+          enter "set #{setting} off"
+          debug_proc(@example)
+          Byebug::Setting[setting].must_equal false
+        end
 
-    describe "setting #{setting} to off" do
-      temporary_change_hash Byebug.settings, setting, true
+        it "must set #{setting} to on using 0" do
+          enter "set #{setting} 0"
+          debug_proc(@example)
+          Byebug::Setting[setting].must_equal false
+        end
 
-      it "must set #{setting} to off using off" do
-        enter "set #{setting} off"
-        debug_file 'set'
-        Byebug.settings[setting].must_equal false
+        it "must set #{setting} to off using 'no' prefix" do
+          enter "set no#{setting}"
+          debug_proc(@example)
+          Byebug::Setting[setting].must_equal false
+        end
       end
+    end
 
-      it "must set #{setting} to on using 0" do
-        enter "set #{setting} 0"
-        debug_file 'set'
-        Byebug.settings[setting].must_equal false
-      end
+    describe 'shortcuts' do
+      describe 'setting' do
+        temporary_change_hash Byebug::Setting, :autosave, false
 
-      it "must set #{setting} to off using 'no' prefix" do
-        enter "set no#{setting}"
-        debug_file 'set'
-        Byebug.settings[setting].must_equal false
-      end
+        it 'must set setting if shortcut not ambiguous' do
+          enter 'set autos'
+          debug_proc(@example)
+          Byebug::Setting[:autosave].must_equal true
+        end
 
-      it "must set #{setting} off using 'no' prefix and shortcut" do
-        skip 'it for now until I make it work'
-        enter 'set noautol'
-        debug_file 'set'
-        Byebug.settings[setting].must_equal 0
+        it 'must not set setting if shortcut is ambiguous' do
+          enter 'set auto'
+          debug_proc(@example)
+          Byebug::Setting[:autosave].must_equal false
+        end
       end
-    end
-  end
 
-  describe 'messages' do
-    temporary_change_hash Byebug.settings, :autolist, 0
+      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 show a message after setting' do
-      enter 'set autolist on'
-      debug_file 'set'
-      check_output_includes 'autolist is on.'
+        it 'must not set setting to off if shortcut ambiguous' do
+          enter 'set noauto'
+          debug_proc(@example)
+          Byebug::Setting[:autosave].must_equal true
+        end
+      end
     end
-  end
 
-  describe 'testing' do
-    describe 'state' do
-      describe 'when setting "testing" to on' do
-        temporary_change_hash Byebug.settings, :testing, false
+    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 3', 'cont'
-          debug_file('set') {
-            state.must_be_kind_of Byebug::CommandProcessor::State }
+          it 'must get set' do
+            enter 'set testing', 'break 7', 'cont'
+            debug_proc(@example) {
+              state.must_be_kind_of Byebug::CommandProcessor::State }
+          end
         end
-      end
 
-      describe 'when setting "testing" to off' do
-        temporary_change_hash Byebug.settings, :testing, true
+        describe 'when setting "testing" to off' do
+          temporary_change_hash Byebug::Setting, :testing, true
 
-        it 'must get unset' do
-          enter 'set notesting', 'break 3', 'cont'
-          debug_file('set') { state.must_be_nil }
+          it 'must get unset' do
+            enter 'set notesting', 'break 7', 'cont'
+            debug_proc(@example) { state.must_be_nil }
+          end
         end
       end
     end
-  end
 
-  describe 'histsize' do
-    after { Byebug::History.max_size = Byebug::History::DEFAULT_MAX_SIZE }
+    describe 'histsize' do
+      temporary_change_hash Byebug::Setting, :histsize, 1
 
-    it 'must set maximum history size' do
-      enter 'set histsize 250'
-      debug_file 'set'
-      Byebug::History.max_size.must_equal 250
-    end
+      it 'must set maximum history size' do
+        enter 'set histsize 250'
+        debug_proc(@example)
+        Byebug::Setting[:histsize].must_equal 250
+      end
 
-    it 'must show a message' do
-      enter 'set histsize 250'
-      debug_file 'set'
-      check_output_includes "Byebug history's maximum size is 250"
-    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
 
-    it 'must show an error message if no size provided' do
-      enter 'set histsize'
-      debug_file 'set'
-      check_output_includes 'You need to specify the history size'
+      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'
+      end
     end
-  end
 
-  describe 'histfile' do
-    let(:filename) { File.expand_path('./.custom-byebug-hist') }
+    describe 'histfile' do
+      let(:filename) { File.expand_path('.custom-byebug-hist') }
 
-    after { Byebug::History.file = Byebug::History::DEFAULT_FILE }
+      temporary_change_hash Byebug::Setting, :histfile, File.expand_path('.byebug-hist')
 
-    it 'must set history filename' do
-      enter "set histfile #{filename}"
-      debug_file 'set'
-      Byebug::History.file.must_equal filename
-    end
+      it 'must set history filename' do
+        enter "set histfile #{filename}"
+        debug_proc(@example)
+        Byebug::Setting[:histfile].must_equal filename
+      end
 
-    it 'must show a message' do
-      enter "set histfile #{filename}"
-      debug_file 'set'
-      check_output_includes "The command history file is \"#{filename}\""
-    end
+      it 'must show a message' do
+        enter "set histfile #{filename}"
+        debug_proc(@example)
+        check_output_includes "The command history file is #{filename}"
+      end
 
-    it 'must show an error message if no filename provided' do
-      enter 'set histfile'
-      debug_file 'set'
-      check_output_includes 'You need to specify a filename'
+      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
     end
-  end
 
-  describe 'width' do
-    temporary_change_hash Byebug.settings, :width, 20
+    [:listsize, :width].each do |setting|
+      describe "setting integer setting #{setting}" do
+        temporary_change_hash Byebug::Setting, setting, 80
 
-    it 'must get correctly set' do
-      enter 'set width 10'
-      debug_file('set')
-      Byebug.settings[:width].must_equal 10
+        it 'must get correctly set' do
+          enter "set #{setting} 120"
+          debug_proc(@example)
+          Byebug::Setting[setting].must_equal 120
+        end
+      end
     end
-  end
 
-  describe 'Help' do
-    it 'must show help when typing just "set"' do
-      enter 'set', 'cont'
-      debug_file 'set'
-      check_output_includes(/List of "set" subcommands:/)
+    describe 'Help' do
+      it 'must show help when typing just "set"' do
+        enter 'set', 'cont'
+        debug_proc(@example)
+        check_output_includes(/Modifies parts of byebug environment./)
+        check_output_includes(/List of settings supported in byebug/)
+      end
     end
   end
 end