caliph 0.1.1 → 0.1.2

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.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/doc/Caliph/CommandChain.html +532 -0
  3. data/doc/Caliph/CommandLine.html +2541 -0
  4. data/doc/Caliph/CommandLineDSL.html +230 -0
  5. data/doc/Caliph/CommandLineExampleGroup/MockingExecute.html +174 -0
  6. data/doc/Caliph/CommandLineExampleGroup.html +366 -0
  7. data/doc/Caliph/CommandRunResult.html +1124 -0
  8. data/doc/Caliph/DefineOp/ClassMethods.html +250 -0
  9. data/doc/Caliph/DefineOp.html +188 -0
  10. data/doc/Caliph/MockCommandResult.html +465 -0
  11. data/doc/Caliph/PipelineChain.html +242 -0
  12. data/doc/Caliph/PrereqChain.html +242 -0
  13. data/doc/Caliph/ShellEscaped.html +445 -0
  14. data/doc/Caliph/WrappingChain.html +242 -0
  15. data/doc/Caliph.html +119 -0
  16. data/doc/_index.html +241 -0
  17. data/doc/class_list.html +54 -0
  18. data/doc/css/common.css +1 -0
  19. data/doc/css/full_list.css +57 -0
  20. data/doc/css/style.css +339 -0
  21. data/doc/file.README.html +235 -0
  22. data/doc/file_list.html +56 -0
  23. data/doc/frames.html +26 -0
  24. data/doc/index.html +235 -0
  25. data/doc/js/app.js +219 -0
  26. data/doc/js/full_list.js +178 -0
  27. data/doc/js/jquery.js +4 -0
  28. data/doc/method_list.html +503 -0
  29. data/doc/top-level-namespace.html +112 -0
  30. data/lib/caliph/command-chain.rb +4 -1
  31. data/lib/caliph/command-line.rb +24 -81
  32. data/lib/caliph/command-run-result.rb +48 -7
  33. data/lib/caliph/shell.rb +172 -0
  34. data/lib/caliph.rb +9 -0
  35. data/spec/command-line-dsl.rb +15 -15
  36. data/spec/command-line.rb +16 -18
  37. data/spec_help/spec_helper.rb +9 -3
  38. metadata +63 -6
