byebug 8.2.5 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 727f87204d164208f5106683d269866c4226c411
-  data.tar.gz: 5ec864cf251f0b0d365cc1a1dd9308d59c41ee90
+  metadata.gz: d998c99367586ad5a7f29f3bd5e22b2836f1d7c8
+  data.tar.gz: 32cf7615ad42d875e78c103e48c9a40dcde502be
 SHA512:
-  metadata.gz: 845f95e29e95071ac483d4580f9ca603a6ec6064f89ddc49747f2f768a76b061739ee3ae26dfc69f90c955facf9104375fa10d5669c717ab7775dc2fb9e5bc28
-  data.tar.gz: ad29da5042821e9be12e8a1fe693c4d14b11ba3213c4abf8e18abc89c9494a69633fe85936a43bd6d5e349c4d930986715cf4c28562cb0035086d350e71eb27a
+  metadata.gz: 2f5f3f1aec38feaa4a83fd97b9b09313a97ea5dd25daee3e9319d602e7268ca8fa6ade3995c8d8ccd4d68d5369e2f6511a3d8710562bc3204866bbc5ab20452b
+  data.tar.gz: 570436e9f4263fdc9191c666337e5a726854427932fa995fa4819417414a6160830d27ffa3d0a3acf9c1e23fa4d387ee8d6f0d4e50e4b6b583626443e31b2bd9

data/CHANGELOG.md

@@ -2,6 +2,83 @@
 
 ## Master (Unreleased)
 
