byebug 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aefd49bb6a9a42bed03f3bfd3e5c05b260460e16
-  data.tar.gz: 2123202331fe1df741b263453e287273383aeb3f
+  metadata.gz: 07f6616707d3f841c7c580f1f5e04ef9534a801d
+  data.tar.gz: e443182d786d0a652fa2166257727e3fb6298431
 SHA512:
-  metadata.gz: 27cb2714d6b8d457aed200e9c5beabaad6d94912e4ecc78c2bbdd3e809d8dce76834d49fdb02fbd89814c3e9bdeb01df5c9346ec777f5a9f4ca3f1fbab94b908
-  data.tar.gz: 72a02e12800f4b7b39d8b6f6b54615046ca80b7a774109ef60c5f18cfc4a959785a804f5ab204e926d984d7421c2c7f430f56a6f273c45ed1643a76627ea9398
+  metadata.gz: 6ef519a0d284a6e4b2b7524569d2e164258e9105850366dc73938e1fbf0602ecd008f3d5f67f799529009d7de1bdd0f3389908dc979edaa8184631336ea20333
+  data.tar.gz: 9f305fd5c78c3a7c8b29ef7e302acc230686986c44a72d3f5e903d4ab4f4df2f99d032bceb67ae00e5ae04302dbbecce92bc86a421549a45346355ff04c7755a

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 3.1.0
+
+* `show commands` moved to a separate `history` command.
+* Byebug.start can't recieve options any more. Any program settings you
+want applied from the start should be set in .byebugrc.
+* `trace` command has been removed. Line tracing functionality should be
+enabled through the `linetrace` setting whereas the global variable
+tracing functionality is now provided through the `tracevar` command.
+* `version` setting has been removed. It was not really a setting because it
+couldn't be set. Use `byebug --version` to check byebug's version.
+* `arg` setting removed. Program restart arguments should be set through
+`restart` command from now on.
+* `linetrace_plus` setting has been renamed to `tracing_plus`.
+
+
 # 3.0.0
 
 - Bugfixes

data/GUIDE.md

