axlsx 1.0.9 → 1.0.10

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 (87) hide show
  1. data/Gemfile +7 -0
  2. data/Gemfile.lock +20 -0
  3. data/README.md +46 -3
  4. data/axlsx.gemspec +10 -10
  5. data/doc/Axlsx/App.html +111 -86
  6. data/doc/Axlsx/Ar/ClassMethods.html +188 -0
  7. data/doc/Axlsx/Ar/InstanceMethods.html +108 -0
  8. data/doc/Axlsx/Ar/SingletonMethods.html +312 -0
  9. data/doc/Axlsx/Ar.html +196 -0
  10. data/doc/Axlsx/Axis.html +57 -48
  11. data/doc/Axlsx/Bar3DChart.html +64 -54
  12. data/doc/Axlsx/BarSeries.html +29 -24
  13. data/doc/Axlsx/Border.html +45 -38
  14. data/doc/Axlsx/BorderPr.html +51 -44
  15. data/doc/Axlsx/CatAxis.html +32 -26
  16. data/doc/Axlsx/CatAxisData.html +25 -23
  17. data/doc/Axlsx/Cell.html +486 -65
  18. data/doc/Axlsx/CellAlignment.html +63 -50
  19. data/doc/Axlsx/CellProtection.html +20 -16
  20. data/doc/Axlsx/CellStyle.html +36 -28
  21. data/doc/Axlsx/Chart.html +102 -86
  22. data/doc/Axlsx/Color.html +27 -21
  23. data/doc/Axlsx/ContentType.html +15 -13
  24. data/doc/Axlsx/Core.html +27 -24
  25. data/doc/Axlsx/DataTypeValidator.html +13 -12
  26. data/doc/Axlsx/Default.html +21 -17
  27. data/doc/Axlsx/Drawing.html +82 -68
  28. data/doc/Axlsx/Fill.html +14 -11
  29. data/doc/Axlsx/Font.html +98 -82
  30. data/doc/Axlsx/GradientFill.html +47 -37
  31. data/doc/Axlsx/GradientStop.html +17 -13
  32. data/doc/Axlsx/GraphicFrame.html +39 -34
  33. data/doc/Axlsx/Line3DChart.html +64 -55
  34. data/doc/Axlsx/LineSeries.html +24 -20
  35. data/doc/Axlsx/Marker.html +40 -33
  36. data/doc/Axlsx/NumFmt.html +52 -47
  37. data/doc/Axlsx/OneCellAnchor.html +49 -41
  38. data/doc/Axlsx/Override.html +21 -17
  39. data/doc/Axlsx/Package.html +186 -77
  40. data/doc/Axlsx/PatternFill.html +47 -41
  41. data/doc/Axlsx/Pic.html +99 -83
  42. data/doc/Axlsx/Pie3DChart.html +17 -15
  43. data/doc/Axlsx/PieSeries.html +29 -24
  44. data/doc/Axlsx/RegexValidator.html +6 -5
  45. data/doc/Axlsx/Relationship.html +21 -17
  46. data/doc/Axlsx/Relationships.html +15 -13
  47. data/doc/Axlsx/RestrictionValidator.html +7 -6
  48. data/doc/Axlsx/Row.html +187 -33
  49. data/doc/Axlsx/Scaling.html +35 -29
  50. data/doc/Axlsx/SerAxis.html +23 -19
  51. data/doc/Axlsx/Series.html +140 -28
  52. data/doc/Axlsx/SeriesTitle.html +16 -15
  53. data/doc/Axlsx/Styles.html +179 -164
  54. data/doc/Axlsx/TableStyle.html +28 -23
  55. data/doc/Axlsx/TableStyleElement.html +53 -47
  56. data/doc/Axlsx/TableStyles.html +26 -22
  57. data/doc/Axlsx/Title.html +32 -28
  58. data/doc/Axlsx/TwoCellAnchor.html +50 -42
  59. data/doc/Axlsx/ValAxis.html +18 -15
  60. data/doc/Axlsx/ValAxisData.html +20 -19
  61. data/doc/Axlsx/View3D.html +48 -38
  62. data/doc/Axlsx/Workbook.html +225 -201
  63. data/doc/Axlsx/Worksheet.html +869 -184
  64. data/doc/Axlsx/Xf.html +75 -58
  65. data/doc/Axlsx.html +207 -124
  66. data/doc/_index.html +2 -2
  67. data/doc/css/style.css +1 -1
  68. data/doc/file.LICENSE.html +11 -10
  69. data/doc/file.README.html +142 -93
  70. data/doc/index.html +142 -93
  71. data/doc/js/app.js +4 -4
  72. data/doc/method_list.html +460 -364
  73. data/doc/top-level-namespace.html +2 -2
  74. data/examples/example.rb +71 -14
  75. data/lib/axlsx/package.rb +8 -1
  76. data/lib/axlsx/stylesheet/styles.rb +1 -1
  77. data/lib/axlsx/util/simple_typed_list.rb +5 -0
  78. data/lib/axlsx/version.rb +1 -1
  79. data/lib/axlsx/workbook/workbook.rb +4 -2
  80. data/lib/axlsx/workbook/worksheet/cell.rb +8 -13
  81. data/lib/axlsx/workbook/worksheet/row.rb +15 -0
  82. data/lib/axlsx/workbook/worksheet/worksheet.rb +44 -1
  83. data/lib/axlsx.rb +3 -5
  84. data/test/rels/tc_relationships.rb +2 -6
  85. data/test/workbook/worksheet/tc_row.rb +6 -0
  86. data/test/workbook/worksheet/tc_worksheet.rb +36 -0
  87. metadata +139 -55
