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,379 @@
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>Module: Rask::StateMachine</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="module">
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/state_machine_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="lib/rask/state_machine.rb">lib/rask/state_machine.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
+
46
+ <!-- Namespace Contents -->
47
+
48
+ <div id="namespace-list-section" class="section">
49
+ <h3 class="section-header">Namespace</h3>
50
+ <ul class="link-list">
51
+
52
+ <li><span class="type">MODULE</span> <a href="StateMachine/ClassMethods.html">Rask::StateMachine::ClassMethods</a></li>
53
+
54
+ </ul>
55
+ </div>
56
+
57
+
58
+ <!-- Method Quickref -->
59
+
60
+ <div id="method-list-section" class="section">
61
+ <h3 class="section-header">Methods</h3>
62
+ <ul class="link-list">
63
+
64
+ <li><a href="#M000006">::included</a></li>
65
+
66
+ <li><a href="#M000000">::new</a></li>
67
+
68
+ <li><a href="#M000004">#destroy</a></li>
69
+
70
+ <li><a href="#M000005">#destroy?</a></li>
71
+
72
+ <li><a href="#M000001">#initial_state</a></li>
73
+
74
+ <li><a href="#M000003">#transition</a></li>
75
+
76
+ </ul>
77
+ </div>
78
+
79
+
80
+ <!-- Included Modules -->
81
+
82
+ </div>
83
+
84
+ <div id="project-metadata">
85
+
86
+
87
+
88
+ <div id="classindex-section" class="section project-section">
89
+ <h3 class="section-header">Class Index
90
+ <span class="search-toggle"><img src="../images/find.png"
91
+ height="16" width="16" alt="[+]"
92
+ title="show/hide quicksearch" /></span></h3>
93
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
94
+ <fieldset>
95
+ <legend>Quicksearch</legend>
96
+ <input type="text" name="quicksearch" value=""
97
+ class="quicksearch-field" />
98
+ </fieldset>
99
+ </form>
100
+
101
+ <ul class="link-list">
102
+
103
+ <li><a href="../Rask.html">Rask</a></li>
104
+
105
+ <li><a href="../Rask/StateMachine.html">Rask::StateMachine</a></li>
106
+
107
+ <li><a href="../Rask/StateMachine/ClassMethods.html">Rask::StateMachine::ClassMethods</a></li>
108
+
109
+ <li><a href="../Rask/Task.html">Rask::Task</a></li>
110
+
111
+ </ul>
112
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
113
+ </div>
114
+
115
+
116
+ </div>
117
+ </div>
118
+
119
+ <div id="documentation">
120
+ <h1 class="module">Rask::StateMachine</h1>
121
+
122
+ <div id="description">
123
+
124
+ </div>
125
+
126
+ <!-- Constants -->
127
+
128
+
129
+ <!-- Attributes -->
130
+
131
+ <div id="attribute-method-details" class="method-section section">
132
+ <h3 class="section-header">Attributes</h3>
133
+
134
+
135
+ <div id="state-attribute-method" class="method-detail">
136
+ <a name="state"></a>
137
+
138
+ <a name="state="></a>
139
+
140
+ <div class="method-heading attribute-method-heading">
141
+ <span class="method-name">state</span><span
142
+ class="attribute-access-type">[RW]</span>
143
+ </div>
144
+
145
+ <div class="method-description">
146
+
147
+ <p class="missing-docs">(Not documented)</p>
148
+
149
+ </div>
150
+ </div>
151
+
152
+ </div>
153
+
154
+
155
+ <!-- Methods -->
156
+
157
+ <div id="public-class-method-details" class="method-section section">
158
+ <h3 class="section-header">Public Class Methods</h3>
159
+
160
+
161
+ <div id="included-method" class="method-detail ">
162
+ <a name="M000006"></a>
163
+
164
+ <div class="method-heading">
165
+
166
+ <span class="method-name">included</span><span
167
+ class="method-args">(base)</span>
168
+ <span class="method-click-advice">click to toggle source</span>
169
+
170
+ </div>
171
+
172
+ <div class="method-description">
173
+
174
+ <p class="missing-docs">(Not documented)</p>
175
+
176
+
177
+
178
+ <div class="method-source-code"
179
+ id="included-source">
180
+ <pre>
181
+ <span class="ruby-comment cmt"># File lib/rask/state_machine.rb, line 47</span>
182
+ 47: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">base</span>)
183
+ 48: <span class="ruby-identifier">base</span>.<span class="ruby-identifier">extend</span>(<span class="ruby-constant">ClassMethods</span>)
184
+ 49: <span class="ruby-keyword kw">end</span></pre>
185
+ </div>
186
+
187
+ </div>
188
+
189
+
190
+ </div>
191
+
192
+
193
+ <div id="new-method" class="method-detail ">
194
+ <a name="M000000"></a>
195
+
196
+ <div class="method-heading">
197
+
198
+ <span class="method-name">new</span><span
199
+ class="method-args">()</span>
200
+ <span class="method-click-advice">click to toggle source</span>
201
+
202
+ </div>
203
+
204
+ <div class="method-description">
205
+
206
+ <p class="missing-docs">(Not documented)</p>
207
+
208
+
209
+
210
+ <div class="method-source-code"
211
+ id="new-source">
212
+ <pre>
213
+ <span class="ruby-comment cmt"># File lib/rask/state_machine.rb, line 16</span>
214
+ 16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
215
+ 17: <span class="ruby-ivar">@state</span> = <span class="ruby-identifier">initial_state</span>
216
+ 18: <span class="ruby-keyword kw">end</span></pre>
217
+ </div>
218
+
219
+ </div>
220
+
221
+
222
+ </div>
223
+
224
+
225
+ </div>
226
+
227
+ <div id="public-instance-method-details" class="method-section section">
228
+ <h3 class="section-header">Public Instance Methods</h3>
229
+
230
+
231
+ <div id="destroy-method" class="method-detail ">
232
+ <a name="M000004"></a>
233
+
234
+ <div class="method-heading">
235
+
236
+ <span class="method-name">destroy</span><span
237
+ class="method-args">()</span>
238
+ <span class="method-click-advice">click to toggle source</span>
239
+
240
+ </div>
241
+
242
+ <div class="method-description">
243
+
244
+ <p class="missing-docs">(Not documented)</p>
245
+
246
+
247
+
248
+ <div class="method-source-code"
249
+ id="destroy-source">
250
+ <pre>
251
+ <span class="ruby-comment cmt"># File lib/rask/state_machine.rb, line 31</span>
252
+ 31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destroy</span>
253
+ 32: <span class="ruby-identifier">transition</span> <span class="ruby-keyword kw">nil</span>
254
+ 33: <span class="ruby-keyword kw">end</span></pre>
255
+ </div>
256
+
257
+ </div>
258
+
259
+
260
+ </div>
261
+
262
+
263
+ <div id="destroy--method" class="method-detail ">
264
+ <a name="M000005"></a>
265
+
266
+ <div class="method-heading">
267
+
268
+ <span class="method-name">destroy?</span><span
269
+ class="method-args">()</span>
270
+ <span class="method-click-advice">click to toggle source</span>
271
+
272
+ </div>
273
+
274
+ <div class="method-description">
275
+
276
+ <p class="missing-docs">(Not documented)</p>
277
+
278
+
279
+
280
+ <div class="method-source-code"
281
+ id="destroy--source">
282
+ <pre>
283
+ <span class="ruby-comment cmt"># File lib/rask/state_machine.rb, line 36</span>
284
+ 36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destroy?</span>
285
+ 37: <span class="ruby-ivar">@state</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
286
+ 38: <span class="ruby-keyword kw">end</span></pre>
287
+ </div>
288
+
289
+ </div>
290
+
291
+
292
+ </div>
293
+
294
+
295
+ <div id="initial-state-method" class="method-detail ">
296
+ <a name="M000001"></a>
297
+
298
+ <div class="method-heading">
299
+
300
+ <span class="method-name">initial_state</span><span
301
+ class="method-args">()</span>
302
+ <span class="method-click-advice">click to toggle source</span>
303
+
304
+ </div>
305
+
306
+ <div class="method-description">
307
+
308
+ <p class="missing-docs">(Not documented)</p>
309
+
310
+
311
+
312
+ <div class="method-source-code"
313
+ id="initial-state-source">
314
+ <pre>
315
+ <span class="ruby-comment cmt"># File lib/rask/state_machine.rb, line 21</span>
316
+ 21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initial_state</span>
317
+ 22: <span class="ruby-keyword kw">nil</span>
318
+ 23: <span class="ruby-keyword kw">end</span></pre>
319
+ </div>
320
+
321
+ </div>
322
+
323
+
324
+ </div>
325
+
326
+
327
+ <div id="transition-method" class="method-detail ">
328
+ <a name="M000003"></a>
329
+
330
+ <div class="method-heading">
331
+
332
+ <span class="method-name">transition</span><span
333
+ class="method-args">(to)</span>
334
+ <span class="method-click-advice">click to toggle source</span>
335
+
336
+ </div>
337
+
338
+ <div class="method-description">
339
+
340
+ <p class="missing-docs">(Not documented)</p>
341
+
342
+
343
+
344
+ <div class="method-source-code"
345
+ id="transition-source">
346
+ <pre>
347
+ <span class="ruby-comment cmt"># File lib/rask/state_machine.rb, line 26</span>
348
+ 26: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">transition</span>(<span class="ruby-identifier">to</span>)
349
+ 27: <span class="ruby-ivar">@state</span> = <span class="ruby-identifier">to</span>
350
+ 28: <span class="ruby-keyword kw">end</span></pre>
351
+ </div>
352
+
353
+ </div>
354
+
355
+
356
+ </div>
357
+
358
+
359
+ </div>
360
+
361
+
362
+ </div>
363
+
364
+
365
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
366
+
367
+ <p>Disabled; run with --debug to generate this.</p>
368
+
369
+ </div>
370
+
371
+ <div id="validator-badges">
372
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
373
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
374
+ Rdoc Generator</a> 1.1.6</small>.</p>
375
+ </div>
376
+
377
+ </body>
378
+ </html>
379
+
@@ -0,0 +1,190 @@
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>Module: Rask::StateMachine::ClassMethods</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="module">
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/state_machine_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="lib/rask/state_machine.rb">lib/rask/state_machine.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
+
46
+ <!-- Namespace Contents -->
47
+
48
+
49
+ <!-- Method Quickref -->
50
+
51
+ <div id="method-list-section" class="section">
52
+ <h3 class="section-header">Methods</h3>
53
+ <ul class="link-list">
54
+
55
+ <li><a href="#M000009">#define_state</a></li>
56
+
57
+ </ul>
58
+ </div>
59
+
60
+
61
+ <!-- Included Modules -->
62
+
63
+ </div>
64
+
65
+ <div id="project-metadata">
66
+
67
+
68
+
69
+ <div id="classindex-section" class="section project-section">
70
+ <h3 class="section-header">Class Index
71
+ <span class="search-toggle"><img src="../../images/find.png"
72
+ height="16" width="16" alt="[+]"
73
+ title="show/hide quicksearch" /></span></h3>
74
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
75
+ <fieldset>
76
+ <legend>Quicksearch</legend>
77
+ <input type="text" name="quicksearch" value=""
78
+ class="quicksearch-field" />
79
+ </fieldset>
80
+ </form>
81
+
82
+ <ul class="link-list">
83
+
84
+ <li><a href="../../Rask.html">Rask</a></li>
85
+
86
+ <li><a href="../../Rask/StateMachine.html">Rask::StateMachine</a></li>
87
+
88
+ <li><a href="../../Rask/StateMachine/ClassMethods.html">Rask::StateMachine::ClassMethods</a></li>
89
+
90
+ <li><a href="../../Rask/Task.html">Rask::Task</a></li>
91
+
92
+ </ul>
93
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
94
+ </div>
95
+
96
+
97
+ </div>
98
+ </div>
99
+
100
+ <div id="documentation">
101
+ <h1 class="module">Rask::StateMachine::ClassMethods</h1>
102
+
103
+ <div id="description">
104
+
105
+ </div>
106
+
107
+ <!-- Constants -->
108
+
109
+
110
+ <!-- Attributes -->
111
+
112
+
113
+ <!-- Methods -->
114
+
115
+ <div id="public-instance-method-details" class="method-section section">
116
+ <h3 class="section-header">Public Instance Methods</h3>
117
+
118
+
119
+ <div id="define-state-method" class="method-detail ">
120
+ <a name="M000009"></a>
121
+
122
+ <div class="method-heading">
123
+
124
+ <span class="method-name">define_state</span><span
125
+ class="method-args">(name, *args)</span>
126
+ <span class="method-click-advice">click to toggle source</span>
127
+
128
+ </div>
129
+
130
+ <div class="method-description">
131
+
132
+ <p class="missing-docs">(Not documented)</p>
133
+
134
+
135
+
136
+ <div class="method-source-code"
137
+ id="define-state-source">
138
+ <pre>
139
+ <span class="ruby-comment cmt"># File lib/rask/state_machine.rb, line 57</span>
140
+ 57: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">define_state</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
141
+ 58:
142
+ 59: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance_eval</span>{
143
+ 60: <span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">name</span>){
144
+ 61: }
145
+ 62: <span class="ruby-identifier">define_method</span>(<span class="ruby-node">&quot;transition_to_#{name}&quot;</span>){
146
+ 63: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
147
+ 64: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">state</span> = <span class="ruby-identifier">name</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>][<span class="ruby-identifier">:from</span>] <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>][<span class="ruby-identifier">:from</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">state</span>)
148
+ 65: <span class="ruby-keyword kw">else</span>
149
+ 66: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">state</span> = <span class="ruby-identifier">name</span>
150
+ 67: <span class="ruby-keyword kw">end</span>
151
+ 68: }
152
+ 69: <span class="ruby-identifier">define_method</span>(<span class="ruby-node">&quot;#{name}?&quot;</span>){
153
+ 70: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">state</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>
154
+ 71: }
155
+ 72: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">method_defined?</span>(<span class="ruby-identifier">name</span>) <span class="ruby-operator">||</span> ( <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>][<span class="ruby-identifier">:initial</span>] )
156
+ 73: <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">&quot;initial_state&quot;</span>) {
157
+ 74: <span class="ruby-identifier">name</span>
158
+ 75: }
159
+ 76: <span class="ruby-keyword kw">end</span>
160
+ 77: }
161
+ 78: <span class="ruby-keyword kw">end</span></pre>
162
+ </div>
163
+
164
+ </div>
165
+
166
+
167
+ </div>
168
+
169
+
170
+ </div>
171
+
172
+
173
+ </div>
174
+
175
+
176
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
177
+
178
+ <p>Disabled; run with --debug to generate this.</p>
179
+
180
+ </div>
181
+
182
+ <div id="validator-badges">
183
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
184
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
185
+ Rdoc Generator</a> 1.1.6</small>.</p>
186
+ </div>
187
+
188
+ </body>
189
+ </html>
190
+