byebug 2.7.0 → 3.0.0

data/lib/byebug/interface.rb

@@ -1,9 +1,9 @@
 module Byebug
   class Interface
-    attr_writer :have_readline
+    attr_accessor :command_queue, :restart_file
 
     def initialize
-      @have_readline = false
+      @command_queue, @restart_file = [], nil
     end
 
     # Common routine for reporting byebug error messages.
@@ -28,7 +28,7 @@ module Byebug
     end
   end
 
-  require_relative 'interfaces/local_interface'
-  require_relative 'interfaces/script_interface'
-  require_relative 'interfaces/remote_interface'
+  require 'byebug/interfaces/local_interface'
+  require 'byebug/interfaces/script_interface'
+  require 'byebug/interfaces/remote_interface'
 end

data/lib/byebug/interfaces/local_interface.rb

@@ -1,24 +1,12 @@
+require 'byebug/history'
+
 module Byebug
   class LocalInterface < Interface
-    attr_accessor :command_queue, :history_length, :history_save, :histfile
-    attr_accessor :restart_file
-
-    FILE_HISTORY = ".byebug_hist" unless defined?(FILE_HISTORY)
+    attr_reader :history
 
-    def initialize()
+    def initialize
       super
-      @command_queue = []
-      @have_readline = false
-      @history_save = true
-      @history_length = ENV["HISTSIZE"] ? ENV["HISTSIZE"].to_i : 256
-      @histfile = File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", FILE_HISTORY)
-      open(@histfile, 'r') do |file|
-        file.each do |line|
-          line.chomp!
-          Readline::HISTORY << line
-        end
-      end if File.exist?(@histfile)
-      @restart_file = nil
+      History.load
     end
 
     def read_command(prompt)
@@ -34,55 +22,16 @@ module Byebug
     end
 
     def close
-    end
-
-    # Things to do before quitting
-    def finalize
-      if Byebug.respond_to?(:save_history)
-        Byebug.save_history
-      end
-    end
-
-    def readline_support?
-      @have_readline
+      History.save
     end
 
     private
 
-      begin
-        require 'readline'
-        class << Byebug
-          @have_readline = true
-          define_method(:save_history) do
-            iface = self.handler.interface
-            iface.histfile ||= File.join(ENV["HOME"]||ENV["HOMEPATH"]||".",
-                                    FILE_HISTORY)
-            open(iface.histfile, 'w') do |file|
-              Readline::HISTORY.to_a.last(iface.history_length).each do |line|
-                file.puts line unless line.strip.empty?
-              end if defined?(iface.history_save) and iface.history_save
-            end rescue nil
-          end
-          public :save_history
-        end
-
-        def readline(prompt, hist)
-          Readline::readline(prompt, hist)
-        rescue Interrupt
-          print "^C\n"
-          retry
-        end
-      rescue LoadError
-        def readline(prompt, hist)
-          @histfile = ''
-          @hist_save = false
-          STDOUT.print prompt
-          STDOUT.flush
-          line = STDIN.gets
-          exit unless line
-          line.chomp!
-          line
-        end
+      def readline(prompt, hist)
+        Readline::readline(prompt, hist)
+      rescue Interrupt
+        print "^C\n"
+        retry
       end
   end
 end

data/lib/byebug/interfaces/remote_interface.rb

@@ -1,44 +1,28 @@
+require 'byebug/history'
+
 module Byebug
   class RemoteInterface < Interface
-    attr_accessor :command_queue, :history_length, :history_save, :histfile
-    attr_accessor :restart_file
+    attr_reader :history
 
     def initialize(socket)
-      @command_queue = []
+      super()
       @socket = socket
-      @history_save = false
-      @history_length = 256
-      @histfile = ''
-      # Do we read the histfile?
-      # open(@histfile, 'r') do |file|
-      #   file.each do |line|
-      #     line.chomp!
-      #     Readline::HISTORY << line
-      #   end
-      # end if File.exist?(@histfile)
-        @restart_file = nil
+      @history = History.new
     end
 
     def close
       @socket.close
-    rescue Exception
+    rescue IOError
     end
 
     def confirm(prompt)
       send_command "CONFIRM #{prompt}"
     end
 
-    def finalize
-    end
-
     def read_command(prompt)
       send_command "PROMPT #{prompt}"
     end
 
