lifeline 0.3.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,400 @@
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 name="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Class: Lifeline::LifelineRakeTask</title>
7
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '..';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+ <a href="../_index.html">Index (L)</a> &raquo;
27
+ <span class='title'><a href="../Lifeline.html" title="Lifeline (module)">Lifeline</a></span>
28
+ &raquo;
29
+ <span class="title">LifelineRakeTask</span>
30
+
31
+
32
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
+ </div>
34
+
35
+ <div id="search">
36
+ <a id="class_list_link" href="#">Class List</a>
37
+ <a id="method_list_link" href="#">Method List</a>
38
+ <a id ="file_list_link" href="#">File List</a>
39
+ </div>
40
+
41
+ <div class="clear"></div>
42
+ </div>
43
+
44
+ <iframe id="search_frame"></iframe>
45
+
46
+ <div id="content"><h1>Class: Lifeline::LifelineRakeTask
47
+
48
+
49
+ </h1>
50
+
51
+ <dl class="box">
52
+
53
+ <dt class="r1">Inherits:</dt>
54
+ <dd class="r1">
55
+ <span class="inheritName">Rake::TaskLib</span>
56
+
57
+ <ul class="fullTree">
58
+ <li>Object</li>
59
+
60
+ <li class="next">Rake::TaskLib</li>
61
+
62
+ <li class="next">Lifeline::LifelineRakeTask</li>
63
+
64
+ </ul>
65
+ <a href="#" class="inheritanceTree">show all</a>
66
+
67
+ </dd>
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dt class="r2 last">Defined in:</dt>
78
+ <dd class="r2 last">lib/lifeline.rb</dd>
79
+
80
+ </dl>
81
+ <div class="clear"></div>
82
+
83
+ <h2>Overview</h2><div class="docstring">
84
+ <div class="discussion">
85
+ <p>
86
+ Define rake tasks for running, starting, and terminating
87
+ </p>
88
+
89
+
90
+ </div>
91
+ </div>
92
+ <div class="tags">
93
+
94
+ </div>
95
+
96
+
97
+ <h2>Instance Attribute Summary</h2>
98
+ <ul class="summary">
99
+
100
+ <li class="public ">
101
+ <span class="summary_signature">
102
+
103
+ <a href="#namespace-instance_method" title="#namespace (instance method)">- (String) <strong>namespace</strong> </a>
104
+
105
+
106
+
107
+ </span>
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+ <span class="summary_desc"><div class='inline'><p>
119
+ The namespace to define the tasks in.
120
+ </p>
121
+ </div></span>
122
+
123
+ </li>
124
+
125
+
126
+ </ul>
127
+
128
+
129
+
130
+ <h2>Instance Method Summary</h2>
131
+
132
+ <ul class="summary">
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (LifelineRakeTask) <strong>initialize</strong>(namespace, opts = {}, &amp;block) </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+ <span class="note title constructor">constructor</span>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+ <span class="summary_desc"><div class='inline'><p>
152
+ Creates 3 new tasks for the lifeline in the namespace specified.
153
+ </p>
154
+ </div></span>
155
+
156
+ </li>
157
+
158
+
159
+ </ul>
160
+
161
+
162
+
163
+ <div id="constructor_details" class="method_details_list">
164
+ <h2>Constructor Details</h2>
165
+
166
+ <div class="method_details first">
167
+ <p class="signature first" id="initialize-instance_method">
168
+
169
+ - (<tt><a href="" title="Lifeline::LifelineRakeTask (class)">LifelineRakeTask</a></tt>) <strong>initialize</strong>(namespace, opts = {}, &amp;block)
170
+
171
+
172
+
173
+ </p><div class="docstring">
174
+ <div class="discussion">
175
+ <p>
176
+ Creates 3 new tasks for the lifeline in the namespace specified. These
177
+ tasks are
178
+ </p>
179
+ <ul>
180
+ <li>run - a task for running the code provided in the block
181
+
182
+ </li>
183
+ <li>lifeline - a lifeline task for running the run task if it&#8217;s not
184
+ already running
185
+
186
+ </li>
187
+ <li>terminate - a task for terminating all lifelines.
188
+
189
+ </li>
190
+ </ul>
191
+
192
+
193
+ </div>
194
+ </div>
195
+ <div class="tags">
196
+ <h3>Parameters:</h3>
197
+ <ul class="param">
198
+
199
+ <li>
200
+
201
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
202
+
203
+
204
+ <span class='name'>name</span>
205
+
206
+
207
+
208
+ &mdash;
209
+ <div class='inline'><p>
210
+ the namespace of the rake tasks
211
+ </p>
212
+ </div>
213
+
214
+ </li>
215
+
216
+ <li>
217
+
218
+ <span class='type'>(<tt>optional</tt>, <tt>Hash</tt>)</span>
219
+
220
+
221
+ <span class='name'>opts</span>
222
+
223
+
224
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
225
+
226
+
227
+ &mdash;
228
+ <div class='inline'><p>
229
+ Additional options for the method
230
+ </p>
231
+ </div>
232
+
233
+ </li>
234
+
235
+ <li>
236
+
237
+ <span class='type'></span>
238
+
239
+
240
+ <span class='name'>a</span>
241
+
242
+
243
+
244
+ &mdash;
245
+ <div class='inline'><p>
246
+ block that defines the body of the run task
247
+ </p>
248
+ </div>
249
+
250
+ </li>
251
+
252
+ </ul>
253
+
254
+
255
+
256
+
257
+
258
+
259
+ <h3>Options Hash (<tt>opts</tt>):</h3>
260
+ <ul class="option">
261
+
262
+ <li>
263
+ <span class="type">(<tt>Array&lt;String, Symbol&gt;</tt>)</span>
264
+ <span class="name">:prereqs</span>
265
+ <span class="default">
266
+
267
+ &mdash; default:
268
+ <tt>[]</tt>
269
+
270
+ </span>
271
+ &mdash;<div class='inline'><p>
272
+ If there any any rake tasks that should be prerequisites of the :run task,
273
+ specify them here (For Rails, you would do :prereqs =&gt; :environment)
274
+ </p>
275
+ </div>
276
+ </tr>
277
+
278
+ </ul>
279
+
280
+
281
+
282
+
283
+ </div><table class="source_code">
284
+ <tr>
285
+ <td>
286
+ <pre class="lines">
287
+
288
+
289
+ 69
290
+ 70
291
+ 71
292
+ 72
293
+ 73
294
+ 74
295
+ 75
296
+ 76
297
+ 77
298
+ 78
299
+ 79</pre>
300
+ </td>
301
+ <td>
302
+ <pre class="code"><span class="info file"># File 'lib/lifeline.rb', line 69</span>
303
+
304
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='namespace identifier id'>namespace</span><span class='comma token'>,</span> <span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
305
+ <span class='if if kw'>if</span> <span class='notop op'>!</span><span class='block_given? fid id'>block_given?</span>
306
+ <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>&quot;You must pass in a block to be the body of the run rake task&quot;</span>
307
+ <span class='end end kw'>end</span>
308
+
309
+ <span class='@namespace ivar id'>@namespace</span> <span class='assign token'>=</span> <span class='namespace identifier id'>namespace</span>
310
+
311
+ <span class='define_run_task identifier id'>define_run_task</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
312
+ <span class='define_lifeline_task identifier id'>define_lifeline_task</span>
313
+ <span class='define_terminate_task identifier id'>define_terminate_task</span>
314
+ <span class='end end kw'>end</span>
315
+ </pre>
316
+ </td>
317
+ </tr>
318
+ </table>
319
+ </div>
320
+
321
+ </div>
322
+
323
+ <div id="instance_attr_details" class="attr_details">
324
+ <h2>Instance Attribute Details</h2>
325
+
326
+
327
+ <span id="namespace=-instance_method"></span>
328
+ <span id="namespace-instance_method"></span>
329
+ <div class="method_details first">
330
+ <p class="signature first" id="namespace-instance_method">
331
+
332
+ - (<tt>String</tt>) <strong>namespace</strong>
333
+
334
+
335
+
336
+ </p><div class="docstring">
337
+ <div class="discussion">
338
+ <p>
339
+ The namespace to define the tasks in
340
+ </p>
341
+
342
+
343
+ </div>
344
+ </div>
345
+ <div class="tags">
346
+ <h3>Returns:</h3>
347
+ <ul class="return">
348
+
349
+ <li>
350
+
351
+ <span class='type'>(<tt>String</tt>)</span>
352
+
353
+
354
+
355
+
356
+ &mdash;
357
+ <div class='inline'><p>
358
+ the namespace for the tasks
359
+ </p>
360
+ </div>
361
+
362
+ </li>
363
+
364
+ </ul>
365
+
366
+ </div><table class="source_code">
367
+ <tr>
368
+ <td>
369
+ <pre class="lines">
370
+
371
+
372
+ 56
373
+ 57
374
+ 58</pre>
375
+ </td>
376
+ <td>
377
+ <pre class="code"><span class="info file"># File 'lib/lifeline.rb', line 56</span>
378
+
379
+ <span class='def def kw'>def</span> <span class='namespace identifier id'>namespace</span>
380
+ <span class='@namespace ivar id'>@namespace</span>
381
+ <span class='end end kw'>end</span>
382
+ </pre>
383
+ </td>
384
+ </tr>
385
+ </table>
386
+ </div>
387
+
388
+ </div>
389
+
390
+
391
+ </div>
392
+
393
+ <div id="footer">
394
+ Generated on Tue Apr 13 12:07:29 2010 by
395
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
396
+ 0.5.4 (ruby-1.8.7).
397
+ </div>
398
+
399
+ </body>
400
+ </html>
@@ -0,0 +1,101 @@
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 name="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Documentation by YARD 0.5.4</title>
7
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+
27
+ <span class="title"></span>
28
+
29
+
30
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
31
+ </div>
32
+
33
+ <div id="search">
34
+ <a id="class_list_link" href="#">Class List</a>
35
+ <a id="method_list_link" href="#">Method List</a>
36
+ <a id ="file_list_link" href="#">File List</a>
37
+ </div>
38
+
39
+ <div class="clear"></div>
40
+ </div>
41
+
42
+ <iframe id="search_frame"></iframe>
43
+
44
+ <div id="content"><div id="listing">
45
+ <h1 class="noborder title">Documentation by YARD 0.5.4</h1>
46
+ <h1 class="alphaindex">Alphabetic Index</h1>
47
+
48
+
49
+ <h2>File Listing</h2>
50
+ <ul id="files">
51
+
52
+
53
+ <li class="r1"><a href="index.html" title="README">README</a></li>
54
+
55
+
56
+ </ul>
57
+
58
+ <div class="clear"></div>
59
+
60
+ <h2>Namespace Listing A-Z</h2>
61
+
62
+
63
+
64
+
65
+ <table>
66
+ <tr>
67
+ <td valign='top' width="33%">
68
+
69
+
70
+ <ul id="alpha_L" class="alpha">
71
+ <li class="letter">L</li>
72
+ <ul>
73
+
74
+ <li>
75
+ <a href="Lifeline.html" title="Lifeline (module)">Lifeline</a>
76
+
77
+ </li>
78
+
79
+ <li>
80
+ <a href="Lifeline/LifelineRakeTask.html" title="Lifeline::LifelineRakeTask (class)">LifelineRakeTask</a>
81
+
82
+ <small>(Lifeline)</small>
83
+
84
+ </li>
85
+
86
+ </ul>
87
+ </ul>
88
+
89
+ </td>
90
+ </tr>
91
+ </table>
92
+ </div></div>
93
+
94
+ <div id="footer">
95
+ Generated on Tue Apr 13 12:07:29 2010 by
96
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
97
+ 0.5.4 (ruby-1.8.7).
98
+ </div>
99
+
100
+ </body>
101
+ </html>