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/ShellEscaped.html ADDED
@@ -0,0 +1,445 @@
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::ShellEscaped
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/ShellEscaped.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 (S)</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">ShellEscaped</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::ShellEscaped
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="CommandLine.html" title="Caliph::CommandLine (class)">CommandLine</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="CommandLine.html" title="Caliph::CommandLine (class)">CommandLine</a></span></li>
82
+
83
+ <li class="next">Caliph::ShellEscaped</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/shell-escaped.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="CommandLine.html" title="Caliph::CommandLine (class)">CommandLine</a></span></h3>
113
+ <p class="inherited"><span class='object_link'><a href="CommandLine.html#env-instance_method" title="Caliph::CommandLine#env (method)">#env</a></span>, <span class='object_link'><a href="CommandLine.html#executable-instance_method" title="Caliph::CommandLine#executable (method)">#executable</a></span>, <span class='object_link'><a href="CommandLine.html#options-instance_method" title="Caliph::CommandLine#options (method)">#options</a></span>, <span class='object_link'><a href="CommandLine.html#output_stream-instance_method" title="Caliph::CommandLine#output_stream (method)">#output_stream</a></span>, <span class='object_link'><a href="CommandLine.html#redirections-instance_method" title="Caliph::CommandLine#redirections (method)">#redirections</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="#command-instance_method" title="#command (instance method)">- (Object) <strong>command</strong> </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'></div></span>
142
+
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#command_environment-instance_method" title="#command_environment (instance method)">- (Object) <strong>command_environment</strong> </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <span class="summary_desc"><div class='inline'></div></span>
164
+
165
+ </li>
166
+
167
+
168
+ <li class="public ">
169
+ <span class="summary_signature">
170
+
171
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (ShellEscaped) <strong>initialize</strong>(cmd) </a>
172
+
173
+
174
+
175
+ </span>
176
+
177
+
178
+ <span class="note title constructor">constructor</span>
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>A new instance of ShellEscaped.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'></div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'></div></span>
234
+
235
+ </li>
236
+
237
+
238
+ </ul>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="CommandLine.html" title="Caliph::CommandLine (class)">CommandLine</a></span></h3>
251
+ <p class="inherited"><span class='object_link'><a href="CommandLine.html#collect_result-instance_method" title="Caliph::CommandLine#collect_result (method)">#collect_result</a></span>, <span class='object_link'><a href="CommandLine.html#complete-instance_method" title="Caliph::CommandLine#complete (method)">#complete</a></span>, <span class='object_link'><a href="CommandLine.html#copy_stream_to-instance_method" title="Caliph::CommandLine#copy_stream_to (method)">#copy_stream_to</a></span>, <span class='object_link'><a href="CommandLine.html#emit_recording-class_method" title="Caliph::CommandLine.emit_recording (method)">emit_recording</a></span>, <span class='object_link'><a href="CommandLine.html#execute-instance_method" title="Caliph::CommandLine#execute (method)">#execute</a></span>, <span class='object_link'><a href="CommandLine.html#execute-class_method" title="Caliph::CommandLine.execute (method)">execute</a></span>, <span class='object_link'><a href="CommandLine.html#kill_process-instance_method" title="Caliph::CommandLine#kill_process (method)">#kill_process</a></span>, <span class='object_link'><a href="CommandLine.html#must_succeed%21-instance_method" title="Caliph::CommandLine#must_succeed! (method)">#must_succeed!</a></span>, <span class='object_link'><a href="CommandLine.html#options_composition-instance_method" title="Caliph::CommandLine#options_composition (method)">#options_composition</a></span>, <span class='object_link'><a href="CommandLine.html#original_execute-instance_method" title="Caliph::CommandLine#original_execute (method)">#original_execute</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_both-instance_method" title="Caliph::CommandLine#redirect_both (method)">#redirect_both</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_from-instance_method" title="Caliph::CommandLine#redirect_from (method)">#redirect_from</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_stderr-instance_method" title="Caliph::CommandLine#redirect_stderr (method)">#redirect_stderr</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_stdin-instance_method" title="Caliph::CommandLine#redirect_stdin (method)">#redirect_stdin</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_stdout-instance_method" title="Caliph::CommandLine#redirect_stdout (method)">#redirect_stdout</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_to-instance_method" title="Caliph::CommandLine#redirect_to (method)">#redirect_to</a></span>, <span class='object_link'><a href="CommandLine.html#report-instance_method" title="Caliph::CommandLine#report (method)">#report</a></span>, <span class='object_link'><a href="CommandLine.html#run-instance_method" title="Caliph::CommandLine#run (method)">#run</a></span>, <span class='object_link'><a href="CommandLine.html#run_as_replacement-instance_method" title="Caliph::CommandLine#run_as_replacement (method)">#run_as_replacement</a></span>, <span class='object_link'><a href="CommandLine.html#run_detached-instance_method" title="Caliph::CommandLine#run_detached (method)">#run_detached</a></span>, <span class='object_link'><a href="CommandLine.html#run_in_background-instance_method" title="Caliph::CommandLine#run_in_background (method)">#run_in_background</a></span>, <span class='object_link'><a href="CommandLine.html#set_env-instance_method" title="Caliph::CommandLine#set_env (method)">#set_env</a></span>, <span class='object_link'><a href="CommandLine.html#spawn_process-instance_method" title="Caliph::CommandLine#spawn_process (method)">#spawn_process</a></span>, <span class='object_link'><a href="CommandLine.html#string_format-instance_method" title="Caliph::CommandLine#string_format (method)">#string_format</a></span>, <span class='object_link'><a href="CommandLine.html#succeeds%3F-instance_method" title="Caliph::CommandLine#succeeds? (method)">#succeeds?</a></span>, <span class='object_link'><a href="CommandLine.html#verbose-instance_method" title="Caliph::CommandLine#verbose (method)">#verbose</a></span></p>
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="DefineOp.html" title="Caliph::DefineOp (module)">DefineOp</a></span></h3>
262
+ <p class="inherited"><span class='object_link'><a href="DefineOp.html#included-class_method" title="Caliph::DefineOp.included (method)">included</a></span></p>
263
+ <div id="constructor_details" class="method_details_list">
264
+ <h2>Constructor Details</h2>
265
+
266
+ <div class="method_details first">
267
+ <h3 class="signature first" id="initialize-instance_method">
268
+
269
+ - (<tt><span class='object_link'><a href="" title="Caliph::ShellEscaped (class)">ShellEscaped</a></span></tt>) <strong>initialize</strong>(cmd)
270
+
271
+
272
+
273
+
274
+
275
+ </h3><div class="docstring">
276
+ <div class="discussion">
277
+
278
+ <p>Returns a new instance of ShellEscaped</p>
279
+
280
+
281
+ </div>
282
+ </div>
283
+ <div class="tags">
284
+
285
+
286
+ </div><table class="source_code">
287
+ <tr>
288
+ <td>
289
+ <pre class="lines">
290
+
291
+
292
+ 5
293
+ 6
294
+ 7</pre>
295
+ </td>
296
+ <td>
297
+ <pre class="code"><span class="info file"># File 'lib/caliph/shell-escaped.rb', line 5</span>
298
+
299
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
300
+ <span class='ivar'>@escaped</span> <span class='op'>=</span> <span class='id identifier rubyid_cmd'>cmd</span>
301
+ <span class='kw'>end</span></pre>
302
+ </td>
303
+ </tr>
304
+ </table>
305
+ </div>
306
+
307
+ </div>
308
+
309
+
310
+ <div id="instance_method_details" class="method_details_list">
311
+ <h2>Instance Method Details</h2>
312
+
313
+
314
+ <div class="method_details first">
315
+ <h3 class="signature first" id="command-instance_method">
316
+
317
+ - (<tt>Object</tt>) <strong>command</strong>
318
+
319
+
320
+
321
+
322
+
323
+ </h3><table class="source_code">
324
+ <tr>
325
+ <td>
326
+ <pre class="lines">
327
+
328
+
329
+ 9
330
+ 10
331
+ 11</pre>
332
+ </td>
333
+ <td>
334
+ <pre class="code"><span class="info file"># File 'lib/caliph/shell-escaped.rb', line 9</span>
335
+
336
+ <span class='kw'>def</span> <span class='id identifier rubyid_command'>command</span>
337
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&#39;</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span> <span class='ivar'>@escaped</span><span class='period'>.</span><span class='id identifier rubyid_string_format'>string_format</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>&#39;</span><span class='regexp_end'>/</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\&#39;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&#39;</span><span class='tstring_end'>&quot;</span></span>
338
+ <span class='kw'>end</span></pre>
339
+ </td>
340
+ </tr>
341
+ </table>
342
+ </div>
343
+
344
+ <div class="method_details ">
345
+ <h3 class="signature " id="command_environment-instance_method">
346
+
347
+ - (<tt>Object</tt>) <strong>command_environment</strong>
348
+
349
+
350
+
351
+
352
+
353
+ </h3><table class="source_code">
354
+ <tr>
355
+ <td>
356
+ <pre class="lines">
357
+
358
+
359
+ 13
360
+ 14
361
+ 15</pre>
362
+ </td>
363
+ <td>
364
+ <pre class="code"><span class="info file"># File 'lib/caliph/shell-escaped.rb', line 13</span>
365
+
366
+ <span class='kw'>def</span> <span class='id identifier rubyid_command_environment'>command_environment</span>
367
+ <span class='lbrace'>{</span><span class='rbrace'>}</span>
368
+ <span class='kw'>end</span></pre>
369
+ </td>
370
+ </tr>
371
+ </table>
372
+ </div>
373
+
374
+ <div class="method_details ">
375
+ <h3 class="signature " id="name-instance_method">
376
+
377
+ - (<tt>Object</tt>) <strong>name</strong>
378
+
379
+
380
+
381
+
382
+
383
+ </h3><table class="source_code">
384
+ <tr>
385
+ <td>
386
+ <pre class="lines">
387
+
388
+
389
+ 17
390
+ 18
391
+ 19</pre>
392
+ </td>
393
+ <td>
394
+ <pre class="code"><span class="info file"># File 'lib/caliph/shell-escaped.rb', line 17</span>
395
+
396
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
397
+ <span class='ivar'>@name</span> <span class='op'>||</span> <span class='ivar'>@escaped</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
398
+ <span class='kw'>end</span></pre>
399
+ </td>
400
+ </tr>
401
+ </table>
402
+ </div>
403
+
404
+ <div class="method_details ">
405
+ <h3 class="signature " id="to_s-instance_method">
406
+
407
+ - (<tt>Object</tt>) <strong>to_s</strong>
408
+
409
+
410
+
411
+
412
+
413
+ </h3><table class="source_code">
414
+ <tr>
415
+ <td>
416
+ <pre class="lines">
417
+
418
+
419
+ 21
420
+ 22
421
+ 23</pre>
422
+ </td>
423
+ <td>
424
+ <pre class="code"><span class="info file"># File 'lib/caliph/shell-escaped.rb', line 21</span>
425
+
426
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
427
+ <span class='id identifier rubyid_command'>command</span>
428
+ <span class='kw'>end</span></pre>
429
+ </td>
430
+ </tr>
431
+ </table>
432
+ </div>
433
+
434
+ </div>
435
+
436
+ </div>
437
+
438
+ <div id="footer">
439
+ Generated on Fri Jun 13 17:31:08 2014 by
440
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
441
+ 0.8.7.4 (ruby-2.0.0).
442
+ </div>
443
+
444
+ </body>
445
+ </html>