debug 1.6.3 → 1.7.0

data/lib/debug/source_repository.rb

@@ -6,6 +6,22 @@ module DEBUGGER__
   class SourceRepository
     include Color
 
+    def file_src iseq
+      if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
+        File.readlines(path, chomp: true)
+      end
+    end
+
+    def get iseq
+      return unless iseq
+
+      if CONFIG[:show_evaledsrc]
+        orig_src(iseq) || file_src(iseq)
+      else
+        file_src(iseq) || orig_src(iseq)
+      end
+    end
+
     if RubyVM.respond_to? :keep_script_lines
       # Ruby 3.1 and later
       RubyVM.keep_script_lines = true
@@ -29,17 +45,13 @@ module DEBUGGER__
         end
       end
 
-      def get iseq
-        return unless iseq
-
-        if lines = iseq.script_lines&.map(&:chomp)
-          lines
+      def orig_src iseq
+        lines = iseq.script_lines&.map(&:chomp)
+        line = iseq.first_line
+        if line > 1
+          lines = [*([''] * (line - 1)), *lines]
         else
-          if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
-            File.readlines(path, chomp: true)
-          else
-            nil
-          end
+          lines
         end
       end
 
@@ -63,15 +75,22 @@ module DEBUGGER__
       end
 
       def add iseq, src
-        if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
+        path = (iseq.absolute_path || iseq.path)
+
+        if path && File.exist?(path)
           reloaded = @files.has_key? path
-          add_path path
-          return path, reloaded
-        elsif src
+
+          if src
+            add_iseq iseq, src
+            return path, reloaded
+          else
+            add_path path
+            return path, reloaded
+          end
+        else
           add_iseq iseq, src
+          nil
         end
-
-        nil
       end
 
       private def all_iseq iseq, rs = []
@@ -87,7 +106,8 @@ module DEBUGGER__
         if line > 1
           src = ("\n" * (line - 1)) + src
         end
