workbook 0.3.1 → 0.4

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 (62) hide show
  1. data/.yardoc/checksums +21 -18
  2. data/.yardoc/object_types +0 -0
  3. data/.yardoc/objects/root.dat +0 -0
  4. data/Gemfile.lock +4 -4
  5. data/README.md +8 -5
  6. data/doc/RubyXL/Cell.html +18 -19
  7. data/doc/RubyXL/Workbook.html +116 -114
  8. data/doc/RubyXL.html +3 -3
  9. data/doc/Workbook/Book.html +513 -145
  10. data/doc/Workbook/Cell.html +181 -170
  11. data/doc/Workbook/Format.html +591 -77
  12. data/doc/Workbook/Modules/RawObjectsStorage.html +39 -45
  13. data/doc/Workbook/Modules/TableDiffSort.html +225 -87
  14. data/doc/Workbook/Modules/TypeParser.html +182 -131
  15. data/doc/Workbook/Modules.html +3 -3
  16. data/doc/Workbook/Readers/CsvReader.html +101 -39
  17. data/doc/Workbook/Readers/OdsReader.html +564 -0
  18. data/doc/Workbook/Readers/TxtReader.html +12 -14
  19. data/doc/Workbook/Readers/XlsReader.html +154 -138
  20. data/doc/Workbook/Readers/XlsShared.html +71 -72
  21. data/doc/Workbook/Readers/XlsxReader.html +89 -82
  22. data/doc/Workbook/Readers.html +6 -6
  23. data/doc/Workbook/Row.html +421 -206
  24. data/doc/Workbook/Sheet.html +379 -32
  25. data/doc/Workbook/Table.html +328 -90
  26. data/doc/Workbook/Template.html +55 -60
  27. data/doc/Workbook/Writers/CsvTableWriter.html +33 -8
  28. data/doc/Workbook/Writers/HtmlWriter.html +393 -0
  29. data/doc/Workbook/Writers/XlsWriter.html +132 -92
  30. data/doc/Workbook/Writers.html +5 -5
  31. data/doc/Workbook.html +16 -4
  32. data/doc/_index.html +45 -15
  33. data/doc/class_list.html +1 -1
  34. data/doc/css/style.css +10 -0
  35. data/doc/file.README.html +53 -48
  36. data/doc/frames.html +1 -1
  37. data/doc/index.html +53 -48
  38. data/doc/method_list.html +232 -56
  39. data/doc/top-level-namespace.html +3 -3
  40. data/lib/workbook/book.rb +27 -1
  41. data/lib/workbook/format.rb +46 -7
  42. data/lib/workbook/modules/type_parser.rb +8 -1
  43. data/lib/workbook/readers/ods_reader.rb +93 -0
  44. data/lib/workbook/row.rb +7 -0
  45. data/lib/workbook/sheet.rb +10 -0
  46. data/lib/workbook/version.rb +1 -1
  47. data/lib/workbook/writers/html_writer.rb +56 -0
  48. data/test/artifacts/book_with_tabs_and_colours.ods +0 -0
  49. data/test/artifacts/complex_types.ods +0 -0
  50. data/test/artifacts/excel_different_types.ods +0 -0
  51. data/test/artifacts/simple_sheet.ods +0 -0
  52. data/test/test_book.rb +6 -0
  53. data/test/test_format.rb +39 -0
  54. data/test/test_modules_type_parser.rb +2 -0
  55. data/test/test_readers_csv_reader.rb +44 -0
  56. data/test/test_readers_ods_reader.rb +51 -0
  57. data/test/test_readers_txt_reader.rb +53 -0
  58. data/test/test_row.rb +12 -0
  59. data/test/test_sheet.rb +12 -0
  60. data/test/test_writers_html_writer.rb +37 -0
  61. data/workbook.gemspec +2 -2
  62. metadata +21 -4
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: Workbook::Sheet
8
8
 
9
- &mdash; Documentation by YARD 0.8.3
9
+ &mdash; Documentation by YARD 0.8.5.2
10
10
 
11
11
  </title>
12
12
 
@@ -132,6 +132,33 @@
132
132
  <p>Returns the book this sheet belongs to.</p>