-    def readline_support?
-      false
-    end
-
     def print(*args)
       @socket.printf(escape(format(*args)))
     end

data/lib/byebug/interfaces/script_interface.rb

@@ -1,20 +1,9 @@
 module Byebug
-  class ScriptInterface < Interface
-    attr_accessor :command_queue, :history_length, :history_save, :histfile
-    attr_accessor :restart_file
-
+  class ScriptInterface < Byebug::Interface
     def initialize(file, out, verbose=false)
       super()
-      @command_queue = []
       @file = file.respond_to?(:gets) ? file : open(file)
-      @out = out
-      @verbose = verbose
-      @history_save = false
-      @history_length = 256
-      @histfile = ''
-    end
-
-    def finalize
+      @out, @verbose = out, verbose
     end
 
     def read_command(prompt)
@@ -26,10 +15,6 @@ module Byebug
       end
     end
 
-    def readline_support?
-      false
-    end
-
     def confirm(prompt)
       'y'
     end

data/lib/byebug/processor.rb

@@ -1,9 +1,6 @@
 require 'forwardable'
-require_relative 'interface'
 
 module Byebug
-
-  # Should this be a mixin?
   class Processor
     attr_accessor :interface
 
@@ -14,5 +11,8 @@ module Byebug
       @interface = interface
     end
   end
-
 end
+
+require 'byebug/command'
+require 'byebug/processors/command_processor'
+require 'byebug/processors/control_command_processor'

data/lib/byebug/{command_processor.rb → processors/command_processor.rb}

@@ -1,7 +1,3 @@
-require 'forwardable'
-require_relative 'interface'
-require_relative 'command'
-
 module Byebug
 
   class CommandProcessor < Processor
@@ -52,11 +48,11 @@ module Byebug
             return unless @interface
             __#{mname}(*args)
           end
-        rescue IOError, Errno::EPIPE
-          self.interface = nil
+        rescue IOError, SystemCallError
+          @interface.close
         rescue SignalException
           raise
-        rescue Exception
+        rescue
           print "INTERNAL ERROR!!! #\{$!\}\n" rescue nil
           print $!.backtrace.map{|l| "\t#\{l\}"}.join("\n") rescue nil
         end
@@ -118,9 +114,6 @@ module Byebug
       def always_run(context, file, line, run_level)
         cmds = Command.commands
 
-        # Remove some commands in post-mortem
-        cmds = cmds.find_all { |cmd| cmd.allow_in_post_mortem } if context.dead?
-
         state = State.new(cmds, context, @display, file, @interface, line)
 
         # Change default when in irb or code included in command line
@@ -194,8 +187,8 @@ module Byebug
       #
       def one_cmd(commands, context, input)
         if cmd = commands.find { |c| c.match(input) }
-          if context.dead? && cmd.class.need_context
-            print "Command is unavailable\n"
+          if context.dead? && !cmd.class.allow_in_post_mortem
+            errmsg "Command unavailable in post mortem mode.\n"
           else
             cmd.execute
           end
@@ -204,7 +197,7 @@ module Byebug
           if unknown_cmd
             unknown_cmd.execute
           else
-            errmsg "Unknown command: \"#{input}\".  Try \"help\".\n"
+            errmsg "Unknown command: \"#{input}\". Try \"help\".\n"
           end
         end
       end
@@ -251,5 +244,5 @@ module Byebug
       end
 
   end # class CommandProcessor
-  
+
 end

data/lib/byebug/{control_command_processor.rb → processors/control_command_processor.rb}

@@ -1,7 +1,3 @@
-require 'forwardable'
-require_relative 'interface'
-require_relative 'command'
-
 module Byebug
 
   class ControlCommandProcessor < Processor
@@ -32,8 +28,8 @@ module Byebug
           end
         end
       end
-    rescue IOError, Errno::EPIPE
-    rescue Exception
+    rescue IOError, SystemCallError
+    rescue
       print "INTERNAL ERROR!!! #{$!}\n" rescue nil
       print $!.backtrace.map{|l| "\t#{l}"}.join("\n") rescue nil
     ensure
@@ -75,5 +71,5 @@ module Byebug
       end
     end
   end
-  
+
 end

data/lib/byebug/version.rb

