byebug 3.1.2 → 3.2.0

data/test/source_test.rb

@@ -1,44 +1,41 @@
-module SourceTest
-  class SourceTestCase < TestDsl::TestCase
-    let(:filename) { 'source_example.txt' }
-
-    before do
+module Byebug
+  class SourceTestCase < TestCase
+    def setup
       @example = -> do
         byebug
         a = 2
         a = 3
       end
 
-      File.open(filename, 'w') do |f|
+      File.open('source_example.txt', 'w') do |f|
         f.puts 'break 2'
         f.puts 'break 3 if true'
       end
-    end
-
-    after { FileUtils.rm(filename) }
 
-    it 'must run commands from file' do
-      enter "source #{filename}"
-      debug_proc(@example) do
-        Byebug.breakpoints[0].pos.must_equal 2
-        Byebug.breakpoints[1].pos.must_equal 3
-        Byebug.breakpoints[1].expr.must_equal 'true'
-      end
+      super
     end
 
-    it 'must be able to use shortcut' do
-      enter "so #{filename}"
-      debug_proc(@example) { Byebug.breakpoints[0].pos.must_equal 2 }
+    def teardown
+      FileUtils.rm('source_example.txt')
     end
 
-    it 'must show an error if file is not found' do
-      enter 'source blabla'
-      debug_proc(@example)
-      check_error_includes(/File ".*blabla" not found/)
-    end
+    %w(source so).each do |cmd_alias|
+      define_method(:"test_#{cmd_alias}_runs_byebug_commands_from_file") do
+        enter "#{cmd_alias} source_example.txt"
+        debug_proc(@example) do
+          assert_equal 2, Byebug.breakpoints[0].pos
+          assert_equal 3, Byebug.breakpoints[1].pos
+          assert_equal 'true', Byebug.breakpoints[1].expr
+        end
+      end
+
+      define_method(:"test_#{cmd_alias}_shows_an_error_if_file_not_found") do
+        enter "#{cmd_alias} blabla"
+        debug_proc(@example)
+        check_error_includes(/File ".*blabla" not found/)
+      end
 
-    describe 'Help' do
-      it 'must show help when used without arguments' do
+      define_method(:"test_#{cmd_alias}_without_arguments_shows_help") do
         enter 'source'
         debug_proc(@example)
         check_output_includes \

data/test/stepping_test.rb

@@ -1,4 +1,4 @@
-module SteppingTest
+module Byebug
   class Example
     def self.a(num)
       num += 2
@@ -16,8 +16,41 @@ module SteppingTest
     end
   end
 
-  class SteppingTestCase < TestDsl::TestCase
-    before do
+  class BasicSteppingTestCase < TestCase
+    def setup
+      @example = -> do
+        byebug
+
+        ex = Example.c(7)
+        ex
+      end
+
+      super
+    end
+
+    def test_next_goes_to_the_next_line
+      enter 'next'
+      debug_proc(@example) { assert_equal 25, state.line }
+    end
+
+    def test_n_goes_to_the_next_line
+      enter 'n'
+      debug_proc(@example) { assert_equal 25, state.line }
+    end
+
+    def test_step_goes_to_the_next_statement
+      enter 'step'
+      debug_proc(@example) { assert_equal 14, state.line }
+    end
+
+    def test_s_goes_to_the_next_statement
+      enter 's'
+      debug_proc(@example) { assert_equal 14, state.line }
+    end
+  end
+
+  class AdvancedStepping < TestCase
+    def setup
       @example = -> do
         byebug
 
@@ -28,184 +61,123 @@ module SteppingTest
 
         Example.b(ex)
       end
-    end
 
-    describe 'Next Command' do
-      describe 'method call behaviour' do
-        before { enter 'break 9', 'cont' }
+      super
 
-        it 'must leave on the same line by default' do
-          enter 'next'
-          debug_proc(@example) { state.line.must_equal 9 }
-        end
+      enter 'break 9', 'cont'
+    end
 
