byebug 2.7.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 818c1a2ce9a37a4dcbf84f6b3e4932335fe94e9d
-  data.tar.gz: d90fd4507ad0a2cd3c8c1f250852ae24d158161a
+  metadata.gz: aefd49bb6a9a42bed03f3bfd3e5c05b260460e16
+  data.tar.gz: 2123202331fe1df741b263453e287273383aeb3f
 SHA512:
-  metadata.gz: e6ee7f21fa7997aa8fa88aba5cfaf3135541013ca5e45411db5bacfdb7727c6c36492de7db70c811f036e85391c9692d03da98d24b33e607cded2d51da6ca4f0
-  data.tar.gz: 1751d22e086c298da4dc76311328e66e57cf9d779d33c14116c542c951515127fadfac72b5808e64db808c7c4c5440c05c7acb110e0640dc5f6c8f8c639cdc7b
+  metadata.gz: 27cb2714d6b8d457aed200e9c5beabaad6d94912e4ecc78c2bbdd3e809d8dce76834d49fdb02fbd89814c3e9bdeb01df5c9346ec777f5a9f4ca3f1fbab94b908
+  data.tar.gz: 72a02e12800f4b7b39d8b6f6b54615046ca80b7a774109ef60c5f18cfc4a959785a804f5ab204e926d984d7421c2c7f430f56a6f273c45ed1643a76627ea9398

data/.gitignore

@@ -2,15 +2,11 @@ tmp
 pkg
 doc
 
-.rvmrc
-.ruby-version
-.ruby-gemset
-.gdbinit
 .gdb_history
 .bundle
 .tags
-.ackrc
-.jrubyrc
+.byebugrc
+.byebug_hist
 
 Gemfile.lock
 

data/.travis.yml

@@ -2,6 +2,7 @@ before_script: bundle exec rake compile
 rvm:
 - 2.0.0
 - 2.1.0
+- 2.1.1
 - ruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# 3.0.0
