byebug 8.2.5 → 9.1.0

data/lib/byebug/core.rb

@@ -47,13 +47,11 @@ module Byebug
   # are debugging, in the directory where you invoke byebug.
   #
   def run_init_script
-    run_rc_file(ENV['HOME'])
-
-    run_rc_file(Dir.pwd) unless Dir.pwd == ENV['HOME']
+    rc_dirs.each { |dir| run_rc_file(dir) }
   end
 
   def self.load_settings
-    Dir.glob(File.expand_path('../settings/*.rb', __FILE__)).each do |file|
+    Dir.glob(File.join(__dir__, 'settings', '*.rb')).each do |file|
       require file
     end
 
@@ -94,6 +92,15 @@ module Byebug
   ensure
     Context.interface = old_interface
   end
+
+  #
+  # List of folders to load rc files from
+  #
+  # @note Files will be loaded in the order specified here.
+  #
+  def rc_dirs
+    [ENV['HOME'], Dir.pwd].compact.uniq
+  end
 end
 
 Byebug.load_settings

data/lib/byebug/frame.rb

@@ -47,13 +47,13 @@ module Byebug
     #
     # Gets local variables for the frame.
     #
-    # TODO: Use brand new local_variable_get, local_variable_set and
-    # local_variable defined for rubies >= 2.1
-    #
     def locals
       return [] unless _binding
 
-      _binding.eval('local_variables.inject({}){|h, v| h[v] = eval(v.to_s); h}')
+      _binding.local_variables.each_with_object({}) do |e, a|
+        a[e] = _binding.local_variable_get(e)
+        a
+      end
     end
 
     #
@@ -158,14 +158,14 @@ module Byebug
     def c_args
       return [] unless _self.to_s != 'main'
 
-      _self.method(_method).parameters
+      _class.instance_method(_method).parameters
     end
 
     def ruby_args
       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

data/lib/byebug/helpers/bin.rb

@@ -0,0 +1,26 @@
+module Byebug
+  module Helpers
+    #
+    # Utilities for interaction with executables
+    #
+    module BinHelper
+      #
+      # Cross-platform way of finding an executable in the $PATH.
+      # Borrowed from: http://stackoverflow.com/questions/2108727
+      #
+      def which(cmd)
+        return File.expand_path(cmd) if File.exist?(cmd)
+
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable?(exe) && !File.directory?(exe)
+          end
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/byebug/helpers/file.rb

@@ -8,7 +8,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 +26,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
 
       #
@@ -54,7 +54,7 @@ module Byebug
       # True for special files like -e, false otherwise
       #
       def virtual_file?(name)
-        ['(irb)', '-e', '(byebug)'].include?(name)
+        ['(irb)', '-e', '(byebug)', '(eval)'].include?(name)
       end
     end
   end

data/lib/byebug/helpers/parse.rb

@@ -9,7 +9,7 @@ module Byebug
       #
       # If either +min+ or +max+ is nil, that value has no bound.
       #
-      # TODO: Remove the `cmd` parameter. It has nothing to do with the method's
+      # @todo Remove the `cmd` parameter. It has nothing to do with the method's
       # purpose.
       #
       def get_int(str, cmd, min = nil, max = nil)

data/lib/byebug/helpers/path.rb

@@ -5,27 +5,23 @@ module Byebug
     #
     module PathHelper
       def bin_file
