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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
class Pry
# Prompt represents the Pry prompt, which can be used with Readline-like
# libraries. It defines a few default prompts (default prompt, simple prompt,
# etc) and also provides an API to add custom prompts.
#
# @example
# Pry::Prompt.add(
# :ipython,
# 'IPython-like prompt', [':', '...:']
# ) do |_context, _nesting, _pry_, sep|
# sep == ':' ? "In [#{_pry_.input_ring.count}]: " : ' ...: '
# end
#
# # Produces:
# # In [3]: def foo
# # ...: puts 'foo'
# # ...: end
# # => :foo
# # In [4]:
# @since v0.11.0
# @api public
module Prompt
# @return [String]
DEFAULT_NAME = 'pry'.freeze
# @return [Array<Object>] the list of objects that are known to have a
# 1-line #inspect output suitable for prompt
SAFE_CONTEXTS = [String, Numeric, Symbol, nil, true, false].freeze
# @deprecated Use {Pry::Prompt.add} instead.
MAP = {}
deprecate_constant(:MAP) if respond_to?(:deprecate_constant)
# A Hash that holds all prompts. The keys of the Hash are prompt
# names, the values are Hash instances of the format {:description, :value}.
@prompts = {}
class << self
# Retrieves a prompt.
#
# @example
# Prompt[:my_prompt][:value]
#
# @param [Symbol] prompt_name The name of the prompt you want to access
# @return [Hash{Symbol=>Object}]
# @since v0.12.0
def [](prompt_name)
all[prompt_name.to_s]
end
# @return [Hash{Symbol=>Hash}] the duplicate of the internal prompts hash
# @note Use this for read-only operations
# @since v0.12.0
def all
@prompts.dup
end
# Adds a new prompt to the prompt hash.
#
# @param [Symbol] prompt_name
# @param [String] description
# @param [Array<String>] separators The separators to differentiate
# between prompt modes (default mode and class/method definition mode).
# The Array *must* have a size of 2.
# @yield [context, nesting, _pry_, sep]
# @yieldparam context [Object] the context where Pry is currently in
# @yieldparam nesting [Integer] whether the context is nested
# @yieldparam _pry_ [Pry] the Pry instance
# @yieldparam separator [String] separator string
# @return [nil]
# @raise [ArgumentError] if the size of `separators` is not 2
# @since v0.12.0
def add(prompt_name, description = '', separators = %w[> *])
unless separators.size == 2
raise ArgumentError, "separators size must be 2, given #{separators.size}"
end
@prompts[prompt_name.to_s] = {
description: description,
value: separators.map do |sep|
proc { |context, nesting, _pry_| yield(context, nesting, _pry_, sep) }
end
}
nil
end
private
def prompt_name(name)
return name unless name.is_a?(Pry::Config::Lazy)
name.call
end
end
add(:default, <<DESC) do |context, nesting, _pry_, sep|
The default Pry prompt. Includes information about the current expression
number, evaluation context, and nesting level, plus a reminder that you're
using Pry.
DESC
format(
"[%<in_count>s] %<name>s(%<context>s)%<nesting>s%<separator>s ",
in_count: _pry_.input_ring.count,
name: prompt_name(_pry_.config.prompt_name),
context: Pry.view_clip(context),
nesting: (nesting > 0 ? ":#{nesting}" : ''),
separator: sep
)
end
add(:simple, "A simple `>>`.\n", ['>> ', ' | ']) do |_, _, _, sep|
sep
end
add(:nav, <<DESC, %w[> *]) do |context, nesting, _pry_, sep|
A prompt that displays the binding stack as a path and includes information
about #{Helpers::Text.bold('_in_')} and #{Helpers::Text.bold('_out_')}.
DESC
tree = _pry_.binding_stack.map { |b| Pry.view_clip(b.eval('self')) }
format(
"[%<in_count>s] (%<name>s) %<tree>s: %<stack_size>s%<separator>s ",
in_count: _pry_.input_ring.count,
name: prompt_name(_pry_.config.prompt_name),
tree: tree.join(' / '),
stack_size: _pry_.binding_stack.size - 1,
separator: sep
)
end
add(:shell, <<DESC, %w[$ *]) do |context, nesting, _pry_, sep|
A prompt that displays `$PWD` as you change it.
DESC
format(
"%<name>s %<context>s:%<pwd>s %<separator>s ",
name: prompt_name(_pry_.config.prompt_name),
context: Pry.view_clip(context),
pwd: Dir.pwd,
separator: sep
)
end
add(:none, 'Wave goodbye to the Pry prompt.', Array.new(2)) { '' }
end
end
|
