debug 1.9.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d25f806f1fa474cea627e17003007f9e28a776244f25c24addae854005fd8d1
-  data.tar.gz: 63a48b8aeee29d020a4d8fb6ec85ad337c42c0b83f32ca53ea83d767a6daadc5
+  metadata.gz: c242bce58b031f61da73507f6b42a26f1ed8322679d1f0b3460d8fbc8c4b7a23
+  data.tar.gz: 543feb5e53a2c99ba04583edae4a13378667c97b13662f5a4d456dd6bacb17b5
 SHA512:
-  metadata.gz: 91f621ae09fb945590cb7ddd43b97401f27304326b49204ea0a17981fbd236e52e5e19bfa4cb158bd49943d04681e39ff51072f317a4d29368ccdaa50552cd86
-  data.tar.gz: 9ab3a0a3509ad947ad62c70e10eedacd3fb299a5e2c1654f06ffd01f59de23d91cd99b80101fc13acd1e0b1192265821a2c5fbddf0dfbefccc69dfaf5748b63d
+  metadata.gz: b5f6c58f38114e3179c3d5c062294ac276b53533fc4a6543114a883198318b672a8506990064f1b40d9f9597d3e1a933cb7c2363ea4cdd4ba0e0571279a80c73
+  data.tar.gz: 142a78dcdc449df6e0148857f992500aa88375707af067f36f1e3391fe2adb7ac8ff0f66623806c5488e94292167a369ca901084475e97b8dc38e32257ccbba0

data/Gemfile

@@ -7,3 +7,4 @@ gem "rake-compiler"
 gem "test-unit", "~> 3.0"
 gem "test-unit-rr"
 gem "json-schema"
+gem "test-unit-launchable"

data/README.md

@@ -13,10 +13,10 @@ New debug.rb has several advantages:
   * TCP/IP
   * Integration with rich debugger frontends
 