133
133
  </div></span>
134
134
 
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Returns the value of attribute name.</p>
160
+ </div></span>
161
+
135
162
  </li>
136
163
 
137
164
 
@@ -151,6 +178,78 @@
151
178
  <li class="public ">
152
179
  <span class="summary_signature">
153
180
 
181
+ <a href="#clone-instance_method" title="#clone (instance method)">- (Workbook::Sheet) <strong>clone</strong> </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>clones itself <b>and</b> the tables it contains.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#create_or_open_table_at-instance_method" title="#create_or_open_table_at (instance method)">- (Object) <strong>create_or_open_table_at</strong>(index) </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'>
220
+ <p>Create or open the existing table at an index value.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#delete_all-instance_method" title="#delete_all (instance method)">- (Workbook::Table) <strong>delete_all</strong> </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+ <span class="summary_desc"><div class='inline'>
244
+ <p>Removes all lines from this table.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
154
253
  <a href="#has_contents%3F-instance_method" title="#has_contents? (instance method)">- (Boolean) <strong>has_contents?</strong> </a>
155
254
 
156
255
 
@@ -313,13 +412,28 @@
313
412
  <pre class="lines">
314
413
 
315
414
 
316
- 12</pre>
415
+ 14
416
+ 15
417
+ 16
418
+ 17
419
+ 18
420
+ 19
421
+ 20
422
+ 21
423
+ 22</pre>
317
424
  </td>
318
425
  <td>
319
- <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 12</span>
320
-
321
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span> <span class='rubyid_table identifier id'>table</span><span class='assign token'>=</span><span class='rubyid_Workbook constant id'>Workbook</span><span class='colon2 op'>::</span><span class='rubyid_Table constant id'>Table</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_self self kw'>self</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='rubyid_book identifier id'>book</span><span class='assign token'>=</span><span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='rubyid_options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span>
322
- </pre>
426
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 14</span>
427
+
428
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_table'>table</span><span class='op'>=</span><span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Table</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_book'>book</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span>
429
+ <span class='kw'>if</span> <span class='id identifier rubyid_table'>table</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'>Table</span>
430
+ <span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_table'>table</span>
431
+ <span class='kw'>else</span>
432
+ <span class='id identifier rubyid_push'>push</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Table</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
433
+ <span class='kw'>end</span>
434
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_book'>book</span> <span class='op'>=</span> <span class='id identifier rubyid_book'>book</span>
435
+ <span class='kw'>return</span> <span class='kw'>self</span>
436
+ <span class='kw'>end</span></pre>
323
437
  </td>
324
438
  </tr>
325
439
  </table>
@@ -376,17 +490,59 @@
376
490
  <pre class="lines">
377
491
 
378
492
 
379
- 4
380
493
  5
381
- 6</pre>
494
+ 6
495
+ 7</pre>
496
+ </td>
497
+ <td>
498
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 5</span>
499
+
500
+ <span class='kw'>def</span> <span class='id identifier rubyid_book'>book</span>
501
+ <span class='ivar'>@book</span>
502
+ <span class='kw'>end</span></pre>
503
+ </td>
504
+ </tr>
505
+ </table>
506
+ </div>
507
+
508
+
509
+ <span id="name=-instance_method"></span>
510
+ <div class="method_details ">
511
+ <h3 class="signature " id="name-instance_method">
512
+
513
+ - (<tt>Object</tt>) <strong>name</strong>
514
+
515
+
516
+
517
+
518
+
519
+ </h3><div class="docstring">
520
+ <div class="discussion">
521
+
522
+ <p>Returns the value of attribute name</p>
523
+
524
+
525
+ </div>
526
+ </div>
527
+ <div class="tags">
528
+
529
+
530
+ </div><table class="source_code">
531
+ <tr>
532
+ <td>
533
+ <pre class="lines">
534
+
535
+
536
+ 6
537
+ 7
538
+ 8</pre>
382
539
  </td>
383
540
  <td>
384
- <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 4</span>
541
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 6</span>
385
542
 
386
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_book identifier id'>book</span>
387
- <span class='rubyid_@book ivar id'>@book</span>
388
- <span class='rubyid_end end kw'>end</span>
389
- </pre>
543
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
544
+ <span class='ivar'>@name</span>
545
+ <span class='kw'>end</span></pre>
390
546
  </td>
