byebug 3.2.0 → 3.3.0

data/lib/byebug/commands/save.rb

@@ -1,17 +1,23 @@
 module Byebug
+  #
+  # Utilities for the save command.
+  #
   module SaveFunctions
     # Create a temporary file to write in if file is nil
     def open_save
-      require "tempfile"
-      file = Tempfile.new("byebug-save")
+      require 'tempfile'
+      file = Tempfile.new('byebug-save')
       # We want close to not unlink, so redefine.
       def file.close
         @tmpfile.close if @tmpfile
       end
-      return file
+      file
     end
   end
 
+  #
+  # Save current settings to use them in another debug session.
+  #
   class SaveCommand < Command
     self.allow_in_control = true
 
@@ -28,15 +34,10 @@ module Byebug
     end
 
     def save_displays(file)
-      for d in @state.display
-        if d[0]
-          file.puts "display #{d[1]}"
-        end
-      end
+      @state.display.each { |d| file.puts "display #{d[1]}" if d[0] }
     end
 
     def save_settings(file)
-      # FIXME put routine in set
       %w(autoeval autoirb autolist basename testing).each do |setting|
         file.puts "set #{setting} #{Setting[setting.to_sym]}"
       end
@@ -47,8 +48,8 @@ module Byebug
     end
 
     def execute
-      if not @match[1]
-        file = open_save()
+      if !@match[1]
+        file = open_save
       else
         file = open(@match[1], 'w')
       end
@@ -56,10 +57,8 @@ module Byebug
       save_catchpoints(file)
       save_displays(file)
       save_settings(file)
-      print "Saved to '#{file.path}'\n"
-      if @state and @state.interface
-        @state.interface.restart_file = file.path
-      end
+      puts "Saved to '#{file.path}'"
+      @state.interface.restart_file = file.path if @state && @state.interface
       file.close
     end
 
@@ -69,12 +68,13 @@ module Byebug
       end
 
       def description
-        %{save[ FILE]
+        %(save[ FILE]
 
           Saves current byebug state to FILE as a script file. This includes
           breakpoints, catchpoints, display expressions and some settings. If
           no filename is given, we will fabricate one.
-          Use the "source" command in another debug session to restore them.}
+
+          Use the "source" command in another debug session to restore them.)
       end
     end
   end

data/lib/byebug/commands/set.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Change byebug settings.
+  #
   class SetCommand < Command
     self.allow_in_control = true
 
@@ -8,34 +11,35 @@ module Byebug
 
     def execute
       key, value = @match[:setting], @match[:value]
-      return print SetCommand.help if key.nil? && value.nil?
+      return puts(SetCommand.help) if key.nil? && value.nil?
 
       full_key = Setting.find(key)
-      return print "Unknown setting :#{key}\n" unless full_key
+      return errmsg("Unknown setting :#{key}") unless full_key
 
       if !Setting.boolean?(full_key) && value.nil?
-        return print "You must specify a value for setting :#{key}\n"
+        value, err = nil, "You must specify a value for setting :#{key}"
       elsif Setting.boolean?(full_key)
-        value = get_onoff(value, key =~ /^no/ ? false : true)
+        value, err = get_onoff(value, key =~ /^no/ ? false : true)
       elsif Setting.integer?(full_key)
-        return unless value = get_int(value, full_key, 1)
+        value, err = get_int(value, full_key, 1)
       end
+      return errmsg(err) if value.nil?
 
       Setting[full_key.to_sym] = value
 
-      return print Setting.settings[full_key.to_sym].to_s
+      puts Setting.settings[full_key.to_sym].to_s
     end
 
     def get_onoff(arg, default)
       return default if arg.nil?
+
       case arg
       when '1', 'on', 'true'
-        return true
+        true
       when '0', 'off', 'false'
-        return false
+        false
       else
-        print "Expecting 'on', 1, true, 'off', 0, false. Got: #{arg}.\n"
-        raise RuntimeError
+        [nil, "Expecting 'on', 1, true, 'off', 0, false. Got: #{arg}.\n"]
       end
     end
 
@@ -56,14 +60,11 @@ module Byebug
           Conversely, you can use "set no<setting> to disable them.
 
           You can see these environment settings with the "show" command.
-
         EOD
       end
 
-      def help(setting = nil)
-        return "set #{setting.to_sym} <value>\n\n#{setting.help}" if setting
-
-        description + Setting.format()
+      def help(subcmds = [])
+        Setting.help('set', subcmds.first)
       end
     end
   end

data/lib/byebug/commands/show.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Show byebug settings.
+  #
   class ShowCommand < Command
     self.allow_in_control = true
 
@@ -8,14 +11,12 @@ module Byebug
 
     def execute
       key = @match[:setting]
-      return print ShowCommand.help if key.nil?
+      return puts(self.class.help) if key.nil?
 
       full_key = Setting.find(key)
