byebug 3.2.0 → 3.3.0

data/Gemfile

@@ -6,10 +6,12 @@ gem 'rake', '~> 10.3'
 
 group :development do
   gem 'rake-compiler', '~> 0.9'
-  gem 'mocha', '~> 1.1'
-  gem 'minitest', '~> 5.4'
+  gem 'rubocop', '~> 0.25'
 end
 
 group :test do
-  gem 'codeclimate-test-reporter', '~> 0.4', require: nil
+  gem 'mocha', '~> 1.1'
+  gem 'minitest', '~> 5.4'
+  gem 'simplecov', '~> 0.9', require: false
+  gem 'codeclimate-test-reporter', '~> 0.4', require: false
 end

data/README.md

@@ -71,7 +71,7 @@ both rails and rspec have deprecated these flags in their latest versions.
     `frame`     |              |
     `help`      |              |
     `history`   |              |
-    `info`      |              | `args` `breakpoints` `catch` `display` `file` `files` `global_variables` `instance_variables` `line` `locals` `program` `variables`
+    `info`      |              | `args` `breakpoints` `catch` `display` `file` `files` `line` `program`
     `irb`       |              |
     `kill`      |              |
     `list`      |              |
@@ -95,7 +95,7 @@ both rails and rspec have deprecated these flags in their latest versions.
     `tracevar`  |              |
     `undisplay` |              |
     `up`        |              |
-    `var`       |              | `class` `constant` `global` `instance` `local`
+    `var`       |              | `all` `class` `constant` `global` `instance` `local`
 
 
 ## Semantic Versioning
@@ -130,7 +130,6 @@ for ruby debugging on Sublime Text.
 
 * Write tests for remote debugging support.
 * Add printers support.
-* Libify and test byebug's executable.
 * Support rubies other than MRI.
 
 ## Credits

data/Rakefile

@@ -6,10 +6,14 @@ Rake::ExtensionTask.new('byebug') do |ext|
   ext.lib_dir = 'lib/byebug'
 end
 
-# Override default rake tests loader
-class Rake::TestTask
-  def rake_loader
-    'test/test_helper.rb'
+module Rake
+  #
+  # Overrides default rake tests loader
+  #
+  class TestTask
+    def rake_loader
+      'test/test_helper.rb'
+    end
   end
 end
 
@@ -18,7 +22,7 @@ task :test do
   Rake::TestTask.new do |t|
     t.verbose = true
     t.warning = true
-    t.pattern = 'test/*_test.rb'
+    t.pattern = 'test/**/*_test.rb'
   end
 end
 
@@ -26,8 +30,8 @@ task default: :test
 
 desc 'Run a test in looped mode so that you can look for memory leaks'
 task 'test_loop' do
-  code = %Q[loop{ require '#{$*[1]}' }]
-  cmd = %Q[ruby -Itest -e "#{ code }"]
+  code = %(loop{ require '#{$ARGV[1]}' })
+  cmd = %(ruby -Itest -e "#{ code }")
   system cmd
 end
 

data/bin/byebug

@@ -1,255 +1,5 @@
 #!/usr/bin/env ruby
 
-#=== Summary
-#
-#A command-line front-end to <tt>byebug</tt>
-#
-#Command invocation:
-#
-#   byebug [options] [--] [script-options] ruby-script-to-debug
-#   byebug [options] [script-options]
-#   byebug [--version | --help]
-#
-#=== Options
-#
-#<tt>-d | --debug</tt>::
-#    Set $DEBUG true.
-#
-#<tt>--help</tt>::
-#      Show invocation help and exit.
-#
-#<tt>-I | --include</tt> <i>path</i>
-#    Add <i>path</i> to <tt>$LOAD_PATH</tt>. Like the <tt>ruby -I</tt> command,
-#    it supports multiple load paths separated by colons.
-#
-#<tt>--post-mortem</tt>::
-#    Activate post-mortem mode.
-#
-#<tt>--no-quit</tt>::
-#    Do not quit when script terminates. Instead rerun the program.
-#
-#<tt>--no-stop</tt>::
-#    Do not stop when script is loaded.
-#
-#<tt>--nx</tt>::
-#    Don’t execute commands found in any initialization files like
-#    <tt>.byebugrc</tt>.
-#
-#<tt>-r | --require</tt><i>script</i>::
-#    Require the library, before executing your script.
-#
-#<tt>--script</tt>=<i>file</i>::
-#    Run script file <i>file</i>
-#
-#<tt>--v</tt>::
-#    Print the version number, then turn on verbose mode if a script name is
-#    given. If no script name is given just exit after printing the version
-#    number.
-#
-#<tt>--verbose</tt>::
-#    Turn on verbose mode.
-#
-#<tt>--version</tt>::
-#    Show the version number and exit.
-#
-#<tt>-x | --trace</tt>::
-#    Show lines before executing them.
-#
+require 'byebug/runner'
 