@@ -1,3 +1,3 @@
 module Byebug
-  VERSION = '2.7.0'
+  VERSION = '3.0.0'
 end

data/test/edit_test.rb

@@ -4,8 +4,8 @@ class TestEdit < TestDsl::TestCase
     temporary_change_hash ENV, 'EDITOR', 'editr'
 
     it 'must open current file in current line in configured editor' do
-      Byebug::Edit.any_instance.expects(:system).
-                                with("editr +2 #{fullpath('edit')}")
+      Byebug::EditCommand.any_instance.expects(:system)
+                                      .with("editr +2 #{fullpath('edit')}")
       enter 'edit'
       debug_file 'edit'
     end
@@ -15,8 +15,8 @@ class TestEdit < TestDsl::TestCase
     temporary_change_hash ENV, 'EDITOR', nil
 
     it 'must call "vim" with current line and file if EDITOR env not set' do
-      Byebug::Edit.any_instance.expects(:system).
-                                with("vim +2 #{fullpath('edit')}")
+      Byebug::EditCommand.any_instance.expects(:system)
+                                      .with("vim +2 #{fullpath('edit')}")
       enter 'edit'
       debug_file 'edit'
     end
@@ -26,8 +26,8 @@ class TestEdit < TestDsl::TestCase
     temporary_change_hash ENV, 'EDITOR', 'editr'
 
     it 'must open specified line in specified file with configured editor' do
-      Byebug::Edit.any_instance.expects(:system).
-                                with("editr +3 #{fullpath('breakpoint')}")
+      Byebug::EditCommand.any_instance.expects(:system)
+                                      .with("editr +3 #{fullpath('breakpoint')}")
       enter "edit #{fullpath('breakpoint')}:3"
       debug_file 'edit'
     end

data/test/examples/breakpoint_deep.rb

@@ -1,4 +1,4 @@
 ex = BreakpointDeepExample.new.a
 2.times do
-  ex += 1
+  ex = ex ? ex : 1
 end

data/test/finish_test.rb

@@ -18,22 +18,22 @@ end
 class TestFinish < TestDsl::TestCase
   before { enter "break #{__FILE__}:14", 'cont' }
 
-  it 'must stop at the next frame by default' do
+  it 'must stop after current frame is finished when without arguments' do
     enter 'finish'
     debug_file('finish') { state.line.must_equal 11 }
   end
 
-  it 'must stop at the #0 frame by default' do
+  it 'must stop before current frame finishes if 0 specified as argument' do
     enter 'finish 0'
-    debug_file('finish') { state.line.must_equal 11 }
+    debug_file('finish') { state.line.must_equal 15 }
   end
 
-  it 'must stop at the specified frame' do
+  it 'must stop after current frame is finished if 1 specified as argument' do
     enter 'finish 1'
-    debug_file('finish') { state.line.must_equal 7 }
+    debug_file('finish') { state.line.must_equal 11 }
   end
 
-  it 'must stop at the next frame if the current frame was changed' do
+  it 'must behave consistenly even if current frame has been changed' do
     enter 'up', 'finish'
     debug_file('finish') { state.line.must_equal 7 }
   end

data/test/help_test.rb

@@ -27,7 +27,7 @@ class TestHelp < TestDsl::TestCase
     it 'must show an error if an undefined command is specified' do
       enter 'help foobar'
       debug_file 'help'
-      check_error_includes 'Undefined command: "foobar".  Try "help".'
+      check_error_includes 'Undefined command: "foobar". Try "help".'
     end
 
     it "must show a command's help" do

data/test/info_test.rb

@@ -25,7 +25,6 @@ class InfoExample
     raise "bang"
   rescue
   end
-
 end
 
 class TestInfo < TestDsl::TestCase

data/test/kill_test.rb

@@ -11,9 +11,9 @@ class TestKill < TestDsl::TestCase
     debug_file('kill')
   end
 
-  it 'must finalize interface when sending KILL signal explicitly' do
+  it 'must close interface when sending KILL signal explicitly' do
     Process.stubs(:kill).with('KILL', Process.pid)
-    interface.expects(:finalize)
+    interface.expects(:close)
     enter 'kill KILL'
     debug_file('kill')
   end

data/test/post_mortem_test.rb

