byebug 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a787d2a2fe1495951f6d362e0f95dde1f3950dd8
-  data.tar.gz: 4c188b52f8f94ee320f2401f90006cbfb5ad65cb
+  metadata.gz: 6a40151455c8ac55d4a9ef4c78744ab3b84aa31c
+  data.tar.gz: c29114c8ea62f89f2e323d734fc75d2e611f7cb0
 SHA512:
-  metadata.gz: 4130241116b86b89c3a6e9f422ce80bdd37b18b327f82542d34781c24ddfd414dc1dd92f4aa200ef84360036b37cc0ce223998444ee1b62fd209350cd2a73560
-  data.tar.gz: d24a84f9ebaf2b0ed2ea0d3265a6f2387f46e95ee43bc381fa4227f5dc0ade510da11e904754ed8cabaf42b8e39b7da6f498e6afaeb7c676166c2180fe590736
+  metadata.gz: 8aba52de48ca4f73cb7f433a9a2b3c602d3fb345ccc32bdfc1ff9ebe5353f414c354f53d6490d0f13c852ff9837128285a1b876f80104abbec0ed6eff3b52465
+  data.tar.gz: 89d9717c9be932067b9405b5e2dd51f7d08a5e7857887b010206256cacffdd7663b3da1c90badafe903b87a5ccaa759534b21b7eae90182ac2e7d0c9ca7d05d5

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 2.4.0
+
+* Use `require` instead of `require_relative` for loading byebug's extension
+library (thanks @nobu)
+* Adds back `debugger` as an alias to `byebug` (thanks @wallace)
+* Adds -R option to byebug's binary to specify server's hostname:port for remote
+debugging (thanks @mrkn)
+* Fixes `thread list` showing too many threads
+* Change in tracing global variables. Use `trace variable foo` instead of `trace
+variable $foo`
+* Fix setting post mortem mode with `set post_mortem`. Now this is the only
+post mortem functionality available as specifying `Byebug.post_mortem` with a
+block has been removed in this version.
+
+
 # 2.3.1
 
 * Fixes bug preventing users from deleting breakpoints

data/README.md

@@ -25,11 +25,6 @@ effects of one bug and go on to learn about another.
 
     $ gem install byebug
 
