byebug 9.0.5 → 11.1.3

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

@@ -1,4 +1,6 @@
-require 'byebug/helpers/file'
+# frozen_string_literal: true
+
+require_relative "../../helpers/file"
 
 module Byebug
   #
@@ -10,6 +12,7 @@ module Byebug
     #
     class FileCommand < Command
       include Helpers::FileHelper
+      include Helpers::StringHelper
 
       self.allow_in_post_mortem = true
 
@@ -18,28 +21,25 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           inf[o] f[ile]
 
           #{short_description}
 
           It informs about file name, number of lines, possible breakpoints in
           the file, last modification time and sha1 digest.
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'Information about a particular source file.'
+        "Information about a particular source file."
       end
 
       def execute
         file = @match[1] || frame.file
-        unless File.exist?(file)
-          return errmsg(pr('info.errors.undefined_file', file: file))
-        end
-
-        puts <<-EOC.gsub(/^ {6}/, '')
+        return errmsg(pr("info.errors.undefined_file", file: file)) unless File.exist?(file)
 
+        puts prettify <<-RUBY
           File #{info_file_basic(file)}
 
           Breakpoint line numbers: #{info_file_breakpoints(file)}
@@ -47,8 +47,7 @@ module Byebug
           Modification time: #{info_file_mtime(file)}
 
           Sha1 Signature: #{info_file_sha1(file)}
-
-        EOC
+        RUBY
       end
 
       private
@@ -57,7 +56,7 @@ module Byebug
         path = File.expand_path(file)
         return unless File.exist?(path)
 
-        s = n_lines(path) == 1 ? '' : 's'
+        s = n_lines(path) == 1 ? "" : "s"
         "#{path} (#{n_lines(path)} line#{s})"
       end
 
@@ -65,7 +64,7 @@ module Byebug
         breakpoints = Breakpoint.potential_lines(file)
         return unless breakpoints
 
-        breakpoints.to_a.sort.join(' ')
+        breakpoints.to_a.sort.join(" ")
       end
 
       def info_file_mtime(file)
@@ -73,7 +72,7 @@ module Byebug
       end
 
       def info_file_sha1(file)
-        require 'digest/sha1'
+        require "digest/sha1"
         Digest::SHA1.hexdigest(file)
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Reopens the +info+ command to define the +line+ subcommand
@@ -14,15 +16,15 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           inf[o] l[ine]
 
           #{short_description}
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'Line number and file name of current position in source file.'
+        "Line number and file name of current position in source file."
       end
 
       def execute

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Reopens the +info+ command to define the +args+ subcommand
@@ -14,19 +16,19 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           inf[o] p[rogram]
 
           #{short_description}
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'Information about the current status of the debugged program.'
+        "Information about the current status of the debugged program."
       end
 
       def execute
-        puts 'Program stopped. '
+        puts "Program stopped. "
         format_stop_reason context.stop_reason
       end
 
@@ -37,9 +39,9 @@ module Byebug
         when :step
           puts "It stopped after stepping, next'ing or initial start."
         when :breakpoint
-          puts 'It stopped at a breakpoint.'
+          puts "It stopped at a breakpoint."
         when :catchpoint
-          puts 'It stopped at a catchpoint.'
+          puts "It stopped at a catchpoint."
         end
       end
     end

data/lib/byebug/commands/info.rb

@@ -1,10 +1,12 @@
-require 'byebug/subcommands'
+# frozen_string_literal: true
 
-require 'byebug/commands/info/breakpoints'
-require 'byebug/commands/info/display'
-require 'byebug/commands/info/file'
-require 'byebug/commands/info/line'
-require 'byebug/commands/info/program'
+require_relative "../subcommands"
+
+require_relative "../commands/info/breakpoints"
+require_relative "../commands/info/display"
+require_relative "../commands/info/file"
+require_relative "../commands/info/line"
+require_relative "../commands/info/program"
 
 module Byebug
   #
@@ -21,15 +23,15 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         info[ subcommand]
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Shows several informations about the program being debugged'
+      "Shows several informations about the program being debugged"
     end
   end
 end

data/lib/byebug/commands/interrupt.rb

@@ -1,4 +1,6 @@
-require 'byebug/command'
+# frozen_string_literal: true
+
+require_relative "../command"
 
 module Byebug
   #
@@ -12,18 +14,20 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         int[errupt]
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Interrupts the program'
+      "Interrupts the program"
     end
 
     def execute
+      Byebug.start
+
       Byebug.thread_context(Thread.main).interrupt
     end
   end

data/lib/byebug/commands/irb.rb

@@ -1,5 +1,8 @@
-require 'byebug/command'
-require 'irb'
+# frozen_string_literal: true
+
+require_relative "../command"
+require "irb"
+require "English"
 
 module Byebug
   #
@@ -13,23 +16,21 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         irb
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Starts an IRB session'
+      "Starts an IRB session"
     end
 
     def execute
