byebug 9.1.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d998c99367586ad5a7f29f3bd5e22b2836f1d7c8
-  data.tar.gz: 32cf7615ad42d875e78c103e48c9a40dcde502be
+SHA256:
+  metadata.gz: d1a9c68e68fbb9969eed83bdb9aeaafeb669f377bceb9ab0b5ec2d0b54c1467a
+  data.tar.gz: 817a487ce04be154b49cfb8b56d54fa2c0f9385503de378044f2f8f0a34982ce
 SHA512:
-  metadata.gz: 2f5f3f1aec38feaa4a83fd97b9b09313a97ea5dd25daee3e9319d602e7268ca8fa6ade3995c8d8ccd4d68d5369e2f6511a3d8710562bc3204866bbc5ab20452b
-  data.tar.gz: 570436e9f4263fdc9191c666337e5a726854427932fa995fa4819417414a6160830d27ffa3d0a3acf9c1e23fa4d387ee8d6f0d4e50e4b6b583626443e31b2bd9
+  metadata.gz: 22559feb649630e9bccbedea078a964dcb4bbb08302a8e6835168937e338ebe1244c0efcc33fd6b259601d17906c20939f64dca9ed23572cb1470ec5bea6397a
+  data.tar.gz: 29a0144c8404d6ef611f7f5b8d1ed22fe986efec0ed6bc20a1bff74b7e0a01904e3a707170e59032072f8cbb9f701db82d8012e7cfd399216472c7f1270bd335

data/CHANGELOG.md

@@ -2,7 +2,28 @@
 
 ## Master (Unreleased)
 
