byebug 3.5.1 → 4.0.0

data/lib/byebug/commands/help.rb

@@ -1,32 +1,23 @@
+require 'byebug/command'
+
 module Byebug
   #
   # Ask for help from byebug's prompt.
   #
   class HelpCommand < Command
-    include Columnize
-
     self.allow_in_control = true
 
     def regexp
-      /^\s* h(?:elp)? (?:\s+(.+))? \s*$/x
+      /^\s* h(?:elp)? (?: \s+(\S+) (?:\s+(\S+))? )? \s*$/x
     end
 
     def execute
-      if @match[1]
-        args = @match[1].split
-        cmds = @state.commands.select { |cmd| cmd.names.include?(args[0]) }
-        if cmds.empty?
-          return errmsg("Undefined command: \"#{args[0]}\". Try \"help\"")
-        end
-
-        return puts(cmds.map { |cmd| cmd.help(args[1..-1]) }.join("\n"))
-      end
+      return puts(self.class.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?
 
-      puts "byebug help v#{VERSION}" unless Setting[:testing]
-      puts "Type \"help <command-name>\" for help on a specific command\n"
-      puts 'Available commands:'
-      cmds = @state.commands.map { |cmd| cmd.names }.flatten.uniq.sort
-      puts columnize(cmds, Setting[:width])
+      cmd.each { |c| puts c.help(@match[2]) }
     end
 
     class << self
@@ -35,11 +26,13 @@ module Byebug
       end
 
       def description
-        %(h[elp][ <command>[ <subcommand>]]
+        prettify <<-EOD
+          h[elp][ <cmd>[ <subcmd>]]
 
-          "help" alone prints this help.
-          "help <command>" prints help on <command>.
-          "help <command> <subcommand> prints help on <subcommand>.)
+          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,3 +1,5 @@
+require 'byebug/command'
+
 module Byebug
   #
   # Show history of byebug commands.
@@ -24,7 +26,9 @@ module Byebug
       end
 
       def description
-        %(hist[ory] [num_cmds]        Show byebug's command history.)
+        prettify <<-EOD
+          hist[ory] [num_cmds]        Show byebug's command history.
+        EOD
       end
     end
   end

data/lib/byebug/commands/info.rb

@@ -1,6 +1,8 @@
+require 'byebug/command'
+
 module Byebug
   #
-  # Utility methods to assist the info command
+  # Utilities for the info command.
   #
   module InfoFunctions
     def info_catch(*_args)
@@ -43,9 +45,9 @@ module Byebug
     def info_breakpoints(*args)
       return puts('No breakpoints.') if Byebug.breakpoints.empty?
 
-      brkpts = Byebug.breakpoints.sort_by { |b| b.id }
+      brkpts = Byebug.breakpoints.sort_by(&:id)
       unless args.empty?
-        indices = args.map { |a| a.to_i }
+        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
@@ -67,63 +69,37 @@ module Byebug
       end
     end
 
-    def info_file_path(file)
-      s = "File #{file}"
+    include FileFunctions
+
+    def info_file_basic(file)
       path = File.expand_path(file)
-      s = "#{s} - #{path}" if path && path != file
-      puts s
-    end
+      return unless File.exist?(path)
 
-    def info_file_lines(file)
-      lines = File.foreach(file)
-      puts "\t#{lines.count} lines" if lines
+      s = n_lines(path) == 1 ? '' : 's'
+      "#{path} (#{n_lines(path)} line#{s})"
     end
 
     def info_file_breakpoints(file)
-      breakpoints = LineCache.trace_line_numbers(file)
+      breakpoints = Breakpoint.potential_lines(file)
       return unless breakpoints
 
-      puts "\tbreakpoint line numbers:"
-      puts columnize(breakpoints.to_a.sort, Setting[:width])
+      breakpoints.to_a.sort.columnize(line_prefix: '  ',
+                                      displaywidth: Setting[:width])
     end
 
     def info_file_mtime(file)
-      stat = File.stat(file)
-      puts "\t#{stat.mtime}" if stat
+      File.stat(file).mtime
     end
 
     def info_file_sha1(file)
-      puts "\t#{Digest::SHA1.hexdigest(file)}"
-    end
-
-    def info_files(*_args)
-      files = SCRIPT_LINES__.keys
-      files.uniq.sort.each do |file|
-        info_file_path(file)
-        info_file_mtime(file)
-      end
+      require 'digest/sha1'
+      Digest::SHA1.hexdigest(file)
     end
 
     def info_line(*_args)
       puts "Line #{@state.line} of \"#{@state.file}\""
     end
 
-    def print_hash(vars)
-      vars.keys.sort.each do |name|
-        begin
-          s = "#{name} = #{vars[name].inspect}"
-        rescue
-          begin
-            s = "#{name} = #{vars[name]}"
-            rescue
-              s = "#{name} = *Error in evaluation*"
-          end
-        end
-        s[Setting[:width] - 3..-1] = '...' if s.size > Setting[:width]
-        puts s
-      end
-    end
-
     def info_stop_reason(stop_reason)
       case stop_reason
       when :step
@@ -132,8 +108,6 @@ module Byebug
         puts 'It stopped at a breakpoint.'
       when :catchpoint
         puts 'It stopped at a catchpoint.'
-      else
-        puts "Unknown reason: #{@state.context.stop_reason}"
       end
     end
 
@@ -147,16 +121,6 @@ module Byebug
       puts 'Program stopped. '
       info_stop_reason @state.context.stop_reason
     end
-
-    def info_variables(*_args)
-      locals = @state.context.frame_locals
-      locals[:self] = @state.context.frame_self(@state.frame_pos)
-      print_hash(locals)
-
-      obj = bb_eval('self')
-      var_list(obj.instance_variables, obj.instance_eval { binding })
-      var_class_self
-    end
   end
 
   #
@@ -164,6 +128,8 @@ module Byebug
   #
   class InfoCommand < Command
     include Columnize
+    include InfoFunctions
+
     self.allow_in_control = true
 
     Subcommands = [
@@ -174,50 +140,33 @@ module Byebug
       ['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',
-       'After the file name is supplied, you can list file attributes that ' \
-       'you wish to see. Attributes include: "all", "basic", "breakpoint", ' \
-       '"lines", "mtime", "path" and "sha1".'],
-      ['files', 5, 'File names and timestamps of files 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 unless defined?(Subcommands)
-
-    InfoFileSubcommands = [
-      ['all', 1, 'All file information available - breakpoints, lines, '     \
-                 'mtime, path and sha1'],
-      ['basic', 2, 'basic information - path, number of lines'],
-      ['breakpoints', 2, 'Show trace line numbers',
-       'These are the line number where a breakpoint can be set.'],
-      ['lines', 1, 'Show number of lines in the file'],
-      ['mtime', 1, 'Show modification time of file'],
-      ['path', 4, 'Show full file path name for file'],
-      ['sha1', 1, 'Show SHA1 hash of contents of the file']
-    ].map do |name, min, help|
-      Subcmd.new(name, min, help)
-    end unless defined?(InfoFileSubcommands)
+    end
 
     def info_file(*args)
-      return info_files unless args[0]
-
-      mode = args[1] || 'basic'
-      subcmd = Command.find(InfoFileSubcommands, mode)
-      return errmsg "Invalid parameter #{args[1]}\n" unless subcmd
-
-      if %w(all basic).member?(subcmd.name)
-        info_file_path(args[0])
-        info_file_lines(args[0])
-        if subcmd.name == 'all'
-          info_file_breakpoints(args[0])
-          info_file_mtime(args[0])
-          info_file_sha1(args[0])
-        end
-      else
-        puts("File #{args[0]}") if subcmd.name != 'path'
-        send("info_file_#{subcmd.name}", args[0])
+      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
@@ -225,7 +174,7 @@ module Byebug
     end
 
     def execute
-      return puts(InfoCommand.help) unless @match[1]
+      return puts(self.class.help) unless @match[1]
 
       args = @match[1].split(/[ \t]+/)
       param = args.shift
@@ -235,7 +184,7 @@ module Byebug
       if @state.context
         send("info_#{subcmd.name}", *args)
       else
-        errmsg "info_#{subcmd.name} not available without a context.\n"
+        errmsg "'info #{subcmd.name}' not available without a context.\n"
       end
     end
 
@@ -245,26 +194,12 @@ module Byebug
       end
 
       def description
-        <<-EOD.gsub(/^ {8}/, '')
-
+        prettify <<-EOD
           info[ subcommand]
 
           Generic command for showing things about the program being debugged.
-
         EOD
       end
-
-      def help(subcmds = [])
-        return description + format_subcmds if subcmds.empty?
-
-        subcmd = subcmds.first
-        return format_subcmd(subcmd) unless 'file' == subcmd && subcmds[2]
-
-        subsubcmd = Command.find(InfoFileSubcommands, subcmds[2])
-        return "\nInvalid \"file\" attribute \"#{args[2]}\"." unless subsubcmd
-
-        subsubcmd.short_help
-      end
     end
   end
 end

data/lib/byebug/commands/interrupt.rb

@@ -1,9 +1,11 @@
+require 'byebug/command'
+
 module Byebug
   #
   # Interrupting execution of current thread.
   #
   class InterruptCommand < Command
-    self.allow_in_control     = true
+    self.allow_in_control = true
     self.allow_in_post_mortem = false
 
     def regexp
@@ -21,7 +23,9 @@ module Byebug
       end
 
       def description
-        %(i|nterrupt        Interrupts the program.)
+        prettify <<-EOD
+          i[nterrupt]  Interrupts the program.
+        EOD
       end
     end
   end

data/lib/byebug/commands/irb.rb

@@ -1,3 +1,4 @@
+require 'byebug/command'
 require 'irb'
 
 module Byebug
@@ -11,7 +12,7 @@ module Byebug
 
     def execute
       unless @state.interface.is_a?(LocalInterface)
-        return errmsg('Command is available only in local mode.')
+        return errmsg(pr('base.errors.only_local'))
       end
 
       IRB.start(__FILE__)
@@ -23,7 +24,9 @@ module Byebug
       end
 
       def description
-        %{irb        Starts an Interactive Ruby (IRB) session.}
+        prettify <<-EOD
+          irb  Starts an Interactive Ruby (IRB) session.
+        EOD
       end
     end
   end

data/lib/byebug/commands/kill.rb

@@ -1,3 +1,5 @@
+require 'byebug/command'
+
 module Byebug
   #
   # Send custom signals to the debugged program.
@@ -31,10 +33,12 @@ module Byebug
       end
 
       def description
-        %{kill[ SIGNAL]
+        prettify <<-EOD
+          kill[ SIGNAL]
 
           Send [signal] to Process.pid
-          Equivalent of Process.kill(Process.pid)}
+          Equivalent of Process.kill(Process.pid)
+        EOD
       end
     end
   end

data/lib/byebug/commands/list.rb

@@ -1,3 +1,5 @@
+require 'byebug/command'
+
 module Byebug
   #
   # List parts of the source code.
@@ -8,15 +10,15 @@ module Byebug
     end
 
     def execute
-      Byebug.source_reload if Setting[:autoreload]
-
-      lines = get_lines(@state.file)
-      return errmsg "No sourcefile available for #{@state.file}\n" unless lines
+      exist = File.exist?(@state.file)
+      return errmsg "No sourcefile available for #{@state.file}\n" unless exist
 
       @match ||= match('list')
-      b, e = range(@match[2], lines.size)
-      return errmsg('Invalid line range') unless valid_range?(b, e, lines.size)
-      display_lines(b, e, lines)
+      max_lines = n_lines(@state.file)
+      b, e = range(@match[2], max_lines)
+      return errmsg('Invalid line range') unless valid_range?(b, e, max_lines)
+
+      display_lines(b, e)
 
       @state.prev_line = b
     end
@@ -27,13 +29,15 @@ module Byebug
       end
 
       def description
-        %(l[ist][[-=]][ nn-mm]
+        prettify <<-EOD
+          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.)
+          list specific sections of code.
+        EOD
       end
     end
 
@@ -106,14 +110,17 @@ module Byebug
     end
 
     #
-    # Show file lines in <lines> from line number <min> to line number <max>.
+    # Show lines in @state.file from line number <min> to line number <max>.
     #
-    def display_lines(min, max, lines)
+    def display_lines(min, max)
       puts "\n[#{min}, #{max}] in #{@state.file}"
 
-      (min..max).to_a.zip(lines[min - 1..max - 1]).map do |l|
-        mark = l[0] == @state.line ? '=> ' : '   '
-        puts format("#{mark}%#{max.to_s.size}d: %s", l[0], l[1])
+      File.foreach(@state.file).with_index do |line, lineno|
+        return if lineno + 1 > max
+        next unless (min..max).include?(lineno + 1)
+
+        mark = lineno + 1 == @state.line ? '=> ' : '   '
+        puts format("#{mark}%#{max.to_s.size}d: %s", lineno + 1, line)
       end
     end
   end