-      unless processor.interface.instance_of?(LocalInterface)
-        return errmsg(pr('base.errors.only_local'))
-      end
+      return errmsg(pr("base.errors.only_local")) unless processor.interface.instance_of?(LocalInterface)
 
-      # @todo IRB tries to parse ARGV so we must clear it (see #197). Add a
+      # @todo IRB tries to parse $ARGV so we must clear it (see #197). Add a
       #   test case for it so we can remove this comment.
       with_clean_argv { IRB.start }
     end
@@ -37,12 +38,12 @@ module Byebug
     private
 
     def with_clean_argv
-      saved_argv = ARGV.dup
-      ARGV.clear
+      saved_argv = $ARGV.dup
+      $ARGV.clear
       begin
         yield
       ensure
-        ARGV.concat(saved_argv)
+        $ARGV.concat(saved_argv)
       end
     end
   end

data/lib/byebug/commands/kill.rb

@@ -1,4 +1,6 @@
-require 'byebug/command'
+# frozen_string_literal: true
+
+require_relative "../command"
 
 module Byebug
   #
@@ -8,37 +10,35 @@ module Byebug
     self.allow_in_control = true
 
     def self.regexp
-      /^\s* (?:kill) \s* (?:\s+(\S+))? \s*$/x
+      /^\s* kill \s* (?:\s+(\S+))? \s*$/x
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         kill[ signal]
 
         #{short_description}
 
         Equivalent of Process.kill(Process.pid)
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Sends a signal to the current process'
+      "Sends a signal to the current process"
     end
 
     def execute
       if @match[1]
         signame = @match[1]
 
-        unless Signal.list.member?(signame)
-          return errmsg("signal name #{signame} is not a signal I know about\n")
-        end
+        return errmsg("signal name #{signame} is not a signal I know about\n") unless Signal.list.member?(signame)
       else
-        return unless confirm('Really kill? (y/n) ')
+        return unless confirm("Really kill? (y/n) ")
 
-        signame = 'KILL'
+        signame = "KILL"
       end
 
-      processor.interface.close if 'KILL' == signame
+      processor.interface.close if signame == "KILL"
       Process.kill(signame, Process.pid)
     end
   end

data/lib/byebug/commands/list.rb

@@ -1,6 +1,9 @@
-require 'byebug/command'
-require 'byebug/helpers/file'
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../source_file_formatter"
+require_relative "../helpers/file"
+require_relative "../helpers/parse"
 
 module Byebug
   #
@@ -17,7 +20,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         l[ist][[-=]][ nn-mm]
 
         #{short_description}
@@ -27,20 +30,18 @@ module Byebug
         "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.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Lists lines of source code'
+      "Lists lines of source code"
     end
 
     def execute
       msg = "No sourcefile available for #{frame.file}"
       raise(msg) unless File.exist?(frame.file)
 
-      max_lines = n_lines(frame.file)
-      b, e = range(@match[2], max_lines)
-      raise('Invalid line range') unless valid_range?(b, e, max_lines)
+      b, e = range(@match[2])
 
       display_lines(b, e)
 
@@ -56,42 +57,44 @@ module Byebug
     #
     # Otherwise it's automatically chosen.
     #
-    def range(input, max_line)
-      size = [Setting[:listsize], max_line].min
+    def range(input)
+      return auto_range(@match[1] || "+") unless input
 
-      return set_range(size, max_line) unless input
+      b, e = parse_range(input)
+      raise("Invalid line range") unless valid_range?(b, e)
 
-      parse_range(input, size, max_line)
+      [b, e]
     end
 
-    def valid_range?(first, last, max)
-      first <= last && (1..max).cover?(first) && (1..max).cover?(last)
+    def valid_range?(first, last)
+      first <= last && (1..max_line).cover?(first) && (1..max_line).cover?(last)
     end
 
     #
     # Set line range to be printed by list
     #
-    # @param size - number of lines to be printed
-    # @param max_line - max line number that can be printed
-    #
     # @return first line number to list
     # @return last line number to list
     #
-    def set_range(size, max_line)
-      first = amend(lower(size, @match[1] || '+'), max_line - size + 1)
+    def auto_range(direction)
+      prev_line = processor.prev_line
 
-      [first, move(first, size - 1)]
+      if direction == "=" || prev_line.nil?
+        source_file_formatter.range_around(frame.line)
+      else
+        source_file_formatter.range_from(move(prev_line, size, direction))
+      end
     end
 
-    def parse_range(input, size, max_line)
-      first, err = get_int(lower_bound(input), 'List', 1, max_line)
+    def parse_range(input)
+      first, err = get_int(lower_bound(input), "List", 1, max_line)
       raise(err) unless first
 
       if upper_bound(input)
-        last, err = get_int(upper_bound(input), 'List', 1, max_line)
+        last, err = get_int(upper_bound(input), "List", 1, max_line)
         raise(err) unless last
 
