byebug 9.0.5 → 11.1.3

data/lib/byebug/frame.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'byebug/helpers/file'
+require_relative "helpers/file"
 
 module Byebug
   #
@@ -47,13 +47,10 @@ module Byebug
     #
     # Gets local variables for the frame.
     #
-    # @todo Use `Binding#local_variables` directly once we drop 2.1 support
-    #   since it's a public method since ruby 2.2
-    #
     def locals
       return [] unless _binding
 
-      _binding.eval('local_variables').each_with_object({}) do |e, a|
+      _binding.local_variables.each_with_object({}) do |e, a|
         a[e] = _binding.local_variable_get(e)
         a
       end
@@ -73,11 +70,11 @@ module Byebug
     # +callstyle+ setting is 'short'
     #
     def deco_class
-      Setting[:callstyle] == 'short' || _class.to_s.empty? ? '' : "#{_class}."
+      Setting[:callstyle] == "short" || _class.to_s.empty? ? "" : "#{_class}."
     end
 
     def deco_block
-      _method[/(?:block(?: \(\d+ levels\))?|rescue) in /] || ''
+      _method[/(?:block(?: \(\d+ levels\))?|rescue) in /] || ""
     end
 
     def deco_method
@@ -90,12 +87,12 @@ module Byebug
     # setting
     #
     def deco_args
-      return '' if args.empty?
+      return "" if args.empty?
 
       my_args = args.map do |arg|
         prefix, default = prefix_and_default(arg[0])
 
-        kls = use_short_style?(arg) ? '' : "##{locals[arg[1]].class}"
+        kls = use_short_style?(arg) ? "" : "##{locals[arg[1]].class}"
 
         "#{prefix}#{arg[1] || default}#{kls}"
       end
@@ -121,7 +118,7 @@ module Byebug
     # Properly formatted frame number of frame
     #
     def deco_pos
-      format('%-2d', pos)
+      format("%-2<pos>d", pos: pos)
     end
 
     #
@@ -132,10 +129,10 @@ module Byebug
     #     marks regular frames
     #
     def mark
-      return '-->' if current?
-      return '    ͱ--' if c_frame?
+      return "-->" if current?
+      return "    ͱ--" if c_frame?
 
-      '   '
+      "   "
     end
 
     #
@@ -159,30 +156,30 @@ module Byebug
     private
 
     def c_args
-      return [] unless _self.to_s != 'main'
+      return [] unless _self.to_s != "main"
 
-      _self.method(_method).parameters
+      _class.instance_method(_method).parameters
     end
 
     def ruby_args
-      meth_name = _binding.eval('__method__')
+      meth_name = _binding.eval("__method__")
       return [] unless meth_name
 
-      meth_obj = _self.method(meth_name)
+      meth_obj = _class.instance_method(meth_name)
       return [] unless meth_obj
 
       meth_obj.parameters
     end
 
     def use_short_style?(arg)
-      Setting[:callstyle] == 'short' || arg[1].nil? || locals.empty?
+      Setting[:callstyle] == "short" || arg[1].nil? || locals.empty?
     end
 
     def prefix_and_default(arg_type)
-      return ['&', 'block'] if arg_type == :block
-      return ['*', 'args'] if arg_type == :rest
+      return ["&", "block"] if arg_type == :block
+      return ["*", "args"] if arg_type == :rest
 
-      ['', nil]
+      ["", nil]
     end
   end
 end

data/lib/byebug/helpers/bin.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Byebug
+  module Helpers
+    #
+    # Utilities for interaction with executables
+    #
+    module BinHelper
+      #
+      # Cross-platform way of finding an executable in the $PATH.
+      # Adapted from: https://gist.github.com/steakknife/88b6c3837a5e90a08296
+      #
+      def which(cmd)
+        return File.expand_path(cmd) if File.exist?(cmd)
+
+        [nil, *search_paths].each do |path|
+          exe = find_executable(path, cmd)
+          return exe if exe
+        end
+
+        nil
+      end
+
+      def find_executable(path, cmd)
+        executable_file_extensions.each do |ext|
+          exe = File.expand_path(cmd + ext, path)
+
+          return exe if real_executable?(exe)
+        end
+
+        nil
+      end
+
+      def search_paths
+        ENV["PATH"].split(File::PATH_SEPARATOR)
+      end
+
+      def executable_file_extensions
+        ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      end
+
+      def real_executable?(file)
+        File.executable?(file) && !File.directory?(file)
+      end
+    end
+  end
+end

