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
@@ -0,0 +1,537 @@
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
+ Module: FileSandbox
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 (F)</a> &raquo;
37
+
38
+
39
+ <span class="title">FileSandbox</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>Module: FileSandbox
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <dt class="r1 last">Defined in:</dt>
75
+ <dd class="r1 last">spec_help/file-sandbox.rb</dd>
76
+
77
+ </dl>
78
+ <div class="clear"></div>
79
+
80
+ <h2>Defined Under Namespace</h2>
81
+ <p class="children">
82
+
83
+
84
+
85
+
86
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="FileSandbox/HaveContents.html" title="FileSandbox::HaveContents (class)">HaveContents</a></span>, <span class='object_link'><a href="FileSandbox/Sandbox.html" title="FileSandbox::Sandbox (class)">Sandbox</a></span>, <span class='object_link'><a href="FileSandbox/SandboxFile.html" title="FileSandbox::SandboxFile (class)">SandboxFile</a></span>
87
+
88
+
89
+ </p>
90
+
91
+
92
+
93
+
94
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
95
+ <ul class="summary">
96
+
97
+ <li class="public ">
98
+ <span class="summary_signature">
99
+
100
+ <a href="#sandbox-instance_method" title="#sandbox (instance method)">- (Object) <strong>sandbox</strong> </a>
101
+
102
+
103
+
104
+ </span>
105
+
106
+
107
+ <span class="note title readonly">readonly</span>
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+ <span class="summary_desc"><div class='inline'>
117
+ <p>Returns the value of attribute sandbox.</p>
118
+ </div></span>
119
+
120
+ </li>
121
+
122
+
123
+ </ul>
124
+
125
+
126
+
127
+
128
+
129
+ <h2>
130
+ Class Method Summary
131
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
132
+ </h2>
133
+
134
+ <ul class="summary">
135
+
136
+ <li class="public ">
137
+ <span class="summary_signature">
138
+
139
+ <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(spec) </a>
140
+
141
+
142
+
143
+ </span>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <span class="summary_desc"><div class='inline'></div></span>
153
+
154
+ </li>
155
+
156
+
157
+ </ul>
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="#have_contents-instance_method" title="#have_contents (instance method)">- (Object) <strong>have_contents</strong>(expected) </a>
170
+
171
+
172
+
173
+ </span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'></div></span>
183
+
184
+ </li>
185
+
186
+
187
+ <li class="public ">
188
+ <span class="summary_signature">
189
+
190
+ <a href="#in_sandbox-instance_method" title="#in_sandbox (instance method)">- (Object) <strong>in_sandbox</strong>(&amp;block) </a>
191
+
192
+
193
+
194
+ </span>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <span class="summary_desc"><div class='inline'></div></span>
204
+
205
+ </li>
206
+
207
+
208
+ <li class="public ">
209
+ <span class="summary_signature">
210
+
211
+ <a href="#setup_sandbox-instance_method" title="#setup_sandbox (instance method)">- (Object) <strong>setup_sandbox</strong>(path = '__sandbox') </a>
212
+
213
+
214
+
215
+ </span>
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <span class="summary_desc"><div class='inline'></div></span>
225
+
226
+ </li>
227
+
228
+
229
+ <li class="public ">
230
+ <span class="summary_signature">
231
+
232
+ <a href="#teardown_sandbox-instance_method" title="#teardown_sandbox (instance method)">- (Object) <strong>teardown_sandbox</strong> </a>
233
+
234
+
235
+
236
+ </span>
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'></div></span>
246
+
247
+ </li>
248
+
249
+
250
+ </ul>
251
+
252
+
253
+
254
+ <div id="instance_attr_details" class="attr_details">
255
+ <h2>Instance Attribute Details</h2>
256
+
257
+
258
+ <span id=""></span>
259
+ <span id="sandbox-instance_method"></span>
260
+ <div class="method_details first">
261
+ <p class="signature first" id="sandbox-instance_method">
262
+
263
+ - (<tt>Object</tt>) <strong>sandbox</strong> <span class="extras">(readonly)</span>
264
+
265
+
266
+
267
+ </p><div class="docstring">
268
+ <div class="discussion">
269
+
270
+ <p>Returns the value of attribute sandbox</p>
271
+
272
+
273
+ </div>
274
+ </div>
275
+ <div class="tags">
276
+
277
+
278
+ </div><table class="source_code">
279
+ <tr>
280
+ <td>
281
+ <pre class="lines">
282
+
283
+
284
+ 36
285
+ 37
286
+ 38</pre>
287
+ </td>
288
+ <td>
289
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 36</span>
290
+
291
+ <span class='kw'>def</span> <span class='id identifier rubyid_sandbox'>sandbox</span>
292
+ <span class='ivar'>@sandbox</span>
293
+ <span class='kw'>end</span></pre>
294
+ </td>
295
+ </tr>
296
+ </table>
297
+ </div>
298
+
299
+ </div>
300
+
301
+
302
+ <div id="class_method_details" class="method_details_list">
303
+ <h2>Class Method Details</h2>
304
+
305
+
306
+ <div class="method_details first">
307
+ <p class="signature first" id="included-class_method">
308
+
309
+ + (<tt>Object</tt>) <strong>included</strong>(spec)
310
+
311
+
312
+
313
+ </p><table class="source_code">
314
+ <tr>
315
+ <td>
316
+ <pre class="lines">
317
+
318
+
319
+ 5
320
+ 6
321
+ 7
322
+ 8
323
+ 9
324
+ 10
325
+ 11
326
+ 12
327
+ 13
328
+ 14
329
+ 15</pre>
330
+ </td>
331
+ <td>
332
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 5</span>
333
+
334
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_spec'>spec</span><span class='rparen'>)</span>
335
+ <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_spec'>spec</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span> <span class='symbol'>:before</span>
336
+
337
+ <span class='id identifier rubyid_spec'>spec</span><span class='period'>.</span><span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
338
+ <span class='id identifier rubyid_setup_sandbox'>setup_sandbox</span>
339
+ <span class='kw'>end</span>
340
+
341
+ <span class='id identifier rubyid_spec'>spec</span><span class='period'>.</span><span class='id identifier rubyid_after'>after</span> <span class='kw'>do</span>
342
+ <span class='id identifier rubyid_teardown_sandbox'>teardown_sandbox</span>
343
+ <span class='kw'>end</span>
344
+ <span class='kw'>end</span></pre>
345
+ </td>
346
+ </tr>
347
+ </table>
348
+ </div>
349
+
350
+ </div>
351
+
352
+ <div id="instance_method_details" class="method_details_list">
353
+ <h2>Instance Method Details</h2>
354
+
355
+
356
+ <div class="method_details first">
357
+ <p class="signature first" id="have_contents-instance_method">
358
+
359
+ - (<tt>Object</tt>) <strong>have_contents</strong>(expected)
360
+
361
+
362
+
363
+ </p><table class="source_code">
364
+ <tr>
365
+ <td>
366
+ <pre class="lines">
367
+
368
+
369
+ 32
370
+ 33
371
+ 34</pre>
372
+ </td>
373
+ <td>
374
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 32</span>
375
+
376
+ <span class='kw'>def</span> <span class='id identifier rubyid_have_contents'>have_contents</span><span class='lparen'>(</span><span class='id identifier rubyid_expected'>expected</span><span class='rparen'>)</span>
377
+ <span class='const'>HaveContents</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_expected'>expected</span><span class='rparen'>)</span>
378
+ <span class='kw'>end</span></pre>
379
+ </td>
380
+ </tr>
381
+ </table>
382
+ </div>
383
+
384
+ <div class="method_details ">
385
+ <p class="signature " id="in_sandbox-instance_method">
386
+
387
+ - (<tt>Object</tt>) <strong>in_sandbox</strong>(&amp;block)
388
+
389
+
390
+
391
+ </p><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 38
398
+ 39
399
+ 40
400
+ 41
401
+ 42
402
+ 43
403
+ 44
404
+ 45
405
+ 46
406
+ 47
407
+ 48
408
+ 49
409
+ 50
410
+ 51
411
+ 52
412
+ 53
413
+ 54
414
+ 55
415
+ 56
416
+ 57
417
+ 58
418
+ 59
419
+ 60
420
+ 61</pre>
421
+ </td>
422
+ <td>
423
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 38</span>
424
+
425
+ <span class='kw'>def</span> <span class='id identifier rubyid_in_sandbox'>in_sandbox</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
426
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>I expected to create a sandbox as you passed in a block to me</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_block_given?'>block_given?</span>
427
+
428
+ <span class='id identifier rubyid_setup_sandbox'>setup_sandbox</span>
429
+ <span class='id identifier rubyid_original_error'>original_error</span> <span class='op'>=</span> <span class='kw'>nil</span>
430
+
431
+ <span class='kw'>begin</span>
432
+ <span class='kw'>yield</span> <span class='ivar'>@sandbox</span>
433
+ <span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
434
+ <span class='id identifier rubyid_original_error'>original_error</span> <span class='op'>=</span> <span class='id identifier rubyid_e'>e</span>
435
+ <span class='id identifier rubyid_raise'>raise</span>
436
+ <span class='kw'>ensure</span>
437
+ <span class='kw'>begin</span>
438
+ <span class='id identifier rubyid_teardown_sandbox'>teardown_sandbox</span>
439
+ <span class='kw'>rescue</span>
440
+ <span class='kw'>if</span> <span class='id identifier rubyid_original_error'>original_error</span>
441
+ <span class='const'>STDERR</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ALERT: a test raised an error and failed to release some lock(s) in the sandbox directory</span><span class='tstring_end'>&quot;</span></span>
442
+ <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='id identifier rubyid_original_error'>original_error</span><span class='rparen'>)</span>
443
+ <span class='kw'>else</span>
444
+ <span class='id identifier rubyid_raise'>raise</span>
445
+ <span class='kw'>end</span>
446
+ <span class='kw'>end</span>
447
+ <span class='kw'>end</span>
448
+ <span class='kw'>end</span></pre>
449
+ </td>
450
+ </tr>
451
+ </table>
452
+ </div>
453
+
454
+ <div class="method_details ">
455
+ <p class="signature " id="setup_sandbox-instance_method">
456
+
457
+ - (<tt>Object</tt>) <strong>setup_sandbox</strong>(path = '__sandbox')
458
+
459
+
460
+
461
+ </p><table class="source_code">
462
+ <tr>
463
+ <td>
464
+ <pre class="lines">
465
+
466
+
467
+ 63
468
+ 64
469
+ 65
470
+ 66
471
+ 67
472
+ 68
473
+ 69</pre>
474
+ </td>
475
+ <td>
476
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 63</span>
477
+
478
+ <span class='kw'>def</span> <span class='id identifier rubyid_setup_sandbox'>setup_sandbox</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>__sandbox</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
479
+ <span class='kw'>unless</span> <span class='ivar'>@sandbox</span>
480
+ <span class='ivar'>@sandbox</span> <span class='op'>=</span> <span class='const'>Sandbox</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
481
+ <span class='ivar'>@__old_path_for_sandbox</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span>
482
+ <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_chdir'>chdir</span><span class='lparen'>(</span><span class='ivar'>@sandbox</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span>
483
+ <span class='kw'>end</span>
484
+ <span class='kw'>end</span></pre>
485
+ </td>
486
+ </tr>
487
+ </table>
488
+ </div>
489
+
490
+ <div class="method_details ">
491
+ <p class="signature " id="teardown_sandbox-instance_method">
492
+
493
+ - (<tt>Object</tt>) <strong>teardown_sandbox</strong>
494
+
495
+
496
+
497
+ </p><table class="source_code">
498
+ <tr>
499
+ <td>
500
+ <pre class="lines">
501
+
502
+
503
+ 71
504
+ 72
505
+ 73
506
+ 74
507
+ 75
508
+ 76
509
+ 77</pre>
510
+ </td>
511
+ <td>
512
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 71</span>
513
+
514
+ <span class='kw'>def</span> <span class='id identifier rubyid_teardown_sandbox'>teardown_sandbox</span>
515
+ <span class='kw'>if</span> <span class='ivar'>@sandbox</span>
516
+ <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_chdir'>chdir</span><span class='lparen'>(</span><span class='ivar'>@__old_path_for_sandbox</span><span class='rparen'>)</span>
517
+ <span class='ivar'>@sandbox</span><span class='period'>.</span><span class='id identifier rubyid_clean_up'>clean_up</span>
518
+ <span class='ivar'>@sandbox</span> <span class='op'>=</span> <span class='kw'>nil</span>
519
+ <span class='kw'>end</span>
520
+ <span class='kw'>end</span></pre>
521
+ </td>
522
+ </tr>
523
+ </table>
524
+ </div>
525
+
526
+ </div>
527
+
528
+ </div>
529
+
530
+ <div id="footer">
531
+ Generated on Mon Mar 5 23:15:39 2012 by
532
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
533
+ 0.7.5 (ruby-1.9.2).
534
+ </div>
535
+
536
+ </body>
537
+ </html>