-**Please upgrade your ruby to 2.0.0-p247 or higher** - a bug in ruby core was
-directly affecting byebug and a fix for it has been released with this
-patchlevel (see [#5](https://github.com/deivid-rodriguez/byebug/issues/5) for
-more information)
-
 
 ## Usage
 
@@ -47,11 +42,8 @@ Former [debugger](https://github.com/cldwalker/debugger) or
 * Some gems (rails, rspec) implement debugging flags (-d, --debugger) that early
 require and start the debugger. These flags are a performance penalty and Byebug
 doesn't need them anymore so my recommendation is not to use them.
-* Stopping execution using the word `debugger` doesn't work anymore unless you
-explicitly alias it. Similarly, the startup configuration file is now called
-`.byebugrc` instead of `.rdebugrc`.
-* `autoreload`, `autoeval` and `autolist` are default options in Byebug so you
-no longer need to set them in the startup file.
+* The startup configuration file is now called `.byebugrc` instead of
+`.rdebugrc`.
 
 
 ## What's different from debugger
@@ -61,7 +53,7 @@ no longer need to set them in the startup file.
 * 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.
-* Very actively mantained.
+* Actively mantained.
 * Editor agnostic: no external editor built-in support.
 * Pry command is built-in. No need of external gem like debugger-pry.
 

data/Rakefile

@@ -6,12 +6,19 @@ Rake::ExtensionTask.new('byebug')
 
 SO_NAME = "byebug.so"
 
+# Override default rake tests loader
+class Rake::TestTask
+  def rake_loader
+    'test/test_helper.rb'
+  end
+end
+
 desc "Run MiniTest suite"
 task :test do
-  Rake::TestTask.new(:test) do |t|
-    t.test_files = FileList["test/*_test.rb"]
-    t.warning = true
+  Rake::TestTask.new do |t|
     t.verbose = true
+    t.warning = true
+    t.pattern = 'test/*_test.rb'
   end
 end
 

data/bin/byebug

@@ -93,6 +93,7 @@ options = OpenStruct.new(
   'quit'               => true,
   'restart_script'     => nil,
   'script'             => nil,
+  'server'             => nil,
   'stop'               => true,
   'tracing'            => false,
 )
@@ -126,11 +127,18 @@ EOB
       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.exists?(options.restart_script)
+      unless File.exist?(options.restart_script)
         puts "Script file '#{options.restart_script}' is not found"
         exit
       end
@@ -138,7 +146,7 @@ EOB
     opts.on('--script FILE', String, 'Name of the script file to run') do
       |script|
       options.script = script
-      unless File.exists?(options.script)
+      unless File.exist?(options.script)
         puts "Script file '#{options.script}' is not found"
         exit
       end
@@ -191,6 +199,12 @@ rescue StandardError => e
   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

data/byebug.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 10.1.0'
   s.add_development_dependency 'rake-compiler', '~> 0.9.1'
   s.add_development_dependency 'mocha', '~> 0.14.0'
+  s.add_development_dependency 'minitest', '~> 5.0.8'
 end

data/ext/byebug/byebug.c

@@ -649,59 +649,6 @@ bb_set_verbose(VALUE self, VALUE value)
   return value;
 }
 
-static VALUE
-set_current_skipped_status(VALUE status)
-{
-  VALUE context;
-  debug_context_t *dc;
-
-  context = bb_current_context(mByebug);
-  Data_Get_Struct(context, debug_context_t, dc);
-
-  if (status)
-    CTX_FL_SET(dc, CTX_FL_SKIPPED);
-  else
-    CTX_FL_UNSET(dc, CTX_FL_SKIPPED);
-
-  return Qnil;
-}
-
-static VALUE
-debug_at_exit_c(VALUE proc)
-{
-  return rb_funcall(proc, rb_intern("call"), 0);
-}
-
-static void
-debug_at_exit_i(VALUE proc)
-{
-  if (IS_STARTED)
-  {
-    set_current_skipped_status(Qtrue);
-    rb_ensure(debug_at_exit_c, proc, set_current_skipped_status, Qfalse);
-  }
-  else
-    debug_at_exit_c(proc);
-}
-
-/*
- *  call-seq:
- *    Byebug.debug_at_exit { block } -> proc
- *
- *  Register <tt>at_exit</tt> hook which is escaped from byebug.
- */
-static VALUE
-bb_at_exit(VALUE self)
-{
-  VALUE proc;
-
-  if (!rb_block_given_p()) rb_raise(rb_eArgError, "called without a block");
-
-  proc = rb_block_proc();
-  rb_set_end_proc(debug_at_exit_i, proc);
-  return proc;
-}
-
 /*
  *  call-seq:
  *    Byebug.tracing -> bool
@@ -810,7 +757,6 @@ Init_byebug()
   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_at_exit"  , bb_at_exit        ,  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);

data/ext/byebug/byebug.h

@@ -10,10 +10,9 @@
 #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_SKIPPED      (1<<6) /* skip all events                        */
-#define CTX_FL_SUSPEND      (1<<7) /* thread currently suspended             */
-#define CTX_FL_TRACING      (1<<8) /* call at_tracing method                 */
-#define CTX_FL_WAS_RUNNING  (1<<9) /* thread was previously running          */
+#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          */
 
 /* macro functions */
 #define CTX_FL_TEST(c,f)  ((c)->flags & (f))

data/ext/byebug/extconf.rb

@@ -10,7 +10,7 @@ end
 if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc/
   $CFLAGS ||= ''
   $CFLAGS += ' -Wall -Werror -Wno-unused-parameter'
-  $CFLAGS += ' -gdwarf-2 -g3' if ENV['debug']
+  $CFLAGS += ' -gdwarf-2 -g3 -O0' if ENV['debug']
 end
 
 dir_config("ruby")

data/lib/byebug.rb

@@ -1,4 +1,4 @@
-require_relative 'byebug.so'
+require 'byebug.so'
 require_relative 'byebug/version'
 require_relative 'byebug/context'
 require_relative 'byebug/processor'
@@ -134,10 +134,10 @@ module Byebug
     #
     def run_init_script(out = handler.interface)
       cwd_script  = File.expand_path(File.join(".", INITFILE))
-      run_script(cwd_script, out) if File.exists?(cwd_script)
+      run_script(cwd_script, out) if File.exist?(cwd_script)
 
       home_script = File.expand_path(File.join(ENV['HOME'].to_s, INITFILE))
-      if File.exists?(home_script) and cwd_script != home_script
+      if File.exist?(home_script) and cwd_script != home_script
          run_script(home_script, out)
       end
     end
@@ -152,53 +152,24 @@ module Byebug
     end
 
     #
-    # Activates the post-mortem mode. There are two ways of using it:
+    # Activates the post-mortem mode.
     #
-    # == Global post-mortem mode
-    # By calling Byebug.post_mortem method without a block, you install an
-    # at_exit hook that intercepts any exception not handled by your script
-    # and enables post-mortem mode.
+    # By calling Byebug.post_mortem method, you install an at_exit hook that
+    # intercepts any exception not handled by your script and enables
+    # post-mortem mode.
     #
-    # == Local post-mortem mode
-    #
-    # If you know that a particular block of code raises an exception you can
-    # enable post-mortem mode by wrapping this block with Byebug.post_mortem,
-    # e.g.
-    #
-    #   def offender
-    #      raise 'error'
-    #   end
-    #   Byebug.post_mortem do
-    #      ...
-    #      offender
-    #      ...
-    #   end
     def post_mortem
-      if block_given?
-        old_post_mortem = self.post_mortem?
-        begin
-          self.post_mortem = true
-          yield
-        rescue Exception => exp
-          handle_post_mortem(exp)
-          raise
-        ensure
-          self.post_mortem = old_post_mortem
-        end
-      else
-        return if self.post_mortem?
-        self.post_mortem = true
-        debug_at_exit do
-          handle_post_mortem($!) if post_mortem?
-        end
-      end
+      return if self.post_mortem?
+      at_exit { handle_post_mortem($!) if post_mortem? }
+      self.post_mortem = true
     end
 
     def handle_post_mortem(exp)
-      return if !exp || !exp.__bb_context || !exp.__bb_context.calced_stack_size
+      return if !exp
+      Byebug.last_exception = exp
+      return if !exp.__bb_context || !exp.__bb_context.calced_stack_size
       orig_tracing = Byebug.tracing?
       Byebug.tracing = false
-      Byebug.last_exception = exp
       handler.at_line(exp.__bb_context, exp.__bb_file, exp.__bb_line)
     ensure
       Byebug.tracing = orig_tracing
@@ -224,4 +195,6 @@ module Kernel
     end
     Byebug.current_context.step_into steps_into if steps_into >= 0
   end
+
+  alias_method :debugger, :byebug
 end

data/lib/byebug/command.rb

@@ -23,12 +23,16 @@ module Byebug
         @commands ||= []
       end
 
-      DEF_OPTIONS = { allow_in_control:     false,
-                      allow_in_post_mortem: true ,
-                      event:                true ,
-                      always_run:           0    ,
-                      unknown:              false,
-                      need_context:         false } unless defined?(DEF_OPTIONS)
+      attr_accessor :allow_in_control, :unknown, :need_context
+      attr_writer :allow_in_post_mortem, :always_run
+
+      def allow_in_post_mortem
+        @allow_in_post_mortem ||= !defined?(@allow_in_post_mortem) ? true : false
+      end
+
+      def always_run
+        @always_run ||= 0
+      end
 
       def help(args)
         if args && args[1]
@@ -73,9 +77,6 @@ module Byebug
       end
 
       def inherited(klass)
-        DEF_OPTIONS.each do |o, v|
-          klass.options[o] = v if klass.options[o].nil?
-        end
         commands << klass
       end
 
@@ -86,22 +87,6 @@ module Byebug
           |name| Byebug.const_get(name) }.each { |mod| include mod }
       end
 
