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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 83a4642834ec1aae9fa42ab3a433381890783b7c
4
- data.tar.gz: 10acc95a5dab359d5105d269cc1f16fb8b74bd5a
3
+ metadata.gz: 9b5de06075953f9ad400bad3cc4332993b9bacd0
4
+ data.tar.gz: 06aa83e94ac0995663cfb620b6ebdfc1ae0ad52f
5
5
  SHA512:
6
- metadata.gz: 9668e96851e72eb15069cae9ff341315965f24f45f8f467d1079e74c53a0e6e9a94977e6793240586f6ffd4f48acff16af4884024b507396fa3bd78ac561850b
7
- data.tar.gz: 481353845b4cf101a7fe848cd505750e688c376f87a9a7fbd3317568d8b33700400e3dd03619283f7aff155b319c4147c817387afff640dfcbbbaa6cd7af5d21
6
+ metadata.gz: 3d6102271b1792f2e61475a4d8fbfe90015a22285db7443c7c9fe0532bde556f514bcc4397b4e8c9c15c782171dbfdc470770e85e9282d24859c970a69395566
7
+ data.tar.gz: b10807d66cff7e0660da4cc896b9cf48eff868617b4f82479a3101f81459eba831b8ed5b73ed8cdf4fe0294b0e6a0077f9aa7b543184ac3070c357a1271e1a1a
@@ -0,0 +1,532 @@
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::CommandChain
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/CommandChain.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 (C)</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">CommandChain</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::CommandChain
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::CommandChain</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dt class="r2">Includes:</dt>
96
+ <dd class="r2"><span class='object_link'><a href="DefineOp.html" title="Caliph::DefineOp (module)">DefineOp</a></span></dd>
97
+
98
+
99
+
100
+
101
+
102
+ <dt class="r1 last">Defined in:</dt>
103
+ <dd class="r1 last">lib/caliph/command-chain.rb</dd>
104
+
105
+ </dl>
106
+ <div class="clear"></div>
107
+
108
+ <div id="subclasses">
109
+ <h2>Direct Known Subclasses</h2>
110
+ <p class="children"><span class='object_link'><a href="PipelineChain.html" title="Caliph::PipelineChain (class)">PipelineChain</a></span>, <span class='object_link'><a href="PrereqChain.html" title="Caliph::PrereqChain (class)">PrereqChain</a></span>, <span class='object_link'><a href="WrappingChain.html" title="Caliph::WrappingChain (class)">WrappingChain</a></span></p>
111
+ </div>
112
+
113
+
114
+
115
+
116
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#commands-instance_method" title="#commands (instance method)">- (Object) <strong>commands</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+ <span class="note title readonly">readonly</span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'>
142
+ <p>Returns the value of attribute commands.</p>
143
+ </div></span>
144
+
145
+ </li>
146
+
147
+
148
+ </ul>
149
+
150
+
151
+
152
+
153
+
154
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="CommandLine.html" title="Caliph::CommandLine (class)">CommandLine</a></span></h3>
155
+ <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>
156
+
157
+
158
+
159
+ <h2>
160
+ Instance Method Summary
161
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
162
+ </h2>
163
+
164
+ <ul class="summary">
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#add-instance_method" title="#add (instance method)">- (Object) <strong>add</strong>(cmd) {|cmd| ... }</a>
170
+
171
+
172
+
173
+ </span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'></div></span>
184
+
185
+ </li>
186
+
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#command_environment-instance_method" title="#command_environment (instance method)">- (Object) <strong>command_environment</strong> </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'>
206
+ <p>Honestly this is sub-optimal - biggest driver for considering the
207
+ mini-shell approach here.</p>
208
+ </div></span>
209
+
210
+ </li>
211
+
212
+
213
+ <li class="public ">
214
+ <span class="summary_signature">
215
+
216
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (CommandChain) <strong>initialize</strong> </a>
217
+
218
+
219
+
220
+ </span>
221
+
222
+
223
+ <span class="note title constructor">constructor</span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+ <span class="summary_desc"><div class='inline'>
233
+ <p>A new instance of CommandChain.</p>
234
+ </div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
243
+
244
+
245
+
246
+ </span>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+ <span class="summary_desc"><div class='inline'></div></span>
257
+
258
+ </li>
259
+
260
+
261
+ </ul>
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="DefineOp.html" title="Caliph::DefineOp (module)">DefineOp</a></span></h3>
274
+ <p class="inherited"><span class='object_link'><a href="DefineOp.html#included-class_method" title="Caliph::DefineOp.included (method)">included</a></span></p>
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="CommandLine.html" title="Caliph::CommandLine (class)">CommandLine</a></span></h3>
285
+ <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#command-instance_method" title="Caliph::CommandLine#command (method)">#command</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>
286
+ <div id="constructor_details" class="method_details_list">
287
+ <h2>Constructor Details</h2>
288
+
289
+ <div class="method_details first">
290
+ <h3 class="signature first" id="initialize-instance_method">
291
+
292
+ - (<tt><span class='object_link'><a href="" title="Caliph::CommandChain (class)">CommandChain</a></span></tt>) <strong>initialize</strong>
293
+
294
+
295
+
296
+
297
+
298
+ </h3><div class="docstring">
299
+ <div class="discussion">
300
+
301
+ <p>Returns a new instance of CommandChain</p>
302
+
303
+
304
+ </div>
305
+ </div>
306
+ <div class="tags">
307
+
308
+
309
+ </div><table class="source_code">
310
+ <tr>
311
+ <td>
312
+ <pre class="lines">
313
+
314
+
315
+ 7
316
+ 8
317
+ 9
318
+ 10
319
+ 11</pre>
320
+ </td>
321
+ <td>
322
+ <pre class="code"><span class="info file"># File 'lib/caliph/command-chain.rb', line 7</span>
323
+
324
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
325
+ <span class='ivar'>@commands</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
326
+ <span class='ivar'>@command_environment</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
327
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span>
328
+ <span class='kw'>end</span></pre>
329
+ </td>
330
+ </tr>
331
+ </table>
332
+ </div>
333
+
334
+ </div>
335
+
336
+ <div id="instance_attr_details" class="attr_details">
337
+ <h2>Instance Attribute Details</h2>
338
+
339
+
340
+ <span id=""></span>
341
+ <div class="method_details first">
342
+ <h3 class="signature first" id="commands-instance_method">
343
+
344
+ - (<tt>Object</tt>) <strong>commands</strong> <span class="extras">(readonly)</span>
345
+
346
+
347
+
348
+
349
+
350
+ </h3><div class="docstring">
351
+ <div class="discussion">
352
+
353
+ <p>Returns the value of attribute commands</p>
354
+
355
+
356
+ </div>
357
+ </div>
358
+ <div class="tags">
359
+
360
+
361
+ </div><table class="source_code">
362
+ <tr>
363
+ <td>
364
+ <pre class="lines">
365
+
366
+
367
+ 13
368
+ 14
369
+ 15</pre>
370
+ </td>
371
+ <td>
372
+ <pre class="code"><span class="info file"># File 'lib/caliph/command-chain.rb', line 13</span>
373
+
374
+ <span class='kw'>def</span> <span class='id identifier rubyid_commands'>commands</span>
375
+ <span class='ivar'>@commands</span>
376
+ <span class='kw'>end</span></pre>
377
+ </td>
378
+ </tr>
379
+ </table>
380
+ </div>
381
+
382
+ </div>
383
+
384
+
385
+ <div id="instance_method_details" class="method_details_list">
386
+ <h2>Instance Method Details</h2>
387
+
388
+
389
+ <div class="method_details first">
390
+ <h3 class="signature first" id="add-instance_method">
391
+
392
+ - (<tt>Object</tt>) <strong>add</strong>(cmd) {|cmd| ... }
393
+
394
+
395
+
396
+
397
+
398
+ </h3><div class="docstring">
399
+ <div class="discussion">
400
+
401
+
402
+ </div>
403
+ </div>
404
+ <div class="tags">
405
+
406
+ <p class="tag_title">Yields:</p>
407
+ <ul class="yield">
408
+
409
+ <li>
410
+
411
+
412
+ <span class='type'>(<tt>cmd</tt>)</span>
413
+
414
+
415
+
416
+ </li>
417
+
418
+ </ul>
419
+
420
+ </div><table class="source_code">
421
+ <tr>
422
+ <td>
423
+ <pre class="lines">
424
+
425
+
426
+ 15
427
+ 16
428
+ 17
429
+ 18
430
+ 19</pre>
431
+ </td>
432
+ <td>
433
+ <pre class="code"><span class="info file"># File 'lib/caliph/command-chain.rb', line 15</span>
434
+
435
+ <span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
436
+ <span class='kw'>yield</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
437
+ <span class='ivar'>@commands</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_cmd'>cmd</span>
438
+ <span class='kw'>self</span>
439
+ <span class='kw'>end</span></pre>
440
+ </td>
441
+ </tr>
442
+ </table>
443
+ </div>
444
+
445
+ <div class="method_details ">
446
+ <h3 class="signature " id="command_environment-instance_method">
447
+
448
+ - (<tt>Object</tt>) <strong>command_environment</strong>
449
+
450
+
451
+
452
+
453
+
454
+ </h3><div class="docstring">
455
+ <div class="discussion">
456
+
457
+ <p>Honestly this is sub-optimal - biggest driver for considering the
458
+ mini-shell approach here.</p>
459
+
460
+
461
+ </div>
462
+ </div>
463
+ <div class="tags">
464
+
465
+
466
+ </div><table class="source_code">
467
+ <tr>
468
+ <td>
469
+ <pre class="lines">
470
+
471
+
472
+ 23
473
+ 24
474
+ 25
475
+ 26
476
+ 27</pre>
477
+ </td>
478
+ <td>
479
+ <pre class="code"><span class="info file"># File 'lib/caliph/command-chain.rb', line 23</span>
480
+
481
+ <span class='kw'>def</span> <span class='id identifier rubyid_command_environment'>command_environment</span>
482
+ <span class='ivar'>@command_environment</span> <span class='op'>=</span> <span class='ivar'>@commands</span><span class='period'>.</span><span class='id identifier rubyid_reverse'>reverse</span><span class='period'>.</span><span class='id identifier rubyid_inject'>inject</span><span class='lparen'>(</span><span class='ivar'>@command_environment</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_command'>command</span><span class='op'>|</span>
483
+ <span class='id identifier rubyid_env'>env</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_command'>command</span><span class='period'>.</span><span class='id identifier rubyid_command_environment'>command_environment</span><span class='rparen'>)</span>
484
+ <span class='kw'>end</span>
485
+ <span class='kw'>end</span></pre>
486
+ </td>
487
+ </tr>
488
+ </table>
489
+ </div>
490
+
491
+ <div class="method_details ">
492
+ <h3 class="signature " id="name-instance_method">
493
+
494
+ - (<tt>Object</tt>) <strong>name</strong>
495
+
496
+
497
+
498
+
499
+
500
+ </h3><table class="source_code">
501
+ <tr>
502
+ <td>
503
+ <pre class="lines">
504
+
505
+
506
+ 29
507
+ 30
508
+ 31</pre>
509
+ </td>
510
+ <td>
511
+ <pre class="code"><span class="info file"># File 'lib/caliph/command-chain.rb', line 29</span>
512
+
513
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
514
+ <span class='ivar'>@name</span> <span class='op'>||</span> <span class='ivar'>@commands</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
515
+ <span class='kw'>end</span></pre>
516
+ </td>
517
+ </tr>
518
+ </table>
519
+ </div>
520
+
521
+ </div>
522
+
523
+ </div>
524
+
525
+ <div id="footer">
526
+ Generated on Fri Jun 13 17:31:08 2014 by
527
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
528
+ 0.8.7.4 (ruby-2.0.0).
529
+ </div>
530
+
531
+ </body>
532
+ </html>