debug 1.0.0.beta5 → 1.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '039bd2cbfdb3a67bbd91603b077a4f4784235fb0c7b48721a4b9f27b493231c6'
-  data.tar.gz: f9605d076dff9d8571e70245baa5c2e97c2377cc7f92ee627cbc1f051361217b
+  metadata.gz: fffc4898e989a76e77a9076407cc1ba6d31b13a531e739c8972afe71bf049285
+  data.tar.gz: 190c18099e1078e00786dde75819b0b793647cd9508b0577e88d93d6a06c045c
 SHA512:
-  metadata.gz: f222a8b1ec58fd6f5264e61ee8613e6ed229c9ebff73c6b4904c4c6c2bded0d625b776fb510b23dec57636cf576a68d471f0b91d7b01d36f8baad741ff64fd38
-  data.tar.gz: 152431ba38203334bbf1c7449ff36a6d49f5116aaa78c017ca5ffa6d695ca87be06bc011822d0bbd325e15c46504385adf4ef94e74ebd37f97468f049da910e8
+  metadata.gz: 647e6c227bded49c962b8d6934557a26930664f5f1ddd57fd596c6651b1c655c1c77e64d5cbba28d2125cdd8a27817e33dc94d465d01f6b43b7f0be61ee30a35
+  data.tar.gz: ceb4dbf7b9479dc54ff5af725e973985493650ca9aaebd16878c4669fa037ae2ee1ec9ddddf83eb25dd65dc2057d0419a74005ec5d74c98585d855eb918e53bb

data/CONTRIBUTING.md

@@ -15,8 +15,6 @@ If you spot any problem, please open an issue.
 
 ```bash
 $ rake test
-# or
-$ ruby bin/test-unit.rb
 ```
 
 ### Run specific test(s)
