pry-byebug 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d546d7bb0c6f46c48b3a640b5f03dd486116fad
-  data.tar.gz: 08f05ab518a9b5c028c03532c34452cbfba30ef2
+  metadata.gz: b7ccdf30b01d3da08853340f1ebcfece6fa15f37
+  data.tar.gz: fd2d3a518fc219cba6127cea742feb72f1bd7d17
 SHA512:
-  metadata.gz: 7d9004bb5febdc7a7f9f0a6631ead052479269576b607ca2c5f48032c3860471ce9d7cdfa41360b2978530dea7734e698cc8460ee1f1569559539ca5c4e1d069
-  data.tar.gz: 5295c526616f549fdc98c49bc7601ca355acd7f8d7f7661924cf4fe286c62d7ca8e6785c87ab397d87ca8b5f25e2119000a2b40c27413360d7a8518e4e364af8
+  metadata.gz: ba6de59e8732c7a8d6cdf5f3f46b3d5803c4d75c04ea7e1d934680d926516021dc06928b043587aca86cdeaad035c847417eeffe0394bf361419ee8988ad68d0
+  data.tar.gz: cc83d46530c56cf1ecf12581271fc66709570813f22406b0a293c704093f826107a2d091f34f9aec10d608739f883baa96a3cd4cc9af32057c23301d91743622

data/CHANGELOG.md

@@ -1,144 +1,147 @@
-## 3.3.0 (2015-11-05)
+# CHANGELOG
+
+## Master (Unreleased)
+
+## 3.4.0 (2016-05-15)
 