@@ -330,12 +330,13 @@ specified.</p>
330
330
  <td>
331
331
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 17</span>
332
332
 
333
- <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
334
- <span class='id 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'>PartName and ContentType are required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:PartName</span><span class='rbracket'>]</span> <span class='op'>&amp;&amp;</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ContentType</span><span class='rbracket'>]</span>
335
- <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span>
336
- <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span>
337
- <span class='kw'>end</span>
338
- <span class='kw'>end</span></pre>
333
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
334
+ <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>&quot;PartName and ContentType are required&quot;</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:PartName</span><span class='rbrack token'>]</span> <span class='andop op'>&amp;&amp;</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack token'>]</span>
335
+ <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span>
336
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>&quot;#{o[0]}=&quot;</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>&quot;#{o[0]}=&quot;</span>
337
+ <span class='end end kw'>end</span>
338
+ <span class='end end kw'>end</span>
339
+ </pre>
339
340
  </td>
340
341
  </tr>
341
342
  </table>
@@ -393,9 +394,10 @@ specified.</p>
393
394
  <td>
394
395
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 7</span>
395
396
 
396
- <span class='kw'>def</span> <span class='const'>ContentType</span>
397
- <span class='ivar'>@ContentType</span>
398
- <span class='kw'>end</span></pre>
397
+ <span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span>
398
+ <span class='@ContentType ivar id'>@ContentType</span>
399
+ <span class='end end kw'>end</span>
400
+ </pre>
399
401
  </td>
400
402
  </tr>
401
403
  </table>
@@ -448,9 +450,10 @@ specified.</p>
448
450
  <td>
449
451
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 11</span>
450
452
 
451
- <span class='kw'>def</span> <span class='const'>PartName</span>
452
- <span class='ivar'>@PartName</span>
453
- <span class='kw'>end</span></pre>
453
+ <span class='def def kw'>def</span> <span class='PartName constant id'>PartName</span>
454
+ <span class='@PartName ivar id'>@PartName</span>
455
+ <span class='end end kw'>end</span>
456
+ </pre>
454
457
  </td>
455
458
  </tr>
456
459
  </table>
@@ -514,9 +517,10 @@ specified.</p>
514
517
  <td>
515
518
  <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 33</span>
516
519
 
