byebug 10.0.2 → 11.0.0

data/CONTRIBUTING.md

@@ -43,36 +43,8 @@ abide by its terms.
 
 ## Code style
 
-* Byebug uses [codeclimate][] to enforce code style. You can run codeclimate
-  checks locally using the [codeclimate CLI][] with `codeclimate analyze`.
-
-* 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 uses several style checks to check code style consistent. You can run
+  those using `bin/rake lint`.
 
 ## Byebug as a C-extension
 
@@ -81,6 +53,6 @@ functionality is implemented in C (the interaction with the TracePoint API).
 The rest of the gem is implemented in Ruby. Normally you won't need to touch
 the C-extension, but it will obviously depended on the bug you're trying to fix
 or the feature you are willing to add. You can learn more about C-extensions
-[here](http://tenderlovemaking.com/2009/12/18/writing-ruby-c-extensions-part-1.html)
+[here](https://tenderlovemaking.com/2009/12/18/writing-ruby-c-extensions-part-1.html)
 or
-[here](http://tenderlovemaking.com/2010/12/11/writing-ruby-c-extensions-part-2.html).
+[here](https://tenderlovemaking.com/2010/12/11/writing-ruby-c-extensions-part-2.html).

data/GUIDE.md

@@ -69,12 +69,12 @@ Now let us step through the program.
     5:   tri = 0
     6:
     7:   0.upto(n) { |i| tri += i }
-    9:   end
-   10:
-   11:   tri
-   12: end
-   13:
-=> 14: triangle(3)
+    8:
+    9:   tri
+   10: end
+   11:
+=> 12: t = triangle(3)
+   13: puts t
 (byebug) <RET> # hit enter
 
 [1, 10] in /path/to/triangle.rb
@@ -613,7 +613,7 @@ We get the same result as if we had run byebug from the outset.
 ### 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
+Bash (see [bashdb](http://bashdb.sourceforge.net)), there may be a number of things that
 seem or feel a little bit different and may confuse you. A number of these
 things aren't oddities of the debugger per se but differences in how Ruby works
 compared to those other languages. Because Ruby works a little differently from
@@ -1298,7 +1298,7 @@ Running a program from byebug adds a bit of overhead and slows it down a little.
 Furthermore, by necessity, debuggers change the operation of the program they
 are debugging. And this can lead to unexpected and unwanted differences. It has
 happened so often that the term
-[Heisenbugs](http://en.wikipedia.org/wiki/Heisenbug) was coined to describe the
+[Heisenbugs](https://en.wikipedia.org/wiki/Heisenbug) was coined to describe the
 situation where using a debugger (among other possibilities) changes the
 behavior of the program so that the bug doesn't manifest itself anymore.
 
@@ -1468,6 +1468,7 @@ display a short list of named classes of commands
   save       -- Saves current byebug session to a file
   set        -- Modifies byebug settings
   show       -- Shows byebug settings
+  skip       -- Runs until the next breakpoint as long as it is different from the current one
   source     -- Restores a previously saved byebug session
   step       -- Steps into blocks or methods one or more times
   thread     -- Commands to manipulate threads

data/LICENSE

@@ -1,23 +1,23 @@
-Copyright (c) David Rodríguez <deivid.rodriguez@gmail.com>
+Copyright (c) 2018 David Rodríguez <deivid.rodriguez@riseup.net>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-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.
+modification, are permitted provided that the following conditions are met:
 
-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
-ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* 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 COPYRIGHT HOLDERS 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 ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,27 +1,28 @@
 # Byebug
 
 [![Version][gem]][gem_url]
-[![Maintainability][mai]][mai_url]
+[![Tidelift][tid]][tid_url]
 [![Coverage][cov]][cov_url]
 [![Gitter][irc]][irc_url]
 
 [gem]: https://img.shields.io/gem/v/byebug.svg
-[mai]: https://api.codeclimate.com/v1/badges/f1a1bec582752c22da80/maintainability
+[tid]: https://tidelift.com/badges/github/deivid-rodriguez/byebug
 [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
-[mai_url]: https://codeclimate.com/github/deivid-rodriguez/byebug/maintainability
+[tid_url]: https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug&utm_medium=readme_badge
 [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
+Byebug is a simple to use and 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.
+navigation. Therefore, Byebug doesn't depend on internal core sources. Byebug is also
+fast because it is developed as a C extension and reliable because it is supported
+by a full test suite.
 
-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:
+The debugger permits the ability to understand what is going on _inside_ a Ruby program
+while it executes and offers many of the traditional debugging features such as:
 
 * Stepping: Running your program one line at a time.
 * Breaking: Pausing the program at some event or specified instruction, to
@@ -34,7 +35,6 @@ and offers many of the traditional debugging features such as:
 ## Build Status
 
 Linux [![Cir][cir]][cir_url]
-macOS [![Tra][tra]][tra_url]
 Windows [![Vey][vey]][vey_url]
 
 [cir]: https://circleci.com/gh/deivid-rodriguez/byebug/tree/master.svg?style=svg
@@ -47,9 +47,7 @@ Windows [![Vey][vey]][vey_url]
 
 ## Requirements
 
-* Required: MRI 2.2.0 or higher.
-
-* Recommended: MRI 2.3.0 or higher.
+MRI 2.3.0 or higher.
 
 ## Install
 
@@ -57,7 +55,7 @@ Windows [![Vey][vey]][vey_url]
 gem install byebug
 ```
 
-Or if you use `bundler`,
+Alternatively, if you use `bundler`:
 
 ```shell
 bundle add byebug --group "development, test"
@@ -67,12 +65,9 @@ bundle add byebug --group "development, test"
 
 ### From within the Ruby code
 
-Simply drop
-
-    byebug
-
-wherever you want to start debugging and the execution will stop there.
-If you were debugging Rails, for example, you would add `byebug` to your code.
+Simply include `byebug` wherever you want to start debugging and the execution will
+stop there. For example, if you were debugging Rails, you would add `byebug` to
+your code:
 
 ```ruby
 def index
@@ -81,13 +76,13 @@ def index
 end
 ```
 
-And then start a Rails server.
+And then start a Rails server:
 
 ```shell
 bin/rails s
 ```
 
-Once the execution gets to your `byebug` command you will get a debugging prompt.
+Once the execution gets to your `byebug` command, you will receive a debugging prompt.
 
 ### From the command line
 
@@ -99,49 +94,50 @@ byebug myscript.rb
 
 ## Byebug's commands
 
-Command     | Aliases      | Subcommands
--------     | -------      | -----------
-`backtrace` | `bt` `where` |
-`break`     |              |
-`catch`     |              |
-`condition` |              |
-`continue`  |              |
-`debug`     |              |
-`delete`    |              |
-`disable`   |              | `breakpoints` `display`
-`display`   |              |
-`down`      |              |
-`edit`      |              |
-`enable`    |              | `breakpoints` `display`
-`finish`    |              |
-`frame`     |              |
-`help`      |              |
-`history`   |              |
-`info`      |              | `args` `breakpoints` `catch` `display` `file` `line` `program`
-`interrupt` |              |
-`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` |              |
-`untracevar`|              |
-`up`        |              |
-`var`       |              | `all` `constant` `global` `instance` `local`
+Command     | Aliases         | Subcommands
+-------     | -------         | -----------
+`backtrace` | `bt` `w` `where`|
+`break`     | `b`             |
+`catch`     | `cat`           |
+`condition` | `cond`          |
+`continue`  | `c` `cont`      |
+`debug`     |                 |
+`delete`    | `del`           |
+`disable`   | `dis`           | `breakpoints` `display`
+`display`   | `disp`          |
+`down`      |                 |
+`edit`      | `ed`            |
+`enable`    | `en`            | `breakpoints` `display`
+`finish`    | `fin`           |
+`frame`     | `f`             |
+`help`      | `h`             |
+`history`   | `hist`          |
+`info`      | `i`             | `args` `breakpoints` `catch` `display` `file` `line` `program`
+`interrupt` | `int`           |
+`irb`       |                 |
+`kill`      |                 |
+`list`      | `l`             |
+`method`    | `m`             | `instance`
+`next`      | `n`             |
+`pry`       |                 |
+`quit`      | `q`             |
+`restart`   |                 |
+`save`      | `sa`            |
+`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`
+`skip`      | `sk`            |
+`source`    | `so`            |
+`step`      | `s`             |
+`thread`    | `th`            | `current` `list` `resume` `stop` `switch`
+`tracevar`  | `tr`            |
+`undisplay` | `undisp`        |
+`untracevar`| `untr`          |
+`up`        |                 |
+`var`       | `v`             | `all` `constant` `global` `instance` `local`
 
 ## Semantic Versioning
 
-Byebug tries to follow [semantic versioning](http://semver.org) and tries to
+Byebug attempts to follow [semantic versioning](https://semver.org) and
 bump major version only when backwards incompatible changes are released.
 Backwards compatibility is targeted to [pry-byebug] and any other plugins
 relying on `byebug`.
@@ -166,10 +162,18 @@ 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].
+## Funding
+
+Subscribe to [Tidelift] to ensure byebug stays actively maintained, and at the
+same time get licensing assurances and timely security notifications for your
+open source dependencies.
+
+You can also help `byebug` by leaving a small (or big) tip through [Liberapay].
+
+## Security contact information
 
-[![Support via Liberapay][liberapay-button]][liberapay-donate]
+Please use the Tidelift security contact to [report a security vulnerability].
+Tidelift will coordinate the fix and disclosure.
 
 ## Credits
 
@@ -190,6 +194,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
+[Liberapay]: https://liberapay.com/byebug/donate
+[Tidelift]: https://tidelift.com/subscription/pkg/rubygems-byebug?utm_source=rubygems-byebug&utm_medium=readme_text
+[report a security vulnerability]: https://tidelift.com/security

data/lib/byebug/commands.rb

@@ -28,6 +28,7 @@ require "byebug/commands/restart"
 require "byebug/commands/save"
 require "byebug/commands/set"
 require "byebug/commands/show"
+require "byebug/commands/skip"
 require "byebug/commands/source"
 require "byebug/commands/step"
 require "byebug/commands/thread"

data/lib/byebug/commands/break.rb

@@ -23,8 +23,8 @@ module Byebug
 
     def self.description
       <<-DESCRIPTION
-        b[reak] [file:]line [if expr]
-        b[reak] [module::...]class(.|#)method [if expr]
+        b[reak] [<file>:]<line> [if <expr>]
+        b[reak] [<module>::...]<class>(.|#)<method> [if <expr>]
 
         They can be specified by line or method and an expression can be added
         for conditionally enabled breakpoints.
@@ -43,9 +43,7 @@ module Byebug
       b = line_breakpoint(@match[1]) || method_breakpoint(@match[1])
       return errmsg(pr("break.errors.location")) unless b
 
-      if syntax_valid?(@match[2])
-        return puts(pr("break.created", id: b.id, file: b.source, line: b.pos))
-      end
+      return puts(pr("break.created", id: b.id, file: b.source, line: b.pos)) if syntax_valid?(@match[2])
 
       errmsg(pr("break.errors.expression", expr: @match[2]))
       b.enabled = false
@@ -76,7 +74,7 @@ module Byebug
     def target_object(str)
       k = error_eval(str)
 
-      k && k.is_a?(Module) ? k.name : str
+      k&.is_a?(Module) ? k.name : str
     rescue StandardError
       errmsg("Warning: breakpoint source is not yet defined")
       str
@@ -87,9 +85,7 @@ module Byebug
 
       fullpath = File.realpath(file)
 
-      if line > n_lines(file)
-        raise(pr("break.errors.far_line", lines: n_lines(file), file: fullpath))
-      end
+      raise(pr("break.errors.far_line", lines: n_lines(file), file: fullpath)) if line > n_lines(file)
 
       unless Breakpoint.potential_line?(fullpath, line)
         msg = pr(

data/lib/byebug/commands/catch.rb

@@ -48,18 +48,14 @@ module Byebug
     private
 
     def remove(exception)
-      unless Byebug.catchpoints.member?(exception)
-        return errmsg pr("catch.errors.not_found", exception: exception)
-      end
+      return errmsg pr("catch.errors.not_found", exception: exception) unless Byebug.catchpoints.member?(exception)
 
       puts pr("catch.removed", exception: exception)
       Byebug.catchpoints.delete(exception)
     end
 
     def add(exception)
-      if warning_eval(exception.is_a?(Class).to_s)
-        errmsg pr("catch.errors.not_class", class: exception)
-      end
+      errmsg pr("catch.errors.not_class", class: exception) if warning_eval(exception.is_a?(Class).to_s)
 
       puts pr("catch.added", exception: exception)
       Byebug.add_catchpoint(exception)

data/lib/byebug/commands/condition.rb

@@ -47,9 +47,7 @@ module Byebug
       breakpoint = breakpoints.find { |b| b.id == pos }
       return errmsg(pr("break.errors.no_breakpoint")) unless breakpoint
 
-      unless syntax_valid?(@match[2])
-        return errmsg(pr("break.errors.not_changed", expr: @match[2]))
-      end
+      return errmsg(pr("break.errors.not_changed", expr: @match[2])) unless syntax_valid?(@match[2])
 
       breakpoint.expr = @match[2]
     end

data/lib/byebug/commands/continue.rb

@@ -14,7 +14,7 @@ module Byebug
     include Helpers::ParseHelper
 
     def self.regexp
-      /^\s* c(?:ont(?:inue)?)? (?:\s+(\S+))? \s*$/x
+      /^\s* c(?:ont(?:inue)?)? (?:(!|\s+unconditionally|\s+\S+))? \s*$/x
     end
 
     def self.description
@@ -22,6 +22,11 @@ module Byebug
         c[ont[inue]][ <line_number>]
 
         #{short_description}
+
+        Normally the program stops at the next breakpoint. However, if the
+        parameter "unconditionally" is given or the command is suffixed with
+        "!", the program will run until the end regardless of any enabled
+        breakpoints.
       DESCRIPTION
     end
 
@@ -30,21 +35,33 @@ module Byebug
     end
 
     def execute
-      if @match[1]
-        num, err = get_int(@match[1], "Continue", 0, nil)
+      if until_line?
+        num, err = get_int(modifier, "Continue", 0, nil)
         return errmsg(err) unless num
 
         filename = File.expand_path(frame.file)
-        unless Breakpoint.potential_line?(filename, num)
-          return errmsg(pr("continue.errors.unstopped_line", line: num))
-        end
+        return errmsg(pr("continue.errors.unstopped_line", line: num)) unless Breakpoint.potential_line?(filename, num)
 
         Breakpoint.add(filename, num)
       end
 
       processor.proceed!
 
-      Byebug.stop if Byebug.stoppable?
+      Byebug.stop if unconditionally? || Byebug.stoppable?
+    end
+
+    private
+
+    def until_line?
+      @match[1] && !["!", "unconditionally"].include?(modifier)
+    end
+
+    def unconditionally?
+      @match[1] && ["!", "unconditionally"].include?(modifier)
+    end
+
+    def modifier
+      @match[1].lstrip
     end
   end
 end