byebug 3.4.2 → 3.5.0

data/lib/byebug/helper.rb

@@ -34,9 +34,9 @@ module Byebug
 
       int = str.to_i
       if min && int < min
-        return nil, "\"#{cmd}\" argument \"#{str}\" needs to be at least #{min}"
+        return min, "\"#{cmd}\" argument \"#{str}\" needs to be at least #{min}"
       elsif max && int > max
-        return nil, "\"#{cmd}\" argument \"#{str}\" needs to be at most #{max}"
+        return max, "\"#{cmd}\" argument \"#{str}\" needs to be at most #{max}"
       end
 
       int

data/lib/byebug/history.rb

@@ -5,38 +5,98 @@ module Byebug
   # Handles byebug's history of commands.
   #
   class History
-    class << self
-      def load
-        open(Setting[:histfile], 'r') do |file|
-          file.each do |line|
-            line.chomp!
-            Readline::HISTORY << line
-          end
-        end if File.exist?(Setting[:histfile])
-      end
+    attr_accessor :size
 
-      def save
-        open(Setting[:histfile], 'w') do |file|
-          Readline::HISTORY.to_a.last(Setting[:histsize]).each do |line|
-            file.puts line unless line.strip.empty?
-          end
-        end
-      end
+    def initialize
+      self.size = 0
+    end
 
-      def to_s(size = Setting[:histsize])
-        rl_size = Readline::HISTORY.length
-        n_entries = rl_size < size ? rl_size : size
+    #
+    # Restores history from disk.
+    #
+    def restore
+      return unless File.exist?(Setting[:histfile])
 
-        first = rl_size - n_entries
-        commands = Readline::HISTORY.to_a.last(n_entries)
+      File.readlines(Setting[:histfile]).reverse.each { |l| push(l.chomp) }
+    end
 
-        s = ''
-        commands.each_with_index do |command, index|
-          s += format("%5d  %s\n", first + index + 1, command)
-        end
+    #
+    # Saves history to disk.
+    #
+    def save
+      n_cmds = Setting[:histsize] > self.size ? self.size : Setting[:histsize]
 
-        s
+      open(Setting[:histfile], 'w') do |file|
+        n_cmds.times { file.puts(pop) }
       end
+
+      clear
+    end
+
+    #
+    # Discards history.
+    #
+    def clear
+      self.size.times { pop }
+    end
+
+    #
+    # Adds a new command to Readline's history.
+    #
+    def push(cmd)
+      self.size += 1
+      Readline::HISTORY.push(cmd)
+    end
+
+    #
+    # Removes a command from Readline's history.
+    #
+    def pop
+      self.size -= 1
+      Readline::HISTORY.pop
+    end
+
+    #
+    # Prints the requested numbers of history entries.
+    #
+    def to_s(n_cmds)
+      show_size = n_cmds ? specific_max_size(n_cmds) : default_max_size
+
+      commands = Readline::HISTORY.to_a.last(show_size)
+
+      (self.size - show_size + 1..self.size).to_a.zip(commands).map do |l|
+        format("%5d  %s", l[0], l[1])
+      end.join("\n") + "\n"
+    end
+
+    #
+    # Max number of commands to be displayed when no size has been specified.
+    #
+    # Never more than Setting[:histsize].
+    #
+    def default_max_size
+      [Setting[:histsize], self.size].min
+    end
+
+    #
+    # Max number of commands to be displayed when a size has been specified.
+    #
+    # The only bound here is not showing more items than available.
+    #
+    def specific_max_size(number)
+      [self.size, number].min
+    end
+
+    #
+    # Whether a specific command should not be stored in history.
+    #
+    # For now, empty lines and consecutive duplicates.
+    #
+    def ignore?(buf)
+      return true if /^\s*$/ =~ buf
+      return false if Readline::HISTORY.length == 0
+
+      Readline::HISTORY[Readline::HISTORY.length - 1] == buf
     end
   end
 end

data/lib/byebug/interface.rb

@@ -1,3 +1,5 @@
+require 'byebug/history'
+
 #
 # Namespace for all of byebug's code
 #
@@ -8,10 +10,10 @@ module Byebug
   # Contains common functionality to all implemented interfaces.
   #
   class Interface
-    attr_accessor :command_queue, :restart_file
+    attr_accessor :command_queue, :history
 
     def initialize
-      @command_queue, @restart_file = [], nil
+      @command_queue, @history = [], History.new
     end
 
     #
