workbook 0.4.13 → 0.4.14

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -1
  3. data/lib/workbook/modules/cell.rb +14 -0
  4. data/lib/workbook/version.rb +1 -1
  5. data/test/test_modules_cache.rb +14 -14
  6. data/test/test_modules_cell.rb +9 -2
  7. data/test/test_readers_xls_reader.rb +1 -1
  8. metadata +4 -46
  9. data/doc/RubyXL/Cell.html +0 -201
  10. data/doc/RubyXL/Workbook.html +0 -449
  11. data/doc/RubyXL.html +0 -128
  12. data/doc/Workbook/Book.html +0 -1852
  13. data/doc/Workbook/Cell.html +0 -1553
  14. data/doc/Workbook/Format.html +0 -1168
  15. data/doc/Workbook/Modules/RawObjectsStorage.html +0 -502
  16. data/doc/Workbook/Modules/TableDiffSort.html +0 -758
  17. data/doc/Workbook/Modules/TypeParser.html +0 -1063
  18. data/doc/Workbook/Modules.html +0 -117
  19. data/doc/Workbook/NilValue.html +0 -434
  20. data/doc/Workbook/Readers/CsvReader.html +0 -324
  21. data/doc/Workbook/Readers/OdsReader.html +0 -1066
  22. data/doc/Workbook/Readers/TxtReader.html +0 -236
  23. data/doc/Workbook/Readers/XlsReader.html +0 -378
  24. data/doc/Workbook/Readers/XlsShared.html +0 -188
  25. data/doc/Workbook/Readers/XlsxReader.html +0 -302
  26. data/doc/Workbook/Readers.html +0 -117
  27. data/doc/Workbook/Row.html +0 -2392
  28. data/doc/Workbook/Sheet.html +0 -875
  29. data/doc/Workbook/Table.html +0 -1732
  30. data/doc/Workbook/Template.html +0 -634
  31. data/doc/Workbook/Writers/CsvTableWriter.html +0 -200
  32. data/doc/Workbook/Writers/HtmlWriter.html +0 -407
  33. data/doc/Workbook/Writers/XlsWriter.html +0 -905
  34. data/doc/Workbook/Writers.html +0 -117
  35. data/doc/Workbook.html +0 -142
  36. data/doc/_index.html +0 -381
  37. data/doc/class_list.html +0 -53
  38. data/doc/css/common.css +0 -1
  39. data/doc/css/full_list.css +0 -57
  40. data/doc/css/style.css +0 -338
  41. data/doc/file.README.html +0 -245
  42. data/doc/file_list.html +0 -55
  43. data/doc/frames.html +0 -28
  44. data/doc/index.html +0 -245
  45. data/doc/js/app.js +0 -214
  46. data/doc/js/full_list.js +0 -173
  47. data/doc/js/jquery.js +0 -4
  48. data/doc/method_list.html +0 -1308
  49. data/doc/top-level-namespace.html +0 -112
  50. data/test/artifacts/floats_problem.xls +0 -0
