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/FileSandbox/SandboxFile.html ADDED
@@ -0,0 +1,622 @@
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: FileSandbox::SandboxFile
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 (S)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../FileSandbox.html" title="FileSandbox (module)">FileSandbox</a></span></span>
38
+ &raquo;
39
+ <span class="title">SandboxFile</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: FileSandbox::SandboxFile
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">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">FileSandbox::SandboxFile</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <dt class="r2 last">Defined in:</dt>
90
+ <dd class="r2 last">spec_help/file-sandbox.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+
96
+
97
+
98
+
99
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
100
+ <ul class="summary">
101
+
102
+ <li class="public ">
103
+ <span class="summary_signature">
104
+
105
+ <a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong> </a>
106
+
107
+
108
+
109
+ </span>
110
+
111
+
112
+ <span class="note title readonly">readonly</span>
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+ <span class="summary_desc"><div class='inline'>
122
+ <p>Returns the value of attribute path.</p>
123
+ </div></span>
124
+
125
+ </li>
126
+
127
+
128
+ </ul>
129
+
130
+
131
+
132
+
133
+
134
+ <h2>
135
+ Instance Method Summary
136
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
137
+ </h2>
138
+
139
+ <ul class="summary">
140
+
141
+ <li class="public ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#binary_content%3D-instance_method" title="#binary_content= (instance method)">- (Object) <strong>binary_content=</strong>(content) </a>
145
+
146
+
147
+
148
+ (also: #binary_contents=)
149
+
150
+ </span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'></div></span>
160
+
161
+ </li>
162
+
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#content-instance_method" title="#content (instance method)">- (Object) <strong>content</strong> </a>
168
+
169
+
170
+
171
+ (also: #contents)
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="#content%3D-instance_method" title="#content= (instance method)">- (Object) <strong>content=</strong>(content) </a>
191
+
192
+
193
+
194
+ (also: #contents=)
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'></div></span>
206
+
207
+ </li>
208
+
209
+
210
+ <li class="public ">
211
+ <span class="summary_signature">
212
+
213
+ <a href="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</strong> </a>
214
+
215
+
216
+
217
+ </span>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <span class="summary_desc"><div class='inline'></div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#exist%3F-instance_method" title="#exist? (instance method)">- (Boolean) <strong>exist?</strong> </a>
235
+
236
+
237
+
238
+ (also: #exists?)
239
+
240
+ </span>
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <span class="summary_desc"><div class='inline'></div></span>
250
+
251
+ </li>
252
+
253
+
254
+ <li class="public ">
255
+ <span class="summary_signature">
256
+
257
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (SandboxFile) <strong>initialize</strong>(path, sandbox_path) </a>
258
+
259
+
260
+
261
+ </span>
262
+
263
+ <span class="note title constructor">constructor</span>
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'>
273
+ <p>A new instance of SandboxFile.</p>
274
+ </div></span>
275
+
276
+ </li>
277
+
278
+
279
+ <li class="public ">
280
+ <span class="summary_signature">
281
+
282
+ <a href="#inspect-instance_method" title="#inspect (instance method)">- (Object) <strong>inspect</strong> </a>
283
+
284
+
285
+
286
+ </span>
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <span class="summary_desc"><div class='inline'></div></span>
296
+
297
+ </li>
298
+
299
+
300
+ </ul>
301
+
302
+
303
+ <div id="constructor_details" class="method_details_list">
304
+ <h2>Constructor Details</h2>
305
+
306
+ <div class="method_details first">
307
+ <p class="signature first" id="initialize-instance_method">
308
+
309
+ - (<tt><span class='object_link'><a href="" title="FileSandbox::SandboxFile (class)">SandboxFile</a></span></tt>) <strong>initialize</strong>(path, sandbox_path)
310
+
311
+
312
+
313
+ </p><div class="docstring">
314
+ <div class="discussion">
315
+
316
+ <p>A new instance of SandboxFile</p>
317
+
318
+
319
+ </div>
320
+ </div>
321
+ <div class="tags">
322
+
323
+
324
+ </div><table class="source_code">
325
+ <tr>
326
+ <td>
327
+ <pre class="lines">
328
+
329
+
330
+ 128
331
+ 129
332
+ 130
333
+ 131</pre>
334
+ </td>
335
+ <td>
336
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 128</span>
337
+
338
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_sandbox_path'>sandbox_path</span><span class='rparen'>)</span>
339
+ <span class='ivar'>@path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
340
+ <span class='ivar'>@sandbox_path</span> <span class='op'>=</span> <span class='id identifier rubyid_sandbox_path'>sandbox_path</span>
341
+ <span class='kw'>end</span></pre>
342
+ </td>
343
+ </tr>
344
+ </table>
345
+ </div>
346
+
347
+ </div>
348
+
349
+ <div id="instance_attr_details" class="attr_details">
350
+ <h2>Instance Attribute Details</h2>
351
+
352
+
353
+ <span id=""></span>
354
+ <span id="path-instance_method"></span>
355
+ <div class="method_details first">
356
+ <p class="signature first" id="path-instance_method">
357
+
358
+ - (<tt>Object</tt>) <strong>path</strong> <span class="extras">(readonly)</span>
359
+
360
+
361
+
362
+ </p><div class="docstring">
363
+ <div class="discussion">
364
+
365
+ <p>Returns the value of attribute path</p>
366
+
367
+
368
+ </div>
369
+ </div>
370
+ <div class="tags">
371
+
372
+
373
+ </div><table class="source_code">
374
+ <tr>
375
+ <td>
376
+ <pre class="lines">
377
+
378
+
379
+ 126
380
+ 127
381
+ 128</pre>
382
+ </td>
383
+ <td>
384
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 126</span>
385
+
386
+ <span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
387
+ <span class='ivar'>@path</span>
388
+ <span class='kw'>end</span></pre>
389
+ </td>
390
+ </tr>
391
+ </table>
392
+ </div>
393
+
394
+ </div>
395
+
396
+
397
+ <div id="instance_method_details" class="method_details_list">
398
+ <h2>Instance Method Details</h2>
399
+
400
+
401
+ <div class="method_details first">
402
+ <p class="signature first" id="binary_content=-instance_method">
403
+
404
+ - (<tt>Object</tt>) <strong>binary_content=</strong>(content)
405
+
406
+
407
+
408
+ <span class="aliases">Also known as:
409
+ <span class="names"><span id='binary_contents=-instance_method'>binary_contents=</span></span>
410
+ </span>
411
+
412
+ </p><table class="source_code">
413
+ <tr>
414
+ <td>
415
+ <pre class="lines">
416
+
417
+
418
+ 150
419
+ 151
420
+ 152
421
+ 153</pre>
422
+ </td>
423
+ <td>
424
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 150</span>
425
+
426
+ <span class='kw'>def</span> <span class='id identifier rubyid_binary_content='>binary_content=</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
427
+ <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_mkdir_p'>mkdir_p</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='ivar'>@path</span><span class='rparen'>)</span>
428
+ <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='ivar'>@path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wb</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='id identifier rubyid_f'>f</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_content'>content</span><span class='rbrace'>}</span>
429
+ <span class='kw'>end</span></pre>
430
+ </td>
431
+ </tr>
432
+ </table>
433
+ </div>
434
+
435
+ <div class="method_details ">
436
+ <p class="signature " id="content-instance_method">
437
+
438
+ - (<tt>Object</tt>) <strong>content</strong>
439
+
440
+
441
+
442
+ <span class="aliases">Also known as:
443
+ <span class="names"><span id='contents-instance_method'>contents</span></span>
444
+ </span>
445
+
446
+ </p><table class="source_code">
447
+ <tr>
448
+ <td>
449
+ <pre class="lines">
450
+
451
+
452
+ 141
453
+ 142
454
+ 143</pre>
455
+ </td>
456
+ <td>
457
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 141</span>
458
+
459
+ <span class='kw'>def</span> <span class='id identifier rubyid_content'>content</span>
460
+ <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span> <span class='id identifier rubyid_path'>path</span>
461
+ <span class='kw'>end</span></pre>
462
+ </td>
463
+ </tr>
464
+ </table>
465
+ </div>
466
+
467
+ <div class="method_details ">
468
+ <p class="signature " id="content=-instance_method">
469
+
470
+ - (<tt>Object</tt>) <strong>content=</strong>(content)
471
+
472
+
473
+
474
+ <span class="aliases">Also known as:
475
+ <span class="names"><span id='contents=-instance_method'>contents=</span></span>
476
+ </span>
477
+
478
+ </p><table class="source_code">
479
+ <tr>
480
+ <td>
481
+ <pre class="lines">
482
+
483
+
484
+ 145
485
+ 146
486
+ 147
487
+ 148</pre>
488
+ </td>
489
+ <td>
490
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 145</span>
491
+
492
+ <span class='kw'>def</span> <span class='id identifier rubyid_content='>content=</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
493
+ <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_mkdir_p'>mkdir_p</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='ivar'>@path</span><span class='rparen'>)</span>
494
+ <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='ivar'>@path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>w</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='id identifier rubyid_f'>f</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_content'>content</span><span class='rbrace'>}</span>
495
+ <span class='kw'>end</span></pre>
496
+ </td>
497
+ </tr>
498
+ </table>
499
+ </div>
500
+
501
+ <div class="method_details ">
502
+ <p class="signature " id="create-instance_method">
503
+
504
+ - (<tt>Object</tt>) <strong>create</strong>
505
+
506
+
507
+
508
+ </p><table class="source_code">
509
+ <tr>
510
+ <td>
511
+ <pre class="lines">
512
+
513
+
514
+ 155
515
+ 156
516
+ 157</pre>
517
+ </td>
518
+ <td>
519
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 155</span>
520
+
521
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
522
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
523
+ <span class='kw'>end</span></pre>
524
+ </td>
525
+ </tr>
526
+ </table>
527
+ </div>
528
+
529
+ <div class="method_details ">
530
+ <p class="signature " id="exist?-instance_method">
531
+
532
+ - (<tt>Boolean</tt>) <strong>exist?</strong>
533
+
534
+
535
+
536
+ <span class="aliases">Also known as:
537
+ <span class="names"><span id='exists?-instance_method'>exists?</span></span>
538
+ </span>
539
+
540
+ </p><div class="docstring">
541
+ <div class="discussion">
542
+
543
+
544
+ </div>
545
+ </div>
546
+ <div class="tags">
547
+
548
+ <h3>Returns:</h3>
549
+ <ul class="return">
550
+
551
+ <li>
552
+
553
+
554
+ <span class='type'>(<tt>Boolean</tt>)</span>
555
+
556
+
557
+
558
+ </li>
559
+
560
+ </ul>
561
+
562
+ </div><table class="source_code">
563
+ <tr>
564
+ <td>
565
+ <pre class="lines">
566
+
567
+
568
+ 137
569
+ 138
570
+ 139</pre>
571
+ </td>
572
+ <td>
573
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 137</span>
574
+
575
+ <span class='kw'>def</span> <span class='id identifier rubyid_exist?'>exist?</span>
576
+ <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span> <span class='id identifier rubyid_path'>path</span>
577
+ <span class='kw'>end</span></pre>
578
+ </td>
579
+ </tr>
580
+ </table>
581
+ </div>
582
+
583
+ <div class="method_details ">
584
+ <p class="signature " id="inspect-instance_method">
585
+
586
+ - (<tt>Object</tt>) <strong>inspect</strong>
587
+
588
+
589
+
590
+ </p><table class="source_code">
591
+ <tr>
592
+ <td>
593
+ <pre class="lines">
594
+
595
+
596
+ 133
597
+ 134
598
+ 135</pre>
599
+ </td>
600
+ <td>
601
+ <pre class="code"><span class="info file"># File 'spec_help/file-sandbox.rb', line 133</span>
602
+
603
+ <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
604
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>SandboxFile: </span><span class='embvar'>#</span><span class='ivar'>@sandbox_path</span><span class='tstring_end'>&quot;</span></span>
605
+ <span class='kw'>end</span></pre>
606
+ </td>
607
+ </tr>
608
+ </table>
609
+ </div>
610
+
611
+ </div>
612
+
613
+ </div>
614
+
615
+ <div id="footer">
616
+ Generated on Mon Mar 5 23:15:39 2012 by
617
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
618
+ 0.7.5 (ruby-1.9.2).
619
+ </div>
620
+
621
+ </body>
622
+ </html>