@@ -21,6 +23,15 @@ module Byebug
     def errmsg(message)
       print("*** #{message}\n")
     end
+
+    protected
+
+    #
+    # Stores <cmd> in commands history.
+    #
+    def save_history(cmd)
+      @history.push(cmd) unless @history.ignore?(cmd)
+    end
   end
 
   require 'byebug/interfaces/local_interface'

data/lib/byebug/interfaces/local_interface.rb

@@ -1,17 +1,8 @@
-require 'byebug/history'
-
 module Byebug
   #
   # Interface class for standard byebug use.
   #
   class LocalInterface < Interface
-    attr_reader :history
-
-    def initialize
-      super
-      History.load
-    end
-
     def read_command(prompt)
       readline(prompt, true)
     end
@@ -25,16 +16,17 @@ module Byebug
     end
 
     def close
-      History.save
     end
 
     private
 
     def readline(prompt, hist)
-      Readline.readline(prompt, hist)
+      line = Readline.readline(prompt, false)
     rescue Interrupt
-      puts '^C'
+      puts('^C')
       retry
+    ensure
+      save_history(line) unless !hist
     end
   end
 end

data/lib/byebug/interfaces/remote_interface.rb

@@ -5,12 +5,9 @@ module Byebug
   # Interface class for remote use of byebug.
   #
   class RemoteInterface < Interface
-    attr_reader :history
-
     def initialize(socket)
       super()
       @socket = socket
-      @history = History.new
     end
 
     def close

data/lib/byebug/processors/command_processor.rb

@@ -127,10 +127,11 @@ module Byebug
       Setting[:autolist] = false if ['(irb)', '-e'].include?(file)
 
       # Bind commands to the current state.
-      commands = cmds.map { |cmd| cmd.new(state) }
-
-      commands.select { |cmd| cmd.class.always_run >= run_level }
-              .each { |cmd| cmd.execute }
+      commands = cmds.map do |cmd_class|
+        cmd = cmd_class.new(state)
+        cmd.execute if cmd.class.always_run >= run_level
+        cmd
+      end
 
       [state, commands]
     end
@@ -158,24 +159,24 @@ module Byebug
     # Handle byebug commands.
     #
     def process_commands(context, file, line)
-      state, commands = always_run(context, file, line, 1)
+      state, commands = preloop(context, file, line)
 
-      if Setting[:testing]
-        Thread.current.thread_variable_set('state', state)
-      else
-        Thread.current.thread_variable_set('state', nil)
-      end
+      repl(state, commands, context)
 
-      preloop(commands, context)
-      puts(state.location) if Setting[:autolist] == 0
+      postloop
+    end
 
+    #
+    # Main byebug's REPL
+    #
+    def repl(state, commands, context)
       until state.proceed?
         input = if @interface.command_queue.empty?
                   @interface.read_command(prompt(context))
                 else
                   @interface.command_queue.shift
                 end
-        break unless input
+        return unless input
 
         if input == ''
           next unless @last_cmd
@@ -183,6 +184,7 @@ module Byebug
         else
           @last_cmd = input
         end
+
         split_commands(input).each do |cmd|
           one_cmd(commands, context, cmd)
         end
@@ -215,24 +217,45 @@ module Byebug
     end
 
     #
-    # Tasks to do before processor loop
+    # Tasks to do before processor loop.
     #
-    def preloop(_commands, context)
+    def preloop(context, file, line)
+      state, commands = always_run(context, file, line, 1)
+
+      if Setting[:testing]
+        Thread.current.thread_variable_set('state', state)
+      else
+        Thread.current.thread_variable_set('state', nil)
+      end
+
       @context_was_dead = true if context.dead? && !@context_was_dead
-      return unless @context_was_dead
+      if @context_was_dead
+        puts 'The program finished.'
+        @context_was_dead = false
+      end
 
-      puts 'The program finished.'
-      @context_was_dead = false
+      puts(state.location) if Setting[:autolist] == 0
+
+      @interface.history.restore if Setting[:autosave]
+
+      [state, commands]
+    end
+
+    #
+    # Tasks to do after processor loop.
+    #
+    def postloop
+      Setting[:autosave] ? @interface.history.save : @interface.history.clear
     end
 
     class State
-      attr_accessor :commands, :context, :display, :file, :frame_pos
-      attr_accessor :interface, :line, :previous_line
+      attr_accessor :commands, :context, :display, :file, :frame_pos,
+                    :interface, :line, :prev_line
 
       def initialize(commands, context, display, file, interface, line)
         @commands, @context, @display = commands, context, display