@@ -27,6 +25,199 @@ $ ruby test/debug/bp_test.rb # run all tests in the specified file
 $ ruby test/debug/bp_test.rb -h # to see all the test options
 ```
 
+## Generate Tests
+There is a test generator in `debug.rb` project to make it easier to write tests.
+### Quickstart
+This section shows you how to create test file by test generator. For more advanced informations on creating tests, please take a look at [gentest options](#gentest-options). (You can also check by `$bin/gentest -h`)
+#### 1. Create a target file for debuggee.
+Let's say, we created `target.rb` which is located in top level directory of debugger.
+```ruby
+module Foo
+  class Bar
+    def self.a
+      "hello"
+    end
+  end
+  Bar.a
+  bar = Bar.new
+end
+```
+#### 2. Run `gentest` as shown in the example below.
+```shell
+$ bin/gentest target.rb
+```
+#### 3. Debugger will be executed. You can type any debug commands.
+```shell
+$ bin/gentest target.rb
+[1, 9] in ~/workspace/debug/target.rb
+=>    1| module Foo
+      2|   class Bar
+      3|     def self.a
+      4|       "hello"
+      5|     end
+      6|   end
+      7|   Bar.a
+      8|   bar = Bar.new
+      9| end
+=>#0	<main> at ~/workspace/debug/target.rb:1
+INTERNAL_INFO: {"location":"~/workspace/debug/target.rb:1","line":1}
+
+(rdbg)s
+ s
+[1, 9] in ~/workspace/debug/target.rb
+      1| module Foo
+=>    2|   class Bar
+      3|     def self.a
+      4|       "hello"
+      5|     end
+      6|   end
+      7|   Bar.a
+      8|   bar = Bar.new
+      9| end
+=>#0	<module:Foo> at ~/workspace/debug/target.rb:2
+  #1	<main> at ~/workspace/debug/target.rb:1
+INTERNAL_INFO: {"location":"~/workspace/debug/target.rb:2","line":2}
+
+(rdbg)n
+ n
+[1, 9] in ~/workspace/debug/target.rb
+      1| module Foo
+      2|   class Bar
+=>    3|     def self.a
+      4|       "hello"
+      5|     end
+      6|   end
+      7|   Bar.a
+      8|   bar = Bar.new
+      9| end
+=>#0	<class:Bar> at ~/workspace/debug/target.rb:3
+  #1	<module:Foo> at ~/workspace/debug/target.rb:2
+  #2	<main> at ~/workspace/debug/target.rb:1
+INTERNAL_INFO: {"location":"~/workspace/debug/target.rb:3","line":3}
+
+(rdbg)b 7
+ b 7
+INTERNAL_INFO: {"location":"~/workspace/debug/target.rb:3","line":3}
+
+(rdbg)c
+ c
+[2, 9] in ~/workspace/debug/target.rb
+      2|   class Bar
+      3|     def self.a
+      4|       "hello"
+      5|     end
+      6|   end
+=>    7|   Bar.a
+      8|   bar = Bar.new
+      9| end
+=>#0	<module:Foo> at ~/workspace/debug/target.rb:7
+  #1	<main> at ~/workspace/debug/target.rb:1
+
+Stop by #0  BP - Line  /Users/naotto/workspace/debug/target.rb:7 (line)
+INTERNAL_INFO: {"location":"~/workspace/debug/target.rb:7","line":7}
+
+(rdbg)q!
+ q!
+```
+#### 4. The test file will be created as `test/debug/foo_test.rb`.
+If the file already exists, **only method** will be added to it.
+```ruby
+# frozen_string_literal: true
+
+require_relative '../support/test_case'
+
+module DEBUGGER__
+  class FooTest < TestCase
+    def program
+      <<~RUBY
+        1| module Foo
+        1|   class Bar
+        2|     def self.a
+        3|       "hello"
+        4|     end
+        5|   end
+        6|   Bar.a
+        7|   bar = Bar.new
+        8| end
+      RUBY
+    end
+    
+    def test_foo
+      debug_code(program) do
+        type 's'
+        assert_line_num 2
+        assert_line_text([
+          /[1, 9] in .*/,
+          /      1| module Foo/,
+          /=>    2|   class Bar/,
+          /      3|     def self.a/,
+          /      4|       "hello"/,
+          /      5|     end/,
+          /      6|   end/,
+          /      7|   Bar.a/,
+          /      8|   bar = Bar.new/,
+          /      9| end/,
+          /=>#0	<module:Foo> at .*/,
+          /  #1	<main> at .*/
+        ])
+        type 'n'
+        assert_line_num 3
+        assert_line_text([
+          /[1, 9] in .*/,
+          /      1| module Foo/,
+          /      2|   class Bar/,
+          /=>    3|     def self.a/,
+          /      4|       "hello"/,
+          /      5|     end/,
+          /      6|   end/,
+          /      7|   Bar.a/,
+          /      8|   bar = Bar.new/,
+          /      9| end/,
+          /=>#0	<class:Bar> at .*/,
+          /  #1	<module:Foo> at .*/,
+          /  #2	<main> at .*/
+        ])
+        type 'b 7'
+        assert_line_text(//)
+        type 'c'
+        assert_line_num 7
+        assert_line_text([
+          /[2, 9] in .*/,
+          /      2|   class Bar/,
+          /      3|     def self.a/,
+          /      4|       "hello"/,
+          /      5|     end/,
+          /      6|   end/,
+          /=>    7|   Bar.a/,
+          /      8|   bar = Bar.new/,
+          /      9| end/,
+          /=>#0	<module:Foo> at .*/,
+          /  #1	<main> at .*/,
+          //,
+          /Stop by #0  BP - Line  .*/
+        ])
+        type 'q!'
+      end
+    end
+  end
+end
+```
+
+#### gentest options
+You can get more information about `gentest` here.
+
+The default method name is `test_foo` and the class name is `FooTest`. The file name will be `[Lowercase letters with "Test" removed from the class name]_test.rb`.
+```shell
+# run without any options(test method name will be `test_foo`, class name will be `FooTest`, file name will be `foo_test.rb`)
+$ bin/gentest target.rb
+# specify the class name(test method name will be `test_foo`, class name will be `StepTest`, file name will be `step_test.rb`)
+$ bin/gentest target.rb -c StepTest
+# specify the method name(test method name will be `test_step`, class name will be `FooTest`, file name will be `foo_test.rb`)
+$ bin/gentest target.rb -m test_step
+# specify class name and method name(test method name will be `test_step`, class name will be `StepTest`, file name will be `step_test.rb`.)
+$ bin/gentest target.rb -c StepTest -m test_step
+```
+
 ## To Update README
 
 This project generates `README.md` from the template `misc/README.md.erb`

data/README.md

@@ -11,7 +11,7 @@ New debug.rb has several advantages:
 * Remote debugging: Support remote debugging natively.
   * UNIX domain socket
   * TCP/IP
-  * VSCode/DAP integration (TODO)
+  * VSCode/DAP integration ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
 * Extensible: application can introduce debugging support with several methods
   * By `rdbg` command
   * By loading libraries with `-r` command line option
@@ -29,6 +29,16 @@ $ gem install debug --pre
 
 or specify `-Ipath/to/debug/lib` in `RUBYOPT` or each ruby command-line option, especially for debug this gem development.
 
+If you use Bundler, write the following line to your Gemfile. And use rdbg command with -c option.
+
+```
+gem "debug", ">= 1.0.0.beta"
+```
+
+```
+$ rdbg -c bundle exec ruby target.rb
+```
+
 # How to use
 
 ## Invoke with debugger
@@ -70,10 +80,6 @@ $ ruby -r debug/run target.rb
 # target.rb
 require 'debug/run' # start the debug console
 
-# or
-
-require 'debug/session'  # introduce the functionality
-DEBUGGER__.console       # and start the debug console
 # ... rest of program ...
 ```
 
@@ -300,11 +306,9 @@ $ rdbg --attach hostname 12345
 
 ### Initial scripts
 
-If there are `.rdbgrc` files are there at the current directory and the home directory, files are loaded as initial scripts which contains debugger commands. `RUBY_DEBUG_INIT_SCRIPT` environment variable can specify the initial script file.
-
-Initial scripts are evaluated at the first suspend timing (generally, it is the beginning of the target script). For example, you can set break points with `break file:123`.
+If there are `~/.rdbgrc`, the file is loaded as initial scripts which contains debugger commands at the beginning of debug session. `RUBY_DEBUG_INIT_SCRIPT` environment variable can specify the initial script file. You can write configurations in a file. For example, you can set break points with `break file:123` in `~/.rdbgrc`.
 
-If there are `.rdbgrc.rb` files at the current directory and the home directory, files are loaded as a ruby script at the initializing timing.
+If there are `~/.rdbgrc.rb` is available, it is loaded as a ruby script at same timing.
 
 ### Environment variables
 
@@ -453,8 +457,13 @@ exe/rdbg [options] -- [debuggee options]
 
 Debug console mode:
     -n, --nonstop                    Do not stop at the beginning of the script.
-    -e COMMAND                       execute debug command at the beginning of the script.
-    -x, --init-script=FILE           execute debug command in the FILE.
+    -e COMMAND                       Execute debug command at the beginning of the script.
+    -x, --init-script=FILE           Execute debug command in the FILE.
+        --no-rc                      Ignore ~/.rdbgrc
+        --no-color                   Disable colorize
+    -c, --command                    Enable command mode.
+                                     The first argument should be a command name in $PATH.
+                                     Example: 'rdbg -c bundle exec rake test'
 
     -O, --open                       Start remote debugging with opening the network port.
                                      If TCP/IP options are not given,
@@ -486,7 +495,6 @@ Attach mode:
 
 Other options:
     -h, --help                       Print help
-    -c, --command                    Command mode (first argument is command name)
         --util=NAME                  Utility mode (used by tools)
 
 NOTE

data/bin/gentest

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require_relative '../test/tool/test_builder'
+
+file_info = {}
+
+OptionParser.new do |opt|
+  opt.banner = 'Usage: bin/gentest [file] [option]'
+  opt.on('-m METHOD', 'Method name in the test file') do |m|
+    file_info[:method] = m
+  end
+  opt.on('-c CLASS', 'Class name in the test file') do |c|
+    file_info[:class] = c
+  end
+  opt.parse!(ARGV)
+end
+
+exit if ARGV.empty?
+
+DEBUGGER__::TestBuilder.new(ARGV, file_info[:method], file_info[:class]).start

data/exe/rdbg

@@ -1,24 +1,20 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/debug/client'
-
+require_relative '../lib/debug/config'
 config = DEBUGGER__.parse_argv(ARGV)
 
 case config[:mode]
 when :start
   require 'rbconfig'
 
-  if config[:remote]
-    start_mode = "debug/open"
-  else
-    start_mode = "debug/run"
-  end
+  libpath = File.join(File.expand_path(File.dirname(__dir__)), 'lib/debug')
+  start_mode = config[:remote] ? "open" : 'run'
+  cmd = config[:command] ? ARGV.shift : RbConfig.ruby
 
-  ::DEBUGGER__.config_to_env(config)
+  env = ::DEBUGGER__.config_to_env_hash(config)
+  env['RUBYOPT'] = "-r #{libpath}/#{start_mode}"
 
-  cmd = config[:command] ? ARGV.shift : RbConfig.ruby
-  exec({'RUBYOPT' => "-I#{File.expand_path(File.dirname(__dir__))}/lib -r #{start_mode}"},
-       cmd, *ARGV)
+  exec(env, cmd, *ARGV)
 
 when :attach
   require_relative "../lib/debug/client"
@@ -29,9 +25,9 @@ when :attach
 
   begin
     if ARGV.empty? && config[:port]
-      connect [config[:host], config[:port]].compact
+      DEBUGGER__::Client.new([config[:host], config[:port]].compact).connect
     else
-      connect ARGV
+      DEBUGGER__::Client.new(ARGV).connect
     end
   rescue DEBUGGER__::CommandLineOptionError
     puts opt.help

data/lib/debug.rb

@@ -1 +1,4 @@
+# frozen_string_literal: true
+
 require_relative 'debug/session'
+DEBUGGER__::start no_sigint_hook: true, nonstop: true

data/lib/debug/breakpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'color'
 
 module DEBUGGER__
@@ -62,6 +64,10 @@ module DEBUGGER__
       to_s
     end
 
+    def duplicable?
+      false
+    end
+
     class << self
       include Color
 
@@ -155,6 +161,11 @@ module DEBUGGER__
       end
     end
 
+    def duplicable?
+      # only binding.bp or DEBUGGER__.console are duplicable
+      @oneshot
+    end
+
     NearestISeq = Struct.new(:iseq, :line, :events)
 
     def try_activate

data/lib/debug/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 require 'io/console/size'
 
@@ -13,11 +15,11 @@ module DEBUGGER__
     begin
       require 'readline'
       def readline
-        Readline.readline("\n(rdb) ", true)
+        Readline.readline("\n(rdbg:remote) ", true)
       end
     rescue LoadError
       def readline
-        print "\n(rdb) "
+        print "\n(rdbg:remote) "
         gets
       end
     end
@@ -162,10 +164,6 @@ module DEBUGGER__
   end
 end
 
-def connect argv = ARGV
-  DEBUGGER__::Client.new(argv).connect
-end
-
 if __FILE__ == $0
-  connect
+  DEBUGGER__::Client.new(argv).connect
 end

data/lib/debug/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'irb/color'
   require "irb/color_printer"
@@ -9,7 +11,7 @@ module DEBUGGER__
   module Color
     if defined? IRB::Color.colorize
       def colorize str, color
-        if CONFIG[:use_colorize]
+        if !CONFIG[:no_color]
           IRB::Color.colorize str, color
         else
           str
@@ -23,7 +25,7 @@ module DEBUGGER__
 
     if defined? IRB::ColorPrinter.pp
       def color_pp obj
-        IRB::ColorPrinter.pp(obj, "")
+        IRB::ColorPrinter.pp(obj, "".dup)
       end
     else
       def color_pp obj
@@ -32,7 +34,7 @@ module DEBUGGER__
     end
 
     def colored_inspect obj
-      if CONFIG[:use_colorize]
+      if !CONFIG[:no_color]
         color_pp obj
       else
         obj.pretty_inspect