byebug 1.3.0 → 1.3.1

data/lib/byebug.rb

@@ -247,7 +247,6 @@ class Module
 end
 
 module Kernel
-
   ##
   # Enters byebug after _steps_ line events occur.
   #
@@ -267,13 +266,30 @@ module Kernel
     end
   end
   alias breakpoint byebug unless respond_to?(:breakpoint)
+end
 
-  ##
-  # Returns a binding of n-th call frame
-  #
-  def binding_n(n = 0)
-    Byebug.skip do
-      Byebug.context.frame_binding(n+1)
+module Rails
+  module Rack
+    class Debugger
+      def initialize(app)
+        @app = app
+
+        # clear ARGV so that rails server options aren't passed to IRB
+        ARGV.clear
+
+        require 'byebug'
+
+        ::Byebug.start
+        puts "=> Byebug enabled"
+      rescue LoadError
+        puts "You're missing the 'byebug' gem. Add it to your Gemfile, bundle " \
+             "it and try again."
+        exit(1)
+      end
+
+      def call(env)
+        @app.call(env)
+      end
     end
   end
 end

data/lib/byebug/command.rb

@@ -30,24 +30,6 @@ module Byebug
       end
       return nil
     end
-
-    ##
-    # Build formatted list of subcmds
-    #
-    def format_subcmds(subcmds)
-      cmd_name = self.class.names.join("|")
-      s = "\n"                                     \
-          "--\n"                                   \
-          "List of \"#{cmd_name}\" subcommands:\n" \
-          "--\n"
-      width = subcmds.map(&:name).max_by(&:size).size
-      for subcmd in subcmds do
-        s += sprintf \
-          "%s %-#{width}s -- %s\n", cmd_name, subcmd.name, subcmd.short_help
-      end
-      return s
-    end
-
   end
 
   # Root dir for byebug
@@ -74,7 +56,37 @@ module Byebug
         output = description.split("\n").map{|l| l.gsub(/^ +/, '')}
         output.shift if output.first && output.first.empty?
         output.pop if output.last && output.last.empty?
-        output.join("\n") + "\n"
+        output = output.join("\n") + "\n"
+
+        if defined? self::Subcommands
+          return output += format_subcmds unless args and args[1]
+          output += format_subcmd(args[1])
+        end
+
+        return output
+      end
+
+      def format_subcmd(subcmd_name)
+        subcmd = find(self::Subcommands, subcmd_name)
+        return "Invalid \"#{names.join("|")}\" " \
+               "subcommand \"#{args[1]}\"." unless subcmd
+
+        return "#{subcmd.short_help}.\n" \
+               "#{subcmd.long_help || '' }"
+      end
+
+      def format_subcmds
+        cmd_name = names.join("|")
+        s = "\n"                                     \
+            "--\n"                                   \
+            "List of \"#{cmd_name}\" subcommands:\n" \
+            "--\n"
+        width = self::Subcommands.map(&:name).max_by(&:size).size
+        for subcmd in self::Subcommands do
+          s += sprintf \
+            "%s %-#{width}s -- %s\n", cmd_name, subcmd.name, subcmd.short_help
+        end
+        return s
       end
 
       def inherited(klass)
@@ -185,9 +197,9 @@ module Byebug
         rescue StandardError, ScriptError => e
           if Command.settings[:stack_trace_on_error]
             at = eval("caller(1)", b)