-      def method_missing(meth, *args, &block)
-        if meth.to_s =~ /^(.+?)=$/
-          options[$1.intern] = args.first
-        else
-          if options.has_key?(meth)
-            options[meth]
-          else
-            super
-          end
-        end
-      end
-
-      def options
-        @options ||= {}
-      end
-
       def settings_map
         @@settings_map ||= {}
       end
@@ -143,7 +128,7 @@ module Byebug
 
       def command_exists?(command)
         ENV['PATH'].split(File::PATH_SEPARATOR).any? {
-          |d| File.exists? File.join(d, command) }
+          |d| File.exist? File.join(d, command) }
       end
 
       def terminal_width
@@ -155,7 +140,6 @@ module Byebug
           nil
         end
       end
-
     end
 
     # Register default settings
@@ -193,7 +177,7 @@ module Byebug
         begin
           eval(str, b)
         rescue StandardError, ScriptError => e
-          at = eval("Thread.current.backtrace_locations", b)
+          at = eval('Thread.current.backtrace_locations(1)', b)
           print "#{at.shift}: #{e.class} Exception(#{e.message})\n"
           for i in at
             print "\tfrom #{i}\n"

data/lib/byebug/commands/breakpoints.rb

@@ -2,6 +2,7 @@ module Byebug
 
   # Implements byebug "break" command.
   class BreakCommand < Command
