byebug 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d18d944520a45aaad538b12d098effea86da264b
-  data.tar.gz: a9a224673d713f67bd67c13e5e1f1a88b08d90c5
+  metadata.gz: 2380cd5fcec35d3f595370d2616036b95d6431a9
+  data.tar.gz: c4d94d6eaf87f359546b4b0d490a17a6e7f436cf
 SHA512:
-  metadata.gz: 29d6e1b0b24f742210043e44e5a6cc767982e5d95bb22fe7e72e42841b2c8d8c347c94431d59d72f0b1138336a6e2b5c52a3b2cae52e1838cab2f73560ee0f9b
-  data.tar.gz: bbc117ad67be478a69e5116a335539be57ebb007f101e4f4de4fab4fac8a793c155a948a287f95af670718513aee946622ef1fcac23913471700ed207959409a
+  metadata.gz: c84394861f16b1ddffd011f93665e4c8a11234c50c697ce9abafd7fee41e992d363e38026083f6f9ef16d4ca8578b1f7705e630c82d9694b45c5f0c47797c94c
+  data.tar.gz: 5fe396fa9105f429a5da215e14507a0160376a0a36c29dc788fcd9e467ab24d84b57022b8914acf7a52305cfc4cf87eb65add335fb2825d48cb180ddc7c02b21

data/.gitignore

@@ -1,6 +1,5 @@
 tmp
 pkg
-vendor/bundle
 doc
 
 .rvmrc

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.4.1
+
+* Fixes crash when printing some filenames in backtraces
+
+
 ## 1.4.0
 
 * Byebug now uses the Debug Inspector API: faster and nicer!

data/GUIDE.md

@@ -1,4 +1,4 @@
-## Second Sample Session: Delving Deeper
+### Second Sample Session: Delving Deeper
 
 In this section we'll introduce breakpoints, the call stack and restarting.
 Below we will debug a simple Ruby program to solve the classic Towers of Hanoi
@@ -172,14 +172,14 @@ Stopped by breakpoint 1 at /home/davidr/Proyectos/byebug/old_doc/hanoi.rb:3
 1: n = 1
 3: a.inspect = :a
 4: b.inspect = :b
+(byebug) set nofullpath
+Displaying frame's full file names is off.
 (byebug) where
 --> #0  Object.hanoi(n#Fixnum, a#Symbol, b#Symbol, c#Symbol)
-      at /home/davidr/Proyectos/byebug/old_doc/hanoi.rb:3
+      at .../byebug/old_doc/hanoi.rb:4
     #1  Object.hanoi(n#Fixnum, a#Symbol, b#Symbol, c#Symbol)
