byebug 9.0.5 → 11.1.3

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

@@ -1,4 +1,6 @@
-require 'byebug/helpers/toggle'
+# frozen_string_literal: true
+
+require_relative "../../helpers/toggle"
 
 module Byebug
   #
@@ -18,22 +20,22 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           dis[able] b[reakpoints][ <id1> <id2> .. <idn>]
 
           #{short_description}
 
           Give breakpoint numbers (separated by spaces) as arguments or no
           argument at all if you want to disable every breakpoint.
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'Disable all or specific breakpoints.'
+        "Disable all or specific breakpoints."
       end
 
       def execute
-        enable_disable_breakpoints('disable', @match[1])
+        enable_disable_breakpoints("disable", @match[1])
       end
     end
   end

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

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

data/lib/byebug/commands/disable.rb

@@ -1,7 +1,9 @@
-require 'byebug/subcommands'
+# frozen_string_literal: true
 
-require 'byebug/commands/disable/breakpoints'
-require 'byebug/commands/disable/display'
+require_relative "../subcommands"
+
+require_relative "../commands/disable/breakpoints"
+require_relative "../commands/disable/display"
 
 module Byebug
   #
@@ -17,15 +19,15 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         dis[able][[ breakpoints| display)][ n1[ n2[ ...[ nn]]]]]
 
         #{short_description}
-       EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Disables breakpoints or displays'
+      "Disables breakpoints or displays"
     end
   end
 end

data/lib/byebug/commands/display.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
   #
@@ -16,18 +18,18 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         disp[lay][ <expression>]
 
         #{short_description}
 
         If <expression> specified, adds <expression> into display expression
         list. Otherwise, it lists all expressions.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Evaluates expressions every time the debugger stops'
+      "Evaluates expressions every time the debugger stops"
     end
 
     def execute
@@ -40,13 +42,13 @@ module Byebug
     private
 
     def display_expression(exp)
-      print pr('display.result', n: Byebug.displays.size,
+      print pr("display.result", n: Byebug.displays.size,
                                  exp: exp,
                                  result: eval_expr(exp))
     end
 
     def print_display_expressions
-      result = prc('display.result', Byebug.displays) do |item, index|
+      result = prc("display.result", Byebug.displays) do |item, index|
         active, exp = item
 
         { n: index + 1, exp: exp, result: eval_expr(exp) } if active
@@ -57,8 +59,8 @@ module Byebug
 
     def eval_expr(expression)
       error_eval(expression).inspect
-    rescue
-      '(undefined)'
+    rescue StandardError
+      "(undefined)"
     end
   end
 end

data/lib/byebug/commands/down.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_relative "../command"
+require_relative "../helpers/frame"
+require_relative "../helpers/parse"
 
 module Byebug
   #
@@ -18,21 +20,21 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         down[ count]
 
         #{short_description}
 
         Use the "bt" command to find out where you want to go.
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Moves to a lower frame in the stack trace'
+      "Moves to a lower frame in the stack trace"
     end
 
     def execute
-      pos, err = parse_steps(@match[1], 'Down')
+      pos, err = parse_steps(@match[1], "Down")
       return errmsg(err) unless pos
 
       jump_frames(-pos)

data/lib/byebug/commands/edit.rb

@@ -1,4 +1,6 @@
-require 'byebug/command'
+# frozen_string_literal: true
+
+require_relative "../command"
 
 module Byebug
   #
@@ -13,7 +15,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         edit[ file:lineno]
 
         #{short_description}
@@ -21,17 +23,17 @@ module Byebug
         With no argumnt, edits file containing most re line listed. Editing
         targets can also be specified to start editing at a specific line in a
         specific file
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Edits source files'
+      "Edits source files"
     end
 
     def execute
       file, line = location(@match[1])
-      return edit_error('not_exist', file) unless File.exist?(file)
-      return edit_error('not_readable', file) unless File.readable?(file)
+      return edit_error("not_exist", file) unless File.exist?(file)
+      return edit_error("not_readable", file) unless File.readable?(file)
 
       cmd = line ? "#{editor} +#{line} #{file}" : "#{editor} #{file}"
 
@@ -43,7 +45,8 @@ module Byebug
     def location(matched)
       if matched.nil?
         file = frame.file
-        return errmsg(pr('edit.errors.state')) unless file
+        return errmsg(pr("edit.errors.state")) unless file
+
         line = frame.line
       elsif (@pos_match = /([^:]+)[:]([0-9]+)/.match(matched))
         file, line = @pos_match.captures
@@ -56,7 +59,7 @@ module Byebug
     end
 
     def editor
-      ENV['EDITOR'] || 'vim'
+      ENV["EDITOR"] || "vim"
     end
 
     def edit_error(type, file)

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

@@ -1,4 +1,6 @@
-require 'byebug/helpers/toggle'
+# frozen_string_literal: true
+
+require_relative "../../helpers/toggle"
 
 module Byebug
   #
@@ -18,22 +20,22 @@ module Byebug
       end
 
       def self.description
-        <<-EOD
+        <<-DESCRIPTION
           en[able] b[reakpoints][ <ids>]
 
           #{short_description}
 
           Give breakpoint numbers (separated by spaces) as arguments or no
           argument at all if you want to enable every breakpoint.
-        EOD
+        DESCRIPTION
       end
 
       def self.short_description
-        'Disable all or specific breakpoints'
+        "Enable all or specific breakpoints"
       end
 
       def execute
-        enable_disable_breakpoints('enable', @match[1])
+        enable_disable_breakpoints("enable", @match[1])
       end
     end
   end

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

@@ -1,4 +1,6 @@
-require 'byebug/helpers/toggle'
+# frozen_string_literal: true
+
+require_relative "../../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/enable.rb

@@ -1,7 +1,9 @@
-require 'byebug/subcommands'
+# frozen_string_literal: true
 
-require 'byebug/commands/enable/breakpoints'
-require 'byebug/commands/enable/display'
+require_relative "../subcommands"
+
+require_relative "../commands/enable/breakpoints"
+require_relative "../commands/enable/display"
 
 module Byebug
   #
@@ -17,15 +19,15 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         en[able][[ b[reakpoints]| d[isplay])][ n1[ n2[ ...[ nn]]]]]
 
         #{short_description}
-      EOD
+      DESCRIPTION
     end
 
     def self.short_description
-      'Enables breakpoints or displays'
+      "Enables breakpoints or displays"
     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_relative "../command"
+require_relative "../helpers/parse"
 
 module Byebug
   #
@@ -17,7 +19,7 @@ module Byebug
     end
 
     def self.description
-      <<-EOD
+      <<-DESCRIPTION
         fin[ish][ n_frames]
 
         #{short_description}
@@ -25,22 +27,22 @@ 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
       end
 
-      force = n_frames == 0 ? true : false
+      force = n_frames.zero? ? true : false
       context.step_out(context.frame.pos + n_frames, force)
       context.frame = 0
       processor.proceed!

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_relative "../command"
+require_relative "../helpers/frame"
+require_relative "../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_relative "../command"
+require_relative "../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_relative "../command"
+require_relative "../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/breakpoints.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   #
   # Reopens the +info+ command to define the +breakpoints+ subcommand
@@ -14,46 +16,48 @@ 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)
 
         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
+          return errmsg("No breakpoints found among list given") if breakpoints.empty?
         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
+        return unless hits.positive?
 
-        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,32 @@ 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.')
-        end
+        return puts("There are no auto-display expressions now.") unless Byebug.displays.find { |d| d[0] }
 
-        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