-        it 'must go to the next line if forced by "plus" sign' do
-          enter 'next+'
-          debug_proc(@example) { state.line.must_equal 10 }
-        end
+    %w(next step).each do |cmd|
+      define_method(:"test_#{cmd}_stays_by_default") do
+        enter cmd
+        debug_proc(@example) { assert_equal 9, state.line }
+      end
 
-        it 'must leave on the same line if forced by "minus" sign' do
-          enter 'next-'
-          debug_proc(@example) { state.line.must_equal 9 }
-        end
+      define_method(:"test_#{cmd}+_goes_2_next_line") do
+        enter "#{cmd}+"
+        debug_proc(@example) { assert_equal 10, state.line }
+      end
 
-        describe 'when forcestep is set' do
-          temporary_change_hash Byebug::Setting, :forcestep, true
+      define_method(:"test_#{cmd}-_stays") do
+        enter "#{cmd}-"
+        debug_proc(@example) { assert_equal 9, state.line }
+      end
 
-          it 'must go to the next line' do
-            enter 'next'
-            debug_proc(@example) { state.line.must_equal 10 }
-          end
+      define_method(:"test_#{cmd}_goes_2_next_line_if_forcestep_is_set") do
+        enter 'set forcestep', cmd
+        debug_proc(@example) { assert_equal 10, state.line }
+      end
 
-          it 'must go to the next line (by shortcut)' do
-            enter 'n'
-            debug_proc(@example) { state.line.must_equal 10 }
-          end
+      define_method(:"test_#{cmd}+_goes_2_next_line_regardless_forcestep") do
+        enter 'set forcestep', "#{cmd}+"
+        debug_proc(@example) { assert_equal 10, state.line }
+      end
+
+      define_method(:"test_#{cmd}-_stays_regardless_forcestep") do
+        enter 'set forcestep', "#{cmd}-"
+        debug_proc(@example) { assert_equal 9, state.line }
+      end
+    end
 
-          it 'must go the specified number of lines forward by default' do
-            enter 'next 2'
-            debug_proc(@example) { state.line.must_equal 25 }
-          end
+    def test_next_goes_the_specified_number_of_lines_forward_by_default
+      enter 'set forcestep', 'next 2'
+      debug_proc(@example) { assert_equal 58, state.line }
+    end
 
-          it 'must inform when not staying in the same frame' do
-            enter 'next 2'
-            debug_proc(@example)
-            check_output_includes \
-              'Next went up a frame because previous frame finished'
-          end
+    def test_next_informs_when_not_staying_in_the_same_frame
+      enter 'set forcestep', 'next 2'
+      debug_proc(@example)
+      check_output_includes \
+          'Next went up a frame because previous frame finished'
+    end
 
+    def step_goes_the_specified_number_of_statements_forward_by_default
+      enter 'set forcestep', 'step 2'
+      debug_proc(@example) { assert_equal 58, state.line }
+    end
 
-          it 'must ignore it if "minus" is specified' do
-            enter 'next-'
-            debug_proc(@example) { state.line.must_equal 9 }
-          end
-        end
-      end
+    def test_next_steps_OVER_blocks
+      enter 'break 58', 'cont', 'next'
+      debug_proc(@example) { assert_equal 62, state.line }
+    end
 
-      describe 'block behaviour' do
-        before { enter 'break 57', 'cont' }
+    def test_step_steps_INTO_blocks
+      enter 'break 58', 'cont', 'step'
+      debug_proc(@example) { assert_equal 59, state.line }
+    end
 
-        it 'must step over blocks' do
-          enter 'next'
-          debug_proc(@example) { state.line.must_equal 24 }
-        end
+    class RaiseFromCMethodExample
+      def a
+        b
+      rescue NameError
+        1
       end
 