-     Frontend |  [Console](https://github.com/ruby/debug#invoke-as-a-remote-debuggee) | [VSCode](https://github.com/ruby/debug#vscode-integration) | [Chrome DevTool](#chrome-devtool-integration) |
-     ---|---|---|---|
-     Connection | UDS, TCP/IP | UDS, TCP/IP | TCP/IP |
-     Requirement | No | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | Chrome |
+     | Frontend    | [Console](https://github.com/ruby/debug#invoke-as-a-remote-debuggee) | [VSCode](https://github.com/ruby/debug#vscode-integration)                                  | [Chrome DevTool](#chrome-devtool-integration) |
+     | ----------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------- |
+     | Connection  | UDS, TCP/IP                                                          | UDS, TCP/IP                                                                                 | TCP/IP                                        |
+     | Requirement | No                                                                   | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | Chrome                                        |
 
 * Extensible: application can introduce debugging support in several ways:
   * By `rdbg` command
@@ -289,10 +289,10 @@ You can run your application as a remote debuggee, and the remote debugger conso
 
 There are multiple ways to run your program as a debuggee:
 
-Stop at program start | [`rdbg` option](https://github.com/ruby/debug#rdbg---open-or-rdbg--o-for-short) | [require](https://github.com/ruby/debug#require-debugopen-in-a-program) | [debugger API](https://github.com/ruby/debug#start-by-method)
----|---|---|---|
-Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open`
-No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
+| Stop at program start | [`rdbg` option](https://github.com/ruby/debug#rdbg---open-or-rdbg--o-for-short) | [require](https://github.com/ruby/debug#require-debugopen-in-a-program) | [debugger API](https://github.com/ruby/debug#start-by-method) |
+| --------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------- |
+| Yes                   | `rdbg --open`                                                                   | `require "debug/open"`                                                  | `DEBUGGER__.open`                                             |
+| No                    | `rdbg --open --nonstop`                                                         | `require "debug/open_nonstop"`                                          | `DEBUGGER__.open(nonstop: true)`                              |
 
 #### `rdbg --open` (or `rdbg -O` for short)
 
@@ -713,7 +713,7 @@ The `<...>` notation means the argument.
 * `eval <expr>`
   * Evaluate `<expr>` on the current frame.
 * `irb`
-  * Invoke `irb` on the current frame.
+  * Activate and switch to `irb:rdbg` console
 
 ### Trace
 
@@ -784,6 +784,30 @@ The `<...>` notation means the argument.
   * Show help for the given command.
 
 
+### Using IRB as the Debug Console
+
+Starting from version `v1.9`, you can now use IRB as the debug console. This integration brings additional features such as:
+
+* Autocompletion
+* Support for multi-line input
+* Access to commands not available in `debug`, like `show_source` or `show_doc`
+* [Configurable command aliases](https://docs.ruby-lang.org/en/master/IRB.html#module-IRB-label-Command+Aliases)
+
+To switch to the IRB console, simply use the `irb` command in the debug console.
+
+Once activated, you'll notice the prompt changes to:
+
+```txt
+irb:rdbg(main):001>
+```
+
+If you want to make IRB the default console for all sessions, configure the `irb_console` setting by either:
+
+* Setting the `RUBY_DEBUG_IRB_CONSOLE=true` environment variable
+* Or adding `config set irb_console 1` to your `~/.rdbgrc`
+
+To disable the IRB console in the current session, execute `config set irb_console 0` in the console.
+
 ## Debugger API
 
 ### Start debugging

data/ext/debug/debug.c

@@ -8,13 +8,13 @@ static VALUE rb_mDebugger;
 
 // iseq
 typedef struct rb_iseq_struct rb_iseq_t;
+const rb_iseq_t *rb_iseqw_to_iseq(VALUE iseqw);
 VALUE rb_iseq_realpath(const rb_iseq_t *iseq);
 
 static VALUE
 iseq_realpath(VALUE iseqw)
 {
-    rb_iseq_t *iseq = DATA_PTR(iseqw);
-    return rb_iseq_realpath(iseq);
+    return rb_iseq_realpath(rb_iseqw_to_iseq(iseqw));
 }
 
 static VALUE rb_cFrameInfo;
@@ -62,15 +62,23 @@ di_body(const rb_debug_inspector_t *dc, void *ptr)
     long i;
 
     for (i=1; i<len; i++) {
-        VALUE loc, e;
+        VALUE e;
         VALUE iseq = rb_debug_inspector_frame_iseq_get(dc, i);
+        VALUE loc = RARRAY_AREF(locs, i);
+        VALUE path;
 
         if (!NIL_P(iseq)) {
-            VALUE path = iseq_realpath(iseq);
-            if (!NIL_P(path) && !NIL_P(skip_path_prefix) && str_start_with(path, skip_path_prefix)) continue;
+            path = iseq_realpath(iseq);
+        }
+        else {
+            // C frame
+            path = rb_funcall(loc, rb_intern("path"), 0);
+        }
+
+        if (!NIL_P(path) && !NIL_P(skip_path_prefix) && str_start_with(path, skip_path_prefix)) {
+            continue;
         }
 
-        loc = RARRAY_AREF(locs, i);
         e = di_entry(loc,
                      rb_debug_inspector_frame_self_get(dc, i),
                      rb_debug_inspector_frame_binding_get(dc, i),
@@ -113,26 +121,26 @@ frame_depth(VALUE self)
 
 // iseq
 
-const struct rb_iseq *rb_iseqw_to_iseq(VALUE iseqw);
+const rb_iseq_t *rb_iseqw_to_iseq(VALUE iseqw);
 
 #ifdef HAVE_RB_ISEQ_TYPE
-VALUE rb_iseq_type(const struct rb_iseq *);
+VALUE rb_iseq_type(const rb_iseq_t *);
 
 static VALUE
 iseq_type(VALUE iseqw)
 {
-    const struct rb_iseq *iseq = rb_iseqw_to_iseq(iseqw);
+    const rb_iseq_t *iseq = rb_iseqw_to_iseq(iseqw);
     return rb_iseq_type(iseq);
 }
 #endif
 
 #ifdef HAVE_RB_ISEQ_PARAMETERS
-VALUE rb_iseq_parameters(const struct rb_iseq *, int is_proc);
+VALUE rb_iseq_parameters(const rb_iseq_t *, int is_proc);
 
 static VALUE
 iseq_parameters_symbols(VALUE iseqw)
 {
-    const struct rb_iseq *iseq = rb_iseqw_to_iseq(iseqw);
+    const rb_iseq_t *iseq = rb_iseqw_to_iseq(iseqw);
     VALUE params = rb_iseq_parameters(iseq, 0);
     VALUE ary = rb_ary_new();
 
@@ -159,12 +167,12 @@ iseq_parameters_symbols(VALUE iseqw)
 #endif
 
 #ifdef HAVE_RB_ISEQ_CODE_LOCATION
-void rb_iseq_code_location(const struct rb_iseq *, int *first_lineno, int *first_column, int *last_lineno, int *last_column);
+void rb_iseq_code_location(const rb_iseq_t *, int *first_lineno, int *first_column, int *last_lineno, int *last_column);
 
 static VALUE
 iseq_first_line(VALUE iseqw)
 {
-    const struct rb_iseq *iseq = rb_iseqw_to_iseq(iseqw);
+    const rb_iseq_t *iseq = rb_iseqw_to_iseq(iseqw);
     int line;
     rb_iseq_code_location(iseq, &line, NULL, NULL, NULL);
     return INT2NUM(line);
@@ -173,7 +181,7 @@ iseq_first_line(VALUE iseqw)
 static VALUE
 iseq_last_line(VALUE iseqw)
 {
-    const struct rb_iseq *iseq = rb_iseqw_to_iseq(iseqw);
+    const rb_iseq_t *iseq = rb_iseqw_to_iseq(iseqw);
     int line;
     rb_iseq_code_location(iseq, NULL, NULL, &line, NULL);
     return INT2NUM(line);

data/lib/debug/config.rb

@@ -158,6 +158,22 @@ module DEBUGGER__
           SESSION.set_no_sigint_hook old, new
         end
       end
+
+      if_updated old_conf, conf, :irb_console do |old, new|
+        if defined?(SESSION) && SESSION.active?
+          # irb_console is switched from true to false
+          if old
+            SESSION.deactivate_irb_integration
+          # irb_console is switched from false to true
+          else
+            if CONFIG[:open]
+              SESSION.instance_variable_get(:@ui).puts "\nIRB is not supported on the remote console."
+            else
+              SESSION.activate_irb_integration
+            end
+          end
+        end
+      end
     end
 
     private def if_updated old_conf, new_conf, key

data/lib/debug/console.rb

@@ -143,7 +143,7 @@ module DEBUGGER__
       rescue LoadError
         def readline prompt
           print prompt
-          gets
+          $stdin.gets
         end
 
         def history

data/lib/debug/irb_integration.rb

@@ -24,4 +24,14 @@ module DEBUGGER__
       IRB::Context.prepend(IrbPatch)
     end
   end
+
+  class Session
+    def deactivate_irb_integration
+      Reline.completion_proc = nil
+      Reline.output_modifier_proc = nil
+      Reline.autocompletion = false
+      Reline.dig_perfect_match_proc = nil
+      reset_ui UI_LocalConsole.new
+    end
+  end
 end

data/lib/debug/prelude.rb

@@ -5,7 +5,7 @@ return if defined?(::DEBUGGER__::Session)
 
 # Put the following line in your login script (e.g. ~/.bash_profile) with modified path:
 #
-#   export RUBYOPT="-r /path/to/debug/prelude $(RUBYOPT)"
+#   export RUBYOPT="-r /path/to/debug/prelude ${RUBYOPT}"
 #
 module Kernel
   def debugger(*a, up_level: 0, **kw)

data/lib/debug/server_cdp.rb

@@ -2,7 +2,6 @@
 
 require 'json'
 require 'digest/sha1'
-require 'base64'
 require 'securerandom'
 require 'stringio'
 require 'open3'
@@ -131,7 +130,7 @@ module DEBUGGER__
           stdout.close
           data = stderr.readpartial 4096
           stderr.close
-          if data.match /DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/
+          if data.match(/DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/)
             port = $1
             path = $2
           end
@@ -158,7 +157,7 @@ module DEBUGGER__
             raise NotFoundChromeEndpointError
           end
           stderr.close
-          if data.match /DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/
+          if data.match(/DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/)
             port = $1
             path = $2
           end
@@ -190,7 +189,7 @@ module DEBUGGER__
         while i < ITERATIONS
           i += 1
           if File.exist?(tf) && data = File.read(tf)
-            if data.match /DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/
+            if data.match(/DevTools listening on ws:\/\/127.0.0.1:(\d+)(.*)/)
               port = $1
               path = $2
               return [port, path]
@@ -297,8 +296,8 @@ module DEBUGGER__
         res = @sock.readpartial 4092
         show_protocol :<, res
 
-        if res.match /^Sec-WebSocket-Accept: (.*)\r\n/
-          correct_key = Base64.strict_encode64 Digest::SHA1.digest "#{key}==258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+        if res.match(/^Sec-WebSocket-Accept: (.*)\r\n/)
+          correct_key = Digest::SHA1.base64digest "#{key}==258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
           raise "The Sec-WebSocket-Accept value: #{$1} is not valid" unless $1 == correct_key
         else
           raise "Unknown response: #{res}"
@@ -378,8 +377,8 @@ module DEBUGGER__
         req = @sock.readpartial 4096
         show_protocol '>', req
 
-        if req.match /^Sec-WebSocket-Key: (.*)\r\n/
-          accept = Base64.strict_encode64 Digest::SHA1.digest "#{$1}258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+        if req.match(/^Sec-WebSocket-Key: (.*)\r\n/)
+          accept = Digest::SHA1.base64digest "#{$1}258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
           res = "HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Accept: #{accept}\r\n\r\n"
           @sock.print res
           show_protocol :<, res
@@ -658,7 +657,7 @@ module DEBUGGER__
 
     def activate_bp bps
       bps.each_key{|k|
-        if k.match /^\d+:(\d+):(.*)/
+        if k.match(/^\d+:(\d+):(.*)/)
           line = $1
           path = $2
           SESSION.add_line_breakpoint(path, line.to_i + 1)

data/lib/debug/session.rb

@@ -202,11 +202,6 @@ module DEBUGGER__
         end
         @tp_thread_end.enable
 
-        if CONFIG[:irb_console] && !CONFIG[:open]
-          require_relative "irb_integration"
-          thc.activate_irb_integration
-        end
-
         # session start
         q << true
         session_server_main
@@ -214,6 +209,12 @@ module DEBUGGER__
       first_q << :ok
 
       q.pop
+
+      # For activating irb:rdbg with startup config like `RUBY_DEBUG_IRB_CONSOLE=1`
+      # Because in that case the `Config#if_updated` callback would not be triggered
+      if CONFIG[:irb_console] && !CONFIG[:open]
+        activate_irb_integration
+      end
     end
 
     def deactivate
@@ -938,14 +939,15 @@ module DEBUGGER__
       end
 
       # * `irb`
-      #   * Invoke `irb` on the current frame.
+      #   * Activate and switch to `irb:rdbg` console
       register_command 'irb' do |arg|
         if @ui.remote?
           @ui.puts "\nIRB is not supported on the remote console."
-          :retry
         else
-          request_eval :irb, nil
+          config_set :irb_console, true
         end
+
+        :retry
       end
 
       ### Trace
@@ -1876,6 +1878,12 @@ module DEBUGGER__
       end
     end
 
+    def activate_irb_integration
+      require_relative "irb_integration"
+      thc = get_thread_client(@session_server)
+      thc.activate_irb_integration
+    end
+
     def enter_postmortem_session exc
       return unless exc.instance_variable_defined? :@__debugger_postmortem_frames
 

data/lib/debug/thread_client.rb

@@ -989,7 +989,7 @@ module DEBUGGER__
                   true
                 else
                   true if depth >= DEBUGGER__.frame_depth - 3 &&
-                          caller_locations(2, 1).first.label == target_location_label
+                          caller_locations(2, 1).first.base_label == target_location_label
                           # TODO: imcomplete condition
                 end
               end
@@ -1005,7 +1005,7 @@ module DEBUGGER__
                   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
+                          caller_locations(2, 1).first.base_label == target_location_label
                           # TODO: imcomplete condition
                 end
               end
@@ -1056,9 +1056,6 @@ module DEBUGGER__
             end
           when :call
             result = frame_eval(eval_src)
-          when :irb
-            require_relative "irb_integration"
-            activate_irb_integration
           when :display, :try_display
             failed_results = []
             eval_src.each_with_index{|src, i|

data/lib/debug/version.rb

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

data/misc/README.md.erb

@@ -13,10 +13,10 @@ New debug.rb has several advantages:
   * TCP/IP
   * Integration with rich debugger frontends
 
-     Frontend |  [Console](https://github.com/ruby/debug#invoke-as-a-remote-debuggee) | [VSCode](https://github.com/ruby/debug#vscode-integration) | [Chrome DevTool](#chrome-devtool-integration) |
-     ---|---|---|---|
-     Connection | UDS, TCP/IP | UDS, TCP/IP | TCP/IP |
-     Requirement | No | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | Chrome |
+     | Frontend    | [Console](https://github.com/ruby/debug#invoke-as-a-remote-debuggee) | [VSCode](https://github.com/ruby/debug#vscode-integration)                                  | [Chrome DevTool](#chrome-devtool-integration) |
+     | ----------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------- |
+     | Connection  | UDS, TCP/IP                                                          | UDS, TCP/IP                                                                                 | TCP/IP                                        |
+     | Requirement | No                                                                   | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | Chrome                                        |
 
 * Extensible: application can introduce debugging support in several ways:
   * By `rdbg` command
@@ -289,10 +289,10 @@ You can run your application as a remote debuggee, and the remote debugger conso
 
 There are multiple ways to run your program as a debuggee:
 
-Stop at program start | [`rdbg` option](https://github.com/ruby/debug#rdbg---open-or-rdbg--o-for-short) | [require](https://github.com/ruby/debug#require-debugopen-in-a-program) | [debugger API](https://github.com/ruby/debug#start-by-method)
----|---|---|---|
-Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open`
-No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
+| Stop at program start | [`rdbg` option](https://github.com/ruby/debug#rdbg---open-or-rdbg--o-for-short) | [require](https://github.com/ruby/debug#require-debugopen-in-a-program) | [debugger API](https://github.com/ruby/debug#start-by-method) |
+| --------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------- |
+| Yes                   | `rdbg --open`                                                                   | `require "debug/open"`                                                  | `DEBUGGER__.open`                                             |
+| No                    | `rdbg --open --nonstop`                                                         | `require "debug/open_nonstop"`                                          | `DEBUGGER__.open(nonstop: true)`                              |
 
 #### `rdbg --open` (or `rdbg -O` for short)
 
@@ -509,6 +509,30 @@ The `<...>` notation means the argument.
 
 <%= DEBUGGER__.help %>
 
+### Using IRB as the Debug Console
+
+Starting from version `v1.9`, you can now use IRB as the debug console. This integration brings additional features such as:
+
+* Autocompletion
+* Support for multi-line input
+* Access to commands not available in `debug`, like `show_source` or `show_doc`
+* [Configurable command aliases](https://docs.ruby-lang.org/en/master/IRB.html#module-IRB-label-Command+Aliases)
+
+To switch to the IRB console, simply use the `irb` command in the debug console.
+
+Once activated, you'll notice the prompt changes to:
+
+```txt
+irb:rdbg(main):001>
+```
+
+If you want to make IRB the default console for all sessions, configure the `irb_console` setting by either:
+
+* Setting the `RUBY_DEBUG_IRB_CONSOLE=true` environment variable
+* Or adding `config set irb_console 1` to your `~/.rdbgrc`
+
+To disable the IRB console in the current session, execute `config set irb_console 0` in the console.
+
 ## Debugger API
 
 ### Start debugging

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.2
 platform: ruby
 authors:
 - Koichi Sasada
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-10 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -90,7 +89,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby/debug
   source_code_uri: https://github.com/ruby/debug
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
-signing_key: 
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Debugging functionality for Ruby
 test_files: []