byebug 0.0.1 → 1.0.0

data/test/restart_test.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-describe "Restart Command" do
+describe "Restart Command (test setup)" do
   include TestDsl
 
   def must_restart
@@ -8,47 +8,50 @@ describe "Restart Command" do
     Byebug::RestartCommand.any_instance.expects(:exec)
   end
 
-  describe "Restart Command 2" do
+  describe "Restart Command" do
+
+    before do
+      @old_consts = {}
+      @old_hashes = {}
+      set_tmp_const(Byebug,
+        "INITIAL_DIR", Pathname.new(__FILE__ + "/../..").realpath.to_s)
+      set_tmp_const(Byebug,
+        "PROG_SCRIPT", Pathname.new(fullpath('restart')).
+                       relative_path_from(Pathname.new(Byebug::INITIAL_DIR)).
+                       cleanpath.to_s)
+      set_tmp_const(Byebug, "RDEBUG_SCRIPT", 'rdebug_script')
+      set_tmp_hash(Byebug::Command.settings, :argv, ['argv'])
+      Byebug::RestartCommand.any_instance.stubs(:exec).
+                                       with("#{Byebug::RDEBUG_SCRIPT} argv")
+    end
 
-    temporary_set_const(Byebug, "INITIAL_DIR",
-                                Pathname.new(__FILE__ + "/../..").realpath.to_s)
-    temporary_set_const(Byebug, "PROG_SCRIPT",
-                                Pathname.new(fullpath('restart')).realpath.to_s)
-    temporary_set_const(Byebug, "RDEBUG_SCRIPT", 'rdebug_script')
-    temporary_change_hash_value(Byebug::Command.settings, :argv, 'argv')
-    Byebug::RestartCommand.any_instance.stubs(:exec).
-                                           with("#{Byebug::RDEBUG_SCRIPT} argv")
+    after do
+      restore_tmp_const(Byebug, "INITIAL_DIR")
+      restore_tmp_const(Byebug, "PROG_SCRIPT")
+      restore_tmp_const(Byebug, "RDEBUG_SCRIPT")
+      restore_tmp_hash(Byebug::Command.settings, :argv)
+    end
 
     it "must be restarted with arguments" do
       Byebug::RestartCommand.any_instance.expects(:exec).
-                 with("#{Byebug::RDEBUG_SCRIPT} test/examples/restart.rb 1 2 3")
+             with("#{Byebug::RDEBUG_SCRIPT} test/examples/restart.rb 1 2 3")
       enter 'restart 1 2 3'
       debug_file('restart')
     end
 
     it "must be restarted without arguments" do
-      temporary_set_const(Byebug, "RDEBUG_SCRIPT", 'rdebug_script') do
-        temporary_set_const(Byebug, "PROG_SCRIPT",
-              Pathname.new(fullpath('restart')).
-                       relative_path_from(Pathname.new(__FILE__ + "/../..")).
-                       cleanpath.to_s) do
-          temporary_change_hash_value(Byebug::Command.settings, :argv, ['argv']) do
-            Byebug::RestartCommand.
-              any_instance.expects(:exec).with("#{Byebug::RDEBUG_SCRIPT} argv")
-            enter 'restart'
-            debug_file('restart')
-          end
-        end
-      end
+      Byebug::RestartCommand.
+        any_instance.expects(:exec).with("#{Byebug::RDEBUG_SCRIPT} argv")
+      enter 'restart'
+      debug_file('restart')
     end
 
     it "must specify arguments by 'set' command" do
       temporary_change_hash_value(Byebug::Command.settings, :argv, []) do
-        temporary_set_const(Byebug, "RDEBUG_SCRIPT", 'rdebug_script') do
-          Byebug::RestartCommand.any_instance.expects(:exec).with("#{Byebug::RDEBUG_SCRIPT}  1 2 3")
-          enter 'set args 1 2 3', 'restart'
-          debug_file('restart')
-        end
+        Byebug::RestartCommand.any_instance.expects(:exec).
+                                      with("#{Byebug::RDEBUG_SCRIPT} 1 2 3")
+        enter 'set args 1 2 3', 'restart'
+        debug_file('restart')
       end
     end
 