-      describe 'raise/rescue behaviour' do
-        describe 'from c method' do
-          before do
-            @example_raise = -> do
-              byebug
-
-              class RaiseFromCMethodExample
-                def a
-                  b
-                rescue NameError
-                  1
-                end
-
-                def b
-                  c
-                end
-
-                def c
-                  d
-                end
-              end
-
-              RaiseFromCMethodExample.new.a
-            end
-            enter 'break 102', 'cont'
-          end
-
-          it 'must step over rescue' do
-            enter 'next'
-            debug_proc(@example_raise) { state.line.must_equal 104 }
-          end
-        end
+      def b
+        c
+      end
 
-        describe 'from ruby method' do
-          before do
-            @example_raise = -> do
-              byebug
-
-              class RaiseFromRubyMethodExample
-                def a
-                  b
-                rescue
-                  1
-                end
-
-                def b
-                  c
-                end
-
-                def c
-                  raise 'bang'
-                end
-              end
-
-              RaiseFromRubyMethodExample.new.a
-            end
-            enter 'break 134', 'cont'
-          end
-
-          it 'must step over rescue' do
-            enter 'next'
-            debug_proc(@example_raise) { state.line.must_equal 136 }
-          end
-        end
+      def c
+        d
       end
     end
 
-    describe 'Step Command' do
-
-      describe 'method call behaviour' do
-        before { enter 'break 9', 'cont' }
-
-        it 'must leave on the same line if forced by a setting' do
-          enter 'step'
-          debug_proc(@example) { state.line.must_equal 9 }
-        end
-
-        it 'must go to the step line if forced to do that by "plus" sign' do
-          enter 'step+'
-          debug_proc(@example) { state.line.must_equal 10 }
-        end
+    def test_next_steps_over_rescue_when_raising_from_c_method
+      example_raise = -> do
+        byebug
 
-        it 'must leave on the same line if forced to do that by "minus" sign' do
-          enter 'step-'
-          debug_proc(@example) { state.line.must_equal 9 }
-        end
+        RaiseFromCMethodExample.new.a
+      end
 
-        describe 'when forcestep is set' do
-          temporary_change_hash Byebug::Setting, :forcestep, true
+      enter 'break 131', 'cont', 'next'
+      debug_proc(example_raise) { assert_equal 133, state.line }
+    end
 
-          it 'must go to the step line if forced by a setting' do
-            enter 'step'
-            debug_proc(@example) { state.line.must_equal 10 }
-          end
+    class RaiseFromRubyMethodExample
+      def a
+        b
+      rescue
+        1
+      end
 
-          it 'must go to the next line if forced by a setting (by shortcut)' do
-            enter 's'
-            debug_proc(@example) { state.line.must_equal 10 }
-          end
+      def b
+        c
+      end
 
-          it 'must go the specified number of lines forward by default' do
-            enter 'step 2'
-            debug_proc(@example) { state.line.must_equal 14 }
-          end
-        end
+      def c
+        raise 'bang'
       end
+    end
 
-      describe 'block behaviour' do
-        before { enter 'break 25', 'cont' }
+    def test_next_steps_over_rescue_when_raising_from_ruby_method
+      example_raise = -> do
+        byebug
 
-        it 'must step into blocks' do
-          enter 'step'
-          debug_proc(@example) { state.line.must_equal 26 }
-        end
+        RaiseFromRubyMethodExample.new.a
       end
+
+      enter 'break 158', 'cont', 'next'
+      debug_proc(example_raise) { assert_equal 160, state.line }
     end
   end
 end

data/test/support/matchers.rb

@@ -1,4 +1,4 @@
-module MiniTest::Assertions
+module Minitest::Assertions
 
   # This matcher checks that given collection is included into the original
   # collection and in correct order. It accepts both strings and regexps.
@@ -61,8 +61,3 @@ module MiniTest::Assertions
       result
     end
 end
-
-module MiniTest::Expectations
-  infect_an_assertion :assert_includes_in_order, :must_include_in_order
-  infect_an_assertion :refute_includes_in_order, :wont_include_in_order
-end

data/test/support/test_interface.rb

@@ -8,7 +8,7 @@ module Byebug
 
     def initialize
       @input_queue, @output_queue, @error_queue = [], [], []