+## 9.1.0 - 2016-08-22
+
+### Added
+
+* Better UI messages for breakpoint management.
+
+### Fixed
+
+* `where` command failing on instance_exec block stack frames.
+* `restart` command crashing in certain cases because of a missing `require 'English'` (#321, @akaneko3).
+* `restart` command crashing when debugged script is not executable or has no shebang (#321, @akaneko3).
+
+### Removed
+
+* Ruby 2.0 and Ruby 2.1 official & unofficial support. Byebug no longer installs
+  on these platforms.
+
+## 9.0.6 - 2016-09-29
+
+### Fixed
+
+* Error when using `byebug` with a ruby compiled against libedit (#241).
+* Allow `Byebug.start_server` to yield the block passed to it when the actual
+  port is already known (#277, thanks @cben).
+* Use a standard license name so it can be more reliably used by tools (#275).
+
+## 9.0.5 - 2016-05-28
+
+### Fixed
+
+* Error loading rc file when `ENV['HOME']` is unset.
+
+## 9.0.4 - 2016-05-19
+
+### Fixed
+
+* Errors in rc file not being displayed to the user.
+
+## 9.0.3 - 2016-05-16
+
+### Fixed
+
+* Unfriendly output in byebug's executable when no script specified (#256).
+* Unfriendly output in byebug's executable when script doesn't exist.
+* Unfriendly output in byebug's executable when script has invalid code.
+
+## 9.0.2 - 2016-05-15
+
+### Fixed
+
+* Skip to get a line in eval context (#263, thanks @k0kubun).
+* Debugger getting disabled after `continue` even when linetrace is enabled
+  (#264, thanks @k0kubun).
+
+## 9.0.1 - 2016-05-14
+
+### Fixed
+
+* `quit` never exiting when remote debugging (#201).
+
+## 9.0.0 - 2016-05-11
+
+### Fixed
+
+* `irb` command unintentionally changing $PROGRAM_NAME.
+* `pry` command failing.
+* Unrelated error message when using `pry` command and Pry not installed.
+* Interrupting program execution from remote control interface (#239, thanks
+  @izaera).
+
+### Removed
+
+* Official Ruby 2.0.0 support. `var local` no longer works in Ruby 2.0. The
+  rest of the commands should still work as before, but `byebug` is no longer
+  tested against this version so they might start breaking in the
+  future.
+
 ## 8.2.5 - 2016-04-27
 
 ### Fixed

data/CONTRIBUTING.md

@@ -1,10 +1,10 @@
-## Contributing to Byebug
+# CONTRIBUTING
 
 Please note that this project is released with a [Contributor Code of
 Conduct](code_of_conduct.md). By participating in this project you agree to
 abide by its terms.
 
-### Bug Reports
+## Bug Reports
 
 * Try to reproduce the issue against the latest revision. There might be
   unrealeased work that fixes your problem!
@@ -14,7 +14,7 @@ abide by its terms.
 * Include the behavior you observed along with the behavior you expected,
   and why you expected it.
 
-### Development dependencies
+## Development dependencies
 
 * `Byebug` depends on Ruby's TracePoint API provided by `ruby-core`. This is a
   young API and a lot of bugs have been recently corrected, so make sure you
@@ -24,7 +24,7 @@ abide by its terms.
 * Running `bundle install` inside a local clone of `byebug` will get development
   dependencies installed.
 
-### Running the test suite
+## Running the test suite
 
 * Make sure you compile the C-extension using `bundle exec rake compile`.
   Otherwise you won't be able to use `byebug`.
@@ -45,7 +45,7 @@ abide by its terms.
     example: `script/minitest_runner.rb Byebug::BreakAtLinesTestCase
     test_catch_removes_specific_catchpoint`
 
-### Code style
+## Code style
 
 * Byebug uses [overcommit][] to enforce code style. Install the git hooks using
   `bundle exec overcommit --install`. They will review your changes before they
@@ -53,7 +53,7 @@ abide by its terms.
 
 [overcommit]: https://github.com/brigade/overcommit/
 
-### Byebug as a C-extension
+## Byebug as a C-extension
 
 Byebug is a gem developed as a C-extension. The debugger internal's
 functionality is implemented in C (the interaction with the TracePoint API).

data/GUIDE.md

@@ -1,3 +1,7 @@
+# GUIDE
+
+## Introduction
+
 ### First Steps
 
 A handful of commands are enough to get started using `byebug`. The following
@@ -182,7 +186,21 @@ end
 
 n_args = $ARGV.length
 
-fail('*** Need number of disks or no parameter') if n_args > 1
+raise('*** Need number of disks or no parameter') if n_args > 1
+
+n = 3
+
+if n_args > 0
+  begin
+    n = $ARGV[0].to_i
+  rescue ValueError
+    raise("*** Expecting an integer, got: #{$ARGV[0]}")
+  end
+end
+
+raise('*** Number of disks should be between 1 and 100') if n < 1 || n > 100
+
+hanoi(n, :a, :b, :c)
 ```
 
 Recall in the first section it was stated that before the `def` is run, the
@@ -312,7 +330,7 @@ Now let's see what happens after stepping:
    11:
 => 12: n_args = $ARGV.length
    13:
-   14: fail('*** Need number of disks or no parameter') if n_args > 1
+   14: raise('*** Need number of disks or no parameter') if n_args > 1
 (byebug) private_methods.member?(:hanoi)
 true
 (byebug)
@@ -438,15 +456,15 @@ NameError Exception: undefined local variable or method `n_args' for main:Object
    19:   begin
    20:     n = $ARGV[0].to_i
    21:   rescue ValueError
-   22:     raise("** Expecting an integer, got: #{$ARGV[0]}")
+   22:     raise("*** Expecting an integer, got: #{$ARGV[0]}")
    23:   end
    24: end
    25:
-   26: fail('*** Number of disks should be between 1 and 100') if n < 1 || n > 100
+   26: raise('*** Number of disks should be between 1 and 100') if n < 1 || n > 100
    27:
 => 28: hanoi(n, :a, :b, :c)
 (byebug) n_args
-0
+1
 (byebug) eval n
 3
 (byebug) down 2
@@ -610,10 +628,6 @@ already been done when you compile the program (or in Perl when it scans in the
 program). In this section we'll consider some other things that might throw off
 new users to Ruby who are familiar with other languages and debugging in them.
 
-* Bouncing Around in Blocks (iterators)
-* No Parameter Values in a Call Stack
-* Lines You Can Stop At
-
 #### Bouncing Around in Blocks (iterators)
 
 When debugging languages with coroutines like Python and Ruby, a method call may
@@ -1600,7 +1614,7 @@ not be printed but they won't be forgotten either, so you can toggle them again
 later. To do that, use `disable display` or `enable display` followed by the
 expression number.
 
-### Evaluation of expressions: display
+### Evaluation of expressions: irb, pry
 
 To examine and change data in your script you can just evaluate any Ruby code
 from `byebug`'s prompt. Any input that is not recognized as a command will be
@@ -1631,23 +1645,9 @@ $ byebug triangle.rb
     9:
    10: if __FILE__ == $0
 (byebug) irb
-2.0.0-p247 :001 > (0..6).inject{|sum, i| sum +=i}
+irb(main):001:0> (0..6).inject { |sum, i| sum += i }
  => 21
-2.0.0-p247 :002 > exit
-/home/davidr/Proyectos/byebug/old_doc/triangle.rb @ 2
-def triangle(n)
-(byebug) list # same line range as before going into irb
-[1, 10] in /path/to/triangle.rb
-    1: # Compute the n'th triangle number, the hard way: triangle(n) == (n*(n+1))/2
-=>  2: def triangle(n)
-    3:   tri = 0
-    4:   0.upto(n) do |i|
-    5:     tri += i
-    6:   end
-    7:   tri
-    8: end
-    9:
-   10: if __FILE__ == $0
+irb(main):002:0> exit
 (byebug)
 ```
 

data/README.md

@@ -18,10 +18,10 @@
 [tip_url]: https://gratipay.com/byebug
 [irc_url]: https://gitter.im/deivid-rodriguez/byebug
 
-Byebug is a simple to use, feature rich debugger for Ruby 2. It uses the new
-TracePoint API for execution control and the new Debug Inspector API for call
-stack navigation, so it doesn't depend on internal core sources. It's developed
-as a C extension, so it's fast. And it has a full test suite so it's reliable.
+Byebug is a simple to use, feature rich debugger for Ruby. It uses the
+TracePoint API for execution control and the Debug Inspector API for call stack
+navigation, so it doesn't depend on internal core sources. It's developed as a C
+extension, so it's fast. And it has a full test suite so it's reliable.
 
 It allows you to see what is going on _inside_ a Ruby program while it executes
 and offers many of the traditional debugging features such as:
@@ -48,12 +48,10 @@ Windows [![Vey][vey]][vey_url]
 
 ## Requirements
 
-* Required: MRI 2.0.0 or higher. For debugging ruby 1.9.3 or older, use
-  [debugger].
 * Recommended:
-  * MRI 2.1.8 or higher.
   * MRI 2.2.4 or higher.
   * MRI 2.3.0 or higher.
+  * MRI 2.4.0 or higher.
 
 ## Install
 
@@ -63,6 +61,8 @@ gem install byebug
 
 ## Usage
 
+### From within the Ruby code
+
 Simply drop
 
     byebug
@@ -74,6 +74,7 @@ If you were debugging Rails, for example, you would add `byebug` to your code.
 def index
   byebug
   @articles = Article.find_recent
+end
 ```
 
 And then start a Rails server.
@@ -84,6 +85,14 @@ bin/rails s
 
 Once the execution gets to your `byebug` command you will get a debugging prompt.
 
+### From the command line
+
+If you want to debug a Ruby script without editing it, you can invoke byebug from the command line.
+
+```shell
+byebug myscript.rb
+```
+
 ## Byebug's commands
 
     Command     | Aliases      | Subcommands
@@ -145,6 +154,7 @@ started. Proper documentation will be eventually written.
   connected.
 * [minitest-byebug] starts a byebug session on minitest failures.
 * [sublime_debugger] provides a plugin for ruby debugging on Sublime Text.
+* [atom-byebug] provides integration with the Atom editor [EXPERIMENTAL].
 
 ## Contribute
 
@@ -168,3 +178,4 @@ software, especially:
 [ruby-debug-passenger]: https://github.com/davejamesmiller/ruby-debug-passenger
 [minitest-byebug]: https://github.com/kaspth/minitest-byebug
 [sublime_debugger]: https://github.com/shuky19/sublime_debugger
+[atom-byebug]: https://github.com/izaera/atom-byebug

data/bin/byebug

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+bin_dir = File.dirname(File.realpath(__FILE__))
+
+$LOAD_PATH.unshift(File.expand_path(File.join('..', 'lib'), bin_dir))
 
 require 'byebug/runner'
 

data/ext/byebug/breakpoint.c

@@ -277,7 +277,7 @@ brkpt_initialize(VALUE self, VALUE source, VALUE pos, VALUE expr)
   return Qnil;
 }
 
-int
+static int
 filename_cmp_impl(VALUE source, char *file)
 {
   char *source_ptr, *file_ptr;
@@ -309,7 +309,7 @@ filename_cmp_impl(VALUE source, char *file)
   return 1;
 }
 
-int
+static int
 filename_cmp(VALUE source, char *file)
 {
 #ifdef _WIN32
@@ -332,7 +332,7 @@ filename_cmp(VALUE source, char *file)
 #endif
 }
 
-int
+static int
 classname_cmp(VALUE name, VALUE klass)
 {
   VALUE mod_name;

data/ext/byebug/byebug.c

@@ -37,9 +37,9 @@ Breakpoints(VALUE self)
 
 /*
  *  call-seq:
- *    Byebug.catchpoints -> array
+ *    Byebug.catchpoints -> hash
  *
- *  Returns an array of catchpoints.
+ *  Returns the catchpoints hash.
  */
 static VALUE
 Catchpoints(VALUE self)
@@ -352,7 +352,7 @@ return_event(VALUE trace_point, void *data)
   {
     file = rb_tracearg_path(trace_arg);
     /*
-     * TODO: Sometimes the TracePoint API gives some return events without
+     * @todo Sometimes the TracePoint API gives some return events without
      * file:line information, so we need to guard for nil until we know what's
      * going on. This happens, for example, with active_support core extensions:
      *
@@ -676,6 +676,9 @@ Stoppable(VALUE self)
   if (post_mortem == Qtrue)
     return Qfalse;
 
+  if (RTEST(tracing))
+    return Qfalse;
+
   context = Current_context(self);
   if (!NIL_P(context))
   {
@@ -841,7 +844,7 @@ Set_post_mortem(VALUE self, VALUE value)
  *  call-seq:
  *    Byebug.add_catchpoint(exception) -> exception
  *
- *  Adds a new exception to the catchpoints array.
+ *  Adds a new exception to the catchpoints hash.
  */
 static VALUE
 Add_catchpoint(VALUE self, VALUE value)

data/ext/byebug/byebug.h

@@ -93,7 +93,6 @@ typedef struct
 } breakpoint_t;
 
 /* functions from locker.c */
-extern int is_in_locked(VALUE thread_id);
 extern void add_to_locked(VALUE thread);
 extern VALUE pop_from_locked();
 extern void remove_from_locked(VALUE thread);
@@ -121,9 +120,6 @@ extern VALUE context_backtrace_set(const rb_debug_inspector_t * inspector,
 
 /* functions from breakpoint.c */
 extern void Init_breakpoint(VALUE mByebug);
-extern VALUE catchpoint_hit_count(VALUE catchpoints, VALUE exception,
-                                  VALUE * exception_name);
-
 extern VALUE find_breakpoint_by_pos(VALUE breakpoints, VALUE source, VALUE pos,
                                     VALUE bind);
 

data/ext/byebug/locker.c

@@ -13,7 +13,7 @@ typedef struct locked_thread_t
 static locked_thread_t *locked_head = NULL;
 static locked_thread_t *locked_tail = NULL;
 
-extern int
+static int
 is_in_locked(VALUE thread)
 {
   locked_thread_t *node;

data/ext/byebug/threads.c

@@ -7,7 +7,7 @@ static VALUE cThreadsTable;
 VALUE next_thread = Qnil;
 
 /* To allow thread syncronization, we must stop threads when debugging */
-VALUE locker = Qnil;
+static VALUE locker = Qnil;
 
 static int
 t_tbl_mark_keyvalue(st_data_t key, st_data_t value, st_data_t tbl)
@@ -97,7 +97,7 @@ is_living_thread(VALUE thread)
 /*
  *  Checks threads table for dead/finished threads.
  */
-void
+static void
 cleanup_dead_threads(void)
 {
   threads_table_t *t_tbl;

data/lib/byebug/breakpoint.rb

@@ -81,10 +81,8 @@ module Byebug
     # Prints all information associated to the breakpoint
     #
     def inspect
-      meths = %w(id pos source expr hit_condition hit_count hit_value enabled?)
-      values = meths.map do |field|
-        "#{field}: #{send(field)}"
-      end.join(', ')
+      meths = %w[id pos source expr hit_condition hit_count hit_value enabled?]
+      values = meths.map { |field| "#{field}: #{send(field)}" }.join(', ')
       "#<Byebug::Breakpoint #{values}>"
     end
   end

data/lib/byebug/commands/catch.rb

@@ -36,7 +36,7 @@ module Byebug
     def execute
       return info unless @match[1]
 
-      return 'off' == @match[1] ? clear : add(@match[1]) unless @match[2]
+      return @match[1] == 'off' ? clear : add(@match[1]) unless @match[2]
 
       return errmsg pr('catch.errors.off', off: cmd) unless @match[2] == 'off'
 

data/lib/byebug/commands/delete.rb

@@ -44,8 +44,10 @@ module Byebug
 
         return errmsg(err) unless pos
 
-        unless Breakpoint.remove(pos)
-          return errmsg(pr('break.errors.no_breakpoint_delete', pos: pos))
+        if Breakpoint.remove(pos)
+          puts(pr('break.messages.breakpoint_deleted', pos: pos))
+        else
+          errmsg(pr('break.errors.no_breakpoint_delete', pos: pos))
         end
       end
     end

data/lib/byebug/commands/edit.rb

@@ -35,7 +35,7 @@ module Byebug
 
       cmd = line ? "#{editor} +#{line} #{file}" : "#{editor} #{file}"
 
-      system(cmd)
+      Kernel.system(cmd)
     end
 
     private

data/lib/byebug/commands/enable/breakpoints.rb

@@ -29,7 +29,7 @@ module Byebug
       end
 
       def self.short_description
-        'Disable all or specific breakpoints'
+        'Enable all or specific breakpoints'
       end
 
       def execute

data/lib/byebug/commands/finish.rb

@@ -40,7 +40,7 @@ module Byebug
         n_frames = 1
       end
 
-      force = n_frames == 0 ? true : false
+      force = n_frames.zero? ? true : false
       context.step_out(context.frame.pos + n_frames, force)
       context.frame = 0
       processor.proceed!

data/lib/byebug/commands/info/breakpoints.rb

@@ -53,7 +53,7 @@ module Byebug
         hits = brkpt.hit_count
         return unless hits > 0
 
-        s = (hits > 1) ? 's' : ''
+        s = hits > 1 ? 's' : ''
         puts "  breakpoint already hit #{hits} time#{s}"
       end
     end

data/lib/byebug/commands/info/file.rb

@@ -10,6 +10,7 @@ module Byebug
     #
     class FileCommand < Command
       include Helpers::FileHelper
+      include Helpers::StringHelper
 
       self.allow_in_post_mortem = true
 
@@ -38,8 +39,7 @@ module Byebug
           return errmsg(pr('info.errors.undefined_file', file: file))
         end
 
-        puts <<-EOC.gsub(/^ {6}/, '')
-
+        puts prettify <<-EOC
           File #{info_file_basic(file)}
 
           Breakpoint line numbers: #{info_file_breakpoints(file)}
@@ -47,7 +47,6 @@ module Byebug
           Modification time: #{info_file_mtime(file)}
 
           Sha1 Signature: #{info_file_sha1(file)}
-
         EOC
       end
 

data/lib/byebug/commands/irb.rb

@@ -1,5 +1,6 @@
 require 'byebug/command'
 require 'irb'
+require 'English'
 
 module Byebug
   #
@@ -25,23 +26,24 @@ module Byebug
     end
 
     def execute
-      unless processor.interface.is_a?(LocalInterface)
+      unless processor.interface.instance_of?(LocalInterface)
         return errmsg(pr('base.errors.only_local'))
       end
 
-      # IRB tries to parse ARGV so we must clear it.  See issue 197
-      with_clean_argv { IRB.start(__FILE__) }
+      # @todo IRB tries to parse $ARGV so we must clear it (see #197). Add a
+      #   test case for it so we can remove this comment.
+      with_clean_argv { IRB.start }
     end
 
     private
 
     def with_clean_argv
-      saved_argv = ARGV.dup
-      ARGV.clear
+      saved_argv = $ARGV.dup
+      $ARGV.clear
       begin
         yield
       ensure
-        ARGV.concat(saved_argv)
+        $ARGV.concat(saved_argv)
       end
     end
   end

data/lib/byebug/commands/kill.rb

@@ -38,7 +38,7 @@ module Byebug
         signame = 'KILL'
       end
 
-      processor.interface.close if 'KILL' == signame
+      processor.interface.close if signame == 'KILL'
       Process.kill(signame, Process.pid)
     end
   end

data/lib/byebug/commands/pry.rb

@@ -25,17 +25,17 @@ module Byebug
     end
 
     def execute
-      unless processor.interface.is_a?(LocalInterface)
+      unless processor.interface.instance_of?(LocalInterface)
         return errmsg(pr('base.errors.only_local'))
       end
 
       begin
         require 'pry'
       rescue LoadError
-        errmsg(pr('pry.errors.not_installed'))
+        return errmsg(pr('pry.errors.not_installed'))
       end
 
-      context.binding.pry
+      Pry.start(context.frame._binding)
     end
   end
 end

data/lib/byebug/commands/restart.rb

@@ -1,12 +1,16 @@
 require 'byebug/command'
+require 'byebug/helpers/bin'
 require 'byebug/helpers/path'
 require 'shellwords'
+require 'English'
+require 'rbconfig'
 
 module Byebug
   #
   # Restart debugged program from within byebug.
   #
   class RestartCommand < Command
+    include Helpers::BinHelper
     include Helpers::PathHelper
 
     self.allow_in_control = true
@@ -32,14 +36,27 @@ module Byebug
     end
 
     def execute
-      argv = [$PROGRAM_NAME]
+      cmd = [$PROGRAM_NAME]
 
-      argv.unshift(bin_file) if Byebug.mode == :standalone
+      cmd = prepend_byebug_bin(cmd)
+      cmd = prepend_ruby_bin(cmd)
 
-      argv += (@match[:args] ? @match[:args].shellsplit : $ARGV.compact)
+      cmd += (@match[:args] ? @match[:args].shellsplit : $ARGV)
 
-      puts pr('restart.success', cmd: argv.shelljoin)
-      exec(*argv)
+      puts pr('restart.success', cmd: cmd.shelljoin)
+      Kernel.exec(*cmd)
+    end
+
+    private
+
+    def prepend_byebug_bin(cmd)
+      cmd.unshift(bin_file) if Byebug.mode == :standalone
+      cmd
+    end
+
+    def prepend_ruby_bin(cmd)
+      cmd.unshift(RbConfig.ruby) if which('ruby') != which(cmd.first)
+      cmd
     end
   end
 end

data/lib/byebug/commands/save.rb

@@ -62,7 +62,7 @@ module Byebug
     end
 
     def save_settings(file)
-      %w(autoirb autolist basename).each do |setting|
+      %w[autoirb autolist basename].each do |setting|
         file.puts "set #{setting} #{Setting[setting.to_sym]}"
       end
     end