mattock 0.2.2 → 0.2.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.
Files changed (59) hide show
  1. data/doc/FileSandbox.html +537 -0
  2. data/doc/FileSandbox/HaveContents.html +279 -0
  3. data/doc/FileSandbox/Sandbox.html +525 -0
  4. data/doc/FileSandbox/SandboxFile.html +622 -0
  5. data/doc/Mattock.html +137 -0
  6. data/doc/Mattock/CascadingDefinition.html +459 -0
  7. data/doc/Mattock/CommandChain.html +456 -0
  8. data/doc/Mattock/CommandLine.html +1312 -0
  9. data/doc/Mattock/CommandLineExampleGroup.html +282 -0
  10. data/doc/Mattock/CommandLineExampleGroup/Matchers.html +109 -0
  11. data/doc/Mattock/CommandRunResult.html +643 -0
  12. data/doc/Mattock/CommandTask.html +464 -0
  13. data/doc/Mattock/Configurable.html +609 -0
  14. data/doc/Mattock/Configurable/ClassMethods.html +754 -0
  15. data/doc/Mattock/Configurable/Struct.html +148 -0
  16. data/doc/Mattock/FileCreationTask.html +177 -0
  17. data/doc/Mattock/FileTask.html +177 -0
  18. data/doc/Mattock/MockCommandResult.html +445 -0
  19. data/doc/Mattock/MultiTask.html +177 -0
  20. data/doc/Mattock/PipelineChain.html +221 -0
  21. data/doc/Mattock/PrereqChain.html +221 -0
  22. data/doc/Mattock/RakeExampleGroup.html +292 -0
  23. data/doc/Mattock/RakeExampleGroup/Matchers.html +109 -0
  24. data/doc/Mattock/RakeExampleGroup/TaskManager.html +131 -0
  25. data/doc/Mattock/RemoteCommandTask.html +423 -0
  26. data/doc/Mattock/ShellEscaped.html +315 -0
  27. data/doc/Mattock/Task.html +181 -0
  28. data/doc/Mattock/TaskLib.html +755 -0
  29. data/doc/Mattock/TaskMixin.html +668 -0
  30. data/doc/Mattock/TaskMixin/ClassMethods.html +166 -0
  31. data/doc/Mattock/TemplateHost.html +320 -0
  32. data/doc/Mattock/ValiseManager.html +257 -0
  33. data/doc/Mattock/WrappingChain.html +221 -0
  34. data/doc/Mattock/YARDExtensions.html +110 -0
  35. data/doc/Mattock/YARDExtensions/DefineHandler.html +253 -0
  36. data/doc/Mattock/YARDExtensions/NilFieldsHandler.html +258 -0
  37. data/doc/Mattock/YARDExtensions/RequiredFieldsHandler.html +205 -0
  38. data/doc/Mattock/YARDExtensions/SettingHandler.html +529 -0
  39. data/doc/Mattock/YARDExtensions/SettingsHandler.html +207 -0
  40. data/doc/RSpecTest.html +233 -0
  41. data/doc/Ungemmer.html +282 -0
  42. data/doc/_index.html +435 -0
  43. data/doc/class_list.html +47 -0
  44. data/doc/css/common.css +1 -0
  45. data/doc/css/full_list.css +55 -0
  46. data/doc/css/style.css +322 -0
  47. data/doc/file.README.html +107 -0
  48. data/doc/file_list.html +49 -0
  49. data/doc/frames.html +13 -0
  50. data/doc/index.html +107 -0
  51. data/doc/js/app.js +205 -0
  52. data/doc/js/full_list.js +173 -0
  53. data/doc/js/jquery.js +16 -0
  54. data/doc/method_list.html +950 -0
  55. data/doc/top-level-namespace.html +107 -0
  56. data/lib/mattock/task.rb +12 -0
  57. data/lib/mattock/yard_extensions.rb +36 -0
  58. data/yard_templates/default/module/setup.rb +1 -0
  59. metadata +114 -4
