byebug 3.2.0 → 3.3.0

data/lib/byebug/commands/interrupt.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Interrupting execution of current thread.
+  #
   class InterruptCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
@@ -18,7 +21,7 @@ module Byebug
       end
 
       def description
-        %{i|nterrupt\t interrupt the program}
+        %(i|nterrupt        Interrupts the program.)
       end
     end
   end

data/lib/byebug/commands/irb.rb

@@ -0,0 +1,30 @@
+require 'irb'
+
+module Byebug
+  #
+  # Enter IRB from byebug's prompt
+  #
+  class IrbCommand < Command
+    def regexp
+      /^\s* irb \s*$/x
+    end
+
+    def execute
+      unless @state.interface.is_a?(LocalInterface)
+        return errmsg('Command is available only in local mode.')
+      end
+
+      IRB.start(__FILE__)
+    end
+
+    class << self
+      def names
+        %w(irb)
+      end
+
+      def description
+        %{irb        Starts an Interactive Ruby (IRB) session.}
+      end
+    end
+  end
+end

data/lib/byebug/commands/kill.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Send custom signals to the debugged program.
+  #
   class KillCommand < Command
     self.allow_in_control = true
 
@@ -13,16 +16,12 @@ module Byebug
           errmsg("signal name #{signame} is not a signal I know about\n")
           return false
         end
-        if 'KILL' == signame
-          @state.interface.close
-        end
+        @state.interface.close if 'KILL' == signame
       else
-        if not confirm("Really kill? (y/n) ")
-          return
-        else
-          signame = 'KILL'
-        end
+        return unless confirm('Really kill? (y/n) ')
+        signame = 'KILL'
       end
+
       Process.kill(signame, Process.pid)
     end
 

data/lib/byebug/commands/list.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # List parts of the source code.
+  #
   class ListCommand < Command
     def regexp
       /^\s* l(?:ist)? (?:\s*([-=])|\s+(\S+))? \s*$/x
@@ -7,7 +10,8 @@ module Byebug
     def execute
       Byebug.source_reload if Setting[:autoreload]
 
-      unless lines = get_lines(@state.file)
+      lines = get_lines(@state.file)
+      unless lines
         errmsg "No sourcefile available for #{@state.file}\n"
         return @state.previous_line
       end
@@ -15,7 +19,7 @@ module Byebug
       b, e = set_line_range(Setting[:listsize], lines.size)
       return @state.previous_line if b < 0
 
-      print "\n[#{b}, #{e}] in #{@state.file}\n"
+      puts "\n[#{b}, #{e}] in #{@state.file}"
       @state.previous_line = display_list(b, e, lines, @state.line)
     end
 
@@ -25,84 +29,85 @@ module Byebug
       end
 
       def description
-        %{l[ist]\t\tlist forward
-          l[ist] -\tlist backward
-          l[ist] =\tlist current line
-          l[ist] nn-mm\tlist given lines
-          * NOTE - to turn on autolist, use 'set autolist'}
+        %(l[ist][[-=]][ nn-mm]
+
+          Lists lines of code forward from current line or from the place where
+          code was last listed. If "list-" is specified, lists backwards
+          instead. If "list=" is specified, lists from current line regardless
+          of where code was last listed. A line range can also be specified to
+          list specific sections of code.)
       end
     end
 
     private
 
-      ##
-      # Set line range to be printed by list
-      #
-      # @param listsize - number of lines to be printed
-      # @param maxline - max line number that can be printed
-      #
-      def set_line_range(listsize, maxline)
-        if !@match || !(@match[1] || @match[2])
-          b = @state.previous_line ?
-          @state.previous_line + listsize : @state.line - (listsize/2)
-        elsif @match[1] == '-'
-          b = if @state.previous_line
-                if  @state.previous_line > 0
-                  @state.previous_line - listsize
-                else
-                  @state.previous_line
-                end
+    ##
+    # Set line range to be printed by list
+    #
+    # @param listsize - number of lines to be printed
+    # @param maxline - max line number that can be printed
+    #
+    def set_line_range(listsize, maxline)
+      if !@match || !(@match[1] || @match[2])
+        b = if @state.previous_line
+              @state.previous_line + listsize
+            else
+              @state.line - (listsize / 2)
+            end
+      elsif @match[1] == '-'
+        b = if @state.previous_line
+              if  @state.previous_line > 0
+                @state.previous_line - listsize
               else
