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
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
|
require 'test_helper'
context 'Document' do
context 'Example document' do
test 'document title' do
doc = example_document(:asciidoc_index)
assert_equal 'AsciiDoc Home Page', doc.doctitle
assert_equal 'AsciiDoc Home Page', doc.name
assert_equal 14, doc.blocks.size
assert_equal :preamble, doc.blocks[0].context
assert doc.blocks[1].is_a? ::Asciidoctor::Section
end
end
context 'Default settings' do
test 'safe mode level set to SECURE by default' do
doc = Asciidoctor::Document.new
assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
end
test 'safe mode level set using string' do
doc = Asciidoctor::Document.new [], :safe => 'server'
assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
doc = Asciidoctor::Document.new [], :safe => 'foo'
assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
end
test 'safe mode level set using symbol' do
doc = Asciidoctor::Document.new [], :safe => :server
assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
doc = Asciidoctor::Document.new [], :safe => :foo
assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
end
test 'safe mode level set using integer' do
doc = Asciidoctor::Document.new [], :safe => 10
assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
doc = Asciidoctor::Document.new [], :safe => 100
assert_equal 100, doc.safe
end
test 'safe mode attributes are set on document' do
doc = Asciidoctor::Document.new
assert_equal Asciidoctor::SafeMode::SECURE, doc.attr('safe-mode-level')
assert_equal 'secure', doc.attr('safe-mode-name')
assert doc.attr?('safe-mode-secure')
assert !doc.attr?('safe-mode-unsafe')
assert !doc.attr?('safe-mode-safe')
assert !doc.attr?('safe-mode-server')
end
test 'safe mode level can be set in the constructor' do
doc = Asciidoctor::Document.new [], :safe => Asciidoctor::SafeMode::SAFE
assert_equal Asciidoctor::SafeMode::SAFE, doc.safe
end
test 'safe model level cannot be modified' do
doc = Asciidoctor::Document.new
begin
doc.safe = Asciidoctor::SafeMode::UNSAFE
flunk 'safe mode property of Asciidoctor::Document should not be writable!'
rescue
end
end
test 'toc and numbered should be enabled by default for DocBook backend' do
doc = Asciidoctor::Document.new [], :backend => 'docbook'
assert doc.attr?('toc')
assert doc.attr?('numbered')
end
test 'should be able to disable toc and numbered in document header for DocBook backend' do
input = <<-EOS
= Document Title
:toc!:
:numbered!:
EOS
doc = document_from_string input, :backend => 'docbook'
assert !doc.attr?('toc')
assert !doc.attr?('numbered')
end
end
context 'Load APIs' do
test 'should load input file' do
sample_input_path = fixture_path('sample.asciidoc')
doc = Asciidoctor.load(File.new(sample_input_path), :safe => Asciidoctor::SafeMode::SAFE)
assert_equal 'Document Title', doc.doctitle
assert_equal File.expand_path(sample_input_path), doc.attr('docfile')
assert_equal File.expand_path(File.dirname(sample_input_path)), doc.attr('docdir')
end
test 'should load input file from filename' do
sample_input_path = fixture_path('sample.asciidoc')
doc = Asciidoctor.load_file(sample_input_path, :safe => Asciidoctor::SafeMode::SAFE)
assert_equal 'Document Title', doc.doctitle
assert_equal File.expand_path(sample_input_path), doc.attr('docfile')
assert_equal File.expand_path(File.dirname(sample_input_path)), doc.attr('docdir')
end
test 'should load input IO' do
input = StringIO.new(<<-EOS)
Document Title
==============
preamble
EOS
doc = Asciidoctor.load(input, :safe => Asciidoctor::SafeMode::SAFE)
assert_equal 'Document Title', doc.doctitle
assert !doc.attr?('docfile')
assert_equal doc.base_dir, doc.attr('docdir')
end
test 'should load input string' do
input = <<-EOS
Document Title
==============
preamble
EOS
doc = Asciidoctor.load(input, :safe => Asciidoctor::SafeMode::SAFE)
assert_equal 'Document Title', doc.doctitle
assert !doc.attr?('docfile')
assert_equal doc.base_dir, doc.attr('docdir')
end
test 'should load input string array' do
input = <<-EOS
Document Title
==============
preamble
EOS
doc = Asciidoctor.load(input.lines.entries, :safe => Asciidoctor::SafeMode::SAFE)
assert_equal 'Document Title', doc.doctitle
assert !doc.attr?('docfile')
assert_equal doc.base_dir, doc.attr('docdir')
end
test 'should accept attributes as array' do
# NOTE there's a tab character before idseparator
doc = Asciidoctor.load('text', :attributes => %w(toc numbered source-highlighter=coderay idprefix idseparator=-))
assert doc.attributes.is_a?(Hash)
assert doc.attr?('toc')
assert_equal '', doc.attr('toc')
assert doc.attr?('numbered')
assert_equal '', doc.attr('numbered')
assert doc.attr?('source-highlighter')
assert_equal 'coderay', doc.attr('source-highlighter')
assert doc.attr?('idprefix')
assert_equal '', doc.attr('idprefix')
assert doc.attr?('idseparator')
assert_equal '-', doc.attr('idseparator')
end
test 'should accept attributes as empty array' do
doc = Asciidoctor.load('text', :attributes => [])
assert doc.attributes.is_a?(Hash)
end
test 'should accept attributes as string' do
# NOTE there's a tab character before idseparator
doc = Asciidoctor.load('text', :attributes => 'toc numbered source-highlighter=coderay idprefix idseparator=-')
assert doc.attributes.is_a?(Hash)
assert doc.attr?('toc')
assert_equal '', doc.attr('toc')
assert doc.attr?('numbered')
assert_equal '', doc.attr('numbered')
assert doc.attr?('source-highlighter')
assert_equal 'coderay', doc.attr('source-highlighter')
assert doc.attr?('idprefix')
assert_equal '', doc.attr('idprefix')
assert doc.attr?('idseparator')
assert_equal '-', doc.attr('idseparator')
end
test 'should accept values containing spaces in attributes string' do
# NOTE there's a tab character before self:
doc = Asciidoctor.load('text', :attributes => 'idprefix idseparator=- note-caption=Note\ to\ self: toc')
assert doc.attributes.is_a?(Hash)
assert doc.attr?('idprefix')
assert_equal '', doc.attr('idprefix')
assert doc.attr?('idseparator')
assert_equal '-', doc.attr('idseparator')
assert doc.attr?('note-caption')
assert_equal "Note to self:", doc.attr('note-caption')
end
test 'should accept attributes as empty string' do
doc = Asciidoctor.load('text', :attributes => '')
assert doc.attributes.is_a?(Hash)
end
test 'should accept attributes as nil' do
doc = Asciidoctor.load('text', :attributes => nil)
assert doc.attributes.is_a?(Hash)
end
test 'should accept attributes if hash like' do
class Hashish
def initialize
@table = {'toc' => ''}
end
def keys
@table.keys
end
def [](key)
@table[key]
end
end
doc = Asciidoctor.load('text', :attributes => Hashish.new)
assert doc.attributes.is_a?(Hash)
assert doc.attributes.has_key?('toc')
end
end
context 'Render APIs' do
test 'should render document to string' do
sample_input_path = fixture_path('sample.asciidoc')
output = Asciidoctor.render_file(sample_input_path, :header_footer => true)
assert !output.empty?
assert_xpath '/html', output, 1
assert_xpath '/html/head', output, 1
assert_xpath '/html/body', output, 1
assert_xpath '/html/head/title[text() = "Document Title"]', output, 1
assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
end
test 'should accept attributes as array' do
sample_input_path = fixture_path('sample.asciidoc')
output = Asciidoctor.render_file(sample_input_path, :attributes => %w(numbered idprefix idseparator=-))
assert_css '#section-a', output, 1
end
test 'should accept attributes as string' do
sample_input_path = fixture_path('sample.asciidoc')
output = Asciidoctor.render_file(sample_input_path, :attributes => 'numbered idprefix idseparator=-')
assert_css '#section-a', output, 1
end
test 'should link to default stylesheet by default when safe mode is SECURE or greater' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path, :header_footer => true)
assert_css 'html:root > head > link[rel="stylesheet"][href="./asciidoctor.css"]', output, 1
end
test 'should embed default stylesheet by default if SafeMode is less than SECURE' do
input = <<-EOS
= Document Title
text
EOS
output = Asciidoctor.render(input, :safe => Asciidoctor::SafeMode::SERVER, :header_footer => true)
assert_css 'html:root > head > link[rel="stylesheet"][href="./asciidoctor.css"]', output, 0
stylenode = xmlnodes_at_css 'html:root > head > style', output, 1
styles = stylenode.first.content
assert !styles.nil?
assert !styles.strip.empty?
end
test 'should link to default stylesheet by default if linkcss is unset in document' do
input = <<-EOS
= Document Title
:linkcss!:
text
EOS
output = Asciidoctor.render(input, :header_footer => true)
assert_css 'html:root > head > link[rel="stylesheet"][href="./asciidoctor.css"]', output, 1
end
test 'should link to default stylesheet by default if linkcss is unset' do
input = <<-EOS
= Document Title
text
EOS
output = Asciidoctor.render(input, :header_footer => true, :attributes => {'linkcss!' => ''})
assert_css 'html:root > head > link[rel="stylesheet"][href="./asciidoctor.css"]', output, 1
end
test 'should embed default stylesheet if safe mode is less than secure and linkcss is unset' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path, :header_footer => true,
:safe => Asciidoctor::SafeMode::SAFE, :attributes => {'linkcss!' => ''})
assert_css 'html:root > head > style', output, 1
stylenode = xmlnodes_at_css 'html:root > head > style', output, 1
styles = stylenode.first.content
assert !styles.nil?
assert !styles.strip.empty?
end
test 'should not link to stylesheet if stylesheet is unset' do
input = <<-EOS
= Document Title
text
EOS
output = Asciidoctor.render(input, :header_footer => true, :attributes => {'stylesheet!' => ''})
assert_css 'html:root > head > link[rel="stylesheet"]', output, 0
end
test 'should link to custom stylesheet if specified in stylesheet attribute' do
input = <<-EOS
= Document Title
text
EOS
output = Asciidoctor.render(input, :header_footer => true, :attributes => {'stylesheet' => './custom.css'})
assert_css 'html:root > head > link[rel="stylesheet"][href="./custom.css"]', output, 1
end
test 'should resolve custom stylesheet relative to stylesdir' do
input = <<-EOS
= Document Title
text
EOS
output = Asciidoctor.render(input, :header_footer => true, :attributes => {'stylesheet' => 'custom.css', 'stylesdir' => './stylesheets'})
assert_css 'html:root > head > link[rel="stylesheet"][href="./stylesheets/custom.css"]', output, 1
end
test 'should resolve custom stylesheet to embed relative to stylesdir' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path, :header_footer => true, :safe => Asciidoctor::SafeMode::SAFE,
:attributes => {'stylesheet' => 'custom.css', 'stylesdir' => './stylesheets', 'linkcss!' => ''})
stylenode = xmlnodes_at_css 'html:root > head > style', output, 1
styles = stylenode.first.content
assert !styles.nil?
assert !styles.strip.empty?
end
test 'should render document in place' do
sample_input_path = fixture_path('sample.asciidoc')
sample_output_path = fixture_path('sample.html')
begin
Asciidoctor.render_file(sample_input_path, :in_place => true)
assert File.exist?(sample_output_path)
output = File.read(sample_output_path)
assert !output.empty?
assert_xpath '/html', output, 1
assert_xpath '/html/head', output, 1
assert_xpath '/html/body', output, 1
assert_xpath '/html/head/title[text() = "Document Title"]', output, 1
assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
ensure
FileUtils::rm(sample_output_path)
end
end
test 'should render document to file' do
sample_input_path = fixture_path('sample.asciidoc')
sample_output_path = fixture_path('result.html')
begin
Asciidoctor.render_file(sample_input_path, :to_file => sample_output_path)
assert File.exist?(sample_output_path)
output = File.read(sample_output_path)
assert !output.empty?
assert_xpath '/html', output, 1
assert_xpath '/html/head', output, 1
assert_xpath '/html/body', output, 1
assert_xpath '/html/head/title[text() = "Document Title"]', output, 1
assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
ensure
FileUtils::rm(sample_output_path)
end
end
test 'should render document to file when base dir is set' do
sample_input_path = fixture_path('sample.asciidoc')
sample_output_path = fixture_path('result.html')
fixture_dir = fixture_path('')
begin
Asciidoctor.render_file(sample_input_path, :to_file => 'result.html', :base_dir => fixture_dir)
assert File.exist?(sample_output_path)
output = File.read(sample_output_path)
assert !output.empty?
assert_xpath '/html', output, 1
assert_xpath '/html/head', output, 1
assert_xpath '/html/body', output, 1
assert_xpath '/html/head/title[text() = "Document Title"]', output, 1
assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
rescue => e
flunk e.message
ensure
FileUtils::rm(sample_output_path, :force => true)
end
end
test 'in_place option must not be used with to_file option' do
sample_input_path = fixture_path('sample.asciidoc')
sample_output_path = fixture_path('result.html')
assert_raise ArgumentError do
begin
Asciidoctor.render_file(sample_input_path, :to_file => sample_output_path, :in_place => true)
ensure
FileUtils::rm(sample_output_path) if File.exists? sample_output_path
end
end
end
test 'in_place option must not be used with to_dir option' do
sample_input_path = fixture_path('sample.asciidoc')
sample_output_path = fixture_path('result.html')
assert_raise ArgumentError do
begin
Asciidoctor.render_file(sample_input_path, :to_dir => '', :in_place => true)
ensure
FileUtils::rm(sample_output_path) if File.exists? sample_output_path
end
end
end
test 'output should be relative to to_dir option' do
sample_input_path = fixture_path('sample.asciidoc')
output_dir = File.join(File.dirname(sample_input_path), 'test_output')
Dir.mkdir output_dir if !File.exists? output_dir
sample_output_path = File.join(output_dir, 'sample.html')
begin
Asciidoctor.render_file(sample_input_path, :to_dir => output_dir)
assert File.exists? sample_output_path
ensure
FileUtils::rm(sample_output_path) if File.exists? sample_output_path
FileUtils::rmdir output_dir
end
end
test 'missing directories should be created if mkdirs is enabled' do
sample_input_path = fixture_path('sample.asciidoc')
output_dir = File.join(File.join(File.dirname(sample_input_path), 'test_output'), 'subdir')
sample_output_path = File.join(output_dir, 'sample.html')
begin
Asciidoctor.render_file(sample_input_path, :to_dir => output_dir, :mkdirs => true)
assert File.exists? sample_output_path
ensure
FileUtils::rm(sample_output_path) if File.exists? sample_output_path
FileUtils::rmdir output_dir
FileUtils::rmdir File.dirname(output_dir)
end
end
test 'to_file should be relative to to_dir when both given' do
sample_input_path = fixture_path('sample.asciidoc')
base_dir = File.dirname(sample_input_path)
sample_rel_output_path = File.join('test_output', 'result.html')
output_dir = File.dirname(File.join(base_dir, sample_rel_output_path))
Dir.mkdir output_dir if !File.exists? output_dir
sample_output_path = File.join(base_dir, sample_rel_output_path)
begin
Asciidoctor.render_file(sample_input_path, :to_dir => base_dir, :to_file => sample_rel_output_path)
assert File.exists? sample_output_path
ensure
FileUtils::rm(sample_output_path) if File.exists? sample_output_path
FileUtils::rmdir output_dir
end
end
end
context 'Docinfo files' do
test 'should include docinfo files for html backend' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo' => ''})
assert !output.empty?
assert_css 'script[src="modernizr.js"]', output, 1
assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo1' => ''})
assert !output.empty?
assert_css 'script[src="modernizr.js"]', output, 0
assert_css 'meta[http-equiv="imagetoolbar"]', output, 1
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo2' => ''})
assert !output.empty?
assert_css 'script[src="modernizr.js"]', output, 1
assert_css 'meta[http-equiv="imagetoolbar"]', output, 1
end
test 'should include docinfo files for docbook backend' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo' => ''})
assert !output.empty?
assert_css 'productname', output, 0
assert_css 'copyright', output, 1
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo1' => ''})
assert !output.empty?
assert_css 'productname', output, 1
assert_css 'edition', output, 1
assert_xpath '//xmlns:edition[text()="1.0"]', output, 1 # verifies substitutions are performed
assert_css 'copyright', output, 0
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo2' => ''})
assert !output.empty?
assert_css 'productname', output, 1
assert_css 'edition', output, 1
assert_xpath '//xmlns:edition[text()="1.0"]', output, 1 # verifies substitutions are performed
assert_css 'copyright', output, 1
end
test 'should include docinfo footer files for html backend' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo' => ''})
assert !output.empty?
assert_css 'body script', output, 1
assert_css 'a#top', output, 0
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo1' => ''})
assert !output.empty?
assert_css 'body script', output, 0
assert_css 'a#top', output, 1
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo2' => ''})
assert !output.empty?
assert_css 'body script', output, 1
assert_css 'a#top', output, 1
end
test 'should include docinfo footer files for docbook backend' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo' => ''})
assert !output.empty?
assert_css 'article > revhistory', output, 1
assert_xpath '/xmlns:article/xmlns:revhistory/xmlns:revision/xmlns:revnumber[text()="1.0"]', output, 1 # verifies substitutions are performed
assert_css 'glossary#_glossary', output, 0
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo1' => ''})
assert !output.empty?
assert_css 'article > revhistory', output, 0
assert_css 'glossary#_glossary', output, 1
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo2' => ''})
assert !output.empty?
assert_css 'article > revhistory', output, 1
assert_xpath '/xmlns:article/xmlns:revhistory/xmlns:revision/xmlns:revnumber[text()="1.0"]', output, 1 # verifies substitutions are performed
assert_css 'glossary#_glossary', output, 1
end
test 'should not include docinfo files by default' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :safe => Asciidoctor::SafeMode::SERVER)
assert !output.empty?
assert_css 'script[src="modernizr.js"]', output, 0
assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER)
assert !output.empty?
assert_css 'productname', output, 0
assert_css 'copyright', output, 0
end
test 'should not include docinfo files if safe mode is SECURE or greater' do
sample_input_path = fixture_path('basic.asciidoc')
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :attributes => {'docinfo2' => ''})
assert !output.empty?
assert_css 'script[src="modernizr.js"]', output, 0
assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
output = Asciidoctor.render_file(sample_input_path,
:header_footer => true, :backend => 'docbook', :attributes => {'docinfo2' => ''})
assert !output.empty?
assert_css 'productname', output, 0
assert_css 'copyright', output, 0
end
end
context 'Renderer' do
test 'built-in HTML5 views are registered by default' do
doc = document_from_string ''
assert_equal 'html5', doc.attributes['backend']
assert doc.attributes.has_key? 'backend-html5'
assert_equal 'html', doc.attributes['basebackend']
assert doc.attributes.has_key? 'basebackend-html'
renderer = doc.renderer
assert !renderer.nil?
views = renderer.views
assert !views.nil?
assert_equal 36, views.size
assert views.has_key? 'document'
assert Asciidoctor.const_defined?(:HTML5)
assert Asciidoctor::HTML5.const_defined?(:DocumentTemplate)
end
test 'built-in DocBook45 views are registered when backend is docbook45' do
doc = document_from_string '', :attributes => {'backend' => 'docbook45'}
renderer = doc.renderer
assert_equal 'docbook45', doc.attributes['backend']
assert doc.attributes.has_key? 'backend-docbook45'
assert_equal 'docbook', doc.attributes['basebackend']
assert doc.attributes.has_key? 'basebackend-docbook'
assert !renderer.nil?
views = renderer.views
assert !views.nil?
assert_equal 36, views.size
assert views.has_key? 'document'
assert Asciidoctor.const_defined?(:DocBook45)
assert Asciidoctor::DocBook45.const_defined?(:DocumentTemplate)
end
test 'built-in DocBook5 views are registered when backend is docbook5' do
doc = document_from_string '', :attributes => {'backend' => 'docbook5'}
renderer = doc.renderer
assert_equal 'docbook5', doc.attributes['backend']
assert doc.attributes.has_key? 'backend-docbook5'
assert_equal 'docbook', doc.attributes['basebackend']
assert doc.attributes.has_key? 'basebackend-docbook'
assert !renderer.nil?
views = renderer.views
assert !views.nil?
assert_equal 36, views.size
assert views.has_key? 'document'
assert Asciidoctor.const_defined?(:DocBook5)
assert Asciidoctor::DocBook5.const_defined?(:DocumentTemplate)
end
test 'eRuby implementation should default to ERB' do
# intentionally use built-in templates for this test
doc = Asciidoctor::Document.new [], :header_footer => true
renderer = doc.renderer
views = renderer.views
assert !views.nil?
assert views.has_key? 'document'
assert views['document'].is_a?(Asciidoctor::HTML5::DocumentTemplate)
assert_equal 'ERB', views['document'].eruby.to_s
assert_equal 'ERB', views['document'].template.class.to_s
end
test 'can set erubis as eRuby implementation' do
# intentionally use built-in templates for this test
doc = Asciidoctor::Document.new [], :eruby => 'erubis', :header_footer => true
assert $LOADED_FEATURES.detect {|p| p == 'erubis.rb' || p.end_with?('/erubis.rb') }.nil?
renderer = doc.renderer
assert $LOADED_FEATURES.detect {|p| p == 'erubis.rb' || p.end_with?('/erubis.rb') }
views = renderer.views
assert !views.nil?
assert views.has_key? 'document'
assert views['document'].is_a?(Asciidoctor::HTML5::DocumentTemplate)
assert_equal 'Erubis::FastEruby', views['document'].eruby.to_s
assert_equal 'Erubis::FastEruby', views['document'].template.class.to_s
end
end
context 'Structure' do
test 'document with no doctitle' do
doc = document_from_string('Snorf')
assert_nil doc.doctitle
assert_nil doc.name
assert !doc.has_header?
assert_nil doc.header
end
test 'document with doctitle defined as attribute entry' do
input = <<-EOS
:doctitle: Document Title
preamble
== First Section
EOS
doc = document_from_string input
assert_equal 'Document Title', doc.doctitle
assert doc.has_header?
assert_equal 'Document Title', doc.header.title
assert_equal 'Document Title', doc.first_section.title
end
test 'document with title attribute entry overrides doctitle' do
input = <<-EOS
= Document Title
:title: Override
{doctitle}
== First Section
EOS
doc = document_from_string input
assert_equal 'Override', doc.doctitle
assert_equal 'Override', doc.title
assert doc.has_header?
assert_equal 'Document Title', doc.header.title
assert_equal 'Document Title', doc.first_section.title
assert_xpath '//*[@id="preamble"]//p[text()="Document Title"]', doc.render, 1
end
test 'document with title attribute entry overrides doctitle attribute entry' do
input = <<-EOS
= Document Title
:snapshot: {doctitle}
:doctitle: doctitle
:title: Override
{snapshot}, {doctitle}
== First Section
EOS
doc = document_from_string input
assert_equal 'Override', doc.doctitle
assert_equal 'Override', doc.title
assert doc.has_header?
assert_equal 'doctitle', doc.header.title
assert_equal 'doctitle', doc.first_section.title
assert_xpath '//*[@id="preamble"]//p[text()="Document Title, doctitle"]', doc.render, 1
end
test 'document with doctitle attribute entry overrides header title and doctitle' do
input = <<-EOS
= Document Title
:snapshot: {doctitle}
:doctitle: Override
{snapshot}, {doctitle}
== First Section
EOS
doc = document_from_string input
assert_equal 'Override', doc.doctitle
assert_nil doc.title
assert doc.has_header?
assert_equal 'Override', doc.header.title
assert_equal 'Override', doc.first_section.title
assert_xpath '//*[@id="preamble"]//p[text()="Document Title, Override"]', doc.render, 1
end
test 'doctitle attribute entry above header overrides header title and doctitle' do
input = <<-EOS
:doctitle: Override
= Document Title
{doctitle}
== First Section
EOS
doc = document_from_string input
assert_equal 'Override', doc.doctitle
assert_nil doc.title
assert doc.has_header?
assert_equal 'Override', doc.header.title
assert_equal 'Override', doc.first_section.title
assert_xpath '//*[@id="preamble"]//p[text()="Override"]', doc.render, 1
end
test 'should recognize document title when preceded by blank lines' do
input = <<-EOS
:doctype: book
= Title
preamble
== Section 1
text
EOS
output = render_string input, :safe => Asciidoctor::SafeMode::SAFE
assert_css '#header h1', output, 1
assert_css '#content h1', output, 0
end
test 'should sanitize contents of HTML title element' do
input = <<-EOS
= *Document* image:logo.png[] _Title_ image:another-logo.png[]
content
EOS
output = render_string input
assert_xpath '/html/head/title[text()="Document Title"]', output, 1
nodes = xmlnodes_at_xpath('//*[@id="header"]/h1', output, 1)
assert_equal 1, nodes.size
assert_match(/<h1><strong>Document<\/strong> <span class="image"><img src="logo.png" alt="logo"><\/span> <em>Title<\/em> <span class="image"><img src="another-logo.png" alt="another-logo"><\/span><\/h1>/, output)
end
test 'should not choke on empty source' do
doc = Asciidoctor::Document.new ''
assert doc.blocks.empty?
assert_nil doc.doctitle
assert !doc.has_header?
assert_nil doc.header
end
test 'should not choke on nil source' do
doc = Asciidoctor::Document.new nil
assert doc.blocks.empty?
assert_nil doc.doctitle
assert !doc.has_header?
assert_nil doc.header
end
test 'with metadata' do
input = <<-EOS
= AsciiDoc
Stuart Rackham <founder@asciidoc.org>
v8.6.8, 2012-07-12: See changelog.
== Version 8.6.8
more info...
EOS
output = render_string input
assert_xpath '//*[@id="header"]/span[@id="author"][text() = "Stuart Rackham"]', output, 1
assert_xpath '//*[@id="header"]/span[@id="email"]/a[@href="mailto:founder@asciidoc.org"][text() = "founder@asciidoc.org"]', output, 1
assert_xpath '//*[@id="header"]/span[@id="revnumber"][text() = "version 8.6.8,"]', output, 1
assert_xpath '//*[@id="header"]/span[@id="revdate"][text() = "2012-07-12"]', output, 1
assert_xpath '//*[@id="header"]/span[@id="revremark"][text() = "See changelog."]', output, 1
end
test 'with metadata to DocBook45' do
input = <<-EOS
= AsciiDoc
Stuart Rackham <founder@asciidoc.org>
v8.6.8, 2012-07-12: See changelog.
== Version 8.6.8
more info...
EOS
output = render_string input, :backend => 'docbook'
assert_xpath '/article/articleinfo', output, 1
assert_xpath '/article/articleinfo/title[text() = "AsciiDoc"]', output, 1
assert_xpath '/article/articleinfo/date[text() = "2012-07-12"]', output, 1
assert_xpath '/article/articleinfo/author/firstname[text() = "Stuart"]', output, 1
assert_xpath '/article/articleinfo/author/surname[text() = "Rackham"]', output, 1
assert_xpath '/article/articleinfo/author/email[text() = "founder@asciidoc.org"]', output, 1
assert_xpath '/article/articleinfo/revhistory', output, 1
assert_xpath '/article/articleinfo/revhistory/revision', output, 1
assert_xpath '/article/articleinfo/revhistory/revision/revnumber[text() = "8.6.8"]', output, 1
assert_xpath '/article/articleinfo/revhistory/revision/date[text() = "2012-07-12"]', output, 1
assert_xpath '/article/articleinfo/revhistory/revision/authorinitials[text() = "SR"]', output, 1
assert_xpath '/article/articleinfo/revhistory/revision/revremark[text() = "See changelog."]', output, 1
end
test 'with metadata to DocBook5' do
input = <<-EOS
= AsciiDoc
Stuart Rackham <founder@asciidoc.org>
== Version 8.6.8
more info...
EOS
output = render_string input, :backend => 'docbook5'
assert_xpath '/article/info', output, 1
assert_xpath '/article/info/title[text() = "AsciiDoc"]', output, 1
assert_xpath '/article/info/author/personname', output, 1
assert_xpath '/article/info/author/personname/firstname[text() = "Stuart"]', output, 1
assert_xpath '/article/info/author/personname/surname[text() = "Rackham"]', output, 1
assert_xpath '/article/info/author/email[text() = "founder@asciidoc.org"]', output, 1
end
test 'with author defined using attribute entry to DocBook' do
input = <<-EOS
= Document Title
:author: Doc Writer
:email: thedoctor@asciidoc.org
content
EOS
output = render_string input, :backend => 'docbook'
assert_xpath '//articleinfo/author', output, 1
assert_xpath '//articleinfo/author/firstname[text() = "Doc"]', output, 1
assert_xpath '//articleinfo/author/surname[text() = "Writer"]', output, 1
assert_xpath '//articleinfo/author/email[text() = "thedoctor@asciidoc.org"]', output, 1
assert_xpath '//articleinfo/authorinitials[text() = "DW"]', output, 1
end
test 'should include multiple authors in HTML output' do
input = <<-EOS
= Document Title
Doc Writer <thedoctor@asciidoc.org>; Junior Writer <junior@asciidoctor.org>
content
EOS
output = render_string input
assert_xpath '//span[@id="author"]', output, 1
assert_xpath '//span[@id="author"][text()="Doc Writer"]', output, 1
assert_xpath '//span[@id="email"]', output, 1
assert_xpath '//span[@id="email"]/a', output, 1
assert_xpath '//span[@id="email"]/a[@href="mailto:thedoctor@asciidoc.org"][text()="thedoctor@asciidoc.org"]', output, 1
assert_xpath '//span[@id="author2"]', output, 1
assert_xpath '//span[@id="author2"][text()="Junior Writer"]', output, 1
assert_xpath '//span[@id="email2"]', output, 1
assert_xpath '//span[@id="email2"]/a', output, 1
assert_xpath '//span[@id="email2"]/a[@href="mailto:junior@asciidoctor.org"][text()="junior@asciidoctor.org"]', output, 1
end
test 'should create authorgroup in DocBook when multiple authors' do
input = <<-EOS
= Document Title
Doc Writer <thedoctor@asciidoc.org>; Junior Writer <junior@asciidoctor.org>
content
EOS
output = render_string input, :backend => 'docbook'
assert_xpath '//articleinfo/author', output, 0
assert_xpath '//articleinfo/authorgroup', output, 1
assert_xpath '//articleinfo/authorgroup/author', output, 2
assert_xpath '//articleinfo/authorgroup/author[1]/firstname[text() = "Doc"]', output, 1
assert_xpath '//articleinfo/authorgroup/author[2]/firstname[text() = "Junior"]', output, 1
end
test 'with authors defined using attribute entry to DocBook' do
input = <<-EOS
= Document Title
:authors: Doc Writer; Junior Writer
:email_1: thedoctor@asciidoc.org
:email_2: junior@asciidoc.org
content
EOS
output = render_string input, :backend => 'docbook'
assert_xpath '//articleinfo/author', output, 0
assert_xpath '//articleinfo/authorgroup', output, 1
assert_xpath '//articleinfo/authorgroup/author', output, 2
assert_xpath '(//articleinfo/authorgroup/author)[1]/firstname[text() = "Doc"]', output, 1
assert_xpath '(//articleinfo/authorgroup/author)[1]/email[text() = "thedoctor@asciidoc.org"]', output, 1
assert_xpath '(//articleinfo/authorgroup/author)[2]/firstname[text() = "Junior"]', output, 1
assert_xpath '(//articleinfo/authorgroup/author)[2]/email[text() = "junior@asciidoc.org"]', output, 1
end
test 'with header footer' do
doc = document_from_string "= Title\n\npreamble"
assert !doc.attr?('embedded')
result = doc.render
assert_xpath '/html', result, 1
assert_xpath '//*[@id="header"]', result, 1
assert_xpath '//*[@id="header"]/h1', result, 1
assert_xpath '//*[@id="footer"]', result, 1
assert_xpath '//*[@id="preamble"]', result, 1
end
test 'can disable last updated in footer' do
doc = document_from_string "= Document Title\n\npreamble", :attributes => {'last-update-label!' => ''}
result = doc.render
assert_xpath '//*[@id="footer-text"]', result, 1
assert_xpath '//*[@id="footer-text"][normalize-space(text())=""]', result, 1
end
test 'no header footer' do
doc = document_from_string "= Title\n\npreamble", :header_footer => false
assert doc.attr?('embedded')
result = doc.render
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 0
assert_xpath '/*[@id="header"]', result, 0
assert_xpath '/*[@id="footer"]', result, 0
assert_xpath '/*[@id="preamble"]', result, 1
end
test 'enable title in embedded document by unassigning notitle attribute' do
input = <<-EOS
= Document Title
content
EOS
result = render_string input, :header_footer => false, :attributes => {'notitle!' => ''}
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 1
assert_xpath '/*[@id="header"]', result, 0
assert_xpath '/*[@id="footer"]', result, 0
assert_xpath '/*[@id="preamble"]', result, 1
assert_xpath '(/*)[1]/self::h1', result, 1
assert_xpath '(/*)[2]/self::*[@id="preamble"]', result, 1
end
test 'enable title in embedded document by assigning showtitle attribute' do
input = <<-EOS
= Document Title
content
EOS
result = render_string input, :header_footer => false, :attributes => {'showtitle' => ''}
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 1
assert_xpath '/*[@id="header"]', result, 0
assert_xpath '/*[@id="footer"]', result, 0
assert_xpath '/*[@id="preamble"]', result, 1
assert_xpath '(/*)[1]/self::h1', result, 1
assert_xpath '(/*)[2]/self::*[@id="preamble"]', result, 1
end
test 'parse header only' do
input = <<-EOS
= Document Title
Author Name
:foo: bar
preamble
EOS
doc = document_from_string input, :parse_header_only => true
assert_equal 'Document Title', doc.doctitle
assert_equal 'Author Name', doc.author
assert_equal 'bar', doc.attributes['foo']
# there would be at least 1 block had it parsed beyond the header
assert_equal 0, doc.blocks.size
end
test 'renders footnotes in footer' do
input = <<-EOS
A footnote footnote:[An example footnote.];
a second footnote with a reference ID footnoteref:[note2,Second footnote.];
finally a reference to the second footnote footnoteref:[note2].
EOS
output = render_string input
assert_css '#footnotes', output, 1
assert_css '#footnotes .footnote', output, 2
assert_css '#footnotes .footnote#_footnote_1', output, 1
assert_xpath '//div[@id="footnotes"]/div[@id="_footnote_1"]/a[@href="#_footnoteref_1"][text()="1"]', output, 1
text = xmlnodes_at_xpath '//div[@id="footnotes"]/div[@id="_footnote_1"]/text()', output, 1
assert_equal '. An example footnote.', text.text.strip
assert_css '#footnotes .footnote#_footnote_2', output, 1
assert_xpath '//div[@id="footnotes"]/div[@id="_footnote_2"]/a[@href="#_footnoteref_2"][text()="2"]', output, 1
text = xmlnodes_at_xpath '//div[@id="footnotes"]/div[@id="_footnote_2"]/text()', output, 1
assert_equal '. Second footnote.', text.text.strip
end
test 'renders footnotes block in embedded document by default' do
input = <<-EOS
Text that has supporting information{empty}footnote:[An example footnote.].
EOS
output = render_string input, :header_footer => false
assert_css '#footnotes', output, 1
end
test 'does not render footnotes block in embedded document if nofootnotes attribute is set' do
input = <<-EOS
Text that has supporting information{empty}footnote:[An example footnote.].
EOS
output = render_string input, :header_footer => false, :attributes => {'nofootnotes' => ''}
assert_css '#footnotes', output, 0
end
end
context 'Backends and Doctypes' do
test 'html5 backend doctype article' do
result = render_string("= Title\n\npreamble", :attributes => {'backend' => 'html5'})
assert_xpath '/html', result, 1
assert_xpath '/html/body[@class="article"]', result, 1
assert_xpath '/html//*[@id="header"]/h1[text() = "Title"]', result, 1
assert_xpath '/html//*[@id="preamble"]//p[text() = "preamble"]', result, 1
end
test 'html5 backend doctype book' do
result = render_string("= Title\n\npreamble", :attributes => {'backend' => 'html5', 'doctype' => 'book'})
assert_xpath '/html', result, 1
assert_xpath '/html/body[@class="book"]', result, 1
assert_xpath '/html//*[@id="header"]/h1[text() = "Title"]', result, 1
assert_xpath '/html//*[@id="preamble"]//p[text() = "preamble"]', result, 1
end
test 'docbook45 backend doctype article' do
input = <<-EOS
= Title
preamble
== First Section
section body
EOS
result = render_string(input, :attributes => {'backend' => 'docbook45'})
assert_xpath '/article', result, 1
assert_xpath '/article/articleinfo/title[text() = "Title"]', result, 1
assert_xpath '/article/simpara[text() = "preamble"]', result, 1
assert_xpath '/article/section', result, 1
assert_xpath '/article/section[@id = "_first_section"]/title[text() = "First Section"]', result, 1
assert_xpath '/article/section[@id = "_first_section"]/simpara[text() = "section body"]', result, 1
end
test 'docbook45 backend doctype article no title' do
result = render_string('text', :attributes => {'backend' => 'docbook45'})
assert_xpath '/article', result, 1
assert_xpath '/article/articleinfo/date', result, 1
assert_xpath '/article/simpara[text() = "text"]', result, 1
end
test 'docbook45 backend doctype article no xmlns' do
result = render_string('text', :keep_namespaces => true, :attributes => {'backend' => 'docbook45', 'doctype' => 'article', 'noxmlns' => ''})
assert_no_match(RE_XMLNS_ATTRIBUTE, result)
end
test 'docbook45 backend doctype book' do
input = <<-EOS
= Title
preamble
== First Chapter
chapter body
EOS
result = render_string(input, :attributes => {'backend' => 'docbook45', 'doctype' => 'book'})
assert_xpath '/book', result, 1
assert_xpath '/book/bookinfo/title[text() = "Title"]', result, 1
assert_xpath '/book/preface/simpara[text() = "preamble"]', result, 1
assert_xpath '/book/chapter', result, 1
assert_xpath '/book/chapter[@id = "_first_chapter"]/title[text() = "First Chapter"]', result, 1
assert_xpath '/book/chapter[@id = "_first_chapter"]/simpara[text() = "chapter body"]', result, 1
end
test 'docbook45 backend doctype book no title' do
result = render_string('text', :attributes => {'backend' => 'docbook45', 'doctype' => 'book'})
assert_xpath '/book', result, 1
assert_xpath '/book/bookinfo/date', result, 1
assert_xpath '/book/simpara[text() = "text"]', result, 1
end
test 'docbook45 backend doctype book no xmlns' do
result = render_string('text', :keep_namespaces => true, :attributes => {'backend' => 'docbook45', 'doctype' => 'book', 'noxmlns' => ''})
assert_no_match(RE_XMLNS_ATTRIBUTE, result)
end
test 'docbook45 backend parses out subtitle' do
input = <<-EOS
= Document Title: Subtitle
:doctype: book
text
EOS
result = render_string input, :backend => 'docbook45'
assert_xpath '/book', result, 1
assert_xpath '/book/bookinfo/title[text() = "Document Title"]', result, 1
assert_xpath '/book/bookinfo/subtitle[text() = "Subtitle"]', result, 1
end
test 'docbook5 backend doctype article' do
input = <<-EOS
= Title
Author Name
preamble
== First Section
section body
EOS
result = render_string(input, :keep_namespaces => true, :attributes => {'backend' => 'docbook5'})
assert_xpath '/xmlns:article', result, 1
doc = xmlnodes_at_xpath('/xmlns:article', result, 1).first
assert_equal 'http://docbook.org/ns/docbook', doc.namespaces['xmlns']
assert_equal 'http://www.w3.org/1999/xlink', doc.namespaces['xmlns:xlink']
assert_xpath '/xmlns:article[@version="5.0"]', result, 1
assert_xpath '/xmlns:article/xmlns:info/xmlns:title[text() = "Title"]', result, 1
assert_xpath '/xmlns:article/xmlns:simpara[text() = "preamble"]', result, 1
assert_xpath '/xmlns:article/xmlns:section', result, 1
section = xmlnodes_at_xpath('/xmlns:article/xmlns:section', result, 1).first
# nokogiri can't make up its mind
id_attr = section.attribute('id') || section.attribute('xml:id')
assert_not_nil id_attr
assert_not_nil id_attr.namespace
assert_equal 'xml', id_attr.namespace.prefix
assert_equal '_first_section', id_attr.value
end
test 'docbook5 backend doctype book' do
input = <<-EOS
= Title
Author Name
preamble
== First Chapter
chapter body
EOS
result = render_string(input, :keep_namespaces => true, :attributes => {'backend' => 'docbook5', 'doctype' => 'book'})
assert_xpath '/xmlns:book', result, 1
doc = xmlnodes_at_xpath('/xmlns:book', result, 1).first
assert_equal 'http://docbook.org/ns/docbook', doc.namespaces['xmlns']
assert_equal 'http://www.w3.org/1999/xlink', doc.namespaces['xmlns:xlink']
assert_xpath '/xmlns:book[@version="5.0"]', result, 1
assert_xpath '/xmlns:book/xmlns:info/xmlns:title[text() = "Title"]', result, 1
assert_xpath '/xmlns:book/xmlns:preface/xmlns:simpara[text() = "preamble"]', result, 1
assert_xpath '/xmlns:book/xmlns:chapter', result, 1
chapter = xmlnodes_at_xpath('/xmlns:book/xmlns:chapter', result, 1).first
# nokogiri can't make up its mind
id_attr = chapter.attribute('id') || chapter.attribute('xml:id')
assert_not_nil id_attr
assert_not_nil id_attr.namespace
assert_equal 'xml', id_attr.namespace.prefix
assert_equal '_first_chapter', id_attr.value
end
test 'should be able to set backend using :backend option key' do
doc = Asciidoctor::Document.new([], :backend => 'html5')
assert_equal 'html5', doc.attributes['backend']
end
test ':backend option should override backend attribute' do
doc = Asciidoctor::Document.new([], :backend => 'html5', :attributes => {'backend' => 'docbook45'})
assert_equal 'html5', doc.attributes['backend']
end
test 'should be able to set doctype using :doctype option key' do
doc = Asciidoctor::Document.new([], :doctype => 'book')
assert_equal 'book', doc.attributes['doctype']
end
test ':doctype option should override doctype attribute' do
doc = Asciidoctor::Document.new([], :doctype => 'book', :attributes => {'doctype' => 'article'})
assert_equal 'book', doc.attributes['doctype']
end
test 'do not override explicit author initials' do
input = <<-EOS
= AsciiDoc
Stuart Rackham <founder@asciidoc.org>
:Author Initials: SJR
more info...
EOS
output = render_string input, :attributes => {'backend' => 'docbook45'}
assert_xpath '/article/articleinfo/authorinitials[text()="SJR"]', output, 1
end
test 'attribute entry can appear immediately after document title' do
input = <<-EOS
Reference Guide
===============
:toc:
preamble
EOS
doc = document_from_string input
assert doc.attr?('toc')
assert_equal '', doc.attr('toc')
end
test 'attribute entry can appear before author line under document title' do
input = <<-EOS
Reference Guide
===============
:toc:
Dan Allen
preamble
EOS
doc = document_from_string input
assert doc.attr?('toc')
assert_equal '', doc.attr('toc')
assert_equal 'Dan Allen', doc.attr('author')
end
test 'should parse mantitle and manvolnum from document title for manpage doctype' do
input = <<-EOS
= asciidoctor ( 1 )
:doctype: manpage
== NAME
asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
EOS
doc = document_from_string input
assert_equal 'asciidoctor', doc.attr('mantitle')
assert_equal '1', doc.attr('manvolnum')
end
test 'should perform attribute substitution on mantitle in manpage doctype' do
input = <<-EOS
= {app}(1)
:doctype: manpage
:app: asciidoctor
== NAME
asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
EOS
doc = document_from_string input
assert_equal 'asciidoctor', doc.attr('mantitle')
end
test 'should consume name section as manname and manpurpose for manpage doctype' do
input = <<-EOS
= asciidoctor(1)
:doctype: manpage
== NAME
asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
EOS
doc = document_from_string input
assert_equal 'asciidoctor', doc.attr('manname')
assert_equal 'converts AsciiDoc source files to HTML, DocBook and other formats', doc.attr('manpurpose')
assert_equal 0, doc.blocks.size
end
test 'should set docname and outfilesuffix from manname and manvolnum for manpage backend and doctype' do
input = <<-EOS
= asciidoctor(1)
:doctype: manpage
== NAME
asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
EOS
doc = document_from_string input, :backend => 'manpage'
assert_equal 'asciidoctor', doc.attributes['docname']
assert_equal '.1', doc.attributes['outfilesuffix']
end
test 'should mark synopsis as special section in manpage doctype' do
input = <<-EOS
= asciidoctor(1)
:doctype: manpage
== NAME
asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
== SYNOPSIS
*asciidoctor* ['OPTION']... 'FILE'..
EOS
doc = document_from_string input
synopsis_section = doc.blocks.first
assert_not_nil synopsis_section
assert_equal :section, synopsis_section.context
assert synopsis_section.special
assert_equal 'synopsis', synopsis_section.sectname
end
test 'should output special header block in HTML for manpage doctype' do
input = <<-EOS
= asciidoctor(1)
:doctype: manpage
== NAME
asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
== SYNOPSIS
*asciidoctor* ['OPTION']... 'FILE'..
EOS
output = render_string input
assert_css 'body.manpage', output, 1
assert_xpath '//body/*[@id="header"]/h1[text()="asciidoctor(1) Manual Page"]', output, 1
assert_xpath '//body/*[@id="header"]/h1/following-sibling::h2[text()="NAME"]', output, 1
assert_xpath '//h2[text()="NAME"]/following-sibling::*[@class="sectionbody"]', output, 1
assert_xpath '//h2[text()="NAME"]/following-sibling::*[@class="sectionbody"]/p[text()="asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats"]', output, 1
assert_xpath '//*[@id="content"]/*[@class="sect1"]/h2[text()="SYNOPSIS"]', output, 1
end
end
context 'Secure Asset Path' do
test 'allows us to specify a path relative to the current dir' do
doc = Asciidoctor::Document.new
legit_path = Dir.pwd + '/foo'
assert_equal legit_path, doc.normalize_asset_path(legit_path)
end
test 'keeps naughty absolute paths from getting outside' do
naughty_path = "#{disk_root}etc/passwd"
doc = Asciidoctor::Document.new
secure_path = doc.normalize_asset_path(naughty_path)
assert naughty_path != secure_path
assert_match(/^#{doc.base_dir}/, secure_path)
end
test 'keeps naughty relative paths from getting outside' do
naughty_path = 'safe/ok/../../../../../etc/passwd'
doc = Asciidoctor::Document.new
secure_path = doc.normalize_asset_path(naughty_path)
assert naughty_path != secure_path
assert_match(/^#{doc.base_dir}/, secure_path)
end
end
end
|