-      at /home/davidr/Proyectos/byebug/old_doc/hanoi.rb:4
-    #2  Object.hanoi(n#Fixnum, a#Symbol, b#Symbol, c#Symbol)
-      at /home/davidr/Proyectos/byebug/old_doc/hanoi.rb:4
-    #3  <main> at /home/davidr/Proyectos/byebug/old_doc/hanoi.rb:34
+      at .../byebug/old_doc/hanoi.rb:8
+    #2  <top (required)> at .../byebug/old_doc/hanoi.rb:34
 (byebug)
 ```
 
@@ -231,7 +231,7 @@ frame #3, the value of `i_args` can be shown. Also note that the value of
 variable `n` is different.
 
 
-## Unit Testing Session
+### Unit Testing Session
 
 In the previous sessions we've been calling byebug right at the outset, but this
 is probably not the mode of operation you will use the most. There are a number
@@ -436,7 +436,7 @@ the corresponding variables that _currently_ exist, and this might have changed
 since the time when the call was made.
 
 
-## Byebug.start with a block
+### Byebug.start with a block
 
 We saw that `Byebug.start()` and `Byebug.stop()` allow fine-grain control over
 where byebug tracking should occur.
@@ -486,8 +486,7 @@ when another `Byebug.start` method is called inside of the outer one. However,
 if you are stopped inside byebug, issuing another `byebug` call will not have
 any effect even if it is nested inside another `Byebug.start`.
 
-## Debugging Oddities: How debugging Ruby may be different from debugging other
-languages
+### Debugging Oddities: How debugging Ruby may be different from other languages
 
 If you are used to debugging in other languages like C, C++, Perl, Java or even
 Bash (see [bashdb](http://bashdb.sf.net)), there may be a number of things that
@@ -515,7 +514,7 @@ to Ruby who are familiar with other languages and debugging in them.
 * No Parameter Values in a Call Stack
 * Lines You Can Stop At
 
-## Bouncing Around in Blocks (iterators)
+#### Bouncing Around in Blocks (iterators)
 
 When debugging languages with coroutines like Python and Ruby, a method call may
 not necessarily go to the first statement after the method header. It's possible
@@ -596,7 +595,7 @@ The loop between lines 23-26 gets interleaved between those of
 `Sieve::next_prime`, lines 6-19 above.
 
 
-### No Parameter Values in a Call Stack
+#### No Parameter Values in a Call Stack
 
 In traditional debuggers, in a call stack you can generally see the names of the
 parameters and the values that were passed in.
@@ -615,7 +614,7 @@ _current_ class of the object. It has been contemplated that a style might be
 added which saves on call shorter "scalar" types of values and the class name.
 
 
-### Lines You Can Stop At
+#### Lines You Can Stop At
 
 As with the duplicate stops per control (e.g. `if` statement), until tools like
 debuggers get more traction among core ruby developers there are going to be
@@ -644,3 +643,116 @@ To be continued...
 * mixing in Byebug.debug with byebug
 * post-mortem debugging and setting up for that
 * references to videos
+
+## Getting in & out
+
+### Starting byebug
+
+There is a wrapper script called `byebug` which basically `require`'s the gem
+then loads `byebug` before its argument (the program to be debugged) is started.
+
+```
+byebug [byebug-options] [--] ruby-script ruby-script-arguments
+```
+
+If you don't need to pass dash options to your program, which might be confused
+with byebug options, then you don't need to add the `--`. To get a brief list of
+options and descriptions, use the `--help` option.
+
+```
+$ byebug --help
+byebug 1.4.0
+Usage: byebug [options] <script.rb> -- <script.rb parameters>
+
+Options:
+ -A, --annotate LEVEL      Set annotation level
+ -d, --debug               Set $DEBUG=true
+ -I, --include PATH        Add PATH (single or multiple:path:list) to $LOAD_PATH
+     --no-quit             Do not quit when script finishes
+     --no-rewrite-program  Don't set $0 to the program debugged
+     --no-stop             Do not stop when script is loaded
+ -nx                       Don't run any byebug initialization files
+ -r, --require SCRIPT      Require library before script
+     --restart-script FILE Name of the script file to run. Erased after read
+     --script FILE         Name of the script file to run
+    -x, --trace            Turn on line tracing
+
+Common options:
+        --verbose          Turn on verbose mode
+        --help             Show this message
+        --version          Print program version
+    -v                     Print version number, then turn on verbose mode
+```
+
+Many options appear as a long option name, such as `--help` and a short one
+letter option name, such as `-h`. The list of options is detailed below:
+
+* **-h | --help**. It causes `byebug` to print some basic help and exit
+* **-v | --version**. It causes `byebug` to print its version number and
+exit.
+* **-A | --annotate <level>**. Set gdb-style annotation `level`, a number.
+Additional information is output automatically when program state is changed.
+This can be used by front-ends such as GNU Emacs to post this updated
+information without having to poll for it.
+* **-d | --debug**. Set `$DEBUG` to `true`. Compatible with Ruby's.
+* **-I | --include <path>**. Add `path` to load path. `path` can be a single
+path ar a colon separated path list.
+* **-m | --post-mortem**. If your program raises an exception that isn't caught
+you can enter byebug for inspection of what went wrong. You may also want to use
+this option in conjunction with `--no-stop`. See also [Post-Mortem Debugging]().
+* **--no-quit**. Restart `byebug` when your program terminates normally.
+* **--no-rewrite-program**. Normally `byebug` will reset the program's name `$0`
+from its name to the debugged program, and set the name in variable
+`$BYEBUG_SCRIPT`. In the unlikely event you don't want to use this option.
+* **--no-stop**. Normally `byebug` stops before executing the first statement.
+If instead you want it to start running initially and perhaps break it later in
+the execution, use this option.
+* **--require | -r**. Require the library before executing the script. However,
+if the library happened to be `debug`, we'll just ignore the require since we're
+already a debugger. This option is compatible with Ruby's.
+* **--script <file>**. Script to run before byebug's execution.
+* **-x | --trace**. Turn on line tracing. Running `byebug --trace
+<rubyscript>.rb` is pretty much like running `ruby -rtracer
+<rubyscript>.rb`. If all you want to do however is get a linetrace, `tracer` is
+most likely faster than `byebug`
+
+```
+$ time ruby -rtracer old_doc/gcd.rb 24 31 >/dev/null
+
+real  0m0.066s
+user  0m0.048s
+sys 0m0.016s
+
+$ time byebug --trace old_doc/gcd.rb 24 31 >/dev/null
+
+real  0m0.660s
+user  0m0.588s
+sys 0m0.056s
+```
+
+### Byebug default options
+
+Byebug has many command-line options,; it seems that some people want to set
+them differently from the defaults. For example, some people may want
+`--no-quit` to be the default behavior. One could write a wrapper script or set
+a shell alias to handle this. But `byebug` has another way to do it. Before
+processing command options, if the file `$HOME/.byebugoptrc` is found, it is
+loaded. If you want to set the defaults in some other way, you can put Ruby code
+here and set variable `options` which is an OpenStruct. For example here's how
+you'd set `-no-quit` and a personal message.
+
+```ruby
+# This file contains how you want the default options to byebug to be set. Any
+# Ruby code can be put here.
+#
+# byebug # Uncomment if you want to debug byebug!
+options.control = false
+puts "rocky's byebugrc run"
+```
+
+Here are the default values in `options`
+
+```ruby
+#<OpenStruct annotate=nil, no_rewrite_program=false, nx=false, quit=true,
+restart_script=nil, script=nil, stop=true, tracing=false, verbose_long=false>
+```

data/README.md

@@ -12,8 +12,7 @@ as a C extension, so it's fast. And it has a full test suite so it's (I hope)
 reliable.
 
 It allows you to see what is going on _inside_ a Ruby program while it executes
-and can do four main kinds of things (plus other things in support of these) to
-help you catch bugs in the act:
+and can do four main kinds of things to help you catch bugs in the act:
 
 * Start your program or attach to it, specifying anything that might affect its
 behavior.
@@ -41,9 +40,8 @@ Simply drop
     byebug
 
 wherever you want to start debugging and the execution will stop there. If you
-are debugging rails, start the server in normal mode with `rails server` and
-once the execution get to your `byebug` command you will get a debugging
-terminal.
+are debugging rails, start the server and once the execution get to your
+`byebug` command you will get a debugging prompt.
 
 _If you are coming from debugger, notice that stopping execution using the word
  `debugger` doesn't work anymore unless you explicitly alias it._

data/bin/byebug

@@ -28,9 +28,6 @@
 #    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>--keep-frame-binding</tt>::
-#    Keep frame bindings.
-#
 #<tt>-m | --post-mortem</tt>::
 #    Activate post-mortem mode.
 #
@@ -106,14 +103,14 @@ end
 
 options = OpenStruct.new(
   'annotate'           => Byebug.annotate,
-  'quit'               => true,
   'no_rewrite_program' => false,
-  'stop'               => true,
   'nx'                 => false,
+  'quit'               => true,
   'restart_script'     => nil,
   'script'             => nil,
+  'stop'               => true,
   'tracing'            => false,
-  'verbose_long'       => false,
+  'verbose_long'       => false
 )
 
 def process_options(options)

data/byebug.gemspec

@@ -1,14 +1,13 @@
-require 'rubygems'
-require File.dirname(__FILE__) + "/lib/byebug/version"
+require File.dirname(__FILE__) + '/lib/byebug/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{byebug}
-  s.version = Byebug::VERSION
-
-  s.authors = ["David Rodríguez", "Kent Sibilev", "Mark Moseley"]
-  s.email = "deivid.rodriguez@mail.com"
-  s.homepage = "http://github.com/deivid-rodriguez/byebug"
-  s.summary = %q{Ruby 2.0 fast debugger - base + cli}
+  s.name        = 'byebug'
+  s.version     = Byebug::VERSION
+  s.authors     = ['David Rodríguez', 'Kent Sibilev', 'Mark Moseley']
+  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.0 debugger. It's implemented using the
     Ruby 2.0 TracePoint C API for execution control and the Debug Inspector C
     API for call stack navigation.  The core component provides support that
@@ -16,20 +15,19 @@ Gem::Specification.new do |s|
     stack frames among other things and it comes with an easy to use command
     line interface.}
 
-  s.required_ruby_version = '>= 2.0.0'
-  s.required_rubygems_version = ">= 2.0.3"
+  s.required_ruby_version     = '>= 2.0.0'
 
-  s.extra_rdoc_files = [ "README.md" ]
-  s.files = `git ls-files`.split("\n")
-  s.extensions << "ext/byebug/extconf.rb"
-  s.executables = ["byebug"]
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- test/*`.split("\n")
+  s.executables      = ['byebug']
+  s.extra_rdoc_files = ['README.md']
+  s.extensions       = ['ext/byebug/extconf.rb']
 
   s.add_dependency "columnize", "~> 0.3.6"
   s.add_dependency "debugger-linecache", '~> 1.2.0'