-                @state.line - (listsize/2)
+                @state.previous_line
               end
-        elsif @match[1] == '='
-          @state.previous_line = nil
-          b = @state.line - (listsize/2)
+            else
+              @state.line - (listsize / 2)
+            end
+      elsif @match[1] == '='
+        @state.previous_line = nil
+        b = @state.line - (listsize / 2)
+      else
+        b, e = @match[2].split(/[-,]/)
+        if e
+          b = b.to_i
+          e = e.to_i
         else
-          b, e = @match[2].split(/[-,]/)
-          if e
-            b = b.to_i
-            e = e.to_i
-          else
-            b = b.to_i - (listsize/2)
-          end
-        end
-
-        if b > maxline
-          errmsg "Invalid line range"
-          return [ -1, -1 ]
+          b = b.to_i - (listsize / 2)
         end
+      end
 
-        b = [1, b].max
-        e ||=  b + listsize - 1
+      if b > maxline
+        errmsg 'Invalid line range'
+        return [-1, -1]
+      end
 
-        if e > maxline
-          e = maxline
-          b = e - listsize + 1
-          b = [1, b].max
-        end
+      b = [1, b].max
+      e ||=  b + listsize - 1
 
-        return [ b, e ]
+      if e > maxline
+        e = maxline
+        b = e - listsize + 1
+        b = [1, b].max
       end
 
-      ##
-      # Show file lines in LINES from line B to line E where CURRENT is the
-      # current line number. If we can show from B to E then we return B,
-      # otherwise we return the previous line @state.previous_line.
-      #
-      def display_list(b, e, lines, current)
-        width = e.to_s.size
-        b.upto(e) do |n|
-          if n > 0 && lines[n-1]
-            if n == current
-              print "=> %#{width}d: %s\n", n, lines[n-1].chomp
-            else
-              print "   %#{width}d: %s\n", n, lines[n-1].chomp
-            end
-          end
-        end
-        print "\n"
-        return e == lines.size ? @state.previous_line : b
+      [b, e]
+    end
+
+    ##
+    # Show file lines in LINES from line B to line E where CURRENT is the
+    # current line number. If we can show from B to E then we return B,
+    # otherwise we return the previous line @state.previous_line.
+    #
+    def display_list(b, e, lines, current)
+      width = e.to_s.size
+      b.upto(e) do |n|
+        next unless n > 0 && lines[n - 1]
+        line = n == current ? '=>' : '  '
+        line += format(" %#{width}d: %s", n, lines[n - 1].chomp)
+        puts(line)
       end
+      e == lines.size ? @state.previous_line : b
+    end
   end
 end

data/lib/byebug/commands/method.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Show methods of specific classes/modules/objects.
+  #
   class MethodCommand < Command
     include Columnize
 
@@ -9,11 +12,11 @@ module Byebug
     def execute
       obj = bb_eval(@match.post_match)
       if @match[1]
-        print "#{columnize(obj.methods.sort(), Setting[:width])}\n"
-      elsif !obj.kind_of?(Module)
-        print "Should be Class/Module: #{@match.post_match}\n"
+        puts "#{columnize(obj.methods.sort, Setting[:width])}"
+      elsif !obj.is_a?(Module)
+        puts "Should be Class/Module: #{@match.post_match}"
       else
-        print "#{columnize(obj.instance_methods(false).sort(), Setting[:width])}\n"
+        puts "#{columnize(obj.instance_methods(false).sort, Setting[:width])}"
       end
     end
 
@@ -23,8 +26,13 @@ module Byebug
       end
 
       def description
-        %{m[ethod] i[nstance] <obj>\tshow methods of object
-          m[ethod] <class|module>\t\tshow instance methods of class or module}
+        %{m[ethod] (i[nstance][ <obj>]|<class|module>)
+
+          When invoked with "instance", shows instance methods of the object
+          specified as argument or of self no object was specified.
+
+          When invoked only with a class or module, shows class methods of the
+          class or module specified as argument.}
       end
     end
   end

data/lib/byebug/commands/pry.rb