517
- <span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span>
518
- <span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Override</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span>
519
- <span class='kw'>end</span></pre>
520
+ <span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
521
+ <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Override constant id'>Override</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span>
522
+ <span class='end end kw'>end</span>
523
+ </pre>
520
524
  </td>
521
525
  </tr>
522
526
  </table>
@@ -527,9 +531,9 @@ specified.</p>
527
531
  </div>
528
532
 
529
533
  <div id="footer">
530
- Generated on Sat Nov 26 13:16:39 2011 by
534
+ Generated on Wed Nov 30 08:53:49 2011 by
531
535
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
532
- 0.7.3 (ruby-1.9.3).
536
+ 0.7.3 (ruby-1.8.7).
533
537
  </div>
534
538
 
535
539
  </body>
@@ -140,6 +140,29 @@ serialization.</p>
140
140
  <p>Initializes your package.</p>
141
141
  </div></span>
142
142
 
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#ruport_table-instance_method" title="#ruport_table (instance method)">- (Object) <strong>ruport_table</strong>(table) </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <span class="summary_desc"><div class='inline'>
163
+ <p>Accepts a ruport table for serialization to xlsx.</p>
164
+ </div></span>
165
+
143
166
  </li>
144
167
 
145
168
 
@@ -192,7 +215,7 @@ serialization.</p>
192
215
  <li class="public ">
193
216
  <span class="summary_signature">
194
217
 
195
- <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a>
218
+ <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> {|@workbook| ... }</a>
196
219
 
197
220
 
198
221
 
@@ -262,7 +285,8 @@ serialization.</p>
262
285
  <h4><div class='inline'>
263
286
  <p>Package.new :author =&gt; ‘you!’, :workbook =&gt; Workbook.new</p>
264
287
  </div></h4>
265
- <pre class="example code"></pre>
288
+ <pre class="example code">
289
+ </pre>
266
290
 
267
291
  </div>
268
292
  <h3>Parameters:</h3>
@@ -359,12 +383,13 @@ package.</p>
359
383
  <td>
360
384
  <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 12</span>
361
385
 
362
- <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
363
- <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='kw'>nil</span>
364
- <span class='ivar'>@core</span><span class='comma'>,</span> <span class='ivar'>@app</span> <span class='op'>=</span> <span class='const'>Core</span><span class='period'>.</span><span class='id new'>new</span><span class='comma'>,</span> <span class='const'>App</span><span class='period'>.</span><span class='id new'>new</span>
365
- <span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:author</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span>
366
- <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
367
- <span class='kw'>end</span></pre>
386
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
387
+ <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span>
388
+ <span class='@core ivar id'>@core</span><span class='comma token'>,</span> <span class='@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='Core constant id'>Core</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='App constant id'>App</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
389
+ <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:author</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span>
390
+ <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
391
+ <span class='end end kw'>end</span>
392
+ </pre>
368
393
  </td>
369
394
  </tr>
370
395
  </table>
@@ -378,7 +403,67 @@ package.</p>
378
403
 
379
404
 
380
405
  <div class="method_details first">
381
- <p class="signature first" id="serialize-instance_method">
406
+ <p class="signature first" id="ruport_table-instance_method">
407
+
408
+ - (<tt>Object</tt>) <strong>ruport_table</strong>(table)
409
+
410
+
411
+
412
+ </p><div class="docstring">
413
+ <div class="discussion">
414
+
415
+ <p>Accepts a ruport table for serialization to xlsx</p>
416
+
417
+
418
+ </div>
419
+ </div>
420
+ <div class="tags">
421
+ <h3>Parameters:</h3>
422
+ <ul class="param">
423
+
424
+ <li>
425
+
426
+ <span class='name'>table</span>
427
+
428
+
429
+ <span class='type'>(<tt>Table</tt>)</span>
430
+
431
+
432
+
433
+ &mdash;
434
+ <div class='inline'>
435
+ <p>a ruport Table object</p>
436
+ </div>
437
+
438
+ </li>
439
+
440
+ </ul>
441
+
442
+
443
+ </div><table class="source_code">
444
+ <tr>
445
+ <td>
446
+ <pre class="lines">
447
+
448
+
449
+ 21
450
+ 22
451
+ 23</pre>
452
+ </td>
453
+ <td>
454
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span>
455
+
456
+ <span class='def def kw'>def</span> <span class='ruport_table identifier id'>ruport_table</span><span class='lparen token'>(</span><span class='table identifier id'>table</span><span class='rparen token'>)</span>
457
+ <span class='puts identifier id'>puts</span> <span class='table identifier id'>table</span>
458
+ <span class='end end kw'>end</span>
459
+ </pre>
460
+ </td>
461
+ </tr>
462
+ </table>
463
+ </div>
464
+
465
+ <div class="method_details ">
466
+ <p class="signature " id="serialize-instance_method">
382
467
 