+
   s.add_development_dependency 'rake', '~> 10.0.4'
   s.add_development_dependency 'rake-compiler', '~> 0.8.3'
   s.add_development_dependency 'mocha', '~> 0.14.0'
   s.add_development_dependency 'minitest', '~> 5.0.3'
-
-  s.license = "BSD"
 end

data/ext/byebug/context.c

@@ -197,7 +197,7 @@ Context_frame_file(int argc, VALUE *argv, VALUE self)
   VALUE loc;
 
   loc = dc_frame_location(context, frame_n);
-  return rb_funcall(loc, rb_intern("absolute_path"), 0);
+  return rb_funcall(loc, rb_intern("path"), 0);
 }
 
 static VALUE

data/ext/byebug/extconf.rb

@@ -1,12 +1,16 @@
 require 'mkmf'
 
+RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+
 if RUBY_VERSION < "2.0"
   STDERR.print("Ruby version is too old\n")
   exit(1)
 end
 
-$CFLAGS = '-Wall -Werror'
-$CFLAGS += ' -g3' if ENV['debug']
+if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc/
+  $CFLAGS = '-Wall -Werror'
+  $CFLAGS += ' -g3' if ENV['debug']
+end
 
 dir_config("ruby")
 create_makefile("byebug")

data/lib/byebug/commands/show.rb

