table_fu 0.1.1
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.
- data/.gitignore +4 -0
- data/LICENSE +20 -0
- data/README +37 -0
- data/Rakefile +58 -0
- data/VERSION.yml +5 -0
- data/doc/TableFu/Datum.html +743 -0
- data/doc/TableFu/Formatting.html +469 -0
- data/doc/TableFu/Header.html +198 -0
- data/doc/TableFu/Row.html +508 -0
- data/doc/TableFu.html +1806 -0
- data/doc/_index.html +154 -0
- data/doc/class_list.html +36 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +50 -0
- data/doc/css/style.css +268 -0
- data/doc/file.README.html +89 -0
- data/doc/file_list.html +38 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +89 -0
- data/doc/js/app.js +99 -0
- data/doc/js/full_list.js +106 -0
- data/doc/js/jquery.js +19 -0
- data/doc/method_list.html +363 -0
- data/doc/top-level-namespace.html +85 -0
- data/documentation/css/dawn.css +121 -0
- data/documentation/css/styles.css +63 -0
- data/documentation/images/proplogo.png +0 -0
- data/documentation/index.html.erb +148 -0
- data/examples/columns.rb +7 -0
- data/examples/columns_hidden.rb +5 -0
- data/examples/faceting.rb +2 -0
- data/examples/formatting_options.rb +6 -0
- data/examples/last_name.rb +4 -0
- data/examples/link.rb +11 -0
- data/examples/only.rb +6 -0
- data/examples/rails_helpers.rb +3 -0
- data/examples/sort_by_column.rb +11 -0
- data/examples/sort_by_number.rb +0 -0
- data/examples/totals.rb +2 -0
- data/examples/zap_joyce.rb +3 -0
- data/index.html +210 -0
- data/lib/table_fu/formatting.rb +52 -0
- data/lib/table_fu.rb +386 -0
- data/spec/assets/sample.csv +476 -0
- data/spec/assets/test.csv +8 -0
- data/spec/assets/test_macro.csv +8 -0
- data/spec/rcov.opts +2 -0
- data/spec/readme_example_spec.rb +39 -0
- data/spec/spec.opts +4 -0
- data/spec/spec_helper.rb +4 -0
- data/spec/table_fu_spec.rb +221 -0
- data/table_fu.gemspec +112 -0
- metadata +141 -0
|
@@ -0,0 +1,469 @@
|
|
|
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: TableFu::Formatting</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 (F)</a> »
|
|
27
|
+
<span class='title'><a href="../TableFu.html" title="TableFu (class)">TableFu</a></span>
|
|
28
|
+
»
|
|
29
|
+
<span class="title">Formatting</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: TableFu::Formatting
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</h1>
|
|
50
|
+
|
|
51
|
+
<dl class="box">
|
|
52
|
+
|
|
53
|
+
<dt class="r1">Inherits:</dt>
|
|
54
|
+
<dd class="r1">
|
|
55
|
+
<span class="inheritName">Object</span>
|
|
56
|
+
|
|
57
|
+
<ul class="fullTree">
|
|
58
|
+
<li>Object</li>
|
|
59
|
+
|
|
60
|
+
<li class="next">TableFu::Formatting</li>
|
|
61
|
+
|
|
62
|
+
</ul>
|
|
63
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
64
|
+
|
|
65
|
+
</dd>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
<dt class="r2 last">Defined in:</dt>
|
|
75
|
+
<dd class="r2 last">lib/table_fu/formatting.rb</dd>
|
|
76
|
+
|
|
77
|
+
</dl>
|
|
78
|
+
<div class="clear"></div>
|
|
79
|
+
|
|
80
|
+
<h2>Overview</h2><div class="docstring">
|
|
81
|
+
<div class="discussion">
|
|
82
|
+
<p>
|
|
83
|
+
Override this class to add more formatting methods
|
|
84
|
+
</p>
|
|
85
|
+
<p>
|
|
86
|
+
Methods expect one or more arguments, which could be nil, and should return
|
|
87
|
+
the appropriate formatting and style.
|
|
88
|
+
</p>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
</div>
|
|
93
|
+
<div class="tags">
|
|
94
|
+
|
|
95
|
+
</div>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<h2>Class Method Summary</h2>
|
|
99
|
+
|
|
100
|
+
<ul class="summary">
|
|
101
|
+
|
|
102
|
+
<li class="public ">
|
|
103
|
+
<span class="summary_signature">
|
|
104
|
+
|
|
105
|
+
<a href="#currency-class_method" title="currency (class method)">+ (Object) <strong>currency</strong>(num) </a>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</span>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<span class="summary_desc">
|
|
118
|
+
Returns a currency formatted number.
|
|
119
|
+
|
|
120
|
+
</span>
|
|
121
|
+
|
|
122
|
+
</li>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<li class="public ">
|
|
126
|
+
<span class="summary_signature">
|
|
127
|
+
|
|
128
|
+
<a href="#last_name-class_method" title="last_name (class method)">+ (Object) <strong>last_name</strong>(name) </a>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
</span>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<span class="summary_desc">
|
|
141
|
+
Returns the last name of a name .
|
|
142
|
+
|
|
143
|
+
</span>
|
|
144
|
+
|
|
145
|
+
</li>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
<li class="public ">
|
|
149
|
+
<span class="summary_signature">
|
|
150
|
+
|
|
151
|
+
<a href="#last_name_first_name-class_method" title="last_name_first_name (class method)">+ (Object) <strong>last_name_first_name</strong>(name) </a>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
</span>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<span class="summary_desc">
|
|
164
|
+
Returns that last name first of a name.
|
|
165
|
+
|
|
166
|
+
</span>
|
|
167
|
+
|
|
168
|
+
</li>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<li class="public ">
|
|
172
|
+
<span class="summary_signature">
|
|
173
|
+
|
|
174
|
+
<a href="#link-class_method" title="link (class method)">+ (Object) <strong>link</strong>(linkname, href) </a>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
</span>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc">
|
|
187
|
+
Returns an html link constructed from link, linkname.
|
|
188
|
+
|
|
189
|
+
</span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<li class="public ">
|
|
195
|
+
<span class="summary_signature">
|
|
196
|
+
|
|
197
|
+
<a href="#method_missing-class_method" title="method_missing (class method)">+ (Object) <strong>method_missing</strong>(method) </a>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</span>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<span class="summary_desc">
|
|
210
|
+
Returns an error message if the given formatter isn’t available.
|
|
211
|
+
|
|
212
|
+
</span>
|
|
213
|
+
|
|
214
|
+
</li>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
</ul>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<div id="class_method_details" class="method_details_list">
|
|
221
|
+
<h2>Class Method Details</h2>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<div class="method_details first">
|
|
225
|
+
<p class="signature first" id="currency-class_method">
|
|
226
|
+
|
|
227
|
+
+ (<tt>Object</tt>) <strong>currency</strong>(num)
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</p><div class="docstring">
|
|
232
|
+
<div class="discussion">
|
|
233
|
+
<p>
|
|
234
|
+
Returns a currency formatted number
|
|
235
|
+
</p>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</div>
|
|
239
|
+
</div>
|
|
240
|
+
<div class="tags">
|
|
241
|
+
|
|
242
|
+
</div><table class="source_code">
|
|
243
|
+
<tr>
|
|
244
|
+
<td>
|
|
245
|
+
<pre class="lines">
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
10
|
|
249
|
+
11
|
|
250
|
+
12
|
|
251
|
+
13
|
|
252
|
+
14
|
|
253
|
+
15
|
|
254
|
+
16
|
|
255
|
+
17
|
|
256
|
+
18</pre>
|
|
257
|
+
</td>
|
|
258
|
+
<td>
|
|
259
|
+
<pre class="code"><span class="info file"># File 'lib/table_fu/formatting.rb', line 10</span>
|
|
260
|
+
|
|
261
|
+
<span class='def def kw'>def</span> <span class='currency identifier id'>currency</span><span class='lparen token'>(</span><span class='num identifier id'>num</span><span class='rparen token'>)</span>
|
|
262
|
+
<span class='begin begin kw'>begin</span>
|
|
263
|
+
<span class='parts identifier id'>parts</span> <span class='assign token'>=</span> <span class='num identifier id'>num</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>'.'</span><span class='rparen token'>)</span>
|
|
264
|
+
<span class='parts identifier id'>parts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='gsub! fid id'>gsub!</span><span class='lparen token'>(</span><span class='regexp val'>/(\d)(?=(\d\d\d)+(?!\d))/</span><span class='comma token'>,</span> <span class='string val'>"\\1,"</span><span class='rparen token'>)</span>
|
|
265
|
+
<span class='dstring node'>"$#{parts.join('.')}"</span>
|
|
266
|
+
<span class='rescue rescue kw'>rescue</span>
|
|
267
|
+
<span class='num identifier id'>num</span>
|
|
268
|
+
<span class='end end kw'>end</span>
|
|
269
|
+
<span class='end end kw'>end</span>
|
|
270
|
+
</pre>
|
|
271
|
+
</td>
|
|
272
|
+
</tr>
|
|
273
|
+
</table>
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
<div class="method_details ">
|
|
277
|
+
<p class="signature " id="last_name-class_method">
|
|
278
|
+
|
|
279
|
+
+ (<tt>Object</tt>) <strong>last_name</strong>(name)
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
</p><div class="docstring">
|
|
284
|
+
<div class="discussion">
|
|
285
|
+
<p>
|
|
286
|
+
Returns the last name of a name
|
|
287
|
+
</p>
|
|
288
|
+
<pre class="code">
|
|
289
|
+
<span class='assign token'>=</span><span class='gt op'>></span> <span class='last_name identifier id'>last_name</span><span class='lparen token'>(</span><span class='string val'>"Jeff Larson"</span><span class='rparen token'>)</span>
|
|
290
|
+
<span class='rshft op'>>></span> <span class='Larson constant id'>Larson</span>
|
|
291
|
+
</pre>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
</div>
|
|
295
|
+
</div>
|
|
296
|
+
<div class="tags">
|
|
297
|
+
|
|
298
|
+
</div><table class="source_code">
|
|
299
|
+
<tr>
|
|
300
|
+
<td>
|
|
301
|
+
<pre class="lines">
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
23
|
|
305
|
+
24
|
|
306
|
+
25
|
|
307
|
+
26
|
|
308
|
+
27
|
|
309
|
+
28
|
|
310
|
+
29
|
|
311
|
+
30</pre>
|
|
312
|
+
</td>
|
|
313
|
+
<td>
|
|
314
|
+
<pre class="code"><span class="info file"># File 'lib/table_fu/formatting.rb', line 23</span>
|
|
315
|
+
|
|
316
|
+
<span class='def def kw'>def</span> <span class='last_name identifier id'>last_name</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
|
|
317
|
+
<span class='name identifier id'>name</span><span class='dot token'>.</span><span class='strip! fid id'>strip!</span>
|
|
318
|
+
<span class='if if kw'>if</span> <span class='name identifier id'>name</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\s(\w+)$/</span><span class='rparen token'>)</span>
|
|
319
|
+
<span class='$1 nth_ref id'>$1</span>
|
|
320
|
+
<span class='else else kw'>else</span>
|
|
321
|
+
<span class='name identifier id'>name</span>
|
|
322
|
+
<span class='end end kw'>end</span>
|
|
323
|
+
<span class='end end kw'>end</span>
|
|
324
|
+
</pre>
|
|
325
|
+
</td>
|
|
326
|
+
</tr>
|
|
327
|
+
</table>
|
|
328
|
+
</div>
|
|
329
|
+
|
|
330
|
+
<div class="method_details ">
|
|
331
|
+
<p class="signature " id="last_name_first_name-class_method">
|
|
332
|
+
|
|
333
|
+
+ (<tt>Object</tt>) <strong>last_name_first_name</strong>(name)
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
</p><div class="docstring">
|
|
338
|
+
<div class="discussion">
|
|
339
|
+
<p>
|
|
340
|
+
Returns that last name first of a name
|
|
341
|
+
</p>
|
|
342
|
+
<pre class="code">
|
|
343
|
+
<span class='assign token'>=</span><span class='gt op'>></span> <span class='last_name_first_name identifier id'>last_name_first_name</span><span class='lparen token'>(</span><span class='string val'>"Jeff Larson"</span><span class='rparen token'>)</span>
|
|
344
|
+
<span class='rshft op'>>></span> <span class='Larson constant id'>Larson</span><span class='comma token'>,</span> <span class='Jeff constant id'>Jeff</span>
|
|
345
|
+
</pre>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
</div>
|
|
349
|
+
</div>
|
|
350
|
+
<div class="tags">
|
|
351
|
+
|
|
352
|
+
</div><table class="source_code">
|
|
353
|
+
<tr>
|
|
354
|
+
<td>
|
|
355
|
+
<pre class="lines">
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
34
|
|
359
|
+
35
|
|
360
|
+
36
|
|
361
|
+
37
|
|
362
|
+
38</pre>
|
|
363
|
+
</td>
|
|
364
|
+
<td>
|
|
365
|
+
<pre class="code"><span class="info file"># File 'lib/table_fu/formatting.rb', line 34</span>
|
|
366
|
+
|
|
367
|
+
<span class='def def kw'>def</span> <span class='last_name_first_name identifier id'>last_name_first_name</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
|
|
368
|
+
<span class='last identifier id'>last</span> <span class='assign token'>=</span> <span class='last_name identifier id'>last_name</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
|
|
369
|
+
<span class='first identifier id'>first</span> <span class='assign token'>=</span> <span class='name identifier id'>name</span><span class='dot token'>.</span><span class='gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='last identifier id'>last</span><span class='comma token'>,</span> <span class='string val'>''</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='strip identifier id'>strip</span>
|
|
370
|
+
<span class='dstring node'>"#{last}, #{first}"</span>
|
|
371
|
+
<span class='end end kw'>end</span>
|
|
372
|
+
</pre>
|
|
373
|
+
</td>
|
|
374
|
+
</tr>
|
|
375
|
+
</table>
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
<div class="method_details ">
|
|
379
|
+
<p class="signature " id="link-class_method">
|
|
380
|
+
|
|
381
|
+
+ (<tt>Object</tt>) <strong>link</strong>(linkname, href)
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</p><div class="docstring">
|
|
386
|
+
<div class="discussion">
|
|
387
|
+
<p>
|
|
388
|
+
Returns an html link constructed from link, linkname
|
|
389
|
+
</p>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</div>
|
|
393
|
+
</div>
|
|
394
|
+
<div class="tags">
|
|
395
|
+
|
|
396
|
+
</div><table class="source_code">
|
|
397
|
+
<tr>
|
|
398
|
+
<td>
|
|
399
|
+
<pre class="lines">
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
41
|
|
403
|
+
42
|
|
404
|
+
43</pre>
|
|
405
|
+
</td>
|
|
406
|
+
<td>
|
|
407
|
+
<pre class="code"><span class="info file"># File 'lib/table_fu/formatting.rb', line 41</span>
|
|
408
|
+
|
|
409
|
+
<span class='def def kw'>def</span> <span class='link identifier id'>link</span><span class='lparen token'>(</span><span class='linkname identifier id'>linkname</span><span class='comma token'>,</span> <span class='href identifier id'>href</span><span class='rparen token'>)</span>
|
|
410
|
+
<span class='dstring node'>"<a href='#{href}' title='#{linkname}'>#{linkname}</a>"</span>
|
|
411
|
+
<span class='end end kw'>end</span>
|
|
412
|
+
</pre>
|
|
413
|
+
</td>
|
|
414
|
+
</tr>
|
|
415
|
+
</table>
|
|
416
|
+
</div>
|
|
417
|
+
|
|
418
|
+
<div class="method_details ">
|
|
419
|
+
<p class="signature " id="method_missing-class_method">
|
|
420
|
+
|
|
421
|
+
+ (<tt>Object</tt>) <strong>method_missing</strong>(method)
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
</p><div class="docstring">
|
|
426
|
+
<div class="discussion">
|
|
427
|
+
<p>
|
|
428
|
+
Returns an error message if the given formatter isn’t available
|
|
429
|
+
</p>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</div>
|
|
433
|
+
</div>
|
|
434
|
+
<div class="tags">
|
|
435
|
+
|
|
436
|
+
</div><table class="source_code">
|
|
437
|
+
<tr>
|
|
438
|
+
<td>
|
|
439
|
+
<pre class="lines">
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
46
|
|
443
|
+
47
|
|
444
|
+
48</pre>
|
|
445
|
+
</td>
|
|
446
|
+
<td>
|
|
447
|
+
<pre class="code"><span class="info file"># File 'lib/table_fu/formatting.rb', line 46</span>
|
|
448
|
+
|
|
449
|
+
<span class='def def kw'>def</span> <span class='method_missing identifier id'>method_missing</span><span class='lparen token'>(</span><span class='method identifier id'>method</span><span class='rparen token'>)</span>
|
|
450
|
+
<span class='dstring node'>"#{method.to_s} not a valid formatter!"</span>
|
|
451
|
+
<span class='end end kw'>end</span>
|
|
452
|
+
</pre>
|
|
453
|
+
</td>
|
|
454
|
+
</tr>
|
|
455
|
+
</table>
|
|
456
|
+
</div>
|
|
457
|
+
|
|
458
|
+
</div>
|
|
459
|
+
|
|
460
|
+
</div>
|
|
461
|
+
|
|
462
|
+
<div id="footer">
|
|
463
|
+
Generated on Tue Mar 9 17:16:38 2010 by
|
|
464
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
|
|
465
|
+
0.5.3 (ruby-1.8.7).
|
|
466
|
+
</div>
|
|
467
|
+
|
|
468
|
+
</body>
|
|
469
|
+
</html>
|
|
@@ -0,0 +1,198 @@
|
|
|
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: TableFu::Header</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 (H)</a> »
|
|
27
|
+
<span class='title'><a href="../TableFu.html" title="TableFu (class)">TableFu</a></span>
|
|
28
|
+
»
|
|
29
|
+
<span class="title">Header</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: TableFu::Header
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</h1>
|
|
50
|
+
|
|
51
|
+
<dl class="box">
|
|
52
|
+
|
|
53
|
+
<dt class="r1">Inherits:</dt>
|
|
54
|
+
<dd class="r1">
|
|
55
|
+
<span class="inheritName"><a href="Datum.html" title="TableFu::Datum (class)">Datum</a></span>
|
|
56
|
+
|
|
57
|
+
<ul class="fullTree">
|
|
58
|
+
<li>Object</li>
|
|
59
|
+
|
|
60
|
+
<li class="next"><a href="Datum.html" title="TableFu::Datum (class)">Datum</a></li>
|
|
61
|
+
|
|
62
|
+
<li class="next">TableFu::Header</li>
|
|
63
|
+
|
|
64
|
+
</ul>
|
|
65
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
66
|
+
|
|
67
|
+
</dd>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<dt class="r2 last">Defined in:</dt>
|
|
77
|
+
<dd class="r2 last">lib/table_fu.rb</dd>
|
|
78
|
+
|
|
79
|
+
</dl>
|
|
80
|
+
<div class="clear"></div>
|
|
81
|
+
|
|
82
|
+
<h2>Overview</h2><div class="docstring">
|
|
83
|
+
<div class="discussion">
|
|
84
|
+
<p>
|
|
85
|
+
A header object needs to be a special kind of Datum, and we may want to
|
|
86
|
+
extend this further, but currently we just need to ensure that when to_s is
|
|
87
|
+
called on a @Header@ object that we don’t run it through a macro, or
|
|
88
|
+
a formatter.
|
|
89
|
+
</p>
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
</div>
|
|
93
|
+
</div>
|
|
94
|
+
<div class="tags">
|
|
95
|
+
|
|
96
|
+
</div>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
<h2>Instance Method Summary</h2>
|
|
104
|
+
|
|
105
|
+
<ul class="summary">
|
|
106
|
+
|
|
107
|
+
<li class="public ">
|
|
108
|
+
<span class="summary_signature">
|
|
109
|
+
|
|
110
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</span>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<span class="summary_desc"></span>
|
|
123
|
+
|
|
124
|
+
</li>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</ul>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<h3 class="inherited">Methods inherited from <a href="Datum.html" title="TableFu::Datum (class)">Datum</a></h3>
|
|
135
|
+
<p class="inherited"><a href="Datum.html#initialize-instance_method" title="TableFu::Datum#initialize (method)">#initialize</a>, <a href="Datum.html#macro_value-instance_method" title="TableFu::Datum#macro_value (method)">#macro_value</a>, <a href="Datum.html#method_missing-instance_method" title="TableFu::Datum#method_missing (method)">#method_missing</a>, <a href="Datum.html#value-instance_method" title="TableFu::Datum#value (method)">#value</a></p>
|
|
136
|
+
<div id="constructor_details" class="method_details_list">
|
|
137
|
+
<h2>Constructor Details</h2>
|
|
138
|
+
|
|
139
|
+
<p class="notice">This class inherits a constructor from <a href="Datum.html#initialize-instance_method" title="TableFu::Datum#initialize (method)">TableFu::Datum</a></p>
|
|
140
|
+
|
|
141
|
+
</div>
|
|
142
|
+
<div id="method_missing_details" class="method_details_list">
|
|
143
|
+
<h2>Dynamic Method Handling</h2>
|
|
144
|
+
<p class="notice super">
|
|
145
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
|
146
|
+
|
|
147
|
+
in the class <a href="Datum.html#method_missing-instance_method" title="TableFu::Datum#method_missing (method)">TableFu::Datum</a>
|
|
148
|
+
|
|
149
|
+
</p>
|
|
150
|
+
|
|
151
|
+
</div>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<div id="instance_method_details" class="method_details_list">
|
|
155
|
+
<h2>Instance Method Details</h2>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<div class="method_details first">
|
|
159
|
+
<p class="signature first" id="to_s-instance_method">
|
|
160
|
+
|
|
161
|
+
- (<tt>Object</tt>) <strong>to_s</strong>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</p><table class="source_code">
|
|
166
|
+
<tr>
|
|
167
|
+
<td>
|
|
168
|
+
<pre class="lines">
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
375
|
|
172
|
+
376
|
|
173
|
+
377</pre>
|
|
174
|
+
</td>
|
|
175
|
+
<td>
|
|
176
|
+
<pre class="code"><span class="info file"># File 'lib/table_fu.rb', line 375</span>
|
|
177
|
+
|
|
178
|
+
<span class='def def kw'>def</span> <span class='to_s identifier id'>to_s</span>
|
|
179
|
+
<span class='@datum ivar id'>@datum</span>
|
|
180
|
+
<span class='end end kw'>end</span>
|
|
181
|
+
</pre>
|
|
182
|
+
</td>
|
|
183
|
+
</tr>
|
|
184
|
+
</table>
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
</div>
|
|
190
|
+
|
|
191
|
+
<div id="footer">
|
|
192
|
+
Generated on Tue Mar 9 17:16:36 2010 by
|
|
193
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
|
|
194
|
+
0.5.3 (ruby-1.8.7).
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
</body>
|
|
198
|
+
</html>
|