Want to step through code or continue / next?
|
1 |
gem install pry-nav |
And add these to ~/.pryrc
|
1 2 3 |
Pry.commands.alias_command 'c', 'continue' Pry.commands.alias_command 's', 'step' Pry.commands.alias_command 'n', 'next' |
Assuming you’ve halted the runtime at the point where you invoked the Pry REPL (see Pry – Part 4), you should have the Pry REPL.
A. The main ways of navigating the stack are the ls and cd commands.
ls shows you methods, constants and variables.
cd moves you into the new context (object or scope).
1. ls
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
ls -h Usage: ls [-m|-M|-p|-pM] [-q|-v] [-c|-i] [Object] ls [-g] [-l] ls shows you which methods, constants and variables are accessible to Pry. By default it shows you the local variables defined in the current shell, and any public methods or instance variables defined on the current object. The colours used are configurable using Pry.config.ls.*_color, and the separator is Pry.config.ls.separator. Pry.config.ls.ceiling is used to hide methods defined higher up in the inheritance chain, this is by default set to [Object, Module, Class] so that methods defined on all Objects are omitted. The -v flag can be used to ignore this setting and show all methods, while the -q can be used to set the ceiling much lower and show only methods defined on the object or its direct class. -m, --methods Show public methods defined on the Object (default) -M, --instance-methods Show methods defined in a Module or Class -p, --ppp Show public, protected (in yellow) and private (in green) methods -q, --quiet Show only methods defined on object.singleton_class and object.class -v, --verbose Show methods and constants on all super-classes (ignores Pry.config.ls.ceiling) -g, --globals Show global variables, including those builtin to Ruby (in cyan) -l, --locals Show hash of local vars, sorted by descending size -c, --constants Show constants, highlighting classes (in blue), and exceptions (in purple). Constants that are pending autoload? are also shown (in yellow) -i, --ivars Show instance variables (in blue) and class variables (in bright blue) -G, --grep Filter output by regular expression -h, --help Show this message. |
2. cd
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
> cd -h Usage: cd [OPTIONS] [--help] Move into new context (object or scope). As in UNIX shells use `cd ..` to go back, `cd /` to return to Pry top-level and `cd -` to toggle between last two scopes. Complex syntax (e.g `cd ../@x/y`) also supported. cd @x cd .. cd / cd - https://github.com/pry/pry/wiki/State-navigation#wiki-Changing_scope -h, --help Show this message. |
B. Apart from navigating state, there are two other commands that are very useful, show-method and show-doc.
1. show-method
This shows the source for a method or class.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
> show-method -h Usage: show-source [OPTIONS] [METH|CLASS] Aliases: $, show-method Show the source for a method or class. Tries instance methods first and then methods by default. show-source hi_method show-source hi_method show-source Pry#rep # source for Pry#rep method show-source Pry # for Pry class show-source Pry -a # for all Pry class definitions (all monkey patches) show-source Pry --super # for superclass of Pry (Object class) https://github.com/pry/pry/wiki/Source-browsing#wiki-Show_method -s, --super Select the 'super' method. Can be repeated to traverse the ancestors -l, --line-numbers Show line numbers -b, --base-one Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands) -a, --all Show all definitions and monkeypatches of the module/class -h, --help Show this message. |
2. show-doc shows the documentation by running the method comments through rdoc or yard
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
> show-method -h Usage: show-source [OPTIONS] [METH|CLASS] Aliases: $, show-method Show the source for a method or class. Tries instance methods first and then methods by default. show-source hi_method show-source hi_method show-source Pry#rep # source for Pry#rep method show-source Pry # for Pry class show-source Pry -a # for all Pry class definitions (all monkey patches) show-source Pry --super # for superclass of Pry (Object class) https://github.com/pry/pry/wiki/Source-browsing#wiki-Show_method -s, --super Select the 'super' method. Can be repeated to traverse the ancestors -l, --line-numbers Show line numbers -b, --base-one Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands) -a, --all Show all definitions and monkeypatches of the module/class -h, --help Show this message. |
You can inject a Pry REPL directly into somewhere that you want to debug.
|
1 |
pry -r ./stack.rb |
Here’s an example of runtime invocation:
test.rb
|
1 2 3 4 5 6 7 8 9 |
require 'pry' # set x to 10 x = 10 # start a REPL session binding.pry # program resumes here (after pry session) puts "program resumes here. Value of x is: #{x}." |
when run using ruby test.rb:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
$ ruby test.rb From: /Users/snowcrash/Developer/Ruby/Pry/test.rb @ line 6 : 1: require 'pry' 2: # set x to 10 3: x = 10 4: 5: # start a REPL session => 6: binding.pry 7: 8: # program resumes here (after pry session) 9: puts "program resumes here. Value of x is: #{x}." [1] pry(main)> |
So, code is shown around the REPL invocation line with a cursor showing where the runtime has stopped.
For the best source of Pry documentation: https://github.com/pry/pry/wiki
For more on Pry at runtime, see Pry – Part 5 – Pry at runtime.
So, assuming you’ve been through Part 1 and Part 2, you should have the Hello World gem installed.
We can cd directly into the gem’s source code and look at it directly:
|
1 |
gem-cd hello_world |
We can run commands directly by prefixing them with a period.
E.g. look at the file structure layout using tree:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
[32] pry(HelloWorld):1> .tree . ├── Manifest ├── README.rdoc ├── Rakefile ├── hello_world.gemspec └── lib └── hello_world.rb 1 directory, 5 files [33] pry(HelloWorld):1> .cd lib/ [34] pry(HelloWorld):1> .cat hello_world.rb module HelloWorld def self.say_hello puts 'hello world' end end[35] pry(HelloWorld):1> |
Note that you may need to install tree on MacOSX. E.g.
|
1 |
brew install tree |
You can cdd into other objects, e.g.
|
1 2 3 |
[35] pry(HelloWorld):1> cd 12 12 [36] pry(12):2> cd String [37] pry(String):3> |
The prompt updates to show you what object you’re in.
And:
|
1 |
nesting |
shows you the current nesting status, e.g.
|
1 2 3 4 5 6 7 8 |
[37] pry(String):3> nesting Nesting status: -- 0. main (Pry top level) 1. HelloWorld 2. 12 3. String [38] pry(String):3> |
Pop out using:
|
1 |
cd .. |
or jump to an index:
|
1 2 |
[38] pry(String):3> jump-to 0 [39] pry(main)> |
Input buffers:
Clear out:
|
1 2 3 4 5 6 |
[39] pry(main)> def helo(name) [39] pry(main)* show-input 1: def helo(name) [39] pry(main)* ! Input buffer cleared! [40] pry(main)> |
Amend:
Say you want to amend a line:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
[40] pry(main)> def hello(name) [40] pry(main)* "Hello, #{name} [40] pry(main)* show-input 1: def hello(name) 2: "Hello, #{name} [40] pry(main)* amend-line 2 "Hello, #{name}" 1: def hello(name) 2: "Hello, #{name}" [40] pry(main)* end => nil [41] pry(main)> hello "Me" => "Hello, Me" [42] pry(main)> |
More on using Pry.
Let’s play around with it a little using the Hello World gem (if you haven’t already installed it, use: gem install hello_world). Then, in pry:
|
1 |
require 'hello_world' |
Some useful commands:
1. ls:
ls shows you which methods, constants and variables are accessible to Pry. By
default it shows you the local variables defined in the current shell, and any
public methods or instance variables defined on the current object.
So we can list, class methods:
|
1 2 |
ls HelloWorld -M [] |
i.e. nothing.
Instance methods:
|
1 2 |
ls HelloWorld -m HelloWorld.methods: say_hello |
i.e. this method is available.
And this is the default, i.e.
|
1 2 |
ls HelloWorld HelloWorld.methods: say_hello |
e.g.:
|
1 2 3 |
HelloWorld.say_hello hello world => nil |
2. cd
cd moves you into a new context (object or scope). As in UNIX shells use cd .. to go
back, cd / to return to Pry top-level and cd – to toggle between last two
scopes.
So,
|
1 |
cd HelloWorld |
and now:
|
1 2 3 4 |
pry(HelloWorld):1> self => HelloWorld pry(HelloWorld):1> ls -m HelloWorld.methods: say_hello |
So, we can invoke it like this:
|
1 2 3 |
pry(HelloWorld):1> say_hello hello world => nil |
However, if we’re only interested in the output value and not the return value then we can use a semi-colon:
|
1 2 3 |
pry(HelloWorld):1> say_hello; hello world pry(HelloWorld):1> |
|
1 2 3 4 |
[23] pry(HelloWorld):1> gem-cd hello_world /Users/snowcrash/.rvm/gems/ruby-1.9.3-p327/gems/hello_world-0.0.2 [24] pry(HelloWorld):1> .pwd /Users/snowcrash/.rvm/gems/ruby-1.9.3-p327/gems/hello_world-0.0.2 |
More in Pry – Part 3.
Using ruby -rdebug, I put a breakpoint in at a line which used a bunch of other libraries.
But when I tried to output a variable using “p” the debugger said it was in a different file.
The consensus with -rdebug is that it’s pretty useless and unmaintained. Better is to use Pry.
Here’s the output I got:
debug.rb:130:in eval':undefined local variable or method query’ for #
A great little document that covers debugging using Ruby.
Amazingly, this was put together in 2005 at IBM but mostly still relevant.
For example:
ruby -rdebug myscript.rb
then,b
: put break-point
and n(ext) or s(tep) and c(ontinue)
p(uts) for display
http://www.ibm.com/developerworks/opensource/tutorials/os-distruby/os-distruby-pdf.pdf