@@ -173,7 +173,6 @@ module Byebug
          'show history save -- Show whether history record should be saved '  \
          'on exit'                                                            \
          'show history size -- Show the size of the command history'],
-        ['keep-frame-bindings', 1, 'Save frame binding on each call'],
         ['linetrace', 3, 'Show line execution tracing'],
         ['linetrace+', 10,
          'Show whether different consecutive lines are shown in tracing'],

data/lib/byebug/processor.rb

@@ -70,6 +70,8 @@ module Byebug
     # are working remotely and want to change the basename. Or we are eliding
     # filenames.
     def self.canonic_file(filename)
+      return '(nil)' if not filename
+
       # For now we want resolved filenames
       if Command.settings[:basename]
         File.basename(filename)
@@ -141,7 +143,6 @@ module Byebug
     protect :at_catchpoint
 
     def at_tracing(context, file, line)
-      tracing_plus = Command.settings[:tracing_plus]
       if file != @last_file || line != @last_line ||
          Command.settings[:tracing_plus] == false
         @last_file = file
@@ -274,19 +275,15 @@ module Byebug
       end
 
       def preloop(commands, context)
-        aprint('stopped') if Byebug.annotate.to_i > 2
-        if context.dead? and not @byebug_context_was_dead
-          if Byebug.annotate.to_i > 2
+        @byebug_context_was_dead = true if context.dead? and not
+          @byebug_context_was_dead
+
+        if Byebug.annotate.to_i > 2
+          aprint('stopped')
+          if @byebug_context_was_dead
             aprint('exited')
             print "The program finished.\n"
           end
-          @byebug_context_was_dead = true
-        end
-
-        if Byebug.annotate.to_i > 2
-          # if we are here, the stack frames have changed outside the command
-          # loop (e.g. after a "continue" command), so we show the annotations
-          # again
           breakpoint_annotations(commands, context)
           display_annotations(commands, context)
           annotation('stack', commands, context, "where")