data/doc/Mattock/CommandChain.html ADDED
@@ -0,0 +1,456 @@
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: Mattock::CommandChain
8
+
9
+ &mdash; Documentation by YARD 0.7.5
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (C)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Mattock.html" title="Mattock (module)">Mattock</a></span></span>
38
+ &raquo;
39
+ <span class="title">CommandChain</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Mattock::CommandChain
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName"><span class='object_link'><a href="CommandLine.html" title="Mattock::CommandLine (class)">CommandLine</a></span></span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next"><span class='object_link'><a href="CommandLine.html" title="Mattock::CommandLine (class)">CommandLine</a></span></li>
75
+
76
+ <li class="next">Mattock::CommandChain</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <dt class="r2 last">Defined in:</dt>
92
+ <dd class="r2 last">lib/mattock/command-line.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+
98
+ <div id="subclasses">
99
+ <h2>Direct Known Subclasses</h2>
100
+ <p class="children"><span class='object_link'><a href="PipelineChain.html" title="Mattock::PipelineChain (class)">PipelineChain</a></span>, <span class='object_link'><a href="PrereqChain.html" title="Mattock::PrereqChain (class)">PrereqChain</a></span>, <span class='object_link'><a href="WrappingChain.html" title="Mattock::WrappingChain (class)">WrappingChain</a></span></p>
101
+ </div>
102
+
103
+
104
+
105
+
106
+
107
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
108
+ <ul class="summary">
109
+
110
+ <li class="public ">
111
+ <span class="summary_signature">
112
+
113
+ <a href="#commands-instance_method" title="#commands (instance method)">- (Object) <strong>commands</strong> </a>
114
+
115
+
116
+
117
+ </span>
118
+
119
+
120
+ <span class="note title readonly">readonly</span>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+ <span class="summary_desc"><div class='inline'>
130
+ <p>Returns the value of attribute commands.</p>
131
+ </div></span>
132
+
133
+ </li>
134
+
135
+
136
+ </ul>
137
+
138
+
139
+
140
+
141
+
142
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="CommandLine.html" title="Mattock::CommandLine (class)">CommandLine</a></span></h3>
143
+ <p class="inherited"><span class='object_link'><a href="CommandLine.html#executable-instance_method" title="Mattock::CommandLine#executable (method)">#executable</a></span>, <span class='object_link'><a href="CommandLine.html#options-instance_method" title="Mattock::CommandLine#options (method)">#options</a></span></p>
144
+
145
+
146
+
147
+ <h2>
148
+ Instance Method Summary
149
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
150
+ </h2>
151
+
152
+ <ul class="summary">
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#add-instance_method" title="#add (instance method)">- (Object) <strong>add</strong>(cmd) {|cmd| ... }</a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+ <span class="summary_desc"><div class='inline'></div></span>
171
+
172
+ </li>
173
+
174
+
175
+ <li class="public ">
176
+ <span class="summary_signature">
177
+
178
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (CommandChain) <strong>initialize</strong> {|_self| ... }</a>
179
+
180
+
181
+
182
+ </span>
183
+
184
+ <span class="note title constructor">constructor</span>
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+ <span class="summary_desc"><div class='inline'>
194
+ <p>A new instance of CommandChain.</p>
195
+ </div></span>
196
+
197
+ </li>
198
+
199
+
200
+ <li class="public ">
201
+ <span class="summary_signature">
202
+
203
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
204
+
205
+
206
+
207
+ </span>
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'></div></span>
217
+
218
+ </li>
219
+
220
+
221
+ </ul>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="CommandLine.html" title="Mattock::CommandLine (class)">CommandLine</a></span></h3>
233
+ <p class="inherited"><span class='object_link'><a href="CommandLine.html#command-instance_method" title="Mattock::CommandLine#command (method)">#command</a></span>, <span class='object_link'><a href="CommandLine.html#copy_stream_to-instance_method" title="Mattock::CommandLine#copy_stream_to (method)">#copy_stream_to</a></span>, <span class='object_link'><a href="CommandLine.html#emit_recording-class_method" title="Mattock::CommandLine.emit_recording (method)">emit_recording</a></span>, <span class='object_link'><a href="CommandLine.html#execute-class_method" title="Mattock::CommandLine.execute (method)">execute</a></span>, <span class='object_link'><a href="CommandLine.html#must_succeed%21-instance_method" title="Mattock::CommandLine#must_succeed! (method)">#must_succeed!</a></span>, <span class='object_link'><a href="CommandLine.html#original_execute-class_method" title="Mattock::CommandLine.original_execute (method)">original_execute</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_from-instance_method" title="Mattock::CommandLine#redirect_from (method)">#redirect_from</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_stderr-instance_method" title="Mattock::CommandLine#redirect_stderr (method)">#redirect_stderr</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_stdin-instance_method" title="Mattock::CommandLine#redirect_stdin (method)">#redirect_stdin</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_stdout-instance_method" title="Mattock::CommandLine#redirect_stdout (method)">#redirect_stdout</a></span>, <span class='object_link'><a href="CommandLine.html#redirect_to-instance_method" title="Mattock::CommandLine#redirect_to (method)">#redirect_to</a></span>, <span class='object_link'><a href="CommandLine.html#run-instance_method" title="Mattock::CommandLine#run (method)">#run</a></span>, <span class='object_link'><a href="CommandLine.html#succeeds%3F-instance_method" title="Mattock::CommandLine#succeeds? (method)">#succeeds?</a></span>, <span class='object_link'><a href="CommandLine.html#verbose-instance_method" title="Mattock::CommandLine#verbose (method)">#verbose</a></span></p>
234
+ <div id="constructor_details" class="method_details_list">
235
+ <h2>Constructor Details</h2>
236
+
237
+ <div class="method_details first">
238
+ <p class="signature first" id="initialize-instance_method">
239
+
240
+ - (<tt><span class='object_link'><a href="" title="Mattock::CommandChain (class)">CommandChain</a></span></tt>) <strong>initialize</strong> {|_self| ... }
241
+
242
+
243
+
244
+ </p><div class="docstring">
245
+ <div class="discussion">
246
+
247
+ <p>A new instance of CommandChain</p>
248
+
249
+
250
+ </div>
251
+ </div>
252
+ <div class="tags">
253
+
254
+ <h3>Yields:</h3>
255
+ <ul class="yield">
256
+
257
+ <li>
258
+
259
+
260
+ <span class='type'>(<tt>_self</tt>)</span>
261
+
262
+
263
+
264
+ </li>
265
+
266
+ </ul>
267
+ <h3>Yield Parameters:</h3>
268
+ <ul class="yieldparam">
269
+
270
+ <li>
271
+
272
+ <span class='name'>_self</span>
273
+
274
+
275
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Mattock::CommandChain (class)">Mattock::CommandChain</a></span></tt>)</span>
276
+
277
+
278
+
279
+ &mdash;
280
+ <div class='inline'>
281
+ <p>the object that the method was called on</p>
282
+ </div>
283
+
284
+ </li>
285
+
286
+ </ul>
287
+
288
+ </div><table class="source_code">
289
+ <tr>
290
+ <td>
291
+ <pre class="lines">
292
+
293
+
294
+ 128
295
+ 129
296
+ 130
297
+ 131</pre>
298
+ </td>
299
+ <td>
300
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 128</span>
301
+
302
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
303
+ <span class='ivar'>@commands</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
304
+ <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
305
+ <span class='kw'>end</span></pre>
306
+ </td>
307
+ </tr>
308
+ </table>
309
+ </div>
310
+
311
+ </div>
312
+
313
+ <div id="instance_attr_details" class="attr_details">
314
+ <h2>Instance Attribute Details</h2>
315
+
316
+
317
+ <span id=""></span>
318
+ <span id="commands-instance_method"></span>
319
+ <div class="method_details first">
320
+ <p class="signature first" id="commands-instance_method">
321
+
322
+ - (<tt>Object</tt>) <strong>commands</strong> <span class="extras">(readonly)</span>
323
+
324
+
325
+
326
+ </p><div class="docstring">
327
+ <div class="discussion">
328
+
329
+ <p>Returns the value of attribute commands</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
+ 133
344
+ 134
345
+ 135</pre>
346
+ </td>
347
+ <td>
348
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 133</span>
349
+
350
+ <span class='kw'>def</span> <span class='id identifier rubyid_commands'>commands</span>
351
+ <span class='ivar'>@commands</span>
352
+ <span class='kw'>end</span></pre>
353
+ </td>
354
+ </tr>
355
+ </table>
356
+ </div>
357
+
358
+ </div>
359
+
360
+
361
+ <div id="instance_method_details" class="method_details_list">
362
+ <h2>Instance Method Details</h2>
363
+
364
+
365
+ <div class="method_details first">
366
+ <p class="signature first" id="add-instance_method">
367
+
368
+ - (<tt>Object</tt>) <strong>add</strong>(cmd) {|cmd| ... }
369
+
370
+
371
+
372
+ </p><div class="docstring">
373
+ <div class="discussion">
374
+
375
+
376
+ </div>
377
+ </div>
378
+ <div class="tags">
379
+
380
+ <h3>Yields:</h3>
381
+ <ul class="yield">
382
+
383
+ <li>
384
+
385
+
386
+ <span class='type'>(<tt>cmd</tt>)</span>
387
+
388
+
389
+
390
+ </li>
391
+
392
+ </ul>
393
+
394
+ </div><table class="source_code">
395
+ <tr>
396
+ <td>
397
+ <pre class="lines">
398
+
399
+
400
+ 135
401
+ 136
402
+ 137
403
+ 138</pre>
404
+ </td>
405
+ <td>
406
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 135</span>
407
+
408
+ <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>
409
+ <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>
410
+ <span class='ivar'>@commands</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_cmd'>cmd</span>
411
+ <span class='kw'>end</span></pre>
412
+ </td>
413
+ </tr>
414
+ </table>
415
+ </div>
416
+
417
+ <div class="method_details ">
418
+ <p class="signature " id="name-instance_method">
419
+
420
+ - (<tt>Object</tt>) <strong>name</strong>
421
+
422
+
423
+
424
+ </p><table class="source_code">
425
+ <tr>
426
+ <td>
427
+ <pre class="lines">
428
+
429
+
430
+ 140
431
+ 141
432
+ 142</pre>
433
+ </td>
434
+ <td>
435
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 140</span>
436
+
437
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
438
+ <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>
439
+ <span class='kw'>end</span></pre>
440
+ </td>
441
+ </tr>
442
+ </table>
443
+ </div>
444
+
445
+ </div>
446
+
447
+ </div>
448
+
449
+ <div id="footer">
450
+ Generated on Tue Mar 6 02:47:29 2012 by
451
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
452
+ 0.7.5 (ruby-1.9.2).
453
+ </div>
454
+
455
+ </body>
456
+ </html>