rprompt 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +0 -1
- data/doc/Rprompt.html +129 -0
- data/doc/Rprompt/GitBranch.html +335 -0
- data/doc/Rprompt/GitNumbers.html +335 -0
- data/doc/Rprompt/GitSha.html +335 -0
- data/doc/Rprompt/GitTrack.html +455 -0
- data/doc/Rprompt/PromptItem.html +516 -0
- data/doc/Rprompt/RvmGemset.html +353 -0
- data/doc/Rprompt/RvmRuby.html +345 -0
- data/doc/String.html +136 -0
- data/doc/_index.html +188 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +338 -0
- data/doc/file.README.html +168 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +168 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +178 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +155 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/rprompt/version.rb +1 -1
- metadata +24 -1
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Rprompt::GitTrack
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.6.2
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '../';
|
|
20
|
+
framesUrl = "../frames.html#!" + escape(window.location.href);
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="../_index.html">Index (G)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../Rprompt.html" title="Rprompt (module)">Rprompt</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">GitTrack</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: Rprompt::GitTrack
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName"><span class='object_link'><a href="PromptItem.html" title="Rprompt::PromptItem (class)">PromptItem</a></span></span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next"><span class='object_link'><a href="PromptItem.html" title="Rprompt::PromptItem (class)">PromptItem</a></span></li>
|
|
82
|
+
|
|
83
|
+
<li class="next">Rprompt::GitTrack</li>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
87
|
+
|
|
88
|
+
</dd>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<dt class="r2 last">Defined in:</dt>
|
|
99
|
+
<dd class="r2 last">lib/rprompt.rb</dd>
|
|
100
|
+
|
|
101
|
+
</dl>
|
|
102
|
+
<div class="clear"></div>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<h2>Instance Attribute Summary</h2>
|
|
111
|
+
|
|
112
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="PromptItem.html" title="Rprompt::PromptItem (class)">PromptItem</a></span></h3>
|
|
113
|
+
<p class="inherited"><span class='object_link'><a href="PromptItem.html#color-instance_method" title="Rprompt::PromptItem#color (method)">#color</a></span>, <span class='object_link'><a href="PromptItem.html#symbol-instance_method" title="Rprompt::PromptItem#symbol (method)">#symbol</a></span></p>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<h2>
|
|
118
|
+
Instance Method Summary
|
|
119
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
120
|
+
</h2>
|
|
121
|
+
|
|
122
|
+
<ul class="summary">
|
|
123
|
+
|
|
124
|
+
<li class="public ">
|
|
125
|
+
<span class="summary_signature">
|
|
126
|
+
|
|
127
|
+
<a href="#count-instance_method" title="#count (instance method)">- (Integer) <strong>count</strong> </a>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</span>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<span class="summary_desc"><div class='inline'>
|
|
142
|
+
<p>Number of commits ahead or behind remote.</p>
|
|
143
|
+
</div></span>
|
|
144
|
+
|
|
145
|
+
</li>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
<li class="public ">
|
|
149
|
+
<span class="summary_signature">
|
|
150
|
+
|
|
151
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (GitTrack) <strong>initialize</strong>(config, state) </a>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
</span>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="note title constructor">constructor</span>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
|
168
|
+
<p>A new instance of GitTrack.</p>
|
|
169
|
+
</div></span>
|
|
170
|
+
|
|
171
|
+
</li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<li class="public ">
|
|
175
|
+
<span class="summary_signature">
|
|
176
|
+
|
|
177
|
+
<a href="#show-instance_method" title="#show (instance method)">- (String) <strong>show</strong> </a>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</span>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="summary_desc"><div class='inline'>
|
|
192
|
+
<p>Terminal representation of the tracking.</p>
|
|
193
|
+
</div></span>
|
|
194
|
+
|
|
195
|
+
</li>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</ul>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="PromptItem.html" title="Rprompt::PromptItem (class)">PromptItem</a></span></h3>
|
|
211
|
+
<p class="inherited"><span class='object_link'><a href="PromptItem.html#commandResult-instance_method" title="Rprompt::PromptItem#commandResult (method)">#commandResult</a></span></p>
|
|
212
|
+
<div id="constructor_details" class="method_details_list">
|
|
213
|
+
<h2>Constructor Details</h2>
|
|
214
|
+
|
|
215
|
+
<div class="method_details first">
|
|
216
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
217
|
+
|
|
218
|
+
- (<tt><span class='object_link'><a href="" title="Rprompt::GitTrack (class)">GitTrack</a></span></tt>) <strong>initialize</strong>(config, state)
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
</h3><div class="docstring">
|
|
225
|
+
<div class="discussion">
|
|
226
|
+
|
|
227
|
+
<p>A new instance of GitTrack</p>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
</div>
|
|
231
|
+
</div>
|
|
232
|
+
<div class="tags">
|
|
233
|
+
<p class="tag_title">Parameters:</p>
|
|
234
|
+
<ul class="param">
|
|
235
|
+
|
|
236
|
+
<li>
|
|
237
|
+
|
|
238
|
+
<span class='name'>state</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
—
|
|
246
|
+
<div class='inline'>
|
|
247
|
+
<p>(“ahead” or “behind”)</p>
|
|
248
|
+
</div>
|
|
249
|
+
|
|
250
|
+
</li>
|
|
251
|
+
|
|
252
|
+
<li>
|
|
253
|
+
|
|
254
|
+
<span class='name'>config</span>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
—
|
|
262
|
+
<div class='inline'>
|
|
263
|
+
<p>Prompt item configuration:</p>
|
|
264
|
+
<ul><li>
|
|
265
|
+
<p>:cmd => shell command</p>
|
|
266
|
+
</li><li>
|
|
267
|
+
<p>:symbol => character</p>
|
|
268
|
+
</li><li>
|
|
269
|
+
<p>:color => color name</p>
|
|
270
|
+
</li></ul>
|
|
271
|
+
</div>
|
|
272
|
+
|
|
273
|
+
</li>
|
|
274
|
+
|
|
275
|
+
</ul>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
</div><table class="source_code">
|
|
279
|
+
<tr>
|
|
280
|
+
<td>
|
|
281
|
+
<pre class="lines">
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
83
|
|
285
|
+
84
|
|
286
|
+
85
|
|
287
|
+
86</pre>
|
|
288
|
+
</td>
|
|
289
|
+
<td>
|
|
290
|
+
<pre class="code"><span class="info file"># File 'lib/rprompt.rb', line 83</span>
|
|
291
|
+
|
|
292
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='comma'>,</span> <span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
|
|
293
|
+
<span class='ivar'>@state</span> <span class='op'>=</span> <span class='id identifier rubyid_state'>state</span>
|
|
294
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
|
|
295
|
+
<span class='kw'>end</span></pre>
|
|
296
|
+
</td>
|
|
297
|
+
</tr>
|
|
298
|
+
</table>
|
|
299
|
+
</div>
|
|
300
|
+
|
|
301
|
+
</div>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<div id="instance_method_details" class="method_details_list">
|
|
305
|
+
<h2>Instance Method Details</h2>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<div class="method_details first">
|
|
309
|
+
<h3 class="signature first" id="count-instance_method">
|
|
310
|
+
|
|
311
|
+
- (<tt>Integer</tt>) <strong>count</strong>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
</h3><div class="docstring">
|
|
318
|
+
<div class="discussion">
|
|
319
|
+
|
|
320
|
+
<div class="note notetag">
|
|
321
|
+
<strong>Note:</strong>
|
|
322
|
+
<div class='inline'>
|
|
323
|
+
<p>works only if remote branch is tracked</p>
|
|
324
|
+
</div>
|
|
325
|
+
</div>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<p>Number of commits ahead or behind remote</p>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
</div>
|
|
332
|
+
</div>
|
|
333
|
+
<div class="tags">
|
|
334
|
+
|
|
335
|
+
<p class="tag_title">Returns:</p>
|
|
336
|
+
<ul class="return">
|
|
337
|
+
|
|
338
|
+
<li>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
—
|
|
346
|
+
<div class='inline'>
|
|
347
|
+
<p>number of commits ahead or behind remote</p>
|
|
348
|
+
</div>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
</ul>
|
|
353
|
+
|
|
354
|
+
</div><table class="source_code">
|
|
355
|
+
<tr>
|
|
356
|
+
<td>
|
|
357
|
+
<pre class="lines">
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
90
|
|
361
|
+
91
|
|
362
|
+
92
|
|
363
|
+
93</pre>
|
|
364
|
+
</td>
|
|
365
|
+
<td>
|
|
366
|
+
<pre class="code"><span class="info file"># File 'lib/rprompt.rb', line 90</span>
|
|
367
|
+
|
|
368
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span>
|
|
369
|
+
<span class='id identifier rubyid_commandResult'>commandResult</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@state</span><span class='rbrace'>}</span><span class='tstring_content'>\s+([0-9]+)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
|
|
370
|
+
<span class='backref'>$1</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
|
371
|
+
<span class='kw'>end</span></pre>
|
|
372
|
+
</td>
|
|
373
|
+
</tr>
|
|
374
|
+
</table>
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
<div class="method_details ">
|
|
378
|
+
<h3 class="signature " id="show-instance_method">
|
|
379
|
+
|
|
380
|
+
- (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>show</strong>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
</h3><div class="docstring">
|
|
387
|
+
<div class="discussion">
|
|
388
|
+
|
|
389
|
+
<p>Terminal representation of the tracking</p>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</div>
|
|
393
|
+
</div>
|
|
394
|
+
<div class="tags">
|
|
395
|
+
|
|
396
|
+
<p class="tag_title">Returns:</p>
|
|
397
|
+
<ul class="return">
|
|
398
|
+
|
|
399
|
+
<li>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
—
|
|
407
|
+
<div class='inline'>
|
|
408
|
+
<p>terminal representation of the tracking</p>
|
|
409
|
+
</div>
|
|
410
|
+
|
|
411
|
+
</li>
|
|
412
|
+
|
|
413
|
+
</ul>
|
|
414
|
+
|
|
415
|
+
</div><table class="source_code">
|
|
416
|
+
<tr>
|
|
417
|
+
<td>
|
|
418
|
+
<pre class="lines">
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
96
|
|
422
|
+
97
|
|
423
|
+
98
|
|
424
|
+
99
|
|
425
|
+
100
|
|
426
|
+
101
|
|
427
|
+
102</pre>
|
|
428
|
+
</td>
|
|
429
|
+
<td>
|
|
430
|
+
<pre class="code"><span class="info file"># File 'lib/rprompt.rb', line 96</span>
|
|
431
|
+
|
|
432
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span>
|
|
433
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_color'>color</span>
|
|
434
|
+
<span class='id identifier rubyid_count'>count</span> <span class='op'>!=</span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_symbol'>symbol</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_count'>count</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_color'>color</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
435
|
+
<span class='kw'>else</span>
|
|
436
|
+
<span class='id identifier rubyid_count'>count</span> <span class='op'>!=</span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_symbol'>symbol</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_count'>count</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
437
|
+
<span class='kw'>end</span>
|
|
438
|
+
<span class='kw'>end</span></pre>
|
|
439
|
+
</td>
|
|
440
|
+
</tr>
|
|
441
|
+
</table>
|
|
442
|
+
</div>
|
|
443
|
+
|
|
444
|
+
</div>
|
|
445
|
+
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
<div id="footer">
|
|
449
|
+
Generated on Sat Jul 20 10:38:07 2013 by
|
|
450
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
451
|
+
0.8.6.2 (ruby-1.9.3).
|
|
452
|
+
</div>
|
|
453
|
+
|
|
454
|
+
</body>
|
|
455
|
+
</html>
|