data/lib/byebug/helpers/eval.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #
@@ -56,27 +58,27 @@ module Byebug
       private
 
       def safe_eval(str, binding)
-        binding.eval(str.gsub(/\Aeval /, ''), '(byebug)', 1)
+        binding.eval(str.gsub(/\Aeval /, ""), "(byebug)", 1)
       rescue StandardError, ScriptError => e
         yield(e)
       end
 
-      def msg(e)
-        msg = Setting[:stack_on_error] ? error_msg(e) : warning_msg(e)
+      def msg(exception)
+        msg = Setting[:stack_on_error] ? error_msg(exception) : warning_msg(exception)
 
-        pr('eval.exception', text_message: msg)
+        pr("eval.exception", text_message: msg)
       end
 
-      def error_msg(e)
-        at = e.backtrace
+      def error_msg(exception)
+        at = exception.backtrace
 
-        locations = ["#{at.shift}: #{warning_msg(e)}"]
+        locations = ["#{at.shift}: #{warning_msg(exception)}"]
         locations += at.map { |path| "  from #{path}" }
         locations.join("\n")
       end
 
-      def warning_msg(e)
-        "#{e.class} Exception: #{e.message}"
+      def warning_msg(exception)
+        "#{exception.class} Exception: #{exception.message}"
       end
 
       #
@@ -98,7 +100,7 @@ module Byebug
 
       #
       # Runs the given block in a new thread, waits for it to finish and
-      # returns the new thred's result.
+      # returns the new thread's result.
       #
       def in_new_thread
         res = nil
@@ -110,14 +112,14 @@ module Byebug
 
       def safe_inspect(var)
         var.inspect
-      rescue
+      rescue StandardError
         safe_to_s(var)
       end
 
       def safe_to_s(var)
         var.to_s
-      rescue
-        '*Error in evaluation*'
+      rescue StandardError
+        "*Error in evaluation*"
       end
     end
   end

data/lib/byebug/helpers/file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #
@@ -8,7 +10,7 @@ module Byebug
       # Reads lines of source file +filename+ into an array
       #
       def get_lines(filename)
-        File.foreach(filename).reduce([]) { |a, e| a << e.chomp }
+        File.foreach(filename).reduce([]) { |acc, elem| acc << elem.chomp }
       end
 
       #
@@ -26,7 +28,7 @@ module Byebug
       # one-line-at-a-time way.
       #
       def n_lines(filename)
-        File.foreach(filename).reduce(0) { |a, _e| a + 1 }
+        File.foreach(filename).reduce(0) { |acc, _elem| acc + 1 }
       end
 
       #
@@ -47,14 +49,14 @@ module Byebug
         components = Pathname(fullpath).each_filename.to_a
         return fullpath if components.size <= 2
 
-        File.join('...', components[-3..-1])
+        File.join("...", components[-3..-1])
       end
 
       #
       # True for special files like -e, false otherwise
       #
       def virtual_file?(name)
-        ['(irb)', '-e', '(byebug)', '(eval)'].include?(name)
+        ["(irb)", "-e", "(byebug)", "(eval)"].include?(name)
       end
     end
   end

data/lib/byebug/helpers/frame.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #
@@ -6,7 +8,7 @@ module Byebug
     module FrameHelper
       def switch_to_frame(frame)
         new_frame = index_from_start(frame)
-        return frame_err('c_frame') if Frame.new(context, new_frame).c_frame?
+        return frame_err("c_frame") if Frame.new(context, new_frame).c_frame?
 
         adjust_frame(new_frame)
       end
@@ -18,8 +20,8 @@ module Byebug
       private
 
       def adjust_frame(new_frame)
