debug 1.0.0.rc2 → 1.2.1

data/lib/debug/thread_client.rb

@@ -20,9 +20,11 @@ module DEBUGGER__
 
   class ThreadClient
     def self.current
-      Thread.current[:DEBUGGER__ThreadClient] || begin
-        tc = ::DEBUGGER__::SESSION.thread_client
-        Thread.current[:DEBUGGER__ThreadClient] = tc
+      if thc = Thread.current[:DEBUGGER__ThreadClient]
+        thc
+      else
+        thc = SESSION.thread_client
+        Thread.current[:DEBUGGER__ThreadClient] = thc
       end
     end
 
@@ -115,7 +117,7 @@ module DEBUGGER__
         # TODO: there is waiting -> waiting
         # raise "#{mode} is given, but #{mode}" unless self.running?
       else
-        raise
+        raise "unknown mode: #{mode}"
       end
 
       @mode = mode
@@ -138,7 +140,11 @@ module DEBUGGER__
     end
 
     def inspect
-      "#<DBG:TC #{self.id}:#{@mode}@#{@thread.backtrace[-1]}>"
+      if bt = @thread.backtrace
+        "#<DBG:TC #{self.id}:#{@mode}@#{bt[-1]}>"
+      else # bt can be nil
+        "#<DBG:TC #{self.id}:#{@mode}>"
+      end
     end
 
     def to_s
@@ -194,10 +200,6 @@ module DEBUGGER__
       wait_next_action
     end
 
-    def on_thread_begin th
-      wait_reply [:thread_begin, th]
-    end
-
     def on_load iseq, eval_src
       wait_reply [:load, iseq, eval_src]
     end
@@ -340,7 +342,8 @@ module DEBUGGER__
       begin
         @success_last_eval = false
 
-        b = current_frame.eval_binding
+        b = current_frame&.eval_binding || TOPLEVEL_BINDING
+
         result = if b
                    f, _l = b.source_location
                    b.eval(src, "(rdbg)/#{f}")
@@ -356,7 +359,7 @@ module DEBUGGER__
 
         puts "eval error: #{e}"
 
-        e.backtrace_locations.each do |loc|
+        e.backtrace_locations&.each do |loc|
           break if loc.path == __FILE__
           puts "  #{loc}"
         end
@@ -659,18 +662,17 @@ module DEBUGGER__
 
     def wait_next_action_
       # assertions
-      raise "@mode is #{@mode}" unless @mode == :waiting
+      raise "@mode is #{@mode}" if !waiting?
 
       unless SESSION.active?
         pp caller
         set_mode :running
         return
       end
-      # SESSION.check_forked
 
       while true
         begin
-          set_mode :waiting if @mode != :waiting
+          set_mode :waiting if !waiting?
           cmds = @q_cmd.pop
           # pp [self, cmds: cmds]
           break unless cmds
@@ -779,6 +781,13 @@ module DEBUGGER__
             end
           when :call
             result = frame_eval(eval_src)
