byebug 4.0.5 → 5.0.0

data/lib/byebug/commands/help.rb

@@ -8,32 +8,32 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      /^\s* h(?:elp)? (?: \s+(\S+) (?:\s+(\S+))? )? \s*$/x
+      /^\s* h(?:elp)? (?:\s+(\S+))? (?:\s+(\S+))? \s*$/x
     end
 
     def execute
-      return puts(self.class.help) unless @match[1]
+      return puts(help) unless @match[1]
 
-      cmd = Command.commands.select { |c| c.names.include?(@match[1]) }
-      return errmsg(pr('help.errors.undefined', cmd: @match[1])) unless cmd.any?
+      cmd = Byebug.commands.find { |c| c.to_name == @match[1] }
+      return errmsg(pr('help.errors.undefined', cmd: @match[1])) unless cmd
 
-      cmd.each { |c| puts c.help(@match[2]) }
-    end
+      cmd = cmd.new(@state)
+      return puts(cmd.help) unless @match[2]
+
+      subcmd = cmd.subcommands.find(@match[2])
+      return errmsg(pr('help.errors.undefined', cmd: @match[2])) unless subcmd
 
-    class << self
-      def names
-        %w(help)
-      end
+      puts(subcmd.help)
+    end
 
-      def description
-        prettify <<-EOD
-          h[elp][ <cmd>[ <subcmd>]]
+    def description
+      <<-EOD
+        h[elp][ <cmd>[ <subcmd>]]
 
-          help                -- prints this help.
-          help <cmd>          -- prints help on command <cmd>.
-          help <cmd> <subcmd> -- prints help on <cmd>'s subcommand <subcmd>.
-        EOD
-      end
+        help                -- prints this help.
+        help <cmd>          -- prints help on command <cmd>.
+        help <cmd> <subcmd> -- prints help on <cmd>'s subcommand <subcmd>.
+      EOD
     end
   end
 end

data/lib/byebug/commands/history.rb

@@ -1,10 +1,13 @@
 require 'byebug/command'
+require 'byebug/helpers/parse'
 
 module Byebug
   #
   # Show history of byebug commands.
   #
   class HistoryCommand < Command
+    include Helpers::ParseHelper
+
     def regexp
       /^\s* hist(?:ory)? (?:\s+(?<num_cmds>.+))? \s*$/x
     end
@@ -13,23 +16,19 @@ module Byebug
       history = @state.interface.history
 
       if @match[:num_cmds]
-        size, _ = get_int(@match[:num_cmds], 'history', 1, history.size)
+        size, = get_int(@match[:num_cmds], 'history', 1, history.size)
         return errmsg(err) unless size
       end
 
       puts history.to_s(size)
     end
 
-    class << self
-      def names
-        %w(history)
-      end
+    def description
+      <<-EOD
+        hist[ory] [num_cmds]
 
-      def description
-        prettify <<-EOD
-          hist[ory] [num_cmds]        Show byebug's command history.
-        EOD
-      end
+        Show byebug's command history.
+      EOD
     end
   end
 end

data/lib/byebug/commands/info.rb

@@ -1,205 +1,32 @@
-require 'byebug/command'
+require 'byebug/subcommands'
 