383
468
  - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false)
384
469
 
@@ -408,12 +493,13 @@ you cannot open the serialized file.</p>
408
493
  <h3>Examples:</h3>
409
494
 
410
495
  <h4><div class='inline'></div></h4>
411
- <pre class="example code"><span class='comment'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
412
- </span><span class='comment'># Take a look at the README for an example of how to do it!
413
- </span><span class='id f'>f</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>test.xlsx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>w</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
414
- <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id f'>f</span><span class='rparen'>)</span>
496
+ <pre class="example code"><span class='comment val'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.</span>
497
+ <span class='comment val'># Take a look at the README for an example of how to do it!</span>
498
+ <span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'test.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span>
499
+ <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span>
415
500
 
416
- <span class='comment'># You will find a file called test.xlsx</span></pre>
501
+ <span class='comment val'># You will find a file called test.xlsx</span>
502
+ </pre>
417
503
 
418
504
  </div>
419
505
  <h3>Parameters:</h3>
@@ -488,13 +574,6 @@ serialized</p>
488
574
  <pre class="lines">
489
575
 
490
576
 
491
- 54
492
- 55
493
- 56
494
- 57
495
- 58
496
- 59
497
- 60
498
577
  61
499
578
  62
500
579
  63
@@ -505,29 +584,37 @@ serialized</p>
505
584
  68
506
585
  69
507
586
  70
508
- 71</pre>
587
+ 71
588
+ 72
589
+ 73
590
+ 74
591
+ 75
592
+ 76
593
+ 77
594
+ 78</pre>
509
595
  </td>
510
596
  <td>
511
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 54</span>
512
-
513
- <span class='kw'>def</span> <span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id output'>output</span><span class='comma'>,</span> <span class='id confirm_valid'>confirm_valid</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
514
- <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id confirm_valid'>confirm_valid</span> <span class='op'>||</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id empty?'>empty?</span>
515
- <span class='id p'>p</span> <span class='op'>=</span> <span class='id parts'>parts</span>
516
- <span class='const'>Zip</span><span class='op'>::</span><span class='const'>ZipOutputStream</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='id output'>output</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id zip'>zip</span><span class='op'>|</span>
517
- <span class='id p'>p</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span>
518
- <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
519
- <span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span>
520
- <span class='id zip'>zip</span><span class='period'>.</span><span class='id puts'>puts</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span>
521
- <span class='kw'>end</span>
522
- <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
523
- <span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span>
524
- <span class='comment'># binread for 1.9.3
525
- </span> <span class='id zip'>zip</span><span class='period'>.</span><span class='id write'>write</span> <span class='const'>IO</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:binread</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>IO</span><span class='period'>.</span><span class='id binread'>binread</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>IO</span><span class='period'>.</span><span class='id read'>read</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span>
526
- <span class='kw'>end</span>
527
- <span class='kw'>end</span>
528
- <span class='kw'>end</span>
529
- <span class='kw'>true</span>
530
- <span class='kw'>end</span></pre>
597
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 61</span>
598
+
599
+ <span class='def def kw'>def</span> <span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='confirm_valid identifier id'>confirm_valid</span><span class='assign token'>=</span><span class='false false kw'>false</span><span class='rparen token'>)</span>
600
+ <span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='notop op'>!</span><span class='confirm_valid identifier id'>confirm_valid</span> <span class='orop op'>||</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span>
601
+ <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='parts identifier id'>parts</span>
602
+ <span class='Zip constant id'>Zip</span><span class='colon2 op'>::</span><span class='ZipOutputStream constant id'>ZipOutputStream</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='zip identifier id'>zip</span><span class='bitor op'>|</span>
603
+ <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='part identifier id'>part</span><span class='bitor op'>|</span>
604
+ <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
605
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span>
606
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='puts identifier id'>puts</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
607
+ <span class='end end kw'>end</span>
608
+ <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
609
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span>
610
+ <span class='comment val'># binread for 1.9.3</span>
611
+ <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='write identifier id'>write</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:binread</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='binread identifier id'>binread</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
612
+ <span class='end end kw'>end</span>
613
+ <span class='end end kw'>end</span>
614
+ <span class='end end kw'>end</span>
615
+ <span class='true true kw'>true</span>
616
+ <span class='end end kw'>end</span>
617
+ </pre>
531
618
  </td>