@@ -0,0 +1,35 @@
+begin
+  require 'pry'
+  has_pry = true
+rescue LoadError
+  has_pry = false
+end
+
+module Byebug
+  #
+  # Enter Pry from byebug's prompt
+  #
+  class PryCommand < Command
+    def regexp
+      /^\s* pry \s*$/x
+    end
+
+    def execute
+      unless @state.interface.is_a?(LocalInterface)
+        return errmsg('Command is available only in local mode.')
+      end
+
+      get_binding.pry
+    end
+
+    class << self
+      def names
+        %w(pry)
+      end
+
+      def description
+        %(pry        Starts a Pry session.)
+      end
+    end
+  end
+end if has_pry

data/lib/byebug/commands/quit.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Exit from byebug.
+  #
   class QuitCommand < Command
     self.allow_in_control = true
 
@@ -7,10 +10,10 @@ module Byebug
     end
 
     def execute
-      if @match[1] or confirm("Really quit? (y/n) ")
-        @state.interface.close
-        exit! # exit -> exit!: No graceful way to stop...
-      end
+      return unless @match[1] || confirm('Really quit? (y/n) ')
+
+      @state.interface.close
+      exit! # exit -> exit!: No graceful way to stop...
     end
 
     class << self
@@ -19,11 +22,11 @@ module Byebug
       end
 
       def description
-        %{q[uit]|exit [!|unconditionally]\tExits from byebug.
+        %(q[uit]|exit [!|unconditionally]        Exits from byebug.
 
           Normally we prompt before exiting. However if the parameter
           "unconditionally" is given or command is suffixed with !, we exit
-          without asking further questions.}
+          without asking further questions.)
       end
     end
   end

data/lib/byebug/commands/reload.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Reload source code to pick up latest changes.
+  #
   class ReloadCommand < Command
     self.allow_in_control = true
     self.allow_in_post_mortem = false
@@ -10,7 +13,7 @@ module Byebug
     def execute
       Byebug.source_reload
       onoff = Setting[:autoreload] ? 'on' : 'off'
-      print "Source code was reloaded. Automatic reloading is #{onoff}\n"
+      puts "Source code was reloaded. Automatic reloading is #{onoff}"
     end
 
     class << self
@@ -19,7 +22,7 @@ module Byebug
       end
 
       def description
-        %{r[eload]\tforces source code reloading}
+        %(r[eload]      Forces source code reloading.)
       end
     end
   end

data/lib/byebug/commands/restart.rb

@@ -1,4 +1,7 @@
 module Byebug
+  #
+  # Restart debugged program from within byebug.
+  #
   class RestartCommand < Command
     self.allow_in_control = true
 
@@ -10,21 +13,22 @@ module Byebug
       prog = PROG_SCRIPT if defined?(PROG_SCRIPT)
       byebug_script = BYEBUG_SCRIPT if defined?(BYEBUG_SCRIPT)
 
-      return errmsg "Don't know name of debugged program\n" unless prog
+      return errmsg("Don't know name of debugged program") unless prog
 
       unless File.exist?(File.expand_path(prog))
-        return errmsg "Ruby program #{prog} doesn't exist\n"
+        return errmsg("Ruby program #{prog} doesn't exist")
       end
 
       if byebug_script
         cmd = "#{byebug_script} #{prog}"
       else
-        print "Byebug was not called from the outset...\n"
+        puts 'Byebug was not called from the outset...'
         if File.executable?(prog)
           cmd = prog
         else
-          print "Ruby program #{prog} not executable... We'll wrap it in a ruby call\n"
-          cmd = "ruby -rbyebug -I#{$:.join(' -I')} #{prog}"
+          puts "Ruby program #{prog} not executable... " \
+               "We'll wrap it in a ruby call"
+          cmd = "ruby -rbyebug -I#{$LOAD_PATH.join(' -I')} #{prog}"
         end
       end
 
@@ -36,10 +40,10 @@ module Byebug
       end
 
       # An execv would be preferable to the "exec" below.
-      print "Re exec'ing:\n\t#{cmd}\n"
+      puts "Re exec'ing:\n\t#{cmd}"
       exec cmd
     rescue Errno::EOPNOTSUPP
-      print "Restart command is not available at this time.\n"
+      puts 'Restart command is not available at this time.'
     end
 
     class << self
@@ -48,10 +52,10 @@ module Byebug
       end
 
       def description
-        %{restart|R [args]
+        %(restart|R [args]
 
           Restart the program. This is a re-exec - all byebug state
-          is lost. If command arguments are passed those are used.}
+          is lost. If command arguments are passed those are used.)
       end
     end
   end