@@ -56,40 +59,27 @@ describe "Restart Command" do
       before { enter 'restart' }
 
       describe "reexecing" do
-
-        it "must restart" do
+        it "must restart and show a message about reexecing" do
           must_restart
           debug_file('restart')
-        end
-
-        it "must show a message about reexecing" do
-          temporary_set_const(Byebug, "PROG_SCRIPT",
-              Pathname.new(fullpath('restart')).
-                           relative_path_from(Pathname.new(__FILE__ + "/../..")).
-                           cleanpath.to_s) do
-            temporary_change_hash_value(Byebug::Command.settings, :argv,
-                                       [Byebug::PROG_SCRIPT]) do
-              temporary_set_const(Byebug, "RDEBUG_SCRIPT",
-                Pathname.new(__FILE__ + "/../../bin/byebug").realpath.to_s) do
-                debug_file('restart')
-                check_output_includes "Re exec'ing:\n\t#{Byebug::RDEBUG_SCRIPT}"
-              end
-            end
-          end
+          check_output_includes "Re exec'ing:\n\t#{Byebug::RDEBUG_SCRIPT}" \
+                                " argv"
         end
       end
 
       describe "no script is specified and don't use $0" do
         before do
-          force_set_const(Byebug, "DEFAULT_START_SETTINGS", init: false, post_mortem: false, tracing: nil)
+          set_tmp_const(Byebug, "PROG_SCRIPT", :__undefined__)
+          set_tmp_const(Byebug, "DEFAULT_START_SETTINGS",
+                              init: false, post_mortem: false, tracing: nil)
         end
-
-        it "must not restart" do
-          must_restart.never
-          debug_file('restart')
+        after do
+          restore_tmp_const(Byebug, "PROG_SCRIPT")
+          restore_tmp_const(Byebug, "DEFAULT_START_SETTINGS")
         end
 
-        it "must show an error message" do
+        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
         end
@@ -119,6 +109,9 @@ describe "Restart Command" do
 
       describe "byebug runner script is not specified" do
 
+        before { set_tmp_const(Byebug, "RDEBUG_SCRIPT", :__undefined__) }
+        after  { restore_tmp_const(Byebug, "RDEBUG_SCRIPT") }
+
         it "must restart anyway" do
           must_restart
           debug_file('restart')
@@ -131,8 +124,8 @@ describe "Restart Command" do
 
         it "must show a warning message when prog script is not executable" do
           debug_file('restart')
-          check_output_includes "Ruby program #{Byebug::PROG_SCRIPT} doesn't seem to be executable..."
-          check_output_includes "We'll add a call to Ruby."
+          check_output_includes "Ruby program #{Byebug::PROG_SCRIPT} not " \
+                                "executable... We'll add a call to Ruby."
         end
       end
 
@@ -154,9 +147,9 @@ describe "Restart Command" do
     describe "Post Mortem" do
       it "must work in post-mortem mode" do
         skip("No post morten mode for now")
-        #must_restart
-        #enter 'cont', 'restart'
-        #debug_file 'post_mortem'
+        must_restart
+        enter 'cont', 'restart'
+        debug_file 'post_mortem'
       end
     end
 

data/test/save_test.rb

@@ -2,14 +2,14 @@ require_relative 'test_helper'
 
 describe "Save Command" do
   include TestDsl
-  let(:file_name) { 'save_output.txt' }
 
   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',
-        'set autoeval', 'set autolist',
-        "save #{file_name}"
+      enter 'break 2', 'break 3 if true', 'catch NoMethodError',
+            'display 2 + 3', 'display 5 + 6', 'set autoeval', 'set autolist',
+            "save #{file_name}"
       debug_file 'save'
     end
     after do
@@ -79,13 +79,14 @@ describe "Save Command" do
   end
 
   describe "Post Mortem" do
+    let(:file_name) { 'save_output.txt' }
     #let(:file_contents) { File.read(file_name) }
     #after { FileUtils.rm(file_name) }
     it "must work in post-mortem mode" do
       skip("No post morten mode for now")