-        last = amend(last, max_line)
+        last = amend_final(last)
       else
         first -= (size / 2)
       end
@@ -99,20 +102,7 @@ module Byebug
       [first, last || move(first, size - 1)]
     end
 
-    def amend(line, max_line)
-      return 1 if line < 1
-
-      [max_line, line].min
-    end
-
-    def lower(size, direction = '+')
-      prev_line = processor.prev_line
-      return frame.line - size / 2 if direction == '=' || prev_line.nil?
-
-      move(prev_line, size, direction)
-    end
-
-    def move(line, size, direction = '+')
+    def move(line, size, direction = "+")
       line.send(direction, size)
     end
 
@@ -125,13 +115,7 @@ module Byebug
     def display_lines(min, max)
       puts "\n[#{min}, #{max}] in #{frame.file}"
 
-      File.foreach(frame.file).with_index do |line, lineno|
-        break if lineno + 1 > max
-        next unless (min..max).cover?(lineno + 1)
-
-        mark = lineno + 1 == frame.line ? '=> ' : '   '
-        puts format("#{mark}%#{max.to_s.size}d: %s", lineno + 1, line)
-      end
+      puts source_file_formatter.lines(min, max).join
     end
 
     #
@@ -160,5 +144,16 @@ module Byebug
     def split_range(str)
       str.split(/[-,]/)
     end
+
+    extend Forwardable
+
+    def_delegators :source_file_formatter, :amend_final, :size, :max_line
+
+    def source_file_formatter
+      @source_file_formatter ||= SourceFileFormatter.new(
+        frame.file,
+        ->(n) { n == frame.line ? "=>" : "  " }
+      )
+    end
   end
 end

data/lib/byebug/commands/method.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/helpers/eval'
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../helpers/eval"
 
 module Byebug
   #
@@ -15,7 +17,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         m[ethod] (i[nstance][ <obj>]|<class|module>)
 
         #{short_description}
@@ -25,11 +27,11 @@ module Byebug
 
         When invoked only with a class or module, shows class methods of the
         class or module specified as argument.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Shows methods of an object, class or module'
+      "Shows methods of an object, class or module"
     end
 
     def execute
@@ -37,11 +39,11 @@ module Byebug
 
       result =
         if @match[1]
-          prc('method.methods', obj.methods.sort) { |item, _| { name: item } }
+          prc("method.methods", obj.methods.sort) { |item, _| { name: item } }
         elsif !obj.is_a?(Module)
-          pr('variable.errors.not_module', object: @match.post_match)
+          pr("variable.errors.not_module", object: @match.post_match)
         else
-          prc('method.methods', obj.instance_methods(false).sort) do |item, _|
+          prc("method.methods", obj.instance_methods(false).sort) do |item, _|
             { name: item }
           end
         end

data/lib/byebug/commands/next.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../helpers/parse"
 
 module Byebug
   #
@@ -16,19 +18,19 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         n[ext][ nnn]
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Runs one or more lines of code'
+      "Runs one or more lines of code"
     end
 
     def execute
-      steps, err = parse_steps(@match[1], 'Next')
+      steps, err = parse_steps(@match[1], "Next")
       return errmsg(err) unless steps
 
       context.step_over(steps, context.frame.pos)

data/lib/byebug/commands/pry.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/helpers/eval'
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../helpers/eval"
 
 module Byebug
   #
@@ -13,26 +15,24 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         pry
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Starts a Pry session'
+      "Starts a Pry session"
     end
 
     def execute
-      unless processor.interface.instance_of?(LocalInterface)
-        return errmsg(pr('base.errors.only_local'))
-      end
+      return errmsg(pr("base.errors.only_local")) unless processor.interface.instance_of?(LocalInterface)
 
       begin
-        require 'pry'
+        require "pry"
       rescue LoadError
-        return errmsg(pr('pry.errors.not_installed'))
+        return errmsg(pr("pry.errors.not_installed"))
       end
 
       Pry.start(context.frame._binding)

data/lib/byebug/commands/quit.rb

@@ -1,4 +1,6 @@
-require 'byebug/command'
+# frozen_string_literal: true
+
+require_relative "../command"
 
 module Byebug
   #
@@ -13,23 +15,23 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
-        q[uit] [!|unconditionally]
+      <<-DESCRIPTION
+        q[uit][!| unconditionally]
 
         #{short_description}
 
-        Normally we prompt before exiting. However if the parameter
-        "unconditionally" is given or command is suffixed with !, we exit
+        Normally we prompt before exiting. However, if the parameter
+        "unconditionally" is given or command is suffixed with "!", we exit
         without asking further questions.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Exits byebug'
+      "Exits byebug"
     end
 
     def execute
-      return unless @match[1] || confirm(pr('quit.confirmations.really'))
+      return unless @match[1] || confirm(pr("quit.confirmations.really"))
 
       processor.interface.autosave
       processor.interface.close