config show_evaledsrc

Now debugger records actually evaluated source code with (1) `eval`
methods or (2) loaded files.

For (1) sometimes `eval` with existing filename, for example erb,
haml and so on.

For (2) sometimes the contents will be changed after loading
especially on development phase.

`config show_evaledsrc` configuration (default: `false`) controls
which should be shown for the source code:

* true: actually evaluated source code
* false (default): current file system's source code

For the erb, haml etc from files, `false`'s behavior seems nice
so I added this configuration (with `false` default).

Author: ko1

README.md

@@ -469,6 +469,7 @@ config set no_color true
 * UI
   * `RUBY_DEBUG_LOG_LEVEL` (`log_level`): Log level same as Logger (default: WARN)
   * `RUBY_DEBUG_SHOW_SRC_LINES` (`show_src_lines`): Show n lines source code on breakpoint (default: 10)
+  * `RUBY_DEBUG_SHOW_EVALEDSRC` (`show_evaledsrc`): Show actually evaluated source (default: false)
   * `RUBY_DEBUG_SHOW_FRAMES` (`show_frames`): Show n frames on breakpoint (default: 2)
   * `RUBY_DEBUG_USE_SHORT_PATH` (`use_short_path`): Show shorten PATH (like $(Gem)/foo.rb) (default: false)
   * `RUBY_DEBUG_NO_COLOR` (`no_color`): Do not use colorize (default: false)

lib/debug/config.rb

@@ -14,6 +14,7 @@ module DEBUGGER__
     # UI setting
     log_level:      ['RUBY_DEBUG_LOG_LEVEL',      "UI: Log level same as Logger",               :loglevel, "WARN"],
     show_src_lines: ['RUBY_DEBUG_SHOW_SRC_LINES', "UI: Show n lines source code on breakpoint", :int, "10"],
+    show_evaledsrc: ['RUBY_DEBUG_SHOW_EVALEDSRC', "UI: Show actually evaluated source",         :bool, "false"],
     show_frames:    ['RUBY_DEBUG_SHOW_FRAMES',    "UI: Show n frames on breakpoint",            :int, "2"],
     use_short_path: ['RUBY_DEBUG_USE_SHORT_PATH', "UI: Show shorten PATH (like $(Gem)/foo.rb)", :bool, "false"],
     no_color:       ['RUBY_DEBUG_NO_COLOR',       "UI: Do not use colorize",                    :bool, "false"],

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 @@ def add iseq, src
         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 @@ def initialize
       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 @@ def add iseq, src
         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 @@ def add iseq, src
 
       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 @@ def add iseq, src
         end
       end
 
-      def get iseq
+      def orig_src iseq
         if si = get_si(iseq)
           si.src
         end

test/console/config_test.rb

@@ -105,6 +105,44 @@ def test_show_src_lines_control_the_lines_displayed_on_breakpoint
     end
   end
 
+  class ShowOrigSrcTest < ConsoleTestCase
+    def program
+      <<~RUBY
+      1| binding.eval <<RUBY, __FILE__, 10
+      2|   a = 111
+      3|   b = 222
+      4|   c = 333
+      5|   d = 444
+      6|   e = 555
+      7|   f = 666
+      8| RUBY
+      9|
+     10| a = 777
+     11| b = 888
+     12| c = 999
+      RUBY
+    end
+
+    def test_show_evaledsrc_false_defalt
+      debug_code program do
+        type 's'
+        assert_line_num 10
+        assert_line_text(/a = 777/) # see file's 10th line
+        type 'c'
+      end
+    end
+
+    def test_show_evaledsrc_true
+      debug_code program do
+        type 'config show_evaledsrc = true'
+        type 's'
+        assert_line_num 10
+        assert_line_text(/a = 111/) # see eval'ed 10t line
+        type 'c'
+      end
+    end
+  end
+
   class ShowFramesTest < ConsoleTestCase
     def program
       <<~RUBY