mack-facets 0.6.1.1 → 0.6.1.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.
Files changed (39) hide show
  1. data/doc/classes/Array.html +408 -0
  2. data/doc/classes/Class.html +233 -0
  3. data/doc/classes/Hash.html +233 -0
  4. data/doc/classes/Kernel.html +184 -0
  5. data/doc/classes/Mack/Utils/Inflector.html +382 -0
  6. data/doc/classes/Mack/Utils/RegistryList.html +469 -0
  7. data/doc/classes/Mack/Utils/RegistryMap.html +479 -0
  8. data/doc/classes/Math.html +188 -0
  9. data/doc/classes/Module.html +203 -0
  10. data/doc/classes/NilClass.html +148 -0
  11. data/doc/classes/Object.html +558 -0
  12. data/doc/classes/String.html +451 -0
  13. data/doc/classes/Symbol.html +148 -0
  14. data/doc/created.rid +1 -0
  15. data/doc/files/README.html +112 -0
  16. data/doc/files/lib/mack-facets/english_extensions/inflect_rb.html +101 -0
  17. data/doc/files/lib/mack-facets/english_extensions/numerals_rb.html +101 -0
  18. data/doc/files/lib/mack-facets/extensions/array_rb.html +101 -0
  19. data/doc/files/lib/mack-facets/extensions/class_rb.html +101 -0
  20. data/doc/files/lib/mack-facets/extensions/hash_rb.html +108 -0
  21. data/doc/files/lib/mack-facets/extensions/kernel_rb.html +109 -0
  22. data/doc/files/lib/mack-facets/extensions/math_rb.html +101 -0
  23. data/doc/files/lib/mack-facets/extensions/module_rb.html +101 -0
  24. data/doc/files/lib/mack-facets/extensions/nil_class_rb.html +101 -0
  25. data/doc/files/lib/mack-facets/extensions/object_rb.html +101 -0
  26. data/doc/files/lib/mack-facets/extensions/string_rb.html +101 -0
  27. data/doc/files/lib/mack-facets/extensions/symbol_rb.html +101 -0
  28. data/doc/files/lib/mack-facets/utils/inflections_rb.html +101 -0
  29. data/doc/files/lib/mack-facets/utils/inflector_rb.html +108 -0
  30. data/doc/files/lib/mack-facets/utils/options_merger_rb.html +101 -0
  31. data/doc/files/lib/mack-facets/utils/registry_list_rb.html +108 -0
  32. data/doc/files/lib/mack-facets/utils/registry_map_rb.html +108 -0
  33. data/doc/files/lib/mack-facets_rb.html +123 -0
  34. data/doc/fr_class_index.html +39 -0
  35. data/doc/fr_file_index.html +45 -0
  36. data/doc/fr_method_index.html +98 -0
  37. data/doc/index.html +24 -0
  38. data/doc/rdoc-style.css +208 -0
  39. metadata +40 -2