-require 'optparse'
-require 'ostruct'
-require File.dirname(__FILE__) + "/../lib/byebug"
-
-def debug_program(options)
-  # Make sure Ruby script syntax checks okay.
-  output = `ruby -c "#{Byebug::PROG_SCRIPT}" 2>&1`
-  if $?.exitstatus != 0
-    puts output
-    exit $?.exitstatus
-  end
-  if bt = Byebug.debug_load(Byebug::PROG_SCRIPT, options.stop)
-    p bt, bt.backtrace
-  end
-end
-
-#
-# Do a shell-like path lookup for prog_script and return the results. If we
-# can't find anything return prog_script.
-#
-def whence_file(prog_script)
-  if prog_script.index(File::SEPARATOR)
-    # Don't search since this name has path separator components
-    return prog_script
-  end
-
-  for dirname in ENV['PATH'].split(File::PATH_SEPARATOR) do
-    prog_script_try = File.join(dirname, prog_script)
-    return prog_script_try if File.exist?(prog_script_try)
-  end
-
-  # Failure
-  return prog_script
-end
-
-options = OpenStruct.new(
-  'nx'                 => false,
-  'post_mortem'        => false,
-  'quit'               => true,
-  'restart_script'     => nil,
-  'script'             => nil,
-  'server'             => nil,
-  'stop'               => true,
-  'tracing'            => false,
-)
-
-def process_options(options)
-  program = File.basename($0)
-  opts = OptionParser.new do |opts|
-    opts.banner = <<EOB
-#{program} #{Byebug::VERSION}
-Usage: #{program} [options] <script.rb> -- <script.rb parameters>
-EOB
-    opts.separator ""
-    opts.separator "Options:"
-
-    opts.on("-d", "--debug", "Set $DEBUG=true") {
-      $DEBUG = true }
-    opts.on('-I', '--include PATH', String,
-            'Add PATH (single or multiple:path:list) to $LOAD_PATH.') {
-      |path| $LOAD_PATH.unshift(*path.split(':')) }
-    opts.on('--no-quit', 'Do not quit when script finishes') {
-      options.quit = false }
-    opts.on('--no-stop', 'Do not stop when script is loaded') {
-      options.stop = false }
-    opts.on('-nx', 'Don\'t run any byebug initialization files') {
-      options.nx = true }
-    opts.on('--post-mortem', 'Run byebug in post-mortem mode') {
-      options.post_mortem = true }
-    opts.on('-r', '--require SCRIPT', String, 'Require library before script') {
-      |name| if name == 'debug'
-        puts 'byebug not compatible with Ruby\'s \'debug\' lib, option ignored'
-      else
-        require name
-      end }
-    opts.on('-R', '--remote HOST[:PORT]', String, 'Specify byebug server spec') {
-      |server| host, port = server.split(':', 2)
-      host = 'localhost' if host.empty?
-      port = nil if port && port.empty?
-      port &&= port.to_i
-      options.server = [host, port].compact
-    }
-    opts.on('--restart-script FILE', String,
-            'Name of the script file to run. Erased after read') do
-      |restart_script|
-      options.restart_script = restart_script
-      unless File.exist?(options.restart_script)
-        puts "Script file '#{options.restart_script}' is not found"
-        exit
-      end
-    end
-    opts.on('--script FILE', String, 'Name of the script file to run') do
-      |script|
-      options.script = script
-      unless File.exist?(options.script)
-        puts "Script file '#{options.script}' is not found"
-        exit
-      end
-    end
-    opts.on('-x', '--trace', 'Turn on line tracing') {
-      options.tracing = true }
-
-    opts.separator ''
-    opts.separator 'Common options:'
-    opts.on_tail('--help', 'Show this message') do
-      puts opts
-      exit
-    end
-    opts.on_tail('--version', 'Print program version') do
-      puts "byebug #{Byebug::VERSION}"
-      exit
-    end
-    opts.on_tail('-v', 'Print version number, then turn on verbose mode') do
-      puts "byebug #{Byebug::VERSION}"
-      $VERBOSE = true
-    end
-  end
-  return opts
-end
-
-# What file is used for byebug startup commands.
-unless defined?(OPTS_INITFILE)
-  OPTS_INITFILE = '.byebugoptrc'
-  HOME_DIR = ENV['HOME'].to_s
-end
-
-begin
-  initfile = File.join(HOME_DIR, OPTS_INITFILE)
-  eval(File.read(initfile)) if File.exist?(initfile)
-rescue
-end
-
-opts = process_options(options)
-
-begin
-  Byebug::BYEBUG_SCRIPT = File.expand_path(__FILE__)
-  Byebug::IGNORED_FILES << Byebug::BYEBUG_SCRIPT
-  opts.parse! ARGV
-rescue StandardError => e
-  puts opts
-  puts
-  puts e.message
-  exit(-1)
-end
-
-if options.server
-  puts "Connecting to byebug server #{options.server.join(':')}"
-  Byebug.start_client(*options.server)
-  exit
-end
-
-if ARGV.empty?
-  puts opts
-  puts
-  puts 'Must specify a script to run'
-  exit(-1)
-end
-
-# Save debugged program
-prog_script = ARGV.shift
-prog_script = whence_file(prog_script) unless File.exist?(prog_script)
-Byebug::PROG_SCRIPT = File.expand_path prog_script
-
-# Set up trace hook for byebug
-Byebug.start
-
-# load initrc script (e.g. .byebugrc)
-Byebug.run_init_script(StringIO.new) unless options.nx
-
-Byebug::Setting[:post_mortem] = options.post_mortem
-
-# run restore-settings startup script if specified
-if options.restart_script
-  require 'fileutils'
-  Byebug.run_script(options.restart_script)
-  FileUtils.rm(options.restart_script)
-end
-
-# run startup script if specified
-if options.script
-  Byebug.run_script(options.script)
-end
-
-options.stop = false if options.tracing
-Byebug::Setting[:linetrace] = options.tracing
-
-loop do
-  debug_program(options)
-
-  break if options.quit
-
-  interface = Byebug::LocalInterface.new
-  # Not sure if ControlCommandProcessor is really the right
-  # thing to use. CommandProcessor requires a state.
-  processor = Byebug::ControlCommandProcessor.new(interface)
-  processor.process_commands
-end
+Byebug::Runner.new.run

