rask 0.0.1 → 0.0.2

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.
@@ -0,0 +1,402 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Rask::Task</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="file-metadata">
26
+ <div id="file-list-section" class="section">
27
+ <h3 class="section-header">In Files</h3>
28
+ <div class="section-body">
29
+ <ul>
30
+
31
+ <li><a href="../lib/rask_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="lib/rask.rb">lib/rask.rb</a></li>
33
+
34
+ </ul>
35
+ </div>
36
+ </div>
37
+
38
+
39
+ </div>
40
+
41
+ <div id="class-metadata">
42
+
43
+ <!-- Parent Class -->
44
+
45
+ <div id="parent-class-section" class="section">
46
+ <h3 class="section-header">Parent</h3>
47
+
48
+ <p class="link">Object</p>
49
+
50
+ </div>
51
+
52
+
53
+ <!-- Namespace Contents -->
54
+
55
+
56
+ <!-- Method Quickref -->
57
+
58
+ <div id="method-list-section" class="section">
59
+ <h3 class="section-header">Methods</h3>
60
+ <ul class="link-list">
61
+
62
+ <li><a href="#M000002">::new</a></li>
63
+
64
+ <li><a href="#M000010">#destroy</a></li>
65
+
66
+ <li><a href="#M000011">#destroy?</a></li>
67
+
68
+ <li><a href="#M000007">#run</a></li>
69
+
70
+ <li><a href="#M000008">#transition</a></li>
71
+
72
+ </ul>
73
+ </div>
74
+
75
+
76
+ <!-- Included Modules -->
77
+
78
+ <div id="includes-section" class="section">
79
+ <h3 class="section-header">Included Modules</h3>
80
+ <ul class="link-list">
81
+
82
+
83
+ <li><a class="include" href="StateMachine/ClassMethods.html">Rask::StateMachine::ClassMethods</a></li>
84
+
85
+
86
+ </ul>
87
+ </div>
88
+
89
+ </div>
90
+
91
+ <div id="project-metadata">
92
+
93
+
94
+
95
+ <div id="classindex-section" class="section project-section">
96
+ <h3 class="section-header">Class Index
97
+ <span class="search-toggle"><img src="../images/find.png"
98
+ height="16" width="16" alt="[+]"
99
+ title="show/hide quicksearch" /></span></h3>
100
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
101
+ <fieldset>
102
+ <legend>Quicksearch</legend>
103
+ <input type="text" name="quicksearch" value=""
104
+ class="quicksearch-field" />
105
+ </fieldset>
106
+ </form>
107
+
108
+ <ul class="link-list">
109
+
110
+ <li><a href="../Rask.html">Rask</a></li>
111
+
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
+ <li><a href="../Rask/Task.html">Rask::Task</a></li>
117
+
118
+ </ul>
119
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
120
+ </div>
121
+
122
+
123
+ </div>
124
+ </div>
125
+
126
+ <div id="documentation">
127
+ <h1 class="class">Rask::Task</h1>
128
+
129
+ <div id="description">
130
+ <h3><a href="Task.html">Task</a> base class</h3>
131
+ <p>
132
+ To define new <a href="Task.html">Task</a> you must inherit this base-class
133
+ </p>
134
+ <ul>
135
+ <li>sample code
136
+
137
+ </li>
138
+ </ul>
139
+ <pre>
140
+ class NewTask &lt; Rask::Task
141
+ define_state :initial, :initial =&gt; true
142
+ define_state :finish
143
+ def initial
144
+ transition :finish
145
+ end
146
+ def finish
147
+ destroy
148
+ end
149
+ end
150
+ </pre>
151
+
152
+ </div>
153
+
154
+ <!-- Constants -->
155
+
156
+
157
+ <!-- Attributes -->
158
+
159
+ <div id="attribute-method-details" class="method-section section">
160
+ <h3 class="section-header">Attributes</h3>
161
+
162
+
163
+ <div id="task-id-attribute-method" class="method-detail">
164
+ <a name="task_id"></a>
165
+
166
+ <a name="task_id="></a>
167
+
168
+ <div class="method-heading attribute-method-heading">
169
+ <span class="method-name">task_id</span><span
170
+ class="attribute-access-type">[RW]</span>
171
+ </div>
172
+
173
+ <div class="method-description">
174
+
175
+ <p class="missing-docs">(Not documented)</p>
176
+
177
+ </div>
178
+ </div>
179
+
180
+ <div id="group-attribute-method" class="method-detail">
181
+ <a name="group"></a>
182
+
183
+ <a name="group="></a>
184
+
185
+ <div class="method-heading attribute-method-heading">
186
+ <span class="method-name">group</span><span
187
+ class="attribute-access-type">[RW]</span>
188
+ </div>
189
+
190
+ <div class="method-description">
191
+
192
+ <p class="missing-docs">(Not documented)</p>
193
+
194
+ </div>
195
+ </div>
196
+
197
+ </div>
198
+
199
+
200
+ <!-- Methods -->
201
+
202
+ <div id="public-class-method-details" class="method-section section">
203
+ <h3 class="section-header">Public Class Methods</h3>
204
+
205
+
206
+ <div id="new-method" class="method-detail ">
207
+ <a name="M000002"></a>
208
+
209
+ <div class="method-heading">
210
+
211
+ <span class="method-name">new</span><span
212
+ class="method-args">(_group=nil)</span>
213
+ <span class="method-click-advice">click to toggle source</span>
214
+
215
+ </div>
216
+
217
+ <div class="method-description">
218
+
219
+ <h4>If group option is given, the task is classified by group name.</h4>
220
+ <h4>_group</h4>
221
+ <pre>
222
+ group name to classify
223
+ </pre>
224
+
225
+
226
+
227
+ <div class="method-source-code"
228
+ id="new-source">
229
+ <pre>
230
+ <span class="ruby-comment cmt"># File lib/rask.rb, line 42</span>
231
+ 42: <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>)
232
+ 43: <span class="ruby-identifier">group</span> = <span class="ruby-identifier">_group</span>
233
+ 44: <span class="ruby-keyword kw">super</span>()
234
+ 45: <span class="ruby-keyword kw">end</span></pre>
235
+ </div>
236
+
237
+ </div>
238
+
239
+
240
+ </div>
241
+
242
+
243
+ </div>
244
+
245
+ <div id="public-instance-method-details" class="method-section section">
246
+ <h3 class="section-header">Public Instance Methods</h3>
247
+
248
+
249
+ <div id="destroy-method" class="method-detail ">
250
+ <a name="M000010"></a>
251
+
252
+ <div class="method-heading">
253
+
254
+ <span class="method-name">destroy</span><span
255
+ class="method-args">()</span>
256
+ <span class="method-click-advice">click to toggle source</span>
257
+
258
+ </div>
259
+
260
+ <div class="method-description">
261
+
262
+
263
+
264
+
265
+
266
+ <div class="method-source-code"
267
+ id="destroy-source">
268
+ <pre>
269
+ <span class="ruby-comment cmt"># File lib/rask.rb, line 65</span>
270
+ 65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destroy</span>
271
+ 66: <span class="ruby-identifier">transition</span> <span class="ruby-keyword kw">nil</span>
272
+ 67: <span class="ruby-keyword kw">end</span></pre>
273
+ </div>
274
+
275
+ </div>
276
+
277
+
278
+ </div>
279
+
280
+
281
+ <div id="destroy--method" class="method-detail ">
282
+ <a name="M000011"></a>
283
+
284
+ <div class="method-heading">
285
+
286
+ <span class="method-name">destroy?</span><span
287
+ class="method-args">()</span>
288
+ <span class="method-click-advice">click to toggle source</span>
289
+
290
+ </div>
291
+
292
+ <div class="method-description">
293
+
294
+
295
+
296
+
297
+
298
+ <div class="method-source-code"
299
+ id="destroy--source">
300
+ <pre>
301
+ <span class="ruby-comment cmt"># File lib/rask.rb, line 70</span>
302
+ 70: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destroy?</span>
303
+ 71: <span class="ruby-ivar">@state</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
304
+ 72: <span class="ruby-keyword kw">end</span></pre>
305
+ </div>
306
+
307
+ </div>
308
+
309
+
310
+ </div>
311
+
312
+
313
+ <div id="run-method" class="method-detail ">
314
+ <a name="M000007"></a>
315
+
316
+ <div class="method-heading">
317
+
318
+ <span class="method-name">run</span><span
319
+ class="method-args">()</span>
320
+ <span class="method-click-advice">click to toggle source</span>
321
+
322
+ </div>
323
+
324
+ <div class="method-description">
325
+
326
+ <h4>automatically callbacked from task engine.</h4>
327
+
328
+
329
+
330
+ <div class="method-source-code"
331
+ id="run-source">
332
+ <pre>
333
+ <span class="ruby-comment cmt"># File lib/rask.rb, line 50</span>
334
+ 50: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
335
+ 51: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@state</span>
336
+ 52: <span class="ruby-identifier">eval</span> <span class="ruby-ivar">@state</span>.<span class="ruby-identifier">to_s</span>
337
+ 53: <span class="ruby-keyword kw">end</span>
338
+ 54: <span class="ruby-keyword kw">end</span></pre>
339
+ </div>
340
+
341
+ </div>
342
+
343
+
344
+ </div>
345
+
346
+
347
+ <div id="transition-method" class="method-detail ">
348
+ <a name="M000008"></a>
349
+
350
+ <div class="method-heading">
351
+
352
+ <span class="method-name">transition</span><span
353
+ class="method-args">(to)</span>
354
+ <span class="method-click-advice">click to toggle source</span>
355
+
356
+ </div>
357
+
358
+ <div class="method-description">
359
+
360
+ <h4>Transition to new state. In the state function.</h4>
361
+ <pre>
362
+ Usually you should call generated transition_to_[state name] function
363
+ </pre>
364
+
365
+
366
+
367
+ <div class="method-source-code"
368
+ id="transition-source">
369
+ <pre>
370
+ <span class="ruby-comment cmt"># File lib/rask.rb, line 59</span>
371
+ 59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">transition</span>(<span class="ruby-identifier">to</span>)
372
+ 60: <span class="ruby-ivar">@state</span> = <span class="ruby-identifier">to</span>
373
+ 61: <span class="ruby-keyword kw">end</span></pre>
374
+ </div>
375
+
376
+ </div>
377
+
378
+
379
+ </div>
380
+
381
+
382
+ </div>
383
+
384
+
385
+ </div>
386
+
387
+
388
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
389
+
390
+ <p>Disabled; run with --debug to generate this.</p>
391
+
392
+ </div>
393
+
394
+ <div id="validator-badges">
395
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
396
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
397
+ Rdoc Generator</a> 1.1.6</small>.</p>
398
+ </div>
399
+
400
+ </body>
401
+ </html>
402
+
@@ -0,0 +1 @@
1
+ Sat, 27 Feb 2010 13:38:05 +0900
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
@@ -0,0 +1,103 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>RDoc Documentation</title>
10
+
11
+ <link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="js/jquery.js" type="text/javascript" charset="utf-8"></script>
14
+ <script src="js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
15
+ <script src="js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
16
+ <script src="js/darkfish.js" type="text/javascript" charset="utf-8"></script>
17
+
18
+ </head>
19
+ <body class="indexpage">
20
+
21
+
22
+ <h1>RDoc Documentation</h1>
23
+
24
+
25
+ <p>This is the API documentation for 'RDoc Documentation'.</p>
26
+
27
+
28
+
29
+
30
+
31
+ <h2>Classes/Modules</h2>
32
+ <ul>
33
+
34
+ <li class="module"><a href="Rask.html">Rask</a></li>
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
+ <li class="class"><a href="Rask/Task.html">Rask::Task</a></li>
41
+
42
+ </ul>
43
+
44
+ <h2>Methods</h2>
45
+ <ul>
46
+
47
+ <li><a href="Rask.html#M000012">::base_directory= &mdash; Rask</a></li>
48
+
49
+ <li><a href="Rask.html#M000022">::daemon &mdash; Rask</a></li>
50
+
51
+ <li><a href="Rask.html#M000020">::destroy &mdash; Rask</a></li>
52
+
53
+ <li><a href="Rask/StateMachine.html#M000006">::included &mdash; Rask::StateMachine</a></li>
54
+
55
+ <li><a href="Rask.html#M000019">::initialize_storage &mdash; Rask</a></li>
56
+
57
+ <li><a href="Rask.html#M000016">::insert &mdash; Rask</a></li>
58
+
59
+ <li><a href="Rask/Task.html#M000002">::new &mdash; Rask::Task</a></li>
60
+
61
+ <li><a href="Rask/StateMachine.html#M000000">::new &mdash; Rask::StateMachine</a></li>
62
+
63
+ <li><a href="Rask.html#M000015">::pid_path &mdash; Rask</a></li>
64
+
65
+ <li><a href="Rask.html#M000017">::run &mdash; Rask</a></li>
66
+
67
+ <li><a href="Rask.html#M000021">::safe_class_name &mdash; Rask</a></li>
68
+
69
+ <li><a href="Rask.html#M000023">::safe_exit &mdash; Rask</a></li>
70
+
71
+ <li><a href="Rask.html#M000014">::task_path &mdash; Rask</a></li>
72
+
73
+ <li><a href="Rask.html#M000018">::tasks &mdash; Rask</a></li>
74
+
75
+ <li><a href="Rask.html#M000013">::thread_max_count= &mdash; Rask</a></li>
76
+
77
+ <li><a href="Rask/StateMachine/ClassMethods.html#M000009">#define_state &mdash; Rask::StateMachine::ClassMethods</a></li>
78
+
79
+ <li><a href="Rask/Task.html#M000010">#destroy &mdash; Rask::Task</a></li>
80
+
81
+ <li><a href="Rask/StateMachine.html#M000004">#destroy &mdash; Rask::StateMachine</a></li>
82
+
83
+ <li><a href="Rask/StateMachine.html#M000005">#destroy? &mdash; Rask::StateMachine</a></li>
84
+
85
+ <li><a href="Rask/Task.html#M000011">#destroy? &mdash; Rask::Task</a></li>
86
+
87
+ <li><a href="Rask/StateMachine.html#M000001">#initial_state &mdash; Rask::StateMachine</a></li>
88
+
89
+ <li><a href="Rask/Task.html#M000007">#run &mdash; Rask::Task</a></li>
90
+
91
+ <li><a href="Rask/StateMachine.html#M000003">#transition &mdash; Rask::StateMachine</a></li>
92
+
93
+ <li><a href="Rask/Task.html#M000008">#transition &mdash; Rask::Task</a></li>
94
+
95
+ </ul>
96
+
97
+ <div id="validator-badges">
98
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
99
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
100
+ Rdoc Generator</a> 1.1.6</small>.</p>
101
+ </div>
102
+ </body>
103
+ </html>