-        si = SrcInfo.new(src.lines)
+
+        si = SrcInfo.new(src.each_line.map{|l| l.chomp})
         all_iseq(iseq).each{|e|
           e.instance_variable_set(:@debugger_si, si)
           e.freeze
@@ -102,7 +122,7 @@ module DEBUGGER__
 
       private def get_si iseq
         return unless iseq
-      
+
         if iseq.instance_variable_defined?(:@debugger_si)
           iseq.instance_variable_get(:@debugger_si)
         elsif @files.has_key?(path = (iseq.absolute_path || iseq.path))
@@ -112,7 +132,7 @@ module DEBUGGER__
         end
       end
 
-      def get iseq
+      def orig_src iseq
         if si = get_si(iseq)
           si.src
         end

data/lib/debug/start.rb

@@ -2,4 +2,4 @@
 
 require_relative 'session'
 return unless defined?(DEBUGGER__)
-DEBUGGER__.start
+DEBUGGER__.start no_sigint_hook: false

data/lib/debug/thread_client.rb

@@ -18,7 +18,7 @@ module DEBUGGER__
   module SkipPathHelper
     def skip_path?(path)
       !path ||
-      CONFIG.skip? ||
+      DEBUGGER__.skip? ||
       ThreadClient.current.management? ||
       skip_internal_path?(path) ||
       skip_config_skip_path?(path)
@@ -291,8 +291,10 @@ module DEBUGGER__
       end
 
       if event != :pause
-        show_src
-        show_frames CONFIG[:show_frames]
+        unless bp&.skip_src
+          show_src
+          show_frames CONFIG[:show_frames]
+        end
 
         set_mode :waiting
 
@@ -328,11 +330,15 @@ module DEBUGGER__
       @step_tp.disable if @step_tp
 
       thread = Thread.current
+      subsession_id = SESSION.subsession_id
 
       if SUPPORT_TARGET_THREAD
         @step_tp = TracePoint.new(*events){|tp|
-          next if SESSION.break_at? tp.path, tp.lineno
-          next if !yield(tp.event)
+          if SESSION.stop_stepping? tp.path, tp.lineno, subsession_id
+            tp.disable
+            next
+          end
+          next if !yield(tp)
           next if tp.path.start_with?(__dir__)
           next if tp.path.start_with?('<internal:trace_point>')
           next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
@@ -347,8 +353,11 @@ module DEBUGGER__
       else
         @step_tp = TracePoint.new(*events){|tp|
           next if thread != Thread.current
-          next if SESSION.break_at? tp.path, tp.lineno
-          next if !yield(tp.event)
+          if SESSION.stop_stepping? tp.path, tp.lineno, subsession_id
+            tp.disable
+            next
+          end
+          next if !yield(tp)
           next if tp.path.start_with?(__dir__)
           next if tp.path.start_with?('<internal:trace_point>')
           next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
@@ -384,15 +393,19 @@ module DEBUGGER__
       end
     end
 
-    def frame_eval_core src, b
+    def frame_eval_core src, b, binding_location: false
       saved_target_frames = @target_frames
       saved_current_frame_index = @current_frame_index
 
       if b
-        f, _l = b.source_location
+        file, lineno = b.source_location
 
         tp_allow_reentry do
-          b.eval(src, "(rdbg)/#{f}")
+          if binding_location
+            b.eval(src, file, lineno)
+          else
+            b.eval(src, "(rdbg)/#{file}")
+          end
         end
       else
         frame_self = current_frame.self
@@ -411,16 +424,16 @@ module DEBUGGER__
       [:return_value,     "_return"],
     ]
 
-    def frame_eval src, re_raise: false
+    def frame_eval src, re_raise: false, binding_location: false
       @success_last_eval = false
 
-      b = current_frame.eval_binding
+      b = current_frame&.eval_binding || TOPLEVEL_BINDING
 
       special_local_variables current_frame do |name, var|
         b.local_variable_set(name, var) if /\%/ !~ name
       end
 
-      result = frame_eval_core(src, b)
+      result = frame_eval_core(src, b, binding_location: binding_location)
 
       @success_last_eval = true
       result
@@ -482,19 +495,28 @@ module DEBUGGER__
       exit!
     end
 
-    def show_src(frame_index: @current_frame_index, update_line: false, max_lines: CONFIG[:show_src_lines], **options)
+    def show_src(frame_index: @current_frame_index, update_line: false, ignore_show_line: false, max_lines: CONFIG[:show_src_lines], **options)
       if frame = get_frame(frame_index)
-        start_line, end_line, lines = *get_src(frame, max_lines: max_lines, **options)
-
-        if start_line
-          if update_line
-            frame.show_line = end_line
+        begin
+          if ignore_show_line
+            prev_show_line = frame.show_line
+            frame.show_line = nil
           end
 
-          puts "[#{start_line+1}, #{end_line}] in #{frame.pretty_path}" if !update_line && max_lines != 1
-          puts lines[start_line...end_line]
-        else
-          puts "# No sourcefile available for #{frame.path}"
+          start_line, end_line, lines = *get_src(frame, max_lines: max_lines, **options)
+
+          if start_line
+            if update_line
+              frame.show_line = end_line
+            end
+
+            puts "[#{start_line+1}, #{end_line}] in #{frame.pretty_path}" if !update_line && max_lines != 1
+            puts lines[start_line...end_line]
+          else
+            puts "# No sourcefile available for #{frame.path}"
+          end
+        ensure
+          frame.show_line = prev_show_line if prev_show_line
         end
       end
     end
@@ -546,27 +568,55 @@ module DEBUGGER__
       end
     end
 
-    def show_ivars pat
-      if s = current_frame&.self
-        M_INSTANCE_VARIABLES.bind_call(s).sort.each{|iv|
-          value = M_INSTANCE_VARIABLE_GET.bind_call(s, iv)
+    def show_ivars pat, expr = nil
+      if expr && !expr.empty?
+        _self = frame_eval(expr);
+      elsif _self = current_frame&.self
+      else
+        _self = nil
+      end
+
+      if _self
+        M_INSTANCE_VARIABLES.bind_call(_self).sort.each{|iv|
+          value = M_INSTANCE_VARIABLE_GET.bind_call(_self, iv)
           puts_variable_info iv, value, pat
         }
       end
     end
 
-    def show_consts pat, only_self: false
-      if s = current_frame&.self
+    def iter_consts c, names = {}
+      c.constants(false).sort.each{|name|
+        next if names.has_key? name
+        names[name] = nil
+        begin
+          value = c.const_get(name)
+        rescue Exception => e
+          value = e
+        end
+        yield name, value
+      }
+    end
+
+    def get_consts expr = nil, only_self: false, &block
+      if expr && !expr.empty?
+        _self = frame_eval(expr)
+        if M_KIND_OF_P.bind_call(_self, Module)
+          iter_consts _self, &block
+          return
+        else
+          raise "#{_self.inspect} (by #{expr}) is not a Module."
+        end
+      elsif _self = current_frame&.self
         cs = {}
-        if M_KIND_OF_P.bind_call(s, Module)
-          cs[s] = :self
+        if M_KIND_OF_P.bind_call(_self, Module)
+          cs[_self] = :self
         else
-          s = M_CLASS.bind_call(s)
-          cs[s] = :self unless only_self
+          _self = M_CLASS.bind_call(_self)
+          cs[_self] = :self unless only_self
         end
 
         unless only_self
-          s.ancestors.each{|c| break if c == Object; cs[c] = :ancestors}
+          _self.ancestors.each{|c| break if c == Object; cs[c] = :ancestors}
           if b = current_frame&.binding
             b.eval('::Module.nesting').each{|c| cs[c] = :nesting unless cs.has_key? c}
           end
@@ -575,16 +625,17 @@ module DEBUGGER__
         names = {}
 
         cs.each{|c, _|
-          c.constants(false).sort.each{|name|
-            next if names.has_key? name
-            names[name] = nil
-            value = c.const_get(name)
-            puts_variable_info name, value, pat
-          }
+          iter_consts c, names, &block
         }
       end
     end
 
+    def show_consts pat, expr = nil, only_self: false
+      get_consts expr, only_self: only_self do |name, value|
+        puts_variable_info name, value, pat
+      end
+    end
+
     SKIP_GLOBAL_LIST = %i[$= $KCODE $-K $SAFE].freeze
     def show_globals pat
       global_variables.sort.each{|name|
@@ -643,7 +694,8 @@ module DEBUGGER__
         if editor = (ENV['RUBY_DEBUG_EDITOR'] || ENV['EDITOR'])
           puts "command: #{editor}"
           puts "   path: #{path}"
-          system(editor, path)
+          require 'shellwords'
+          system(*Shellwords.split(editor), path)
         else
           puts "can not find editor setting: ENV['RUBY_DEBUG_EDITOR'] or ENV['EDITOR']"
         end
@@ -758,7 +810,7 @@ module DEBUGGER__
       case args.first
       when :method
         klass_name, op, method_name, cond, cmd, path = args[1..]
-        bp = MethodBreakpoint.new(current_frame.eval_binding, klass_name, op, method_name, cond: cond, command: cmd, path: path)
+        bp = MethodBreakpoint.new(current_frame&.eval_binding || TOPLEVEL_BINDING, klass_name, op, method_name, cond: cond, command: cmd, path: path)
         begin
           bp.enable
         rescue NameError => e
@@ -814,6 +866,7 @@ module DEBUGGER__
           set_mode :waiting if !waiting?
           cmds = @q_cmd.pop
           # pp [self, cmds: cmds]
+
           break unless cmds
         ensure
           set_mode :running
@@ -831,8 +884,9 @@ module DEBUGGER__
 
           case step_type
           when :in
+            iter = iter || 1
             if @recorder&.replaying?
-              @recorder.step_forward
+              @recorder.step_forward iter
               raise SuspendReplay
             else
               step_tp iter do
@@ -845,6 +899,7 @@ module DEBUGGER__
             frame = @target_frames.first
             path = frame.location.absolute_path || "!eval:#{frame.path}"
             line = frame.location.lineno
+            label = frame.location.base_label
 
             if frame.iseq
               frame.iseq.traceable_lines_norec(lines = {})
@@ -856,35 +911,89 @@ module DEBUGGER__
 
             depth = @target_frames.first.frame_depth
 
-            step_tp iter do
+            step_tp iter do |tp|
               loc = caller_locations(2, 1).first
               loc_path = loc.absolute_path || "!eval:#{loc.path}"
+              loc_label = loc.base_label
+              loc_depth = DEBUGGER__.frame_depth - 3
 
-              # same stack depth
-              (DEBUGGER__.frame_depth - 3 <= depth) ||
-
-              # different frame
-              (next_line && loc_path == path &&
-               (loc_lineno = loc.lineno) > line &&
-               loc_lineno <= next_line)
+              case
+              when loc_depth == depth && loc_label == label
+                true
+              when loc_depth < depth
+                # lower stack depth
+                true
+              when (next_line &&
+                    loc_path == path &&
+                    (loc_lineno = loc.lineno) > line &&
+                    loc_lineno <= next_line)
+                # different frame (maybe block) but the line is before next_line
+                true
+              end
             end
             break
 
           when :finish
             finish_frames = (iter || 1) - 1
-            goal_depth = @target_frames.first.frame_depth - finish_frames
+            frame = @target_frames.first
+            goal_depth = frame.frame_depth - finish_frames - (frame.has_return_value ? 1 : 0)
 
             step_tp nil, [:return, :b_return] do
               DEBUGGER__.frame_depth - 3 <= goal_depth ? true : false
             end
             break
 
+          when :until
+            location = iter&.strip
+            frame = @target_frames.first
+            depth = frame.frame_depth - (frame.has_return_value ? 1 : 0)
+            target_location_label = frame.location.base_label
+
+            case location
+            when nil, /\A(?:(.+):)?(\d+)\z/
+              no_loc = !location
+              file = $1 || frame.location.path
+              line = ($2 ||  frame.location.lineno + 1).to_i
+
+              step_tp nil, [:line, :return] do |tp|
+                if tp.event == :line
+                  next false if no_loc && depth < DEBUGGER__.frame_depth - 3
+                  next false unless tp.path.end_with?(file)
+                  next false unless tp.lineno >= line
+                  true
+                else
+                  true if depth >= DEBUGGER__.frame_depth - 3 &&
+                          caller_locations(2, 1).first.label == target_location_label
+                          # TODO: imcomplete condition
+                end
+              end
+            else
+              pat = location
+              if /\A\/(.+)\/\z/ =~ pat
+                pat = Regexp.new($1)
+              end
+
+              step_tp nil, [:call, :c_call, :return] do |tp|
+                case tp.event
+                when :call, :c_call
+                  true if pat === tp.callee_id.to_s
+                else # :return, :b_return
+                  true if depth >= DEBUGGER__.frame_depth - 3 &&
+                          caller_locations(2, 1).first.label == target_location_label
+                          # TODO: imcomplete condition
+                end
+              end
+            end
+
+            break
+
           when :back
+            iter = iter || 1
             if @recorder&.can_step_back?
               unless @recorder.backup_frames
                 @recorder.backup_frames = @target_frames
               end
-              @recorder.step_back
+              @recorder.step_back iter
               raise SuspendReplay
             else
               puts "Can not step back more."
@@ -922,8 +1031,9 @@ module DEBUGGER__
           when :call
             result = frame_eval(eval_src)
           when :irb
+            require 'irb' # prelude's binding.irb doesn't have show_code option
             begin
-              result = frame_eval('binding.irb')
+              result = frame_eval('binding.irb(show_code: false)', binding_location: true)
             ensure
               # workaround: https://github.com/ruby/debug/issues/308
               Reline.prompt_proc = nil if defined? Reline
@@ -988,6 +1098,10 @@ module DEBUGGER__
           when :list
             show_src(update_line: true, **(args.first || {}))
 
+          when :whereami
+            show_src ignore_show_line: true
+            show_frames CONFIG[:show_frames]
+
           when :edit
             show_by_editor(args.first)
 
@@ -1003,11 +1117,13 @@ module DEBUGGER__
 
           when :ivars
             pat = args.shift
-            show_ivars pat
+            expr = args.shift
+            show_ivars pat, expr
 
           when :consts
             pat = args.shift
-            show_consts pat
+            expr = args.shift
+            show_consts pat, expr
 
           when :globals
             pat = args.shift
@@ -1093,6 +1209,8 @@ module DEBUGGER__
           end
           event! :result, nil
 
+        when :quit
+          sleep # wait for SystemExit
         when :dap
           process_dap args
         when :cdp
@@ -1107,6 +1225,8 @@ module DEBUGGER__
     rescue Exception => e
       pp ["DEBUGGER Exception: #{__FILE__}:#{__LINE__}", e, e.backtrace]
       raise
+    ensure
+      @returning = false
     end
 
     def debug_event(ev, args)
@@ -1187,12 +1307,18 @@ module DEBUGGER__
         @tp_recorder.enabled?
       end
 
-      def step_back
-        @index += 1
+      def step_back iter
+        @index += iter
+        if @index > @log.size
+          @index = @log.size
+        end
       end
 
-      def step_forward
-        @index -= 1
+      def step_forward iter
+        @index -= iter
+        if @index < 0
+          @index = 0
+        end
       end
 
       def step_reset

data/lib/debug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DEBUGGER__
-  VERSION = "1.6.3"
+  VERSION = "1.7.0"
 end

data/lib/debug.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'debug/session'
-return unless defined?(DEBUGGER__)
-DEBUGGER__::start no_sigint_hook: true, nonstop: true
+if ENV['RUBY_DEBUG_LAZY']
+  require_relative 'debug/prelude'
+else
+  require_relative 'debug/session'
+  return unless defined?(DEBUGGER__)
+  DEBUGGER__::start no_sigint_hook: true, nonstop: true
+end

data/misc/README.md.erb

@@ -498,7 +498,8 @@ There are additional features:
 * `<expr>` without debug command is almost same as `pp <expr>`.
   * If the input line `<expr>` does *NOT* start with any debug command, the line `<expr>` will be evaluated as a Ruby expression and the result will be printed with `pp` method. So that the input `foo.bar` is same as `pp foo.bar`.
   * If `<expr>` is recognized as a debug command, of course it is not evaluated as a Ruby expression, but is executed as debug command. For example, you can not evaluate such single letter local variables `i`, `b`, `n`, `c` because they are single letter debug commands. Use `p i` instead.
-* `Enter` without any input repeats the last command (useful when repeating `step`s).
+  * So the author (Koichi Sasada) recommends to use `p`, `pp` or `eval` command to evaluate the Ruby expression everytime.
+* `Enter` without any input repeats the last command (useful when repeating `step`s) for some commands.
 * `Ctrl-D` is equal to `quit` command.
 * [debug command compare sheet - Google Sheets](https://docs.google.com/spreadsheets/d/1TlmmUDsvwK4sSIyoMv-io52BUUz__R5wpu-ComXlsw0/edit?usp=sharing)
 
@@ -567,11 +568,11 @@ It is useful if you only want to call a debug command and don't want to stop the
 ```
 def initialize
   @a = 1
-  binding.b do: 'watch @a'
+  binding.b do: 'info \n watch @a'
 end
 ```
 
-On this case, register a watch breakpoint for `@a` and continue to run.
+On this case, execute the `info` command then register a watch breakpoint for `@a` and continue to run. You can also use `;;` instead of `\n` to separate your commands.
 
 If `pre: 'command'` is specified, the debugger suspends the program and run the `command` as a debug command, and keep suspend.
 It is useful if you have operations before suspend.
@@ -591,6 +592,11 @@ On this case, you can see the result of `bar()` every time you stop there.
 <%= `exe/rdbg --help` %>
 ```
 
+# Additional Resources
+
+- [From byebug to ruby/debug](https://st0012.dev/from-byebug-to-ruby-debug) by Stan Lo - A migration guide for `byebug` users.
+- [ruby/debug cheatsheet](https://st0012.dev/ruby-debug-cheatsheet) by Stan Lo
+
 # Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: reline
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +60,7 @@ files:
 - ext/debug/extconf.rb
 - ext/debug/iseq_collector.c
 - lib/debug.rb
+- lib/debug/abbrev_command.rb
 - lib/debug/breakpoint.rb
 - lib/debug/client.rb
 - lib/debug/color.rb