@@ -308,8 +305,7 @@ module Byebug
               context.dead?
           end
           if not context.dead? and @@Show_annotations_run.find{|pat| cmd =~ pat}
-            aprint 'starting'  if Byebug.annotate.to_i > 2
-
+            aprint 'starting'
             @byebug_context_was_dead = false
           end
         end

data/lib/byebug/version.rb

@@ -1,3 +1,3 @@
 module Byebug
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

data/old_doc/byebug.texi

@@ -892,11 +892,9 @@ To be continued...
 * Command Files::        Command files
 * Quitting byebug::      How to leave byebug (quit, kill)
 * Calling from Program:: Calling byebug from inside your program
+* Post-Mortem Debugging:: Enter byebug after an uncaught exception
 @end menu
 
-It is also possible to enter byebug when you have an uncaught exception (see
-@ref{Post-Mortem Debugging}).
-
 @node Starting byebug
 @section Starting byebug
 

data/old_doc/gcd.rb

@@ -0,0 +1,15 @@
+# Greatest common divisor of a and b
+def gcd a, b
+  x = [a,b].max
+  y = [a,b].min
+
+  while y != 0
+    r = x % y
+    x = y
+    y = r
+  end
+
+  x
+end
+
+puts gcd ARGV[0].to_i, ARGV[1].to_i

data/old_doc/test-triangle.rb

@@ -1,7 +1,5 @@
 require 'test/unit'
 require_relative 'triangle.rb'
-require 'byebug'
-Byebug.start
 
 class TestTri < Test::Unit::TestCase
   def test_basic

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: byebug
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - David Rodríguez
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: columnize
@@ -165,6 +165,7 @@ files:
 - logo.png
 - old_doc/byebug.1
 - old_doc/byebug.texi
+- old_doc/gcd.rb
 - old_doc/hanoi.rb
 - old_doc/primes.rb
 - old_doc/test-triangle.rb
@@ -252,11 +253,76 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 2.0.3
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby 2.0 fast debugger - base + cli
-test_files: []
+test_files:
+- test/breakpoints_test.rb
+- test/conditions_test.rb
+- test/continue_test.rb
+- test/display_test.rb
+- test/edit_test.rb
+- test/eval_test.rb
+- test/examples/breakpoint1.rb
+- test/examples/breakpoint2.rb
+- test/examples/conditions.rb
+- test/examples/continue.rb
+- test/examples/display.rb
+- test/examples/edit.rb
+- test/examples/eval.rb
+- test/examples/finish.rb
+- test/examples/frame.rb
+- test/examples/help.rb
+- test/examples/info.rb
+- test/examples/info2.rb
+- test/examples/irb.rb
+- test/examples/jump.rb
+- test/examples/kill.rb
+- test/examples/list.rb
+- test/examples/method.rb
+- test/examples/post_mortem.rb
+- test/examples/quit.rb
+- test/examples/reload.rb
+- test/examples/restart.rb
+- test/examples/save.rb
+- test/examples/set.rb
+- test/examples/set_annotate.rb
+- test/examples/settings.rb
+- test/examples/show.rb
+- test/examples/source.rb
+- test/examples/stepping.rb
+- test/examples/tmate.rb
+- test/examples/trace.rb
+- test/examples/variables.rb
+- test/finish_test.rb
+- test/frame_test.rb
+- test/help_test.rb
+- test/info_test.rb
+- test/jump_test.rb
+- test/kill_test.rb
+- test/list_test.rb
+- test/method_test.rb
+- test/post_mortem_test.rb
+- test/quit_test.rb
+- test/reload_test.rb
+- test/repl_test.rb
+- test/restart_test.rb
+- test/save_test.rb
+- test/set_test.rb
+- test/show_test.rb
+- test/source_test.rb
+- test/stepping_test.rb
+- test/support/breakpoint.rb
+- test/support/context.rb
+- test/support/matchers.rb
+- test/support/mocha_extensions.rb
+- test/support/processor.rb
+- test/support/test_dsl.rb
+- test/support/test_interface.rb
+- test/test_helper.rb
+- test/trace_test.rb
+- test/variables_test.rb