-- Improvements:
-  * Up to date dependencies, including byebug 8.0 series.
-  * Faster debugger thanks to @k0kubun (#80).
+### Fixed
 
-- Bugfixes:
-  * Fix encoding error in gemspec file (#70).
+* 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)
 
-- Improvements:
-  * Allow continue to receive a line number argument (#56).
-  * Refactorings + RuboCop.
-  * Up to date dependencies.
+### Added
+
+* `continue` can now receive a line number argument (#56).
 
-- Bugfixes:
-  * Don't conflict with `break` and `next` Ruby keywords inside multiline
-statements (#44).
+### Fixed
 
-- Removals:
-  * `breaks` command. It was broken anyways (#47).
+* 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)
 
-- Improvements:
-  * Add frame nav commands up, down and frame.
+### Added
 
+* Frame navigation commands `up`, `down` and `frame`.
 
 ## 3.0.1 (2015-04-02)
 
-- Improvements:
-  * Fix several formatting and alignment issues.
+### Fixed
 
+* Several formatting and alignment issues.
 
 ## 3.0.0 (2015-02-02)
 
-- Improvements:
-  * Adds RuboCop to enforce a consistent code style.
-  * Several refactorings to keep code simpler.
+### Fixed
 
-- Bugfixes:
-  * `binding.pry` would not stop at the correct place when called at the last
-line of a method/block.
+* `binding.pry` would not stop at the correct place when called at the last
+  line of a method/block.
 
-- Removals:
-  * Stepping aliases for `next` (`n`), `step` (`s`), `finish` (`f`) and
-`continue` (`c`). See #34.
+### Removed
 
+* Stepping aliases for `next` (`n`), `step` (`s`), `finish` (`f`) and `continue`
+  (`c`). See #34.
 
 ## 2.0.0 (2014-01-09)
 
-- Improvements:
-  * Compatibility with byebug 3
-  * Now pry starts at the first line after binding.pry, not at binding.pry
-- Bugfixes:
-  * 'continue' doesn't finish pry instance (issue #13)
+### 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)
 
-* Relaxes pry dependency to support pry 0.10 series and further minor version
-level releases.
+### Fixed
 
+* Pry 0.10 series and further minor version level releases compatibility.
 
 ## 1.3.2 (2014-24-02)
 
-* Bumps byebug dependency to get rid of bug in byebug.
+### Fixed
 
+* Bug inherited from `byebug`.
 
 ## 1.3.1 (2014-08-02)
 
-* Fix #22 (thanks @andreychernih)
+### Fixed
 
+* Bug #22 (thanks @andreychernih).
 
 ## 1.3.0 (2014-05-02)
 
-* Add breakpoints on method names (thanks @andreychernih & @palkan)
-* Fix "undefined method `interface`" error (huge thanks to @andreychernih)
+### Added
+
+* Breakpoints on method names (thanks @andreychernih & @palkan).
+
+### Fixed
 
+* "Undefined method `interface`" error (huge thanks to @andreychernih).
 
 ## 1.2.1 (2013-30-12)
 
-* Fix for "uncaught throw :breakout_nav" (thanks @lukebergen)
+### Fixed
 
+* "Uncaught throw :breakout_nav" error (thanks @lukebergen).
 
 ## 1.2.0 (2013-24-09)
 
-* Compatibility with byebug's 2.x series
+### Fixed
 
+* Compatibility with byebug's 2.x series
 
 ## 1.1.2 (2013-11-07)
 
-* Allow pry-byebug to use backwards compatible versions of byebug
+### Fixed
 
+* Compatibility with backwards compatible byebug versions.
 
 ## 1.1.1 (2013-02-07)
 
-* Adds some initial tests to the test suite
-* Fixes bug when doing "step n" or "next n" where n > 1 right after binding.pry
+### Fixed
 
+* Bug when doing `step n` or `next n` where n > 1 right after `binding.pry`.
 
 ## 1.1.0 (2013-06-06)
 
-* Adds a test suite (thanks @teeparham!)
-* Uses byebug ~> 1.4.0
-* Uses s, n, f and c aliases by default (thanks @jgakos!)
-
-
-## 1.0.0, 1.0.1 (2013-05-07)
-
-* Forked from [pry-debugger](https://github.com/nixme/pry-debugger) to support
-  byebug
-* Dropped pry-remote support
-
+### Added
 
-## 0.2.2 (2013-03-07)
+* `s`, `n`, `f` and `c` aliases (thanks @jgakos!).
 
-* Relaxed [byebug][byebug] dependency.
+## 1.0.1 (2013-05-07)
 
+### Fixed
 
-## 0.2.1 (2012-12-26)
+* Unwanted debugging printf.
 
-* Support breakpoints on methods defined in the pry console. (@banister)
-* Fix support for specifying breakpoints by *file:line_number*. (@nviennot)
-* Validate breakpoint conditionals are real Ruby expressions.
-* Support for debugger ~> 1.2.0. (@jshou)
-* Safer `alias_method_chain`-style patching of `Pry.start` and
-  `PryRemote::Server#teardown`. (@benizi)
+## 1.0.0 (2013-05-07)
 
+### Added
 
-## 0.2.0 (2012-06-11)
+* Initial release forked from
+  [pry-debugger](https://github.com/nixme/pry-debugger) to support byebug.
 
-* Breakpoints
-* **finish** command
-* Internal cleanup and bug fixes
+### Removed
 
+* pry-remote support.
 
-## 0.1.0 (2012-06-07)
+## Older releases
 
-* First release. **step**, **next**, and **continue** commands.
-  [pry-remote 0.1.4][pry-remote] support.
+* Check [pry-debugger](https://github.com/nixme/pry-debugger)'s CHANGELOG.

data/README.md

@@ -1,14 +1,13 @@
 # pry-byebug
+
 [![Version][VersionBadge]][VersionURL]
 [![Build][TravisBadge]][TravisURL]
 [![Inline docs][InchCIBadge]][InchCIURL]
 [![Gittip][GittipBadge]][GittipURL]
 [![Coverage][CoverageBadge]][CoverageURL]
 
-_Fast execution control in Pry_
-
-Adds **step**, **next**, **finish** and **continue** commands and
-**breakpoints** to [Pry][pry] using [byebug][byebug].
+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`.
@@ -27,12 +26,12 @@ puts 'Goodbye World' # Run 'next' in the console to move here.
 ## Requirements
 
 * Required: MRI 2.0.0 or higher. For debugging ruby 1.9.3 or older, use
-[pry-debugger][].
+  [pry-debugger][].
 
 * Recommended:
-  - MRI 2.1.7 or higher.
-  - MRI 2.2.3 or higher.
-
+  * MRI 2.1.8 or higher.
+  * MRI 2.2.4 or higher.
+  * MRI 2.3.0 or higher.
 
 ## Installation
 
@@ -46,11 +45,14 @@ in your Gemfile and run
 
     bundle install
 
-_Make sure you include the gem globally or inside the `:test` group if you plan
-to use it to debug your tests!_
+Make sure you include the gem globally or inside the `:test` group if you plan
+to use it to debug your tests!
 
+## Commands
 
-## Execution 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.
@@ -62,6 +64,11 @@ optional numeric argument to step multiple lines.
 
 **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.
 
@@ -133,8 +140,8 @@ Type `break --help` from a Pry session to see all available options.
 ## 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.
+  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.

data/lib/byebug/processors/pry_processor.rb

@@ -41,7 +41,15 @@ module Byebug
     # Set up a number of navigational commands to be performed by Byebug.
     #
     def perform(action, options = {})
-      return unless %i(next step finish up down frame).include?(action)
+      return unless %i(
+        backtrace
+        down
+        finish
+        frame
+        next
+        step
+        up
+      ).include?(action)
 
       send("perform_#{action}", options)
     end
@@ -109,6 +117,12 @@ module Byebug
       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)

data/lib/pry-byebug/base.rb

@@ -16,7 +16,7 @@ module PryByebug
   #
   def check_file_context(target, e = nil)
     e ||= 'Cannot find local context. Did you use `binding.pry`?'
-    fail(Pry::CommandError, e) unless file_context?(target)
+    raise(Pry::CommandError, e) unless file_context?(target)
   end
   module_function :check_file_context
 

data/lib/pry-byebug/commands.rb

@@ -1,3 +1,4 @@
+require 'pry-byebug/commands/backtrace'
 require 'pry-byebug/commands/next'
 require 'pry-byebug/commands/step'
 require 'pry-byebug/commands/continue'

data/lib/pry-byebug/commands/backtrace.rb

@@ -0,0 +1,29 @@
+require 'pry-byebug/helpers/navigation'
+
+module PryByebug
+  #
+  # Display the current stack
+  #
+  class BacktraceCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match 'backtrace'
+    group 'Byebug'
+
+    description 'Display the current stack.'
+
+    banner <<-BANNER
+      Usage: backtrace
+
+      Display the current stack.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :backtrace
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::BacktraceCommand)

data/lib/pry-byebug/commands/breakpoint.rb

@@ -124,7 +124,7 @@ module PryByebug
         end
         breakpoints.add_method(place, condition)
       else
-        fail(ArgumentError, 'Cannot identify arguments as breakpoint')
+        raise(ArgumentError, 'Cannot identify arguments as breakpoint')
       end
     end
   end

data/lib/pry-byebug/pry_ext.rb

@@ -1,7 +1,7 @@
 require 'byebug/processors/pry_processor'
 
 class << Pry
-  alias_method :start_without_pry_byebug, :start
+  alias start_without_pry_byebug start
 
   def start_with_pry_byebug(target = TOPLEVEL_BINDING, options = {})
     if target.is_a?(Binding) && PryByebug.file_context?(target)
@@ -12,5 +12,5 @@ class << Pry
     end
   end
 
-  alias_method :start, :start_with_pry_byebug
+  alias start start_with_pry_byebug
 end

data/lib/pry-byebug/pry_remote_ext.rb

@@ -10,7 +10,7 @@ module PryRemote
     # teardown the server right after Pry.start finishes.
     #
     def run
-      fail('Already running a pry-remote session!') if
+      raise('Already running a pry-remote session!') if
         PryByebug.current_remote_server
 
       PryByebug.current_remote_server = self
@@ -22,7 +22,7 @@ module PryRemote
     #
     # Override to reset our saved global current server session.
     #
-    alias_method :teardown_without_pry_byebug, :teardown
+    alias teardown_without_pry_byebug teardown
     def teardown_with_pry_byebug
       return if @torn
 
@@ -30,7 +30,7 @@ module PryRemote
       PryByebug.current_remote_server = nil
       @torn = true
     end
-    alias_method :teardown, :teardown_with_pry_byebug
+    alias teardown teardown_with_pry_byebug
   end
 end
 

data/lib/pry-byebug/version.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Main container module for Pry-Byebug functionality
 #
 module PryByebug
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'.freeze
 end

data/lib/pry/byebug/breakpoints.rb

@@ -60,7 +60,7 @@ class Pry
       #
       def add_file(file, line, expression = nil)
         real_file = (file != Pry.eval_path)
-        fail(ArgumentError, 'Invalid file!') if real_file && !File.exist?(file)
+        raise(ArgumentError, 'Invalid file!') if real_file && !File.exist?(file)
         validate_expression expression
 
         path = (real_file ? File.expand_path(file) : file)
@@ -89,7 +89,7 @@ class Pry
           ::Byebug::Breakpoint.remove(id) &&
           breakpoints.delete(find_by_id(id))
 
-        fail(ArgumentError, "No breakpoint ##{id}") unless deleted
+        raise(ArgumentError, "No breakpoint ##{id}") unless deleted
       end
 
       #
@@ -141,7 +141,7 @@ class Pry
 
       def find_by_id(id)
         breakpoint = find { |b| b.id == id }
-        fail(ArgumentError, "No breakpoint ##{id}!") unless breakpoint
+        raise(ArgumentError, "No breakpoint ##{id}!") unless breakpoint
         breakpoint
       end
 
@@ -157,7 +157,7 @@ class Pry
         valid = exp && (exp.empty? || !Pry::Code.complete_expression?(exp))
         return unless valid
 
-        fail("Invalid breakpoint conditional: #{expression}")
+        raise("Invalid breakpoint conditional: #{expression}")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-byebug
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - David Rodríguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2016-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 description: |-
   Combine 'pry' with 'byebug'. Adds 'step', 'next', 'finish',
       'continue' and 'break' commands to control execution.
@@ -57,6 +57,7 @@ files:
 - lib/pry-byebug/base.rb
 - lib/pry-byebug/cli.rb
 - lib/pry-byebug/commands.rb
+- lib/pry-byebug/commands/backtrace.rb
 - lib/pry-byebug/commands/breakpoint.rb
 - lib/pry-byebug/commands/continue.rb
 - lib/pry-byebug/commands/down.rb
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Fast debugging with Pry.