-## 9.1.0 - 2016-08-22
+## 10.0.0 - 2018-01-26
+
+### Changed
+
+* Breaking on methods now stops on the first effective line of a method, not on
+  the line containing the `def` keyword.
+
+### Added
+
+* Show valid breakpoint locations when invalid location given (#393, @ko1).
+* Ruby 2.5.0 support (#397, @yui-knk).
+* Log host & port when launching byebug's client in remote mode.
+* Some love & tests to remote debugging (#82).
+* `remote_byebug` shortcut to start the most common case for remote debugging (#141).
+
+## Fixed
+
+* Properly ignore ruby fullpath executable when passed to byebug script (#419).
+* Remote server crash when interrupting client (#141, #274).
+* Control server thread being able to `interrupt` main thread only a single time. (#239).
+
+## 9.1.0 - 2017-08-22
 
 ### Added
 
@@ -11,7 +32,7 @@
 ### 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 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
@@ -32,7 +53,7 @@
 
 ### Fixed
 
-* Error loading rc file when `ENV['HOME']` is unset.
+* Error loading rc file when `ENV["HOME"]` is unset.
 
 ## 9.0.4 - 2016-05-19
 

data/CONTRIBUTING.md

@@ -21,37 +21,58 @@ abide by its terms.
   always have the lastest patch level release installed.
 * The recommended tool to manage development dependencies is `bundler`. Run
   `gem install bundler` to install it.
-* Running `bundle install` inside a local clone of `byebug` will get development
-  dependencies installed.
+* Running `bin/bundle install` inside a local clone of `byebug` will get
+  development dependencies installed.
 
 ## Running the test suite
 
-* Make sure you compile the C-extension using `bundle exec rake compile`.
+* Make sure you compile the C-extension using `bin/rake compile`.
   Otherwise you won't be able to use `byebug`.
-* Run the test suite using the default rake task (`bundle exec rake`). This
-  task is composed of 2 subtasks: `bundle exec rake compile` &&
-  `bundle exec rake test`.
+* Run the test suite using the default rake task (`bin/rake`). This task is
+  composed of 3 subtasks: `bin/rake compile`, `bin/rake test` & `bin/rake lint`.
 * If you want to run specific tests, use the provided test runner, like so:
-  * Specific test files. For example,
-    `script/minitest_runner.rb test/commands/break_test.rb`
-  * Specific test classes. For example,
-    `script/minitest_runner.rb Byebug::BreakAtLinesTestCase`
+  * Specific test files. For example, `bin/minitest test/commands/break_test.rb`
+  * Specific test classes. For example, `bin/minitest BreakAtLinesTest`
   * Specific tests. For example,
-    `script/minitest_runner.rb test_catch_removes_specific_catchpoint`
+    `bin/minitest test_catch_removes_specific_catchpoint`
   * Specific fully qualified tests. For example,
-    `script/minitest_runner.rb
-    BreakAtLinesTest#test_setting_breakpoint_sets_correct_fields`
+    `bin/minitest BreakAtLinesTest#test_setting_breakpoint_sets_correct_fields`
   * You can combine any of them and you will get the union of all filters. For
-    example: `script/minitest_runner.rb Byebug::BreakAtLinesTestCase
+    example: `bin/minitest BreakAtLinesTest
     test_catch_removes_specific_catchpoint`
 
 ## 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
-  are committed, checking they are consistent with the project's code style.
+* Byebug uses [codeclimate][] to enforce code style. You can run codeclimate
+  checks locally using the [codeclimate CLI][] with `codeclimate analyze`.
 
-[overcommit]: https://github.com/brigade/overcommit/
+* It also uses some extra style checks that are not available in codeclimate.
+  You can run those using `bin/rake lint`. These tasks are:
+
+  * Linting of c-files using `clang-format`. Configuration is specific to
+    clang-format 3.8, you may need some extra work to get that installed on macOS,
+    see below.
+
+  * Checking correct executable bit on repository files.
+
+[codeclimate]: https://codeclimate.com/github/deivid-rodriguez/byebug
+[codeclimate CLI]: https://github.com/codeclimate/codeclimate
+
+### Runnning `clang-format` on macOS
+
+At the moment byebug uses older `clang-format` version to enforce C codestyle than
+can be found in Homebrew. If you are planning to change some C source here it is
+recommended to use [direnv][] to hook that older version into your shell:
+
+* Install [direnv][] as described in their README
+* Install `clang-format@3.8` with `brew install clang-format@3.8`
+* In byebug source code directory do `echo 'export PATH="/usr/local/opt/clang-format@3.8/bin:$PATH"' > .envrc`
+* Allow direnv to use that `.envrc` file with `direnv allow`
+
+With that your `$PATH` will be updated to use older `clang-format` every time you `cd`
+into byebug source code folder. It will reverted back when you `cd` out of it as well.
+
+[direnv]: https://github.com/direnv/direnv/
 
 ## Byebug as a C-extension
 

data/GUIDE.md

@@ -186,7 +186,7 @@ end
 
 n_args = $ARGV.length
 
-raise('*** 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
 
@@ -198,7 +198,7 @@ if n_args > 0
   end
 end
 
-raise('*** Number of disks should be between 1 and 100') if n < 1 || n > 100
+raise("*** Number of disks should be between 1 and 100") if n < 1 || n > 100
 
 hanoi(n, :a, :b, :c)
 ```
@@ -330,7 +330,7 @@ Now let's see what happens after stepping:
    11:
 => 12: n_args = $ARGV.length
    13:
-   14: raise('*** 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)
@@ -349,7 +349,7 @@ can use the `restart` command here.
 ```bash
 (byebug) restart 3
 Re exec'ing:
-  /path/to/bin/byebug /path/to/hanoi.rb 3
+  /path/to/exe/byebug /path/to/hanoi.rb 3
 
 [1, 10] in /path/to/hanoi.rb
     1: #
@@ -460,7 +460,7 @@ NameError Exception: undefined local variable or method `n_args' for main:Object
    23:   end
    24: end
    25:
-   26: raise('*** 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
@@ -527,8 +527,8 @@ framework for that. Here's the test code, it should be placed in the same
 directory as `triangle.rb`.
 
 ```ruby
-require 'minitest/autorun'
-require_relative 'triangle.rb'
+require "minitest/autorun"
+require_relative "triangle.rb"
 
 class TestTriangle < Minitest::Test
   def test_basic
@@ -536,7 +536,7 @@ class TestTriangle < Minitest::Test
 
     0.upto(5) { |i| solutions << triangle(i) }
 
-    assert_equal([0, 1, 3, 6, 10, 15], solutions, 'First 5 triangle numbers')
+    assert_equal([0, 1, 3, 6, 10, 15], solutions, "First 5 triangle numbers")
   end
 end
 ```
@@ -561,7 +561,7 @@ Run options: --seed 31679
 # Running:
 
 [2, 11] in test_triangle.rb
-    2: require_relative 'triangle.rb'
+    2: require_relative "triangle.rb"
     3:
     4: class TestTriangle < Minitest::Test
     5:   def test_basic
@@ -570,7 +570,7 @@ Run options: --seed 31679
     8:
     9:     0.upto(5) { |i| solutions << triangle(i) }
    10:
-   11:     assert_equal([0, 1, 3, 6, 10, 15], solutions, 'First 5 triangle numbers')
+   11:     assert_equal([0, 1, 3, 6, 10, 15], solutions, "First 5 triangle numbers")
 (byebug)
 ```
 
@@ -740,7 +740,7 @@ _current_ class of the object.
 Consider the following little Ruby program.
 
 ```ruby
-'Yes it does' =~ /
+"Yes it does" =~ /
 (Yes) \s+
 it  \s+
 does
@@ -953,8 +953,7 @@ We have started by debugging the `employee` thread. To do that, we switch to
 that thread using the `thread switch 3` command. The thread number is the one
 specified by `thread list`, we know this is our worker thread because `thread
 list` specifies where the thread is defined in the file (and its current
-position if the thread is currently running, although this is only available
-since Ruby 2.2.1).
+position if the thread is currently running).
 
 After that we stopped the main thread and the worker thread, using the command
 `thread stop`. We do this because we want to focus on the employee thread first
@@ -1312,7 +1311,7 @@ at the same speed as if there were no byebug.
 To enter byebug this way, just drop `byebug` in whichever line you want to start
 debugging at. You also have to require byebug somehow. If using bundler, it will
 take care of that for you, otherwise you can use the ruby `-r` flag or add
-`require 'byebug'` in the line previous to the `byebug` call.
+`require "byebug"` in the line previous to the `byebug` call.
 
 If speed is crucial, you may want to start and stop this around certain sections
 of code, using `Byebug.start` and `Byebug.stop`. Alternatively, instead of
@@ -1328,7 +1327,7 @@ problem you want to investigate. And since `byebug` is just a method call it's
 possible to enclose it in a conditional expression, for example
 
 ```ruby
-byebug if 'bar' == foo and 20 == iter_count
+byebug if "bar" == foo and 20 == iter_count
 ```
 
 ### Restarting Byebug
@@ -1355,9 +1354,9 @@ program that you want to debug (In Rails, the
 `config/environments/development.rb` could be a good candidate).
 
 ```ruby
-  require 'byebug/core'
+  require "byebug/core"
   Byebug.wait_connection = true
-  Byebug.start_server('localhost', <port>)
+  Byebug.start_server("localhost", <port>)
 ```
 
 Once this piece gets executed, you can connect to the remote debugger from your

data/README.md

@@ -1,21 +1,18 @@
 # Byebug
 
 [![Version][gem]][gem_url]
-[![Quality][gpa]][gpa_url]
+[![Maintainability][mai]][mai_url]
 [![Coverage][cov]][cov_url]
-[![Gratipay][tip]][tip_url]
 [![Gitter][irc]][irc_url]
 
 [gem]: https://img.shields.io/gem/v/byebug.svg
-[gpa]: https://img.shields.io/codeclimate/github/deivid-rodriguez/byebug.svg
-[cov]: https://img.shields.io/codeclimate/coverage/github/deivid-rodriguez/byebug.svg
-[tip]: https://img.shields.io/gittip/byebug.svg
+[mai]: https://api.codeclimate.com/v1/badges/f1a1bec582752c22da80/maintainability
+[cov]: https://api.codeclimate.com/v1/badges/f1a1bec582752c22da80/test_coverage
 [irc]: https://img.shields.io/badge/IRC%20(gitter)-devs%20%26%20users-brightgreen.svg
 
 [gem_url]: https://rubygems.org/gems/byebug
-[gpa_url]: https://codeclimate.com/github/deivid-rodriguez/byebug
-[cov_url]: https://codeclimate.com/github/deivid-rodriguez/byebug
-[tip_url]: https://gratipay.com/byebug
+[mai_url]: https://codeclimate.com/github/deivid-rodriguez/byebug/maintainability
+[cov_url]: https://codeclimate.com/github/deivid-rodriguez/byebug/test_coverage
 [irc_url]: https://gitter.im/deivid-rodriguez/byebug
 
 Byebug is a simple to use, feature rich debugger for Ruby. It uses the
@@ -36,22 +33,23 @@ and offers many of the traditional debugging features such as:
 
 ## Build Status
 
-Linux [![Tra][tra]][tra_url]
-
+Linux [![Cir][cir]][cir_url]
+macOS [![Tra][tra]][tra_url]
 Windows [![Vey][vey]][vey_url]
 
-[tra]: https://img.shields.io/travis/deivid-rodriguez/byebug.svg?branch=master
+[cir]: https://circleci.com/gh/deivid-rodriguez/byebug/tree/master.svg?style=svg
+[tra]: https://api.travis-ci.org/deivid-rodriguez/byebug.svg?branch=master
 [vey]: https://ci.appveyor.com/api/projects/status/github/deivid-rodriguez/byebug?svg=true
 
+[cir_url]: https://circleci.com/gh/deivid-rodriguez/byebug/tree/master
 [tra_url]: https://travis-ci.org/deivid-rodriguez/byebug
 [vey_url]: https://ci.appveyor.com/project/deivid-rodriguez/byebug
 
 ## Requirements
 
-* Recommended:
-  * MRI 2.2.4 or higher.
-  * MRI 2.3.0 or higher.
-  * MRI 2.4.0 or higher.
+* Required: MRI 2.2.0 or higher.
+
+* Recommended: MRI 2.3.0 or higher.
 
 ## Install
 
@@ -59,6 +57,12 @@ Windows [![Vey][vey]][vey_url]
 gem install byebug
 ```
 
+Or if you use `bundler`,
+
+```shell
+bundle add byebug --group "development, test"
+```
+
 ## Usage
 
 ### From within the Ruby code
@@ -95,43 +99,43 @@ byebug myscript.rb
 
 ## Byebug's commands
 
-    Command     | Aliases      | Subcommands
-    ----------- |:------------ |:-----------
-    `backtrace` | `bt` `where` |
-    `break`     |              |
-    `catch`     |              |
-    `condition` |              |
-    `continue`  |              |
-    `delete`    |              |
-    `debug`     |              |
-    `disable`   |              | `breakpoints` `display`
-    `display`   |              |
-    `down`      |              |
-    `edit`      |              |
-    `enable`    |              | `breakpoints` `display`
-    `finish`    |              |
-    `frame`     |              |
-    `help`      |              |
-    `history`   |              |
-    `info`      |              | `args` `breakpoints` `catch` `display` `file` `line` `program`
-    `irb`       |              |
-    `kill`      |              |
-    `list`      |              |
-    `method`    |              | `instance`
-    `next`      |              |
-    `pry`       |              |
-    `quit`      |              |
-    `restart`   |              |
-    `save`      |              |
-    `set`       |              | `autoirb` `autolist` `autopry` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `width`
-    `show`      |              | `autoirb` `autolist` `autopry` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `width`
-    `source`    |              |
-    `step`      |              |
-    `thread`    |              | `current` `list` `resume` `stop` `switch`
-    `tracevar`  |              |
-    `undisplay` |              |
-    `up`        |              |
-    `var`       |              | `all` `constant` `global` `instance` `local`
+Command     | Aliases      | Subcommands
+-------     | -------      | -----------
+`backtrace` | `bt` `where` |
+`break`     |              |
+`catch`     |              |
+`condition` |              |
+`continue`  |              |
+`delete`    |              |
+`debug`     |              |
+`disable`   |              | `breakpoints` `display`
+`display`   |              |
+`down`      |              |
+`edit`      |              |
+`enable`    |              | `breakpoints` `display`
+`finish`    |              |
+`frame`     |              |
+`help`      |              |
+`history`   |              |
+`info`      |              | `args` `breakpoints` `catch` `display` `file` `line` `program`
+`irb`       |              |
+`kill`      |              |
+`list`      |              |
+`method`    |              | `instance`
+`next`      |              |
+`pry`       |              |
+`quit`      |              |
+`restart`   |              |
+`save`      |              |
+`set`       |              | `autoirb` `autolist` `autopry` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `width`
+`show`      |              | `autoirb` `autolist` `autopry` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `width`
+`source`    |              |
+`step`      |              |
+`thread`    |              | `current` `list` `resume` `stop` `switch`
+`tracevar`  |              |
+`undisplay` |              |
+`up`        |              |
+`var`       |              | `all` `constant` `global` `instance` `local`
 
 ## Semantic Versioning
 
@@ -160,6 +164,11 @@ started. Proper documentation will be eventually written.
 
 See [Getting Started with Development](CONTRIBUTING.md).
 
+You can also help `byebug` by leaving a small (or big) tip through
+[Liberapay][liberapay.com].
+
+[![Support via Liberapay][liberapay-button]][liberapay-donate]
+
 ## Credits
 
 Everybody who has ever contributed to this forked and reforked piece of
@@ -179,3 +188,6 @@ software, especially:
 [minitest-byebug]: https://github.com/kaspth/minitest-byebug
 [sublime_debugger]: https://github.com/shuky19/sublime_debugger
 [atom-byebug]: https://github.com/izaera/atom-byebug
+[liberapay.com]: https://liberapay.com
+[liberapay-button]: https://liberapay.com/assets/widgets/donate.svg
+[liberapay-donate]: https://liberapay.com/byebug/donate

data/exe/byebug

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "byebug/runner"
+
+Byebug::Runner.new.run

data/ext/byebug/breakpoint.c

@@ -239,7 +239,7 @@ brkpt_source(VALUE self)
 }
 
 static void
-mark_breakpoint(breakpoint_t * breakpoint)
+mark_breakpoint(breakpoint_t *breakpoint)
 {
   rb_gc_mark(breakpoint->source);
   rb_gc_mark(breakpoint->expr);