-      #enter 'cont', "save #{file_name}"
-      #debug_file 'post_mortem'
-      #file_contents.must_include "set autoirb off"
+      enter 'cont', "save #{file_name}"
+      debug_file 'post_mortem'
+      file_contents.must_include "set autoirb off"
     end
   end
 

data/test/set_test.rb

@@ -64,13 +64,10 @@ describe "Set Command" do
   end
 
   describe "byebugtesting" do
-    temporary_change_hash_value(Byebug::Command.settings, :byebugtesting, false)
-    before { $rdebug_state = nil }
-    after { $rdebug_state = nil }
-
-    it "must set $rdebug_context if byebugsetting is on" do
+    it "must set $byebug_state if byebugsetting is on" do
       enter 'set byebugtesting', 'break 3', 'cont'
-      debug_file('set') { state.must_be_kind_of Byebug::CommandProcessor::State }
+      debug_file('set') {
+        state.must_be_kind_of Byebug::CommandProcessor::State }
     end
 
     it "must set basename on too" do
@@ -81,9 +78,9 @@ describe "Set Command" do
       end
     end
 
-    it "must not set $rdebug_context if byebugsetting is off" do
+    it "must not set $byebug_state if byebugsetting is off" do
       enter 'set nobyebugtesting', 'break 3', 'cont'
-      debug_file('set') { state.must_be_nil }
+      debug_file('set') { $byebug_state.must_be_nil }
     end
   end
 
@@ -168,9 +165,9 @@ describe "Set Command" do
     temporary_change_hash_value(Byebug::Command.settings, :autolist, 0)
     it "must work in post-mortem mode" do
       skip("No post morten mode for now")
-      #enter 'cont', "set autolist on"
-      #debug_file 'post_mortem'
-      #check_output_includes "autolist is on."
+      enter 'cont', "set autolist on"
+      debug_file 'post_mortem'
+      check_output_includes "autolist is on."
     end
   end
 

data/test/show_test.rb

@@ -106,11 +106,9 @@ describe "Show Command" do
   end
 
   it "must show linetrace" do
-    temporary_change_method_value(context, :tracing, true) do
-      enter 'show linetrace'
-      debug_file 'show'
-      check_output_includes "line tracing is on."
-    end
+    enter 'trace on', 'show linetrace'
+    debug_file 'show'
+    check_output_includes "line tracing is on."
   end
 
 

data/test/stepping_test.rb

@@ -7,51 +7,46 @@ describe "Stepping Commands" do
 
     describe "Usual mode" do
 
-      before { enter 'break 10', 'cont' }
+      before do
+        enter 'break 10', 'cont'
+      end
 
       it "must go to the next line if forced by a setting" do
-        temporary_change_hash_value(
-                           Byebug::Command.settings, :force_stepping, true) do
-          enter 'next'
-          debug_file('stepping') { state.line.must_equal 11 }
-        end
+        Byebug::Command.settings[:force_stepping] = true
+        enter 'next'
+        debug_file('stepping') { state.line.must_equal 11 }
       end
 
       it "must go to the next line if forced by a setting (by shortcut)" do
-        temporary_change_hash_value(
-                           Byebug::Command.settings, :force_stepping, true) do
-          enter 'n'
-          debug_file('stepping') { state.line.must_equal 11 }
-        end
+        Byebug::Command.settings[:force_stepping] = true
+        enter 'n'
+        debug_file('stepping') { state.line.must_equal 11 }
       end
 
       it "must leave on the same line if forced by a setting" do
-        temporary_change_hash_value(
-                          Byebug::Command.settings, :force_stepping, false) do
-          enter 'next'
-          debug_file('stepping') { state.line.must_equal 10 }
-        end
+        Byebug::Command.settings[:force_stepping] = false
+        enter 'next'
+        debug_file('stepping') { state.line.must_equal 10 }
       end
 
-      it "must go to the specified number of lines forward by default" do
-        temporary_change_hash_value(
-                           Byebug::Command.settings, :force_stepping, true) do
-          enter 'next 2'
-          debug_file('stepping') { state.line.must_equal 21 }
-        end
+      it "must go the specified number of lines forward by default" do
+        Byebug::Command.settings[:force_stepping] = true
+        enter 'next 2'
+        debug_file('stepping') { state.line.must_equal 21 }
       end
 