data/doc/Caliph/MockCommandResult.html ADDED
@@ -0,0 +1,465 @@
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: Caliph::MockCommandResult
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
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#!Caliph/MockCommandResult.html";
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 (M)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Caliph.html" title="Caliph (module)">Caliph</a></span></span>
36
+ &raquo;
37
+ <span class="title">MockCommandResult</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: Caliph::MockCommandResult
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="CommandRunResult.html" title="Caliph::CommandRunResult (class)">CommandRunResult</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="CommandRunResult.html" title="Caliph::CommandRunResult (class)">CommandRunResult</a></span></li>
82
+
83
+ <li class="next">Caliph::MockCommandResult</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/caliph/testing/mock-command-line.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#exit_code-instance_method" title="#exit_code (instance method)">- (Object) <strong>exit_code</strong> </a>
115
+
116
+
117
+
118
+ (also: #exit_status)
119
+
120
+ </span>
121
+
122
+
123
+
124
+
125
+ <span class="note title readonly">readonly</span>
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <span class="summary_desc"><div class='inline'>
136
+ <p>Returns the value of attribute exit_code.</p>
137
+ </div></span>
138
+
139
+ </li>
140
+
141
+
142
+ <li class="public ">
143
+ <span class="summary_signature">
144
+
145
+ <a href="#streams-instance_method" title="#streams (instance method)">- (Object) <strong>streams</strong> </a>
146
+
147
+
148
+
149
+ </span>
150
+
151
+
152
+
153
+
154
+ <span class="note title readonly">readonly</span>
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ <span class="summary_desc"><div class='inline'>
165
+ <p>Returns the value of attribute streams.</p>
166
+ </div></span>
167
+
168
+ </li>
169
+
170
+
171
+ </ul>
172
+
173
+
174
+
175
+
176
+
177
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="CommandRunResult.html" title="Caliph::CommandRunResult (class)">CommandRunResult</a></span></h3>
178
+ <p class="inherited"><span class='object_link'><a href="CommandRunResult.html#consume_timeout-instance_method" title="Caliph::CommandRunResult#consume_timeout (method)">#consume_timeout</a></span>, <span class='object_link'><a href="CommandRunResult.html#pid-instance_method" title="Caliph::CommandRunResult#pid (method)">#pid</a></span>, <span class='object_link'><a href="CommandRunResult.html#process_status-instance_method" title="Caliph::CommandRunResult#process_status (method)">#process_status</a></span></p>
179
+
180
+
181
+
182
+ <h2>
183
+ Class Method Summary
184
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
185
+ </h2>
186
+
187
+ <ul class="summary">
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#create-class_method" title="create (class method)">+ (Object) <strong>create</strong>(*args) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'></div></span>
207
+
208
+ </li>
209
+
210
+
211
+ </ul>
212
+
213
+ <h2>
214
+ Instance Method Summary
215
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
216
+ </h2>
217
+
218
+ <ul class="summary">
219
+
220
+ <li class="public ">
221
+ <span class="summary_signature">
222
+
223
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (MockCommandResult) <strong>initialize</strong>(code, streams) </a>
224
+
225
+
226
+
227
+ </span>
228
+
229
+
230
+ <span class="note title constructor">constructor</span>
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'>
240
+ <p>A new instance of MockCommandResult.</p>
241
+ </div></span>
242
+
243
+ </li>
244
+
245
+
246
+ </ul>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="CommandRunResult.html" title="Caliph::CommandRunResult (class)">CommandRunResult</a></span></h3>
259
+ <p class="inherited"><span class='object_link'><a href="CommandRunResult.html#consume_buffers-instance_method" title="Caliph::CommandRunResult#consume_buffers (method)">#consume_buffers</a></span>, <span class='object_link'><a href="CommandRunResult.html#format_streams-instance_method" title="Caliph::CommandRunResult#format_streams (method)">#format_streams</a></span>, <span class='object_link'><a href="CommandRunResult.html#must_succeed%21-instance_method" title="Caliph::CommandRunResult#must_succeed! (method)">#must_succeed!</a></span>, <span class='object_link'><a href="CommandRunResult.html#stderr-instance_method" title="Caliph::CommandRunResult#stderr (method)">#stderr</a></span>, <span class='object_link'><a href="CommandRunResult.html#stdout-instance_method" title="Caliph::CommandRunResult#stdout (method)">#stdout</a></span>, <span class='object_link'><a href="CommandRunResult.html#succeeded%3F-instance_method" title="Caliph::CommandRunResult#succeeded? (method)">#succeeded?</a></span>, <span class='object_link'><a href="CommandRunResult.html#wait-instance_method" title="Caliph::CommandRunResult#wait (method)">#wait</a></span></p>
260
+ <div id="constructor_details" class="method_details_list">
261
+ <h2>Constructor Details</h2>
262
+
263
+ <div class="method_details first">
264
+ <h3 class="signature first" id="initialize-instance_method">
265
+
266
+ - (<tt><span class='object_link'><a href="" title="Caliph::MockCommandResult (class)">MockCommandResult</a></span></tt>) <strong>initialize</strong>(code, streams)
267
+
268
+
269
+
270
+
271
+
272
+ </h3><div class="docstring">
273
+ <div class="discussion">
274
+
275
+ <p>Returns a new instance of MockCommandResult</p>
276
+
277
+
278
+ </div>
279
+ </div>
280
+ <div class="tags">
281
+
282
+
283
+ </div><table class="source_code">
284
+ <tr>
285
+ <td>
286
+ <pre class="lines">
287
+
288
+
289
+ 17
290
+ 18
291
+ 19
292
+ 20</pre>
293
+ </td>
294
+ <td>
295
+ <pre class="code"><span class="info file"># File 'lib/caliph/testing/mock-command-line.rb', line 17</span>
296
+
297
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_streams'>streams</span><span class='rparen'>)</span>
298
+ <span class='ivar'>@streams</span> <span class='op'>=</span> <span class='id identifier rubyid_streams'>streams</span>
299
+ <span class='ivar'>@exit_code</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span>
300
+ <span class='kw'>end</span></pre>
301
+ </td>
302
+ </tr>
303
+ </table>
304
+ </div>
305
+
306
+ </div>
307
+
308
+ <div id="instance_attr_details" class="attr_details">
309
+ <h2>Instance Attribute Details</h2>
310
+
311
+
312
+ <span id=""></span>
313
+ <div class="method_details first">
314
+ <h3 class="signature first" id="exit_code-instance_method">
315
+
316
+ - (<tt>Object</tt>) <strong>exit_code</strong> <span class="extras">(readonly)</span>
317
+
318
+
319
+
320
+ <span class="aliases">Also known as:
321
+ <span class="names"><span id='exit_status-instance_method'>exit_status</span></span>
322
+ </span>
323
+
324
+
325
+
326
+ </h3><div class="docstring">
327
+ <div class="discussion">
328
+
329
+ <p>Returns the value of attribute exit_code</p>
330
+
331
+
332
+ </div>
333
+ </div>
334
+ <div class="tags">
335
+
336
+
337
+ </div><table class="source_code">
338
+ <tr>
339
+ <td>
340
+ <pre class="lines">
341
+
342
+
343
+ 22
344
+ 23
345
+ 24</pre>
346
+ </td>
347
+ <td>
348
+ <pre class="code"><span class="info file"># File 'lib/caliph/testing/mock-command-line.rb', line 22</span>
349
+
350
+ <span class='kw'>def</span> <span class='id identifier rubyid_exit_code'>exit_code</span>
351
+ <span class='ivar'>@exit_code</span>
352
+ <span class='kw'>end</span></pre>
353
+ </td>
354
+ </tr>
355
+ </table>
356
+ </div>
357
+
358
+
359
+ <span id=""></span>
360
+ <div class="method_details ">
361
+ <h3 class="signature " id="streams-instance_method">
362
+
363
+ - (<tt>Object</tt>) <strong>streams</strong> <span class="extras">(readonly)</span>
364
+
365
+
366
+
367
+
368
+
369
+ </h3><div class="docstring">
370
+ <div class="discussion">
371
+
372
+ <p>Returns the value of attribute streams</p>
373
+
374
+
375
+ </div>
376
+ </div>
377
+ <div class="tags">
378
+
379
+
380
+ </div><table class="source_code">
381
+ <tr>
382
+ <td>
383
+ <pre class="lines">
384
+
385
+
386
+ 22
387
+ 23
388
+ 24</pre>
389
+ </td>
390
+ <td>
391
+ <pre class="code"><span class="info file"># File 'lib/caliph/testing/mock-command-line.rb', line 22</span>
392
+
393
+ <span class='kw'>def</span> <span class='id identifier rubyid_streams'>streams</span>
394
+ <span class='ivar'>@streams</span>
395
+ <span class='kw'>end</span></pre>
396
+ </td>
397
+ </tr>
398
+ </table>
399
+ </div>
400
+
401
+ </div>
402
+
403
+
404
+ <div id="class_method_details" class="method_details_list">
405
+ <h2>Class Method Details</h2>
406
+
407
+
408
+ <div class="method_details first">
409
+ <h3 class="signature first" id="create-class_method">
410
+
411
+ + (<tt>Object</tt>) <strong>create</strong>(*args)
412
+
413
+
414
+
415
+
416
+
417
+ </h3><table class="source_code">
418
+ <tr>
419
+ <td>
420
+ <pre class="lines">
421
+
422
+
423
+ 5
424
+ 6
425
+ 7
426
+ 8
427
+ 9
428
+ 10
429
+ 11
430
+ 12
431
+ 13
432
+ 14
433
+ 15</pre>
434
+ </td>
435
+ <td>
436
+ <pre class="code"><span class="info file"># File 'lib/caliph/testing/mock-command-line.rb', line 5</span>
437
+
438
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
439
+ <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span>
440
+ <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='int'>1</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span><span class='rbracket'>]</span>
441
+ <span class='kw'>end</span>
442
+
443
+ <span class='kw'>if</span> <span class='const'>String</span> <span class='op'>==</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
444
+ <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='int'>1</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbrace'>}</span>
445
+ <span class='kw'>end</span>
446
+
447
+ <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
448
+ <span class='kw'>end</span></pre>
449
+ </td>
450
+ </tr>
451
+ </table>
452
+ </div>
453
+
454
+ </div>
455
+
456
+ </div>
457
+
458
+ <div id="footer">
459
+ Generated on Fri Jun 13 17:31:08 2014 by
460
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
461
+ 0.8.7.4 (ruby-2.0.0).
462
+ </div>
463
+
464
+ </body>
465
+ </html>