-            print "%s:%s\n", at.shift, e.to_s.sub(/\(eval\):1:(in `.*?':)?/, '')
+            print "#{at.shift}:#{e.to_s.sub(/\(eval\):1:(in `.*?':)?/, '')}"
             for i in at
-              print "\tfrom %s\n", i
+              print "\tfrom #{i}\n"
             end
           else
             print "#{e.class} Exception: #{e.message}\n"
@@ -212,9 +224,8 @@ module Byebug
         end
       end
 
-      def get_binding
-        @state.context ? @state.context.frame_binding(@state.frame_pos) :
-          TOPLEVEL_BINDING
+      def get_binding pos = @state.frame_pos
+        @state.context ? @state.context.frame_binding(pos) : TOPLEVEL_BINDING
       end
   end
 

data/lib/byebug/commands/breakpoints.rb

@@ -1,7 +1,7 @@
 module Byebug
 
   # Implements byebug "break" command.
-  class AddBreakpoint < Command
+  class BreakCommand < Command
     self.allow_in_control = true
 
     def regexp
@@ -14,8 +14,7 @@ module Byebug
     end
 
     def execute
-      return print AddBreakpoint.help(nil) if
-        AddBreakpoint.names.include?(@match[0])
+      return print self.class.help(nil) if self.class.names.include?(@match[0])
 
       if @match[1]
         line, _, _, expr = @match.captures
@@ -61,27 +60,20 @@ module Byebug
         line = line.to_i
         if LineCache.cache(brkpt_filename, Command.settings[:autoreload])
           last_line = LineCache.size(brkpt_filename)
-          if line > last_line
-            errmsg \
-              "There are only %d lines in file %s\n",
-              last_line, brkpt_filename
-            return
-          end
-          unless LineCache.trace_line_numbers(brkpt_filename).member?(line)
-            errmsg \
-              "Line %d is not a stopping point in file %s\n",
-               line, brkpt_filename
-            return
-          end
+          return errmsg "There are only #{last_line} lines in file " \
+                        "#{brkpt_filename}\n" if line > last_line
+
+          return errmsg "Line #{line} is not a stopping point in file " \
+                        "#{brkpt_filename}\n" unless
+            LineCache.trace_line_numbers(brkpt_filename).member?(line)
         else
-          errmsg("No source file named %s\n", brkpt_filename)
+          errmsg "No source file named #{brkpt_filename}\n"
           return unless confirm("Set breakpoint anyway? (y/n) ")
         end
 
-        unless @state.context
-          errmsg "We are not in a state we can add breakpoints.\n"
-          return
-        end
+        return errmsg "We are not in a state we can add breakpoints.\n" unless
+          @state.context
+
         b = Byebug.add_breakpoint brkpt_filename, line, expr
         print "Created breakpoint #{b.id} at " \
               "#{CommandProcessor.canonic_file(brkpt_filename)}:#{line.to_s}\n"
@@ -114,7 +106,7 @@ module Byebug
   end
 
   # Implements byebug "delete" command.
-  class DeleteBreakpointCommand < Command
+  class DeleteCommand < Command
     self.allow_in_control = true
 
     def regexp
@@ -122,19 +114,16 @@ module Byebug
     end
 
     def execute
-      return errmsg "We are not in a state we can delete breakpoints.\n" unless @state.context
-      brkpts = @match[1]
-      unless brkpts
-        if confirm("Delete all breakpoints? (y or n) ")
-          Byebug.breakpoints.clear
-        end
+      return errmsg "We are not in a state we can delete breakpoints.\n" unless
+        @state.context
+
+      if not @match[1]
+        Byebug.breakpoints.clear if confirm("Delete all breakpoints? (y or n) ")
       else
-        brkpts.split(/[ \t]+/).each do |pos|
-          pos = get_int(pos, "Delete", 1)
-          return unless pos
-          unless Byebug.remove_breakpoint(pos)
-            errmsg "No breakpoint number %d\n", pos
-          end
+        @match[1].split(/[ \t]+/).each do |pos|
+          return unless pos = get_int(pos, "Delete", 1)
+          errmsg "No breakpoint number %d\n", pos unless
+            Byebug.remove_breakpoint(pos)
         end
       end
     end
@@ -148,8 +137,8 @@ module Byebug
         %{
           del[ete][ nnn...]
 
-          Without argumen, deletes all breakpoints. With integer numbers,
-          deletes specific breakpoints.
+          Without and argument, deletes all breakpoints. With integer arguments,
+          it deletes specific breakpoints.
         }
       end
     end

data/lib/byebug/commands/catchpoint.rb

@@ -11,29 +11,25 @@ module Byebug
 
     def execute
       excn = @match[1]
-      if not excn
-        # No args given.
-        info_catch
-      elsif not @match[2]
-        # One arg given.
-        if 'off' == excn
+      return info_catch unless excn
+
+      if not @match[2]
+        if 'off' == @match[1]
           Byebug.catchpoints.clear if
             confirm("Delete all catchpoints? (y or n) ")
         else
-          binding = @state.context ? get_binding : TOPLEVEL_BINDING
-          unless debug_eval("#{excn}.is_a?(Class)", binding)
-            print "Warning #{excn} is not known to be a Class\n"
-          end
-          Byebug.add_catchpoint(excn)
-          print "Catch exception %s.\n", excn
+          print "Warning #{@match[1]} is not known to be a Class\n" unless
+            debug_eval "#{@match[1]}.is_a?(Class)", get_binding
+          Byebug.add_catchpoint @match[1]
+          print "Catch exception #{@match[1]}.\n"
         end
       elsif @match[2] != 'off'
-        errmsg "Off expected. Got %s\n", @match[2]
-      elsif Byebug.catchpoints.member?(excn)
-        Byebug.catchpoints.delete(excn)
-        print "Catch for exception %s removed.\n", excn
+        errmsg "Off expected. Got #{@match[2]}\n"
+      elsif Byebug.catchpoints.member?(@match[1])
+        Byebug.catchpoints.delete @match[1]
+        print "Catch for exception #{match[1]} removed.\n"
       else
-        errmsg "Catch for exception %s not found.\n", excn
+        return errmsg "Catch for exception #{@match[1]} not found\n"
       end
     end
 

data/lib/byebug/commands/condition.rb

@@ -7,26 +7,21 @@ module Byebug
     end
 
     def execute
-      if not @match[1]
-        errmsg "\"condition\" must be followed by breakpoint number and expression\n"
-      else
-        breakpoints = Byebug.breakpoints.sort_by{|b| b.id }
-        largest = breakpoints.inject(0) do |tally, b|
-          tally = b.id if b.id > tally
-        end
-        if 0 == largest
-          print "No breakpoints have been set.\n"
-          return
-        end
-        pos = get_int(@match[1], "Condition", 1, largest)
-        return unless pos
-        breakpoints.each do |b|
-          if b.id == pos
-            b.expr = @match[2].empty? ? nil : @match[2]
-            break
-          end
-        end
+      return errmsg "\"condition\" must be followed by " \
+                    "breakpoint number and expression\n" unless @match[1]
 
+      breakpoints = Byebug.breakpoints.sort_by{|b| b.id }
+      largest = breakpoints.inject(0) do |tally, b|
+        tally = b.id if b.id > tally
+      end
+
+      return print "No breakpoints have been set.\n" if 0 == largest
+      return unless pos = get_int(@match[1], "Condition", 1, largest)
+      breakpoints.each do |b|
+        if b.id == pos
+          b.expr = @match[2].empty? ? nil : @match[2]
+          break
+        end
       end
     end
 

data/lib/byebug/commands/continue.rb

@@ -12,13 +12,11 @@ module Byebug
     def execute
       if @match[1] && !@state.context.dead?
         filename = File.expand_path(@state.file)
-        line_number = get_int(@match[1], "Continue", 0, nil, 0)
-        return unless line_number
-        unless LineCache.trace_line_numbers(filename).member?(line_number)
-          errmsg("Line %d is not a stopping point in file \"%s\".\n",
-                 line_number, filename)
-          return
-        end
+        return unless line_number = get_int(@match[1], "Continue", 0, nil, 0)
+        return errmsg "Line #{line_number} is not a stopping point in file " \
+                      "\"#{filename}\"\n" unless
+          LineCache.trace_line_numbers(filename).member?(line_number)
+
         Byebug.add_breakpoint filename, line_number
       end
       @state.proceed

data/lib/byebug/commands/display.rb

@@ -2,7 +2,7 @@ module Byebug
 
   module DisplayFunctions
     def display_expression(exp)
-      print "%s = %s\n", exp, debug_silent_eval(exp).to_s
+      print "#{exp} = #{debug_silent_eval(exp).to_s}\n"
     end
 
     def active_display_expressions?
@@ -13,7 +13,7 @@ module Byebug
       n = 1
       for d in @state.display
         if d[0]
-          print "%d: ", n
+          print "#{n}: "
           display_expression(d[1])
         end
         n += 1
@@ -29,7 +29,7 @@ module Byebug
     def execute
       exp = @match[1]
       @state.display.push [true, exp]
-      print "%d: ", @state.display.size
+      print "#{@state.display.size}: "
       display_expression(exp)
     end
 

data/lib/byebug/commands/edit.rb

@@ -8,7 +8,7 @@ module Byebug
     end
 
     def execute
-      if not @match[1] or @match[1].strip.empty?
+      if not @match[1]
         unless @state.context
           errmsg "We are not in a state that has an associated file.\n"
           return

data/lib/byebug/commands/enable.rb

@@ -64,18 +64,16 @@ module Byebug
     end
 
     def execute
-      if not @match[1]
-        errmsg "\"enable\" must be followed by \"display\", \"breakpoints\" " \
-               "or breakpoint numbers.\n"
+      return errmsg "\"enable\" must be followed by \"display\", " \
+                    "\"breakpoints\" or breakpoint numbers.\n" unless @match[1]
+
+      args = @match[1].split(/[ \t]+/)
+      param = args.shift
+      subcmd = find(Subcommands, param)
+      if subcmd
+        send("enable_#{subcmd.name}", args)
       else
-        args = @match[1].split(/[ \t]+/)
-        param = args.shift
-        subcmd = find(Subcommands, param)
-        if subcmd
-          send("enable_#{subcmd.name}", args)
-        else
-          send('enable_breakpoints', args.unshift(param))
-        end
+        send('enable_breakpoints', args.unshift(param))
       end
     end
 
@@ -87,17 +85,6 @@ module Byebug
       enable_disable_display('Enable', args)
     end
 
-    def help
-      if args[1]
-        subcmd = find(Subcommands, args[1])
-        return "Invalid \"enable\" subcommand \"#{args[1]}\"." unless subcmd
-        str = subcmd.short_help + '.'
-        str += '\n' + subcmd.long_help if subcmd.long_help
-        return str
-      end
-      EnableCommand.description + format_subcmds(Subcommands)
-    end
-
     class << self
       def names
         %w(enable)
@@ -131,18 +118,16 @@ module Byebug
     end
 
     def execute
-      if not @match[1]
-        errmsg "\"disable\" must be followed by \"display\", \"breakpoints\" " \
-               "or breakpoint numbers.\n"
+      return errmsg "\"disable\" must be followed by \"display\", " \
+                    "\"breakpoints\" or breakpoint numbers.\n" unless @match[1]
+
+      args = @match[1].split(/[ \t]+/)
+      param = args.shift
+      subcmd = find(Subcommands, param)
+      if subcmd
+        send("disable_#{subcmd.name}", args)
       else
-        args = @match[1].split(/[ \t]+/)
-        param = args.shift
-        subcmd = find(Subcommands, param)
-        if subcmd
-          send("disable_#{subcmd.name}", args)
-        else
-          send('disable_breakpoints', args.unshift(param))
-        end
+        send('disable_breakpoints', args.unshift(param))
       end
     end
 
@@ -154,18 +139,6 @@ module Byebug
       enable_disable_display('Disable', args)
     end
 
-    def help(args)
-      if args[1]
-        subcmd = find(Subcommands, args[1])
-        return "Invalid \"disable\" subcommand \"#{args[1]}\"." unless subcmd
-
-        str = subcmd.short_help + '.'
-        str += '\n' + subcmd.long_help if subcmd.long_help
-        return str
-      end
-      DisableCommand.description + format_subcmds(Subcommads)
-    end
-
     class << self
       def names
         %w(disable)