-        return frame_err('too_low') if new_frame >= context.stack_size
-        return frame_err('too_high') if new_frame < 0
+        return frame_err("too_low") if new_frame >= context.stack_size
+        return frame_err("too_high") if new_frame.negative?
 
         context.frame = new_frame
         processor.prev_line = nil
@@ -65,8 +67,8 @@ module Byebug
       #
       # @param i [Integer] Integer to be converted in a proper positive index.
       #
-      def index_from_start(i)
-        i >= 0 ? i : context.stack_size + i
+      def index_from_start(index)
+        index >= 0 ? index : context.stack_size + index
       end
     end
   end

data/lib/byebug/helpers/parse.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #
@@ -13,16 +15,14 @@ module Byebug
       # purpose.
       #
       def get_int(str, cmd, min = nil, max = nil)
-        if str !~ /\A-?[0-9]+\z/
-          return nil, pr('parse.errors.int.not_number', cmd: cmd, str: str)
-        end
+        return nil, pr("parse.errors.int.not_number", cmd: cmd, str: str) unless /\A-?[0-9]+\z/.match?(str)
 
         int = str.to_i
         if min && int < min
-          err = pr('parse.errors.int.too_low', cmd: cmd, str: str, min: min)
+          err = pr("parse.errors.int.too_low", cmd: cmd, str: str, min: min)
           return nil, err
         elsif max && int > max
-          err = pr('parse.errors.int.too_high', cmd: cmd, str: str, max: max)
+          err = pr("parse.errors.int.too_high", cmd: cmd, str: str, max: max)
           return nil, err
         end
 

data/lib/byebug/helpers/path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #
@@ -5,27 +7,23 @@ module Byebug
     #
     module PathHelper
       def bin_file
-        @bin_file ||= Gem.bin_path('byebug', 'byebug')
+        @bin_file ||= File.join(root_path, "exe", "byebug")
       end
 
       def root_path
-        @root_path ||= File.expand_path('../..', bin_file)
+        @root_path ||= File.expand_path(File.join("..", "..", ".."), __dir__)
       end
 
       def lib_files
-        @lib_files ||= expand_from_root('lib/**/*.{rb,yml}')
-      end
-
-      def ext_files
-        @ext_files ||= expand_from_root('ext/**/*.{c,h,rb}')
+        @lib_files ||= glob_for("lib")
       end
 
       def test_files
-        @test_files ||= expand_from_root('test/**/*.rb')
+        @test_files ||= glob_for("test")
       end
 
       def gem_files
-        @gem_files ||= [bin_file] + lib_files + ext_files
+        @gem_files ||= [bin_file] + lib_files
       end
 
       def all_files
@@ -34,8 +32,8 @@ module Byebug
 
       private
 
-      def expand_from_root(glob)
-        Dir.glob(File.expand_path(glob, root_path))
+      def glob_for(dir)
+        Dir.glob(File.join(root_path, dir, "**", "*.rb"))
       end
     end
   end

data/lib/byebug/helpers/reflection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #

data/lib/byebug/helpers/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #
@@ -9,7 +11,7 @@ module Byebug
       # ACamelizedString.
       #
       def camelize(str)
-        str.dup.split(/[_-]/).map(&:capitalize).join('')
+        str.dup.split(/[_-]/).map(&:capitalize).join("")
       end
 
       #
@@ -17,7 +19,14 @@ module Byebug
       # command prompt.
       #
       def prettify(str)