+
+- Bugfixes
+ * Fix post_mortem mode
+ * Command history is also saved after regular program termination, not only
+after quitting with the `q` command.
+ * Fix failure when calling Byebug.start with Timeout::timeout (see #54), thanks
+@zmoazeni!
+
+- Changes
+ * `show commands` command for listing history of previous byebug commands now
+behaves like shell's `history` command.
+ * Changes in `history` commands: see
+[50e6ad8](https://github.com/deivid-rodriguez/byebug/commit/50e6ad8)
+ * Changes in `finish` semantics and in the C extension API: see
+[61f9b4d](https://github.com/deivid-rodriguez/byebug/commit/61f9b4d)
+ * The `init` option for Byebug.start has been removed. Information to make the
+`restart` command work is always saved now.
+
+- Features
+ * Allow disabling post_mortem mode
+
+
 # 2.7.0
 * Bugfix release (#52, #53 and #54)
 

data/Gemfile

@@ -1,3 +1,12 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'rake', '~> 10.2'
+
+group :development, :test do
+  gem 'rake-compiler', '~> 0.9'
+  gem 'mocha', '~> 1.0'
+  gem 'minitest', '~> 5.3'
+  gem 'coveralls', '~> 0.7'
+end

data/README.md

@@ -51,25 +51,20 @@ doesn't need them anymore so my recommendation is not to use them.
 
 ## What's different from debugger
 
-* Works on Ruby 2.x and it doesn't on 1.9.x.
-* Has no MRI internal source code dependencies, just a clean API.
-* Fixes all of debugger's open bugs in its issue tracker and provides some
-enhancements, such as a markdown guide or the fact that `byebug` can now be
-placed at the end of a block or method call.
+* Works on Ruby 2.x but it doesn't on 1.9.x (you should probably upgrade
+anyways).
+* Has no MRI internal source code dependencies, just a clean API (no more `bump
+ruby_core_source dependency` entries in CHANGELOG, no more broken debugger's on
+ruby's releases).
+* Fixes a lot of debugger's issues, such as ruby 2.x support or post_mortem
+debugging. It also provides several enhancements, such as the fact the `byebug`
+can now be placed at the end of a block or method call.
 * Actively mantained.
 * Editor agnostic: no external editor built-in support.
 * Pry command is built-in. No need of external gem like debugger-pry.
 
 
-## Semantic Versioning
-
-Byebug tries to follow [semantic versioning](http://semver.org). Backwards
-compatibility doesn't seem like a critic issue for a debugger because it's not
-supposed to be used permanently by any program, let alone in production
-environments. However, I still like the idea of giving some meaning to version
-changes.
-
-Byebug's public API is determined by its set of commands
+## Byebug's commands
 
     Command     | Aliases      | Subcommands
     ----------- |:------------ |:-----------
@@ -102,8 +97,8 @@ Byebug's public API is determined by its set of commands
     `reload`    |              |
     `restart`   |              |
     `save`      |              |
-    `set`       |              | `args` `autoeval` `autoirb` `autolist` `autoreload` `basename` `callstyle` `callstyle` `forcestep` `fullpath` `history` `linetrace` `linetrace_plus` `listsize` `post_mortem` `stack_on_error` `testing` `verbose` `width`
-    `show`      |              | `args` `autoeval` `autoirb` `autolist` `autoreload` `basename` `callstyle` `callstyle` `commands` `forcestep` `fullpath` `history` `linetrace` `linetrace_plus` `listsize` `post_mortem` `stack_on_error` `verbose` `width`
+    `set`       |              | `args` `autoeval` `autoirb` `autolist` `autoreload` `autosave` `basename` `callstyle` `callstyle` `forcestep` `fullpath` `histfile` `histsize` `linetrace` `linetrace_plus` `listsize` `post_mortem` `stack_on_error` `testing` `verbose` `width`
+    `show`      |              | `args` `autoeval` `autoirb` `autolist` `autoreload` `autosave` `basename` `callstyle` `callstyle` `commands` `forcestep` `fullpath` `histfile` `histsize` `linetrace` `linetrace_plus` `listsize` `post_mortem` `stack_on_error` `verbose` `width`
     `skip`      |              |
     `source`    |              |
     `step`      |              |
@@ -114,6 +109,15 @@ Byebug's public API is determined by its set of commands
     `var`       |              | `class` `constant` `global` `instance` `local` `ct`
 
 
+## Semantic Versioning
+
+Byebug tries to follow [semantic versioning](http://semver.org) and tries to
+bump major version only when backwards incompatible changes are released.
+Backwards compatibility is targeted to
+[pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) and any other
+plugins relying on `byebug`.
+
+
 ## Getting Started
 
 Read [byebug's markdown
@@ -124,7 +128,7 @@ started. Proper documentation will be eventually written.
 ## Related projects
 
 * [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) adds `next`,
-  `step`, `finish`, `continue` and `break` commands to pry using byebug.
+`step`, `finish`, `continue` and `break` commands to pry using byebug.
 * [ruby-debug-passenger](https://github.com/davejamesmiller/ruby-debug-passenger)
 adds a rake task that restarts Passenger with byebug connected.
 * [minitest-byebug](https://github.com/kaspth/minitest-byebug) starts a byebug
@@ -133,35 +137,34 @@ session on minitest failures.
 for ruby debugging on Sublime Text.
 
 
-## Future (possible) directions
+## TODO List (by priority)
 
-* JRuby support.
-* Libify and test byebug's executable.
+* Write tests for remote debugging support.
 * Add printers support.
-
+* Libify and test byebug's executable.
+* Support rubies other than MRI.
 
 ## Credits
 
 Everybody who has ever contributed to this forked and reforked piece of
 software, specially:
 
-* Kent Sibilev and Mark Moseley, original authors of
-[ruby-debug](https://github.com/mark-moseley/ruby-debug).
-* Gabriel Horner, [debugger](https://github.com/cldwalker/debugger)'s mantainer.
-* Koichi Sasada, author of the new C debugging API for Ruby.
-* Dennis Ushakov, author of [debase](https://github.com/denofevil/debase), the
+* @ko1, author of the awesome TracePoint API for Ruby.
+* @cldwalker, [debugger](https://github.com/cldwalker/debugger)'s mantainer.
+* @denofevil, author of [debase](https://github.com/denofevil/debase), the
 starting point of this.
 * @kevjames3 for testing, bug reports and the interest in the project.
+* @FooBarWidget for working and helping with remote debugging.
 
-[VersionBadge]: https://badge.fury.io/rb/byebug.png
+[VersionBadge]: https://badge.fury.io/rb/byebug.svg
 [VersionURL]: http://badge.fury.io/rb/byebug
-[TravisBadge]: https://travis-ci.org/deivid-rodriguez/byebug.png
+[TravisBadge]: https://travis-ci.org/deivid-rodriguez/byebug.svg
 [TravisURL]: http://travis-ci.org/deivid-rodriguez/byebug
-[CodeClimateBadge]: https://codeclimate.com/github/deivid-rodriguez/byebug.png
+[CodeClimateBadge]: https://img.shields.io/codeclimate/github/deivid-rodriguez/byebug.svg
 [CodeClimateURL]: https://codeclimate.com/github/deivid-rodriguez/byebug
-[GemnasiumBadge]: https://gemnasium.com/deivid-rodriguez/byebug.png
+[GemnasiumBadge]: https://gemnasium.com/deivid-rodriguez/byebug.svg
 [GemnasiumURL]: https://gemnasium.com/deivid-rodriguez/byebug
-[CoverallsBadge]: https://coveralls.io/repos/deivid-rodriguez/byebug/badge.png
+[CoverallsBadge]: http://img.shields.io/coveralls/deivid-rodriguez/byebug.svg
 [CoverallsURL]: https://coveralls.io/r/deivid-rodriguez/byebug
-[GittipBadge]: http://img.shields.io/gittip/deivid-rodriguez.png
+[GittipBadge]: http://img.shields.io/gittip/deivid-rodriguez.svg
 [GittipURL]: https://www.gittip.com/deivid-rodriguez

data/Rakefile

@@ -22,9 +22,7 @@ task :test do
   end
 end
 
-base_spec = eval(File.read('byebug.gemspec'), binding, 'byebug.gemspec')
-
-task :default => :test
+task default: :test
 
 desc 'Run a test in looped mode so that you can look for memory leaks'
 task 'test_loop' do

data/byebug.gemspec

@@ -25,10 +25,4 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'columnize', '~> 0.3'
   s.add_dependency 'debugger-linecache', '~> 1.2'
-
-  s.add_development_dependency 'rake', '~> 10.1'
-  s.add_development_dependency 'rake-compiler', '~> 0.9'
-  s.add_development_dependency 'mocha', '~> 1.0'
-  s.add_development_dependency 'minitest', '~> 5.2'
-  s.add_development_dependency 'coveralls', '~> 0.7'
 end

data/ext/byebug/byebug.c

@@ -10,6 +10,8 @@ static VALUE catchpoints = Qnil;
 static VALUE breakpoints = Qnil;
 static VALUE tracepoints = Qnil;
 
+static VALUE raised_exception = Qnil;
+
 /* Implements thread syncronization, we must stop threads when debugging */
 VALUE locker = Qnil;
 
@@ -158,9 +160,8 @@ call_at_catchpoint(VALUE context_obj, debug_context_t *dc, VALUE exp)
 static VALUE
 call_at_return(VALUE context_obj, debug_context_t *dc, VALUE file, VALUE line)
 {
-  dc->stop_reason = CTX_STOP_BREAKPOINT;
+  CTX_FL_UNSET(dc, CTX_FL_STOP_ON_RET);
   return call_at(context_obj, dc, rb_intern("at_return"), 2, file, line);
-
 }
 
 static void
@@ -240,6 +241,9 @@ call_event(VALUE trace_point, void *data)
 
   dc->calced_stack_size++;
 
+  if (CTX_FL_TEST(dc, CTX_FL_STOP_ON_RET))
+    dc->steps_out = dc->steps_out <= 0 ? -1 : dc->steps_out + 1;
+
   EVENT_COMMON
 
   breakpoint = Qnil;
@@ -269,7 +273,11 @@ return_event(VALUE trace_point, void *data)
 
   EVENT_COMMON
 
-  if (dc->calced_stack_size + 1 == dc->before_frame)
+  if (dc->steps_out == 1)
+  {
+    dc->steps = 1;
+  }
+  else if ((dc->steps_out == 0) && (CTX_FL_TEST(dc, CTX_FL_STOP_ON_RET)))
   {
     VALUE file, line;
 
@@ -279,11 +287,7 @@ return_event(VALUE trace_point, void *data)
     call_at_return(context, dc, file, line);
   }
 
-  if (dc->calced_stack_size + 1 == dc->after_frame)
-  {
-    reset_stepping_stop_points(dc);
-    dc->steps = 1;
-  }
+  dc->steps_out = dc->steps_out <= 0 ? -1 : dc->steps_out - 1;
 
   cleanup(dc);
 }
@@ -315,60 +319,55 @@ c_return_event(VALUE trace_point, void *data)
 static void
 raise_event(VALUE trace_point, void *data)
 {
-  VALUE expn_class, aclass;
-  VALUE err;
-  VALUE ancestors;
+  VALUE expn_class, ancestors;
+  VALUE path, lineno, binding, post_mortem_context;
   int i;
   debug_context_t *new_dc;
-  VALUE binding, path, lineno;
 
   EVENT_SETUP
 
-  err = rb_errinfo();
-
   EVENT_COMMON
 
-  binding = rb_tracearg_binding(trace_arg);
-  path    = rb_tracearg_path(trace_arg);
-  lineno  = rb_tracearg_lineno(trace_arg);
+  path             = rb_tracearg_path(trace_arg);
+  lineno           = rb_tracearg_lineno(trace_arg);
+  binding          = rb_tracearg_binding(trace_arg);
+  raised_exception = rb_tracearg_raised_exception(trace_arg);
 
   if (post_mortem == Qtrue)
   {
-    context = context_dup(dc);
-    rb_ivar_set(err, rb_intern("@__bb_file")   , path);
-    rb_ivar_set(err, rb_intern("@__bb_line")   , lineno);
-    rb_ivar_set(err, rb_intern("@__bb_binding"), binding);
-    rb_ivar_set(err, rb_intern("@__bb_context"), context);
+    post_mortem_context = context_dup(dc);
+    rb_ivar_set(raised_exception, rb_intern("@__bb_file")   , path);
+    rb_ivar_set(raised_exception, rb_intern("@__bb_line")   , lineno);
+    rb_ivar_set(raised_exception, rb_intern("@__bb_binding"), binding);
+    rb_ivar_set(raised_exception, rb_intern("@__bb_context"), post_mortem_context);
 
-    Data_Get_Struct(context, debug_context_t, new_dc);
+    Data_Get_Struct(post_mortem_context, debug_context_t, new_dc);
     rb_debug_inspector_open(context_backtrace_set, (void *)new_dc);
   }
 
-  expn_class = rb_obj_class(err);
-
-  if (catchpoints == Qnil || dc->calced_stack_size == 0 ||
-      CTX_FL_TEST(dc, CTX_FL_CATCHING) ||
+  if (catchpoints == Qnil ||
+      dc->calced_stack_size == 0 ||
       RHASH_TBL(catchpoints)->num_entries == 0)
   {
     cleanup(dc);
     return;
   }
 
+  expn_class = rb_obj_class(raised_exception);
   ancestors = rb_mod_ancestors(expn_class);
   for (i = 0; i < RARRAY_LENINT(ancestors); i++)
   {
-    VALUE mod_name;
-    VALUE hit_count;
+    VALUE ancestor_class, module_name, hit_count;
 
-    aclass    = rb_ary_entry(ancestors, i);
-    mod_name  = rb_mod_name(aclass);
-    hit_count = rb_hash_aref(catchpoints, mod_name);
+    ancestor_class = rb_ary_entry(ancestors, i);
+    module_name    = rb_mod_name(ancestor_class);
+    hit_count      = rb_hash_aref(catchpoints, module_name);
 
     /* increment exception */
     if (hit_count != Qnil)
     {
-      rb_hash_aset(catchpoints, mod_name, INT2FIX(FIX2INT(hit_count) + 1));
-      call_at_catchpoint(context, dc, err);
+      rb_hash_aset(catchpoints, module_name, INT2FIX(FIX2INT(hit_count) + 1));
+      call_at_catchpoint(context, dc, raised_exception);
       call_at_line(context, dc, path, lineno);
       break;
     }
@@ -678,7 +677,7 @@ bb_set_tracing(VALUE self, VALUE value)
  *  call-seq:
  *    Byebug.post_mortem? -> bool
  *
- *  Returns +true+ if post-moterm debugging is enabled.
+ *  Returns +true+ if post-mortem debugging is enabled.
  */
 static VALUE
 bb_post_mortem(VALUE self)
@@ -739,6 +738,18 @@ bb_add_catchpoint(VALUE self, VALUE value)
   return value;
 }
 
+/*
+ *  call-seq:
+ *    Byebug.raised_exception -> exception
+ *
+ *  Returns raised exception when in post_mortem mode.
+ */
+static VALUE
+bb_raised_exception(VALUE self)
+{
+  return raised_exception;
+}
+
 /*
  *   Document-class: Byebug
  *
@@ -752,22 +763,23 @@ Init_byebug()
 {
   mByebug = rb_define_module("Byebug");
 
-  rb_define_module_function(mByebug, "add_catchpoint" , bb_add_catchpoint ,  1);
-  rb_define_module_function(mByebug, "breakpoints"    , bb_breakpoints    ,  0);
-  rb_define_module_function(mByebug, "catchpoints"    , bb_catchpoints    ,  0);
-  rb_define_module_function(mByebug, "contexts"       , bb_contexts       ,  0);
-  rb_define_module_function(mByebug, "current_context", bb_current_context,  0);
-  rb_define_module_function(mByebug, "debug_load"     , bb_load           , -1);
-  rb_define_module_function(mByebug, "post_mortem?"   , bb_post_mortem    ,  0);
-  rb_define_module_function(mByebug, "post_mortem="   , bb_set_post_mortem,  1);
-  rb_define_module_function(mByebug, "_start"         , bb_start          ,  0);
-  rb_define_module_function(mByebug, "started?"       , bb_started        ,  0);
-  rb_define_module_function(mByebug, "stop"           , bb_stop           ,  0);
-  rb_define_module_function(mByebug, "thread_context" , bb_thread_context ,  1);
-  rb_define_module_function(mByebug, "tracing?"       , bb_tracing        ,  0);
-  rb_define_module_function(mByebug, "tracing="       , bb_set_tracing    ,  1);
-  rb_define_module_function(mByebug, "verbose"        , bb_verbose        ,  0);
-  rb_define_module_function(mByebug, "verbose="       , bb_set_verbose    ,  1);
+  rb_define_module_function(mByebug, "add_catchpoint"   , bb_add_catchpoint  ,  1);
+  rb_define_module_function(mByebug, "breakpoints"      , bb_breakpoints     ,  0);
+  rb_define_module_function(mByebug, "catchpoints"      , bb_catchpoints     ,  0);
+  rb_define_module_function(mByebug, "contexts"         , bb_contexts        ,  0);
+  rb_define_module_function(mByebug, "current_context"  , bb_current_context ,  0);
+  rb_define_module_function(mByebug, "debug_load"       , bb_load            , -1);
+  rb_define_module_function(mByebug, "post_mortem?"     , bb_post_mortem     ,  0);
+  rb_define_module_function(mByebug, "post_mortem="     , bb_set_post_mortem ,  1);
+  rb_define_module_function(mByebug, "raised_exception" , bb_raised_exception,  0);
+  rb_define_module_function(mByebug, "_start"           , bb_start           ,  0);
+  rb_define_module_function(mByebug, "started?"         , bb_started         ,  0);
+  rb_define_module_function(mByebug, "stop"             , bb_stop            ,  0);
+  rb_define_module_function(mByebug, "thread_context"   , bb_thread_context  ,  1);
+  rb_define_module_function(mByebug, "tracing?"         , bb_tracing         ,  0);
+  rb_define_module_function(mByebug, "tracing="         , bb_set_tracing     ,  1);
+  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);
 
@@ -777,5 +789,6 @@ Init_byebug()
   rb_global_variable(&breakpoints);
   rb_global_variable(&catchpoints);
   rb_global_variable(&tracepoints);
+  rb_global_variable(&raised_exception);
   rb_global_variable(&threads);
 }

data/ext/byebug/byebug.h

@@ -5,14 +5,14 @@
 #include <ruby/debug.h>
 
 /* flags */
-#define CTX_FL_CATCHING     (1<<1) /* catching of exceptions enabled         */
-#define CTX_FL_DEAD         (1<<2) /* this context belonged to a dead thread */
-#define CTX_FL_ENABLE_BKPT  (1<<3) /* cab check for breakpoints              */
-#define CTX_FL_FORCE_MOVE   (1<<4) /* don't stop unless we've changed line   */
-#define CTX_FL_IGNORE       (1<<5) /* this context belongs to ignored thread */
-#define CTX_FL_SUSPEND      (1<<6) /* thread currently suspended             */
-#define CTX_FL_TRACING      (1<<7) /* call at_tracing method                 */
-#define CTX_FL_WAS_RUNNING  (1<<8) /* thread was previously running          */
+#define CTX_FL_DEAD         (1<<1) /* this context belonged to a dead thread */
+#define CTX_FL_ENABLE_BKPT  (1<<2) /* can check for breakpoints              */
+#define CTX_FL_FORCE_MOVE   (1<<3) /* don't stop unless we've changed line   */
+#define CTX_FL_IGNORE       (1<<4) /* this context belongs to ignored thread */
+#define CTX_FL_SUSPEND      (1<<5) /* thread currently suspended             */
+#define CTX_FL_TRACING      (1<<6) /* call at_tracing method                 */
+#define CTX_FL_WAS_RUNNING  (1<<7) /* thread was previously running          */
+#define CTX_FL_STOP_ON_RET  (1<<8) /* can stop on method 'end'               */
 
 /* macro functions */
 #define CTX_FL_TEST(c,f)  ((c)->flags & (f))
@@ -35,11 +35,10 @@ typedef struct {
   VALUE thread;
   int thnum;
 
-  int dest_frame;
-  int lines;                   /* # of lines in dest_frame before stopping    */
-  int steps;                   /* # of steps before stopping                  */
-  int after_frame;             /* stop right after returning from this frame  */
-  int before_frame;            /* stop right before returning from this frame */
+  int dest_frame;              /* next stop's frame if stopped by next     */
+  int lines;                   /* # of lines in dest_frame before stopping */
+  int steps;                   /* # of steps before stopping               */
+  int steps_out;               /* # of returns before stopping             */
 
   VALUE last_file;
   VALUE last_line;