@@ -104,7 +104,7 @@ to be displayed when tracing, we can turn on _basename_.
 ```
 (byebug) display i
 2: i =
-(byebug) set linetrace on
+(byebug) set tracing on
 line tracing is on.
 (byebug) set basename on
 basename is on.
@@ -638,7 +638,7 @@ $ byebug primes.rb
     8:     candidate += 1
     9:     while true do
    10:       @@odd_primes.each do |p|
-(byebug) set linetrace
+(byebug) set tracing
 line tracing is on.
 (byebug) set basename
 basename in on.

data/LICENSE

@@ -1,6 +1,6 @@
-Copyright (C) 2013  David Rodríguez <deivid.rodriguez@gmail.com>
+Copyright (C) 2014  David Rodríguez <deivid.rodriguez@gmail.com>
 All rights reserved.
- *
+
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
@@ -9,7 +9,7 @@ are met:
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
- *
+
 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

data/README.md

@@ -82,6 +82,7 @@ can now be placed at the end of a block or method call.
     `finish`    |              |
     `frame`     |              |
     `help`      |              |
+    `history`   |              |
     `info`      |              | `args` `breakpoints` `catch` `display` `file` `files` `global_variables` `instance_variables` `line` `locals` `program` `stack` `variables`
     `irb`       |              |
     `kill`      |              |
@@ -97,16 +98,16 @@ can now be placed at the end of a block or method call.
     `reload`    |              |
     `restart`   |              |
     `save`      |              |
-    `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`
+    `set`       |              | `autoeval` `autoirb` `autolist` `autoreload` `autosave` `basename` `callstyle` `forcestep` `fullpath` `histfile` `histsize` `linetrace` `tracing_plus` `listsize` `post_mortem` `stack_on_error` `testing` `verbose` `width`
+    `show`      |              | `autoeval` `autoirb` `autolist` `autoreload` `autosave` `basename` `callstyle` `forcestep` `fullpath` `histfile` `histsize` `linetrace` `tracing_plus` `listsize` `post_mortem` `stack_on_error` `testing` `verbose` `width`
     `skip`      |              |
     `source`    |              |
     `step`      |              |
     `thread`    |              | `current` `list` `resume` `stop` `switch`
-    `trace`     |              |
+    `tracevar`  |              |
     `undisplay` |              |
     `up`        |              |
-    `var`       |              | `class` `constant` `global` `instance` `local` `ct`
+    `var`       |              | `class` `constant` `global` `instance` `local`
 
 
 ## Semantic Versioning

data/byebug.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md']
   s.extensions       = ['ext/byebug/extconf.rb']
 
-  s.add_dependency 'columnize', '~> 0.3'
+  s.add_dependency 'columnize', '~> 0.8'
   s.add_dependency 'debugger-linecache', '~> 1.2'
 end

data/ext/byebug/byebug.c

@@ -35,14 +35,15 @@ trace_print(rb_trace_arg_t *trace_arg, debug_context_t *dc)
   if (trace_arg)
   {
     int i = 0;
-    VALUE path  = rb_tracearg_path(trace_arg);
-    VALUE line  = rb_tracearg_lineno(trace_arg);
-    VALUE event = rb_tracearg_event(trace_arg);
-    VALUE mid   = rb_tracearg_method_id(trace_arg);
-    for (i=0; i<dc->calced_stack_size; i++) putc('|', stderr);
-    fprintf(stderr, "[#%d] %s@%s:%d %s\n", dc->thnum,
-      rb_id2name(SYM2ID(event)), RSTRING_PTR(path), NUM2INT(line),
-      NIL_P(mid) ? "" : rb_id2name(SYM2ID(mid)));
+    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",
+           dc->calced_stack_size, dc->thnum, event, path, line, mid);
   }
 }
 
@@ -543,17 +544,17 @@ bb_stop(VALUE self)
 
 /*
  *  call-seq:
- *    Byebug.start_ -> bool
- *    Byebug.start_ { ... } -> bool
+ *    Byebug.start -> bool
+ *    Byebug.start { ... } -> bool
  *
- *  This method is internal and activates the debugger. Use Byebug.start (from
- *  <tt>lib/byebug.rb</tt>) instead.
+ *  If a block is given, it starts byebug and yields block. After the block is
+ *  executed it stops byebug with Byebug.stop method. Inside the block you
+ *  will probably want to have a call to Byebug.byebug. For example:
+ *
+ *      Byebug.start { byebug; foo }  # Stop inside of foo
  *
  *  The return value is the value of !Byebug.started? <i>before</i> issuing the
  *  +start+; That is, +true+ is returned, unless byebug was previously started.
- *
- *  If a block is given, it starts byebug and yields to block. When the block
- *  is finished executing it stops the debugger with Byebug.stop method.
  */
 static VALUE
 bb_start(VALUE self)
@@ -624,7 +625,7 @@ bb_load(int argc, VALUE *argv, VALUE self)
 
 /*
  *  call-seq:
- *    Byebug.verbose -> bool
+ *    Byebug.verbose? -> bool
  *
  *  Returns +true+ if verbose output of TracePoint API events is enabled.
  */
@@ -650,7 +651,7 @@ bb_set_verbose(VALUE self, VALUE value)
 
 /*
  *  call-seq:
- *    Byebug.tracing -> bool
+ *    Byebug.tracing? -> bool
  *
  *  Returns +true+ if global tracing is enabled.
  */
@@ -772,13 +773,13 @@ Init_byebug()
   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, "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_verbose         ,  0);
   rb_define_module_function(mByebug, "verbose="         , bb_set_verbose     ,  1);
 
   cThreadsTable = rb_define_class_under(mByebug, "ThreadsTable", rb_cObject);

data/lib/byebug.rb

@@ -3,6 +3,7 @@ require 'byebug/version'
 require 'byebug/context'
 require 'byebug/interface'
 require 'byebug/processor'
+require 'byebug/setting'
 require 'byebug/remote'
 require 'stringio'
 require 'tracer'
@@ -13,18 +14,10 @@ module Byebug
   # List of files byebug will ignore while debugging
   IGNORED_FILES = Dir.glob(File.expand_path('../**/*.rb', __FILE__))
 
-  # Default options to Byebug.start
-  unless defined?(DEFAULT_START_SETTINGS)
-    DEFAULT_START_SETTINGS = { post_mortem: false,
-                               tracing: false,
-                               save_history: true }
-  end
-
   # Configuration file used for startup commands. Default value is .byebugrc
   INITFILE = '.byebugrc' unless defined?(INITFILE)
 
   # Original ARGV, command line and initial directory to make restarts possible
-  ARGV = ARGV.clone unless defined?(ARGV)
   PROG_SCRIPT = $0 unless defined?(PROG_SCRIPT)
   INITIAL_DIR = Dir.pwd unless defined?(INITIAL_DIR)
 
@@ -83,46 +76,6 @@ module Byebug
     extend Forwardable
     def_delegators :"handler.interface", :print
 
-    #
-    # Byebug.start(options) -> bool
-    # Byebug.start(options) { ... } -> obj
-    #
-    # If it's called without a block, it returns +true+ unless byebug was
-    # already started.
-    #
-    # If a block is given, it starts byebug and yields block. After the block is
-    # executed it stops byebug with Byebug.stop method. Inside the block you
-    # will probably want to have a call to Byebug.byebug. For example:
-    #
-    #     Byebug.start { byebug; foo }  # Stop inside of foo
-    #
-    # Also, byebug only allows one invocation of byebug at a time; nested
-    # Byebug.start's have no effect and you can't use this inside byebug itself.
-    #
-    # <i>Note that if you want to stop byebug, you must call Byebug.stop as
-    # many times as you called Byebug.start method.</i>
-    #
-    # +options+ is a hash used to set various debugging options.
-    #   :post_mortem  - true if you want to enter post-mortem debugging on an
-    #                   uncaught exception, false otherwise. Default: false.
-    #   :tracing      - true if line tracing should be enabled, false otherwise.
-    #                   Default: false.
-    #   :save_history - true if byebug's command history should be saved to a
-    #                   file on program termination so that it can be reloaded
-    #                   later.
-    #
-    def start(options={}, &block)
-      options = Byebug::DEFAULT_START_SETTINGS.merge(options)
-      Byebug.tracing = options[:tracing]
-
-      retval = Byebug._start(&block)
-
-      post_mortem if options[:post_mortem]
-      at_exit { Byebug::History.save } if options[:save_history]
-
-      return retval
-    end
-
     #
     # Runs normal byebug initialization scripts.
     #
@@ -168,11 +121,7 @@ module Byebug
       context = raised_exception.__bb_context
       file    = raised_exception.__bb_file
       line    = raised_exception.__bb_line
-      orig_tracing = Byebug.tracing?
-      Byebug.tracing = false
       handler.at_line(context, file, line)
-    ensure
-      Byebug.tracing = orig_tracing
     end
     private :handle_post_mortem
   end
@@ -188,8 +137,8 @@ module Kernel
   # events occur. Before entering byebug the init script is read.
   #
   def byebug(steps_out = 1, before = true)
-    Byebug.start
     Byebug.run_init_script(StringIO.new)
+    Byebug.start
     Byebug.current_context.step_out(steps_out, before)
   end
 

data/lib/byebug/command.rb

@@ -3,26 +3,10 @@ require 'forwardable'
 require 'byebug/helper'
 
 module Byebug
-
-  module CommandFunctions
-    #
-    # Pad a string with dots at the end to fit :width setting
-    #
-    def pad_with_dots(string)
-      if string.size > Command.settings[:width]
-        string[Command.settings[:width]-3 .. -1] = "..."
-      end
-    end
-  end
-
   class Command
     Subcmd = Struct.new(:name, :min, :help)
 
     class << self
-      def commands
-        @commands ||= []
-      end
-
       attr_accessor :allow_in_control, :unknown
       attr_writer :allow_in_post_mortem, :always_run
 
@@ -76,87 +60,25 @@ module Byebug
         return s
       end
 
+      def commands
+        @commands ||= []
+      end
+
       def inherited(klass)
         commands << klass
       end
 
       def load_commands
-        Dir[File.join(File.dirname(__FILE__), 'commands', '*')].each {
-          |file| require file }
-        Byebug.constants.grep(/Functions$/).map {
-          |name| Byebug.const_get(name) }.each { |mod| include mod }
-      end
-
-      def settings_map
-        @@settings_map ||= {}
-      end
-      private :settings_map
-
-      def settings
-        unless defined? @settings and @settings
-          @settings = Object.new
-          map = settings_map
-          c = class << @settings; self end
-          c.send(:define_method, :[]) do |name|
-            raise "No such setting #{name}" unless map.has_key?(name)
-            map[name][:getter].call
-          end
-          c.send(:define_method, :[]=) do |name, value|
-            raise "No such setting #{name}" unless map.has_key?(name)
-            map[name][:setter].call(value)
-          end
+        Dir.glob(File.expand_path('../commands/*.rb', __FILE__)).each do |file|
+          require file
         end
-        @settings
-      end
 
-      def register_setting_var(name, default)
-        var_name = "@@#{name}"
-        class_variable_set(var_name, default)
-        register_setting_get(name) { class_variable_get(var_name) }
-        register_setting_set(name) { |value| class_variable_set(var_name, value) }
-      end
-
-      def register_setting_get(name, &block)
-        settings_map[name] ||= {}
-        settings_map[name][:getter] = block
-      end
-
-      def register_setting_set(name, &block)
-        settings_map[name] ||= {}
-        settings_map[name][:setter] = block
-      end
-
-      def command_exists?(command)
-        ENV['PATH'].split(File::PATH_SEPARATOR).any? {
-          |d| File.exist? File.join(d, command) }
-      end
-
-      def terminal_width
-        if ENV['COLUMNS'] =~ /^\d+$/
-          ENV['COLUMNS'].to_i
-        elsif STDIN.tty? && command_exists?('stty')
-          `stty size`.scan(/\d+/)[1].to_i
-        else
-          nil
-        end
+        Byebug.constants.grep(/Functions$/).map {
+          |name| Byebug.const_get(name)
+        }.each { |mod| include mod }
       end
     end
 
-    # Register default settings
-    register_setting_var(:autosave, true)
-    register_setting_var(:basename, false)
-    register_setting_var(:callstyle, :long)
-    register_setting_var(:testing, false)
-    register_setting_var(:forcestep, false)
-    register_setting_var(:fullpath, true)
-    register_setting_var(:listsize, 10)
-    register_setting_var(:stack_on_error, false)
-    register_setting_var(:linetrace_plus, false)
-    cols = terminal_width || 160
-    register_setting_var(:width, cols > 10 ? cols : 160)
-    Byebug::ARGV = ARGV.clone unless defined? Byebug::ARGV
-    register_setting_var(:argv, Byebug::ARGV)
-
     def initialize(state)
       @match, @state = nil, state
     end
@@ -206,26 +128,4 @@ module Byebug
   end
 
   Command.load_commands
-
-  ##
-  # Returns ths settings object.
-  # Use Byebug.settings[] and Byebug.settings[]= methods to query and set
-  # byebug settings. These settings are available:
-  #
-  #  :autoeval          - evaluates input in the current binding if it's not
-  #                       recognized as a byebug command
-  #  :autoirb           - automatically calls 'irb' command on breakpoint
-  #  :autolist          - automatically calls 'list' command on breakpoint
-  #  :autoreload        - makes 'list' command always display up-to-date source
-  #                       code
-  #  :autosave          - automatic saving of command history on exit
-  #  :frame_class_names - displays method's class name when showing frame stack
-  #  :forcestep         - stepping command always move to the new line
-  #  :fullpath          - displays full paths when showing frame stack
-  #  :stack_on_error    - shows full stack trace if eval command results in an
-  #                       exception
-  #
-  def self.settings
-    Command.settings
-  end
 end

data/lib/byebug/commands/breakpoints.rb

@@ -54,7 +54,7 @@ module Byebug
 
       if line =~ /^\d+$/
         line = line.to_i
-        if LineCache.cache(brkpt_filename, Command.settings[:autoreload])
+        if LineCache.cache(brkpt_filename, Setting[:autoreload])
           last_line = LineCache.size(brkpt_filename)
           return errmsg "There are only #{last_line} lines in file " \
                         "#{brkpt_filename}\n" if line > last_line

data/lib/byebug/commands/control.rb

@@ -1,30 +1,31 @@
 module Byebug
-
   class RestartCommand < Command
     self.allow_in_control = true
 
     def regexp
-      /^\s* (?:restart|R) (?:\s+(.+))? \s*$/x
+      /^\s* (?:restart|R) (?:\s+(?<args>.+))? \s*$/x
     end
 
     def execute
-      return errmsg "Don't know name of debugged program\n" unless
-        defined? Byebug::PROG_SCRIPT
+      prog = Byebug::PROG_SCRIPT if defined?(Byebug::PROG_SCRIPT)
+      byebug_script = Byebug::BYEBUG_SCRIPT if defined?(Byebug::BYEBUG_SCRIPT)
+
+      return errmsg "Don't know name of debugged program\n" unless prog
 
-      return errmsg "Ruby program #{Byebug::PROG_SCRIPT} doesn't exist\n" unless
-        File.exist?(File.expand_path(Byebug::PROG_SCRIPT))
+      unless File.exist?(File.expand_path(prog))
+        return errmsg "Ruby program #{prog} doesn't exist\n"
+      end
 
-      if not defined? Byebug::BYEBUG_SCRIPT
+      if byebug_script
+        cmd = "#{byebug_script} #{prog}"
+      else
         print "Byebug was not called from the outset...\n"
-        if not File.executable?(Byebug::PROG_SCRIPT)
-          print "Ruby program #{Byebug::PROG_SCRIPT} not executable... " \
-                "We'll add a call to Ruby.\n"
-          cmd = "ruby -rbyebug -I#{$:.join(' -I')} #{Byebug::PROG_SCRIPT}"
+        if File.executable?(prog)
+          cmd = prog
         else
-          cmd = Byebug::PROG_SCRIPT
+          print "Ruby program #{prog} not executable... We'll wrap it in a ruby call\n"
+          cmd = "ruby -rbyebug -I#{$:.join(' -I')} #{prog}"
         end
-      else
-        cmd = "#{Byebug::BYEBUG_SCRIPT} #{Byebug::PROG_SCRIPT}"
       end
 
       begin
@@ -33,13 +34,11 @@ module Byebug
         print "Failed to change initial directory #{Byebug::INITIAL_DIR}"
       end
 
-      if @match[1]
-        cmd += " #{@match[1]}"
-      elsif not defined? Command.settings[:argv]
-        return errmsg "Arguments not set. Use 'set args' to set them.\n"
+      if @match[:args]
+        cmd += " #{@match[:args]}"
       else
         require 'shellwords'
-        cmd += " #{Command.settings[:argv].compact.shelljoin}"
+        cmd += " #{ARGV.compact.shelljoin}"
       end
 
       # An execv would be preferable to the "exec" below.
@@ -72,8 +71,8 @@ module Byebug
     end
 
     def execute
-        context = Byebug.thread_context(Thread.main)
-        context.interrupt
+      context = Byebug.thread_context(Thread.main)
+      context.interrupt
     end
 
     class << self