391
547
  </tr>
392
548
  </table>
@@ -400,7 +556,200 @@
400
556
 
401
557
 
402
558
  <div class="method_details first">
403
- <h3 class="signature first" id="has_contents?-instance_method">
559
+ <h3 class="signature first" id="clone-instance_method">
560
+
561
+ - (<tt><span class='object_link'><a href="" title="Workbook::Sheet (class)">Workbook::Sheet</a></span></tt>) <strong>clone</strong>
562
+
563
+
564
+
565
+
566
+
567
+ </h3><div class="docstring">
568
+ <div class="discussion">
569
+
570
+ <p>clones itself <b>and</b> the tables it contains</p>
571
+
572
+
573
+ </div>
574
+ </div>
575
+ <div class="tags">
576
+
577
+ <p class="tag_title">Returns:</p>
578
+ <ul class="return">
579
+
580
+ <li>
581
+
582
+
583
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Sheet (class)">Workbook::Sheet</a></span></tt>)</span>
584
+
585
+
586
+
587
+ &mdash;
588
+ <div class='inline'>
589
+ <p>The cloned sheet</p>
590
+ </div>
591
+
592
+ </li>
593
+
594
+ </ul>
595
+
596
+ </div><table class="source_code">
597
+ <tr>
598
+ <td>
599
+ <pre class="lines">
600
+
601
+
602
+ 60
603
+ 61
604
+ 62
605
+ 63
606
+ 64
607
+ 65
608
+ 66</pre>
609
+ </td>
610
+ <td>
611
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 60</span>
612
+
613
+ <span class='kw'>def</span> <span class='id identifier rubyid_clone'>clone</span>
614
+ <span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='kw'>self</span>
615
+ <span class='id identifier rubyid_c'>c</span> <span class='op'>=</span> <span class='kw'>super</span>
616
+ <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_delete_all'>delete_all</span>
617
+ <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_clone'>clone</span><span class='rbrace'>}</span>
618
+ <span class='kw'>return</span> <span class='id identifier rubyid_c'>c</span>
619
+ <span class='kw'>end</span></pre>
620
+ </td>
621
+ </tr>
622
+ </table>
623
+ </div>
624
+
625
+ <div class="method_details ">
626
+ <h3 class="signature " id="create_or_open_table_at-instance_method">
627
+
628
+ - (<tt>Object</tt>) <strong>create_or_open_table_at</strong>(index)
629
+
630
+
631
+
632
+
633
+
634
+ </h3><div class="docstring">
635
+ <div class="discussion">
636
+
637
+ <p>Create or open the existing table at an index value</p>
638
+
639
+
640
+ </div>
641
+ </div>
642
+ <div class="tags">
643
+ <p class="tag_title">Parameters:</p>
644
+ <ul class="param">
645
+
646
+ <li>
647
+
648
+ <span class='name'>index</span>
649
+
650
+
651
+ <span class='type'>(<tt>Integer</tt>)</span>
652
+
653
+
654
+
655
+ &mdash;
656
+ <div class='inline'>
657
+ <p>the index of the table</p>
658
+ </div>
659
+
660
+ </li>
661
+
662
+ </ul>
663
+
664
+
665
+ </div><table class="source_code">
666
+ <tr>
667
+ <td>
668
+ <pre class="lines">
669
+
670
+
671
+ 71
672
+ 72
673
+ 73
674
+ 74
675
+ 75
676
+ 76</pre>
677
+ </td>
678
+ <td>
679
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 71</span>
680
+
681
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_or_open_table_at'>create_or_open_table_at</span> <span class='id identifier rubyid_index'>index</span>
682
+ <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
683
+ <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Table</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>if</span> <span class='id identifier rubyid_t'>t</span> <span class='op'>==</span> <span class='kw'>nil</span>
684
+ <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_sheet'>sheet</span> <span class='op'>=</span> <span class='kw'>self</span>
685
+ <span class='id identifier rubyid_t'>t</span>
686
+ <span class='kw'>end</span></pre>
687
+ </td>
688
+ </tr>
689
+ </table>
690
+ </div>
691
+
692
+ <div class="method_details ">
693
+ <h3 class="signature " id="delete_all-instance_method">
694
+
695
+ - (<tt><span class='object_link'><a href="Table.html" title="Workbook::Table (class)">Workbook::Table</a></span></tt>) <strong>delete_all</strong>
696
+
697
+
698
+
699
+
700
+
701
+ </h3><div class="docstring">
702
+ <div class="discussion">
703
+
704
+ <p>Removes all lines from this table</p>
705
+
706
+
707
+ </div>
708
+ </div>
709
+ <div class="tags">
710
+
711
+ <p class="tag_title">Returns:</p>
712
+ <ul class="return">
713
+
714
+ <li>
715
+
716
+
717
+ <span class='type'>(<tt><span class='object_link'><a href="Table.html" title="Workbook::Table (class)">Workbook::Table</a></span></tt>)</span>
718
+
719
+
720
+
721
+ &mdash;
722
+ <div class='inline'>
723
+ <p>(self)</p>
724
+ </div>
725
+
726
+ </li>
727
+
728
+ </ul>
729
+
730
+ </div><table class="source_code">
731
+ <tr>
732
+ <td>
733
+ <pre class="lines">
734
+
735
+
736
+ 53
737
+ 54
738
+ 55</pre>
739
+ </td>
740
+ <td>
741
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 53</span>
742
+
743
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_all'>delete_all</span>
744
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_b'>b</span><span class='op'>|</span> <span class='kw'>true</span><span class='rbrace'>}</span>
745
+ <span class='kw'>end</span></pre>
746
+ </td>
747
+ </tr>
748
+ </table>
749
+ </div>
750
+
751
+ <div class="method_details ">
752
+ <h3 class="signature " id="has_contents?-instance_method">
404
753
 