532
619
  </tr>
533
620
  </table>
@@ -571,10 +658,11 @@ improved. Please report your errors to the gem author.</p>
571
658
  <h3>Examples:</h3>
572
659
 
573
660
  <h4><div class='inline'></div></h4>
574
- <pre class="example code"><span class='comment'># The following will output any error messages found in serialization.
575
- </span><span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span>
576
- <span class='comment'># ... code to create sheets, charts, styles etc.
577
- </span><span class='id p'>p</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id error'>error</span><span class='op'>|</span> <span class='id puts'>puts</span> <span class='id error'>error</span><span class='period'>.</span><span class='id message'>message</span> <span class='rbrace'>}</span></pre>
661
+ <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span>
662
+ <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
663
+ <span class='comment val'># ... code to create sheets, charts, styles etc.</span>
664
+ <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='error identifier id'>error</span><span class='bitor op'>|</span> <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='message identifier id'>message</span> <span class='rbrace token'>}</span>
665
+ </pre>
578
666
 
579
667
  </div>
580
668
 
@@ -610,20 +698,21 @@ improved. Please report your errors to the gem author.</p>
610
698
  <pre class="lines">
611
699
 
612
700
 
613
- 88
614
- 89
615
- 90
616
- 91
617
- 92</pre>
701
+ 95
702
+ 96
703
+ 97
704
+ 98
705
+ 99</pre>
618
706
  </td>
619
707
  <td>
620
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 88</span>
621
-
622
- <span class='kw'>def</span> <span class='id validate'>validate</span>
623
- <span class='id errors'>errors</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
624
- <span class='id parts'>parts</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span> <span class='id errors'>errors</span><span class='period'>.</span><span class='id concat'>concat</span> <span class='id validate_single_doc'>validate_single_doc</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='rbrace'>}</span>
625
- <span class='id errors'>errors</span>
626
- <span class='kw'>end</span></pre>
708
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 95</span>
709
+
710
+ <span class='def def kw'>def</span> <span class='validate identifier id'>validate</span>
711
+ <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
712
+ <span class='parts identifier id'>parts</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='part identifier id'>part</span><span class='bitor op'>|</span> <span class='errors identifier id'>errors</span><span class='dot token'>.</span><span class='concat identifier id'>concat</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span>
713
+ <span class='errors identifier id'>errors</span>
714
+ <span class='end end kw'>end</span>
715
+ </pre>
627
716
  </td>
628
717
  </tr>
629
718
  </table>
@@ -632,7 +721,7 @@ improved. Please report your errors to the gem author.</p>
632
721
  <div class="method_details ">
633
722
  <p class="signature " id="workbook-instance_method">
634
723
 
635
- - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong>
724
+ - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> {|@workbook| ... }
636
725
 
637
726
 
638
727
 
@@ -645,13 +734,14 @@ improved. Please report your errors to the gem author.</p>
645
734
  <p>As there are multiple ways to instantiate a workbook for the package, here
646
735
  are a few examples:</p>
647
736
 