-        @bin_file ||= Gem.bin_path('byebug', 'byebug')
+        @bin_file ||= File.join(root_path, 'bin', '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 +30,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/string.rb

@@ -17,7 +17,17 @@ 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.
+      #
+      # @note Might be unnecessary when Ruby 2.2 support is dropped and we can
+      # use squiggly heredoc's.
+      #
+      def deindent(str, leading_spaces: 6)
+        str.gsub(/^ {#{leading_spaces}}/, '')
       end
     end
   end

data/lib/byebug/helpers/thread.rb

@@ -28,10 +28,12 @@ module Byebug
       def context_from_thread(thnum)
         ctx = Byebug.contexts.find { |c| c.thnum.to_s == thnum }
 
-        err = case
-              when ctx.nil? then pr('thread.errors.no_thread')
-              when ctx == context then pr('thread.errors.current_thread')
-              when ctx.ignored? then pr('thread.errors.ignored', arg: thnum)
+        err = if ctx.nil?
+                pr('thread.errors.no_thread')
+              elsif ctx == context
+                pr('thread.errors.current_thread')
+              elsif ctx.ignored?
+                pr('thread.errors.ignored', arg: thnum)
               end
 
         [ctx, err]
@@ -39,7 +41,7 @@ module Byebug
 
       private
 
-      # TODO: Check whether it is Byebug.current_context or context
+      # @todo Check whether it is Byebug.current_context or context
       def location(ctx)
         return context.location if ctx == Byebug.current_context
 

data/lib/byebug/helpers/toggle.rb

@@ -9,50 +9,51 @@ module Byebug
       include ParseHelper
 
       def enable_disable_breakpoints(is_enable, args)
-        return errmsg(pr('toggle.errors.no_breakpoints')) if Breakpoint.none?
+        raise 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
-
-        selected_breakpoints.each do |b|
-          enabled = ('enable' == is_enable)
+        select_breakpoints(is_enable, args).each do |b|
+          enabled = (is_enable == 'enable')
           if enabled && !syntax_valid?(b.expr)
-            return errmsg(pr('toggle.errors.expression', expr: b.expr))
+            raise pr('toggle.errors.expression', expr: b.expr)
           end
 
+          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

@@ -18,7 +18,7 @@ module Byebug
 
       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)

data/lib/byebug/history.rb

@@ -21,6 +21,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.
     #
@@ -74,7 +81,7 @@ 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])
@@ -115,7 +122,7 @@ module Byebug
       return true if /^\s*$/ =~ buf
       return false if Readline::HISTORY.empty?
 
-      Readline::HISTORY[Readline::HISTORY.length - 1] == buf
+      buffer[Readline::HISTORY.length - 1] == buf
     end
   end
 end

data/lib/byebug/interface.rb

@@ -86,6 +86,9 @@ module Byebug
       output.puts(message)
     end
 
+    #
+    # Prints an output message to the output stream without a final "\n".
+    #
     def print(message)
       output.print(message)
     end

data/lib/byebug/interfaces/local_interface.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Byebug
   #
   # Interface class for standard byebug use.
@@ -8,9 +9,9 @@ module Byebug
 
     def initialize
       super()
-      @input = STDIN
-      @output = STDOUT
-      @error = STDERR
+      @input = $stdin
+      @output = $stdout
+      @error = $stderr
     end
 
     #
@@ -20,9 +21,7 @@ module Byebug
     # @param prompt Prompt to be displayed.
     #
     def readline(prompt)
-      with_repl_like_sigint do
-        Readline.readline(prompt, false) || EOF_ALIAS
-      end
+      with_repl_like_sigint { Readline.readline(prompt) || EOF_ALIAS }
     end
 
     #

data/lib/byebug/interfaces/script_interface.rb

@@ -5,9 +5,10 @@ module Byebug
   class ScriptInterface < Interface
     def initialize(file, verbose = false)
       super()
+      @verbose = verbose
       @input = File.open(file)
-      @output = verbose ? STDOUT : StringIO.new
-      @error = verbose ? STDERR : StringIO.new
+      @output = verbose ? $stdout : StringIO.new
+      @error = $stderr
     end
 
     def read_command(prompt)
@@ -20,7 +21,7 @@ module Byebug
 
     def readline(*)
       while (result = input.gets)
-        output.puts "+ #{result}"
+        output.puts "+ #{result}" if @verbose
         next if result =~ /^\s*#/
         return result.chomp
       end

data/lib/byebug/printers/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'yaml'
 
 module Byebug
@@ -61,7 +62,7 @@ module Byebug
       end
 
       def contents_files
-        [File.expand_path(File.join('..', 'texts', 'base.yml'), __FILE__)]
+        [File.join(__dir__, 'texts', 'base.yml')]
       end
     end
   end

data/lib/byebug/printers/plain.rb

@@ -35,8 +35,7 @@ module Byebug
       private
 
       def contents_files
-        [File.expand_path(File.join('..', 'texts', 'plain.yml'), __FILE__)] +
-          super
+        [File.join(__dir__, 'texts', 'plain.yml')] + super
       end
     end
   end

data/lib/byebug/printers/texts/base.yml

@@ -16,6 +16,8 @@ break:
     not_changed: "Incorrect expression \"{expr}\", breakpoint not changed"
   confirmations:
     delete_all: "Delete all breakpoints?"
+  messages:
+    breakpoint_deleted: "Deleted breakpoint {pos}"
 
 catch:
   added: "Catching exception {exception}."
@@ -97,6 +99,8 @@ toggle:
     no_display: "No display expressions have been set"
     syntax: "\"{toggle}\" must be followed by \"display\", \"breakpoints\" or breakpoint ids"
     expression: "Expression \"{expr}\" syntactically incorrect; breakpoint remains disabled."