405
754
  - (<tt>Boolean</tt>) <strong>has_contents?</strong>
406
755
 
@@ -438,17 +787,16 @@
438
787
  <pre class="lines">
439
788
 
440
789
 
441
- 25
442
- 26
443
- 27</pre>
790
+ 27
791
+ 28
792
+ 29</pre>
444
793
  </td>
445
794
  <td>
446
- <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 25</span>
795
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 27</span>
447
796
 
448
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_has_contents? fid id'>has_contents?</span>
449
- <span class='rubyid_table identifier id'>table</span><span class='dot token'>.</span><span class='rubyid_has_contents? fid id'>has_contents?</span>
450
- <span class='rubyid_end end kw'>end</span>
451
- </pre>
797
+ <span class='kw'>def</span> <span class='id identifier rubyid_has_contents?'>has_contents?</span>
798
+ <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_has_contents?'>has_contents?</span>
799
+ <span class='kw'>end</span></pre>
452
800
  </td>
453
801
  </tr>
454
802
  </table>
@@ -498,17 +846,16 @@
498
846
  <pre class="lines">
499
847
 
500
848
 
501
- 32
502
- 33
503
- 34</pre>
849
+ 34
850
+ 35
851
+ 36</pre>
504
852
  </td>
505
853
  <td>
506
- <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 32</span>
854
+ <pre class="code"><span class="info file"># File 'lib/workbook/sheet.rb', line 34</span>
507
855
 
508
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_table identifier id'>table</span>
509
- <span class='rubyid_first identifier id'>first</span>
510
- <span class='rubyid_end end kw'>end</span>
511
- </pre>
856
+ <span class='kw'>def</span> <span class='id identifier rubyid_table'>table</span>
857
+ <span class='id identifier rubyid_first'>first</span>
858
+ <span class='kw'>end</span></pre>
512
859
  </td>
513
860
  </tr>
514
861
  </table>
@@ -519,9 +866,9 @@
519
866
  </div>
520
867
 
521
868
  <div id="footer">
522
- Generated on Thu Jan 17 13:16:04 2013 by
869
+ Generated on Sun May 5 14:58:07 2013 by
523
870
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
524
- 0.8.3 (ruby-1.8.7).
871
+ 0.8.5.2 (ruby-1.9.3).
525
872
  </div>
526
873
 
527
874
  </body>