1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Axlsx::Package
— Documentation by YARD 0.7.3
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '..';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> »
<span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
»
<span class="title">Package</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Axlsx::Package
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Axlsx::Package</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/axlsx/package.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>
Package is responsible for managing all the bits and peices that Open
Office XML requires to make a valid xlsx document including valdation and
serialization.
</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
The workbook this package will serialize or validate.
</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#base_content_types-instance_method" title="#base_content_types (instance method)">- (ContentType) <strong>base_content_types</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Creates the minimum content types for generating a valid xlsx document.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#content_types-instance_method" title="#content_types (instance method)">- (ContentType) <strong>content_types</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Appends override objects for drawings, charts, and sheets as they exist in
your workbook to the default content types.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Package) <strong>initialize</strong>(options = {}) {|_self| ... }</a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>
Initializes your package.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parts-instance_method" title="#parts (instance method)">- (Array) <strong>parts</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
The parts of a package.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Creates the relationships required for a valid xlsx document.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#serialize-instance_method" title="#serialize (instance method)">- (Boolean) <strong>serialize</strong>(output, confirm_valid = false) </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Serialize your workbook to disk as an xlsx document.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#validate-instance_method" title="#validate (instance method)">- (Array) <strong>validate</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Validate all parts of the package against xsd schema.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#validate_single_doc-instance_method" title="#validate_single_doc (instance method)">- (Array) <strong>validate_single_doc</strong>(schema, doc) </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Performs xsd validation for a signle document.
</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<p class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Package</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... }
</p><div class="docstring">
<div class="discussion">
<p>
Initializes your package
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'><p>
Package.new :author => ‘you!’, :workbook => Workbook.new
</p>
</div></h4>
<pre class="example code">
</pre>
</div>
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>
A hash that you can use to specify the author and workbook for this
package.
</p>
</div>
</li>
</ul>
<h3>Options Hash (<tt>options</tt>):</h3>
<ul class="option">
<li>
<span class="name">:author</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>
The author of the document
</p>
</div>
</li>
</ul>
<h3>Yields:</h3>
<ul class="yield">
<li>
<span class='type'>(<tt>_self</tt>)</span>
</li>
</ul>
<h3>Yield Parameters:</h3>
<ul class="yieldparam">
<li>
<span class='name'>_self</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Axlsx::Package</a></span></tt>)</span>
—
<div class='inline'><p>
the object that the method was called on
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 28</span>
<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>
<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>
<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>
<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>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="workbook=-instance_method"></span>
<span id="workbook-instance_method"></span>
<div class="method_details first">
<p class="signature first" id="workbook-instance_method">
- (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong>
</p><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>
As there are multiple ways to instantiate a workbook for the package, here
are a few examples:
</p>
<pre class="code">
<span class='comment val'># assign directly during package instanciation</span>
<span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:workbook</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span>
<span class='comment val'># get a fresh workbook automatically from the package</span>
<span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Pacakge constant id'>Pacakge</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span>
<span class='comment val'># # set the workbook after creating the package</span>
<span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier 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>
</pre>
</div>
</div>
<p>
The workbook this package will serialize or validate.
</p>
</div>
</div>
<div class="tags">
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span>
—
<div class='inline'><p>
If no workbook instance has been assigned with this package a new Workbook
instance is returned.
</p>
</div>
</li>
</ul>
<h3>Raises:</h3>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>
ArgumentError if workbook parameter is not a Workbook instance.
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span>
<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span>
<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>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<p class="signature first" id="base_content_types-instance_method">
- (<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>) <strong>base_content_types</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Creates the minimum content types for generating a valid xlsx document.
</p>
</div>
</div>
<div class="tags">
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
156
157
158
159
160
161
162
163
164
165
166</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 156</span>
<span class='def def kw'>def</span> <span class='base_content_types identifier id'>base_content_types</span>
<span class='c_types identifier id'>c_types</span> <span class='assign token'>=</span> <span class='ContentType constant id'>ContentType</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Default constant id'>Default</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_CT constant id'>RELS_CT</span><span class='comma token'>,</span> <span class='symbol val'>:Extension</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_EX constant id'>RELS_EX</span><span class='rparen token'>)</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Default constant id'>Default</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:Extension</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_EX constant id'>XML_EX</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_CT constant id'>XML_CT</span><span class='rparen token'>)</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/#{APP_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_CT constant id'>APP_CT</span><span class='rparen token'>)</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/#{CORE_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_CT constant id'>CORE_CT</span><span class='rparen token'>)</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/xl/#{STYLES_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='STYLES_CT constant id'>STYLES_CT</span><span class='rparen token'>)</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/#{WORKBOOK_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKBOOK_CT constant id'>WORKBOOK_CT</span><span class='rparen token'>)</span>
<span class='c_types identifier id'>c_types</span><span class='dot token'>.</span><span class='lock identifier id'>lock</span>
<span class='c_types identifier id'>c_types</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="content_types-instance_method">
- (<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>) <strong>content_types</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Appends override objects for drawings, charts, and sheets as they exist in
your workbook to the default content types.
</p>
</div>
</div>
<div class="tags">
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 136</span>
<span class='def def kw'>def</span> <span class='content_types identifier id'>content_types</span>
<span class='c_types identifier id'>c_types</span> <span class='assign token'>=</span> <span class='base_content_types identifier id'>base_content_types</span>
<span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</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='drawing identifier id'>drawing</span><span class='bitor op'>|</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/xl/#{drawing.pn}"</span><span class='comma token'>,</span>
<span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='DRAWING_CT constant id'>DRAWING_CT</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
<span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</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='chart identifier id'>chart</span><span class='bitor op'>|</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/xl/#{chart.pn}"</span><span class='comma token'>,</span>
<span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CHART_CT constant id'>CHART_CT</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
<span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</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='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
<span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/xl/#{sheet.pn}"</span><span class='comma token'>,</span>
<span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKSHEET_CT constant id'>WORKSHEET_CT</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
<span class='c_types identifier id'>c_types</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="parts-instance_method">
- (<tt>Array</tt>) <strong>parts</strong>
</p><div class="docstring">
<div class="discussion">
<p>
The parts of a package
</p>
</div>
</div>
<div class="tags">
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>
An array of hashes that define the entry, document and schema for each part
of the package.
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 90</span>
<span class='def def kw'>def</span> <span class='parts identifier id'>parts</span>
<span class='@parts ivar id'>@parts</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span>
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_PN constant id'>RELS_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_PN constant id'>CORE_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_XSD constant id'>CORE_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_PN constant id'>APP_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@app ivar id'>@app</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_XSD constant id'>APP_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKBOOK_RELS_PN constant id'>WORKBOOK_RELS_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKBOOK_PN constant id'>WORKBOOK_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CONTENT_TYPES_PN constant id'>CONTENT_TYPES_PN</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='content_types identifier id'>content_types</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CONTENT_TYPES_XSD constant id'>CONTENT_TYPES_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span>
<span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{STYLES_PN}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span>
<span class='rbrack token'>]</span>
<span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</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='drawing identifier id'>drawing</span><span class='bitor op'>|</span>
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{drawing.rels_pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span>
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{drawing.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='DRAWING_XSD constant id'>DRAWING_XSD</span><span class='rbrace token'>}</span>
<span class='end end kw'>end</span>
<span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</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='chart identifier id'>chart</span><span class='bitor op'>|</span>
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{chart.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='DRAWING_XSD constant id'>DRAWING_XSD</span><span class='rbrace token'>}</span>
<span class='end end kw'>end</span>
<span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</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='sheet identifier id'>sheet</span><span class='bitor op'>|</span>
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{sheet.rels_pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span>
<span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{sheet.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span>
<span class='end end kw'>end</span>
<span class='@parts ivar id'>@parts</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="relationships-instance_method">
- (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Creates the relationships required for a valid xlsx document
</p>
</div>
</div>
<div class="tags">
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
171
172
173
174
175
176
177
178</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 171</span>
<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span>
<span class='rels identifier id'>rels</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
<span class='rels identifier id'>rels</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='WORKBOOK_R constant id'>WORKBOOK_R</span><span class='comma token'>,</span> <span class='WORKBOOK_PN constant id'>WORKBOOK_PN</span><span class='rparen token'>)</span>
<span class='rels identifier id'>rels</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='CORE_R constant id'>CORE_R</span><span class='comma token'>,</span> <span class='CORE_PN constant id'>CORE_PN</span><span class='rparen token'>)</span>
<span class='rels identifier id'>rels</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='APP_R constant id'>APP_R</span><span class='comma token'>,</span> <span class='APP_PN constant id'>APP_PN</span><span class='rparen token'>)</span>
<span class='rels identifier id'>rels</span><span class='dot token'>.</span><span class='lock identifier id'>lock</span>
<span class='rels identifier id'>rels</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="serialize-instance_method">
- (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false)
</p><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>
A tremendous amount of effort has gone into ensuring that you cannot create
invalid xlsx documents. confirm_valid should be used in the rare case that
you cannot open the serialized file.
</p>
</div>
</div>
<p>
Serialize your workbook to disk as an xlsx document.
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'></div></h4>
<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>
<span class='comment val'># Take a look at the README for an example of how to do it!</span>
<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>
<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>
<span class='comment val'># You will find a file called test.xlsx</span>
</pre>
</div>
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='name'>output</span>
<span class='type'>(<tt>File</tt>)</span>
—
<div class='inline'><p>
The file you want to serialize your package to
</p>
</div>
</li>
<li>
<span class='name'>confirm_valid</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>
Validate the package prior to serialization.
</p>
</div>
</li>
</ul>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>
False if confirm_valid and validation errors exist. True if the package was
serialized
</p>
</div>
</li>
</ul>
<h3>See Also:</h3>
<ul class="see">
<li><span class='object_link'><a href="#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 55</span>
<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>
<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>
<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='new identifier id'>new</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='string val'>"w"</span><span class='rparen token'>)</span>
<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='f identifier id'>f</span><span class='dot token'>.</span><span class='path identifier id'>path</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>
<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='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> <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> <span class='rbrace token'>}</span>
<span class='end end kw'>end</span>
<span class='true true kw'>true</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="validate-instance_method">
- (<tt>Array</tt>) <strong>validate</strong>
</p><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>
This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip
and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition.
opc schema require an internet connection to import remote schema from
dublin core for dc, dcterms and xml namespaces. Those remote schema are
included in this gem, and the original files have been altered to refer to
the local versions.
</p>
<p>
If by chance you are able to creat a package that does not validate it
indicates that the internal validation is not robust enough and needs to be
improved. Please report your errors to the gem author.
</p>
</div>
</div>
<p>
Validate all parts of the package against xsd schema.
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'></div></h4>
<pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span>
<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>
<span class='comment val'># ... code to create sheets, charts, styles etc.</span>
<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>
</pre>
</div>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>
An array of all validation errors found.
</p>
</div>
</li>
</ul>
<h3>See Also:</h3>
<ul class="see">
<li><a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm" target="_parent" title="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
79
80
81
82
83</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 79</span>
<span class='def def kw'>def</span> <span class='validate identifier id'>validate</span>
<span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<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='rbrace token'>}</span>
<span class='errors identifier id'>errors</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="validate_single_doc-instance_method">
- (<tt>Array</tt>) <strong>validate_single_doc</strong>(schema, doc)
</p><div class="docstring">
<div class="discussion">
<p>
Performs xsd validation for a signle document
</p>
</div>
</div>
<div class="tags">
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='name'>schema</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>
path to the xsd schema to be used in validation.
</p>
</div>
</li>
<li>
<span class='name'>doc</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>
The xml text to be validated
</p>
</div>
</li>
</ul>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>
An array of all validation errors encountered.
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
122
123
124
125
126
127
128
129
130
131</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 122</span>
<span class='def def kw'>def</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='schema identifier id'>schema</span><span class='comma token'>,</span> <span class='doc identifier id'>doc</span><span class='rparen token'>)</span>
<span class='schema identifier id'>schema</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Schema constant id'>Schema</span><span class='lparen 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='schema identifier id'>schema</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
<span class='doc identifier id'>doc</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='rparen token'>)</span>
<span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<span class='schema identifier id'>schema</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='rparen token'>)</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='error identifier id'>error</span><span class='bitor op'>|</span>
<span class='errors identifier id'>errors</span> <span class='lshft op'><<</span> <span class='error identifier id'>error</span>
<span class='end end kw'>end</span>
<span class='errors identifier id'>errors</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 21 19:45:36 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.3 (ruby-1.8.7).
</div>
</body>
</html>
|
