byebug 9.1.0 → 10.0.0

data/lib/byebug/commands/enable/display.rb

@@ -1,4 +1,6 @@
-require 'byebug/helpers/toggle'
+# frozen_string_literal: true
+
+require "byebug/helpers/toggle"
 
 module Byebug
   #
@@ -18,7 +20,7 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           en[able] d[isplay][ <id1> <id2> .. <idn>]
 
           #{short_description}
@@ -26,15 +28,15 @@ module Byebug
           Arguments are the code numbers of the expressions to enable. Do "info
           display" to see the current list of code numbers. If no arguments are
           specified, all displays are enabled.
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'Enables expressions to be displayed when program stops.'
+        "Enables expressions to be displayed when program stops."
       end
 
       def execute
-        enable_disable_display('enable', @match[1])
+        enable_disable_display("enable", @match[1])
       end
     end
   end

data/lib/byebug/commands/finish.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/parse"
 
 module Byebug
   #
@@ -17,7 +19,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         fin[ish][ n_frames]
 
         #{short_description}
@@ -25,16 +27,16 @@ module Byebug
         If no number is given, we run until the current frame returns. If a
         number of frames `n_frames` is given, then we run until `n_frames`
         return from the current position.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Runs the program until frame returns'
+      "Runs the program until frame returns"
     end
 
     def execute
       if @match[1]
-        n_frames, err = get_int(@match[1], 'finish', 0, max_frames - 1)
+        n_frames, err = get_int(@match[1], "finish", 0, max_frames - 1)
         return errmsg(err) unless n_frames
       else
         n_frames = 1

data/lib/byebug/commands/frame.rb

@@ -1,7 +1,9 @@
-require 'pathname'
-require 'byebug/command'
-require 'byebug/helpers/frame'
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require "pathname"
+require "byebug/command"
+require "byebug/helpers/frame"
+require "byebug/helpers/parse"
 
 module Byebug
   #
@@ -18,7 +20,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         f[rame][ frame-number]
 
         #{short_description}
@@ -34,17 +36,17 @@ module Byebug
         if there is a front end also watching over things.
 
         Use the "bt" command to find out where you want to go.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Moves to a frame in the call stack'
+      "Moves to a frame in the call stack"
     end
 
     def execute
-      return print(pr('frame.line', context.frame.to_hash)) unless @match[1]
+      return print(pr("frame.line", context.frame.to_hash)) unless @match[1]
 
-      pos, err = get_int(@match[1], 'Frame')
+      pos, err = get_int(@match[1], "Frame")
       return errmsg(err) unless pos
 
       switch_to_frame(pos)

data/lib/byebug/commands/help.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/errors'
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/errors"
 
 module Byebug
   #
@@ -14,7 +16,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         h[elp][ <cmd>[ <subcmd>]]
 
         #{short_description}
@@ -22,11 +24,11 @@ module Byebug
         help                -- prints a summary of all commands
         help <cmd>          -- prints help on command <cmd>
         help <cmd> <subcmd> -- prints help on <cmd>'s subcommand <subcmd>
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Helps you using byebug'
+      "Helps you using byebug"
     end
 
     def execute

data/lib/byebug/commands/history.rb

@@ -1,5 +1,7 @@
-require 'byebug/command'
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require "byebug/command"
+require "byebug/helpers/parse"
 
 module Byebug
   #
@@ -15,11 +17,11 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         hist[ory][ num_cmds]
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
@@ -29,7 +31,7 @@ module Byebug
     def execute
       history = processor.interface.history
 
-      size, = get_int(@match[:num_cmds], 'history', 1) if @match[:num_cmds]
+      size, = get_int(@match[:num_cmds], "history", 1) if @match[:num_cmds]
 
       puts history.to_s(size)
     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 "byebug/subcommands"
+
+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"
 
 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/info/breakpoints.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Reopens the +info+ command to define the +breakpoints+ subcommand
@@ -14,19 +16,19 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           inf[o] b[reakpoints]
 
           #{short_description}
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'Status of user settable breakpoints'
+        "Status of user settable breakpoints"
       end
 
       def execute
-        return puts('No breakpoints.') if Byebug.breakpoints.empty?
+        return puts("No breakpoints.") if Byebug.breakpoints.empty?
 
         breakpoints = Byebug.breakpoints.sort_by(&:id)
 
@@ -34,26 +36,30 @@ module Byebug
           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')
+            return errmsg("No breakpoints found among list given")
           end
         end
 
-        puts 'Num Enb What'
+        puts "Num Enb What"
         breakpoints.each { |b| info_breakpoint(b) }
       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)
+        interp = format(
+          "%-<id>3d %-<status>3s at %<file>s:%<line>s%<expression>s",
+          id: brkpt.id,
+          status: brkpt.enabled? ? "y" : "n",
+          file: brkpt.source,
+          line: brkpt.pos,
+          expression: brkpt.expr.nil? ? "" : " if #{brkpt.expr}"
+        )
         puts interp
         hits = brkpt.hit_count
         return unless hits > 0
 
-        s = hits > 1 ? 's' : ''
+        s = hits > 1 ? "s" : ""
         puts "  breakpoint already hit #{hits} time#{s}"
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Reopens the +info+ command to define the +display+ subcommand
@@ -14,27 +16,34 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           inf[o] d[display]
 
           #{short_description}
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'List of expressions to display when program stops'
+        "List of expressions to display when program stops"
       end
 
       def execute
         unless Byebug.displays.find { |d| d[0] }
-          return puts('There are no auto-display expressions now.')
+          return puts("There are no auto-display expressions now.")
         end
 
-        puts 'Auto-display expressions now in effect:'
-        puts 'Num Enb Expression'
+        puts "Auto-display expressions now in effect:"
+        puts "Num Enb Expression"
 
         Byebug.displays.each_with_index do |d, i|
-          puts(format('%3d: %s  %s', i + 1, d[0] ? 'y' : 'n', d[1]))
+          interp = format(
+            "%<number>3d: %<status>s  %<expression>s",
+            number: i + 1,
+            status: d[0] ? "y" : "n",
+            expression: d[1]
+          )
+
+          puts(interp)
         end
       end
     end

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

@@ -1,4 +1,6 @@
-require 'byebug/helpers/file'
+# frozen_string_literal: true
+
+require "byebug/helpers/file"
 
 module Byebug
   #
@@ -19,27 +21,27 @@ 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))
+          return errmsg(pr("info.errors.undefined_file", file: file))
         end
 
-        puts prettify <<-EOC
+        puts prettify <<-RUBY
           File #{info_file_basic(file)}
 
           Breakpoint line numbers: #{info_file_breakpoints(file)}
@@ -47,7 +49,7 @@ module Byebug
           Modification time: #{info_file_mtime(file)}
 
           Sha1 Signature: #{info_file_sha1(file)}
-        EOC
+        RUBY
       end
 
       private
@@ -56,7 +58,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
 
@@ -64,7 +66,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)
@@ -72,7 +74,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