reap 0.4.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +8 -1
- data/Reapfile +8 -7
- data/doc/classes/Reap.html +1 -1
- data/doc/classes/Reap/AnnounceTask.html +50 -42
- data/doc/classes/Reap/ChmodTask.html +40 -41
- data/doc/classes/Reap/PackageTask.html +35 -33
- data/doc/classes/Reap/PublishTask.html +48 -42
- data/doc/classes/Reap/RDocTask.html +14 -14
- data/doc/classes/Reap/Runner.html +49 -57
- data/doc/classes/Reap/Task.html +119 -71
- data/doc/classes/Reap/TemplateTask.html +42 -49
- data/doc/classes/Reap/TestTask.html +135 -23
- data/doc/classes/Reap/TestTask/TestResults.html +235 -0
- data/doc/created.rid +1 -1
- data/doc/files/README.html +3 -3
- data/doc/files/lib/reap/reap_rb.html +3 -2
- data/doc/files/lib/reap/runner_rb.html +6 -5
- data/doc/files/lib/reap/task_rb.html +1 -1
- data/doc/files/lib/reap/tasks/announce-task_rb.html +6 -6
- data/doc/files/lib/reap/tasks/chmod-task_rb.html +1 -1
- data/doc/files/lib/reap/tasks/package-task_rb.html +1 -1
- data/doc/files/lib/reap/tasks/publish-task_rb.html +1 -1
- data/doc/files/lib/reap/tasks/rdoc-task_rb.html +1 -1
- data/doc/files/lib/reap/tasks/template-task_rb.html +2 -1
- data/doc/files/lib/reap/tasks/test-task_rb.html +9 -1
- data/doc/fr_class_index.html +1 -0
- data/doc/fr_file_index.html +0 -1
- data/doc/fr_method_index.html +40 -36
- data/lib/reap/reap.rb +4 -2
- data/lib/reap/runner.rb +23 -28
- data/lib/reap/task.rb +71 -22
- data/lib/reap/tasks/announce-task.rb +29 -20
- data/lib/reap/tasks/chmod-task.rb +6 -9
- data/lib/reap/tasks/package-task.rb +33 -29
- data/lib/reap/tasks/publish-task.rb +22 -16
- data/lib/reap/tasks/rdoc-task.rb +9 -11
- data/lib/reap/tasks/template-task.rb +12 -11
- data/lib/reap/tasks/test-task.rb +115 -20
- data/pub/www/doc/classes/Reap.html +184 -0
- data/pub/www/doc/classes/Reap/AnnounceTask.html +331 -0
- data/pub/www/doc/classes/Reap/ChmodTask.html +278 -0
- data/pub/www/doc/classes/Reap/PackageTask.html +372 -0
- data/pub/www/doc/classes/Reap/PublishTask.html +231 -0
- data/pub/www/doc/classes/Reap/RDocTask.html +254 -0
- data/pub/www/doc/classes/Reap/Runner.html +307 -0
- data/pub/www/doc/classes/Reap/Task.html +390 -0
- data/pub/www/doc/classes/Reap/TemplateTask.html +233 -0
- data/pub/www/doc/classes/Reap/TestTask.html +242 -0
- data/pub/www/doc/created.rid +1 -0
- data/pub/www/doc/files/LICENSE.html +119 -0
- data/pub/www/doc/files/README.html +194 -0
- data/pub/www/doc/files/lib/reap/reap_rb.html +110 -0
- data/pub/www/doc/files/lib/reap/runner_rb.html +113 -0
- data/pub/www/doc/files/lib/reap/task_rb.html +108 -0
- data/pub/www/doc/files/lib/reap/tasks/announce-task_rb.html +113 -0
- data/pub/www/doc/files/lib/reap/tasks/chmod-task_rb.html +101 -0
- data/pub/www/doc/files/lib/reap/tasks/package-task_rb.html +108 -0
- data/pub/www/doc/files/lib/reap/tasks/publish-task_rb.html +101 -0
- data/pub/www/doc/files/lib/reap/tasks/rdoc-task_rb.html +101 -0
- data/pub/www/doc/files/lib/reap/tasks/template-task_rb.html +108 -0
- data/pub/www/doc/files/lib/reap/tasks/test-task_rb.html +101 -0
- data/{doc → pub/www/doc}/files/lib/reap/template_rb.html +0 -0
- data/pub/www/doc/fr_class_index.html +36 -0
- data/pub/www/doc/fr_file_index.html +39 -0
- data/pub/www/doc/fr_method_index.html +69 -0
- data/pub/www/doc/index.html +24 -0
- data/pub/www/doc/rdoc-style.css +208 -0
- data/pub/www/index.html +6 -0
- data/test/{test_require.rb → tc_require.rb} +0 -0
- metadata +50 -10
- data/lib/reap/template.rb +0 -72
|
@@ -0,0 +1,307 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Class: Reap::Runner</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Class</strong></td>
|
|
53
|
+
<td class="class-name-in-header">Reap::Runner</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../../files/lib/reap/runner_rb.html">
|
|
59
|
+
lib/reap/runner.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
</td>
|
|
63
|
+
</tr>
|
|
64
|
+
|
|
65
|
+
<tr class="top-aligned-row">
|
|
66
|
+
<td><strong>Parent:</strong></td>
|
|
67
|
+
<td>
|
|
68
|
+
Object
|
|
69
|
+
</td>
|
|
70
|
+
</tr>
|
|
71
|
+
</table>
|
|
72
|
+
</div>
|
|
73
|
+
<!-- banner header -->
|
|
74
|
+
|
|
75
|
+
<div id="bodyContent">
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<div id="contextContent">
|
|
80
|
+
|
|
81
|
+
<div id="description">
|
|
82
|
+
<p>
|
|
83
|
+
Main <a href="Runner.html">Runner</a> class
|
|
84
|
+
</p>
|
|
85
|
+
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<div id="method-list">
|
|
92
|
+
<h3 class="section-bar">Methods</h3>
|
|
93
|
+
|
|
94
|
+
<div class="name-list">
|
|
95
|
+
<a href="#M000031">acknowledge</a>
|
|
96
|
+
<a href="#M000029">call</a>
|
|
97
|
+
<a href="#M000027">new</a>
|
|
98
|
+
<a href="#M000030">run</a>
|
|
99
|
+
<a href="#M000028">task?</a>
|
|
100
|
+
</div>
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<!-- if includes -->
|
|
107
|
+
|
|
108
|
+
<div id="section">
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<div id="attribute-list">
|
|
115
|
+
<h3 class="section-bar">Attributes</h3>
|
|
116
|
+
|
|
117
|
+
<div class="name-list">
|
|
118
|
+
<table>
|
|
119
|
+
<tr class="top-aligned-row context-row">
|
|
120
|
+
<td class="context-item-name">config</td>
|
|
121
|
+
<td class="context-item-value"> [R] </td>
|
|
122
|
+
<td class="context-item-desc"></td>
|
|
123
|
+
</tr>
|
|
124
|
+
</table>
|
|
125
|
+
</div>
|
|
126
|
+
</div>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
<!-- if method_list -->
|
|
131
|
+
<div id="methods">
|
|
132
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
133
|
+
|
|
134
|
+
<div id="method-M000027" class="method-detail">
|
|
135
|
+
<a name="M000027"></a>
|
|
136
|
+
|
|
137
|
+
<div class="method-heading">
|
|
138
|
+
<a href="#M000027" class="method-signature">
|
|
139
|
+
<span class="method-name">new</span><span class="method-args">( config_file=nil )</span>
|
|
140
|
+
</a>
|
|
141
|
+
</div>
|
|
142
|
+
|
|
143
|
+
<div class="method-description">
|
|
144
|
+
<p><a class="source-toggle" href="#"
|
|
145
|
+
onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
|
|
146
|
+
<div class="method-source-code" id="M000027-source">
|
|
147
|
+
<pre>
|
|
148
|
+
<span class="ruby-comment cmt"># File lib/reap/runner.rb, line 29</span>
|
|
149
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">config_file</span>=<span class="ruby-keyword kw">nil</span> )
|
|
150
|
+
<span class="ruby-identifier">config_file</span> <span class="ruby-operator">||=</span> <span class="ruby-value str">'Reapfile'</span>
|
|
151
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>( <span class="ruby-identifier">config_file</span> )
|
|
152
|
+
<span class="ruby-comment cmt"># load config file</span>
|
|
153
|
+
<span class="ruby-identifier">config</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>( <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>( <span class="ruby-identifier">config_file</span> ) )
|
|
154
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">traverse!</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> [<span class="ruby-identifier">k</span>.<span class="ruby-identifier">downcase</span>, <span class="ruby-identifier">v</span>] }
|
|
155
|
+
<span class="ruby-ivar">@config</span> = <span class="ruby-identifier">config</span>
|
|
156
|
+
|
|
157
|
+
<span class="ruby-comment cmt"># main parameters</span>
|
|
158
|
+
<span class="ruby-ivar">@title</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value str">'title'</span>]
|
|
159
|
+
<span class="ruby-ivar">@name</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value str">'name'</span>]
|
|
160
|
+
<span class="ruby-ivar">@version</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value str">'version'</span>]
|
|
161
|
+
<span class="ruby-ivar">@summary</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value str">'summary'</span>]
|
|
162
|
+
<span class="ruby-ivar">@description</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value str">'description'</span>]
|
|
163
|
+
|
|
164
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-value str">"TITLE is a required configuration field"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@title</span>
|
|
165
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-value str">"NAME is a required configuration field"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@name</span>
|
|
166
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-value str">"VERSION is a required configuration field"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@version</span>
|
|
167
|
+
<span class="ruby-keyword kw">else</span>
|
|
168
|
+
<span class="ruby-ivar">@config</span> = {}
|
|
169
|
+
<span class="ruby-keyword kw">end</span>
|
|
170
|
+
<span class="ruby-keyword kw">end</span>
|
|
171
|
+
</pre>
|
|
172
|
+
</div>
|
|
173
|
+
</div>
|
|
174
|
+
</div>
|
|
175
|
+
|
|
176
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
|
177
|
+
|
|
178
|
+
<div id="method-M000031" class="method-detail">
|
|
179
|
+
<a name="M000031"></a>
|
|
180
|
+
|
|
181
|
+
<div class="method-heading">
|
|
182
|
+
<a href="#M000031" class="method-signature">
|
|
183
|
+
<span class="method-name">acknowledge</span><span class="method-args">()</span>
|
|
184
|
+
</a>
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
<div class="method-description">
|
|
188
|
+
<p><a class="source-toggle" href="#"
|
|
189
|
+
onclick="toggleCode('M000031-source');return false;">[Source]</a></p>
|
|
190
|
+
<div class="method-source-code" id="M000031-source">
|
|
191
|
+
<pre>
|
|
192
|
+
<span class="ruby-comment cmt"># File lib/reap/runner.rb, line 89</span>
|
|
193
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">acknowledge</span>
|
|
194
|
+
<span class="ruby-identifier">y</span> <span class="ruby-ivar">@config</span>
|
|
195
|
+
<span class="ruby-keyword kw">end</span>
|
|
196
|
+
</pre>
|
|
197
|
+
</div>
|
|
198
|
+
</div>
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
<div id="method-M000029" class="method-detail">
|
|
202
|
+
<a name="M000029"></a>
|
|
203
|
+
|
|
204
|
+
<div class="method-heading">
|
|
205
|
+
<a href="#M000029" class="method-signature">
|
|
206
|
+
<span class="method-name">call</span><span class="method-args">( tsk, *args )</span>
|
|
207
|
+
</a>
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
<div class="method-description">
|
|
211
|
+
<p><a class="source-toggle" href="#"
|
|
212
|
+
onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
|
|
213
|
+
<div class="method-source-code" id="M000029-source">
|
|
214
|
+
<pre>
|
|
215
|
+
<span class="ruby-comment cmt"># File lib/reap/runner.rb, line 63</span>
|
|
216
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call</span>( <span class="ruby-identifier">tsk</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
|
|
217
|
+
<span class="ruby-identifier">tsk</span> = <span class="ruby-identifier">tsk</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">to_sym</span>
|
|
218
|
+
<span class="ruby-keyword kw">case</span> <span class="ruby-identifier">tsk</span>
|
|
219
|
+
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:acknowledge</span>, <span class="ruby-identifier">:show</span>
|
|
220
|
+
<span class="ruby-identifier">acknowledge</span>
|
|
221
|
+
<span class="ruby-keyword kw">else</span>
|
|
222
|
+
<span class="ruby-identifier">run</span>( <span class="ruby-identifier">tsk</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
|
|
223
|
+
<span class="ruby-keyword kw">end</span>
|
|
224
|
+
<span class="ruby-keyword kw">end</span>
|
|
225
|
+
</pre>
|
|
226
|
+
</div>
|
|
227
|
+
</div>
|
|
228
|
+
</div>
|
|
229
|
+
|
|
230
|
+
<div id="method-M000030" class="method-detail">
|
|
231
|
+
<a name="M000030"></a>
|
|
232
|
+
|
|
233
|
+
<div class="method-heading">
|
|
234
|
+
<a href="#M000030" class="method-signature">
|
|
235
|
+
<span class="method-name">run</span><span class="method-args">( tsk, *args )</span>
|
|
236
|
+
</a>
|
|
237
|
+
</div>
|
|
238
|
+
|
|
239
|
+
<div class="method-description">
|
|
240
|
+
<p><a class="source-toggle" href="#"
|
|
241
|
+
onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
|
|
242
|
+
<div class="method-source-code" id="M000030-source">
|
|
243
|
+
<pre>
|
|
244
|
+
<span class="ruby-comment cmt"># File lib/reap/runner.rb, line 73</span>
|
|
245
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>( <span class="ruby-identifier">tsk</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
|
|
246
|
+
<span class="ruby-identifier">taskClass</span> = <span class="ruby-constant">Task</span>.<span class="ruby-identifier">registry</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">task</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">tsk</span> }
|
|
247
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-value str">"Task undefined."</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">taskClass</span> <span class="ruby-comment cmt"># should not happen</span>
|
|
248
|
+
<span class="ruby-identifier">task</span> = <span class="ruby-identifier">taskClass</span>.<span class="ruby-identifier">new</span>( <span class="ruby-ivar">@config</span> )
|
|
249
|
+
<span class="ruby-identifier">section</span> = <span class="ruby-identifier">taskClass</span>.<span class="ruby-identifier">task</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>
|
|
250
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-identifier">section</span>].<span class="ruby-identifier">is_a?</span>( <span class="ruby-constant">Array</span> )
|
|
251
|
+
<span class="ruby-ivar">@config</span>[<span class="ruby-identifier">section</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
|
|
252
|
+
<span class="ruby-identifier">task</span>.<span class="ruby-identifier">set</span>( <span class="ruby-identifier">s</span> )
|
|
253
|
+
<span class="ruby-identifier">task</span>.<span class="ruby-identifier">run</span>
|
|
254
|
+
<span class="ruby-keyword kw">end</span>
|
|
255
|
+
<span class="ruby-keyword kw">else</span>
|
|
256
|
+
<span class="ruby-identifier">task</span>.<span class="ruby-identifier">set</span>( <span class="ruby-ivar">@config</span>[<span class="ruby-identifier">section</span>] )
|
|
257
|
+
<span class="ruby-identifier">task</span>.<span class="ruby-identifier">run</span>
|
|
258
|
+
<span class="ruby-keyword kw">end</span>
|
|
259
|
+
<span class="ruby-keyword kw">end</span>
|
|
260
|
+
</pre>
|
|
261
|
+
</div>
|
|
262
|
+
</div>
|
|
263
|
+
</div>
|
|
264
|
+
|
|
265
|
+
<div id="method-M000028" class="method-detail">
|
|
266
|
+
<a name="M000028"></a>
|
|
267
|
+
|
|
268
|
+
<div class="method-heading">
|
|
269
|
+
<a href="#M000028" class="method-signature">
|
|
270
|
+
<span class="method-name">task?</span><span class="method-args">( tsk )</span>
|
|
271
|
+
</a>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
<div class="method-description">
|
|
275
|
+
<p><a class="source-toggle" href="#"
|
|
276
|
+
onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
|
|
277
|
+
<div class="method-source-code" id="M000028-source">
|
|
278
|
+
<pre>
|
|
279
|
+
<span class="ruby-comment cmt"># File lib/reap/runner.rb, line 52</span>
|
|
280
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">task?</span>( <span class="ruby-identifier">tsk</span> )
|
|
281
|
+
<span class="ruby-identifier">tsk</span> = <span class="ruby-identifier">tsk</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">to_sym</span>
|
|
282
|
+
<span class="ruby-keyword kw">case</span> <span class="ruby-identifier">tsk</span>
|
|
283
|
+
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:acknowledge</span>, <span class="ruby-identifier">:show</span>
|
|
284
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
|
|
285
|
+
<span class="ruby-keyword kw">else</span>
|
|
286
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Reap</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">tasks</span>.<span class="ruby-identifier">include?</span>( <span class="ruby-identifier">tsk</span> )
|
|
287
|
+
<span class="ruby-keyword kw">end</span>
|
|
288
|
+
<span class="ruby-keyword kw">false</span>
|
|
289
|
+
<span class="ruby-keyword kw">end</span>
|
|
290
|
+
</pre>
|
|
291
|
+
</div>
|
|
292
|
+
</div>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
</div>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
</div>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<div id="validator-badges">
|
|
303
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
304
|
+
</div>
|
|
305
|
+
|
|
306
|
+
</body>
|
|
307
|
+
</html>
|
|
@@ -0,0 +1,390 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Class: Reap::Task</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Class</strong></td>
|
|
53
|
+
<td class="class-name-in-header">Reap::Task</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../../files/lib/reap/task_rb.html">
|
|
59
|
+
lib/reap/task.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
</td>
|
|
63
|
+
</tr>
|
|
64
|
+
|
|
65
|
+
<tr class="top-aligned-row">
|
|
66
|
+
<td><strong>Parent:</strong></td>
|
|
67
|
+
<td>
|
|
68
|
+
Object
|
|
69
|
+
</td>
|
|
70
|
+
</tr>
|
|
71
|
+
</table>
|
|
72
|
+
</div>
|
|
73
|
+
<!-- banner header -->
|
|
74
|
+
|
|
75
|
+
<div id="bodyContent">
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<div id="contextContent">
|
|
80
|
+
|
|
81
|
+
<div id="description">
|
|
82
|
+
<p>
|
|
83
|
+
Base class for all tasks
|
|
84
|
+
</p>
|
|
85
|
+
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<div id="method-list">
|
|
92
|
+
<h3 class="section-bar">Methods</h3>
|
|
93
|
+
|
|
94
|
+
<div class="name-list">
|
|
95
|
+
<a href="#M000036">[]</a>
|
|
96
|
+
<a href="#M000032">inherited</a>
|
|
97
|
+
<a href="#M000035">new</a>
|
|
98
|
+
<a href="#M000039">package_name</a>
|
|
99
|
+
<a href="#M000033">registry</a>
|
|
100
|
+
<a href="#M000038">ruby</a>
|
|
101
|
+
<a href="#M000037">sh</a>
|
|
102
|
+
<a href="#M000034">tasks</a>
|
|
103
|
+
</div>
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
</div>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<!-- if includes -->
|
|
110
|
+
|
|
111
|
+
<div id="section">
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<div id="constants-list">
|
|
115
|
+
<h3 class="section-bar">Constants</h3>
|
|
116
|
+
|
|
117
|
+
<div class="name-list">
|
|
118
|
+
<table summary="Constants">
|
|
119
|
+
<tr class="top-aligned-row context-row">
|
|
120
|
+
<td class="context-item-name">RUBY</td>
|
|
121
|
+
<td>=</td>
|
|
122
|
+
<td class="context-item-value">Config::CONFIG['ruby_install_name']</td>
|
|
123
|
+
</tr>
|
|
124
|
+
<tr class="top-aligned-row context-row">
|
|
125
|
+
<td class="context-item-name">DEFAULT_INCLUDE</td>
|
|
126
|
+
<td>=</td>
|
|
127
|
+
<td class="context-item-value">[ '[A-Z]*', 'setup.rb', 'lib/**/*', 'bin/**/*', 'doc/**/*', 'rdoc/**/*', 'test/**/*', 'bench/**/*', 'demo/**/*', 'samples/**/*', 'examples/**/*' ]</td>
|
|
128
|
+
</tr>
|
|
129
|
+
<tr class="top-aligned-row context-row">
|
|
130
|
+
<td class="context-item-name">MUST_EXCLUDE</td>
|
|
131
|
+
<td>=</td>
|
|
132
|
+
<td class="context-item-value">[ 'InstalledFiles', '**/CVS/**/*', '**/*~' ]</td>
|
|
133
|
+
</tr>
|
|
134
|
+
</table>
|
|
135
|
+
</div>
|
|
136
|
+
</div>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<div id="attribute-list">
|
|
141
|
+
<h3 class="section-bar">Attributes</h3>
|
|
142
|
+
|
|
143
|
+
<div class="name-list">
|
|
144
|
+
<table>
|
|
145
|
+
<tr class="top-aligned-row context-row">
|
|
146
|
+
<td class="context-item-name">config</td>
|
|
147
|
+
<td class="context-item-value"> [R] </td>
|
|
148
|
+
<td class="context-item-desc"></td>
|
|
149
|
+
</tr>
|
|
150
|
+
<tr class="top-aligned-row context-row">
|
|
151
|
+
<td class="context-item-name">section</td>
|
|
152
|
+
<td class="context-item-value"> [R] </td>
|
|
153
|
+
<td class="context-item-desc"></td>
|
|
154
|
+
</tr>
|
|
155
|
+
</table>
|
|
156
|
+
</div>
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<!-- if method_list -->
|
|
162
|
+
<div id="methods">
|
|
163
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
164
|
+
|
|
165
|
+
<div id="method-M000032" class="method-detail">
|
|
166
|
+
<a name="M000032"></a>
|
|
167
|
+
|
|
168
|
+
<div class="method-heading">
|
|
169
|
+
<a href="#M000032" class="method-signature">
|
|
170
|
+
<span class="method-name">inherited</span><span class="method-args">( klass )</span>
|
|
171
|
+
</a>
|
|
172
|
+
</div>
|
|
173
|
+
|
|
174
|
+
<div class="method-description">
|
|
175
|
+
<p><a class="source-toggle" href="#"
|
|
176
|
+
onclick="toggleCode('M000032-source');return false;">[Source]</a></p>
|
|
177
|
+
<div class="method-source-code" id="M000032-source">
|
|
178
|
+
<pre>
|
|
179
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 20</span>
|
|
180
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>( <span class="ruby-identifier">klass</span> )
|
|
181
|
+
(<span class="ruby-ivar">@task_registry</span> <span class="ruby-operator">||=</span> []) <span class="ruby-operator"><<</span> <span class="ruby-identifier">klass</span>
|
|
182
|
+
<span class="ruby-keyword kw">end</span>
|
|
183
|
+
</pre>
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
|
|
188
|
+
<div id="method-M000035" class="method-detail">
|
|
189
|
+
<a name="M000035"></a>
|
|
190
|
+
|
|
191
|
+
<div class="method-heading">
|
|
192
|
+
<a href="#M000035" class="method-signature">
|
|
193
|
+
<span class="method-name">new</span><span class="method-args">( config )</span>
|
|
194
|
+
</a>
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
<div class="method-description">
|
|
198
|
+
<p><a class="source-toggle" href="#"
|
|
199
|
+
onclick="toggleCode('M000035-source');return false;">[Source]</a></p>
|
|
200
|
+
<div class="method-source-code" id="M000035-source">
|
|
201
|
+
<pre>
|
|
202
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 31</span>
|
|
203
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">config</span> )
|
|
204
|
+
<span class="ruby-ivar">@config</span> = <span class="ruby-identifier">config</span>
|
|
205
|
+
<span class="ruby-keyword kw">end</span>
|
|
206
|
+
</pre>
|
|
207
|
+
</div>
|
|
208
|
+
</div>
|
|
209
|
+
</div>
|
|
210
|
+
|
|
211
|
+
<div id="method-M000033" class="method-detail">
|
|
212
|
+
<a name="M000033"></a>
|
|
213
|
+
|
|
214
|
+
<div class="method-heading">
|
|
215
|
+
<a href="#M000033" class="method-signature">
|
|
216
|
+
<span class="method-name">registry</span><span class="method-args">()</span>
|
|
217
|
+
</a>
|
|
218
|
+
</div>
|
|
219
|
+
|
|
220
|
+
<div class="method-description">
|
|
221
|
+
<p><a class="source-toggle" href="#"
|
|
222
|
+
onclick="toggleCode('M000033-source');return false;">[Source]</a></p>
|
|
223
|
+
<div class="method-source-code" id="M000033-source">
|
|
224
|
+
<pre>
|
|
225
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 24</span>
|
|
226
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registry</span> ; <span class="ruby-ivar">@task_registry</span> <span class="ruby-operator">||=</span> [] ; <span class="ruby-keyword kw">end</span>
|
|
227
|
+
</pre>
|
|
228
|
+
</div>
|
|
229
|
+
</div>
|
|
230
|
+
</div>
|
|
231
|
+
|
|
232
|
+
<div id="method-M000034" class="method-detail">
|
|
233
|
+
<a name="M000034"></a>
|
|
234
|
+
|
|
235
|
+
<div class="method-heading">
|
|
236
|
+
<a href="#M000034" class="method-signature">
|
|
237
|
+
<span class="method-name">tasks</span><span class="method-args">()</span>
|
|
238
|
+
</a>
|
|
239
|
+
</div>
|
|
240
|
+
|
|
241
|
+
<div class="method-description">
|
|
242
|
+
<p><a class="source-toggle" href="#"
|
|
243
|
+
onclick="toggleCode('M000034-source');return false;">[Source]</a></p>
|
|
244
|
+
<div class="method-source-code" id="M000034-source">
|
|
245
|
+
<pre>
|
|
246
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 26</span>
|
|
247
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">tasks</span> ; <span class="ruby-ivar">@task</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">registry</span>.<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">task</span> } ; <span class="ruby-keyword kw">end</span>
|
|
248
|
+
</pre>
|
|
249
|
+
</div>
|
|
250
|
+
</div>
|
|
251
|
+
</div>
|
|
252
|
+
|
|
253
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
|
254
|
+
|
|
255
|
+
<div id="method-M000036" class="method-detail">
|
|
256
|
+
<a name="M000036"></a>
|
|
257
|
+
|
|
258
|
+
<div class="method-heading">
|
|
259
|
+
<a href="#M000036" class="method-signature">
|
|
260
|
+
<span class="method-name">[]</span><span class="method-args">(x)</span>
|
|
261
|
+
</a>
|
|
262
|
+
</div>
|
|
263
|
+
|
|
264
|
+
<div class="method-description">
|
|
265
|
+
<p><a class="source-toggle" href="#"
|
|
266
|
+
onclick="toggleCode('M000036-source');return false;">[Source]</a></p>
|
|
267
|
+
<div class="method-source-code" id="M000036-source">
|
|
268
|
+
<pre>
|
|
269
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 35</span>
|
|
270
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">x</span>)
|
|
271
|
+
<span class="ruby-ivar">@config</span>[<span class="ruby-identifier">x</span>]
|
|
272
|
+
<span class="ruby-keyword kw">end</span>
|
|
273
|
+
</pre>
|
|
274
|
+
</div>
|
|
275
|
+
</div>
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
<div id="method-M000039" class="method-detail">
|
|
279
|
+
<a name="M000039"></a>
|
|
280
|
+
|
|
281
|
+
<div class="method-heading">
|
|
282
|
+
<a href="#M000039" class="method-signature">
|
|
283
|
+
<span class="method-name">package_name</span><span class="method-args">()</span>
|
|
284
|
+
</a>
|
|
285
|
+
</div>
|
|
286
|
+
|
|
287
|
+
<div class="method-description">
|
|
288
|
+
<p>
|
|
289
|
+
Returns the full package name which combines package name and version.
|
|
290
|
+
</p>
|
|
291
|
+
<p><a class="source-toggle" href="#"
|
|
292
|
+
onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
|
|
293
|
+
<div class="method-source-code" id="M000039-source">
|
|
294
|
+
<pre>
|
|
295
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 83</span>
|
|
296
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">package_name</span>
|
|
297
|
+
<span class="ruby-ivar">@config</span>[<span class="ruby-value str">'name'</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">'--'</span> <span class="ruby-operator">+</span> ( <span class="ruby-ivar">@config</span>[<span class="ruby-value str">'version'</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">'0.0.1'</span> )
|
|
298
|
+
<span class="ruby-keyword kw">end</span>
|
|
299
|
+
</pre>
|
|
300
|
+
</div>
|
|
301
|
+
</div>
|
|
302
|
+
</div>
|
|
303
|
+
|
|
304
|
+
<div id="method-M000038" class="method-detail">
|
|
305
|
+
<a name="M000038"></a>
|
|
306
|
+
|
|
307
|
+
<div class="method-heading">
|
|
308
|
+
<a href="#M000038" class="method-signature">
|
|
309
|
+
<span class="method-name">ruby</span><span class="method-args">(*args)</span>
|
|
310
|
+
</a>
|
|
311
|
+
</div>
|
|
312
|
+
|
|
313
|
+
<div class="method-description">
|
|
314
|
+
<p>
|
|
315
|
+
Run a Ruby interpreter with the given arguments.
|
|
316
|
+
</p>
|
|
317
|
+
<p>
|
|
318
|
+
Example:
|
|
319
|
+
</p>
|
|
320
|
+
<pre>
|
|
321
|
+
ruby %{-pe '$_.upcase!' <README}
|
|
322
|
+
</pre>
|
|
323
|
+
<p><a class="source-toggle" href="#"
|
|
324
|
+
onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
|
|
325
|
+
<div class="method-source-code" id="M000038-source">
|
|
326
|
+
<pre>
|
|
327
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 57</span>
|
|
328
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ruby</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
329
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>
|
|
330
|
+
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span>
|
|
331
|
+
<span class="ruby-keyword kw">else</span>
|
|
332
|
+
<span class="ruby-identifier">options</span> = {}
|
|
333
|
+
<span class="ruby-keyword kw">end</span>
|
|
334
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{RUBY} #{args.join(' ')}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">$DEBUG</span>
|
|
335
|
+
<span class="ruby-identifier">sh</span> <span class="ruby-node">"#{RUBY} #{args.join(' ')}"</span>, <span class="ruby-identifier">options</span>
|
|
336
|
+
<span class="ruby-keyword kw">end</span>
|
|
337
|
+
</pre>
|
|
338
|
+
</div>
|
|
339
|
+
</div>
|
|
340
|
+
</div>
|
|
341
|
+
|
|
342
|
+
<div id="method-M000037" class="method-detail">
|
|
343
|
+
<a name="M000037"></a>
|
|
344
|
+
|
|
345
|
+
<div class="method-heading">
|
|
346
|
+
<a href="#M000037" class="method-signature">
|
|
347
|
+
<span class="method-name">sh</span><span class="method-args">(cmd, options={})</span>
|
|
348
|
+
</a>
|
|
349
|
+
</div>
|
|
350
|
+
|
|
351
|
+
<div class="method-description">
|
|
352
|
+
<p>
|
|
353
|
+
Run the system command <tt>cmd</tt>.
|
|
354
|
+
</p>
|
|
355
|
+
<p>
|
|
356
|
+
Example:
|
|
357
|
+
</p>
|
|
358
|
+
<pre>
|
|
359
|
+
sh %{ls -ltr}
|
|
360
|
+
</pre>
|
|
361
|
+
<p><a class="source-toggle" href="#"
|
|
362
|
+
onclick="toggleCode('M000037-source');return false;">[Source]</a></p>
|
|
363
|
+
<div class="method-source-code" id="M000037-source">
|
|
364
|
+
<pre>
|
|
365
|
+
<span class="ruby-comment cmt"># File lib/reap/task.rb, line 44</span>
|
|
366
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sh</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">options</span>={})
|
|
367
|
+
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">send</span>( <span class="ruby-identifier">:fu_check_options</span>, <span class="ruby-identifier">options</span>, <span class="ruby-identifier">:noop</span>, <span class="ruby-identifier">:verbose</span> )
|
|
368
|
+
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">send</span>( <span class="ruby-identifier">:fu_output_message</span>, <span class="ruby-identifier">cmd</span> ) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:verbose</span>]
|
|
369
|
+
<span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:noop</span>]
|
|
370
|
+
<span class="ruby-identifier">system</span>(<span class="ruby-identifier">cmd</span>) <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">fail</span> <span class="ruby-node">"Command Failed: [#{cmd}]"</span>
|
|
371
|
+
<span class="ruby-keyword kw">end</span>
|
|
372
|
+
<span class="ruby-keyword kw">end</span>
|
|
373
|
+
</pre>
|
|
374
|
+
</div>
|
|
375
|
+
</div>
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
</div>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</div>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<div id="validator-badges">
|
|
386
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
387
|
+
</div>
|
|
388
|
+
|
|
389
|
+
</body>
|
|
390
|
+
</html>
|