-        @file, @interface, @line = file, interface, line
-        @frame_pos, @previous_line, @proceed = 0, nil, false
+        @file, @frame_pos, @interface = file, 0, interface
+        @line, @prev_line, @proceed = line, nil, false
       end
 
       extend Forwardable

data/lib/byebug/runner.rb

@@ -35,10 +35,7 @@ module Byebug
     # Used for restarts.
     #
     def debugged_program_from_argv
-      if ARGV.empty?
-        Byebug.puts 'You must specify a program to debug...'
-        abort
-      end
+      abort_with_err('You must specify a program to debug...') if ARGV.empty?
 
       prog_script_try = which(ARGV.first)
       if prog_script_try == which('ruby')
@@ -49,6 +46,11 @@ module Byebug
       prog_script_try
     end
 
+    def abort_with_err(msg)
+      Byebug.errmsg(msg)
+      abort
+    end
+
     #
     # Starts byebug to debug a program
     #
@@ -66,6 +68,7 @@ module Byebug
       end
 
       Byebug.debugged_program = debugged_program_from_argv
+      abort_with_err("The script doesn't exist") unless Byebug.debugged_program
 
       # Set up trace hook for byebug
       Byebug.start

data/lib/byebug/version.rb

@@ -1,3 +1,3 @@
 module Byebug
-  VERSION = '3.4.2'
+  VERSION = '3.5.0'
 end

data/test/commands/history_test.rb

@@ -3,43 +3,59 @@ module Byebug
     def setup
       @example = -> do
         byebug
+        a = 2
+        a = 3
       end
 
       super
+    end
 
-      @old_readline = Readline::HISTORY
-      force_set_const(Readline, 'HISTORY', %w(aaa bbb ccc ddd))
+    def test_history_displays_latest_records_from_readline_history
+      enter 'show', 'history'
+      debug_proc(@example)
+      check_output_includes("1  show\n    2  history")
     end
 
-    def teardown
-      force_set_const(Readline, 'HISTORY', @old_readline)
+    def test_history_n_displays_whole_history_if_n_is_bigger_than_history_size
+      enter 'show', 'history 3'
+      debug_proc(@example)
+
+      check_output_includes("1  show\n    2  history 3")
     end
 
-    def test_history_displays_latest_records_from_readline_history
-      enter 'set histsize 3', 'history'
+    def test_history_n_displays_lastest_n_records_from_readline_history
+      enter 'show width', 'show autolist', 'history 2'
+      debug_proc(@example)
+
+      check_output_includes("2  show autolist\n    3  history 2")
+    end
+
+    def test_history_does_not_save_empty_commands
+      enter 'show', 'show width', '', 'history 3'
       debug_proc(@example)
-      check_output_includes(/2  bbb\n    3  ccc\n    4  ddd/)
-      check_output_doesnt_include(/1  aaa/)
+
+      check_output_includes("1  show\n    2  show width\n    3  history 3")
     end
 
-    def test_history_displays_whole_history_if_max_size_is_bigger_than_readline
-      enter 'set histsize 7', 'history'
+    def test_history_does_not_save_duplicated_consecutive_commands
+      enter 'show', 'show width', 'show width', 'history 3'
       debug_proc(@example)
-      check_output_includes(/1  aaa\n    2  bbb\n    3  ccc\n    4  ddd/)
+
+      check_output_includes("1  show\n    2  show width\n    3  history 3")
     end
 
-    def test_history_n_displays_lastest_n_records_from_readline_history
-      enter 'history 2'
+    def test_cmds_from_previous_repls_are_remembered_if_autosave_enabled
+      enter 'set autosave', 'next', 'history 2'
       debug_proc(@example)
-      check_output_includes(/3  ccc\n    4  ddd/)
-      check_output_doesnt_include(/1  aaa\n    2  bbb/)
+
+      check_output_includes("2  next\n    3  history 2")
     end
 
-    def test_history_with_autosave_disabled_does_not_show_records_from_readline
-      enter 'set noautosave', 'history'
+    def test_cmds_from_previous_repls_are_not_remembered_if_autosave_disabled
+      enter 'set noautosave', 'next', 'history 2'
       debug_proc(@example)
-      check_error_includes "Not currently saving history. " \
-                           'Enable it with "set autosave"'
+
+      check_output_includes("1  history 2")
     end
   end
 end