+    self.allow_in_post_mortem = false
     self.allow_in_control = true
 
     def regexp
@@ -97,6 +98,7 @@ module Byebug
 
   # Implements byebug "delete" command.
   class DeleteCommand < Command
+    self.allow_in_post_mortem = false
     self.allow_in_control = true
 
     def regexp

data/lib/byebug/commands/catchpoint.rb

@@ -19,7 +19,7 @@ module Byebug
           print "Warning #{@match[1]} is not known to be a Class\n" unless
             bb_eval "#{@match[1]}.is_a?(Class)", get_binding
           Byebug.add_catchpoint @match[1]
-          print "Catch exception #{@match[1]}.\n"
+          print "Catching exception #{@match[1]}.\n"
         end
       elsif @match[2] != 'off'
         errmsg "Off expected. Got #{@match[2]}\n"

data/lib/byebug/commands/condition.rb

@@ -1,6 +1,7 @@
 module Byebug
 
   class ConditionCommand < Command
+    self.allow_in_post_mortem = false
 
     def regexp
       /^\s* cond(?:ition)? (?:\s+(\d+)(?:\s+(.*))?)? \s*$/x

data/lib/byebug/commands/display.rb

@@ -22,6 +22,8 @@ module Byebug
   end
 
   class AddDisplayCommand < Command
+    self.allow_in_post_mortem = false
+
     def regexp
       /^\s* disp(?:lay)? \s+ (.+) \s*$/x
     end
@@ -45,6 +47,8 @@ module Byebug
   end
 
   class DisplayCommand < Command
+    self.allow_in_post_mortem = false
+
     def self.always_run
       2
     end
@@ -69,6 +73,8 @@ module Byebug
   end
 
   class DeleteDisplayCommand < Command
+    self.allow_in_post_mortem = false
+
     def regexp
       /^\s* undisp(?:lay)? (?:\s+(\S+))? \s*$/x
     end