-module Byebug
-  #
-  # Utilities for the info command.
-  #
-  module InfoFunctions
-    def info_catch(*_args)
-      return puts('No frame selected.') unless @state.context
-
-      if Byebug.catchpoints && !Byebug.catchpoints.empty?
-        Byebug.catchpoints.each do |exception, _hits|
-          puts("#{exception}: #{exception.is_a?(Class)}")
-        end
-      else
-        puts 'No exceptions set to be caught.'
-      end
-    end
-
-    def info_args(*args)
-      locals = @state.context.frame_locals
-      args = @state.context.frame_args
-      return if args == [[:rest]]
-
-      args.map do |_, name|
-        s = "#{name} = #{locals[name].inspect}"
-        s[Setting[:width] - 3..-1] = '...' if s.size > Setting[:width]
-        puts s
-      end
-    end
-
-    def info_breakpoint(brkpt)
-      expr = brkpt.expr.nil? ? '' : " if #{brkpt.expr}"
-      y_n = brkpt.enabled? ? 'y' : 'n'
-      interp = format('%-3d %-3s at %s:%s%s',
-                      brkpt.id, y_n, brkpt.source, brkpt.pos, expr)
-      puts interp
-      hits = brkpt.hit_count
-      return unless hits > 0
-
-      s = (hits > 1) ? 's' : ''
-      puts "\tbreakpoint already hit #{hits} time#{s}"
-    end
-
-    def info_breakpoints(*args)
-      return puts('No breakpoints.') if Byebug.breakpoints.empty?
-
-      brkpts = Byebug.breakpoints.sort_by(&:id)
-      unless args.empty?
-        indices = args.map(&:to_i)
-        brkpts = brkpts.select { |b| indices.member?(b.id) }
-        return errmsg('No breakpoints found among list given') if brkpts.empty?
-      end
-
-      puts 'Num Enb What'
-      brkpts.each { |b| info_breakpoint(b) }
-    end
-
-    def info_display(*_args)
-      return puts('There are no auto-display expressions now.') unless
-        @state.display.find { |d| d[0] }
-
-      puts 'Auto-display expressions now in effect:'
-      puts 'Num Enb Expression'
-      n = 1
-      @state.display.each do |d|
-        puts(format('%3d: %s  %s', n, d[0] ? 'y' : 'n', d[1]))
-        n += 1
-      end
-    end
-
-    include FileFunctions
-
-    def info_file_basic(file)
-      path = File.expand_path(file)
-      return unless File.exist?(path)
-
-      s = n_lines(path) == 1 ? '' : 's'
-      "#{path} (#{n_lines(path)} line#{s})"
-    end
-
-    def info_file_breakpoints(file)
-      breakpoints = Breakpoint.potential_lines(file)
-      return unless breakpoints
-
-      breakpoints.to_a.sort.columnize(line_prefix: '  ',
-                                      displaywidth: Setting[:width])
-    end
-
-    def info_file_mtime(file)
-      File.stat(file).mtime
-    end
-
-    def info_file_sha1(file)
-      require 'digest/sha1'
-      Digest::SHA1.hexdigest(file)
-    end
-
-    def info_line(*_args)
-      puts "Line #{@state.line} of \"#{@state.file}\""
-    end
-
-    def info_stop_reason(stop_reason)
-      case stop_reason
-      when :step
-        puts "It stopped after stepping, next'ing or initial start."
-      when :breakpoint
-        puts 'It stopped at a breakpoint.'
-      when :catchpoint
-        puts 'It stopped at a catchpoint.'
-      end
-    end
-
-    def info_program(*_args)
-      if @state.context.dead?
-        puts 'The program crashed.'
-        excpt = Byebug.last_exception
-        return puts("Exception: #{excpt.inspect}") if excpt
-      end
-
-      puts 'Program stopped. '
-      info_stop_reason @state.context.stop_reason
-    end
-  end
+require 'byebug/commands/info/args'
+require 'byebug/commands/info/breakpoints'
+require 'byebug/commands/info/catch'
+require 'byebug/commands/info/display'
+require 'byebug/commands/info/file'
+require 'byebug/commands/info/line'
+require 'byebug/commands/info/program'
 
+module Byebug
   #
-  # Show info about different aspects of the debugger.
+  # Shows info about different aspects of the debugger.
   #
   class InfoCommand < Command
-    include Columnize
-    include InfoFunctions
+    include Subcommands
 
     self.allow_in_control = true
 
-    Subcommands = [
-      ['args', 1, 'Argument variables of current stack frame'],
-      ['breakpoints', 1, 'Status of user-settable breakpoints',
-       'Without argument, list info about all breakpoints. With an integer ' \
-       'argument, list info on that breakpoint.'],
-      ['catch', 3, 'Exceptions that can be caught in the current stack frame'],
-      ['display', 2, 'Expressions to display when program stops'],
-      ['file', 4, 'Info about a particular file read in',
-       'File name, number of lines, possible breakpoints in the file, last ' \
-       'modification time and sha1 digest are listed.'],
-      ['line', 2, 'Line number and file name of current position in source ' \
-                  'file.'],
-      ['program', 2, 'Execution status of the program']
-    ].map do |name, min, help|
-      Subcmd.new(name, min, help)
-    end
-
-    def info_file(*args)
-      file = args[0] || @state.file
-      unless File.exist?(file)
-        return errmsg(pr('info.errors.undefined_file', file: file))
-      end
-
-      puts <<-EOC.gsub(/^ {6}/, '')
-
-        File #{info_file_basic(file)}
-
-        Breakpoint line numbers:
-        #{info_file_breakpoints(file)}
-
-        Modification time: #{info_file_mtime(file)}
-
-        Sha1 Signature: #{info_file_sha1(file)}
-
-      EOC
-    end
-
     def regexp
