forked from asciidoctor/asciidoctor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathattributes_test.rb
1666 lines (1394 loc) · 51.2 KB
/
attributes_test.rb
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
# frozen_string_literal: true
require_relative 'test_helper'
context 'Attributes' do
default_logger = Asciidoctor::LoggerManager.logger
setup do
Asciidoctor::LoggerManager.logger = (@logger = Asciidoctor::MemoryLogger.new)
end
teardown do
Asciidoctor::LoggerManager.logger = default_logger
end
context 'Assignment' do
test 'creates an attribute' do
doc = document_from_string(':frog: Tanglefoot')
assert_equal 'Tanglefoot', doc.attributes['frog']
end
test 'requires a space after colon following attribute name' do
doc = document_from_string 'foo:bar'
assert_nil doc.attributes['foo']
end
# NOTE AsciiDoc Python recognizes this entry
test 'does not recognize attribute entry if name contains colon' do
input = ':foo:bar: baz'
doc = document_from_string input
refute doc.attr?('foo:bar')
assert_equal 1, doc.blocks.size
assert_equal :paragraph, doc.blocks[0].context
end
# NOTE AsciiDoc Python recognizes this entry
test 'does not recognize attribute entry if name ends with colon' do
input = ':foo:: bar'
doc = document_from_string input
refute doc.attr?('foo:')
assert_equal 1, doc.blocks.size
assert_equal :dlist, doc.blocks[0].context
end
# NOTE AsciiDoc Python does not recognize this entry
test 'allows any word character defined by Unicode in an attribute name' do
[['café', 'a coffee shop'], ['سمن', %(سازمان مردمنهاد)]].each do |(name, value)|
str = <<~EOS
:#{name}: #{value}
{#{name}}
EOS
result = convert_string_to_embedded str
assert_includes result, %(<p>#{value}</p>)
end
end
test 'creates an attribute by fusing a legacy multi-line value' do
str = <<~'EOS'
:description: This is the first +
Ruby implementation of +
AsciiDoc.
EOS
doc = document_from_string(str)
assert_equal 'This is the first Ruby implementation of AsciiDoc.', doc.attributes['description']
end
test 'creates an attribute by fusing a multi-line value' do
str = <<~'EOS'
:description: This is the first \
Ruby implementation of \
AsciiDoc.
EOS
doc = document_from_string(str)
assert_equal 'This is the first Ruby implementation of AsciiDoc.', doc.attributes['description']
end
test 'honors line break characters in multi-line values' do
str = <<~'EOS'
:signature: Linus Torvalds + \
Linux Hacker + \
EOS
doc = document_from_string(str)
assert_equal %(Linus Torvalds +\nLinux Hacker +\[email protected]), doc.attributes['signature']
end
test 'should allow pass macro to surround a multi-line value that contains line breaks' do
str = <<~'EOS'
:signature: pass:a[{author} + \
{title} + \
{email}]
EOS
doc = document_from_string str, attributes: { 'author' => 'Linus Torvalds', 'title' => 'Linux Hacker', 'email' => '[email protected]' }
assert_equal %(Linus Torvalds +\nLinux Hacker +\[email protected]), (doc.attr 'signature')
end
test 'should delete an attribute that ends with !' do
doc = document_from_string(":frog: Tanglefoot\n:frog!:")
assert_nil doc.attributes['frog']
end
test 'should delete an attribute that ends with ! set via API' do
doc = document_from_string(":frog: Tanglefoot", attributes: { 'frog!' => '' })
assert_nil doc.attributes['frog']
end
test 'should delete an attribute that begins with !' do
doc = document_from_string(":frog: Tanglefoot\n:!frog:")
assert_nil doc.attributes['frog']
end
test 'should delete an attribute that begins with ! set via API' do
doc = document_from_string(":frog: Tanglefoot", attributes: { '!frog' => '' })
assert_nil doc.attributes['frog']
end
test 'should delete an attribute set via API to nil value' do
doc = document_from_string(":frog: Tanglefoot", attributes: { 'frog' => nil })
assert_nil doc.attributes['frog']
end
test "doesn't choke when deleting a non-existing attribute" do
doc = document_from_string(':frog!:')
assert_nil doc.attributes['frog']
end
test "replaces special characters in attribute value" do
doc = document_from_string(":xml-busters: <>&")
assert_equal '<>&', doc.attributes['xml-busters']
end
test "performs attribute substitution on attribute value" do
doc = document_from_string(":version: 1.0\n:release: Asciidoctor {version}")
assert_equal 'Asciidoctor 1.0', doc.attributes['release']
end
test 'assigns attribute to empty string if substitution fails to resolve attribute' do
input = ':release: Asciidoctor {version}'
document_from_string input, attributes: { 'attribute-missing' => 'drop-line' }
assert_message @logger, :INFO, 'dropping line containing reference to missing attribute: version'
end
test 'assigns multi-line attribute to empty string if substitution fails to resolve attribute' do
input = <<~'EOS'
:release: Asciidoctor +
{version}
EOS
doc = document_from_string input, attributes: { 'attribute-missing' => 'drop-line' }
assert_equal '', doc.attributes['release']
assert_message @logger, :INFO, 'dropping line containing reference to missing attribute: version'
end
test 'resolves attributes inside attribute value within header' do
input = <<~'EOS'
= Document Title
:big: big
:bigfoot: {big}foot
{bigfoot}
EOS
result = convert_string_to_embedded input
assert_includes result, 'bigfoot'
end
test 'resolves attributes and pass macro inside attribute value outside header' do
input = <<~'EOS'
= Document Title
content
:big: pass:a,q[_big_]
:bigfoot: {big}foot
{bigfoot}
EOS
result = convert_string_to_embedded input
assert_includes result, '<em>big</em>foot'
end
test 'should limit maximum size of attribute value if safe mode is SECURE' do
expected = 'a' * 4096
input = <<~EOS
:name: #{'a' * 5000}
{name}
EOS
result = convert_inline_string input
assert_equal expected, result
assert_equal 4096, result.bytesize
end
test 'should handle multibyte characters when limiting attribute value size' do
expected = '日本'
input = <<~'EOS'
:name: 日本語
{name}
EOS
result = convert_inline_string input, attributes: { 'max-attribute-value-size' => 6 }
assert_equal expected, result
assert_equal 6, result.bytesize
end
test 'should not mangle multibyte characters when limiting attribute value size' do
expected = '日本'
input = <<~'EOS'
:name: 日本語
{name}
EOS
result = convert_inline_string input, attributes: { 'max-attribute-value-size' => 8 }
assert_equal expected, result
assert_equal 6, result.bytesize
end
test 'should allow maximize size of attribute value to be disabled' do
expected = 'a' * 5000
input = <<~EOS
:name: #{'a' * 5000}
{name}
EOS
result = convert_inline_string input, attributes: { 'max-attribute-value-size' => nil }
assert_equal expected, result
assert_equal 5000, result.bytesize
end
test 'resolves user-home attribute if safe mode is less than SERVER' do
input = <<~'EOS'
:imagesdir: {user-home}/etc/images
{imagesdir}
EOS
output = convert_inline_string input, safe: :safe
assert_equal %(#{Asciidoctor::USER_HOME}/etc/images), output
end
test 'user-home attribute resolves to . if safe mode is SERVER or greater' do
input = <<~'EOS'
:imagesdir: {user-home}/etc/images
{imagesdir}
EOS
output = convert_inline_string input, safe: :server
assert_equal './etc/images', output
end
test "apply custom substitutions to text in passthrough macro and assign to attribute" do
doc = document_from_string(":xml-busters: pass:[<>&]")
assert_equal '<>&', doc.attributes['xml-busters']
doc = document_from_string(":xml-busters: pass:none[<>&]")
assert_equal '<>&', doc.attributes['xml-busters']
doc = document_from_string(":xml-busters: pass:specialcharacters[<>&]")
assert_equal '<>&', doc.attributes['xml-busters']
doc = document_from_string(":xml-busters: pass:n,-c[<(C)>]")
assert_equal '<©>', doc.attributes['xml-busters']
end
test 'should not recognize pass macro with invalid substitution list in attribute value' do
[',', '42', 'a,'].each do |subs|
doc = document_from_string %(:pass-fail: pass:#{subs}[whale])
assert_equal %(pass:#{subs}[whale]), doc.attributes['pass-fail']
end
end
test "attribute is treated as defined until it's not" do
input = <<~'EOS'
:holygrail:
ifdef::holygrail[]
The holy grail has been found!
endif::holygrail[]
:holygrail!:
ifndef::holygrail[]
Buggers! What happened to the grail?
endif::holygrail[]
EOS
output = convert_string input
assert_xpath '//p', output, 2
assert_xpath '(//p)[1][text() = "The holy grail has been found!"]', output, 1
assert_xpath '(//p)[2][text() = "Buggers! What happened to the grail?"]', output, 1
end
test 'attribute set via API overrides attribute set in document' do
doc = document_from_string(':cash: money', attributes: { 'cash' => 'heroes' })
assert_equal 'heroes', doc.attributes['cash']
end
test 'attribute set via API cannot be unset by document' do
doc = document_from_string(':cash!:', attributes: { 'cash' => 'heroes' })
assert_equal 'heroes', doc.attributes['cash']
end
test 'attribute soft set via API using modifier on name can be overridden by document' do
doc = document_from_string(':cash: money', attributes: { 'cash@' => 'heroes' })
assert_equal 'money', doc.attributes['cash']
end
test 'attribute soft set via API using modifier on value can be overridden by document' do
doc = document_from_string(':cash: money', attributes: { 'cash' => 'heroes@' })
assert_equal 'money', doc.attributes['cash']
end
test 'attribute soft set via API using modifier on name can be unset by document' do
doc = document_from_string(':cash!:', attributes: { 'cash@' => 'heroes' })
assert_nil doc.attributes['cash']
doc = document_from_string(':cash!:', attributes: { 'cash@' => true })
assert_nil doc.attributes['cash']
end
test 'attribute soft set via API using modifier on value can be unset by document' do
doc = document_from_string(':cash!:', attributes: { 'cash' => 'heroes@' })
assert_nil doc.attributes['cash']
end
test 'attribute unset via API cannot be set by document' do
[
{ 'cash!' => '' },
{ '!cash' => '' },
{ 'cash' => nil },
].each do |attributes|
doc = document_from_string(':cash: money', attributes: attributes)
assert_nil doc.attributes['cash']
end
end
test 'attribute soft unset via API can be set by document' do
[
{ 'cash!@' => '' },
{ '!cash@' => '' },
{ 'cash!' => '@' },
{ '!cash' => '@' },
{ 'cash' => false },
].each do |attributes|
doc = document_from_string(':cash: money', attributes: attributes)
assert_equal 'money', doc.attributes['cash']
end
end
test 'can soft unset built-in attribute from API and still override in document' do
[
{ 'sectids!@' => '' },
{ '!sectids@' => '' },
{ 'sectids!' => '@' },
{ '!sectids' => '@' },
{ 'sectids' => false },
].each do |attributes|
doc = document_from_string '== Heading', attributes: attributes
refute doc.attr?('sectids')
assert_css '#_heading', (doc.convert standalone: false), 0
doc = document_from_string %(:sectids:\n\n== Heading), attributes: attributes
assert doc.attr?('sectids')
assert_css '#_heading', (doc.convert standalone: false), 1
end
end
test 'backend and doctype attributes are set by default in default configuration' do
input = <<~'EOS'
= Document Title
Author Name
content
EOS
doc = document_from_string input
expect = {
'backend' => 'html5',
'backend-html5' => '',
'backend-html5-doctype-article' => '',
'outfilesuffix' => '.html',
'basebackend' => 'html',
'basebackend-html' => '',
'basebackend-html-doctype-article' => '',
'doctype' => 'article',
'doctype-article' => '',
'filetype' => 'html',
'filetype-html' => '',
}
expect.each do |key, val|
assert doc.attributes.key? key
assert_equal val, doc.attributes[key]
end
end
test 'backend and doctype attributes are set by default in custom configuration' do
input = <<~'EOS'
= Document Title
Author Name
content
EOS
doc = document_from_string input, doctype: 'book', backend: 'docbook'
expect = {
'backend' => 'docbook5',
'backend-docbook5' => '',
'backend-docbook5-doctype-book' => '',
'outfilesuffix' => '.xml',
'basebackend' => 'docbook',
'basebackend-docbook' => '',
'basebackend-docbook-doctype-book' => '',
'doctype' => 'book',
'doctype-book' => '',
'filetype' => 'xml',
'filetype-xml' => '',
}
expect.each do |key, val|
assert doc.attributes.key? key
assert_equal val, doc.attributes[key]
end
end
test 'backend attributes are updated if backend attribute is defined in document and safe mode is less than SERVER' do
input = <<~'EOS'
= Document Title
Author Name
:backend: docbook
:doctype: book
content
EOS
doc = document_from_string input, safe: Asciidoctor::SafeMode::SAFE
expect = {
'backend' => 'docbook5',
'backend-docbook5' => '',
'backend-docbook5-doctype-book' => '',
'outfilesuffix' => '.xml',
'basebackend' => 'docbook',
'basebackend-docbook' => '',
'basebackend-docbook-doctype-book' => '',
'doctype' => 'book',
'doctype-book' => '',
'filetype' => 'xml',
'filetype-xml' => '',
}
expect.each do |key, val|
assert doc.attributes.key?(key)
assert_equal val, doc.attributes[key]
end
refute doc.attributes.key?('backend-html5')
refute doc.attributes.key?('backend-html5-doctype-article')
refute doc.attributes.key?('basebackend-html')
refute doc.attributes.key?('basebackend-html-doctype-article')
refute doc.attributes.key?('doctype-article')
refute doc.attributes.key?('filetype-html')
end
test 'backend attributes defined in document options overrides backend attribute in document' do
doc = document_from_string(':backend: docbook5', safe: Asciidoctor::SafeMode::SAFE, attributes: { 'backend' => 'html5' })
assert_equal 'html5', doc.attributes['backend']
assert doc.attributes.key? 'backend-html5'
assert_equal 'html', doc.attributes['basebackend']
assert doc.attributes.key? 'basebackend-html'
end
test 'can only access a positional attribute from the attributes hash' do
node = Asciidoctor::Block.new nil, :paragraph, attributes: { 1 => 'position 1' }
assert_nil node.attr(1)
refute node.attr?(1)
assert_equal 'position 1', node.attributes[1]
end
test 'attr should not retrieve attribute from document if not set on block' do
doc = document_from_string 'paragraph', :attributes => { 'name' => 'value' }
para = doc.blocks[0]
assert_nil para.attr 'name'
end
test 'attr looks for attribute on document if fallback name is true' do
doc = document_from_string 'paragraph', :attributes => { 'name' => 'value' }
para = doc.blocks[0]
assert_equal 'value', (para.attr 'name', nil, true)
end
test 'attr uses fallback name when looking for attribute on document' do
doc = document_from_string 'paragraph', :attributes => { 'alt-name' => 'value' }
para = doc.blocks[0]
assert_equal 'value', (para.attr 'name', nil, 'alt-name')
end
test 'attr? should not check for attribute on document if not set on block' do
doc = document_from_string 'paragraph', :attributes => { 'name' => 'value' }
para = doc.blocks[0]
refute para.attr? 'name'
end
test 'attr? checks for attribute on document if fallback name is true' do
doc = document_from_string 'paragraph', :attributes => { 'name' => 'value' }
para = doc.blocks[0]
assert para.attr? 'name', nil, true
end
test 'attr? checks for fallback name when looking for attribute on document' do
doc = document_from_string 'paragraph', :attributes => { 'alt-name' => 'value' }
para = doc.blocks[0]
assert para.attr? 'name', nil, 'alt-name'
end
test 'set_attr should set value to empty string if no value is specified' do
node = Asciidoctor::Block.new nil, :paragraph, attributes: {}
node.set_attr 'foo'
assert_equal '', (node.attr 'foo')
end
test 'remove_attr should remove attribute and return previous value' do
doc = empty_document
node = Asciidoctor::Block.new doc, :paragraph, attributes: { 'foo' => 'bar' }
assert_equal 'bar', (node.remove_attr 'foo')
assert_nil node.attr('foo')
end
test 'set_attr should not overwrite existing key if overwrite is false' do
node = Asciidoctor::Block.new nil, :paragraph, attributes: { 'foo' => 'bar' }
assert_equal 'bar', (node.attr 'foo')
node.set_attr 'foo', 'baz', false
assert_equal 'bar', (node.attr 'foo')
end
test 'set_attr should overwrite existing key by default' do
node = Asciidoctor::Block.new nil, :paragraph, attributes: { 'foo' => 'bar' }
assert_equal 'bar', (node.attr 'foo')
node.set_attr 'foo', 'baz'
assert_equal 'baz', (node.attr 'foo')
end
test 'set_attr should set header attribute in loaded document' do
input = <<~'EOS'
:uri: http://example.org
{uri}
EOS
doc = Asciidoctor.load input, attributes: { 'uri' => 'https://github.com' }
doc.set_attr 'uri', 'https://google.com'
output = doc.convert
assert_xpath '//a[@href="https://google.com"]', output, 1
end
test 'set_attribute should set attribute if key is not locked' do
doc = empty_document
refute doc.attr? 'foo'
res = doc.set_attribute 'foo', 'baz'
assert res
assert_equal 'baz', (doc.attr 'foo')
end
test 'set_attribute should not set key if key is locked' do
doc = empty_document attributes: { 'foo' => 'bar' }
assert_equal 'bar', (doc.attr 'foo')
res = doc.set_attribute 'foo', 'baz'
refute res
assert_equal 'bar', (doc.attr 'foo')
end
test 'set_attribute should update backend attributes' do
doc = empty_document attributes: { 'backend' => 'html5@' }
assert_equal '', (doc.attr 'backend-html5')
res = doc.set_attribute 'backend', 'docbook5'
assert res
refute doc.attr? 'backend-html5'
assert_equal '', (doc.attr 'backend-docbook5')
end
test 'verify toc attribute matrix' do
expected_data = <<~'EOS'
#attributes |toc|toc-position|toc-placement|toc-class
toc | |nil |auto |nil
toc=header | |nil |auto |nil
toc=beeboo | |nil |auto |nil
toc=left | |left |auto |toc2
toc2 | |left |auto |toc2
toc=right | |right |auto |toc2
toc=preamble | |content |preamble |nil
toc=macro | |content |macro |nil
toc toc-placement=macro toc-position=left | |content |macro |nil
toc toc-placement! | |content |macro |nil
EOS
expected = expected_data.lines.map do |l|
next if l.start_with? '#'
l.split('|').map {|e| (e = e.strip) == 'nil' ? nil : e }
end.compact
expected.each do |expect|
raw_attrs, toc, toc_position, toc_placement, toc_class = expect
attrs = Hash[*raw_attrs.split.map {|e| e.include?('=') ? e.split('=', 2) : [e, ''] }.flatten]
doc = document_from_string '', attributes: attrs
toc ? (assert doc.attr?('toc', toc)) : (refute doc.attr?('toc'))
toc_position ? (assert doc.attr?('toc-position', toc_position)) : (refute doc.attr?('toc-position'))
toc_placement ? (assert doc.attr?('toc-placement', toc_placement)) : (refute doc.attr?('toc-placement'))
toc_class ? (assert doc.attr?('toc-class', toc_class)) : (refute doc.attr?('toc-class'))
end
end
end
context 'Interpolation' do
test "convert properly with simple names" do
html = convert_string(":frog: Tanglefoot\n:my_super-hero: Spiderman\n\nYo, {frog}!\nBeat {my_super-hero}!")
assert_xpath %(//p[text()="Yo, Tanglefoot!\nBeat Spiderman!"]), html, 1
end
test 'attribute lookup is not case sensitive' do
input = <<~'EOS'
:He-Man: The most powerful man in the universe
He-Man: {He-Man}
She-Ra: {She-Ra}
EOS
result = convert_string_to_embedded input, attributes: { 'She-Ra' => 'The Princess of Power' }
assert_xpath '//p[text()="He-Man: The most powerful man in the universe"]', result, 1
assert_xpath '//p[text()="She-Ra: The Princess of Power"]', result, 1
end
test "convert properly with single character name" do
html = convert_string(":r: Ruby\n\nR is for {r}!")
assert_xpath %(//p[text()="R is for Ruby!"]), html, 1
end
test "collapses spaces in attribute names" do
input = <<~'EOS'
Main Header
===========
:My frog: Tanglefoot
Yo, {myfrog}!
EOS
output = convert_string input
assert_xpath '(//p)[1][text()="Yo, Tanglefoot!"]', output, 1
end
test 'ignores lines with bad attributes if attribute-missing is drop-line' do
input = <<~'EOS'
:attribute-missing: drop-line
This is
blah blah {foobarbaz}
all there is.
EOS
output = convert_string_to_embedded input
para = xmlnodes_at_css 'p', output, 1
refute_includes 'blah blah', para.content
assert_message @logger, :INFO, 'dropping line containing reference to missing attribute: foobarbaz'
end
test "attribute value gets interpretted when converting" do
doc = document_from_string(":google: http://google.com[Google]\n\n{google}")
assert_equal 'http://google.com[Google]', doc.attributes['google']
output = doc.convert
assert_xpath '//a[@href="http://google.com"][text() = "Google"]', output, 1
end
test 'should drop line with reference to missing attribute if attribute-missing attribute is drop-line' do
input = <<~'EOS'
:attribute-missing: drop-line
Line 1: This line should appear in the output.
Line 2: Oh no, a {bogus-attribute}! This line should not appear in the output.
EOS
output = convert_string_to_embedded input
assert_match(/Line 1/, output)
refute_match(/Line 2/, output)
assert_message @logger, :INFO, 'dropping line containing reference to missing attribute: bogus-attribute'
end
test 'should not drop line with reference to missing attribute by default' do
input = <<~'EOS'
Line 1: This line should appear in the output.
Line 2: A {bogus-attribute}! This time, this line should appear in the output.
EOS
output = convert_string_to_embedded input
assert_match(/Line 1/, output)
assert_match(/Line 2/, output)
assert_match(/\{bogus-attribute\}/, output)
end
test 'should drop line with attribute unassignment by default' do
input = <<~'EOS'
:a:
Line 1: This line should appear in the output.
Line 2: {set:a!}This line should not appear in the output.
EOS
output = convert_string_to_embedded input
assert_match(/Line 1/, output)
refute_match(/Line 2/, output)
end
test 'should not drop line with attribute unassignment if attribute-undefined is drop' do
input = <<~'EOS'
:attribute-undefined: drop
:a:
Line 1: This line should appear in the output.
Line 2: {set:a!}This line should appear in the output.
EOS
output = convert_string_to_embedded input
assert_match(/Line 1/, output)
assert_match(/Line 2/, output)
refute_match(/\{set:a!\}/, output)
end
test 'should drop line that only contains attribute assignment' do
input = <<~'EOS'
Line 1
{set:a}
Line 2
EOS
output = convert_string_to_embedded input
assert_xpath %(//p[text()="Line 1\nLine 2"]), output, 1
end
test 'should drop line that only contains unresolved attribute when attribute-missing is drop' do
input = <<~'EOS'
Line 1
{unresolved}
Line 2
EOS
output = convert_string_to_embedded input, attributes: { 'attribute-missing' => 'drop' }
assert_xpath %(//p[text()="Line 1\nLine 2"]), output, 1
end
test "substitutes inside unordered list items" do
html = convert_string(":foo: bar\n* snort at the {foo}\n* yawn")
assert_xpath %(//li/p[text()="snort at the bar"]), html, 1
end
test 'substitutes inside section title' do
output = convert_string(":prefix: Cool\n\n== {prefix} Title\n\ncontent")
assert_xpath '//h2[text()="Cool Title"]', output, 1
assert_css 'h2#_cool_title', output, 1
end
test 'interpolates attribute defined in header inside attribute entry in header' do
input = <<~'EOS'
= Title
Author Name
:attribute-a: value
:attribute-b: {attribute-a}
preamble
EOS
doc = document_from_string(input, parse_header_only: true)
assert_equal 'value', doc.attributes['attribute-b']
end
test 'interpolates author attribute inside attribute entry in header' do
input = <<~'EOS'
= Title
Author Name
:name: {author}
preamble
EOS
doc = document_from_string(input, parse_header_only: true)
assert_equal 'Author Name', doc.attributes['name']
end
test 'interpolates revinfo attribute inside attribute entry in header' do
input = <<~'EOS'
= Title
Author Name
2013-01-01
:date: {revdate}
preamble
EOS
doc = document_from_string(input, parse_header_only: true)
assert_equal '2013-01-01', doc.attributes['date']
end
test 'attribute entries can resolve previously defined attributes' do
input = <<~'EOS'
= Title
Author Name
v1.0, 2010-01-01: First release!
:a: value
:a2: {a}
:revdate2: {revdate}
{a} == {a2}
{revdate} == {revdate2}
EOS
doc = document_from_string input
assert_equal '2010-01-01', doc.attr('revdate')
assert_equal '2010-01-01', doc.attr('revdate2')
assert_equal 'value', doc.attr('a')
assert_equal 'value', doc.attr('a2')
output = doc.convert
assert_includes output, 'value == value'
assert_includes output, '2010-01-01 == 2010-01-01'
end
test 'should warn if unterminated block comment is detected in document header' do
input = <<~'EOS'
= Document Title
:foo: bar
////
:hey: there
content
EOS
doc = document_from_string input
assert_nil doc.attr('hey')
assert_message @logger, :WARN, '<stdin>: line 3: unterminated comment block', Hash
end
test 'substitutes inside block title' do
input = <<~'EOS'
:gem_name: asciidoctor
.Require the +{gem_name}+ gem
To use {gem_name}, the first thing to do is to import it in your Ruby source file.
EOS
output = convert_string_to_embedded input, attributes: { 'compat-mode' => '' }
assert_xpath '//*[@class="title"]/code[text()="asciidoctor"]', output, 1
input = <<~'EOS'
:gem_name: asciidoctor
.Require the `{gem_name}` gem
To use {gem_name}, the first thing to do is to import it in your Ruby source file.
EOS
output = convert_string_to_embedded input
assert_xpath '//*[@class="title"]/code[text()="asciidoctor"]', output, 1
end
test 'sets attribute until it is deleted' do
input = <<~'EOS'
:foo: bar
Crossing the {foo}.
:foo!:
Belly up to the {foo}.
EOS
output = convert_string_to_embedded input
assert_xpath '//p[text()="Crossing the bar."]', output, 1
assert_xpath '//p[text()="Belly up to the bar."]', output, 0
end
test 'should allow compat-mode to be set and unset in middle of document' do
input = <<~'EOS'
:foo: bar
[[paragraph-a]]
`{foo}`
:compat-mode!:
[[paragraph-b]]
`{foo}`
:compat-mode:
[[paragraph-c]]
`{foo}`
EOS
result = convert_string_to_embedded input, attributes: { 'compat-mode' => '@' }
assert_xpath '/*[@id="paragraph-a"]//code[text()="{foo}"]', result, 1
assert_xpath '/*[@id="paragraph-b"]//code[text()="bar"]', result, 1
assert_xpath '/*[@id="paragraph-c"]//code[text()="{foo}"]', result, 1
end
test 'does not disturb attribute-looking things escaped with backslash' do
html = convert_string(":foo: bar\nThis is a \\{foo} day.")
assert_xpath '//p[text()="This is a {foo} day."]', html, 1
end
test 'does not disturb attribute-looking things escaped with literals' do
html = convert_string(":foo: bar\nThis is a +++{foo}+++ day.")
assert_xpath '//p[text()="This is a {foo} day."]', html, 1
end
test 'does not substitute attributes inside listing blocks' do
input = <<~'EOS'
:forecast: snow
----
puts 'The forecast for today is {forecast}'
----
EOS
output = convert_string(input)
assert_match(/\{forecast\}/, output)
end
test 'does not substitute attributes inside literal blocks' do
input = <<~'EOS'
:foo: bar
....
You insert the text {foo} to expand the value
of the attribute named foo in your document.
....
EOS
output = convert_string(input)
assert_match(/\{foo\}/, output)
end
test 'does not show docdir and shows relative docfile if safe mode is SERVER or greater' do
input = <<~'EOS'
* docdir: {docdir}
* docfile: {docfile}
EOS
docdir = Dir.pwd
docfile = File.join(docdir, 'sample.adoc')
output = convert_string_to_embedded input, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docdir' => docdir, 'docfile' => docfile }
assert_xpath '//li[1]/p[text()="docdir: "]', output, 1
assert_xpath '//li[2]/p[text()="docfile: sample.adoc"]', output, 1
end
test 'shows absolute docdir and docfile paths if safe mode is less than SERVER' do
input = <<~'EOS'
* docdir: {docdir}
* docfile: {docfile}
EOS
docdir = Dir.pwd
docfile = File.join(docdir, 'sample.adoc')
output = convert_string_to_embedded input, safe: Asciidoctor::SafeMode::SAFE, attributes: { 'docdir' => docdir, 'docfile' => docfile }
assert_xpath %(//li[1]/p[text()="docdir: #{docdir}"]), output, 1
assert_xpath %(//li[2]/p[text()="docfile: #{docfile}"]), output, 1
end
test 'assigns attribute defined in attribute reference with set prefix and value' do
input = '{set:foo:bar}{foo}'
output = convert_string_to_embedded input
assert_xpath '//p', output, 1
assert_xpath '//p[text()="bar"]', output, 1
end
test 'assigns attribute defined in attribute reference with set prefix and no value' do
input = "{set:foo}\n{foo}yes"
output = convert_string_to_embedded input
assert_xpath '//p', output, 1
assert_xpath '//p[normalize-space(text())="yes"]', output, 1
end
test 'assigns attribute defined in attribute reference with set prefix and empty value' do
input = "{set:foo:}\n{foo}yes"
output = convert_string_to_embedded input
assert_xpath '//p', output, 1
assert_xpath '//p[normalize-space(text())="yes"]', output, 1
end
test 'unassigns attribute defined in attribute reference with set prefix' do
input = <<~'EOS'
:attribute-missing: drop-line
:foo:
{set:foo!}
{foo}yes
EOS
output = convert_string_to_embedded input
assert_xpath '//p', output, 1
assert_xpath '//p/child::text()', output, 0
assert_message @logger, :INFO, 'dropping line containing reference to missing attribute: foo'
end
end
context "Intrinsic attributes" do
test "substitute intrinsics" do
Asciidoctor::INTRINSIC_ATTRIBUTES.each_pair do |key, value|
html = convert_string("Look, a {#{key}} is here")
# can't use Nokogiri because it interprets the HTML entities and we can't match them
assert_match(/Look, a #{Regexp.escape(value)} is here/, html)
end
end
test "don't escape intrinsic substitutions" do
html = convert_string('happy{nbsp}together')
assert_match(/happy together/, html)
end
test "escape special characters" do
html = convert_string('<node>&</node>')
assert_match(/<node>&<\/node>/, html)
end