rask 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- data/README.rdoc +23 -15
- data/doc/Rask.html +356 -218
- data/doc/Rask/Task.html +161 -59
- data/doc/created.rid +1 -1
- data/doc/index.html +21 -31
- data/doc/lib/rask_rb.html +1 -1
- data/lib/rask.rb +125 -51
- metadata +1 -4
- data/doc/Rask/StateMachine.html +0 -379
- data/doc/Rask/StateMachine/ClassMethods.html +0 -190
- data/doc/lib/rask/state_machine_rb.html +0 -57
data/doc/Rask/Task.html
CHANGED
|
@@ -59,15 +59,19 @@
|
|
|
59
59
|
<h3 class="section-header">Methods</h3>
|
|
60
60
|
<ul class="link-list">
|
|
61
61
|
|
|
62
|
-
<li><a href="#
|
|
62
|
+
<li><a href="#M000000">::new</a></li>
|
|
63
63
|
|
|
64
|
-
<li><a href="#
|
|
64
|
+
<li><a href="#M000005">#destroy</a></li>
|
|
65
65
|
|
|
66
|
-
<li><a href="#
|
|
66
|
+
<li><a href="#M000006">#destroy?</a></li>
|
|
67
67
|
|
|
68
|
-
<li><a href="#
|
|
68
|
+
<li><a href="#M000003">#read_only</a></li>
|
|
69
69
|
|
|
70
|
-
<li><a href="#
|
|
70
|
+
<li><a href="#M000004">#read_only?</a></li>
|
|
71
|
+
|
|
72
|
+
<li><a href="#M000001">#run</a></li>
|
|
73
|
+
|
|
74
|
+
<li><a href="#M000002">#transition</a></li>
|
|
71
75
|
|
|
72
76
|
</ul>
|
|
73
77
|
</div>
|
|
@@ -80,7 +84,7 @@
|
|
|
80
84
|
<ul class="link-list">
|
|
81
85
|
|
|
82
86
|
|
|
83
|
-
<li><
|
|
87
|
+
<li><span class="include">StateMachine</span></li>
|
|
84
88
|
|
|
85
89
|
|
|
86
90
|
</ul>
|
|
@@ -109,10 +113,6 @@
|
|
|
109
113
|
|
|
110
114
|
<li><a href="../Rask.html">Rask</a></li>
|
|
111
115
|
|
|
112
|
-
<li><a href="../Rask/StateMachine.html">Rask::StateMachine</a></li>
|
|
113
|
-
|
|
114
|
-
<li><a href="../Rask/StateMachine/ClassMethods.html">Rask::StateMachine::ClassMethods</a></li>
|
|
115
|
-
|
|
116
116
|
<li><a href="../Rask/Task.html">Rask::Task</a></li>
|
|
117
117
|
|
|
118
118
|
</ul>
|
|
@@ -127,26 +127,41 @@
|
|
|
127
127
|
<h1 class="class">Rask::Task</h1>
|
|
128
128
|
|
|
129
129
|
<div id="description">
|
|
130
|
-
<
|
|
130
|
+
<table>
|
|
131
|
+
<tr><td valign="top">Authors:</td><td>mewlist / Hidenori Doi
|
|
132
|
+
|
|
133
|
+
</td></tr>
|
|
134
|
+
<tr><td valign="top">Copyright:</td><td>Copyright (C) 2010 mewlist / Hidenori Doi
|
|
135
|
+
|
|
136
|
+
</td></tr>
|
|
137
|
+
<tr><td valign="top">License:</td><td>The MIT License
|
|
138
|
+
|
|
139
|
+
</td></tr>
|
|
140
|
+
</table>
|
|
141
|
+
<h2><a href="Task.html">Task</a> base class</h2>
|
|
131
142
|
<p>
|
|
132
143
|
To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
133
144
|
</p>
|
|
134
145
|
<ul>
|
|
135
|
-
<li>
|
|
146
|
+
<li>Transition function is defined automatically, named transition_to_[state]
|
|
147
|
+
|
|
148
|
+
</li>
|
|
149
|
+
<li>For this sample, transition_to_finish is defined.
|
|
136
150
|
|
|
137
151
|
</li>
|
|
138
152
|
</ul>
|
|
153
|
+
<h4>sample code</h4>
|
|
139
154
|
<pre>
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
155
|
+
class NewTask < Rask::Task
|
|
156
|
+
define_state :initial, :initial => true
|
|
157
|
+
define_state :finish
|
|
158
|
+
def initial
|
|
159
|
+
transition_to_finish
|
|
160
|
+
end
|
|
161
|
+
def finish
|
|
162
|
+
destroy
|
|
163
|
+
end
|
|
148
164
|
end
|
|
149
|
-
end
|
|
150
165
|
</pre>
|
|
151
166
|
|
|
152
167
|
</div>
|
|
@@ -172,7 +187,7 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
172
187
|
|
|
173
188
|
<div class="method-description">
|
|
174
189
|
|
|
175
|
-
|
|
190
|
+
|
|
176
191
|
|
|
177
192
|
</div>
|
|
178
193
|
</div>
|
|
@@ -189,7 +204,22 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
189
204
|
|
|
190
205
|
<div class="method-description">
|
|
191
206
|
|
|
192
|
-
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</div>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
<div id="state-attribute-method" class="method-detail">
|
|
213
|
+
<a name="state"></a>
|
|
214
|
+
|
|
215
|
+
<div class="method-heading attribute-method-heading">
|
|
216
|
+
<span class="method-name">state</span><span
|
|
217
|
+
class="attribute-access-type">[R]</span>
|
|
218
|
+
</div>
|
|
219
|
+
|
|
220
|
+
<div class="method-description">
|
|
221
|
+
|
|
222
|
+
|
|
193
223
|
|
|
194
224
|
</div>
|
|
195
225
|
</div>
|
|
@@ -204,7 +234,7 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
204
234
|
|
|
205
235
|
|
|
206
236
|
<div id="new-method" class="method-detail ">
|
|
207
|
-
<a name="
|
|
237
|
+
<a name="M000000"></a>
|
|
208
238
|
|
|
209
239
|
<div class="method-heading">
|
|
210
240
|
|
|
@@ -216,10 +246,17 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
216
246
|
|
|
217
247
|
<div class="method-description">
|
|
218
248
|
|
|
219
|
-
<
|
|
220
|
-
<
|
|
249
|
+
<dl>
|
|
250
|
+
<dt>_group</dt><dd>group name to classify. You can filter task group when call
|
|
251
|
+
<b>Rask::task_ids / Rask::daemon</b> methods.
|
|
252
|
+
|
|
253
|
+
</dd>
|
|
254
|
+
</dl>
|
|
255
|
+
<h3>If group option is given, the task is classified by group name.</h3>
|
|
256
|
+
<h4>sample code</h4>
|
|
221
257
|
<pre>
|
|
222
|
-
|
|
258
|
+
Rask::insert NewTask.new('group_name')
|
|
259
|
+
Rask::daemon(:group => 'group_name')
|
|
223
260
|
</pre>
|
|
224
261
|
|
|
225
262
|
|
|
@@ -227,11 +264,11 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
227
264
|
<div class="method-source-code"
|
|
228
265
|
id="new-source">
|
|
229
266
|
<pre>
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
267
|
+
<span class="ruby-comment cmt"># File lib/rask.rb, line 87</span>
|
|
268
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_group</span>=<span class="ruby-keyword kw">nil</span>)
|
|
269
|
+
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">group</span> = <span class="ruby-identifier">_group</span>
|
|
270
|
+
<span class="ruby-keyword kw">super</span>()
|
|
271
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
235
272
|
</div>
|
|
236
273
|
|
|
237
274
|
</div>
|
|
@@ -247,7 +284,7 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
247
284
|
|
|
248
285
|
|
|
249
286
|
<div id="destroy-method" class="method-detail ">
|
|
250
|
-
<a name="
|
|
287
|
+
<a name="M000005"></a>
|
|
251
288
|
|
|
252
289
|
<div class="method-heading">
|
|
253
290
|
|
|
@@ -266,10 +303,10 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
266
303
|
<div class="method-source-code"
|
|
267
304
|
id="destroy-source">
|
|
268
305
|
<pre>
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
306
|
+
<span class="ruby-comment cmt"># File lib/rask.rb, line 120</span>
|
|
307
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destroy</span>
|
|
308
|
+
<span class="ruby-identifier">transition</span> <span class="ruby-keyword kw">nil</span>
|
|
309
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
273
310
|
</div>
|
|
274
311
|
|
|
275
312
|
</div>
|
|
@@ -279,7 +316,7 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
279
316
|
|
|
280
317
|
|
|
281
318
|
<div id="destroy--method" class="method-detail ">
|
|
282
|
-
<a name="
|
|
319
|
+
<a name="M000006"></a>
|
|
283
320
|
|
|
284
321
|
<div class="method-heading">
|
|
285
322
|
|
|
@@ -298,10 +335,74 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
298
335
|
<div class="method-source-code"
|
|
299
336
|
id="destroy--source">
|
|
300
337
|
<pre>
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
338
|
+
<span class="ruby-comment cmt"># File lib/rask.rb, line 125</span>
|
|
339
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destroy?</span>
|
|
340
|
+
<span class="ruby-ivar">@state</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
|
|
341
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
342
|
+
</div>
|
|
343
|
+
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<div id="read-only-method" class="method-detail ">
|
|
351
|
+
<a name="M000003"></a>
|
|
352
|
+
|
|
353
|
+
<div class="method-heading">
|
|
354
|
+
|
|
355
|
+
<span class="method-name">read_only</span><span
|
|
356
|
+
class="method-args">()</span>
|
|
357
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
358
|
+
|
|
359
|
+
</div>
|
|
360
|
+
|
|
361
|
+
<div class="method-description">
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
<div class="method-source-code"
|
|
368
|
+
id="read-only-source">
|
|
369
|
+
<pre>
|
|
370
|
+
<span class="ruby-comment cmt"># File lib/rask.rb, line 110</span>
|
|
371
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_only</span>
|
|
372
|
+
<span class="ruby-ivar">@read_only</span> = <span class="ruby-keyword kw">true</span>
|
|
373
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
374
|
+
</div>
|
|
375
|
+
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
</div>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<div id="read-only--method" class="method-detail ">
|
|
383
|
+
<a name="M000004"></a>
|
|
384
|
+
|
|
385
|
+
<div class="method-heading">
|
|
386
|
+
|
|
387
|
+
<span class="method-name">read_only?</span><span
|
|
388
|
+
class="method-args">()</span>
|
|
389
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
390
|
+
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
<div class="method-description">
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<div class="method-source-code"
|
|
400
|
+
id="read-only--source">
|
|
401
|
+
<pre>
|
|
402
|
+
<span class="ruby-comment cmt"># File lib/rask.rb, line 115</span>
|
|
403
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_only?</span>
|
|
404
|
+
<span class="ruby-ivar">@read_only</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">true</span>
|
|
405
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
305
406
|
</div>
|
|
306
407
|
|
|
307
408
|
</div>
|
|
@@ -311,7 +412,7 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
311
412
|
|
|
312
413
|
|
|
313
414
|
<div id="run-method" class="method-detail ">
|
|
314
|
-
<a name="
|
|
415
|
+
<a name="M000001"></a>
|
|
315
416
|
|
|
316
417
|
<div class="method-heading">
|
|
317
418
|
|
|
@@ -323,19 +424,20 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
323
424
|
|
|
324
425
|
<div class="method-description">
|
|
325
426
|
|
|
326
|
-
<
|
|
427
|
+
<h3>automatically callbacked from task engine.</h3>
|
|
327
428
|
|
|
328
429
|
|
|
329
430
|
|
|
330
431
|
<div class="method-source-code"
|
|
331
432
|
id="run-source">
|
|
332
433
|
<pre>
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
434
|
+
<span class="ruby-comment cmt"># File lib/rask.rb, line 95</span>
|
|
435
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
|
|
436
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">read_only?</span>
|
|
437
|
+
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@state</span>
|
|
438
|
+
<span class="ruby-identifier">eval</span> <span class="ruby-ivar">@state</span>.<span class="ruby-identifier">to_s</span>
|
|
439
|
+
<span class="ruby-keyword kw">end</span>
|
|
440
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
339
441
|
</div>
|
|
340
442
|
|
|
341
443
|
</div>
|
|
@@ -345,7 +447,7 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
345
447
|
|
|
346
448
|
|
|
347
449
|
<div id="transition-method" class="method-detail ">
|
|
348
|
-
<a name="
|
|
450
|
+
<a name="M000002"></a>
|
|
349
451
|
|
|
350
452
|
<div class="method-heading">
|
|
351
453
|
|
|
@@ -357,20 +459,20 @@ To define new <a href="Task.html">Task</a> you must inherit this base-class
|
|
|
357
459
|
|
|
358
460
|
<div class="method-description">
|
|
359
461
|
|
|
360
|
-
<
|
|
361
|
-
<
|
|
362
|
-
|
|
363
|
-
</
|
|
462
|
+
<h3>Transition to new state. In the state function.</h3>
|
|
463
|
+
<p>
|
|
464
|
+
Usually you should call generated transition_to_[state name] function
|
|
465
|
+
</p>
|
|
364
466
|
|
|
365
467
|
|
|
366
468
|
|
|
367
469
|
<div class="method-source-code"
|
|
368
470
|
id="transition-source">
|
|
369
471
|
<pre>
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
472
|
+
<span class="ruby-comment cmt"># File lib/rask.rb, line 105</span>
|
|
473
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">transition</span>(<span class="ruby-identifier">to</span>)
|
|
474
|
+
<span class="ruby-ivar">@state</span> = <span class="ruby-identifier">to</span>
|
|
475
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
374
476
|
</div>
|
|
375
477
|
|
|
376
478
|
</div>
|
data/doc/created.rid
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
Sun, 28 Feb 2010 22:50:48 +0900
|
data/doc/index.html
CHANGED
|
@@ -33,10 +33,6 @@
|
|
|
33
33
|
|
|
34
34
|
<li class="module"><a href="Rask.html">Rask</a></li>
|
|
35
35
|
|
|
36
|
-
<li class="module"><a href="Rask/StateMachine.html">Rask::StateMachine</a></li>
|
|
37
|
-
|
|
38
|
-
<li class="module"><a href="Rask/StateMachine/ClassMethods.html">Rask::StateMachine::ClassMethods</a></li>
|
|
39
|
-
|
|
40
36
|
<li class="class"><a href="Rask/Task.html">Rask::Task</a></li>
|
|
41
37
|
|
|
42
38
|
</ul>
|
|
@@ -44,53 +40,47 @@
|
|
|
44
40
|
<h2>Methods</h2>
|
|
45
41
|
<ul>
|
|
46
42
|
|
|
47
|
-
<li><a href="Rask.html#
|
|
48
|
-
|
|
49
|
-
<li><a href="Rask.html#M000022">::daemon — Rask</a></li>
|
|
50
|
-
|
|
51
|
-
<li><a href="Rask.html#M000020">::destroy — Rask</a></li>
|
|
52
|
-
|
|
53
|
-
<li><a href="Rask/StateMachine.html#M000006">::included — Rask::StateMachine</a></li>
|
|
43
|
+
<li><a href="Rask.html#M000007">::base_directory= — Rask</a></li>
|
|
54
44
|
|
|
55
|
-
<li><a href="Rask.html#
|
|
45
|
+
<li><a href="Rask.html#M000017">::daemon — Rask</a></li>
|
|
56
46
|
|
|
57
|
-
<li><a href="Rask.html#M000016">::
|
|
47
|
+
<li><a href="Rask.html#M000016">::destroy — Rask</a></li>
|
|
58
48
|
|
|
59
|
-
<li><a href="Rask
|
|
49
|
+
<li><a href="Rask.html#M000018">::initialize_storage — Rask</a></li>
|
|
60
50
|
|
|
61
|
-
<li><a href="Rask
|
|
51
|
+
<li><a href="Rask.html#M000011">::insert — Rask</a></li>
|
|
62
52
|
|
|
63
|
-
<li><a href="Rask.html#
|
|
53
|
+
<li><a href="Rask/Task.html#M000000">::new — Rask::Task</a></li>
|
|
64
54
|
|
|
65
|
-
<li><a href="Rask.html#
|
|
55
|
+
<li><a href="Rask.html#M000010">::pid_path — Rask</a></li>
|
|
66
56
|
|
|
67
|
-
<li><a href="Rask.html#
|
|
57
|
+
<li><a href="Rask.html#M000014">::read — Rask</a></li>
|
|
68
58
|
|
|
69
|
-
<li><a href="Rask.html#
|
|
59
|
+
<li><a href="Rask.html#M000012">::run — Rask</a></li>
|
|
70
60
|
|
|
71
|
-
<li><a href="Rask.html#
|
|
61
|
+
<li><a href="Rask.html#M000013">::run_all — Rask</a></li>
|
|
72
62
|
|
|
73
|
-
<li><a href="Rask.html#
|
|
63
|
+
<li><a href="Rask.html#M000019">::safe_class_name — Rask</a></li>
|
|
74
64
|
|
|
75
|
-
<li><a href="Rask.html#
|
|
65
|
+
<li><a href="Rask.html#M000020">::safe_exit — Rask</a></li>
|
|
76
66
|
|
|
77
|
-
<li><a href="Rask
|
|
67
|
+
<li><a href="Rask.html#M000015">::task_ids — Rask</a></li>
|
|
78
68
|
|
|
79
|
-
<li><a href="Rask
|
|
69
|
+
<li><a href="Rask.html#M000009">::task_path — Rask</a></li>
|
|
80
70
|
|
|
81
|
-
<li><a href="Rask
|
|
71
|
+
<li><a href="Rask.html#M000008">::thread_max_count= — Rask</a></li>
|
|
82
72
|
|
|
83
|
-
<li><a href="Rask/
|
|
73
|
+
<li><a href="Rask/Task.html#M000005">#destroy — Rask::Task</a></li>
|
|
84
74
|
|
|
85
|
-
<li><a href="Rask/Task.html#
|
|
75
|
+
<li><a href="Rask/Task.html#M000006">#destroy? — Rask::Task</a></li>
|
|
86
76
|
|
|
87
|
-
<li><a href="Rask/
|
|
77
|
+
<li><a href="Rask/Task.html#M000003">#read_only — Rask::Task</a></li>
|
|
88
78
|
|
|
89
|
-
<li><a href="Rask/Task.html#
|
|
79
|
+
<li><a href="Rask/Task.html#M000004">#read_only? — Rask::Task</a></li>
|
|
90
80
|
|
|
91
|
-
<li><a href="Rask/
|
|
81
|
+
<li><a href="Rask/Task.html#M000001">#run — Rask::Task</a></li>
|
|
92
82
|
|
|
93
|
-
<li><a href="Rask/Task.html#
|
|
83
|
+
<li><a href="Rask/Task.html#M000002">#transition — Rask::Task</a></li>
|
|
94
84
|
|
|
95
85
|
</ul>
|
|
96
86
|
|
data/doc/lib/rask_rb.html
CHANGED