648
- <pre class="code"><span class='comment'># assign directly during package instanciation
649
- </span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:workbook</span> <span class='op'>=&gt;</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span>
737
+ <pre class="ruby"><span class="ruby-comment"># assign directly during package instanciation</span>
738
+ <span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">workbook</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>).<span class="ruby-identifier">workbook</span>
650
739
 
651
- <span class='comment'># get a fresh workbook automatically from the package
652
- </span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Pacakge</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span>
653
- <span class='comment'># # set the workbook after creating the package
654
- </span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span></pre>
740
+ <span class="ruby-comment"># get a fresh workbook automatically from the package</span>
741
+ <span class="ruby-identifier">wb</span> = <span class="ruby-constant">Pacakge</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span>
742
+ <span class="ruby-comment"># # set the workbook after creating the package</span>
743
+ <span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span> = <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>
744
+ </pre>
655
745
  </div>
656
746
  </div>
657
747
 
@@ -663,6 +753,19 @@ are a few examples:</p>
663
753
  </div>
664
754
  <div class="tags">
665
755
 
756
+ <h3>Yields:</h3>
757
+ <ul class="yield">
758
+
759
+ <li>
760
+
761
+
762
+ <span class='type'>(<tt>@workbook</tt>)</span>
763
+
764
+
765
+
766
+ </li>
767
+
768
+ </ul>
666
769
  <h3>Returns:</h3>
667
770
  <ul class="return">
668
771
 
@@ -707,16 +810,21 @@ instance is returned.</p>
707
810
  <pre class="lines">
708
811
 
709
812
 
710
- 32
711
- 33
712
- 34</pre>
813
+ 37
814
+ 38
815
+ 39
816
+ 40
817
+ 41</pre>
713
818
  </td>
714
819
  <td>
715
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 32</span>
820
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span>
716
821
 
717
- <span class='kw'>def</span> <span class='id workbook'>workbook</span>
718
- <span class='ivar'>@workbook</span> <span class='op'>||</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span>
719
- <span class='kw'>end</span></pre>
822
+ <span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span>
823
+ <span class='@workbook ivar id'>@workbook</span> <span class='orop op'>||</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
824
+ <span class='yield yield kw'>yield</span> <span class='@workbook ivar id'>@workbook</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
825
+ <span class='@workbook ivar id'>@workbook</span>
826
+ <span class='end end kw'>end</span>
827
+ </pre>
720
828
  </td>
721
829
  </tr>
722
830
  </table>
@@ -751,12 +859,13 @@ instance is returned.</p>
751
859
  <pre class="lines">
752
860
 
753
861
 
754
- 37</pre>
862
+ 44</pre>
755
863
  </td>
756
864
  <td>
757
- <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span>
865
+ <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 44</span>
758
866
 
759
- <span class='kw'>def</span> <span class='id workbook='>workbook=</span><span class='lparen'>(</span><span class='id workbook'>workbook</span><span class='rparen'>)</span> <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Package.workbook</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='const'>Workbook</span><span class='comma'>,</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
867
+ <span class='def def kw'>def</span> <span class='workbook= identifier id'>workbook=</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='rparen token'>)</span> <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>&quot;Package.workbook&quot;</span><span class='comma token'>,</span> <span class='Workbook constant id'>Workbook</span><span class='comma token'>,</span> <span class='workbook identifier id'>workbook</span><span class='semicolon token'>;</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='workbook identifier id'>workbook</span> <span class='end end kw'>end</span>
868
+ </pre>
760
869
  </td>
761
870
  </tr>
762
871
  </table>
@@ -767,9 +876,9 @@ instance is returned.</p>
767
876
  </div>
768
877
 
769
878
  <div id="footer">
770
- Generated on Sat Nov 26 13:16:36 2011 by
879
+ Generated on Wed Nov 30 08:53:51 2011 by
771
880
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
772
- 0.7.3 (ruby-1.9.3).
881
+ 0.7.3 (ruby-1.8.7).
773
882
  </div>
774
883
 
775
884
  </body>