pry 0.9.12.6-i386-mingw32 → 0.10.0-i386-mingw32
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +702 -0
- data/LICENSE +2 -2
- data/{README.markdown → README.md} +37 -31
- data/lib/pry.rb +38 -151
- data/lib/pry/cli.rb +35 -17
- data/lib/pry/code.rb +19 -63
- data/lib/pry/code/code_file.rb +103 -0
- data/lib/pry/code/code_range.rb +2 -1
- data/lib/pry/code/loc.rb +2 -2
- data/lib/pry/code_object.rb +40 -21
- data/lib/pry/color_printer.rb +55 -0
- data/lib/pry/command.rb +12 -9
- data/lib/pry/command_set.rb +81 -38
- data/lib/pry/commands.rb +1 -1
- data/lib/pry/commands/amend_line.rb +2 -2
- data/lib/pry/commands/bang.rb +1 -1
- data/lib/pry/commands/cat.rb +11 -2
- data/lib/pry/commands/cat/exception_formatter.rb +6 -7
- data/lib/pry/commands/cat/file_formatter.rb +15 -32
- data/lib/pry/commands/cat/input_expression_formatter.rb +1 -1
- data/lib/pry/commands/cd.rb +14 -3
- data/lib/pry/commands/change_inspector.rb +27 -0
- data/lib/pry/commands/change_prompt.rb +26 -0
- data/lib/pry/commands/code_collector.rb +4 -4
- data/lib/pry/commands/easter_eggs.rb +3 -3
- data/lib/pry/commands/edit.rb +10 -22
- data/lib/pry/commands/edit/exception_patcher.rb +2 -2
- data/lib/pry/commands/edit/file_and_line_locator.rb +0 -2
- data/lib/pry/commands/exit_program.rb +0 -1
- data/lib/pry/commands/find_method.rb +16 -22
- data/lib/pry/commands/gem_install.rb +5 -2
- data/lib/pry/commands/gem_open.rb +1 -1
- data/lib/pry/commands/gist.rb +10 -11
- data/lib/pry/commands/help.rb +14 -14
- data/lib/pry/commands/hist.rb +27 -8
- data/lib/pry/commands/install_command.rb +14 -12
- data/lib/pry/commands/list_inspectors.rb +35 -0
- data/lib/pry/commands/list_prompts.rb +35 -0
- data/lib/pry/commands/ls.rb +72 -296
- data/lib/pry/commands/ls/constants.rb +47 -0
- data/lib/pry/commands/ls/formatter.rb +49 -0
- data/lib/pry/commands/ls/globals.rb +48 -0
- data/lib/pry/commands/ls/grep.rb +21 -0
- data/lib/pry/commands/ls/instance_vars.rb +39 -0
- data/lib/pry/commands/ls/interrogatable.rb +18 -0
- data/lib/pry/commands/ls/jruby_hacks.rb +49 -0
- data/lib/pry/commands/ls/local_names.rb +35 -0
- data/lib/pry/commands/ls/local_vars.rb +39 -0
- data/lib/pry/commands/ls/ls_entity.rb +70 -0
- data/lib/pry/commands/ls/methods.rb +57 -0
- data/lib/pry/commands/ls/methods_helper.rb +46 -0
- data/lib/pry/commands/ls/self_methods.rb +32 -0
- data/lib/pry/commands/play.rb +44 -10
- data/lib/pry/commands/pry_backtrace.rb +1 -2
- data/lib/pry/commands/raise_up.rb +2 -2
- data/lib/pry/commands/reload_code.rb +16 -19
- data/lib/pry/commands/ri.rb +7 -3
- data/lib/pry/commands/shell_command.rb +18 -13
- data/lib/pry/commands/shell_mode.rb +2 -4
- data/lib/pry/commands/show_doc.rb +5 -0
- data/lib/pry/commands/show_info.rb +8 -13
- data/lib/pry/commands/show_source.rb +15 -3
- data/lib/pry/commands/simple_prompt.rb +1 -1
- data/lib/pry/commands/toggle_color.rb +8 -4
- data/lib/pry/commands/watch_expression.rb +105 -0
- data/lib/pry/commands/watch_expression/expression.rb +38 -0
- data/lib/pry/commands/whereami.rb +18 -10
- data/lib/pry/commands/wtf.rb +3 -3
- data/lib/pry/config.rb +20 -254
- data/lib/pry/config/behavior.rb +139 -0
- data/lib/pry/config/convenience.rb +26 -0
- data/lib/pry/config/default.rb +165 -0
- data/lib/pry/core_extensions.rb +31 -21
- data/lib/pry/editor.rb +107 -103
- data/lib/pry/exceptions.rb +77 -0
- data/lib/pry/helpers/base_helpers.rb +22 -109
- data/lib/pry/helpers/command_helpers.rb +10 -8
- data/lib/pry/helpers/documentation_helpers.rb +1 -2
- data/lib/pry/helpers/text.rb +4 -5
- data/lib/pry/history.rb +46 -45
- data/lib/pry/history_array.rb +6 -1
- data/lib/pry/hooks.rb +9 -29
- data/lib/pry/indent.rb +6 -6
- data/lib/pry/input_completer.rb +242 -0
- data/lib/pry/input_lock.rb +132 -0
- data/lib/pry/inspector.rb +27 -0
- data/lib/pry/last_exception.rb +61 -0
- data/lib/pry/method.rb +82 -87
- data/lib/pry/{commands/edit/method_patcher.rb → method/patcher.rb} +41 -38
- data/lib/pry/module_candidate.rb +4 -14
- data/lib/pry/object_path.rb +82 -0
- data/lib/pry/output.rb +50 -0
- data/lib/pry/pager.rb +193 -48
- data/lib/pry/plugins.rb +1 -1
- data/lib/pry/prompt.rb +26 -0
- data/lib/pry/pry_class.rb +149 -230
- data/lib/pry/pry_instance.rb +302 -413
- data/lib/pry/rbx_path.rb +1 -1
- data/lib/pry/repl.rb +202 -0
- data/lib/pry/repl_file_loader.rb +20 -26
- data/lib/pry/rubygem.rb +13 -5
- data/lib/pry/terminal.rb +2 -1
- data/lib/pry/test/helper.rb +26 -41
- data/lib/pry/version.rb +1 -1
- data/lib/pry/wrapped_module.rb +45 -59
- metadata +62 -225
- data/.document +0 -2
- data/.gitignore +0 -16
- data/.travis.yml +0 -25
- data/.yardopts +0 -1
- data/CHANGELOG +0 -534
- data/CONTRIBUTORS +0 -55
- data/Gemfile +0 -12
- data/Rakefile +0 -140
- data/TODO +0 -117
- data/lib/pry/completion.rb +0 -321
- data/lib/pry/custom_completions.rb +0 -6
- data/lib/pry/rbx_method.rb +0 -13
- data/man/pry.1 +0 -195
- data/man/pry.1.html +0 -204
- data/man/pry.1.ronn +0 -141
- data/pry.gemspec +0 -29
- data/spec/Procfile +0 -3
- data/spec/cli_spec.rb +0 -78
- data/spec/code_object_spec.rb +0 -277
- data/spec/code_spec.rb +0 -219
- data/spec/command_helpers_spec.rb +0 -29
- data/spec/command_integration_spec.rb +0 -644
- data/spec/command_set_spec.rb +0 -627
- data/spec/command_spec.rb +0 -821
- data/spec/commands/amend_line_spec.rb +0 -247
- data/spec/commands/bang_spec.rb +0 -19
- data/spec/commands/cat_spec.rb +0 -164
- data/spec/commands/cd_spec.rb +0 -250
- data/spec/commands/disable_pry_spec.rb +0 -25
- data/spec/commands/edit_spec.rb +0 -727
- data/spec/commands/exit_all_spec.rb +0 -34
- data/spec/commands/exit_program_spec.rb +0 -19
- data/spec/commands/exit_spec.rb +0 -34
- data/spec/commands/find_method_spec.rb +0 -70
- data/spec/commands/gem_list_spec.rb +0 -26
- data/spec/commands/gist_spec.rb +0 -79
- data/spec/commands/help_spec.rb +0 -56
- data/spec/commands/hist_spec.rb +0 -181
- data/spec/commands/jump_to_spec.rb +0 -15
- data/spec/commands/ls_spec.rb +0 -181
- data/spec/commands/play_spec.rb +0 -140
- data/spec/commands/raise_up_spec.rb +0 -56
- data/spec/commands/save_file_spec.rb +0 -177
- data/spec/commands/show_doc_spec.rb +0 -510
- data/spec/commands/show_input_spec.rb +0 -17
- data/spec/commands/show_source_spec.rb +0 -782
- data/spec/commands/whereami_spec.rb +0 -203
- data/spec/completion_spec.rb +0 -241
- data/spec/control_d_handler_spec.rb +0 -58
- data/spec/documentation_helper_spec.rb +0 -73
- data/spec/editor_spec.rb +0 -79
- data/spec/exception_whitelist_spec.rb +0 -21
- data/spec/fixtures/candidate_helper1.rb +0 -11
- data/spec/fixtures/candidate_helper2.rb +0 -8
- data/spec/fixtures/example.erb +0 -5
- data/spec/fixtures/example_nesting.rb +0 -33
- data/spec/fixtures/show_source_doc_examples.rb +0 -15
- data/spec/fixtures/testrc +0 -2
- data/spec/fixtures/testrcbad +0 -2
- data/spec/fixtures/whereami_helper.rb +0 -6
- data/spec/helper.rb +0 -34
- data/spec/helpers/bacon.rb +0 -86
- data/spec/helpers/mock_pry.rb +0 -43
- data/spec/helpers/table_spec.rb +0 -105
- data/spec/history_array_spec.rb +0 -67
- data/spec/hooks_spec.rb +0 -522
- data/spec/indent_spec.rb +0 -301
- data/spec/input_stack_spec.rb +0 -90
- data/spec/method_spec.rb +0 -482
- data/spec/prompt_spec.rb +0 -60
- data/spec/pry_defaults_spec.rb +0 -419
- data/spec/pry_history_spec.rb +0 -99
- data/spec/pry_output_spec.rb +0 -95
- data/spec/pry_spec.rb +0 -515
- data/spec/run_command_spec.rb +0 -25
- data/spec/sticky_locals_spec.rb +0 -157
- data/spec/syntax_checking_spec.rb +0 -81
- data/spec/wrapped_module_spec.rb +0 -261
- data/wiki/Customizing-pry.md +0 -397
- data/wiki/Home.md +0 -4
data/wiki/Customizing-pry.md
DELETED
@@ -1,397 +0,0 @@
|
|
1
|
-
Customizing Pry
|
2
|
-
---------------
|
3
|
-
|
4
|
-
Pry supports customization of the input, the output, the commands,
|
5
|
-
the hooks, the prompt, and the 'print' object (the "P" in REPL).
|
6
|
-
|
7
|
-
Global customization, which applies to all Pry sessions, is done
|
8
|
-
through invoking class accessors on the `Pry` class, the accessors
|
9
|
-
are:
|
10
|
-
|
11
|
-
* `Pry.input=`
|
12
|
-
* `Pry.output=`
|
13
|
-
* `Pry.commands=`
|
14
|
-
* `Pry.hooks=`
|
15
|
-
* `Pry.prompt=`
|
16
|
-
* `Pry.print=`
|
17
|
-
|
18
|
-
Local customization (applied to a single Pry session) is done by
|
19
|
-
passing config hash options to `Pry.start()` or to `Pry.new()`; also the
|
20
|
-
same accessors as described above for the `Pry` class exist for a
|
21
|
-
Pry instance so that customization can occur at runtime.
|
22
|
-
|
23
|
-
### Input
|
24
|
-
|
25
|
-
For input Pry accepts any object that implements the `readline` method. This
|
26
|
-
includes `IO` objects, `StringIO`, `Readline`, `File` and custom objects. Pry
|
27
|
-
initially defaults to using `Readline` for input.
|
28
|
-
|
29
|
-
#### Example: Setting global input
|
30
|
-
|
31
|
-
Setting Pry's global input causes all subsequent Pry instances to use
|
32
|
-
this input by default:
|
33
|
-
|
34
|
-
Pry.input = StringIO.new("@x = 10\nexit")
|
35
|
-
Object.pry
|
36
|
-
|
37
|
-
Object.instance_variable_get(:@x) #=> 10
|
38
|
-
|
39
|
-
The above will execute the code in the `StringIO`
|
40
|
-
non-interactively. It gets all the input it needs from the `StringIO`
|
41
|
-
and then exits the Pry session. Note it is important to end the
|
42
|
-
session with 'exit' if you are running non-interactively or the Pry
|
43
|
-
session will hang as it loops indefinitely awaiting new input.
|
44
|
-
|
45
|
-
#### Example: Setting input for a specific session
|
46
|
-
|
47
|
-
The settings for a specific session override the global settings
|
48
|
-
(discussed above). There are two ways to set input for a specific pry session: At the
|
49
|
-
point the session is started, or within the session itself (at runtime):
|
50
|
-
|
51
|
-
##### At session start
|
52
|
-
|
53
|
-
Pry.start(Object, :input => StringIO.new("@x = 10\nexit"))
|
54
|
-
Object.instance_variable_get(:@x) #=> 10
|
55
|
-
|
56
|
-
##### At runtime
|
57
|
-
|
58
|
-
If you want to set the input object within the session itself you use
|
59
|
-
the special `_pry_` local variable which represents the Pry instance
|
60
|
-
managing the current session; inside the session we type:
|
61
|
-
|
62
|
-
_pry_.input = StringIO.new("@x = 10\nexit")
|
63
|
-
|
64
|
-
Note we can also set the input object for the parent Pry session (if
|
65
|
-
the current session is nested) like so:
|
66
|
-
|
67
|
-
_pry_.parent.input = StringIO.new("@x = 10\nexit")
|
68
|
-
|
69
|
-
### Output
|
70
|
-
|
71
|
-
For output Pry accepts any object that implements the `puts` method. This
|
72
|
-
includes `IO` objects, `StringIO`, `File` and custom objects. Pry initially
|
73
|
-
defaults to using `$stdout` for output.
|
74
|
-
|
75
|
-
#### Example: Setting global output
|
76
|
-
|
77
|
-
Setting Pry's global output causes all subsequent Pry instances to use
|
78
|
-
this output by default:
|
79
|
-
|
80
|
-
Pry.output = StringIO.new
|
81
|
-
|
82
|
-
#### Example: Setting output for a specific session
|
83
|
-
|
84
|
-
As per Input, given above, we set the local output as follows:
|
85
|
-
|
86
|
-
##### At session start
|
87
|
-
|
88
|
-
Pry.start(Object, :output => StringIO.new("@x = 10\nexit"))
|
89
|
-
|
90
|
-
##### At runtime
|
91
|
-
|
92
|
-
_pry_.output = StringIO.new
|
93
|
-
|
94
|
-
### Commands
|
95
|
-
|
96
|
-
Pry commands are not methods; they are commands that are intercepted
|
97
|
-
and executed before a Ruby eval takes place. Pry comes with a default
|
98
|
-
command set (`Pry::Commands`), but these commands can be augmented or overriden by
|
99
|
-
user-specified ones.
|
100
|
-
|
101
|
-
The Pry command API is quite sophisticated supporting features such as:
|
102
|
-
command set inheritance, importing of specific commands from another
|
103
|
-
command set, deletion of commands, calling of commands within other
|
104
|
-
commands, and so on.
|
105
|
-
|
106
|
-
A valid Pry command object must inherit from
|
107
|
-
`Pry::CommandBase` (or one of its subclasses) and use the special command API:
|
108
|
-
|
109
|
-
#### Example: Defining a command object and setting it globally
|
110
|
-
|
111
|
-
class MyCommands < Pry::CommandBase
|
112
|
-
command "greet", "Greet the user." do |name, age|
|
113
|
-
output.puts "Hello #{name.capitalize}, how does it feel being #{age}?"
|
114
|
-
end
|
115
|
-
end
|
116
|
-
|
117
|
-
Pry.commands = MyCommands
|
118
|
-
|
119
|
-
Then inside a pry session:
|
120
|
-
|
121
|
-
pry(main)> greet john 9
|
122
|
-
Hello John, how does it feel being 9?
|
123
|
-
=> nil
|
124
|
-
|
125
|
-
#### Example: Using a command object in a specific session
|
126
|
-
|
127
|
-
As in the case of `input` and `output`:
|
128
|
-
|
129
|
-
##### At session start:
|
130
|
-
|
131
|
-
Pry.start(self, :commands => MyCommands)
|
132
|
-
|
133
|
-
##### At runtime:
|
134
|
-
|
135
|
-
_pry_.commands = MyCommands
|
136
|
-
|
137
|
-
#### The command API
|
138
|
-
|
139
|
-
The command API is defined by the `Pry::CommandBase` class (hence why
|
140
|
-
all commands must inherit from it or a subclass). The API works as follows:
|
141
|
-
|
142
|
-
##### `command` method
|
143
|
-
|
144
|
-
The `command` method defines a new command, its parameter is the
|
145
|
-
name of the command and an optional second parameter is a description of
|
146
|
-
the command.
|
147
|
-
|
148
|
-
The associated block defines the action to be performed. The number of
|
149
|
-
parameters in the block determine the number of parameters that will
|
150
|
-
be sent to the command (from the Pry prompt) when it is invoked. Note
|
151
|
-
that all parameters that are received will be strings; if a parameter
|
152
|
-
is not received it will be set to `nil`.
|
153
|
-
|
154
|
-
command "hello" do |x, y, z|
|
155
|
-
puts "hello there #{x}, #{y}, and #{z}!"
|
156
|
-
end
|
157
|
-
|
158
|
-
Command aliases can also be defined - simply use an array of strings
|
159
|
-
for the command name - all these strings will be valid names for the
|
160
|
-
command.
|
161
|
-
|
162
|
-
command ["ls", "dir"], "show a list of local vars" do
|
163
|
-
output.puts target.eval("local_variables")
|
164
|
-
end
|
165
|
-
|
166
|
-
##### `delete` method
|
167
|
-
|
168
|
-
The `delete` method deletes a command or a group of commands. It
|
169
|
-
can be useful when inheriting from another command set and you wish
|
170
|
-
to keep only a portion of the inherited commands.
|
171
|
-
|
172
|
-
class MyCommands < Pry::Commands
|
173
|
-
delete "show_method", "show_imethod"
|
174
|
-
end
|
175
|
-
|
176
|
-
##### `import_from` method
|
177
|
-
|
178
|
-
The `import_from` method enables you to specifically select which
|
179
|
-
commands will be copied across from another command set, useful when
|
180
|
-
you only want a small number of commands and so inheriting and then
|
181
|
-
deleting would be inefficient. The first parameter to `import_from`
|
182
|
-
is the class to import from and the other paramters are the names of
|
183
|
-
the commands to import:
|
184
|
-
|
185
|
-
class MyCommands < Pry::CommandBase
|
186
|
-
import_from Pry::Commands, "ls", "status", "!"
|
187
|
-
end
|
188
|
-
|
189
|
-
##### `run` method
|
190
|
-
|
191
|
-
The `run` command invokes one command from within another.
|
192
|
-
The first parameter is the name of the command to invoke
|
193
|
-
and the remainder of the parameters will be passed on to the command
|
194
|
-
being invoked:
|
195
|
-
|
196
|
-
class MyCommands < Pry::Commands
|
197
|
-
command "ls_with_hello" do
|
198
|
-
output.puts "hello!"
|
199
|
-
run "ls"
|
200
|
-
end
|
201
|
-
end
|
202
|
-
|
203
|
-
##### `alias_command` method
|
204
|
-
|
205
|
-
The `alias_command` method creates an alias of a command. The first
|
206
|
-
parameter is the name of the new command, the second parameter is the
|
207
|
-
name of the command to be aliased; an optional third parameter is the
|
208
|
-
description to use for the alias. If no description is provided then
|
209
|
-
the description of the original command is used.
|
210
|
-
|
211
|
-
class MyCommands < Pry::Commands
|
212
|
-
alias_command "help2", "help", "An alias of help"
|
213
|
-
end
|
214
|
-
|
215
|
-
##### `desc` method
|
216
|
-
|
217
|
-
The `desc` method is used to give a command a new description. The
|
218
|
-
first parameter is the name of the command, the second parameter is
|
219
|
-
the description.
|
220
|
-
|
221
|
-
class MyCommands < Pry::Commands
|
222
|
-
desc "ls", "a new description"
|
223
|
-
end
|
224
|
-
|
225
|
-
#### Utility methods for commands
|
226
|
-
|
227
|
-
All commands can access the special `output` and `target` methods. The
|
228
|
-
`output` method returns the `output` object for the active pry session.
|
229
|
-
Ensuring that your commands invoke `puts` on this rather than using
|
230
|
-
the top-level `puts` will ensure that all your session output goes to
|
231
|
-
the same place.
|
232
|
-
|
233
|
-
The `target` method returns the `Binding` object the Pry session is currently
|
234
|
-
active on - useful when your commands need to manipulate or examine
|
235
|
-
the state of the object. E.g, the "ls" command is implemented as follows
|
236
|
-
|
237
|
-
command "ls" do
|
238
|
-
output.puts target.eval("local_variables + instance_variables").inspect
|
239
|
-
end
|
240
|
-
|
241
|
-
#### The opts hash
|
242
|
-
|
243
|
-
These are miscellaneous variables that may be useful to your commands:
|
244
|
-
|
245
|
-
* `opts[:val]` - The line of input that invoked the command.
|
246
|
-
* `opts[:eval_string]` - The cumulative lines of input for multi-line input.
|
247
|
-
* `opts[:nesting]` - Lowlevel session nesting information.
|
248
|
-
* `opts[:commands]` - Lowlevel data of all Pry commands.
|
249
|
-
|
250
|
-
(see commands.rb for examples of how some of these options are used)
|
251
|
-
|
252
|
-
#### The `help` command
|
253
|
-
|
254
|
-
The `Pry::CommandBase` class automatically defines a `help` command
|
255
|
-
for you. Typing `help` in a Pry session will show a list of commands
|
256
|
-
to the user followed by their descriptions. Passing a parameter to
|
257
|
-
`help` with the command name will just return the description of that
|
258
|
-
specific command. If a description is left out it will automatically
|
259
|
-
be given the description "No description.".
|
260
|
-
|
261
|
-
If the description is explicitly set to `""` then this command will
|
262
|
-
not be displayed in `help`.
|
263
|
-
|
264
|
-
### Hooks
|
265
|
-
|
266
|
-
Currently Pry supports just two hooks: `before_session` and
|
267
|
-
`after_session`. These hooks are invoked before a Pry session starts
|
268
|
-
and after a session ends respectively. The default hooks used are
|
269
|
-
stored in the `Pry::DEFAULT_HOOKS` and just output the text `"Beginning
|
270
|
-
Pry session for <obj>"` and `"Ending Pry session for <obj>"`.
|
271
|
-
|
272
|
-
#### Example: Setting global hooks
|
273
|
-
|
274
|
-
All subsequent Pry instances will use these hooks as default:
|
275
|
-
|
276
|
-
Pry.hooks = {
|
277
|
-
:before_session => proc { |out, obj| out.puts "Opened #{obj}" },
|
278
|
-
:after_session => proc { |out, obj| out.puts "Closed #{obj}" }
|
279
|
-
}
|
280
|
-
|
281
|
-
5.pry
|
282
|
-
|
283
|
-
Inside the session:
|
284
|
-
|
285
|
-
Opened 5
|
286
|
-
pry(5)> exit
|
287
|
-
Closed 5
|
288
|
-
|
289
|
-
Note that the `before_session` and `after_session` procs receive the
|
290
|
-
current session's output object and session receiver as parameters.
|
291
|
-
|
292
|
-
#### Example: Setting hooks for a specific session
|
293
|
-
|
294
|
-
Like all the other customization options, the global default (as
|
295
|
-
explained above) can be overriden for a specific session, either at
|
296
|
-
session start or during runtime.
|
297
|
-
|
298
|
-
##### At session start
|
299
|
-
|
300
|
-
Pry.start(self, :hooks => { :before_session => proc { puts "hello world!" },
|
301
|
-
:after_session => proc { puts "goodbye world!" }
|
302
|
-
})
|
303
|
-
|
304
|
-
##### At runtime
|
305
|
-
|
306
|
-
_pry_.hooks = { :before_session => proc { puts "puts "hello world!" } }
|
307
|
-
|
308
|
-
### Prompts
|
309
|
-
|
310
|
-
The Pry prompt is used by `Readline` and other input objects that
|
311
|
-
accept a prompt. Pry can accept two prompt-types for every prompt; the
|
312
|
-
'main prompt' and the 'wait prompt'. The main prompt is always used
|
313
|
-
for the first line of input; the wait prompt is used in multi-line
|
314
|
-
input to indicate that the current expression is incomplete and more lines of
|
315
|
-
input are required. The default Prompt used by Pry is stored in the
|
316
|
-
`Pry::DEFAULT_PROMPT` constant.
|
317
|
-
|
318
|
-
A valid Pry prompt is either a single `Proc` object or a two element
|
319
|
-
array of `Proc` objects. When an array is used the first element is
|
320
|
-
the 'main prompt' and the last element is the 'wait prompt'. When a
|
321
|
-
single `Proc` object is used it will be used for both the main prompt
|
322
|
-
and the wait prompt.
|
323
|
-
|
324
|
-
#### Example: Setting global prompt
|
325
|
-
|
326
|
-
The prompt `Proc` objects are passed the receiver of the Pry session
|
327
|
-
and the nesting level of that session as parameters (they can simply
|
328
|
-
ignore these if they do not need them).
|
329
|
-
|
330
|
-
# Using one proc for both main and wait prompts
|
331
|
-
Pry.prompt = proc { |obj, nest_level| "#{obj}:#{nest_level}> " }
|
332
|
-
|
333
|
-
# Alternatively, provide two procs; one for main and one for wait
|
334
|
-
Pry.prompt = [ proc { "ENTER INPUT> " }, proc { "MORE INPUT REQUIRED!* " }]
|
335
|
-
|
336
|
-
#### Example: Setting the prompt for a specific session
|
337
|
-
|
338
|
-
##### At session start
|
339
|
-
|
340
|
-
Pry.start(self, :prompt => [proc { "ENTER INPUT> " },
|
341
|
-
proc { "MORE INPUT REQUIRED!* " }])
|
342
|
-
|
343
|
-
##### At runtime
|
344
|
-
|
345
|
-
_pry_.prompt = [proc { "ENTER INPUT> " },
|
346
|
-
proc { "MORE INPUT REQUIRED!* " }]
|
347
|
-
|
348
|
-
### Print
|
349
|
-
|
350
|
-
The Print phase of Pry's READ-EVAL-PRINT-LOOP can be customized. The
|
351
|
-
default action is stored in the `Pry::DEFAULT_PRINT` constant and it
|
352
|
-
simply outputs the value of the current expression preceded by a `=>` (or the first
|
353
|
-
line of the backtrace if the value is an `Exception` object.)
|
354
|
-
|
355
|
-
The print object should be a `Proc` and the parameters passed to the
|
356
|
-
`Proc` are the output object for the current session and the 'value'
|
357
|
-
returned by the current expression.
|
358
|
-
|
359
|
-
#### Example: Setting global print object
|
360
|
-
|
361
|
-
Let's define a print object that displays the full backtrace of any
|
362
|
-
exception and precedes the output of a value by the text `"Output is: "`:
|
363
|
-
|
364
|
-
Pry.print = proc do |output, value|
|
365
|
-
case value
|
366
|
-
when Exception
|
367
|
-
output.puts value.backtrace
|
368
|
-
else
|
369
|
-
output.puts "Output is: #{value}"
|
370
|
-
end
|
371
|
-
end
|
372
|
-
|
373
|
-
#### Example: Setting the print object for a specific session
|
374
|
-
|
375
|
-
##### At session start
|
376
|
-
|
377
|
-
Pry.start(self, :print => proc do |output, value|
|
378
|
-
case value
|
379
|
-
when Exception
|
380
|
-
output.puts value.backtrace
|
381
|
-
else
|
382
|
-
output.puts "Output is: #{value.inspect}"
|
383
|
-
end
|
384
|
-
end)
|
385
|
-
|
386
|
-
##### At runtime
|
387
|
-
|
388
|
-
_pry_.print = proc do |output, value|
|
389
|
-
case value
|
390
|
-
when Exception
|
391
|
-
output.puts value.backtrace
|
392
|
-
else
|
393
|
-
output.puts "Output is: #{value.inspect}"
|
394
|
-
end
|
395
|
-
end
|
396
|
-
|
397
|
-
[Back to front page of documentation](http://rdoc.info/github/banister/pry/master/file/README.markdown)
|
data/wiki/Home.md
DELETED