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,282 @@
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::CommandLineExampleGroup
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">CommandLineExampleGroup</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::CommandLineExampleGroup
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+
70
+
71
+ <dt class="r1">Includes:</dt>
72
+ <dd class="r1"><span class='object_link'><a href="CommandLineExampleGroup/Matchers.html" title="Mattock::CommandLineExampleGroup::Matchers (module)">Matchers</a></span></dd>
73
+
74
+
75
+
76
+
77
+
78
+ <dt class="r2 last">Defined in:</dt>
79
+ <dd class="r2 last">lib/mattock/testing/mock-command-line.rb</dd>
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+
85
+ <h2>Defined Under Namespace</h2>
86
+ <p class="children">
87
+
88
+
89
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="CommandLineExampleGroup/Matchers.html" title="Mattock::CommandLineExampleGroup::Matchers (module)">Matchers</a></span>
90
+
91
+
92
+
93
+
94
+ </p>
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+ <h2>
105
+ Class Method Summary
106
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
107
+ </h2>
108
+
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(group) </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ <span class="summary_desc"><div class='inline'></div></span>
128
+
129
+ </li>
130
+
131
+
132
+ </ul>
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="#expect_command-instance_method" title="#expect_command (instance method)">- (Object) <strong>expect_command</strong>(cmd, *result) </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+ <span class="summary_desc"><div class='inline'></div></span>
158
+
159
+ </li>
160
+
161
+
162
+ </ul>
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <div id="class_method_details" class="method_details_list">
174
+ <h2>Class Method Details</h2>
175
+
176
+
177
+ <div class="method_details first">
178
+ <p class="signature first" id="included-class_method">
179
+
180
+ + (<tt>Object</tt>) <strong>included</strong>(group)
181
+
182
+
183
+
184
+ </p><table class="source_code">
185
+ <tr>
186
+ <td>
187
+ <pre class="lines">
188
+
189
+
190
+ 28
191
+ 29
192
+ 30
193
+ 31
194
+ 32
195
+ 33
196
+ 34
197
+ 35
198
+ 36
199
+ 37
200
+ 38
201
+ 39
202
+ 40
203
+ 41
204
+ 42
205
+ 43
206
+ 44
207
+ 45
208
+ 46</pre>
209
+ </td>
210
+ <td>
211
+ <pre class="code"><span class="info file"># File 'lib/mattock/testing/mock-command-line.rb', line 28</span>
212
+
213
+ <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_group'>group</span><span class='rparen'>)</span>
214
+ <span class='id identifier rubyid_group'>group</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
215
+ <span class='id identifier rubyid_let'>let</span> <span class='symbol'>:pairs</span> <span class='kw'>do</span>
216
+ <span class='lbracket'>[</span><span class='rbracket'>]</span>
217
+ <span class='kw'>end</span>
218
+
219
+ <span class='id identifier rubyid_before'>before</span> <span class='symbol'>:each</span> <span class='kw'>do</span>
220
+ <span class='const'>Mattock</span><span class='op'>::</span><span class='const'>CommandLine</span><span class='period'>.</span><span class='id identifier rubyid_should_receive'>should_receive</span><span class='lparen'>(</span><span class='symbol'>:execute</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>
221
+ <span class='id identifier rubyid_pattern'>pattern</span><span class='comma'>,</span> <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='id identifier rubyid_pairs'>pairs</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
222
+ <span class='id identifier rubyid_pattern'>pattern</span> <span class='op'>=~</span> <span class='id identifier rubyid_cmd'>cmd</span>
223
+ <span class='const'>Mattock</span><span class='op'>::</span><span class='const'>MockCommandResult</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_res'>res</span><span class='rparen'>)</span>
224
+ <span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_any_number_of_times'>any_number_of_times</span>
225
+ <span class='kw'>end</span>
226
+
227
+ <span class='id identifier rubyid_after'>after</span> <span class='symbol'>:each</span> <span class='kw'>do</span>
228
+ <span class='id identifier rubyid_pairs'>pairs</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_have_all_been_called'>have_all_been_called</span>
229
+ <span class='kw'>end</span>
230
+ <span class='kw'>end</span>
231
+ <span class='kw'>end</span></pre>
232
+ </td>
233
+ </tr>
234
+ </table>
235
+ </div>
236
+
237
+ </div>
238
+
239
+ <div id="instance_method_details" class="method_details_list">
240
+ <h2>Instance Method Details</h2>
241
+
242
+
243
+ <div class="method_details first">
244
+ <p class="signature first" id="expect_command-instance_method">
245
+
246
+ - (<tt>Object</tt>) <strong>expect_command</strong>(cmd, *result)
247
+
248
+
249
+
250
+ </p><table class="source_code">
251
+ <tr>
252
+ <td>
253
+ <pre class="lines">
254
+
255
+
256
+ 48
257
+ 49
258
+ 50</pre>
259
+ </td>
260
+ <td>
261
+ <pre class="code"><span class="info file"># File 'lib/mattock/testing/mock-command-line.rb', line 48</span>
262
+
263
+ <span class='kw'>def</span> <span class='id identifier rubyid_expect_command'>expect_command</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
264
+ <span class='id identifier rubyid_pairs'>pairs</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rbracket'>]</span>
265
+ <span class='kw'>end</span></pre>
266
+ </td>
267
+ </tr>
268
+ </table>
269
+ </div>
270
+
271
+ </div>
272
+
273
+ </div>
274
+
275
+ <div id="footer">
276
+ Generated on Tue Mar 6 02:47:31 2012 by
277
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
278
+ 0.7.5 (ruby-1.9.2).
279
+ </div>
280
+
281
+ </body>
282
+ </html>
@@ -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::CommandLineExampleGroup::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="../CommandLineExampleGroup.html" title="Mattock::CommandLineExampleGroup (module)">CommandLineExampleGroup</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::CommandLineExampleGroup::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="../CommandLineExampleGroup.html" title="Mattock::CommandLineExampleGroup (module)">Mattock::CommandLineExampleGroup</a></span></dd>
79
+
80
+
81
+
82
+ <dt class="r1 last">Defined in:</dt>
83
+ <dd class="r1 last">lib/mattock/testing/mock-command-line.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>
@@ -0,0 +1,643 @@
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::CommandRunResult
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">CommandRunResult</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::CommandRunResult
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::CommandRunResult</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">lib/mattock/command-line.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+
96
+ <div id="subclasses">
97
+ <h2>Direct Known Subclasses</h2>
98
+ <p class="children"><span class='object_link'><a href="MockCommandResult.html" title="Mattock::MockCommandResult (class)">MockCommandResult</a></span></p>
99
+ </div>
100
+
101
+
102
+
103
+
104
+
105
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
106
+ <ul class="summary">
107
+
108
+ <li class="public ">
109
+ <span class="summary_signature">
110
+
111
+ <a href="#process_status-instance_method" title="#process_status (instance method)">- (Object) <strong>process_status</strong> </a>
112
+
113
+
114
+
115
+ </span>
116
+
117
+
118
+ <span class="note title readonly">readonly</span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ <span class="summary_desc"><div class='inline'>
128
+ <p>Returns the value of attribute process_status.</p>
129
+ </div></span>
130
+
131
+ </li>
132
+
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#streams-instance_method" title="#streams (instance method)">- (Object) <strong>streams</strong> </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+
144
+ <span class="note title readonly">readonly</span>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+ <span class="summary_desc"><div class='inline'>
154
+ <p>Returns the value of attribute streams.</p>
155
+ </div></span>
156
+
157
+ </li>
158
+
159
+
160
+ </ul>
161
+
162
+
163
+
164
+
165
+
166
+ <h2>
167
+ Instance Method Summary
168
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
169
+ </h2>
170
+
171
+ <ul class="summary">
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#exit_code-instance_method" title="#exit_code (instance method)">- (Object) <strong>exit_code</strong> </a>
177
+
178
+
179
+
180
+ (also: #exit_status)
181
+
182
+ </span>
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <span class="summary_desc"><div class='inline'></div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (CommandRunResult) <strong>initialize</strong>(command, status, streams) </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+ <span class="note title constructor">constructor</span>
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <span class="summary_desc"><div class='inline'>
215
+ <p>A new instance of CommandRunResult.</p>
216
+ </div></span>
217
+
218
+ </li>
219
+
220
+
221
+ <li class="public ">
222
+ <span class="summary_signature">
223
+
224
+ <a href="#must_succeed%21-instance_method" title="#must_succeed! (instance method)">- (Object) <strong>must_succeed!</strong> </a>
225
+
226
+
227
+
228
+ </span>
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+ <span class="summary_desc"><div class='inline'></div></span>
238
+
239
+ </li>
240
+
241
+
242
+ <li class="public ">
243
+ <span class="summary_signature">
244
+
245
+ <a href="#stderr-instance_method" title="#stderr (instance method)">- (Object) <strong>stderr</strong> </a>
246
+
247
+
248
+
249
+ </span>
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'></div></span>
259
+
260
+ </li>
261
+
262
+
263
+ <li class="public ">
264
+ <span class="summary_signature">
265
+
266
+ <a href="#stdout-instance_method" title="#stdout (instance method)">- (Object) <strong>stdout</strong> </a>
267
+
268
+
269
+
270
+ </span>
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+ <span class="summary_desc"><div class='inline'></div></span>
280
+
281
+ </li>
282
+
283
+
284
+ <li class="public ">
285
+ <span class="summary_signature">
286
+
287
+ <a href="#succeeded%3F-instance_method" title="#succeeded? (instance method)">- (Boolean) <strong>succeeded?</strong> </a>
288
+
289
+
290
+
291
+ </span>
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+ <span class="summary_desc"><div class='inline'></div></span>
301
+
302
+ </li>
303
+
304
+
305
+ </ul>
306
+
307
+
308
+ <div id="constructor_details" class="method_details_list">
309
+ <h2>Constructor Details</h2>
310
+
311
+ <div class="method_details first">
312
+ <p class="signature first" id="initialize-instance_method">
313
+
314
+ - (<tt><span class='object_link'><a href="" title="Mattock::CommandRunResult (class)">CommandRunResult</a></span></tt>) <strong>initialize</strong>(command, status, streams)
315
+
316
+
317
+
318
+ </p><div class="docstring">
319
+ <div class="discussion">
320
+
321
+ <p>A new instance of CommandRunResult</p>
322
+
323
+
324
+ </div>
325
+ </div>
326
+ <div class="tags">
327
+
328
+
329
+ </div><table class="source_code">
330
+ <tr>
331
+ <td>
332
+ <pre class="lines">
333
+
334
+
335
+ 3
336
+ 4
337
+ 5
338
+ 6
339
+ 7</pre>
340
+ </td>
341
+ <td>
342
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 3</span>
343
+
344
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_command'>command</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_streams'>streams</span><span class='rparen'>)</span>
345
+ <span class='ivar'>@command</span> <span class='op'>=</span> <span class='id identifier rubyid_command'>command</span>
346
+ <span class='ivar'>@process_status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
347
+ <span class='ivar'>@streams</span> <span class='op'>=</span> <span class='id identifier rubyid_streams'>streams</span>
348
+ <span class='kw'>end</span></pre>
349
+ </td>
350
+ </tr>
351
+ </table>
352
+ </div>
353
+
354
+ </div>
355
+
356
+ <div id="instance_attr_details" class="attr_details">
357
+ <h2>Instance Attribute Details</h2>
358
+
359
+
360
+ <span id=""></span>
361
+ <span id="process_status-instance_method"></span>
362
+ <div class="method_details first">
363
+ <p class="signature first" id="process_status-instance_method">
364
+
365
+ - (<tt>Object</tt>) <strong>process_status</strong> <span class="extras">(readonly)</span>
366
+
367
+
368
+
369
+ </p><div class="docstring">
370
+ <div class="discussion">
371
+
372
+ <p>Returns the value of attribute process_status</p>
373
+
374
+
375
+ </div>
376
+ </div>
377
+ <div class="tags">
378
+
379
+
380
+ </div><table class="source_code">
381
+ <tr>
382
+ <td>
383
+ <pre class="lines">
384
+
385
+
386
+ 8
387
+ 9
388
+ 10</pre>
389
+ </td>
390
+ <td>
391
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 8</span>
392
+
393
+ <span class='kw'>def</span> <span class='id identifier rubyid_process_status'>process_status</span>
394
+ <span class='ivar'>@process_status</span>
395
+ <span class='kw'>end</span></pre>
396
+ </td>
397
+ </tr>
398
+ </table>
399
+ </div>
400
+
401
+
402
+ <span id=""></span>
403
+ <span id="streams-instance_method"></span>
404
+ <div class="method_details ">
405
+ <p class="signature " id="streams-instance_method">
406
+
407
+ - (<tt>Object</tt>) <strong>streams</strong> <span class="extras">(readonly)</span>
408
+
409
+
410
+
411
+ </p><div class="docstring">
412
+ <div class="discussion">
413
+
414
+ <p>Returns the value of attribute streams</p>
415
+
416
+
417
+ </div>
418
+ </div>
419
+ <div class="tags">
420
+
421
+
422
+ </div><table class="source_code">
423
+ <tr>
424
+ <td>
425
+ <pre class="lines">
426
+
427
+
428
+ 8
429
+ 9
430
+ 10</pre>
431
+ </td>
432
+ <td>
433
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 8</span>
434
+
435
+ <span class='kw'>def</span> <span class='id identifier rubyid_streams'>streams</span>
436
+ <span class='ivar'>@streams</span>
437
+ <span class='kw'>end</span></pre>
438
+ </td>
439
+ </tr>
440
+ </table>
441
+ </div>
442
+
443
+ </div>
444
+
445
+
446
+ <div id="instance_method_details" class="method_details_list">
447
+ <h2>Instance Method Details</h2>
448
+
449
+
450
+ <div class="method_details first">
451
+ <p class="signature first" id="exit_code-instance_method">
452
+
453
+ - (<tt>Object</tt>) <strong>exit_code</strong>
454
+
455
+
456
+
457
+ <span class="aliases">Also known as:
458
+ <span class="names"><span id='exit_status-instance_method'>exit_status</span></span>
459
+ </span>
460
+
461
+ </p><table class="source_code">
462
+ <tr>
463
+ <td>
464
+ <pre class="lines">
465
+
466
+
467
+ 18
468
+ 19
469
+ 20</pre>
470
+ </td>
471
+ <td>
472
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 18</span>
473
+
474
+ <span class='kw'>def</span> <span class='id identifier rubyid_exit_code'>exit_code</span>
475
+ <span class='ivar'>@process_status</span><span class='period'>.</span><span class='id identifier rubyid_exitstatus'>exitstatus</span>
476
+ <span class='kw'>end</span></pre>
477
+ </td>
478
+ </tr>
479
+ </table>
480
+ </div>
481
+
482
+ <div class="method_details ">
483
+ <p class="signature " id="must_succeed!-instance_method">
484
+
485
+ - (<tt>Object</tt>) <strong>must_succeed!</strong>
486
+
487
+
488
+
489
+ </p><table class="source_code">
490
+ <tr>
491
+ <td>
492
+ <pre class="lines">
493
+
494
+
495
+ 30
496
+ 31
497
+ 32
498
+ 33
499
+ 34
500
+ 35
501
+ 36
502
+ 37</pre>
503
+ </td>
504
+ <td>
505
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 30</span>
506
+
507
+ <span class='kw'>def</span> <span class='id identifier rubyid_must_succeed!'>must_succeed!</span>
508
+ <span class='kw'>case</span> <span class='id identifier rubyid_exit_code'>exit_code</span>
509
+ <span class='kw'>when</span> <span class='int'>0</span>
510
+ <span class='kw'>return</span> <span class='id identifier rubyid_exit_code'>exit_code</span>
511
+ <span class='kw'>else</span>
512
+ <span class='id identifier rubyid_fail'>fail</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Command </span><span class='embexpr_beg'>#{</span><span class='ivar'>@command</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_content'> failed with exit status </span><span class='embexpr_beg'>#{</span><span class='gvar'>$?</span><span class='period'>.</span><span class='id identifier rubyid_exitstatus'>exitstatus</span><span class='rbrace'>}</span><span class='tstring_content'>: \n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_streams'>streams</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
513
+ <span class='kw'>end</span>
514
+ <span class='kw'>end</span></pre>
515
+ </td>
516
+ </tr>
517
+ </table>
518
+ </div>
519
+
520
+ <div class="method_details ">
521
+ <p class="signature " id="stderr-instance_method">
522
+
523
+ - (<tt>Object</tt>) <strong>stderr</strong>
524
+
525
+
526
+
527
+ </p><table class="source_code">
528
+ <tr>
529
+ <td>
530
+ <pre class="lines">
531
+
532
+
533
+ 14
534
+ 15
535
+ 16</pre>
536
+ </td>
537
+ <td>
538
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 14</span>
539
+
540
+ <span class='kw'>def</span> <span class='id identifier rubyid_stderr'>stderr</span>
541
+ <span class='ivar'>@streams</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span>
542
+ <span class='kw'>end</span></pre>
543
+ </td>
544
+ </tr>
545
+ </table>
546
+ </div>
547
+
548
+ <div class="method_details ">
549
+ <p class="signature " id="stdout-instance_method">
550
+
551
+ - (<tt>Object</tt>) <strong>stdout</strong>
552
+
553
+
554
+
555
+ </p><table class="source_code">
556
+ <tr>
557
+ <td>
558
+ <pre class="lines">
559
+
560
+
561
+ 10
562
+ 11
563
+ 12</pre>
564
+ </td>
565
+ <td>
566
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 10</span>
567
+
568
+ <span class='kw'>def</span> <span class='id identifier rubyid_stdout'>stdout</span>
569
+ <span class='ivar'>@streams</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
570
+ <span class='kw'>end</span></pre>
571
+ </td>
572
+ </tr>
573
+ </table>
574
+ </div>
575
+
576
+ <div class="method_details ">
577
+ <p class="signature " id="succeeded?-instance_method">
578
+
579
+ - (<tt>Boolean</tt>) <strong>succeeded?</strong>
580
+
581
+
582
+
583
+ </p><div class="docstring">
584
+ <div class="discussion">
585
+
586
+
587
+ </div>
588
+ </div>
589
+ <div class="tags">
590
+
591
+ <h3>Returns:</h3>
592
+ <ul class="return">
593
+
594
+ <li>
595
+
596
+
597
+ <span class='type'>(<tt>Boolean</tt>)</span>
598
+
599
+
600
+
601
+ </li>
602
+
603
+ </ul>
604
+
605
+ </div><table class="source_code">
606
+ <tr>
607
+ <td>
608
+ <pre class="lines">
609
+
610
+
611
+ 23
612
+ 24
613
+ 25
614
+ 26
615
+ 27
616
+ 28</pre>
617
+ </td>
618
+ <td>
619
+ <pre class="code"><span class="info file"># File 'lib/mattock/command-line.rb', line 23</span>
620
+
621
+ <span class='kw'>def</span> <span class='id identifier rubyid_succeeded?'>succeeded?</span>
622
+ <span class='id identifier rubyid_must_succeed!'>must_succeed!</span>
623
+ <span class='kw'>return</span> <span class='kw'>true</span>
624
+ <span class='kw'>rescue</span>
625
+ <span class='kw'>return</span> <span class='kw'>false</span>
626
+ <span class='kw'>end</span></pre>
627
+ </td>
628
+ </tr>
629
+ </table>
630
+ </div>
631
+
632
+ </div>
633
+
634
+ </div>
635
+
636
+ <div id="footer">
637
+ Generated on Tue Mar 6 02:47:29 2012 by
638
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
639
+ 0.7.5 (ruby-1.9.2).
640
+ </div>
641
+
642
+ </body>
643
+ </html>