-      it "must go to the next line if forced to do that by 'plus' sign" do
+      it "must go to the next line if forced by 'plus' sign" do
         enter 'next+'
         debug_file('stepping') { state.line.must_equal 11 }
       end
 
-      it "must leave on the same line if forced to do that by 'minus' sign" do
+      it "must leave on the same line if forced by 'minus' sign" do
         enter 'next-'
         debug_file('stepping') { state.line.must_equal 10 }
       end
 
       it "must ignore the setting if 'minus' is specified" do
+        Byebug::Command.settings[:force_stepping] = true
         enter 'next-'
         debug_file('stepping') { state.line.must_equal 10 }
       end
@@ -61,48 +56,43 @@ describe "Stepping Commands" do
       temporary_change_hash_value(Byebug::Command.settings, :autoeval, false)
       it "must not work in post-mortem mode" do
         skip("No post morten mode for now")
-        #enter 'cont', "next"
-        #debug_file('post_mortem')
-        #check_output_includes 'Unknown command: "next".  Try "help".', interface.error_queue
+        enter 'cont', "next"
+        debug_file('post_mortem')
+        check_output_includes 'Unknown command: "next".  Try "help".', interface.error_queue
       end
     end
   end
 
-
   describe "Step Command" do
+
     describe "Usual mode" do
-      before { enter 'break 10', 'cont' }
+
+      before do
+        enter 'break 10', 'cont'
+      end
 
       it "must go to the step line if forced by a setting" do
-        temporary_change_hash_value(
-                           Byebug::Command.settings, :force_stepping, true) do
-          enter 'step'
-          debug_file('stepping') { state.line.must_equal 11 }
-        end
+        Byebug::Command.settings[:force_stepping] = true
+        enter 'step'
+        debug_file('stepping') { state.line.must_equal 11 }
       end
 
       it "must go to the next line by shortcut" do
-        temporary_change_hash_value(
-                           Byebug::Command.settings, :force_stepping, true) do
-          enter 's'
-          debug_file('stepping') { state.line.must_equal 11 }
-        end
+        Byebug::Command.settings[:force_stepping] = true
+        enter 's'
+        debug_file('stepping') { state.line.must_equal 11 }
       end
 
       it "must leave on the same line if forced by a setting" do
-        temporary_change_hash_value(
-                          Byebug::Command.settings, :force_stepping, false) do
-          enter 'step'
-          debug_file('stepping') { state.line.must_equal 10 }
-        end
+        Byebug::Command.settings[:force_stepping] = false
+        enter 'step'
+        debug_file('stepping') { state.line.must_equal 10 }
       end
 
-      it "must go to the specified number of lines forward by default" do
-        temporary_change_hash_value(
-                           Byebug::Command.settings, :force_stepping, true) do
-          enter 'step 2'
-          debug_file('stepping') { state.line.must_equal 15 }
-        end
+      it "must go the specified number of lines forward by default" do
+        Byebug::Command.settings[:force_stepping] = true
+        enter 'step 2'
+        debug_file('stepping') { state.line.must_equal 15 }
       end
 
       it "must go to the step line if forced to do that by 'plus' sign" do
@@ -120,9 +110,9 @@ describe "Stepping Commands" do
       temporary_change_hash_value(Byebug::Command.settings, :autoeval, false)
       it "must not work in post-mortem mode" do
         skip("No post morten mode for now")
-        #enter 'cont', "step"
-        #debug_file('post_mortem')
-        #check_output_includes 'Unknown command: "step".  Try "help".', interface.error_queue
+        enter 'cont', "step"
+        debug_file('post_mortem')
+        check_output_includes 'Unknown command: "step".  Try "help".', interface.error_queue
       end
     end
   end

data/test/support/context.rb

@@ -1,4 +1,5 @@
 module Byebug
+
   class Context
 
     def inspect

data/test/support/processor.rb

