debug 1.4.0 → 1.6.1

data/misc/README.md.erb

@@ -1,19 +1,23 @@
-[![Ruby](https://github.com/ruby/debug/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/ruby/debug/actions/workflows/ruby.yml?query=branch%3Amaster)
+[![Ruby](https://github.com/ruby/debug/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/ruby/debug/actions/workflows/ruby.yml?query=branch%3Amaster) [![Protocol](https://github.com/ruby/debug/actions/workflows/protocol.yml/badge.svg)](https://github.com/ruby/debug/actions/workflows/protocol.yml)
 
 # debug.rb
 
-This library provides debugging functionality to Ruby.
+This library provides debugging functionality to Ruby (MRI) 2.6 and later.
 
 This debug.rb is replacement of traditional lib/debug.rb standard library which is implemented by `set_trace_func`.
 New debug.rb has several advantages:
 
 * Fast: No performance penalty on non-stepping mode and non-breakpoints.
 * [Remote debugging](#remote-debugging): Support remote debugging natively.
-  * UNIX domain socket
+  * UNIX domain socket (UDS)
   * TCP/IP
-  * Integration with rich debugger frontend
-    * VSCode/DAP ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
-    * Chrome DevTools
+  * 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 |
+
 * Extensible: application can introduce debugging support with several ways:
   * By `rdbg` command
   * By loading libraries with `-r` command line option
@@ -38,6 +42,9 @@ If you use Bundler, write the following line to your Gemfile.
 gem "debug", ">= 1.0.0"
 ```
 
+(The version constraint is important; `debug < 1.0.0` is an older,
+abandoned gem that is completely different from this product.)
+
 # HOW TO USE
 
 To use a debugger, roughly you will do the following steps:
@@ -113,7 +120,7 @@ d => nil
       5| binding.break
       6| c = 3
       7| d = 4
-=>    8| binding.break                 # Again the program stops at here
+=>    8| binding.break                 # Again the program stops here
       9| p [a, b, c, d]
      10|
      11| __END__
@@ -134,7 +141,7 @@ d => 4
 ### Invoke the program from the debugger as a traditional debuggers
 
 If you don't want to modify the source code, you can set breakpoints with a debug command `break` (`b` for short).
-Using `rdbg` command to launch the program without any modifications, you can run the program with the debugger.
+Using `rdbg` command (or `bundle exec rdbg`) to launch the program without any modifications, you can run the program with the debugger.
 
 ```shell
 $ cat target.rb                        # Sample program
@@ -280,7 +287,12 @@ You can run your application as a remote debuggee and the remote debugger consol
 
 ### Invoke as a remote debuggee
 
-There are two ways to invoke a script as remote debuggee: Use `rdbg --open` and require `debug/open` (or `debug/open_nonstop`).
+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)`
 
 #### `rdbg --open` (or `rdbg -O` for short)
 
@@ -358,6 +370,8 @@ Also `open` command allows opening the debug port.
 
 #### VSCode integration
 
+([vscode-rdbg v0.0.9](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) or later is required)
+
 If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the following steps.
 
 `rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code` command).
@@ -417,7 +431,7 @@ Note that you can attach with `rdbg --attach` and continue REPL debugging.
 
 #### Chrome DevTool integration
 
-With `rdbg --open=chrome` command will shows the following message.
+With `rdbg --open=chrome` command will show the following message.
 
 ```
 $ rdbg target.rb --open=chrome
@@ -435,8 +449,6 @@ Also `open chrome` command works like `open vscode`.
 
 For more information about how to use Chrome debugging, you might want to read [here](https://developer.chrome.com/docs/devtools/).
 
-Note: If you want to maximize Chrome DevTools, click [Toggle Device Toolbar](https://developer.chrome.com/docs/devtools/device-mode/#viewport).
-
 ## Configuration
 
 You can configure the debugger's behavior with debug commands and environment variables.
@@ -452,10 +464,18 @@ config set log_level INFO
 config set no_color true
 ```
 
-<% cat = nil; DEBUGGER__::CONFIG_SET.each do |key, (env, desc)| %>
+<% cat = nil; DEBUGGER__::CONFIG_SET.each do |key, (env, desc, _, default)| %>
 <% /\A(\w+): (.+)/ =~ desc; if cat != $1; cat = 1 %>
 * <%= $1 %>
-<% cat = $1; end %>  * `<%= env %>` (`<%= key %>`): <%= $2 %><% end %>
+<% cat = $1; end %>  * `<%= env %>` (`<%= key %>`): <%= default ? "#{$2} (default: #{default})" : $2 %><% end %>
+
+There are other environment variables:
+
+* `NO_COLOR`: If the value is set, set `RUBY_DEBUG_NO_COLOR` ([NO_COLOR: disabling ANSI color output in various Unix commands](https://no-color.org/)).
+* `RUBY_DEBUG_ENABLE`: If the value is `0`, do not enable debug.gem feature.
+* `RUBY_DEBUG_ADDED_RUBYOPT`: Remove this value from `RUBYOPT` at first. This feature helps loading debug.gem with `RUBYOPT='-r debug/...'` and you don't want to derive it to child processes. In this case you can set `RUBY_DEBUG_ADDED_RUBYOPT='-r debug/...'` (same value) and this string will be deleted from `RUBYOPT` at first.
+* `RUBY_DEBUG_EDITOR` or `EDITOR`: An editor used by `edit` debug command.
+* `RUBY_DEBUG_BB`: Define `Kernel#bb` method which is alias of `Kernel#debugger`.
 
 ### Initial scripts
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -30,16 +30,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.3.1
 description: Debugging functionality for Ruby. This is completely rewritten debug.rb
-  which was contained by the encient Ruby versions.
+  which was contained by the ancient Ruby versions.
 email:
 - ko1@atdot.net
 executables:
@@ -48,28 +48,18 @@ 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/pull_request_template.md"
-- ".github/workflows/ruby.yml"
-- ".gitignore"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - TODO.md
-- bin/console
-- bin/gentest
-- bin/setup
 - debug.gemspec
 - exe/rdbg
 - ext/debug/debug.c
 - ext/debug/extconf.rb
 - ext/debug/iseq_collector.c
 - lib/debug.rb
-- lib/debug/bp.vim
 - lib/debug/breakpoint.rb
 - lib/debug/client.rb
 - lib/debug/color.rb
@@ -112,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Debugging functionality for Ruby

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,24 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Your environment**
-
-* `ruby -v`: 
-* `rdbg -v`:
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Additional context**
-Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/custom.md

@@ -1,10 +0,0 @@
----
-name: Custom issue template
-about: Blank issue
-title: ''
-labels: ''
-assignees: ''
-
----
-
-

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,14 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Your proposal**
-What is your idea?
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -1,9 +0,0 @@
-Thanks for your Pull Request 🎉 
-
-**Please follow these instructions to help us review it more efficiently:**
-
-- Add references of related issues/PRs in the description if available.
-- If you're updating the readme file, make sure you followed [the instruction here](https://github.com/ruby/debug/blob/master/CONTRIBUTING.md#to-update-readme).
-
-## Description
-Describe your changes:

data/.github/workflows/ruby.yml

@@ -1,34 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0', 'head', 'debug']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-/Gemfile.lock
-/lib/debug/debug.so
-.ruby-version

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "debug"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/gentest

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-
-require_relative '../test/tool/test_builder'
-
-options = {}
-
-OptionParser.new do |opt|
-  opt.banner = 'Usage: bin/gentest [file] [option]'
-  opt.on('-m METHOD', 'Method name in the test file') do |m|
-    options[:method] = m
-  end
-  opt.on('-c CLASS', 'Class name in the test file') do |c|
-    options[:class] = c
-  end
-  opt.on('--open=FRONTEND', 'Start remote debugging with opening the network port.',
-                            'Currently, only vscode is supported.') do |f|
-    options[:open] = f.downcase
-  end
-  opt.parse!(ARGV)
-end
-
-exit if ARGV.empty?
-
-if options[:open] == 'vscode'
-  DEBUGGER__::DAPTestBuilder.new(ARGV, options[:method], options[:class]).start
-else
-  DEBUGGER__::LocalTestBuilder.new(ARGV, options[:method], options[:class]).start
-end

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/debug/bp.vim

@@ -1,68 +0,0 @@
-let g:rdb_bps = {}
-
-function SET_BP()
-  let signed = sign_getplaced(bufname(), {'lnum': line('.')})
-  if empty(signed[0]['signs'])
-    call sign_place(0, '', 'signBP', bufname(), {'lnum': line('.')})
-  else
-    "echo signed[0]['signs']
-    call sign_unplace('', {'buffer': bufname(), 'id': signed[0]['signs'][0]['id']})
-  endif
-endfunction
-
-function UPDATE_BPS()
-  let signs = sign_getplaced(bufname())
-  let key = expand('%:p')
-
-  if empty(signs[0]['signs'])
-    let removed = remove(g:rdb_bps, key)
-  else
-    let g:rdb_bps[key] = signs[0]['signs']
-  endif
-endfunction
-
-function APPLY_BPS()
-  let key = expand('%:p')
-  if has_key(g:rdb_bps, key)
-    for b in g:rdb_bps[key]
-      call sign_place(0, '', 'signBP', bufname(), {'lnum': b['lnum']})
-    endfor
-  endif
-endfunction
-
-function WRITE_BPS()
-  call writefile([json_encode(g:rdb_bps)], '.rdb_breakpoints.json')
-endfunction
-
-" load
-try
-  let json = readfile('.rdb_breakpoints.json')
-  let g:rdb_bps = json_decode(json[0])
-  " {"/full/path/to/file1": [{"lnum": 10}, ...], ...}
-catch /Can't open/
-  let g:rdb_bps = {}
-catch /Invalid arguments for function json_decode/
-  let g:rdb_bps = {}
-endtry
-
-sign define signBP text=BR
-
-call APPLY_BPS()
-
-autocmd BufReadPost * call APPLY_BPS()
-autocmd BufUnload   * call UPDATE_BPS()
-autocmd VimLeave    * call WRITE_BPS()
-
-function! s:ruby_bp_settings() abort
-  echomsg "Type <Space> to toggle break points and <q> to quit"
-
-  if &readonly
-    nnoremap <silent> <buffer> <Space> :call SET_BP()<CR>
-    nnoremap <silent> <buffer> q :<C-u>quit<CR>
-  endif
-endfunction
-
-" autocmd FileType ruby call s:ruby_bp_settings()
-autocmd BufEnter *.rb call s:ruby_bp_settings()
-
-call s:ruby_bp_settings()