data/byebug.gemspec

@@ -7,22 +7,25 @@ Gem::Specification.new do |s|
   s.email       = 'deivid.rodriguez@mail.com'
   s.license     = 'BSD'
   s.homepage    = 'http://github.com/deivid-rodriguez/byebug'
-  s.summary     = %q{Ruby 2.0 fast debugger - base + cli}
-  s.description = %q{Byebug is a Ruby 2 debugger. It's implemented using the
+  s.summary     = 'Ruby 2.0 fast debugger - base + CLI'
+  s.description = "Byebug is a Ruby 2 debugger. It's implemented using the
     Ruby 2 TracePoint C API for execution control and the Debug Inspector C API
     for call stack navigation.  The core component provides support that
     front-ends can build on. It provides breakpoint handling and bindings for
     stack frames among other things and it comes with an easy to use command
-    line interface.}
+    line interface."
 
   s.required_ruby_version     = '>= 2.0.0'
 
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- test/*`.split("\n")
+  s.bindir           = 'bin'
   s.executables      = ['byebug']
-  s.extra_rdoc_files = ['README.md']
+  s.extra_rdoc_files = %w(README.md GUIDE.md)
   s.extensions       = ['ext/byebug/extconf.rb']
+  s.require_path     = 'lib'
 
   s.add_dependency 'columnize', '~> 0.8'
+  s.add_dependency 'slop', '~> 3.6'
   s.add_dependency 'debugger-linecache', '~> 1.2'
 end

data/ext/byebug/byebug.c

@@ -12,12 +12,11 @@ static VALUE tracepoints = Qnil;
 
 static VALUE raised_exception = Qnil;
 
-/* Implements thread syncronization, we must stop threads when debugging */
+/* To allow thread syncronization, we must stop threads when debugging */
 VALUE locker = Qnil;
 
-/* Threads table */
+/* Hash table with active threads and their associated contexts */
 VALUE threads = Qnil;
-VALUE cThreadsTable;
 
 #define IS_STARTED  (catchpoints != Qnil)
 static void
