gitlab-pry-byebug 3.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 033fb16a7334f1e384315488a374de6609e12ae6e6ec092e80d56ee5d9e010ae
+  data.tar.gz: 1a6e8bc37cc14f84c8702fb5f48b826281814fa1580180c1dfb93ef65d12f1ef
+SHA512:
+  metadata.gz: 7146526d40e7946b7f8d9fd5662116ea1b444c201d535c27a09410c7b08933d85632e6ff921f6aebb15522c662ea06b6ca636576a4f1e7a591a06a6485a5e316
+  data.tar.gz: a9b0f0a259200f7675c4d7e70e4370ce2c54966f06f65c6ee965a0d77bfbae6f5b7eed1bb8b23b7abf667db6c71751b8be213f53c427d64e1ae421e06efcee99

data/CHANGELOG.md

@@ -0,0 +1,214 @@
+# CHANGELOG
+
+## Master (Unreleased)
+
+## 3.9.0 (2020-03-21)
+
+### Fixed
+
+* Dependency on pry being too loose. Now breaking minor releases of pry won't affect pry-byebug users (#289).
+
+### Added
+
+* Support for pry 0.13.0 (#266).
+
+### Removed
+
+* Support for pry older than 0.13.0 (#289).
+
+## 3.8.0 (2020-01-22)
+
+### Fixed
+
+* Use `Binding#source_location` instead of evaluating `__FILE__` to avoid
+  warnings on Ruby 2.7 and on Ruby 2.6 in verbose mode (#221).
+
+### Removed
+
+* Support for Ruby 2.3. Pry-byebug no longer installs on this platform.
+
+## 3.7.0 (2019-02-21)
+
+* Byebug 11 compatibility, with ruby 2.6 support.
+
+## 3.6.0 (2018-02-07)
+
+### Added
+
+* Byebug 10 compatibility, with ruby 2.5 support.
+
+## 3.5.1 (2017-11-27)
+
+### Fixed
+
+* Allow other threads like Pry (#142).
+
+## 3.5.0 (2017-08-23)
+
+### Added
+
+* Byebug 9.1 support. As a result, Ruby 2.0 & Ruby 2.1 support has been dropped.
+  Pry-byebug no longer installs on these platforms.
+
+## 3.4.3 (2017-08-22)
+
+### Fixed
+
+* Installation on old rubies after byebug dropping support for them.
+
+## 3.4.2 (2016-12-06)
+
+### Fixed
+
+* Byebug doesn't start after `disable-pry` command.
+
+## 3.4.1 (2016-11-22)
+
+### Fixed
+
+* control_d handler not being required properly when `pry-byebug` loaded
+  as a `pry` plugin and not through explicit require.
+
+## 3.4.0 (2016-05-15)
+
+### Fixed
+
+* Byebug 9 compatibility.
+
+### Added
+
+* A new `backtrace` command.
+
+## 3.3.0 (2015-11-05)
+
+### Fixed
+
+* Byebug 8 compatibility.
+* Fix encoding error in gemspec file (#70).
+* Debugger being too slow (#80, thanks @k0kubun).
+
+## 3.2.0 (2015-07-18)
+
+### Added
+
+* `continue` can now receive a line number argument (#56).
+
+### Fixed
+
+* Conflicts with `break` and `next` Ruby keywords inside multiline statements
+  (#44).
+
+### Removed
+
+* `breaks` command. It was broken anyways (#47).
+
+## 3.1.0 (2015-04-14)
+
+### Added
+
+* Frame navigation commands `up`, `down` and `frame`.
+
+## 3.0.1 (2015-04-02)
+
+### Fixed
+
+* Several formatting and alignment issues.
+
+## 3.0.0 (2015-02-02)
+
+### Fixed
+
+* `binding.pry` would not stop at the correct place when called at the last
+  line of a method/block.
+
+### Removed
+
+* Stepping aliases for `next` (`n`), `step` (`s`), `finish` (`f`) and `continue`
+  (`c`). See #34.
+
+## 2.0.0 (2014-01-09)
+
+### Fixed
+
+* Byebug 3 compatibility.
+* Pry not starting at the first line after `binding.pry`  but at `binding.pry`.
+* `continue` not finishing pry instance (#13).
+
+## 1.3.3 (2014-25-06)
+
+### Fixed
+
+* Pry 0.10 series and further minor version level releases compatibility.
+
+## 1.3.2 (2014-24-02)
+
+### Fixed
+
+* Bug inherited from `byebug`.
+
+## 1.3.1 (2014-08-02)
+
+### Fixed
+
+* Bug #22 (thanks @andreychernih).
+
+## 1.3.0 (2014-05-02)
+
+### Added
+
+* Breakpoints on method names (thanks @andreychernih & @palkan).
+
+### Fixed
+
+* "Undefined method `interface`" error (huge thanks to @andreychernih).
+
+## 1.2.1 (2013-30-12)
+
+### Fixed
+
+* "Uncaught throw :breakout_nav" error (thanks @lukebergen).
+
+## 1.2.0 (2013-24-09)
+
+### Fixed
+
+* Compatibility with byebug's 2.x series
+
+## 1.1.2 (2013-11-07)
+
+### Fixed
+
+* Compatibility with backwards compatible byebug versions.
+
+## 1.1.1 (2013-02-07)
+
+### Fixed
+
+* Bug when doing `step n` or `next n` where n > 1 right after `binding.pry`.
+
+## 1.1.0 (2013-06-06)
+
+### Added
+
+* `s`, `n`, `f` and `c` aliases (thanks @jgakos!).
+
+## 1.0.1 (2013-05-07)
+
+### Fixed
+
+* Unwanted debugging printf.
+
+## 1.0.0 (2013-05-07)
+
+### Added
+
+* Initial release forked from
+  [pry-debugger](https://github.com/nixme/pry-debugger) to support byebug.
+
+### Removed
+
+* pry-remote support.
+
+## Older releases
+
+* Check [pry-debugger](https://github.com/nixme/pry-debugger)'s CHANGELOG.

data/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 David Rodríguez <deivid.rodriguez@riseup.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,192 @@
+# pry-byebug
+
+[![Version][VersionBadge]][VersionURL]
+[![Build][CIBadge]][CIURL]
+[![Inline docs][InchCIBadge]][InchCIURL]
+[![Coverage][CoverageBadge]][CoverageURL]
+
+Adds step-by-step debugging and stack navigation capabilities to [pry] using
+[byebug].
+
+To use, invoke pry normally. No need to start your script or app differently.
+Execution will stop in the first statement after your `binding.pry`.
+
+```ruby
+def some_method
+  puts 'Hello World' # Run 'step' in the console to move here
+end
+
+binding.pry
+some_method          # Execution will stop here.
+puts 'Goodbye World' # Run 'next' in the console to move here.
+```
+
+## Requirements
+
+MRI 2.4.0 or higher.
+
+## Installation
+
+Add
+
+```ruby
+gem 'pry-byebug'
+```
+
+to your Gemfile and run
+
+```console
+bundle install
+```
+
+Make sure you include the gem globally or inside the `:test` group if you plan
+to use it to debug your tests!
+
+## Commands
+
+### Step-by-step debugging
+
+**break:** Manage breakpoints.
+
+**step:** Step execution into the next line or method. Takes an optional numeric
+argument to step multiple times.
+
+**next:** Step over to the next line within the same frame. Also takes an
+optional numeric argument to step multiple lines.
+
+**finish:** Execute until current stack frame returns.
+
+**continue:** Continue program execution and end the Pry session.
+
+### Callstack navigation
+
+**backtrace:** Shows the current stack. You can use the numbers on the left
+side with the `frame` command to navigate the stack.
+
+**up:** Moves the stack frame up. Takes an optional numeric argument to move
+multiple frames.
+
+**down:** Moves the stack frame down. Takes an optional numeric argument to move
+multiple frames.
+
+**frame:** Moves to a specific frame. Called without arguments will show the
+current frame.
+
+## Matching Byebug Behaviour
+
+If you're coming from Byebug or from Pry-Byebug versions previous to 3.0, you
+may be lacking the 'n', 's', 'c' and 'f' aliases for the stepping commands.
+These aliases were removed by default because they usually conflict with
+scratch variable names. But it's very easy to reenable them if you still want
+them, just add the following shortcuts to your `~/.pryrc` file:
+
+```ruby
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end
+```
+
+Also, you might find useful as well the repeat the last command by just hitting
+the `Enter` key (e.g., with `step` or `next`). To achieve that, add this to
+your `~/.pryrc` file:
+
+```ruby
+# Hit Enter to repeat last command
+Pry::Commands.command /^$/, "repeat last command" do
+  _pry_.run_command Pry.history.to_a.last
+end
+```
+
+## Breakpoints
+
+You can set and adjust breakpoints directly from a Pry session using the
+`break` command:
+
+**break:** Set a new breakpoint from a line number in the current file, a file
+and line number, or a method. Pass an optional expression to create a
+conditional breakpoint. Edit existing breakpoints via various flags.
+
+Examples:
+
+```ruby
+break SomeClass#run            # Break at the start of `SomeClass#run`.
+break Foo#bar if baz?          # Break at `Foo#bar` only if `baz?`.
+break app/models/user.rb:15    # Break at line 15 in user.rb.
+break 14                       # Break at line 14 in the current file.
+
+break --condition 4 x > 2      # Change condition on breakpoint #4 to 'x > 2'.
+break --condition 3            # Remove the condition on breakpoint #3.
+
+break --delete 5               # Delete breakpoint #5.
+break --disable-all            # Disable all breakpoints.
+
+break                          # List all breakpoints.
+break --show 2                 # Show details about breakpoint #2.
+```
+
+Type `break --help` from a Pry session to see all available options.
+
+## Alternatives
+
+Note that all of the alternatives here are incompatible with pry-byebug. If
+your platform is supported by pry-byebug, you should remove any of the gems
+mentioned here if they are present in your Gemfile.
+
+* [pry-debugger]: Provides step-by-step debugging for MRI 1.9.3 or older
+  rubies. If you're still using those and need a step-by-step debugger to help
+  with the upgrade, pry-debugger can be handy.
+
+* [pry-stack_explorer]: Provides stack navigation capabilities for MRI 1.9.3 or
+  older rubies. If you're still using those and need to navigate your stack to
+  help with the upgrade, pry-stack_explorer can be handy.
+
+* [pry-nav]: Provides step-by-step debugging for JRuby.
+
+## Contribute
+
+See [Getting Started with Development](CONTRIBUTING.md).
+
+## Funding
+
+Subscribe to [Tidelift] to ensure pry-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 `pry-byebug` by leaving a small (or big) tip through [Liberapay].
+
+[Tidelift]: https://tidelift.com/subscription/pkg/rubygems-pry-byebug?utm_source=rubygems-pry-byebug&utm_medium=referral&utm_campaign=readme
+[Liberapay]: https://liberapay.com/pry-byebug/donate
+
+## Security contact information
+
+Please use the Tidelift security contact to [report a security vulnerability].
+Tidelift will coordinate the fix and disclosure.
+
+[report a security vulnerability]: https://tidelift.com/security
+
+## Credits
+
+* Gopal Patel (@nixme), creator of [pry-debugger], and everybody who contributed
+  to it. pry-byebug is a fork of pry-debugger so it wouldn't exist as it is
+  without those contributions.
+* John Mair (@banister), creator of [pry].
+
+Patches and bug reports are welcome.
+
+[pry]: http://pry.github.com
+[byebug]: https://github.com/deivid-rodriguez/byebug
+[pry-debugger]: https://github.com/nixme/pry-debugger
+[pry-nav]: https://github.com/nixme/pry-nav
+[pry-stack_explorer]: https://github.com/pry/pry-stack_explorer
+
+[VersionBadge]: https://badge.fury.io/rb/pry-byebug.svg
+[VersionURL]: http://badge.fury.io/rb/pry-byebug
+[CIBadge]: https://github.com/deivid-rodriguez/pry-byebug/workflows/ubuntu/badge.svg?branch=master
+[CIURL]: https://github.com/deivid-rodriguez/pry-byebug/actions?query=workflow%3Aubuntu
+[InchCIBadge]: http://inch-ci.org/github/deivid-rodriguez/pry-byebug.svg?branch=master
+[InchCIURL]: http://inch-ci.org/github/deivid-rodriguez/pry-byebug
+[CoverageBadge]: https://api.codeclimate.com/v1/badges/a88e27809329c03af017/test_coverage
+[CoverageURL]: https://codeclimate.com/github/deivid-rodriguez/pry-byebug/test_coverage

data/lib/byebug/processors/pry_processor.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require "byebug/core"
+
+module Byebug
+  #
+  # Extends raw byebug's processor.
+  #
+  class PryProcessor < CommandProcessor
+    attr_accessor :pry
+
+    extend Forwardable
+    def_delegators :@pry, :output
+    def_delegators Pry::Helpers::Text, :bold
+
+    def self.start
+      Byebug.start
+      Setting[:autolist] = false
+      Context.processor = self
+      Byebug.current_context.step_out(4, true)
+    end
+
+    #
+    # Wrap a Pry REPL to catch navigational commands and act on them.
+    #
+    def run(&_block)
+      return_value = nil
+
+      command = catch(:breakout_nav) do # Throws from PryByebug::Commands
+        return_value = allowing_other_threads { yield }
+        {} # Nothing thrown == no navigational command
+      end
+
+      # Pry instance to resume after stepping
+      @pry = command[:pry]
+
+      perform(command[:action], command[:options])
+
+      return_value
+    end
+
+    #
+    # Set up a number of navigational commands to be performed by Byebug.
+    #
+    def perform(action, options = {})
+      return unless %i[
+        backtrace
+        down
+        finish
+        frame
+        next
+        step
+        up
+      ].include?(action)
+
+      send("perform_#{action}", options)
+    end
+
+    # --- Callbacks from byebug C extension ---
+
+    #
+    # Called when the debugger wants to stop at a regular line
+    #
+    def at_line
+      resume_pry
+    end
+
+    #
+    # Called when the debugger wants to stop right before a method return
+    #
+    def at_return(_return_value)
+      resume_pry
+    end
+
+    #
+    # Called when the debugger wants to stop right before the end of a class
+    # definition
+    #
+    def at_end
+      resume_pry
+    end
+
+    #
+    # Called when a breakpoint is hit. Note that `at_line`` is called
+    # inmediately after with the context's `stop_reason == :breakpoint`, so we
+    # must not resume the pry instance here
+    #
+    def at_breakpoint(breakpoint)
+      @pry ||= Pry.new
+
+      output.puts bold("\n  Breakpoint #{breakpoint.id}. ") + n_hits(breakpoint)
+
+      expr = breakpoint.expr
+      return unless expr
+
+      output.puts bold("Condition: ") + expr
+    end
+
+    private
+
+    def n_hits(breakpoint)
+      n_hits = breakpoint.hit_count
+
+      n_hits == 1 ? "First hit" : "Hit #{n_hits} times."
+    end
+
+    #
+    # Resume an existing Pry REPL at the paused point.
+    #
+    def resume_pry
+      new_binding = frame._binding
+
+      run do
+        if defined?(@pry) && @pry
+          @pry.repl(new_binding)
+        else
+          @pry = Pry.start_without_pry_byebug(new_binding)
+        end
+      end
+    end
+
+    def perform_backtrace(_options)
+      Byebug::WhereCommand.new(self, "backtrace").execute
+
+      resume_pry
+    end
+
+    def perform_next(options)
+      lines = (options[:lines] || 1).to_i
+      context.step_over(lines, frame.pos)
+    end
+
+    def perform_step(options)
+      times = (options[:times] || 1).to_i
+      context.step_into(times, frame.pos)
+    end
+
+    def perform_finish(*)
+      context.step_out(1)
+    end
+
+    def perform_up(options)
+      times = (options[:times] || 1).to_i
+
+      Byebug::UpCommand.new(self, "up #{times}").execute
+
+      resume_pry
+    end
+
+    def perform_down(options)
+      times = (options[:times] || 1).to_i
+
+      Byebug::DownCommand.new(self, "down #{times}").execute
+
+      resume_pry
+    end
+
+    def perform_frame(options)
+      index = options[:index] ? options[:index].to_i : ""
+
+      Byebug::FrameCommand.new(self, "frame #{index}").execute
+
+      resume_pry
+    end
+  end
+end