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/CommandTask.html ADDED
@@ -0,0 +1,464 @@
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::CommandTask
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">CommandTask</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::CommandTask
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="Task.html" title="Mattock::Task (class)">Task</a></span></span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Rake::Task</li>
75
+
76
+ <li class="next"><span class='object_link'><a href="Task.html" title="Mattock::Task (class)">Task</a></span></li>
77
+
78
+ <li class="next">Mattock::CommandTask</li>
79
+
80
+ </ul>
81
+ <a href="#" class="inheritanceTree">show all</a>
82
+
83
+ </dd>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2 last">Defined in:</dt>
94
+ <dd class="r2 last">lib/mattock/command-task.rb</dd>
95
+
96
+ </dl>
97
+ <div class="clear"></div>
98
+
99
+
100
+ <h2>Rake Tasks Defined</h2>
101
+ <pre class="code ruby"><span class='id identifier rubyid_decorated'>decorated</span><span class='lparen'>(</span><span class='id identifier rubyid_command'>command</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_must_succeed!'>must_succeed!</span></pre>
102
+
103
+ <div id="subclasses">
104
+ <h2>Direct Known Subclasses</h2>
105
+ <p class="children"><span class='object_link'><a href="RemoteCommandTask.html" title="Mattock::RemoteCommandTask (class)">RemoteCommandTask</a></span></p>
106
+ </div>
107
+
108
+ <h2>Constant Summary</h2>
109
+
110
+
111
+
112
+
113
+ <h2>Constant Summary</h2>
114
+
115
+ <h3 class="inherited">Constants included
116
+ from <span class='object_link'><a href="Configurable.html" title="Mattock::Configurable (module)">Configurable</a></span></h3>
117
+ <p class="inherited"><span class='object_link'><a href="Configurable.html#RequiredField-constant" title="Mattock::Configurable::RequiredField (constant)">Mattock::Configurable::RequiredField</a></span></p>
118
+
119
+
120
+ <h2>Instance Settings Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
121
+ <ul class="summary">
122
+
123
+ <li class="public ">
124
+ <span class="summary_signature">
125
+
126
+ <a href="#task_name-instance_method" title="#task_name (instance method)">- (Object) <strong>task_name</strong> </a>
127
+
128
+
129
+
130
+ </span>
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+ <span class="summary_desc"><div class='inline'>
140
+ <p>The value of setting task_name.</p>
141
+ </div></span>
142
+
143
+
144
+ <span class="summary_desc">Default value: <code>:run</code></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#command-instance_method" title="#command (instance method)">- (Object) <strong>command</strong> </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'>
166
+ <p>The value of setting command.</p>
167
+ </div></span>
168
+
169
+
170
+ <span class="summary_desc"><em>This setting must have a value set</em></span>
171
+
172
+ </li>
173
+
174
+
175
+ <li class="public ">
176
+ <span class="summary_signature">
177
+
178
+ <a href="#verify_command-instance_method" title="#verify_command (instance method)">- (Object) <strong>verify_command</strong> </a>
179
+
180
+
181
+
182
+ </span>
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <span class="summary_desc"><div class='inline'>
192
+ <p>The value of setting verify_command.</p>
193
+ </div></span>
194
+
195
+
196
+ <span class="summary_desc">Default value: <code>nil</code></span>
197
+
198
+ </li>
199
+
200
+
201
+ </ul>
202
+
203
+
204
+
205
+
206
+
207
+
208
+ <h2>
209
+ Instance Method Summary
210
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
211
+ </h2>
212
+
213
+ <ul class="summary">
214
+
215
+ <li class="public ">
216
+ <span class="summary_signature">
217
+
218
+ <a href="#action-instance_method" title="#action (instance method)">- (Object) <strong>action</strong> </a>
219
+
220
+
221
+
222
+ </span>
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'></div></span>
232
+
233
+ </li>
234
+
235
+
236
+ <li class="public ">
237
+ <span class="summary_signature">
238
+
239
+ <a href="#decorated-instance_method" title="#decorated (instance method)">- (Object) <strong>decorated</strong>(cmd) </a>
240
+
241
+
242
+
243
+ </span>
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <span class="summary_desc"><div class='inline'></div></span>
253
+
254
+ </li>
255
+
256
+
257
+ <li class="public ">
258
+ <span class="summary_signature">
259
+
260
+ <a href="#needed%3F-instance_method" title="#needed? (instance method)">- (Boolean) <strong>needed?</strong> </a>
261
+
262
+
263
+
264
+ </span>
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+ <span class="summary_desc"><div class='inline'></div></span>
274
+
275
+ </li>
276
+
277
+
278
+ </ul>
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="TaskMixin.html" title="Mattock::TaskMixin (module)">TaskMixin</a></span></h3>
295
+ <p class="inherited"><span class='object_link'><a href="TaskMixin.html#define-instance_method" title="Mattock::TaskMixin#define (method)">#define</a></span>, <span class='object_link'><a href="TaskMixin.html#included-class_method" title="Mattock::TaskMixin.included (method)">included</a></span>, <span class='object_link'><a href="TaskMixin.html#initialize-instance_method" title="Mattock::TaskMixin#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="TaskMixin.html#inspect-instance_method" title="Mattock::TaskMixin#inspect (method)">#inspect</a></span>, <span class='object_link'><a href="TaskMixin.html#resolve_configuration-instance_method" title="Mattock::TaskMixin#resolve_configuration (method)">#resolve_configuration</a></span>, <span class='object_link'><a href="TaskMixin.html#task_class-instance_method" title="Mattock::TaskMixin#task_class (method)">#task_class</a></span></p>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="CascadingDefinition.html" title="Mattock::CascadingDefinition (module)">CascadingDefinition</a></span></h3>
305
+ <p class="inherited"><span class='object_link'><a href="CascadingDefinition.html#confirm_configuration-instance_method" title="Mattock::CascadingDefinition#confirm_configuration (method)">#confirm_configuration</a></span>, <span class='object_link'><a href="CascadingDefinition.html#default_configuration-instance_method" title="Mattock::CascadingDefinition#default_configuration (method)">#default_configuration</a></span>, <span class='object_link'><a href="CascadingDefinition.html#define-instance_method" title="Mattock::CascadingDefinition#define (method)">#define</a></span>, <span class='object_link'><a href="CascadingDefinition.html#initialize-instance_method" title="Mattock::CascadingDefinition#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="CascadingDefinition.html#resolve_configuration-instance_method" title="Mattock::CascadingDefinition#resolve_configuration (method)">#resolve_configuration</a></span></p>
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Configurable.html" title="Mattock::Configurable (module)">Configurable</a></span></h3>
315
+ <p class="inherited"><span class='object_link'><a href="Configurable.html#check_required-instance_method" title="Mattock::Configurable#check_required (method)">#check_required</a></span>, <span class='object_link'><a href="Configurable.html#copy_settings_to-instance_method" title="Mattock::Configurable#copy_settings_to (method)">#copy_settings_to</a></span>, <span class='object_link'><a href="Configurable.html#nil_fields-instance_method" title="Mattock::Configurable#nil_fields (method)">#nil_fields</a></span>, <span class='object_link'><a href="Configurable.html#required_fields-instance_method" title="Mattock::Configurable#required_fields (method)">#required_fields</a></span>, <span class='object_link'><a href="Configurable.html#setting-instance_method" title="Mattock::Configurable#setting (method)">#setting</a></span>, <span class='object_link'><a href="Configurable.html#settings-instance_method" title="Mattock::Configurable#settings (method)">#settings</a></span>, <span class='object_link'><a href="Configurable.html#setup_defaults-instance_method" title="Mattock::Configurable#setup_defaults (method)">#setup_defaults</a></span>, <span class='object_link'><a href="Configurable.html#unset%3F-instance_method" title="Mattock::Configurable#unset? (method)">#unset?</a></span></p>
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Configurable/ClassMethods.html" title="Mattock::Configurable::ClassMethods (module)">Mattock::Configurable::ClassMethods</a></span></h3>
325
+ <p class="inherited"><span class='object_link'><a href="Configurable/ClassMethods.html#copy_settings-instance_method" title="Mattock::Configurable::ClassMethods#copy_settings (method)">#copy_settings</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#default_values-instance_method" title="Mattock::Configurable::ClassMethods#default_values (method)">#default_values</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#included-instance_method" title="Mattock::Configurable::ClassMethods#included (method)">#included</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#missing_required_fields_on-instance_method" title="Mattock::Configurable::ClassMethods#missing_required_fields_on (method)">#missing_required_fields_on</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#nested-instance_method" title="Mattock::Configurable::ClassMethods#nested (method)">#nested</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#nil_fields-instance_method" title="Mattock::Configurable::ClassMethods#nil_fields (method)">#nil_fields</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#required_fields-instance_method" title="Mattock::Configurable::ClassMethods#required_fields (method)">#required_fields</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#set_defaults_on-instance_method" title="Mattock::Configurable::ClassMethods#set_defaults_on (method)">#set_defaults_on</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#setting-instance_method" title="Mattock::Configurable::ClassMethods#setting (method)">#setting</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#settings-instance_method" title="Mattock::Configurable::ClassMethods#settings (method)">#settings</a></span></p>
326
+
327
+ <div id="constructor_details" class="method_details_list">
328
+ <h2>Constructor Details</h2>
329
+
330
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="TaskMixin.html#initialize-instance_method" title="Mattock::TaskMixin#initialize (method)">Mattock::TaskMixin</a></span></p>
331
+
332
+ </div>
333
+
334
+
335
+ <div id="instance_method_details" class="method_details_list">
336
+ <h2>Instance Method Details</h2>
337
+
338
+
339
+ <div class="method_details first">
340
+ <p class="signature first" id="action-instance_method">
341
+
342
+ - (<tt>Object</tt>) <strong>action</strong>
343
+
344
+
345
+
346
+ </p><table class="source_code">
347
+ <tr>
348
+ <td>
349
+ <pre class="lines">
350
+
351
+
352
+ 21
353
+ 22
354
+ 23</pre>
355
+ </td>
356
+ <td>
357
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-task.rb', line 21</span>
358
+
359
+ <span class='kw'>def</span> <span class='id identifier rubyid_action'>action</span>
360
+ <span class='id identifier rubyid_decorated'>decorated</span><span class='lparen'>(</span><span class='id identifier rubyid_command'>command</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_must_succeed!'>must_succeed!</span>
361
+ <span class='kw'>end</span></pre>
362
+ </td>
363
+ </tr>
364
+ </table>
365
+ </div>
366
+
367
+ <div class="method_details ">
368
+ <p class="signature " id="decorated-instance_method">
369
+
370
+ - (<tt>Object</tt>) <strong>decorated</strong>(cmd)
371
+
372
+
373
+
374
+ </p><table class="source_code">
375
+ <tr>
376
+ <td>
377
+ <pre class="lines">
378
+
379
+
380
+ 17
381
+ 18
382
+ 19</pre>
383
+ </td>
384
+ <td>
385
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-task.rb', line 17</span>
386
+
387
+ <span class='kw'>def</span> <span class='id identifier rubyid_decorated'>decorated</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
388
+ <span class='id identifier rubyid_cmd'>cmd</span>
389
+ <span class='kw'>end</span></pre>
390
+ </td>
391
+ </tr>
392
+ </table>
393
+ </div>
394
+
395
+ <div class="method_details ">
396
+ <p class="signature " id="needed?-instance_method">
397
+
398
+ - (<tt>Boolean</tt>) <strong>needed?</strong>
399
+
400
+
401
+
402
+ </p><div class="docstring">
403
+ <div class="discussion">
404
+
405
+
406
+ </div>
407
+ </div>
408
+ <div class="tags">
409
+
410
+ <h3>Returns:</h3>
411
+ <ul class="return">
412
+
413
+ <li>
414
+
415
+
416
+ <span class='type'>(<tt>Boolean</tt>)</span>
417
+
418
+
419
+
420
+ </li>
421
+
422
+ </ul>
423
+
424
+ </div><table class="source_code">
425
+ <tr>
426
+ <td>
427
+ <pre class="lines">
428
+
429
+
430
+ 25
431
+ 26
432
+ 27
433
+ 28
434
+ 29
435
+ 30
436
+ 31</pre>
437
+ </td>
438
+ <td>
439
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-task.rb', line 25</span>
440
+
441
+ <span class='kw'>def</span> <span class='id identifier rubyid_needed?'>needed?</span>
442
+ <span class='kw'>unless</span> <span class='id identifier rubyid_verify_command'>verify_command</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
443
+ <span class='op'>!</span><span class='id identifier rubyid_decorated'>decorated</span><span class='lparen'>(</span><span class='id identifier rubyid_verify_command'>verify_command</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_succeeds?'>succeeds?</span>
444
+ <span class='kw'>else</span>
445
+ <span class='kw'>super</span>
446
+ <span class='kw'>end</span>
447
+ <span class='kw'>end</span></pre>
448
+ </td>
449
+ </tr>
450
+ </table>
451
+ </div>
452
+
453
+ </div>
454
+
455
+ </div>
456
+
457
+ <div id="footer">
458
+ Generated on Tue Mar 6 02:47:29 2012 by
459
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
460
+ 0.7.5 (ruby-1.9.2).
461
+ </div>
462
+
463
+ </body>
464
+ </html>