@@ -1,634 +0,0 @@
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 http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
- <title>
7
- Class: Workbook::Template
8
-
9
- &mdash; Documentation by YARD 0.8.5.2
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
19
- relpath = '../';
20
- framesUrl = "../frames.html#!" + escape(window.location.href);
21
- </script>
22
-
23
-
24
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
-
26
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
-
28
-
29
- </head>
30
- <body>
31
- <div id="header">
32
- <div id="menu">
33
-
34
- <a href="../_index.html">Index (T)</a> &raquo;
35
- <span class='title'><span class='object_link'><a href="../Workbook.html" title="Workbook (module)">Workbook</a></span></span>
36
- &raquo;
37
- <span class="title">Template</span>
38
-
39
-
40
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
- </div>
42
-
43
- <div id="search">
44
-
45
- <a class="full_list_link" id="class_list_link"
46
- href="../class_list.html">
47
- Class List
48
- </a>
49
-
50
- <a class="full_list_link" id="method_list_link"
51
- href="../method_list.html">
52
- Method List
53
- </a>
54
-
55
- <a class="full_list_link" id="file_list_link"
56
- href="../file_list.html">
57
- File List
58
- </a>
59
-
60
- </div>
61
- <div class="clear"></div>
62
- </div>
63
-
64
- <iframe id="search_frame"></iframe>
65
-
66
- <div id="content"><h1>Class: Workbook::Template
67
-
68
-
69
-
70
- </h1>
71
-
72
- <dl class="box">
73
-
74
- <dt class="r1">Inherits:</dt>
75
- <dd class="r1">
76
- <span class="inheritName">Object</span>
77
-
78
- <ul class="fullTree">
79
- <li>Object</li>
80
-
81
- <li class="next">Workbook::Template</li>
82
-
83
- </ul>
84
- <a href="#" class="inheritanceTree">show all</a>
85
-
86
- </dd>
87
-
88
-
89
-
90
-
91
-
92
-
93
- <dt class="r2">Includes:</dt>
94
- <dd class="r2"><span class='object_link'><a href="Modules/RawObjectsStorage.html" title="Workbook::Modules::RawObjectsStorage (module)">Modules::RawObjectsStorage</a></span></dd>
95
-
96
-
97
-
98
-
99
-
100
- <dt class="r1 last">Defined in:</dt>
101
- <dd class="r1 last">lib/workbook/template.rb</dd>
102
-
103
- </dl>
104
- <div class="clear"></div>
105
-
106
- <h2>Overview</h2><div class="docstring">
107
- <div class="discussion">
108
-
109
- <p>Workbook::Template is a container for different Workbook::Format's and the
110
- storage of raw template data that isn't really supported by Workbook, but
111
- should survive a typical read/write cyclus.</p>
112
-
113
-
114
- </div>
115
- </div>
116
- <div class="tags">
117
-
118
-
119
- </div>
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
- <h2>
128
- Instance Method Summary
129
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
130
- </h2>
131
-
132
- <ul class="summary">
133
-
134
- <li class="public ">
135
- <span class="summary_signature">
136
-
137
- <a href="#add_format-instance_method" title="#add_format (instance method)">- (Object) <strong>add_format</strong>(format) </a>
138
-
139
-
140
-
141
- </span>
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- <span class="summary_desc"><div class='inline'>
152
- <p>Add a Workbook::Format to the template.</p>
153
- </div></span>
154
-
155
- </li>
156
-
157
-
158
- <li class="public ">
159
- <span class="summary_signature">
160
-
161
- <a href="#create_or_find_format_by-instance_method" title="#create_or_find_format_by (instance method)">- (Workbook::Format) <strong>create_or_find_format_by</strong>(name, variant = :default) </a>
162
-
163
-
164
-
165
- </span>
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
- <span class="summary_desc"><div class='inline'>
176
- <p>Create or find a format by name.</p>
177
- </div></span>
178
-
179
- </li>
180
-
181
-
182
- <li class="public ">
183
- <span class="summary_signature">
184
-
185
- <a href="#formats-instance_method" title="#formats (instance method)">- (Hash) <strong>formats</strong> </a>
186
-
187
-
188
-
189
- </span>
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
- <span class="summary_desc"><div class='inline'>
200
- <p>Return the list of associated formats.</p>
201
- </div></span>
202
-
203
- </li>
204
-
205
-
206
- <li class="public ">
207
- <span class="summary_signature">
208
-
209
- <a href="#has_header%3F-instance_method" title="#has_header? (instance method)">- (Boolean) <strong>has_header?</strong> </a>
210
-
211
-
212
-
213
- </span>
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
- <span class="summary_desc"><div class='inline'>
224
- <p>Whether the template has a predefined header (headers are used ).</p>
225
- </div></span>
226
-
227
- </li>
228
-
229
-
230
- <li class="public ">
231
- <span class="summary_signature">
232
-
233
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Template) <strong>initialize</strong> </a>
234
-
235
-
236
-
237
- </span>
238
-
239
-
240
- <span class="note title constructor">constructor</span>
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
- <span class="summary_desc"><div class='inline'>
250
- <p>Initialize Workbook::Template.</p>
251
- </div></span>
252
-
253
- </li>
254
-
255
-
256
- </ul>
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Modules/RawObjectsStorage.html" title="Workbook::Modules::RawObjectsStorage (module)">Modules::RawObjectsStorage</a></span></h3>
269
- <p class="inherited"><span class='object_link'><a href="Modules/RawObjectsStorage.html#add_raw-instance_method" title="Workbook::Modules::RawObjectsStorage#add_raw (method)">#add_raw</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#has_raw_for%3F-instance_method" title="Workbook::Modules::RawObjectsStorage#has_raw_for? (method)">#has_raw_for?</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#raws-instance_method" title="Workbook::Modules::RawObjectsStorage#raws (method)">#raws</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#remove_all_raws%21-instance_method" title="Workbook::Modules::RawObjectsStorage#remove_all_raws! (method)">#remove_all_raws!</a></span>, <span class='object_link'><a href="Modules/RawObjectsStorage.html#return_raw_for-instance_method" title="Workbook::Modules::RawObjectsStorage#return_raw_for (method)">#return_raw_for</a></span></p>
270
- <div id="constructor_details" class="method_details_list">
271
- <h2>Constructor Details</h2>
272
-
273
- <div class="method_details first">
274
- <h3 class="signature first" id="initialize-instance_method">
275
-
276
- - (<tt><span class='object_link'><a href="" title="Workbook::Template (class)">Template</a></span></tt>) <strong>initialize</strong>
277
-
278
-
279
-
280
-
281
-
282
- </h3><div class="docstring">
283
- <div class="discussion">
284
-
285
- <p>Initialize Workbook::Template</p>
286
-
287
-
288
- </div>
289
- </div>
290
- <div class="tags">
291
-
292
-
293
- </div><table class="source_code">
294
- <tr>
295
- <td>
296
- <pre class="lines">
297
-
298
-
299
- 10
300
- 11
301
- 12
302
- 13</pre>
303
- </td>
304
- <td>
305
- <pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 10</span>
306
-
307
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
308
- <span class='ivar'>@formats</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
309
- <span class='ivar'>@has_header</span> <span class='op'>=</span> <span class='kw'>true</span>
310
- <span class='kw'>end</span></pre>
311
- </td>
312
- </tr>
313
- </table>
314
- </div>
315
-
316
- </div>
317
-
318
-
319
- <div id="instance_method_details" class="method_details_list">
320
- <h2>Instance Method Details</h2>
321
-
322
-
323
- <div class="method_details first">
324
- <h3 class="signature first" id="add_format-instance_method">
325
-
326
- - (<tt>Object</tt>) <strong>add_format</strong>(format)
327
-
328
-
329
-
330
-
331
-
332
- </h3><div class="docstring">
333
- <div class="discussion">
334
-
335
- <p>Add a Workbook::Format to the template</p>
336
-
337
-
338
- </div>
339
- </div>
340
- <div class="tags">
341
- <p class="tag_title">Parameters:</p>
342
- <ul class="param">
343
-
344
- <li>
345
-
346
- <span class='name'>format</span>
347
-
348
-
349
- <span class='type'>(<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
350
-
351
-
352
-
353
- &mdash;
354
- <div class='inline'>
355
- <p>(of a cell) to add to the template</p>
356
- </div>
357
-
358
- </li>
359
-
360
- </ul>
361
-
362
-
363
- </div><table class="source_code">
364
- <tr>
365
- <td>
366
- <pre class="lines">
367
-
368
-
369
- 22
370
- 23
371
- 24
372
- 25
373
- 26
374
- 27
375
- 28</pre>
376
- </td>
377
- <td>
378
- <pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 22</span>
379
-
380
- <span class='kw'>def</span> <span class='id identifier rubyid_add_format'>add_format</span> <span class='id identifier rubyid_format'>format</span>
381
- <span class='kw'>if</span> <span class='id identifier rubyid_format'>format</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Format</span>
382
- <span class='ivar'>@formats</span><span class='lbracket'>[</span><span class='id identifier rubyid_format'>format</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='op'>=</span><span class='id identifier rubyid_format'>format</span>
383
- <span class='kw'>else</span>
384
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>format should be a Workboot::Format</span><span class='tstring_end'>&quot;</span></span>
385
- <span class='kw'>end</span>
386
- <span class='kw'>end</span></pre>
387
- </td>
388
- </tr>
389
- </table>
390
- </div>
391
-
392
- <div class="method_details ">
393
- <h3 class="signature " id="create_or_find_format_by-instance_method">
394
-
395
- - (<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>) <strong>create_or_find_format_by</strong>(name, variant = :default)
396
-
397
-
398
-
399
-
400
-
401
- </h3><div class="docstring">
402
- <div class="discussion">
403
-
404
- <p>Create or find a format by name</p>
405
-
406
-
407
- </div>
408
- </div>
409
- <div class="tags">
410
- <p class="tag_title">Parameters:</p>
411
- <ul class="param">
412
-
413
- <li>
414
-
415
- <span class='name'>name</span>
416
-
417
-
418
- <span class='type'>(<tt>String</tt>)</span>
419
-
420
-
421
-
422
- &mdash;
423
- <div class='inline'>
424
- <p>of the format (e.g. whatever you want, in diff names such as ‘destroyed’,
425
- ‘updated’ and ‘created’ are being used)</p>
426
- </div>
427
-
428
- </li>
429
-
430
- <li>
431
-
432
- <span class='name'>variant</span>
433
-
434
-
435
- <span class='type'>(<tt>Symbol</tt>)</span>
436
-
437
-
438
- <em class="default">(defaults to: <tt>:default</tt>)</em>
439
-
440
-
441
- &mdash;
442
- <div class='inline'>
443
- <p>can also be a strftime formatting string (e.g. “%Y-%m-%d”)</p>
444
- </div>
445
-
446
- </li>
447
-
448
- </ul>
449
-
450
- <p class="tag_title">Returns:</p>
451
- <ul class="return">
452
-
453
- <li>
454
-
455
-
456
- <span class='type'>(<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
457
-
458
-
459
-
460
- &mdash;
461
- <div class='inline'>
462
- <p>The new or found format</p>
463
- </div>
464
-
465
- </li>
466
-
467
- </ul>
468
-
469
- </div><table class="source_code">
470
- <tr>
471
- <td>
472
- <pre class="lines">
473
-
474
-
475
- 40
476
- 41
477
- 42
478
- 43
479
- 44
480
- 45
481
- 46
482
- 47
483
- 48
484
- 49
485
- 50
486
- 51
487
- 52</pre>
488
- </td>
489
- <td>
490
- <pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 40</span>
491
-
492
- <span class='kw'>def</span> <span class='id identifier rubyid_create_or_find_format_by'>create_or_find_format_by</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_variant'>variant</span><span class='op'>=</span><span class='symbol'>:default</span>
493
- <span class='id identifier rubyid_fs'>fs</span> <span class='op'>=</span> <span class='ivar'>@formats</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
494
- <span class='id identifier rubyid_fs'>fs</span> <span class='op'>=</span> <span class='ivar'>@formats</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_fs'>fs</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
495
- <span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='id identifier rubyid_fs'>fs</span><span class='lbracket'>[</span><span class='id identifier rubyid_variant'>variant</span><span class='rbracket'>]</span>
496
- <span class='kw'>if</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
497
- <span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Format</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
498
- <span class='kw'>if</span> <span class='id identifier rubyid_variant'>variant</span> <span class='op'>!=</span> <span class='symbol'>:default</span> <span class='kw'>and</span> <span class='id identifier rubyid_fs'>fs</span><span class='lbracket'>[</span><span class='symbol'>:default</span><span class='rbracket'>]</span>
499
- <span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='id identifier rubyid_fs'>fs</span><span class='lbracket'>[</span><span class='symbol'>:default</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_clone'>clone</span>
500
- <span class='kw'>end</span>
501
- <span class='ivar'>@formats</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_variant'>variant</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_f'>f</span>
502
- <span class='kw'>end</span>
503
- <span class='kw'>return</span> <span class='ivar'>@formats</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_variant'>variant</span><span class='rbracket'>]</span>
504
- <span class='kw'>end</span></pre>
505
- </td>
506
- </tr>
507
- </table>
508
- </div>
509
-
510
- <div class="method_details ">
511
- <h3 class="signature " id="formats-instance_method">
512
-
513
- - (<tt>Hash</tt>) <strong>formats</strong>
514
-
515
-
516
-
517
-
518
-
519
- </h3><div class="docstring">
520
- <div class="discussion">
521
-
522
- <p>Return the list of associated formats</p>
523
-
524
-
525
- </div>
526
- </div>
527
- <div class="tags">
528
-
529
- <p class="tag_title">Returns:</p>
530
- <ul class="return">
531
-
532
- <li>
533
-
534
-
535
- <span class='type'>(<tt>Hash</tt>)</span>
536
-
537
-
538
-
539
- &mdash;
540
- <div class='inline'>
541
- <p>A keyed-hash of named formats</p>
542
- </div>
543
-
544
- </li>
545
-
546
- </ul>
547
-
548
- </div><table class="source_code">
549
- <tr>
550
- <td>
551
- <pre class="lines">
552
-
553
-
554
- 32
555
- 33
556
- 34</pre>
557
- </td>
558
- <td>
559
- <pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 32</span>
560
-
561
- <span class='kw'>def</span> <span class='id identifier rubyid_formats'>formats</span>
562
- <span class='ivar'>@formats</span>
563
- <span class='kw'>end</span></pre>
564
- </td>
565
- </tr>
566
- </table>
567
- </div>
568
-
569
- <div class="method_details ">
570
- <h3 class="signature " id="has_header?-instance_method">
571
-
572
- - (<tt>Boolean</tt>) <strong>has_header?</strong>
573
-
574
-
575
-
576
-
577
-
578
- </h3><div class="docstring">
579
- <div class="discussion">
580
-
581
- <p>Whether the template has a predefined header (headers are used )</p>
582
-
583
-
584
- </div>
585
- </div>
586
- <div class="tags">
587
-
588
- <p class="tag_title">Returns:</p>
589
- <ul class="return">
590
-
591
- <li>
592
-
593
-
594
- <span class='type'>(<tt>Boolean</tt>)</span>
595
-
596
-
597
-
598
- </li>
599
-
600
- </ul>
601
-
602
- </div><table class="source_code">
603
- <tr>
604
- <td>
605
- <pre class="lines">
606
-
607
-
608
- 16
609
- 17
610
- 18</pre>
611
- </td>
612
- <td>
613
- <pre class="code"><span class="info file"># File 'lib/workbook/template.rb', line 16</span>
614
-
615
- <span class='kw'>def</span> <span class='id identifier rubyid_has_header?'>has_header?</span>
616
- <span class='ivar'>@has_header</span>
617
- <span class='kw'>end</span></pre>
618
- </td>
619
- </tr>
620
- </table>
621
- </div>
622
-
623
- </div>
624
-
625
- </div>
626
-
627
- <div id="footer">
628
- Generated on Sun May 19 23:16:32 2013 by
629
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
630
- 0.8.5.2 (ruby-1.9.3).
631
- </div>
632
-
633
- </body>
634
- </html>