+  messages:
+    toggled: "Breakpoint {bpnum} {endis}abled"
 
 parse:
   errors:

data/lib/byebug/printers/texts/plain.yml

@@ -1,5 +1,5 @@
 break:
-  created: "Successfully created breakpoint with id {id}"
+  created: "Created breakpoint {id} at {file}:{line}"
 
 display:
   result: "{n}: {exp} = {result}"

data/lib/byebug/processors/command_processor.rb

@@ -109,21 +109,6 @@ module Byebug
       '(byebug) '
     end
 
-    private
-
-    def auto_cmds_for(run_level)
-      command_list.select { |cmd| cmd.always_run >= run_level }
-    end
-
-    #
-    # Run permanent commands.
-    #
-    def run_auto_cmds(run_level)
-      safely do
-        auto_cmds_for(run_level).each { |cmd| cmd.new(self).execute }
-      end
-    end
-
     def before_repl
       @proceed = false
       @prev_line = nil
@@ -150,6 +135,21 @@ module Byebug
       end
     end
 
+    private
+
+    def auto_cmds_for(run_level)
+      command_list.select { |cmd| cmd.always_run >= run_level }
+    end
+
+    #
+    # Run permanent commands.
+    #
+    def run_auto_cmds(run_level)
+      safely do
+        auto_cmds_for(run_level).each { |cmd| cmd.new(self).execute }
+      end
+    end
+
     #
     # Executes the received input
     #

data/lib/byebug/processors/script_processor.rb

@@ -12,25 +12,19 @@ module Byebug
       super.select(&:allow_in_control)
     end
 
-    def process_commands
+    def repl
       while (input = interface.read_command(prompt))
-        command = command_list.match(input)
+        safely do
+          command = command_list.match(input)
+          raise CommandNotFound.new(input) unless command
 
-        if command
           command.new(self, input).execute
-        else
-          errmsg('Unknown command')
         end
       end
+    end
 
+    def after_repl
       interface.close
-    rescue IOError, SystemCallError
-      interface.close
-    rescue
-      without_exceptions do
-        puts "INTERNAL ERROR!!! #{$ERROR_INFO}"
-        puts $ERROR_INFO.backtrace.map { |l| "  #{l}" }.join("\n")
-      end
     end
 
     #

data/lib/byebug/remote.rb

@@ -1,9 +1,10 @@
 require 'socket'
+require 'byebug/processors/control_processor'
 
 #
 # Remote debugging functionality.
 #
-# TODO: Refactor & add tests
+# @todo Refactor & add tests
 #
 module Byebug
   # Port number used for remote debugging
@@ -33,9 +34,7 @@ module Byebug
       Context.interface = nil
       start
 
-      start_control(host, port == 0 ? 0 : port + 1)
-
-      yield if block_given?
+      start_control(host, port.zero? ? 0 : port + 1)
 
       mutex = Mutex.new
       proceed = ConditionVariable.new
@@ -43,6 +42,8 @@ module Byebug
       server = TCPServer.new(host, port)
       self.actual_port = server.addr[1]
 
+      yield if block_given?
+
       @thread = DebugThread.new do
         while (session = server.accept)
           Context.interface = RemoteInterface.new(session)
@@ -73,27 +74,26 @@ module Byebug
     # Connects to the remote byebug
     #
     def start_client(host = 'localhost', port = PORT)
-      Context.interface = LocalInterface.new
+      interface = LocalInterface.new
       puts 'Connecting to byebug server...'
       socket = TCPSocket.new(host, port)
       puts 'Connected.'
 
-      catch(:exit) do
-        while (line = socket.gets)
-          case line
-          when /^PROMPT (.*)$/
-            input = Context.interface.read_command(Regexp.last_match[1])
-            throw :exit unless input
-            socket.puts input
-          when /^CONFIRM (.*)$/
-            input = Context.interface.confirm(Regexp.last_match[1])
-            throw :exit unless input
-            socket.puts input
-          else
-            puts line
-          end
+      while (line = socket.gets)
+        case line
+        when /^PROMPT (.*)$/
+          input = interface.read_command(Regexp.last_match[1])
+          break unless input
+          socket.puts input
+        when /^CONFIRM (.*)$/
+          input = interface.readline(Regexp.last_match[1])
+          break unless input
+          socket.puts input
+        else
+          puts line
         end
       end
+
       socket.close
     end