@@ -11,243 +11,59 @@ class TestPostMortem < TestDsl::TestCase
 
   describe 'Features' do
     before { enter 'set post_mortem', 'cont' }
+    after { Byebug.post_mortem = false }
 
-    it 'must enter into post-mortem mode' do
-      debug_file('post_mortem', rescue: true) do
-        Byebug.post_mortem?.must_equal true
+    it 'is rising right before exiting' do
+      assert_raises(RuntimeError) do
+        debug_file('post_mortem')
       end
     end
 
-    it 'must stop at the correct line' do
-      debug_file('post_mortem', rescue: true) { assert_equal 4, state.line }
-    end
-  end
-
-  describe 'Unavailable commands' do
-    temporary_change_hash Byebug.settings, :autoeval, false
-
-    describe 'step' do
-      it 'must not work in post-mortem mode' do
-        enter 'set post_mortem', 'cont', 'step'
-        debug_file 'post_mortem', rescue: true
-        check_error_includes 'Unknown command: "step".  Try "help".'
-      end
-    end
-
-    describe 'next' do
-      it 'must not work in post-mortem mode' do
-        enter 'set post_mortem', 'cont', 'next'
-        debug_file 'post_mortem', rescue: true
-        check_error_includes 'Unknown command: "next".  Try "help".'
-      end
-    end
-
-    describe 'finish' do
-      it 'must not work in post-mortem mode' do
-        enter 'set post_mortem', 'cont', 'finish'
-        debug_file 'post_mortem', rescue: true
-        check_error_includes 'Unknown command: "finish".  Try "help".'
-      end
-    end
-
-    describe 'break' do
-      it 'must not be able to set breakpoints in post-mortem mode' do
-        enter 'set post_mortem', 'cont', "break #{__FILE__}:6"
-        debug_file 'post_mortem', rescue: true
-        check_error_includes "Unknown command: \"break #{__FILE__}:6\".  " \
-                             'Try "help".'
+    it 'sets post_mortem to true' do
+      begin
+        debug_file('post_mortem')
+      rescue
+        Byebug.post_mortem?.must_equal true
       end
     end
 
-    describe 'condition' do
-      it 'must not be able to set conditions in post-mortem mode' do
-        enter "break #{__FILE__}:6", 'set post_mortem', 'cont',
-              ->{ "cond #{Byebug.breakpoints.last.id} true" }
-        debug_file 'post_mortem', rescue: true
-        check_error_includes \
-          "Unknown command: \"cond #{Byebug.breakpoints.last.id} true\".  " \
-          "Try \"help\"."
+    it 'stops at the correct line' do
+      begin
+        debug_file('post_mortem')
+      rescue
+        Byebug.raised_exception.__bb_line.must_equal 4
       end
     end
+  end
 
-    describe 'display' do
-      it 'must be not able to set display expressions in post-mortem mode' do
-        enter 'set post_mortem', 'cont', 'display 2 + 2'
-        debug_file 'post_mortem', rescue: true
-        check_error_includes 'Unknown command: "display 2 + 2".  Try "help".'
-      end
-    end
+  describe 'Unavailable commands' do
+    temporary_change_hash Byebug.settings, :autoeval, false
 
-    describe 'reload' do
-      it 'must work in post-mortem mode' do
-        enter 'set post_mortem', 'cont', 'reload'
-        debug_file 'post_mortem', rescue: true
-        check_error_includes 'Unknown command: "reload".  Try "help".'
+    %w(step next finish break condition display reload).each do |cmd|
+      define_method "test_#{cmd}_is_forbidden_in_post_mortem_mode" do
+        enter "#{cmd}"
+        state.context.stubs(:dead?).returns(:true)
+        begin
+          debug_file('post_mortem')
+        rescue RuntimeError
+          check_error_includes 'Command unavailable in post mortem mode.'
+        end
       end
     end
-
-
   end
 
   describe 'Available commands' do