-      @confirm_queue, @command_queue, @history = [], [], Byebug::History.new
+      @confirm_queue, @command_queue, @history = [], [], History.new
     end
 
     def errmsg(*args)

data/test/support/{test_dsl.rb → utils.rb}

@@ -1,62 +1,7 @@
-module TestDsl
-
-  class TestCase < MiniTest::Spec
-    include TestDsl
-
-    def setup
-      Byebug.handler = Byebug::CommandProcessor.new(Byebug::TestInterface.new)
-      Byebug.breakpoints.clear if Byebug.breakpoints
-    end
-
-    def self.temporary_change_hash hash, key, value
-      before do
-        @old_hashes ||= {}
-        @old_hashes.merge!({ hash => { key => hash[key] } }) do |k, v1, v2|
-          v1.merge(v2)
-        end
-        hash[key] = value
-      end
-
-      after do
-        hash[key] = @old_hashes[hash][key]
-      end
-    end
-
-    def self.temporary_change_const klass, const, value
-      before do
-        @old_consts ||= {}
-        old_value = klass.const_defined?(const) ?
-                    klass.const_get(const) : :__undefined__
-        @old_consts.merge!({ klass => { const => old_value } }) do |k, v1, v2|
-          v1.merge(v2)
-        end
-        klass.send :remove_const, const if klass.const_defined?(const)
-        klass.const_set const, value unless value == :__undefined__
-      end
-
-      after do
-        klass.send :remove_const, const if klass.const_defined?(const)
-        klass.const_set const, @old_consts[klass][const] unless
-          @old_consts[klass][const] == :__undefined__
-      end
-    end
-  end
-
-  #
-  # Expand fullpath of a given example file
-  #
-  def fullpath(filename)
-    (Pathname.new(__FILE__) + "../../examples/#{filename}.rb").cleanpath.to_s
-  end
-
-  #
-  # Shorten a fullpath
-  #
-  def shortpath(fullpath)
-    separator = File::ALT_SEPARATOR || File::SEPARATOR
-    "...#{separator}" + fullpath.split(separator)[-3..-1].join(separator)
-  end
+require_relative 'matchers'
+require_relative 'test_interface'
 
+module Byebug::TestUtils
   #
   # Adds commands to the input queue, so they will be later retrieved by
   # Processor, i.e., it emulates user's input.
@@ -77,7 +22,7 @@ module TestDsl
   end
 
   #
-  # Runs the provided Proc.
+  # Runs the provided Proc
   #
   # You also can specify a block, which will be executed when Processor extracts
   # all the commands from the input queue. You can use that for making asserts
@@ -92,7 +37,7 @@ module TestDsl
   #     byebug
   #     puts 'hello'
   #   end
-  #   debug_proc(code) { state.line.must_equal 4 }
+  #   debug_proc(code) { assert_equal 4, state.line }
   #
   def debug_proc(program, &block)
     Byebug.stubs(:run_init_script)
@@ -120,19 +65,19 @@ module TestDsl
             interface.output_queue : args.pop
     queue_messages = queue.map(&:strip)
     messages = Array(args).map { |msg| msg.is_a?(String) ? msg.strip : msg }
-    queue_messages.send(check_method, messages)
+    send(check_method, messages, queue_messages)
   end
 
   def check_error_includes(*args)
-    check_output :must_include_in_order, *args, interface.error_queue
+    check_output :assert_includes_in_order, *args, interface.error_queue
   end
 
   def check_output_includes(*args)
-    check_output :must_include_in_order, *args
+    check_output :assert_includes_in_order, *args
   end
 
   def check_output_doesnt_include(*args)
-    check_output :wont_include_in_order, *args
+    check_output :refute_includes_in_order, *args
   end
 
   def interface
@@ -143,6 +88,14 @@ module TestDsl
     Thread.current.thread_variable_get('state')
   end
 
+  def first_brkpt
+    Byebug.breakpoints.first
+  end
+
+  def last_brkpt
+    Byebug.breakpoints.last
+  end
+
   def context
     state.context
   end