@@ -0,0 +1,469 @@
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: Mack::Utils::RegistryList</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">Mack::Utils::RegistryList</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../../files/lib/mack-facets/utils/registry_list_rb.html">
59
+ lib/mack-facets/utils/registry_list.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
+ <a href="../../Object.html">
69
+ Object
70
+ </a>
71
+ </td>
72
+ </tr>
73
+ </table>
74
+ </div>
75
+ <!-- banner header -->
76
+
77
+ <div id="bodyContent">
78
+
79
+
80
+
81
+ <div id="contextContent">
82
+
83
+ <div id="description">
84
+ <p>
85
+ This is a general purpose Singleton Registry class. It takes the drudgery
86
+ out of creating registry classes, that are, let&#8216;s face it, all pretty
87
+ much the same.
88
+ </p>
89
+
90
+ </div>
91
+
92
+
93
+ </div>
94
+
95
+ <div id="method-list">
96
+ <h3 class="section-bar">Methods</h3>
97
+
98
+ <div class="name-list">
99
+ <a href="#M000059">add</a>&nbsp;&nbsp;
100
+ <a href="#M000064">add</a>&nbsp;&nbsp;
101
+ <a href="#M000062">clear!</a>&nbsp;&nbsp;
102
+ <a href="#M000057">initial_state</a>&nbsp;&nbsp;
103
+ <a href="#M000067">move_to_bottom</a>&nbsp;&nbsp;
104
+ <a href="#M000066">move_to_top</a>&nbsp;&nbsp;
105
+ <a href="#M000061">registered_items</a>&nbsp;&nbsp;
106
+ <a href="#M000060">remove</a>&nbsp;&nbsp;
107
+ <a href="#M000065">remove</a>&nbsp;&nbsp;
108
+ <a href="#M000063">reset!</a>&nbsp;&nbsp;
109
+ <a href="#M000058">reset!</a>&nbsp;&nbsp;
110
+ </div>
111
+ </div>
112
+
113
+ </div>
114
+
115
+
116
+ <!-- if includes -->
117
+ <div id="includes">
118
+ <h3 class="section-bar">Included Modules</h3>
119
+
120
+ <div id="includes-list">
121
+ <span class="include-name">Singleton</span>
122
+ <span class="include-name">Extlib::Hook</span>
123
+ </div>
124
+ </div>
125
+
126
+ <div id="section">
127
+
128
+
129
+
130
+
131
+
132
+ <div id="attribute-list">
133
+ <h3 class="section-bar">Attributes</h3>
134
+
135
+ <div class="name-list">
136
+ <table>
137
+ <tr class="top-aligned-row context-row">
138
+ <td class="context-item-name">registered_items</td>
139
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
140
+ <td class="context-item-desc">
141
+ The list of registered items
142
+
143
+ </td>
144
+ </tr>
145
+ </table>
146
+ </div>
147
+ </div>
148
+
149
+
150
+
151
+ <!-- if method_list -->
152
+ <div id="methods">
153
+ <h3 class="section-bar">Public Class methods</h3>
154
+
155
+ <div id="method-M000064" class="method-detail">
156
+ <a name="M000064"></a>
157
+
158
+ <div class="method-heading">
159
+ <a href="#M000064" class="method-signature">
160
+ <span class="method-name">add</span><span class="method-args">(klass, position = registered_items.size)</span>
161
+ </a>
162
+ </div>
163
+
164
+ <div class="method-description">
165
+ <p>
166
+ Adds an object to the list at a specified position. By default the position
167
+ is last.
168
+ </p>
169
+ <p><a class="source-toggle" href="#"
170
+ onclick="toggleCode('M000064-source');return false;">[Source]</a></p>
171
+ <div class="method-source-code" id="M000064-source">
172
+ <pre>
173
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 59</span>
174
+ 59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">position</span> = <span class="ruby-identifier">registered_items</span>.<span class="ruby-identifier">size</span>)
175
+ 60: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">position</span>)
176
+ 61: <span class="ruby-keyword kw">end</span>
177
+ </pre>
178
+ </div>
179
+ </div>
180
+ </div>
181
+
182
+ <div id="method-M000062" class="method-detail">
183
+ <a name="M000062"></a>
184
+
185
+ <div class="method-heading">
186
+ <a href="#M000062" class="method-signature">
187
+ <span class="method-name">clear!</span><span class="method-args">()</span>
188
+ </a>
189
+ </div>
190
+
191
+ <div class="method-description">
192
+ <p>
193
+ Emptys out the list of <a
194
+ href="RegistryList.html#M000061">registered_items</a>.
195
+ </p>
196
+ <p><a class="source-toggle" href="#"
197
+ onclick="toggleCode('M000062-source');return false;">[Source]</a></p>
198
+ <div class="method-source-code" id="M000062-source">
199
+ <pre>
200
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 49</span>
201
+ 49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clear!</span>
202
+ 50: <span class="ruby-identifier">registered_items</span>.<span class="ruby-identifier">clear</span>
203
+ 51: <span class="ruby-keyword kw">end</span>
204
+ </pre>
205
+ </div>
206
+ </div>
207
+ </div>
208
+
209
+ <div id="method-M000067" class="method-detail">
210
+ <a name="M000067"></a>
211
+
212
+ <div class="method-heading">
213
+ <a href="#M000067" class="method-signature">
214
+ <span class="method-name">move_to_bottom</span><span class="method-args">(klass)</span>
215
+ </a>
216
+ </div>
217
+
218
+ <div class="method-description">
219
+ <p>
220
+ Moves an object to the bottom of the <a
221
+ href="RegistryList.html#M000061">registered_items</a> list.
222
+ </p>
223
+ <p><a class="source-toggle" href="#"
224
+ onclick="toggleCode('M000067-source');return false;">[Source]</a></p>
225
+ <div class="method-source-code" id="M000067-source">
226
+ <pre>
227
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 74</span>
228
+ 74: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">move_to_bottom</span>(<span class="ruby-identifier">klass</span>)
229
+ 75: <span class="ruby-identifier">remove</span>(<span class="ruby-identifier">klass</span>)
230
+ 76: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">klass</span>)
231
+ 77: <span class="ruby-keyword kw">end</span>
232
+ </pre>
233
+ </div>
234
+ </div>
235
+ </div>
236
+
237
+ <div id="method-M000066" class="method-detail">
238
+ <a name="M000066"></a>
239
+
240
+ <div class="method-heading">
241
+ <a href="#M000066" class="method-signature">
242
+ <span class="method-name">move_to_top</span><span class="method-args">(klass)</span>
243
+ </a>
244
+ </div>
245
+
246
+ <div class="method-description">
247
+ <p>
248
+ Moves an object to the top of the <a
249
+ href="RegistryList.html#M000061">registered_items</a> list.
250
+ </p>
251
+ <p><a class="source-toggle" href="#"
252
+ onclick="toggleCode('M000066-source');return false;">[Source]</a></p>
253
+ <div class="method-source-code" id="M000066-source">
254
+ <pre>
255
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 69</span>
256
+ 69: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">move_to_top</span>(<span class="ruby-identifier">klass</span>)
257
+ 70: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-value">0</span>)
258
+ 71: <span class="ruby-keyword kw">end</span>
259
+ </pre>
260
+ </div>
261
+ </div>
262
+ </div>
263
+
264
+ <div id="method-M000061" class="method-detail">
265
+ <a name="M000061"></a>
266
+
267
+ <div class="method-heading">
268
+ <a href="#M000061" class="method-signature">
269
+ <span class="method-name">registered_items</span><span class="method-args">()</span>
270
+ </a>
271
+ </div>
272
+
273
+ <div class="method-description">
274
+ <p>
275
+ Returns the list of registered items.
276
+ </p>
277
+ <p><a class="source-toggle" href="#"
278
+ onclick="toggleCode('M000061-source');return false;">[Source]</a></p>
279
+ <div class="method-source-code" id="M000061-source">
280
+ <pre>
281
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 44</span>
282
+ 44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">registered_items</span>
283
+ 45: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">registered_items</span>
284
+ 46: <span class="ruby-keyword kw">end</span>
285
+ </pre>
286
+ </div>
287
+ </div>
288
+ </div>
289
+
290
+ <div id="method-M000065" class="method-detail">
291
+ <a name="M000065"></a>
292
+
293
+ <div class="method-heading">
294
+ <a href="#M000065" class="method-signature">
295
+ <span class="method-name">remove</span><span class="method-args">(klass)</span>
296
+ </a>
297
+ </div>
298
+
299
+ <div class="method-description">
300
+ <p>
301
+ Removes an object from the list.
302
+ </p>
303
+ <p><a class="source-toggle" href="#"
304
+ onclick="toggleCode('M000065-source');return false;">[Source]</a></p>
305
+ <div class="method-source-code" id="M000065-source">
306
+ <pre>
307
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 64</span>
308
+ 64: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>(<span class="ruby-identifier">klass</span>)
309
+ 65: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">remove</span>(<span class="ruby-identifier">klass</span>)
310
+ 66: <span class="ruby-keyword kw">end</span>
311
+ </pre>
312
+ </div>
313
+ </div>
314
+ </div>
315
+
316
+ <div id="method-M000063" class="method-detail">
317
+ <a name="M000063"></a>
318
+
319
+ <div class="method-heading">
320
+ <a href="#M000063" class="method-signature">
321
+ <span class="method-name">reset!</span><span class="method-args">()</span>
322
+ </a>
323
+ </div>
324
+
325
+ <div class="method-description">
326
+ <p>
327
+ Resets the <a href="RegistryList.html#M000061">registered_items</a> list to
328
+ the list specified by the <a
329
+ href="RegistryList.html#M000057">initial_state</a> method.
330
+ </p>
331
+ <p><a class="source-toggle" href="#"
332
+ onclick="toggleCode('M000063-source');return false;">[Source]</a></p>
333
+ <div class="method-source-code" id="M000063-source">
334
+ <pre>
335
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 54</span>
336
+ 54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset!</span>
337
+ 55: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">reset!</span>
338
+ 56: <span class="ruby-keyword kw">end</span>
339
+ </pre>
340
+ </div>
341
+ </div>
342
+ </div>
343
+
344
+ <h3 class="section-bar">Public Instance methods</h3>
345
+
346
+ <div id="method-M000059" class="method-detail">
347
+ <a name="M000059"></a>
348
+
349
+ <div class="method-heading">
350
+ <a href="#M000059" class="method-signature">
351
+ <span class="method-name">add</span><span class="method-args">(klass, position = self.registered_items.size)</span>
352
+ </a>
353
+ </div>
354
+
355
+ <div class="method-description">
356
+ <p>
357
+ Adds an object to the list at a specified position. By default the position
358
+ is last.
359
+ </p>
360
+ <p><a class="source-toggle" href="#"
361
+ onclick="toggleCode('M000059-source');return false;">[Source]</a></p>
362
+ <div class="method-source-code" id="M000059-source">
363
+ <pre>
364
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 30</span>
365
+ 30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">position</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registered_items</span>.<span class="ruby-identifier">size</span>)
366
+ 31: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registered_items</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-identifier">position</span>, <span class="ruby-identifier">klass</span>)
367
+ 32: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registered_items</span>.<span class="ruby-identifier">uniq!</span>
368
+ 33: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registered_items</span>.<span class="ruby-identifier">compact!</span>
369
+ 34: <span class="ruby-keyword kw">end</span>
370
+ </pre>
371
+ </div>
372
+ </div>
373
+ </div>
374
+
375
+ <div id="method-M000057" class="method-detail">
376
+ <a name="M000057"></a>
377
+
378
+ <div class="method-heading">
379
+ <a href="#M000057" class="method-signature">
380
+ <span class="method-name">initial_state</span><span class="method-args">()</span>
381
+ </a>
382
+ </div>
383
+
384
+ <div class="method-description">
385
+ <p>
386
+ Override this method to set the initial state of the <a
387
+ href="RegistryList.html#M000061">registered_items</a> <a
388
+ href="../../Array.html">Array</a>. By default this list is empty.
389
+ </p>
390
+ <p><a class="source-toggle" href="#"
391
+ onclick="toggleCode('M000057-source');return false;">[Source]</a></p>
392
+ <div class="method-source-code" id="M000057-source">
393
+ <pre>
394
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 20</span>
395
+ 20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initial_state</span>
396
+ 21: []
397
+ 22: <span class="ruby-keyword kw">end</span>
398
+ </pre>
399
+ </div>
400
+ </div>
401
+ </div>
402
+
403
+ <div id="method-M000060" class="method-detail">
404
+ <a name="M000060"></a>
405
+
406
+ <div class="method-heading">
407
+ <a href="#M000060" class="method-signature">
408
+ <span class="method-name">remove</span><span class="method-args">(klass)</span>
409
+ </a>
410
+ </div>
411
+
412
+ <div class="method-description">
413
+ <p>
414
+ Removes an object from the list.
415
+ </p>
416
+ <p><a class="source-toggle" href="#"
417
+ onclick="toggleCode('M000060-source');return false;">[Source]</a></p>
418
+ <div class="method-source-code" id="M000060-source">
419
+ <pre>
420
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 37</span>
421
+ 37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>(<span class="ruby-identifier">klass</span>)
422
+ 38: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registered_items</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">klass</span>)
423
+ 39: <span class="ruby-keyword kw">end</span>
424
+ </pre>
425
+ </div>
426
+ </div>
427
+ </div>
428
+
429
+ <div id="method-M000058" class="method-detail">
430
+ <a name="M000058"></a>
431
+
432
+ <div class="method-heading">
433
+ <a href="#M000058" class="method-signature">
434
+ <span class="method-name">reset!</span><span class="method-args">()</span>
435
+ </a>
436
+ </div>
437
+
438
+ <div class="method-description">
439
+ <p>
440
+ Resets the <a href="RegistryList.html#M000061">registered_items</a> list to
441
+ the list specified by the <a
442
+ href="RegistryList.html#M000057">initial_state</a> method.
443
+ </p>
444
+ <p><a class="source-toggle" href="#"
445
+ onclick="toggleCode('M000058-source');return false;">[Source]</a></p>
446
+ <div class="method-source-code" id="M000058-source">
447
+ <pre>
448
+ <span class="ruby-comment cmt"># File lib/mack-facets/utils/registry_list.rb, line 25</span>
449
+ 25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset!</span>
450
+ 26: <span class="ruby-ivar">@registered_items</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">initial_state</span>.<span class="ruby-identifier">dup</span>
451
+ 27: <span class="ruby-keyword kw">end</span>
452
+ </pre>
453
+ </div>
454
+ </div>
455
+ </div>
456
+
457
+
458
+ </div>
459
+
460
+
461
+ </div>
462
+
463
+
464
+ <div id="validator-badges">
465
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
466
+ </div>
467
+
468
+ </body>
469
+ </html>