-    describe 'restart' do
-      it 'must work in post-mortem mode' do
-        must_restart
-        enter 'cont', 'restart'
-        debug_file 'post_mortem', rescue: true
-      end
-    end
-
-    describe 'frame' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'frame'
-        debug_file('post_mortem', rescue: true) { state.line.must_equal 4 }
-        check_output_includes(/--> #0  PostMortemExample\.a\s+at #{__FILE__}:4/)
-      end
-    end
-
-    describe 'exit' do
-      it 'must work in post-mortem mode' do
-        Byebug::QuitCommand.any_instance.expects(:exit!)
-        enter 'cont', 'exit!'
-        debug_file 'post_mortem', rescue: true
-      end
-    end
-
-    describe 'edit' do
-      temporary_change_hash ENV, 'EDITOR', 'editr'
-
-      it 'must work in post-mortem mode' do
-        Byebug::Edit.any_instance.
-                     expects(:system).with("editr +2 #{fullpath('edit')}")
-        enter 'cont', "edit #{fullpath('edit')}:2", 'cont'
-        debug_file 'post_mortem', rescue: true
-      end
-    end
+    ['restart', 'frame', 'quit', 'edit', 'info', 'irb', 'source', 'help',
+     'var class', 'list', 'method', 'kill', 'eval', 'set', 'save', 'show',
+     'trace', 'thread list'].each do |cmd|
+      define_method "test_#{cmd}_is_permitted_in_post_mortem_mode" do
+        enter "#{cmd}"
+        class_name = cmd.gsub(/(^| )\w/) { |b| b[-1,1].upcase } + 'Command'
 
-    describe 'info' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'info line'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes "Line 4 of \"#{__FILE__}\""
-      end
-    end
-
-    describe 'irb' do
-      let(:irb) { stub(context: ->{}) }
-
-      it 'must work in post-mortem mode' do
-        skip "Don't know why this is failing now..."
-        irb.stubs(:eval_input).throws(:IRB_EXIT, :cont)
-        enter 'cont', 'break 11', 'irb'
-        debug_file('post_mortem', rescue: true) { state.line.must_equal 11 }
-      end
-    end
-
-    describe 'source' do
-      let(:filename) { 'source_example.txt' }
-
-      before { File.open(filename, 'w') { |f| f.puts 'frame' } }
-
-      it 'must work in post-mortem mode' do
-        enter 'cont', "so #{filename}"
-        debug_file('post_mortem', rescue: true)
-        check_output_includes(/--> #0  PostMortemExample\.a\s+at #{__FILE__}:4/)
-      end
-    end
-
-    describe 'help' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'help'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes 'Available commands:'
-      end
-    end
-
-    describe 'var' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'var local'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes 'x => nil', 'z => 4'
-      end
-    end
-
-    describe 'list' do
-      it 'must work in post-mortem mode' do
-        enter 'cont'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes "[1, 10] in #{__FILE__}"
-      end
-    end
-
-    describe 'method' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'm i self'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes(/to_s/)
-      end
-    end
-
-    describe 'kill' do
-      it 'must work in post-mortem mode' do
-        Process.expects(:kill).with('USR1', Process.pid)
-        enter 'cont', 'kill USR1'
-        debug_file 'post_mortem', rescue: true
-      end
-    end
-
-    describe 'eval' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'eval 2 + 2'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes '4'
-      end
-    end
-
-    describe 'set' do
-      temporary_change_hash Byebug.settings, :autolist, 0
-
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'set autolist on'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes 'autolist is on.'
-      end
-    end
-
-    describe 'save' do
-      let(:file_name) { 'save_output.txt' }
-      let(:file_contents) { File.read(file_name) }
-      after { File.delete(file_name) }
-
-      it 'must work in post-mortem mode' do
-        enter 'cont', "save #{file_name}"
-        debug_file 'post_mortem', rescue: true
-        file_contents.must_include 'set autoirb off'
-      end
-    end
-
-    describe 'show' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'show autolist'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes 'autolist is on.'
-      end
-    end
-
-    describe 'trace' do
-      it 'must work in post-mortem mode' do
-        enter 'cont', 'trace on'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes 'line tracing is on.'
-      end
-    end
-
-    describe 'thread' do
-      it "must work in post-mortem mode" do
-        enter 'cont', 'thread list'
-        debug_file 'post_mortem', rescue: true
-        check_output_includes(/\+ \d+ #<Thread:(\S+) run/)
+        Byebug.const_get(class_name).any_instance.stubs(:execute)
+        assert_raises(RuntimeError) { debug_file('post_mortem') }
       end
     end
   end
+
 end