@@ -34,15 +33,13 @@ trace_print(rb_trace_arg_t *trace_arg, debug_context_t *dc)
 {
   if (trace_arg)
   {
-    int i = 0;
     const char *event = rb_id2name(SYM2ID(rb_tracearg_event(trace_arg)));
     char *path = RSTRING_PTR(rb_tracearg_path(trace_arg));
     int line = NUM2INT(rb_tracearg_lineno(trace_arg));
-    VALUE v_mid = rb_tracearg_method_id(trace_arg);
-    const char *mid = NIL_P(v_mid) ? "" : rb_id2name(SYM2ID(v_mid));
-
-    for (i = 0; i < dc->calced_stack_size; i++) putc('-', stdout);
-    printf("(%d)->[#%d] %s@%s:%d %s\n",
+    VALUE v_mid_sym = rb_tracearg_method_id(trace_arg);
+    VALUE v_mid_id = NIL_P(v_mid_sym) ? Qnil : SYM2ID(v_mid_sym);
+    const char *mid = NIL_P(v_mid_id) ? "" : rb_id2name(v_mid_id);
+    printf("%*s (%d)->[#%d] %s@%s:%d %s\n", dc->calced_stack_size, "",
            dc->calced_stack_size, dc->thnum, event, path, line, mid);
   }
 }
@@ -55,7 +52,7 @@ cleanup(debug_context_t *dc)
   dc->stop_reason = CTX_STOP_NONE;
 
   /* checks for dead threads */
-  check_thread_contexts();
+  check_threads_table();
 
   /* release a lock */
   locker = Qnil;
@@ -72,9 +69,10 @@ cleanup(debug_context_t *dc)
   VALUE context;                                                        \
   thread_context_lookup(rb_thread_current(), &context);                 \
   Data_Get_Struct(context, debug_context_t, dc);                        \
-  if (verbose == Qtrue) trace_print(trace_arg, dc);                     \
 
-#define EVENT_COMMON if (!trace_common(trace_arg, dc)) { return; }
+#define EVENT_COMMON                                                    \
+  if (verbose == Qtrue) trace_print(trace_arg, dc);                     \
+  if (!trace_common(trace_arg, dc)) { return; }                         \
 
 static int
 trace_common(rb_trace_arg_t *trace_arg, debug_context_t *dc)
@@ -216,7 +214,7 @@ line_event(VALUE trace_point, void *data)
       if (dc->calced_stack_size < dc->dest_frame)
       {
         dc->dest_frame = dc->calced_stack_size;
-        rb_funcall(mByebug, rb_intern("print"), 1,
+        rb_funcall(mByebug, rb_intern("puts"), 1,
           rb_str_new2("Next went up a frame because previous frame finished\n"));
       }
     }
@@ -458,8 +456,8 @@ bb_contexts(VALUE self)
     rb_ary_push(new_list, context);
   }
 
-  threads_clear(threads);
   Data_Get_Struct(threads, threads_table_t, t_tbl);
+  st_clear(t_tbl->tbl);
 
   for (i = 0; i < RARRAY_LENINT(new_list); i++)
   {
@@ -569,7 +567,7 @@ bb_start(VALUE self)
     locker      = Qnil;
     breakpoints = rb_ary_new();
     catchpoints = rb_hash_new();
-    threads     = threads_create();
+    threads     = create_threads_table();
 
     register_tracepoints(self);
     result = Qtrue;
@@ -606,6 +604,8 @@ bb_load(int argc, VALUE *argv, VALUE self)
   context = bb_current_context(self);
   Data_Get_Struct(context, debug_context_t, dc);
 
+  dc->calced_stack_size = 1;
+
   if (RTEST(stop)) dc->steps = 1;
 
   /* Initializing $0 to the script's path */
@@ -709,7 +709,7 @@ bb_set_post_mortem(VALUE self, VALUE value)
 static VALUE
 bb_breakpoints(VALUE self)
 {
-  return breakpoints;
+  return NIL_P(breakpoints) ? rb_ary_new() : breakpoints;
 }
 
 /*
@@ -783,8 +783,7 @@ Init_byebug()
   rb_define_module_function(mByebug, "verbose?"         , bb_verbose         ,  0);
   rb_define_module_function(mByebug, "verbose="         , bb_set_verbose     ,  1);
 
-  cThreadsTable = rb_define_class_under(mByebug, "ThreadsTable", rb_cObject);
-
+  Init_threads_table(mByebug);
   Init_context(mByebug);
   Init_breakpoint(mByebug);