-      /^\s* i(?:nfo)? (?:\s+(.+))? \s*$/x
-    end
-
-    def execute
-      return puts(self.class.help) unless @match[1]
-
-      args = @match[1].split(/ +/)
-      param = args.shift
-      subcmd = Command.find(Subcommands, param)
-      return errmsg "Unknown info command #{param}\n" unless subcmd
-
-      if @state.context
-        send("info_#{subcmd.name}", *args)
-      else
-        errmsg "'info #{subcmd.name}' not available without a context.\n"
-      end
+      /^\s* i(?:nfo)? (?:\s+ (.+))? \s*$/x
     end
 
-    class << self
-      def names
-        %w(info)
-      end
-
-      def description
-        prettify <<-EOD
-          info[ subcommand]
+    def description
+      <<-EOD
+        info[ subcommand]
 
-          Generic command for showing things about the program being debugged.
-        EOD
-      end
+        Generic command for showing things about the program being debugged.
+      EOD
     end
   end
 end

data/lib/byebug/commands/info/args.rb

@@ -0,0 +1,39 @@
+module Byebug
+  #
+  # Reopens the +info+ command to define the +args+ subcommand
+  #
+  class InfoCommand < Command
+    #
+    # Information about arguments of the current method/block
+    #
+    class ArgsSubcommand < Command
+      def regexp
+        /^\s* a(?:rgs)? \s*$/x
+      end
+
+      def execute
+        locals = @state.context.frame_locals
+        args = @state.context.frame_args
+        return if args == [[:rest]]
+
+        args.map do |_, name|
+          s = "#{name} = #{locals[name].inspect}"
+          s[Setting[:width] - 3..-1] = '...' if s.size > Setting[:width]
+          puts s
+        end
+      end
+
+      def short_description
+        'Information about arguments of the current method/block'
+      end
+
+      def description
+        <<-EOD
+          inf[o] a[args]
+
+          #{short_description}
+        EOD
+      end
+    end
+  end
+end

data/lib/byebug/commands/info/breakpoints.rb

@@ -0,0 +1,59 @@
+module Byebug
+  #
+  # Reopens the +info+ command to define the +breakpoints+ subcommand
+  #
+  class InfoCommand < Command
+    #
+    # Information about current breakpoints
+    #
+    class BreakpointsSubcommand < Command
+      def regexp
+        /^\s* b(?:reakpoints)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def execute
+        return puts('No breakpoints.') if Byebug.breakpoints.empty?
+
+        breakpoints = Byebug.breakpoints.sort_by(&:id)
+
+        if @match[1]
+          indices = @match[1].split(/ +/).map(&:to_i)
+          breakpoints = breakpoints.select { |b| indices.member?(b.id) }
+          if breakpoints.empty?
+            return errmsg('No breakpoints found among list given')
+          end
+        end
+
+        puts 'Num Enb What'
+        breakpoints.each { |b| info_breakpoint(b) }
+      end
+
+      def short_description
+        'Status of user settable breakpoints.'
+      end
+
+      def description
+        <<-EOD
+          inf[o] b[reakpoints]
+
+          #{short_description}
+        EOD
+      end
+
+      private
+
+      def info_breakpoint(brkpt)
+        expr = brkpt.expr.nil? ? '' : " if #{brkpt.expr}"
+        y_n = brkpt.enabled? ? 'y' : 'n'
+        interp = format('%-3d %-3s at %s:%s%s',
+                        brkpt.id, y_n, brkpt.source, brkpt.pos, expr)
+        puts interp
+        hits = brkpt.hit_count
+        return unless hits > 0
+
+        s = (hits > 1) ? 's' : ''
+        puts "\tbreakpoint already hit #{hits} time#{s}"
+      end
+    end
+  end
+end

data/lib/byebug/commands/info/catch.rb

@@ -0,0 +1,39 @@
+module Byebug
+  #
+  # Reopens the +info+ command to define the +catch+ subcommand
+  #
+  class InfoCommand < Command
+    #
+    # Information on exceptions that can be caught by the debugger
+    #
+    class CatchSubcommand < Command
+      def regexp
+        /^\s* c(?:atch)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def execute
+        return puts('No frame selected.') unless @state.context
+
+        if Byebug.catchpoints && !Byebug.catchpoints.empty?
+          Byebug.catchpoints.each do |exception, _hits|
+            puts("#{exception}: #{exception.is_a?(Class)}")
+          end
+        else
+          puts 'No exceptions set to be caught.'
+        end
+      end
+
+      def short_description
+        'Exceptions that can be caught in the current stack frame'
+      end
+
+      def description
+        <<-EOD
+          inf[o] c[atch]
+
+          #{short_description}
+        EOD
+      end
+    end
+  end
+end