-      if full_key
-        print Setting.settings[full_key.to_sym].to_s
-      else
-        print "Unknown setting :#{key}\n"
-      end
+      return errmsg("Unknown setting :#{key}") unless full_key
+
+      puts Setting.settings[full_key.to_sym].to_s
     end
 
     class << self
@@ -24,7 +25,7 @@ module Byebug
       end
 
       def description
-        <<-EOD.gsub(/^        /, '')
+        <<-EOD.gsub(/^ {8}/, '')
 
           show <setting> <value>
 
@@ -34,10 +35,8 @@ module Byebug
         EOD
       end
 
-      def help(setting = nil)
-        return "show #{setting.to_sym} <value>\n\n#{setting.help}" if setting
-
-        description + Setting.format()
+      def help(subcmds = [])
+        Setting.help('show', subcmds.first)
       end
     end
   end

data/lib/byebug/commands/source.rb

@@ -1,4 +1,9 @@
 module Byebug
+  #
+  # Execute a file containing byebug commands.
+  #
+  # It can be used to restore a previously saved debugging session.
+  #
   class SourceCommand < Command
     self.allow_in_control = true
 
@@ -7,13 +12,12 @@ module Byebug
     end
 
     def execute
-      return print SourceCommand.help(nil) if
-        SourceCommand.names.include?(@match[0])
+      return puts(self.class.help) if self.class.names.include?(@match[0])
 
       file = File.expand_path(@match[1]).strip
-      return errmsg "File \"#{file}\" not found\n" unless File.exist?(file)
+      return errmsg("File \"#{file}\" not found") unless File.exist?(file)
 
-      if @state and @state.interface
+      if @state && @state.interface
         @state.interface.command_queue += File.open(file).readlines
       else
         Byebug.run_script(file, @state)
@@ -26,7 +30,9 @@ module Byebug
       end
 
       def description
-        %{source FILE\texecutes a file containing byebug commands}
+        %(source <file>
+
+          Executes file <file> containing byebug commands.)
       end
     end
   end

data/lib/byebug/commands/stepping.rb

@@ -3,19 +3,24 @@ module Byebug
   # Mixin to assist command parsing
   #
   module SteppingFunctions
-    def parse_stepping_args(command_name, match)
-      if match[1].nil?
-        force = Setting[:forcestep]
-      elsif match[1] == '+'
-        force = true
-      elsif match[1] == '-'
-        force = false
+    def parse_force(str)
+      return Setting[:forcestep] unless str
+
+      case str
+      when '+' then
+        true
+      when '-' then
+        false
       end
-      steps = get_int(match[2], command_name, 1)
-      return [steps, force]
     end
   end
 
+  #
+  # Implements the next functionality.
+  #
+  # Allows the user the continue execution until the next instruction in the
+  # current frame.
+  #
   class NextCommand < Command
     self.allow_in_post_mortem = false
 
@@ -24,9 +29,10 @@ module Byebug
     end
 
     def execute
-      steps, force = parse_stepping_args("Next", @match)
-      return unless steps
-      @state.context.step_over steps, @state.frame_pos, force
+      steps, err = parse_steps(@match[2], 'Next')
+      return errmsg(err) unless steps
+
+      @state.context.step_over(steps, @state.frame_pos, parse_force(@match[1]))
       @state.proceed
     end
 
@@ -36,14 +42,21 @@ module Byebug
       end
 
       def description
-        %{n[ext][+-]?[ nnn]\tstep over once or nnn times,
-          \t\t'+' forces to move to another line.
-          \t\t'-' is the opposite of '+' and disables the :forcestep setting.
-         }
+        %(n[ext][+-]?[ nnn]
+
+        Steps over once or nnn times.
+          '+' forces to move to another line.
+          '-' is the opposite of '+' and disables the :forcestep setting.)
       end
     end
   end
 
+  #
+  # Implements the step functionality.
+  #
+  # Allows the user the continue execution until the next instruction, possibily
+  # in a different frame. Use step to step into method calls or blocks.
+  #
   class StepCommand < Command
     self.allow_in_post_mortem = false
 
@@ -52,9 +65,10 @@ module Byebug
     end
 
     def execute
-      steps, force = parse_stepping_args("Step", @match)
-      return unless steps
-      @state.context.step_into steps, force
+      steps, err = parse_steps(@match[2], 'Steps')
+      return errmsg(err) unless steps
+
+      @state.context.step_into(steps, parse_force(@match[1]))
       @state.proceed
     end
 
@@ -64,11 +78,11 @@ module Byebug
       end
 
       def description
-        %{
-          s[tep][+-]?[ nnn]\tstep (into methods) once or nnn times
-          \t\t'+' forces to move to another line.
-          \t\t'-' is the opposite of '+' and disables the :forcestep setting.
-         }
+        %{s[tep][+-]?[ nnn]
+
+          Steps (into methods) once or nnn times.
+            '+' forces to move to another line.
+            '-' is the opposite of '+' and disables the :forcestep setting.}
       end
     end
   end