+          when :irb
+            begin
+              result = frame_eval('binding.irb')
+            ensure
+              # workaround: https://github.com/ruby/debug/issues/308
+              Reline.prompt_proc = nil if defined? Reline
+            end
           when :display, :try_display
             failed_results = []
             eval_src.each_with_index{|src, i|

data/lib/debug/tracer.rb

@@ -14,7 +14,7 @@ module DEBUGGER__
       end
     end
 
-    attr_reader :type
+    attr_reader :type, :key
 
     def initialize ui, pattern: nil, into: nil
       if /\ADEBUGGER__::(([A-Z][a-z]+?)[A-Z][a-z]+)/ =~ self.class.name
@@ -37,6 +37,8 @@ module DEBUGGER__
         @output = ui
       end
 
+      @key = [@type, @pattern, @into].freeze
+
       enable
     end
 
@@ -95,6 +97,8 @@ module DEBUGGER__
     end
 
     def minfo tp
+      return "block{}" if tp.event == :b_call
+
       klass = tp.defined_class
 
       if klass.singleton_class?
@@ -172,6 +176,7 @@ module DEBUGGER__
       @obj_id = obj_id
       @obj_inspect = obj_inspect
       super(ui, **kw)
+      @key = [@type, @obj_id, @pattern, @into].freeze
     end
 
     def description
@@ -201,7 +206,7 @@ module DEBUGGER__
             end
 
           out tp, " #{colorized_obj_inspect} receives #{colorize_blue(method_info)}"
-        else
+        elsif !tp.parameters.empty?
           b = tp.binding
           method_info = colorize_blue(minfo(tp))
 
@@ -216,7 +221,7 @@ module DEBUGGER__
                 out tp, " #{colorized_obj_inspect} is used as a parameter #{colorized_name} of #{method_info}"
               end
             when :rest
-              next name == :"*"
+              next if name == :"*"
 
               ary = b.local_variable_get(name)
               ary.each{|e|

data/lib/debug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DEBUGGER__
-  VERSION = "1.0.0.rc2"
+  VERSION = "1.2.1"
 end

data/misc/README.md.erb

@@ -8,7 +8,7 @@ This debug.rb is replacement of traditional lib/debug.rb standard library which
 New debug.rb has several advantages:
 
 * Fast: No performance penalty on non-stepping mode and non-breakpoints.
-* Remote debugging: Support remote debugging natively.
+* [Remote debugging](#remote-debugging): Support remote debugging natively.
   * UNIX domain socket
   * TCP/IP
   * VSCode/DAP integration ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
@@ -25,7 +25,7 @@ New debug.rb has several advantages:
 # Installation
 
 ```
-$ gem install debug --pre
+$ gem install debug
 ```
 
 or specify `-Ipath/to/debug/lib` in `RUBYOPT` or each ruby command-line option, especially for debug this gem development.
@@ -33,7 +33,7 @@ or specify `-Ipath/to/debug/lib` in `RUBYOPT` or each ruby command-line option,
 If you use Bundler, write the following line to your Gemfile.
 
 ```
-gem "debug", ">= 1.0.0.rc"
+gem "debug", ">= 1.0.0"
 ```
 
 # HOW TO USE
@@ -44,22 +44,24 @@ To use a debugger, roughly you will do the following steps:
 2. Run a program with the debugger.
 3. At the breakpoint, enter the debugger console.
 4. Use debug commands.
-    * Query the program status (e.g. `p lvar` to see the local variable `lvar`).
-    * Control program flow (e.g. move to the another line with `step`, to the next line with `next`).
-    * Set another breakpoint (e.g. `catch Exception` to set a breakpoint when `Exception` is raised).
-    * Change the configuration (e.g. `config set no_color true` to disable coloring).
+    * [Evaluate Ruby expressions](#evaluate) (e.g. `p lvar` to see the local variable `lvar`).
+    * [Query the program status](#information) (e.g. `info` to see information about the current frame).
+    * [Control program flow](#control-flow) (e.g. move to the another line with `step`, to the next line with `next`).
+    * [Set another breakpoint](#breakpoint) (e.g. `catch Exception` to set a breakpoint that'll be triggered when `Exception` is raised).
+    * [Activate tracing in your program](#trace) (e.g. `trace call` to trace method calls).
+    * [Change the configuration](#configuration-1) (e.g. `config set no_color true` to disable coloring).
     * Continue the program (`c` or `continue`) and goto 3.
 
 ## Invoke with the debugger
 
 There are several options for (1) and (2). Please choose your favorite way.
 
-### Modify source code as `binding.pry` and `binding.irb`
+### Modify source code with [`binding.break`](#bindingbreak-method) (similar to `binding.pry` or `binding.irb`)
 
-If you can modify the source code, you can use the debugger by adding `require 'debug'` line at the top of your program and putting `binding.break` method (`binding.b` for short) into lines where you want to stop as breakpoints like `binding.pry` and `binding.irb`.
+If you can modify the source code, you can use the debugger by adding `require 'debug'` line at the top of your program and putting [`binding.break`](#bindingbreak-method) method (`binding.b` for short) into lines where you want to stop as breakpoints like `binding.pry` and `binding.irb`.
 After that, you run the program as usual and you will enter the debug console at breakpoints you inserted.
 
-The following example shows the demonstration of `binding.break`.
+The following example shows the demonstration of [`binding.break`](#bindingbreak-method).
 
 ```shell
 $ cat target.rb                        # Sample program
@@ -370,7 +372,12 @@ If there are `~/.rdbgrc.rb` is available, it is also loaded as a ruby script at
 
 On the debug console, you can use the following debug commands.
 
-* `Enter` repeats the last command (useful when repeating `step`s).
+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).
 * `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)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.2.1
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: reline
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +48,9 @@ extensions:
 - ext/debug/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/custom.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - CONTRIBUTING.md
@@ -102,9 +105,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: