Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 82 lines (59 sloc) 2.627 kb
1f7321a @nixme Clearer message to switch to pry-debugger
authored
1 ### Using MRI 1.9.2+? Switch to [**pry-debugger**][pry-debugger].
f0e1745 @nixme Version 0.2.4
authored
2 ### Using MRI 2+? Switch to [**pry-byebug**][pry-byebug].
16be991 @nixme Point people to pry-debugger
authored
3
1f7321a @nixme Clearer message to switch to pry-debugger
authored
4 Same features as **pry-nav** but with faster tracing, breakpoints, and more.
5
6 * * *
16be991 @nixme Point people to pry-debugger
authored
7
d638f34 @nixme Add a Bitdeli badge to README
authored
8 pry-nav [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/nixme/pry-nav/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
0488937 @nixme Initial attempt at basic 'step' and 'next' commands
authored
9 =======
10
11 _Simple execution control in Pry_
12
c72e0ff @nixme Improve README
authored
13 Teaches [Pry][pry] about **step**, **next**, and **continue** to create a simple
14 debugger.
0488937 @nixme Initial attempt at basic 'step' and 'next' commands
authored
15
c72e0ff @nixme Improve README
authored
16 To use, invoke pry normally:
17
18 ```ruby
19 def some_method
20 binding.pry # Execution will stop here.
21 puts 'Hello World' # Run 'step' or 'next' in the console to move here.
22 end
23 ```
24
25 **pry-nav** is not yet thread-safe, so only use in single-threaded environments.
26
4e81c50 @nixme Update pry-remote support for pry-remote 0.1.1. #10
authored
27 Rudimentary support for [pry-remote][pry-remote] (>= 0.1.1) is also included.
28 Ensure pry-remote is loaded or required before pry-nav. For example, in a
29 Gemfile:
dd47eff @nixme Rudimentary support for pry-remote
authored
30
31 ```ruby
32 gem 'pry'
33 gem 'pry-remote'
34 gem 'pry-nav'
35 ```
36
e9870e5 @nixme README: aliases and require gotchas
authored
37 Stepping through code often? Add the following shortcuts to `~/.pryrc`:
38
39 ```ruby
40 Pry.commands.alias_command 'c', 'continue'
41 Pry.commands.alias_command 's', 'step'
42 Pry.commands.alias_command 'n', 'next'
43 ```
44
c72e0ff @nixme Improve README
authored
45 Debugging functionality is implemented through
46 [`set_trace_func`][set_trace_func], which imposes a large performance
47 penalty. **pry-nav** traces only when necessary, but due to a workaround for a
48 [bug in 1.9.2][ruby-bug], the console will feel sluggish. Use 1.9.3 for best
49 results and almost no performance penalty.
0488937 @nixme Initial attempt at basic 'step' and 'next' commands
authored
50
51
d3cc907 @nixme Version 0.2.1
authored
52 ## Contributors
53
54 * Gopal Patel (@nixme)
55 * John Mair (@banister)
56 * Conrad Irwin (@ConradIrwin)
0eaea35 @nixme Version 0.2.3
authored
57 * Benjamin R. Haskell (@benizi)
f0e1745 @nixme Version 0.2.4
authored
58 * Jason R. Clark (@jasonrclark)
ac02f25 @nixme Version 0.0.2
authored
59
60 Patches and bug reports are welcome. Just send a [pull request][pullrequests] or
61 file an [issue][issues]. [Project changelog][changelog].
62
63
0488937 @nixme Initial attempt at basic 'step' and 'next' commands
authored
64 ## Acknowledgments
65
dd47eff @nixme Rudimentary support for pry-remote
authored
66 - Ruby stdlib's [debug.rb][debug.rb]
0488937 @nixme Initial attempt at basic 'step' and 'next' commands
authored
67 - [@Mon-Ouie][Mon-Ouie]'s [pry_debug][pry_debug]
68
69
16be991 @nixme Point people to pry-debugger
authored
70 [pry-debugger]: https://github.com/nixme/pry-debugger
c72e0ff @nixme Improve README
authored
71 [pry]: http://pry.github.com
72 [pry-remote]: https://github.com/Mon-Ouie/pry-remote
73 [set_trace_func]: http://www.ruby-doc.org/core-1.9.3/Kernel.html#method-i-set_trace_func
74 [ruby-bug]: http://redmine.ruby-lang.org/issues/3921
75 [pullrequests]: https://github.com/nixme/pry-nav/pulls
76 [issues]: https://github.com/nixme/pry-nav/issues
77 [changelog]: https://github.com/nixme/pry-nav/blob/master/CHANGELOG.md
78 [debug.rb]: https://github.com/ruby/ruby/blob/trunk/lib/debug.rb
79 [Mon-Ouie]: https://github.com/Mon-Ouie
80 [pry_debug]: https://github.com/Mon-Ouie/pry_debug
f0e1745 @nixme Version 0.2.4
authored
81 [pry-byebug]: https://github.com/deivid-rodriguez/pry-byebug
Something went wrong with that request. Please try again.