data/lib/byebug/commands/threads.rb

@@ -1,17 +1,22 @@
 module Byebug
+  #
+  # Utilities to assist commands related to threads.
+  #
   module ThreadFunctions
     def display_context(context, should_show_top_frame = true)
       args = thread_arguments(context, should_show_top_frame)
-      print "%s%s%d %s\t%s\n", args[:status_flag], args[:debug_flag], args[:id],
-                               args[:thread], args[:file_line]
+      interp = format("%s%s%d %s\t%s",
+                      args[:status_flag], args[:debug_flag], args[:id],
+                      args[:thread], args[:file_line])
+      puts interp
     end
 
     def thread_arguments(context, should_show_top_frame = true)
       status_flag = if context.suspended?
-        "$"
-      else
-        context.thread == Thread.current ? '+' : ' '
-      end
+                      '$'
+                    else
+                      context.thread == Thread.current ? '+' : ' '
+                    end
       debug_flag = context.ignored? ? '!' : ' '
       if should_show_top_frame
         if context.thread == Thread.current && !context.dead?
@@ -36,19 +41,18 @@ module Byebug
     end
 
     def parse_thread_num(subcmd, arg)
-      if '' == arg
-        errmsg "\"#{subcmd}\" needs a thread number"
-        nil
-      else
-        thread_num = get_int(arg, subcmd, 1)
-        return nil unless thread_num
-        get_context(thread_num)
-      end
+      return errmsg("\"#{subcmd}\" needs a thread number") if '' == arg
+
+      thread_num, err = get_int(arg, subcmd, 1)
+      return errmsg(err) unless thread_num
+
+      Byebug.contexts.find { |c| c.thnum == thnum }
     end
 
     def parse_thread_num_for_cmd(subcmd, arg)
       c = parse_thread_num(subcmd, arg)
-      return nil unless c
+      return unless c
+
       case
       when nil == c
         errmsg 'No such thread'
@@ -57,13 +61,14 @@ module Byebug
       when c.ignored?
         errmsg "Can't #{subcmd} thread #{arg}"
       else
-        return c
+        c
       end
-      return nil
     end
-
   end
 
+  #
+  # List current threads.
+  #
   class ThreadListCommand < Command
     self.allow_in_control = true
 
@@ -82,13 +87,14 @@ module Byebug
       end
 
       def description
-        %{
-          th[read] l[ist]\t\t\tlist all threads
-        }
+        %(th[read] l[ist]        Lists all threads.)
       end
     end
   end
 
+  #
+  # Show current thread.
+  #
   class ThreadCurrentCommand < Command
     def regexp
       /^\s* th(?:read)? \s+ (?:cur(?:rent)?)? \s*$/x
@@ -104,11 +110,14 @@ module Byebug
       end
 
       def description
-        %{th[read] [cur[rent]]\t\tshow current thread}
+        %(th[read] [cur[rent]]        Shows current thread.)
       end
     end
   end
 
+  #
+  # Stop execution of a thread.
+  #
   class ThreadStopCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
@@ -120,6 +129,7 @@ module Byebug
     def execute
       c = parse_thread_num_for_cmd('thread stop', @match[1])
       return unless c
+
       c.suspend
       display_context(c)
     end
@@ -130,11 +140,14 @@ module Byebug
       end
 
       def description
-        %{th[read] stop <nnn>\t\tstop thread nnn}
+        %(th[read] stop <n>        Stops thread <n>.)
       end
     end
   end
 
+  #
+  # Resume execution of a thread.
+  #
   class ThreadResumeCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
@@ -146,10 +159,7 @@ module Byebug
     def execute
       c = parse_thread_num_for_cmd('thread resume', @match[1])
       return unless c
-      if !c.suspended?
-        errmsg 'Already running'
-        return
-      end
+      return errmsg('Already running') unless c.suspended?
       c.resume
       display_context(c)
     end
@@ -160,11 +170,14 @@ module Byebug
       end
 
       def description
-        %{th[read] resume <nnn>\t\tresume thread nnn}
+        %(th[read] resume <n>        Resumes thread <n>.)
       end
     end
   end
 
+  #
+  # Switch execution to a different thread.
+  #
   class ThreadSwitchCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
@@ -175,11 +188,12 @@ module Byebug
 
     def execute
       if @match[1] =~ /switch/
-        errmsg '"thread switch" needs a thread number'
-        return
+        return errmsg('"thread switch" needs a thread number')
       end
+
       c = parse_thread_num_for_cmd('thread switch', @match[1])
       return unless c
+
       display_context(c)
       c.step_into 1
       c.thread.run
@@ -192,7 +206,7 @@ module Byebug
       end
 
       def description
-        %{th[read] [sw[itch]] <nnn>\tswitch thread context to nnn}
+        %(th[read] [sw[itch]] <nnn>        Switches thread context to <n>.)
       end
     end
   end