mattock 0.2.2 → 0.2.3

Sign up to get free protection for your applications and to get access to all the features.
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/RakeExampleGroup/Matchers.html ADDED
@@ -0,0 +1,109 @@
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: Mattock::RakeExampleGroup::Matchers
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 (M)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Mattock.html" title="Mattock (module)">Mattock</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../RakeExampleGroup.html" title="Mattock::RakeExampleGroup (module)">RakeExampleGroup</a></span></span>
38
+ &raquo;
39
+ <span class="title">Matchers</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: Mattock::RakeExampleGroup::Matchers
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+ <dt class="r1">Extended by:</dt>
70
+ <dd class="r1">RSpec::Matchers::DSL</dd>
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dt class="r2">Included in:</dt>
78
+ <dd class="r2"><span class='object_link'><a href="../RakeExampleGroup.html" title="Mattock::RakeExampleGroup (module)">Mattock::RakeExampleGroup</a></span></dd>
79
+
80
+
81
+
82
+ <dt class="r1 last">Defined in:</dt>
83
+ <dd class="r1 last">lib/mattock/testing/rake-example-group.rb</dd>
84
+
85
+ </dl>
86
+ <div class="clear"></div>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+ </div>
101
+
102
+ <div id="footer">
103
+ Generated on Tue Mar 6 02:47:31 2012 by
104
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
105
+ 0.7.5 (ruby-1.9.2).
106
+ </div>
107
+
108
+ </body>
109
+ </html>
data/doc/Mattock/RakeExampleGroup/TaskManager.html ADDED
@@ -0,0 +1,131 @@
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::RakeExampleGroup::TaskManager
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 (T)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Mattock.html" title="Mattock (module)">Mattock</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../RakeExampleGroup.html" title="Mattock::RakeExampleGroup (module)">RakeExampleGroup</a></span></span>
38
+ &raquo;
39
+ <span class="title">TaskManager</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::RakeExampleGroup::TaskManager
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">Mattock::RakeExampleGroup::TaskManager</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+ <dt class="r2">Includes:</dt>
87
+ <dd class="r2">Rake::TaskManager</dd>
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r1 last">Defined in:</dt>
94
+ <dd class="r1 last">lib/mattock/testing/rake-example-group.rb</dd>
95
+
96
+ </dl>
97
+ <div class="clear"></div>
98
+
99
+ <h2>Overview</h2><div class="docstring">
100
+ <div class="discussion">
101
+
102
+ <p>include FileUtils</p>
103
+
104
+
105
+ </div>
106
+ </div>
107
+ <div class="tags">
108
+
109
+
110
+ </div>
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+ </div>
123
+
124
+ <div id="footer">
125
+ Generated on Tue Mar 6 02:47:31 2012 by
126
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
127
+ 0.7.5 (ruby-1.9.2).
128
+ </div>
129
+
130
+ </body>
131
+ </html>
data/doc/Mattock/RemoteCommandTask.html ADDED
@@ -0,0 +1,423 @@
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::RemoteCommandTask
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 (R)</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">RemoteCommandTask</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::RemoteCommandTask
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="CommandTask.html" title="Mattock::CommandTask (class)">CommandTask</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"><span class='object_link'><a href="CommandTask.html" title="Mattock::CommandTask (class)">CommandTask</a></span></li>
79
+
80
+ <li class="next">Mattock::RemoteCommandTask</li>
81
+
82
+ </ul>
83
+ <a href="#" class="inheritanceTree">show all</a>
84
+
85
+ </dd>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dt class="r2 last">Defined in:</dt>
96
+ <dd class="r2 last">lib/mattock/remote-command-task.rb</dd>
97
+
98
+ </dl>
99
+ <div class="clear"></div>
100
+
101
+
102
+
103
+ <h2>Constant Summary</h2>
104
+
105
+
106
+
107
+
108
+ <h2>Constant Summary</h2>
109
+
110
+ <h3 class="inherited">Constants included
111
+ from <span class='object_link'><a href="Configurable.html" title="Mattock::Configurable (module)">Configurable</a></span></h3>
112
+ <p class="inherited"><span class='object_link'><a href="Configurable.html#RequiredField-constant" title="Mattock::Configurable::RequiredField (constant)">Configurable::RequiredField</a></span></p>
113
+
114
+
115
+ <h2>Instance Settings Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
116
+ <ul class="summary">
117
+
118
+ <li class="public ">
119
+ <span class="summary_signature">
120
+
121
+ <a href="#remote_server.address-instance_method" title="#remote_server.address (instance method)">- (Object) <strong>remote_server.address</strong> </a>
122
+
123
+
124
+
125
+ </span>
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>The value of setting remote_server.address.</p>
136
+ </div></span>
137
+
138
+
139
+ <span class="summary_desc">Default value: <code>"localhost"</code></span>
140
+
141
+ </li>
142
+
143
+
144
+ <li class="public ">
145
+ <span class="summary_signature">
146
+
147
+ <a href="#remote_server.user-instance_method" title="#remote_server.user (instance method)">- (Object) <strong>remote_server.user</strong> </a>
148
+
149
+
150
+
151
+ </span>
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'>
161
+ <p>The value of setting remote_server.user.</p>
162
+ </div></span>
163
+
164
+
165
+ <span class="summary_desc">Default value: <code>nil</code></span>
166
+
167
+ </li>
168
+
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#ssh_options-instance_method" title="#ssh_options (instance method)">- (Object) <strong>ssh_options</strong> </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ <span class="summary_desc"><div class='inline'>
187
+ <p>The value of setting ssh_options.</p>
188
+ </div></span>
189
+
190
+
191
+ <span class="summary_desc">Default value: <code>[]</code></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#id_file-instance_method" title="#id_file (instance method)">- (Object) <strong>id_file</strong> </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>The value of setting id_file.</p>
214
+ </div></span>
215
+
216
+
217
+ <span class="summary_desc">Default value: <code>nil</code></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#free_arguments-instance_method" title="#free_arguments (instance method)">- (Object) <strong>free_arguments</strong> </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+ <span class="summary_desc"><div class='inline'>
239
+ <p>The value of setting free_arguments.</p>
240
+ </div></span>
241
+
242
+
243
+ <span class="summary_desc">Default value: <code>nil</code></span>
244
+
245
+ </li>
246
+
247
+
248
+ </ul>
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <h2>
256
+ Instance Method Summary
257
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
258
+ </h2>
259
+
260
+ <ul class="summary">
261
+
262
+ <li class="public ">
263
+ <span class="summary_signature">
264
+
265
+ <a href="#decorated-instance_method" title="#decorated (instance method)">- (Object) <strong>decorated</strong>(command_on_remote) </a>
266
+
267
+
268
+
269
+ </span>
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <span class="summary_desc"><div class='inline'></div></span>
279
+
280
+ </li>
281
+
282
+
283
+ </ul>
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="CommandTask.html" title="Mattock::CommandTask (class)">CommandTask</a></span></h3>
295
+ <p class="inherited"><span class='object_link'><a href="CommandTask.html#action-instance_method" title="Mattock::CommandTask#action (method)">#action</a></span>, <span class='object_link'><a href="CommandTask.html#needed%3F-instance_method" title="Mattock::CommandTask#needed? (method)">#needed?</a></span></p>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="TaskMixin.html" title="Mattock::TaskMixin (module)">TaskMixin</a></span></h3>
310
+ <p class="inherited"><span class='object_link'><a href="TaskMixin.html#action-instance_method" title="Mattock::TaskMixin#action (method)">#action</a></span>, <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>
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="CascadingDefinition.html" title="Mattock::CascadingDefinition (module)">CascadingDefinition</a></span></h3>
320
+ <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>
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Configurable.html" title="Mattock::Configurable (module)">Configurable</a></span></h3>
330
+ <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>
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Configurable/ClassMethods.html" title="Mattock::Configurable::ClassMethods (module)">Configurable::ClassMethods</a></span></h3>
340
+ <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>
341
+
342
+ <div id="constructor_details" class="method_details_list">
343
+ <h2>Constructor Details</h2>
344
+
345
+ <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>
346
+
347
+ </div>
348
+
349
+
350
+ <div id="instance_method_details" class="method_details_list">
351
+ <h2>Instance Method Details</h2>
352
+
353
+
354
+ <div class="method_details first">
355
+ <p class="signature first" id="decorated-instance_method">
356
+
357
+ - (<tt>Object</tt>) <strong>decorated</strong>(command_on_remote)
358
+
359
+
360
+
361
+ </p><table class="source_code">
362
+ <tr>
363
+ <td>
364
+ <pre class="lines">
365
+
366
+
367
+ 11
368
+ 12
369
+ 13
370
+ 14
371
+ 15
372
+ 16
373
+ 17
374
+ 18
375
+ 19
376
+ 20
377
+ 21
378
+ 22
379
+ 23
380
+ 24
381
+ 25
382
+ 26
383
+ 27
384
+ 28</pre>
385
+ </td>
386
+ <td>
387
+ <pre class="code"><span class="info file"># File 'lib/mattock/remote-command-task.rb', line 11</span>
388
+
389
+ <span class='kw'>def</span> <span class='id identifier rubyid_decorated'>decorated</span><span class='lparen'>(</span><span class='id identifier rubyid_command_on_remote'>command_on_remote</span><span class='rparen'>)</span>
390
+ <span class='id identifier rubyid_fail'>fail</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Need remote server for </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_remote_server'>remote_server</span><span class='period'>.</span><span class='id identifier rubyid_address'>address</span>
391
+
392
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Empty remote command</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_command_on_remote'>command_on_remote</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
393
+ <span class='const'>Mattock</span><span class='op'>::</span><span class='const'>WrappingChain</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cmd'>cmd</span><span class='op'>|</span>
394
+ <span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span> <span class='const'>Mattock</span><span class='op'>::</span><span class='const'>CommandLine</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ssh</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cmd'>cmd</span><span class='op'>|</span>
395
+ <span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-u </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_remote_server'>remote_server</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_remote_server'>remote_server</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span>
396
+ <span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-i </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id_file'>id_file</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_id_file'>id_file</span>
397
+ <span class='kw'>unless</span> <span class='id identifier rubyid_ssh_options'>ssh_options</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
398
+ <span class='id identifier rubyid_ssh_options'>ssh_options</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_opt'>opt</span><span class='op'>|</span>
399
+ <span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-o </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opt'>opt</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
400
+ <span class='kw'>end</span>
401
+ <span class='kw'>end</span>
402
+ <span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_remote_server'>remote_server</span><span class='period'>.</span><span class='id identifier rubyid_address'>address</span>
403
+ <span class='kw'>end</span>
404
+ <span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span> <span class='const'>Mattock</span><span class='op'>::</span><span class='const'>ShellEscaped</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_command_on_remote'>command_on_remote</span><span class='rparen'>)</span>
405
+ <span class='kw'>end</span>
406
+ <span class='kw'>end</span></pre>
407
+ </td>
408
+ </tr>
409
+ </table>
410
+ </div>
411
+
412
+ </div>
413
+
414
+ </div>
415
+
416
+ <div id="footer">
417
+ Generated on Tue Mar 6 02:47:31 2012 by
418
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
419
+ 0.7.5 (ruby-1.9.2).
420
+ </div>
421
+
422
+ </body>
423
+ </html>