-        "\n" + str.gsub(/^ {6}/, '') + "\n"
+        "\n" + deindent(str) + "\n"
+      end
+
+      #
+      # Removes a number of leading whitespace for each input line.
+      #
+      def deindent(str, leading_spaces: 6)
+        str.gsub(/^ {#{leading_spaces}}/, "")
       end
     end
   end

data/lib/byebug/helpers/thread.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Byebug
   module Helpers
     #
@@ -5,7 +7,7 @@ module Byebug
     #
     module ThreadHelper
       def display_context(ctx)
-        puts pr('thread.context', thread_arguments(ctx))
+        puts pr("thread.context", thread_arguments(ctx))
       end
 
       def thread_arguments(ctx)
@@ -29,11 +31,11 @@ module Byebug
         ctx = Byebug.contexts.find { |c| c.thnum.to_s == thnum }
 
         err = if ctx.nil?
-                pr('thread.errors.no_thread')
+                pr("thread.errors.no_thread")
               elsif ctx == context
-                pr('thread.errors.current_thread')
+                pr("thread.errors.current_thread")
               elsif ctx.ignored?
-                pr('thread.errors.ignored', arg: thnum)
+                pr("thread.errors.ignored", arg: thnum)
               end
 
         [ctx, err]
@@ -46,19 +48,19 @@ module Byebug
         return context.location if ctx == Byebug.current_context
 
         backtrace = ctx.thread.backtrace_locations
-        return '' unless backtrace && backtrace[0]
+        return "" unless backtrace && backtrace[0]
 
         "#{backtrace[0].path}:#{backtrace[0].lineno}"
       end
 
       def status_flag(ctx)
-        return '$' if ctx.suspended?
+        return "$" if ctx.suspended?
 
-        current_thread?(ctx) ? '+' : ' '
+        current_thread?(ctx) ? "+" : " "
       end
 
       def debug_flag(ctx)
-        ctx.ignored? ? '!' : ' '
+        ctx.ignored? ? "!" : " "
       end
     end
   end

data/lib/byebug/helpers/toggle.rb

@@ -1,4 +1,6 @@
-require 'byebug/helpers/parse'
+# frozen_string_literal: true
+
+require_relative "parse"
 
 module Byebug
   module Helpers
@@ -9,50 +11,49 @@ module Byebug
       include ParseHelper
 
       def enable_disable_breakpoints(is_enable, args)
-        return errmsg(pr('toggle.errors.no_breakpoints')) if Breakpoint.none?
-
-        all_breakpoints = Byebug.breakpoints.sort_by(&:id)
-        if args.nil?
-          selected_breakpoints = all_breakpoints
-        else
-          selected_ids = []
-          args.split(/ +/).each do |pos|
-            last_id = all_breakpoints.last.id
-            pos, err = get_int(pos, "#{is_enable} breakpoints", 1, last_id)
-            return errmsg(err) unless pos
-
-            selected_ids << pos
-          end
-          selected_breakpoints = all_breakpoints.select do |b|
-            selected_ids.include?(b.id)
-          end
-        end
+        raise pr("toggle.errors.no_breakpoints") if Breakpoint.none?
 
-        selected_breakpoints.each do |b|
-          enabled = ('enable' == is_enable)
-          if enabled && !syntax_valid?(b.expr)
-            return errmsg(pr('toggle.errors.expression', expr: b.expr))
-          end
+        select_breakpoints(is_enable, args).each do |b|
+          enabled = (is_enable == "enable")
+          raise pr("toggle.errors.expression", expr: b.expr) if enabled && !syntax_valid?(b.expr)
 
+          puts pr("toggle.messages.toggled", bpnum: b.id,
+                                             endis: enabled ? "en" : "dis")
           b.enabled = enabled
         end
       end
 
       def enable_disable_display(is_enable, args)
-        return errmsg(pr('toggle.errors.no_display')) if 0 == n_displays
+        raise pr("toggle.errors.no_display") if n_displays.zero?
 
         selected_displays = args ? args.split(/ +/) : [1..n_displays + 1]
 
         selected_displays.each do |pos|
           pos, err = get_int(pos, "#{is_enable} display", 1, n_displays)
-          return errmsg(err) unless err.nil?
+          raise err unless err.nil?
 
-          Byebug.displays[pos - 1][0] = ('enable' == is_enable)
+          Byebug.displays[pos - 1][0] = (is_enable == "enable")
         end
       end
 
       private
 
+      def select_breakpoints(is_enable, args)
+        all_breakpoints = Byebug.breakpoints.sort_by(&:id)
+        return all_breakpoints if args.nil?
+
+        selected_ids = []
+        args.split(/ +/).each do |pos|
+          last_id = all_breakpoints.last.id
+          pos, err = get_int(pos, "#{is_enable} breakpoints", 1, last_id)
+          raise(ArgumentError, err) unless pos
+
+          selected_ids << pos
+        end
+
+        all_breakpoints.select { |b| selected_ids.include?(b.id) }
+      end
+
       def n_displays
         Byebug.displays.size
       end

data/lib/byebug/helpers/var.rb

@@ -1,4 +1,6 @@
-require 'byebug/helpers/eval'
+# frozen_string_literal: true
+
+require_relative "eval"
 
 module Byebug
   module Helpers
@@ -13,19 +15,19 @@ module Byebug
           [name, safe_inspect(silent_eval(name.to_s, binding))]
         end
 
-        puts prv(vars, 'instance')
+        puts prv(vars, "instance")
       end
 
       def var_global
         globals = global_variables.reject do |v|
-          [:$IGNORECASE, :$=, :$KCODE, :$-K, :$binding].include?(v)
+          %i[$IGNORECASE $= $KCODE $-K $binding].include?(v)
         end
 
         var_list(globals)
       end
 
       def var_instance(str)
-        obj = warning_eval(str || 'self')
+        obj = warning_eval(str || "self")
 
         var_list(obj.instance_variables, obj.instance_eval { binding })
       end
@@ -33,8 +35,8 @@ module Byebug
       def var_local
         locals = context.frame.locals
         cur_self = context.frame._self
-        locals[:self] = cur_self unless cur_self.to_s == 'main'
-        puts prv(locals.keys.sort.map { |k| [k, locals[k]] }, 'instance')
+        locals[:self] = cur_self unless cur_self.to_s == "main"
+        puts prv(locals.keys.sort.map { |k| [k, locals[k]] }, "instance")
       end
 
       def var_args
@@ -45,7 +47,7 @@ module Byebug
         arg_values = args.map { |arg| arg[1] }
 
         locals = all_locals.select { |k, _| arg_values.include?(k) }
-        puts prv(locals.keys.sort.map { |k| [k, locals[k]] }, 'instance')
+        puts prv(locals.keys.sort.map { |k| [k, locals[k]] }, "instance")
       end
     end
   end

data/lib/byebug/history.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 begin
-  require 'readline'
+  require "readline"
 rescue LoadError
-  warn <<-EOW
+  warn <<-MESSAGE
     Sorry, you can't use byebug without Readline. To solve this, you need to
     rebuild Ruby with Readline support. If using Ubuntu, try `sudo apt-get
     install libreadline-dev` and then reinstall your Ruby.
-  EOW
+  MESSAGE
 
   raise
 end
@@ -21,6 +23,13 @@ module Byebug
       self.size = 0
     end
 
+    #
+    # Array holding the list of commands in history
+    #
+    def buffer
+      Readline::HISTORY.to_a
+    end
+
     #
     # Restores history from disk.
     #
@@ -36,7 +45,7 @@ module Byebug
     def save
       n_cmds = Setting[:histsize] > size ? size : Setting[:histsize]
 
-      open(Setting[:histfile], 'w') do |file|
+      File.open(Setting[:histfile], "w") do |file|
         n_cmds.times { file.puts(pop) }
       end
 
@@ -74,18 +83,18 @@ module Byebug
     def to_s(n_cmds)
       show_size = n_cmds ? specific_max_size(n_cmds) : default_max_size
 
-      commands = Readline::HISTORY.to_a.last(show_size)
+      commands = buffer.last(show_size)
 
       last_ids(show_size).zip(commands).map do |l|
-        format('%5d  %s', l[0], l[1])
+        format("%<position>5d  %<command>s", position: l[0], command: l[1])
       end.join("\n") + "\n"
     end
 
     #
-    # Array of ids of the last n commands.
+    # Array of ids of the last +number+ commands.
     #
-    def last_ids(n)
-      (1 + size - n..size).to_a
+    def last_ids(number)
+      (1 + size - number..size).to_a
     end
 
     #
@@ -112,10 +121,10 @@ module Byebug
     # For now, empty lines and consecutive duplicates.
     #
     def ignore?(buf)
-      return true if /^\s*$/ =~ buf
+      return true if /^\s*$/.match?(buf)
       return false if Readline::HISTORY.empty?
 
-      Readline::HISTORY[Readline::HISTORY.length - 1] == buf
+      buffer[Readline::HISTORY.length - 1] == buf
     end
   end
 end