@@ -1,7 +1,13 @@
-class Byebug::Processor
-  class << self
-    def print(message)
-      Byebug.handler.interface.print_queue << message
+module Byebug
+
+  class Processor
+
+    class << self
+      def print(message)
+        Byebug.handler.interface.print_queue << message
+      end
     end
+
   end
+
 end

data/test/support/test_dsl.rb

@@ -12,6 +12,7 @@ module TestDsl
     base.class_eval do
       extend ClassMethods
       before do
+        Byebug::Command.settings[:byebugtesting] = true
         Byebug.interface = TestInterface.new
         Byebug.handler.display.clear
       end
@@ -21,10 +22,11 @@ module TestDsl
     end
   end
 
+  ##
   # Adds commands to the input queue, so they will be later retrieved by
-  # Processor, i.e. it emulates user's input.
+  # Processor, i.e., it emulates user's input.
   #
-  # If a command is a Proc object, it will be executed before retrieving by
+  # If a command is a Proc object, it will be executed before being retrieved by
   # Processor. May be handy when you need build a command depending on the
   # current context/state.
   #
@@ -39,13 +41,13 @@ module TestDsl
     interface.input_queue.concat(messages)
   end
 
-  # Runs a byebug with the provided basename for a file. The file should be
-  # placed in the test/examples dir.
+  ##
+  # Runs byebug with the provided basename for a file.
   #
-  # You also can specify a block, which will be executed when Processor extracts
-  # all the commands from the input queue. You can use it e.g. for making
-  # asserts for the current test. If you specified the block, and it never was
-  # executed, the test will fail.
+  # The file should be placed in the test/examples dir. 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 on the current test. If
+  # you specified the block and it never was executed, the test will fail.
   #
   # Usage:
   #   debug "ex1" # ex1 should be placed in test/examples/ex1.rb
@@ -81,18 +83,20 @@ module TestDsl
     raise exception if exception
   end
 
+  ##
+  # Checks the output of byebug.
   #
-  # Checks the output of byebug. By default it checks output queue of the current
-  # interface, but you can check again any queue by providing it as a second
-  # argument.
+  # By default it checks output queue of the current interface, but you can
+  # check again any queue by providing it as a second argument.
   #
   # Usage:
   #   enter 'break 4', 'cont'
-  #   debug("ex1")
+  #   debug 'ex1'
   #   check_output "Breakpoint 1 at #{fullpath('ex1')}:4"
   #
   def check_output(check_method, *args)
-    queue = args.last.is_a?(String) || args.last.is_a?(Regexp) ? interface.output_queue : args.pop
+    queue = args.last.is_a?(String) || args.last.is_a?(Regexp) ?
+            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)
@@ -111,17 +115,13 @@ module TestDsl
   end
 
   def state
-    $rdebug_state
+    $byebug_state
   end
 
   def context
     state.context
   end
 
-  def breakpoint
-    Byebug.breakpoints.first
-  end
-
   def force_set_const(klass, const, value)
     klass.send(:remove_const, const) if klass.const_defined?(const)
     klass.const_set(const, value)
@@ -161,6 +161,34 @@ module TestDsl
     end
   end
 
+  def set_tmp_hash(hash, key, value)
+    @old_hashes.merge!({ hash => { key => hash[key] } }) do |k, v1, v2|
+      v1.merge(v2)
+    end
+    hash[key] = value
+  end
+
+  def restore_tmp_hash(hash, key)
+    hash[key] = @old_hashes[hash][key]
+  end
+
+  def set_tmp_const(klass, const, value)
+    @old_consts.merge!({ klass =>
+      { const => klass.const_defined?(const) ?
+                 klass.const_get(const) : :__undefined__ } }) do |k, v1, v2|
+      v1.merge(v2)
+    end
+    value == :__undefined__ ? klass.send(:remove_const, const) :
+                              force_set_const(klass, const, value)
+  end
+
+  def restore_tmp_const(klass, const)
+    @old_consts[klass][const] == :__undefined ?
+                    klass.send(:remove_const, const) :
+                    force_set_const(klass, const, @old_consts[klass][const])
+  end
+
+
   module ClassMethods
 
     include Shared