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 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248
|
# frozen_string_literal: true
require_relative 'test_helper'
BUILT_IN_ELEMENTS = %w(admonition audio colist dlist document embedded example floating_title image inline_anchor inline_break inline_button inline_callout inline_footnote inline_image inline_indexterm inline_kbd inline_menu inline_quoted listing literal stem olist open page_break paragraph pass preamble quote section sidebar table thematic_break toc ulist verse video)
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
refute_nil doc.header
assert_equal :section, doc.header.context
assert_equal 'header', doc.header.sectname
assert_equal 14, doc.blocks.size
assert_equal :preamble, doc.blocks[0].context
assert_equal :section, doc.blocks[1].context
# verify compat-mode is set when atx-style doctitle is used
result = doc.blocks[0].convert
assert_xpath %q(//em[text()="Stuart Rackham"]), result, 1
end
end
context 'Default settings' do
test 'safe mode level set to SECURE by default' do
doc = empty_document
assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
end
test 'safe mode level set using string' do
doc = empty_document safe: 'server'
assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
doc = empty_document safe: 'foo'
assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
end
test 'safe mode level set using symbol' do
doc = empty_document safe: :server
assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
doc = empty_document safe: :foo
assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
end
test 'safe mode level set using integer' do
doc = empty_document safe: 10
assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
doc = empty_document safe: 100
assert_equal 100, doc.safe
end
test 'safe mode attributes are set on document' do
doc = empty_document
assert_equal Asciidoctor::SafeMode::SECURE, doc.attr('safe-mode-level')
assert_equal 'secure', doc.attr('safe-mode-name')
assert doc.attr?('safe-mode-secure')
refute doc.attr?('safe-mode-unsafe')
refute doc.attr?('safe-mode-safe')
refute 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 = empty_document
begin
doc.safe = Asciidoctor::SafeMode::UNSAFE
flunk 'safe mode property of Asciidoctor::Document should not be writable!'
rescue
end
end
test 'toc and sectnums should be enabled by default in DocBook backend' do
doc = document_from_string 'content', backend: 'docbook', parse: true
assert doc.attr?('toc')
assert doc.attr?('sectnums')
result = doc.convert
assert_match('<?asciidoc-toc?>', result)
assert_match('<?asciidoc-numbered?>', result)
end
test 'maxdepth attribute should be set on asciidoc-toc and asciidoc-numbered processing instructions in DocBook backend' do
doc = document_from_string 'content', backend: 'docbook', parse: true, attributes: { 'toclevels' => '1', 'sectnumlevels' => '1' }
assert doc.attr?('toc')
assert doc.attr?('sectnums')
result = doc.convert
assert_match('<?asciidoc-toc maxdepth="1"?>', result)
assert_match('<?asciidoc-numbered maxdepth="1"?>', result)
end
test 'should be able to disable toc and sectnums in document header in DocBook backend' do
input = <<~'EOS'
= Document Title
:toc!:
:sectnums!:
EOS
doc = document_from_string input, backend: 'docbook'
refute doc.attr?('toc')
refute doc.attr?('sectnums')
end
test 'noheader attribute should suppress info element when converting to DocBook' do
input = <<~'EOS'
= Document Title
:noheader:
content
EOS
result = convert_string input, backend: 'docbook'
assert_xpath '/article', result, 1
assert_xpath '/article/info', result, 0
end
test 'should be able to disable section numbering using numbered attribute in document header in DocBook backend' do
input = <<~'EOS'
= Document Title
:numbered!:
EOS
doc = document_from_string input, backend: 'docbook'
refute doc.attr?('sectnums')
end
end
context 'Docinfo files' do
test 'should include docinfo files for html backend' do
sample_input_path = fixture_path('basic.adoc')
cases = {
'docinfo' => { head_script: 1, meta: 0, top_link: 0, footer_script: 1, navbar: 1 },
'docinfo=private' => { head_script: 1, meta: 0, top_link: 0, footer_script: 1, navbar: 1 },
'docinfo1' => { head_script: 0, meta: 1, top_link: 1, footer_script: 0, navbar: 0 },
'docinfo=shared' => { head_script: 0, meta: 1, top_link: 1, footer_script: 0, navbar: 0 },
'docinfo2' => { head_script: 1, meta: 1, top_link: 1, footer_script: 1, navbar: 1 },
'docinfo docinfo2' => { head_script: 1, meta: 1, top_link: 1, footer_script: 1, navbar: 1 },
'docinfo=private,shared' => { head_script: 1, meta: 1, top_link: 1, footer_script: 1, navbar: 1 },
'docinfo=private-head' => { head_script: 1, meta: 0, top_link: 0, footer_script: 0, navbar: 0 },
'docinfo=private-header' => { head_script: 0, meta: 0, top_link: 0, footer_script: 0, navbar: 1 },
'docinfo=shared-head' => { head_script: 0, meta: 1, top_link: 0, footer_script: 0, navbar: 0 },
'docinfo=private-footer' => { head_script: 0, meta: 0, top_link: 0, footer_script: 1, navbar: 0 },
'docinfo=shared-footer' => { head_script: 0, meta: 0, top_link: 1, footer_script: 0, navbar: 0 },
'docinfo=private-head\ ,\ shared-footer' => { head_script: 1, meta: 0, top_link: 1, footer_script: 0, navbar: 0 },
}
cases.each do |attr_val, markup|
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: %(linkcss copycss! #{attr_val})
refute_empty output
assert_css 'script[src="modernizr.js"]', output, markup[:head_script]
assert_css 'meta[http-equiv="imagetoolbar"]', output, markup[:meta]
assert_css 'body > a#top', output, markup[:top_link]
assert_css 'body > script', output, markup[:footer_script]
assert_css 'body > nav.navbar', output, markup[:navbar]
assert_css 'body > nav.navbar + #header', output, markup[:navbar]
end
end
test 'should include docinfo header even if noheader attribute is set' do
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo' => 'private-header', 'noheader' => '' }
refute_empty output
assert_css 'body > nav.navbar', output, 1
assert_css 'body > nav.navbar + #content', output, 1
end
test 'should include docinfo footer even if nofooter attribute is set' do
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo1' => '', 'nofooter' => '' }
refute_empty output
assert_css 'body > a#top', output, 1
end
test 'should include user docinfo after built-in docinfo' do
sample_input_path = fixture_path 'basic.adoc'
attrs = { 'docinfo' => 'shared', 'source-highlighter' => 'highlight.js', 'linkcss' => '', 'copycss' => nil }
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: :safe, attributes: attrs
assert_css 'link[rel=stylesheet] + meta[http-equiv=imagetoolbar]', output, 1
assert_css 'meta[http-equiv=imagetoolbar] + *', output, 0
assert_css 'script + a#top', output, 1
assert_css 'a#top + *', output, 0
end
test 'should include docinfo files for html backend with custom docinfodir' do
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo' => '', 'docinfodir' => 'custom-docinfodir' }
refute_empty output
assert_css 'script[src="bootstrap.js"]', output, 1
assert_css 'meta[name="robots"]', output, 0
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo1' => '', 'docinfodir' => 'custom-docinfodir' }
refute_empty output
assert_css 'script[src="bootstrap.js"]', output, 0
assert_css 'meta[name="robots"]', output, 1
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo2' => '', 'docinfodir' => './custom-docinfodir' }
refute_empty output
assert_css 'script[src="bootstrap.js"]', output, 1
assert_css 'meta[name="robots"]', output, 1
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo2' => '', 'docinfodir' => 'custom-docinfodir/subfolder' }
refute_empty output
assert_css 'script[src="bootstrap.js"]', output, 0
assert_css 'meta[name="robots"]', output, 0
end
test 'should include docinfo files in docbook backend' do
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo' => '' }
refute_empty output
assert_css 'productname', output, 0
assert_css 'copyright', output, 1
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo1' => '' }
refute_empty output
assert_css 'productname', output, 1
assert_xpath '//xmlns:productname[text()="Asciidoctorâ„¢"]', 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.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo2' => '' }
refute_empty output
assert_css 'productname', output, 1
assert_xpath '//xmlns:productname[text()="Asciidoctorâ„¢"]', 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 use header docinfo in place of default header' do
output = Asciidoctor.convert_file fixture_path('sample.adoc'), to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo' => 'private-header', 'noheader' => '' }
refute_empty output
assert_css 'article > info', output, 1
assert_css 'article > info > title', output, 1
assert_css 'article > info > revhistory', output, 1
assert_css 'article > info > revhistory > revision', output, 2
end
test 'should include docinfo footer files for html backend' do
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo' => '' }
refute_empty output
assert_css 'body script', output, 1
assert_css 'a#top', output, 0
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo1' => '' }
refute_empty output
assert_css 'body script', output, 0
assert_css 'a#top', output, 1
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo2' => '' }
refute_empty output
assert_css 'body script', output, 1
assert_css 'a#top', output, 1
end
test 'should include docinfo footer files in DocBook backend' do
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo' => '' }
refute_empty output
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', output, 0
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo1' => '' }
refute_empty output
assert_css 'article > revhistory', output, 0
assert_css 'glossary[xml|id="_glossary"]', output, 1
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo2' => '' }
refute_empty output
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[xml|id="_glossary"]', output, 1
end
# WARNING this test manipulates runtime settings; should probably be run in forked process
test 'should force encoding of docinfo files to UTF-8' do
old_external = Encoding.default_external
old_internal = Encoding.default_internal
old_verbose = $VERBOSE
begin
$VERBOSE = nil # disable warnings since we have to modify constants
Encoding.default_external = Encoding.default_internal = Encoding::IBM437
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false, standalone: true,
backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER, attributes: { 'docinfo' => 'private,shared' }
refute_empty output
assert_css 'productname', output, 1
assert_includes output, '<productname>Asciidoctorâ„¢</productname>'
assert_css 'edition', output, 1
assert_xpath '//xmlns:edition[text()="1.0"]', output, 1 # verifies substitutions are performed
assert_css 'copyright', output, 1
ensure
Encoding.default_external = old_external
Encoding.default_internal = old_internal
$VERBOSE = old_verbose
end
end
test 'should not include docinfo files by default' do
sample_input_path = fixture_path('basic.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, safe: Asciidoctor::SafeMode::SERVER
refute_empty output
assert_css 'script[src="modernizr.js"]', output, 0
assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', safe: Asciidoctor::SafeMode::SERVER
refute_empty output
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.adoc')
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, attributes: { 'docinfo2' => '' }
refute_empty output
assert_css 'script[src="modernizr.js"]', output, 0
assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
output = Asciidoctor.convert_file sample_input_path, to_file: false,
standalone: true, backend: 'docbook', attributes: { 'docinfo2' => '' }
refute_empty output
assert_css 'productname', output, 0
assert_css 'copyright', output, 0
end
test 'should substitute attributes in docinfo files by default' do
sample_input_path = fixture_path 'subs.adoc'
using_memory_logger do |logger|
output = Asciidoctor.convert_file sample_input_path,
to_file: false,
standalone: true,
safe: :server,
attributes: { 'docinfo' => '', 'bootstrap-version' => nil, 'linkcss' => '', 'attribute-missing' => 'drop-line' }
refute_empty output
assert_css 'script', output, 0
assert_xpath %(//meta[@name="copyright"][@content="(C) OpenDevise"]), output, 1
assert_message logger, :INFO, 'dropping line containing reference to missing attribute: bootstrap-version'
end
end
test 'should apply explicit substitutions to docinfo files' do
sample_input_path = fixture_path 'subs.adoc'
output = Asciidoctor.convert_file sample_input_path,
to_file: false,
standalone: true,
safe: :server,
attributes: { 'docinfo' => '', 'docinfosubs' => 'attributes,replacements', 'linkcss' => '' }
refute_empty output
assert_css 'script[src="bootstrap.3.2.0.min.js"]', output, 1
assert_xpath %(//meta[@name="copyright"][@content="#{decode_char 169} OpenDevise"]), output, 1
end
end
context 'MathJax' do
test 'should add MathJax script to HTML head if stem attribute is set' do
output = convert_string '', attributes: { 'stem' => '' }
assert_match('<script type="text/x-mathjax-config">', output)
assert_match('inlineMath: [["\\\\(", "\\\\)"]]', output)
assert_match('displayMath: [["\\\\[", "\\\\]"]]', output)
assert_match('delimiters: [["\\\\$", "\\\\$"]]', output)
end
end
context 'Converter' do
test 'convert methods on built-in converter are registered by default' do
doc = document_from_string ''
assert_equal 'html5', doc.attributes['backend']
assert doc.attributes.key? 'backend-html5'
assert_equal 'html', doc.attributes['basebackend']
assert doc.attributes.key? 'basebackend-html'
converter = doc.converter
assert_kind_of Asciidoctor::Converter::Html5Converter, converter
BUILT_IN_ELEMENTS.each do |element|
assert_respond_to converter, %(convert_#{element})
end
end
test 'convert methods on built-in converter are registered when backend is docbook5' do
doc = document_from_string '', attributes: { 'backend' => 'docbook5' }
assert_equal 'docbook5', doc.attributes['backend']
assert doc.attributes.key? 'backend-docbook5'
assert_equal 'docbook', doc.attributes['basebackend']
assert doc.attributes.key? 'basebackend-docbook'
converter = doc.converter
assert_kind_of Asciidoctor::Converter::DocBook5Converter, converter
BUILT_IN_ELEMENTS.each do |element|
assert_respond_to converter, %(convert_#{element})
end
end
test 'should add favicon if favicon attribute is set' do
{
'' => %w(favicon.ico image/x-icon),
'/favicon.ico' => %w(/favicon.ico image/x-icon),
'/img/favicon.png' => %w(/img/favicon.png image/png),
}.each do |val, (href, type)|
result = convert_string '= Untitled', attributes: { 'favicon' => val }
assert_css 'link[rel="icon"]', result, 1
assert_css %(link[rel="icon"][href="#{href}"]), result, 1
assert_css %(link[rel="icon"][type="#{type}"]), result, 1
end
end
end
context 'Structure' do
test 'document with no doctitle' do
doc = document_from_string('Snorf')
assert_nil doc.doctitle
assert_nil doc.name
refute doc.has_header?
assert_nil doc.header
end
test 'should enable compat mode for document with legacy doctitle' do
input = <<~'EOS'
Document Title
==============
+content+
EOS
doc = document_from_string input
assert(doc.attr? 'compat-mode')
result = doc.convert
assert_xpath '//code[text()="content"]', result, 1
end
test 'should not enable compat mode for document with legacy doctitle if compat mode disable by header' do
input = <<~'EOS'
Document Title
==============
:compat-mode!:
+content+
EOS
doc = document_from_string input
assert_nil(doc.attr 'compat-mode')
result = doc.convert
assert_xpath '//code[text()="content"]', result, 0
end
test 'should not enable compat mode for document with legacy doctitle if compat mode is locked by API' do
input = <<~'EOS'
Document Title
==============
+content+
EOS
doc = document_from_string input, attributes: { 'compat-mode' => nil }
assert(doc.attribute_locked? 'compat-mode')
assert_nil(doc.attr 'compat-mode')
result = doc.convert
assert_xpath '//code[text()="content"]', result, 0
end
test 'should apply max-width to each top-level container' do
input = <<~'EOS'
= Document Title
contentfootnote:[placeholder]
EOS
output = convert_string input, attributes: { 'max-width' => '70em' }
assert_css 'body[style]', output, 0
assert_css '#header[style="max-width: 70em;"]', output, 1
assert_css '#content[style="max-width: 70em;"]', output, 1
assert_css '#footnotes[style="max-width: 70em;"]', output, 1
assert_css '#footer[style="max-width: 70em;"]', output, 1
end
test 'title partition API with default separator' do
title = Asciidoctor::Document::Title.new 'Main Title: And More: Subtitle'
assert_equal 'Main Title: And More', title.main
assert_equal 'Subtitle', title.subtitle
end
test 'title partition API with custom separator' do
title = Asciidoctor::Document::Title.new 'Main Title:: And More:: Subtitle', separator: '::'
assert_equal 'Main Title:: And More', title.main
assert_equal 'Subtitle', title.subtitle
end
test 'document with subtitle' do
input = <<~'EOS'
= Main Title: *Subtitle*
Author Name
content
EOS
doc = document_from_string input
title = doc.doctitle partition: true, sanitize: true
assert title.subtitle?
assert title.sanitized?
assert_equal 'Main Title', title.main
assert_equal 'Subtitle', title.subtitle
end
test 'document with subtitle and custom separator' do
input = <<~'EOS'
[separator=::]
= Main Title:: *Subtitle*
Author Name
content
EOS
doc = document_from_string input
title = doc.doctitle partition: true, sanitize: true
assert title.subtitle?
assert title.sanitized?
assert_equal 'Main Title', title.main
assert_equal 'Subtitle', title.subtitle
end
test 'should not honor custom separator for doctitle if attribute is locked by API' do
input = <<~'EOS'
[separator=::]
= Main Title - *Subtitle*
Author Name
content
EOS
doc = document_from_string input, attributes: { 'title-separator' => ' -' }
title = doc.doctitle partition: true, sanitize: true
assert title.subtitle?
assert title.sanitized?
assert_equal 'Main Title', title.main
assert_equal 'Subtitle', title.subtitle
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 doctitle defined as attribute entry followed by block with title' do
input = <<~'EOS'
:doctitle: Document Title
.Block title
Block content
EOS
doc = document_from_string input
assert_equal 'Document Title', doc.doctitle
assert doc.has_header?
assert_equal 1, doc.blocks.size
assert_equal :paragraph, doc.blocks[0].context
assert_equal 'Block title', doc.blocks[0].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.convert, 1
end
test 'document with blank title attribute entry overrides doctitle' do
input = <<~'EOS'
= Document Title
:title:
{doctitle}
== First Section
EOS
doc = document_from_string input
assert_equal '', doc.doctitle
assert_equal '', 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.convert, 1
end
test 'document header can reference intrinsic doctitle attribute' do
input = <<~'EOS'
= ACME Documentation
:intro: Welcome to the {doctitle}!
{intro}
EOS
doc = document_from_string input
assert_equal 'Welcome to the ACME Documentation!', (doc.attr 'intro')
assert_xpath '//p[text()="Welcome to the ACME Documentation!"]', doc.convert, 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.convert, 1
end
test 'document with doctitle attribute entry overrides implicit 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.attributes['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.convert, 1
end
test 'doctitle attribute entry above header overrides implicit 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.attributes['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.convert, 1
end
test 'should apply header substitutions to value of the doctitle attribute assigned from implicit doctitle' do
input = <<~'EOS'
= <Foo> {plus} <Bar>
The name of the game is {doctitle}.
EOS
doc = document_from_string input
assert_equal '<Foo> + <Bar>', (doc.attr 'doctitle')
assert_includes doc.blocks[0].content, '<Foo> + <Bar>'
end
test 'should substitute attribute reference in implicit document title for attribute defined earlier in header' do
using_memory_logger do |logger|
input = <<~'EOS'
:project-name: ACME
= {project-name} Docs
{doctitle}
EOS
doc = document_from_string input, attributes: { 'attribute-missing' => 'warn' }
assert_empty logger
assert_equal 'ACME Docs', (doc.attr 'doctitle')
assert_equal 'ACME Docs', doc.doctitle
assert_xpath '//p[text()="ACME Docs"]', doc.convert, 1
end
end
test 'should not warn if implicit document title contains attribute reference for attribute defined later in header' do
using_memory_logger do |logger|
input = <<~'EOS'
= {project-name} Docs
:project-name: ACME
{doctitle}
EOS
doc = document_from_string input, attributes: { 'attribute-missing' => 'warn' }
assert_empty logger
assert_equal '{project-name} Docs', (doc.attr 'doctitle')
assert_equal 'ACME Docs', doc.doctitle
assert_xpath '//p[text()="{project-name} Docs"]', doc.convert, 1
end
end
test 'should recognize document title when preceded by blank lines' do
input = <<~'EOS'
= Title
preamble
== Section 1
text
EOS
output = convert_string input, safe: Asciidoctor::SafeMode::SAFE
assert_css '#header h1', output, 1
assert_css '#content h1', output, 0
end
test 'should recognize document title when preceded by blank lines introduced by a preprocessor conditional' do
input = <<~'EOS'
ifdef::sectids[]
:foo: bar
endif::[]
= Title
preamble
== Section 1
text
EOS
output = convert_string input, safe: Asciidoctor::SafeMode::SAFE
assert_css '#header h1', output, 1
assert_css '#content h1', output, 0
end
test 'should recognize document title when preceded by blank lines after an attribute entry' do
input = <<~'EOS'
:doctype: book
= Title
preamble
== Section 1
text
EOS
output = convert_string input, safe: Asciidoctor::SafeMode::SAFE
assert_css '#header h1', output, 1
assert_css '#content h1', output, 0
end
test 'should recognize document title in include file when preceded by blank lines' do
input = <<~'EOS'
include::fixtures/include-with-leading-blank-line.adoc[]
EOS
output = convert_string input, safe: Asciidoctor::SafeMode::SAFE, attributes: { 'docdir' => testdir }
assert_xpath '//h1[text()="Document Title"]', output, 1
assert_css '#toc', output, 1
end
test 'should include specified lines even when leading lines are skipped' do
input = <<~'EOS'
include::fixtures/include-with-leading-blank-line.adoc[lines=6]
EOS
output = convert_string input, safe: Asciidoctor::SafeMode::SAFE, attributes: { 'docdir' => testdir }
assert_xpath '//h2[text()="Section"]', output, 1
end
test 'document with multiline attribute entry but only one line should not crash' do
input = ':foo: bar' + Asciidoctor::LINE_CONTINUATION
doc = document_from_string input
assert_equal 'bar', doc.attributes['foo']
end
test 'should sanitize contents of HTML title element' do
input = <<~'EOS'
= *Document* image:logo.png[] _Title_ image:another-logo.png[another logo]
content
EOS
output = convert_string input
assert_xpath '/html/head/title[text()="Document Title"]', output, 1
nodes = xmlnodes_at_xpath('//*[@id="header"]/h1', output)
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_empty doc.blocks
assert_nil doc.doctitle
refute doc.has_header?
assert_nil doc.header
end
test 'should not choke on nil source' do
doc = Asciidoctor::Document.new nil
assert_empty doc.blocks
assert_nil doc.doctitle
refute 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.
:description: AsciiDoc user guide
:keywords: asciidoc,documentation
:copyright: Stuart Rackham
== Version 8.6.8
more info...
EOS
output = convert_string input
assert_xpath '//meta[@name="author"][@content="Stuart Rackham"]', output, 1
assert_xpath '//meta[@name="description"][@content="AsciiDoc user guide"]', output, 1
assert_xpath '//meta[@name="keywords"][@content="asciidoc,documentation"]', output, 1
assert_xpath '//meta[@name="copyright"][@content="Stuart Rackham"]', output, 1
assert_xpath '//*[@id="header"]/*[@class="details"]/span[@id="author"][text()="Stuart Rackham"]', output, 1
assert_xpath '//*[@id="header"]/*[@class="details"]/span[@id="email"]/a[@href="mailto:founder@asciidoc.org"][text()="founder@asciidoc.org"]', output, 1
assert_xpath '//*[@id="header"]/*[@class="details"]/span[@id="revnumber"][text()="version 8.6.8,"]', output, 1
assert_xpath '//*[@id="header"]/*[@class="details"]/span[@id="revdate"][text()="2012-07-12"]', output, 1
assert_xpath '//*[@id="header"]/*[@class="details"]/span[@id="revremark"][text()="See changelog."]', output, 1
end
test 'should parse revision line if date is empty' do
input = <<~'EOS'
= Document Title
Author Name
v1.0.0,:remark
content
EOS
doc = document_from_string input
assert_equal '1.0.0', doc.attributes['revnumber']
assert_nil doc.attributes['revdate']
assert_equal 'remark', doc.attributes['revremark']
end
test 'should include revision history in DocBook output if revdate and revnumber is set' do
input = <<~'EOS'
= Document Title
Author Name
:revdate: 2011-11-11
:revnumber: 1.0
content
EOS
output = convert_string input, backend: 'docbook'
assert_css 'revhistory', output, 1
assert_css 'revhistory > revision', output, 1
assert_css 'revhistory > revision > date', output, 1
assert_css 'revhistory > revision > revnumber', output, 1
end
test 'should include revision history in DocBook output if revdate and revremark is set' do
input = <<~'EOS'
= Document Title
Author Name
:revdate: 2011-11-11
:revremark: features!
content
EOS
output = convert_string input, backend: 'docbook'
assert_css 'revhistory', output, 1
assert_css 'revhistory > revision', output, 1
assert_css 'revhistory > revision > date', output, 1
assert_css 'revhistory > revision > revremark', output, 1
end
test 'should not include revision history in DocBook output if revdate is not set' do
input = <<~'EOS'
= Document Title
Author Name
:revnumber: 1.0
content
EOS
output = convert_string input, backend: 'docbook'
assert_css 'revhistory', output, 0
end
test 'with metadata to DocBook 5' do
input = <<~'EOS'
= AsciiDoc
Stuart Rackham <founder@asciidoc.org>
== Version 8.6.8
more info...
EOS
output = convert_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
assert_css 'article:root:not([xml|id])', output, 1
assert_css 'article:root[xml|lang="en"]', output, 1
end
test 'with document ID to Docbook 5' do
input = <<~'EOS'
[[document-id]]
= Document Title
more info...
EOS
output = convert_string input, backend: 'docbook', keep_namespaces: true
assert_css 'article:root[xml|id="document-id"]', 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 = convert_string input, backend: 'docbook'
assert_xpath '/article/info/author', output, 1
assert_xpath '/article/info/author/personname/firstname[text()="Doc"]', output, 1
assert_xpath '/article/info/author/personname/surname[text()="Writer"]', output, 1
assert_xpath '/article/info/author/email[text()="thedoctor@asciidoc.org"]', output, 1
assert_xpath '/article/info/authorinitials[text()="DW"]', output, 1
end
test 'should substitute replacements in author names in HTML output' do
input = <<~'EOS'
= Document Title
Stephen O'Grady <founder@redmonk.com>
content
EOS
output = convert_string input
assert_xpath %(//meta[@name="author"][@content="Stephen O#{decode_char 8217}Grady"]), output, 1
assert_xpath %(//span[@id="author"][text()="Stephen O#{decode_char 8217}Grady"]), output, 1
end
test 'should substitute replacements in author names in DocBook output' do
input = <<~'EOS'
= Document Title
Stephen O'Grady <founder@redmonk.com>
content
EOS
output = convert_string input, backend: 'docbook'
assert_xpath '//author', output, 1
assert_xpath %(//author/personname/surname[text()="O#{decode_char 8217}Grady"]), output, 1
end
test 'should sanitize content of HTML meta authors tag' do
input = <<~'EOS'
= Document Title
:author: pass:n[http://example.org/community/team.html[Ze *Product* team]]
content
EOS
output = convert_string input
assert_xpath '//meta[@name="author"][@content="Ze Product team"]', output, 1
end
test 'should not double escape ampersand in author attribute' do
input = <<~'EOS'
= Document Title
R&D Lab
{author}
EOS
output = convert_string input
assert_includes output, 'R&D Lab', 2
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 = convert_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 = convert_string input, backend: 'docbook'
assert_xpath '/article/info/author', output, 0
assert_xpath '/article/info/authorgroup', output, 1
assert_xpath '/article/info/authorgroup/author', output, 2
assert_xpath '(/article/info/authorgroup/author)[1]/personname/firstname[text()="Doc"]', output, 1
assert_xpath '(/article/info/authorgroup/author)[2]/personname/firstname[text()="Junior"]', output, 1
end
test 'should process author defined by attribute when implicit doctitle is absent' do
input = <<~'EOS'
:author: Doc Writer
{lastname}, {firstname} ({authorinitials})
EOS
doc = document_from_string input, standalone: false
assert_equal 'Doc Writer', (doc.attr 'author')
assert_nil (doc.attr 'author_1')
assert_equal 'Writer', (doc.attr 'lastname')
assert_equal 'Doc', (doc.attr 'firstname')
assert_equal 'DW', (doc.attr 'authorinitials')
assert_equal 1, (doc.attr 'authorcount')
output = doc.convert
assert_xpath '//p[text()="Writer, Doc (DW)"]', output, 1
end
test 'should process author and authorinitials defined by attribute when implicit doctitle is absent' do
input = <<~'EOS'
:authorinitials: DOC
:author: Doc Writer
{lastname}, {firstname} ({authorinitials})
EOS
doc = document_from_string input, standalone: false
assert_equal 'Doc Writer', (doc.attr 'author')
assert_equal 'DOC', (doc.attr 'authorinitials')
assert_equal 1, (doc.attr 'authorcount')
output = doc.convert
assert_xpath '//p[text()="Writer, Doc (DOC)"]', output, 1
end
test 'should process authors defined by attribute when implicit doctitle is absent' do
input = <<~'EOS'
:authors: Doc Writer; Other Author
{lastname}, {firstname} ({authorinitials})
EOS
doc = document_from_string input, standalone: false
assert_equal 'Doc Writer', (doc.attr 'author')
assert_equal 'Doc Writer, Other Author', (doc.attr 'authors')
assert_equal 'Doc Writer', (doc.attr 'author_1')
assert_equal 'Writer', (doc.attr 'lastname')
assert_equal 'Writer', (doc.attr 'lastname_1')
assert_equal 'Doc', (doc.attr 'firstname')
assert_equal 'Doc', (doc.attr 'firstname_1')
assert_equal 'DW', (doc.attr 'authorinitials')
assert_equal 'DW', (doc.attr 'authorinitials_1')
assert_equal 'Other Author', (doc.attr 'author_2')
assert_equal 'OA', (doc.attr 'authorinitials_2')
assert_equal 2, (doc.attr 'authorcount')
output = doc.convert
assert_xpath '//p[text()="Writer, Doc (DW)"]', output, 1
end
test 'should process authors and authorinitials defined by attribute when implicit doctitle is absent' do
input = <<~'EOS'
:authorinitials: DOC
:authors: Doc Writer; Other Author
{lastname}, {firstname} ({authorinitials})
EOS
doc = document_from_string input, standalone: false
assert_equal 'Doc Writer', (doc.attr 'author')
assert_equal 'Doc Writer', (doc.attr 'author_1')
# FIXME this should be supported, but isn't yet
#assert_equal 'DOC', (doc.attr 'authorinitials')
assert_equal 'DW', (doc.attr 'authorinitials')
assert_equal 'Other Author', (doc.attr 'author_2')
assert_equal 2, (doc.attr 'authorcount')
output = doc.convert
#assert_xpath '//p[text()="Writer, Doc (DOC)"]', output, 1
assert_xpath '//p[text()="Writer, Doc (DW)"]', output, 1
end
test 'should set authorcount to 0 if document has no header' do
doc = document_from_string 'content'
assert_equal 0, (doc.attr 'authorcount')
end
test 'should set authorcount to 0 if author not set by attribute and implicit doctitle is missing' do
input = <<~'EOS'
:idprefix:
== Section Title
content
EOS
doc = document_from_string input
assert_equal 0, (doc.attr 'authorcount')
end
test 'should set authorcount to 0 if author not set by attribute and document starts with level-0 section with style' do
input = <<~'EOS'
:doctype: book
[preface]
= Preface
content
= Part
== Chapter
content
EOS
doc = document_from_string input
assert_equal 0, (doc.attr 'authorcount')
end
test 'with author defined by indexed attribute name' do
input = <<~'EOS'
= Document Title
:author_1: Doc Writer
{author}
EOS
doc = document_from_string input
assert_equal 'Doc Writer', (doc.attr 'author')
assert_equal 'Doc Writer', (doc.attr 'author_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 = convert_string input, backend: 'docbook'
assert_xpath '/article/info/author', output, 0
assert_xpath '/article/info/authorgroup', output, 1
assert_xpath '/article/info/authorgroup/author', output, 2
assert_xpath '(/article/info/authorgroup/author)[1]/personname/firstname[text()="Doc"]', output, 1
assert_xpath '(/article/info/authorgroup/author)[1]/email[text()="thedoctor@asciidoc.org"]', output, 1
assert_xpath '(/article/info/authorgroup/author)[2]/personname/firstname[text()="Junior"]', output, 1
assert_xpath '(/article/info/authorgroup/author)[2]/email[text()="junior@asciidoc.org"]', output, 1
end
test 'should populate copyright element in DocBook output if copyright attribute is defined' do
input = <<~'EOS'
= Jet Bike
:copyright: ACME, Inc.
Essential for catching road runners.
EOS
output = convert_string input, backend: 'docbook5'
assert_xpath '/article/info/copyright', output, 1
assert_xpath '/article/info/copyright/holder[text()="ACME, Inc."]', output, 1
end
test 'should populate copyright element in DocBook output if copyright attribute is defined with year' do
input = <<~'EOS'
= Jet Bike
:copyright: ACME, Inc. 1956
Essential for catching road runners.
EOS
output = convert_string input, backend: 'docbook5'
assert_xpath '/article/info/copyright', output, 1
assert_xpath '/article/info/copyright/holder[text()="ACME, Inc."]', output, 1
assert_xpath '/article/info/copyright/year', output, 1
assert_xpath '/article/info/copyright/year[text()="1956"]', output, 1
end
test 'should populate copyright element in DocBook output if copyright attribute is defined with year range' do
input = <<~'EOS'
= Jet Bike
:copyright: ACME, Inc. 1956-2018
Essential for catching road runners.
EOS
output = convert_string input, backend: 'docbook5'
assert_xpath '/article/info/copyright', output, 1
assert_xpath '/article/info/copyright/holder[text()="ACME, Inc."]', output, 1
assert_xpath '/article/info/copyright/year', output, 1
assert_xpath '/article/info/copyright/year[text()="1956-2018"]', output, 1
end
test 'with header footer' do
doc = document_from_string "= Title\n\nparagraph"
refute doc.attr?('embedded')
result = doc.convert
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="content"]', result, 1
end
test 'does not output footer if nofooter is set' do
input = <<~'EOS'
:nofooter:
content
EOS
result = convert_string input
assert_xpath '//*[@id="footer"]', result, 0
end
test 'can disable last updated in footer' do
doc = document_from_string "= Document Title\n\npreamble", attributes: { 'last-update-label!' => '' }
result = doc.convert
assert_xpath '//*[@id="footer-text"]', result, 1
assert_xpath '//*[@id="footer-text"][normalize-space(text())=""]', result, 1
end
test 'should create embedded document if standalone option passed to constructor is false' do
doc = (Asciidoctor::Document.new "= Document Title\n\ncontent", standalone: false).parse
assert doc.attr?('embedded')
result = doc.convert
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 0
assert_xpath '/*[@id="header"]', result, 0
assert_xpath '/*[@id="footer"]', result, 0
assert_xpath '/*[@class="paragraph"]', result, 1
end
test 'should create embedded document if standalone option passed to convert method is false' do
doc = (Asciidoctor::Document.new "= Document Title\n\ncontent", standalone: true).parse
refute doc.attr?('embedded')
result = doc.convert standalone: false
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 1
assert_xpath '/*[@id="header"]', result, 0
assert_xpath '/*[@id="footer"]', result, 0
assert_xpath '/*[@class="paragraph"]', result, 1
end
test 'should create embedded document if deprecated header_footer option is false' do
doc = (Asciidoctor::Document.new "= Document Title\n\ncontent", header_footer: false).parse
assert doc.attr?('embedded')
result = doc.convert
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 0
assert_xpath '/*[@id="header"]', result, 0
assert_xpath '/*[@id="footer"]', result, 0
assert_xpath '/*[@class="paragraph"]', result, 1
end
test 'should create embedded document if header_footer option passed to convert method is false' do
doc = (Asciidoctor::Document.new "= Document Title\n\ncontent", header_footer: true).parse
refute doc.attr?('embedded')
result = doc.convert header_footer: false
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 1
assert_xpath '/*[@id="header"]', result, 0
assert_xpath '/*[@id="footer"]', result, 0
assert_xpath '/*[@class="paragraph"]', result, 1
end
test 'enable title in embedded document by unassigning notitle attribute' do
input = <<~'EOS'
= Document Title
content
EOS
result = convert_string_to_embedded input, 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 '/*[@class="paragraph"]', result, 1
assert_xpath '(/*)[1]/self::h1', result, 1
assert_xpath '(/*)[2]/self::*[@class="paragraph"]', result, 1
end
test 'should be able to enable doctitle for embedded document' do
[
[{ 'notitle' => nil }, nil],
[{ 'notitle' => nil }, [':!showtitle:']],
[{ 'notitle' => false }, nil],
[{ 'notitle' => '@' }, [':!notitle:']],
[{ 'notitle' => '@' }, [':showtitle:']],
[{ 'showtitle' => '' }, [':notitle:']],
[{ 'showtitle' => '@' }, nil],
[{ 'showtitle' => false }, [':!notitle:']],
[{}, [':!notitle:']],
[{}, [':notitle:', ':showtitle:']],
[{}, [':showtitle:']],
[{}, [':!showtitle:', ':!notitle:']],
].each do |api_attrs, attr_entries|
input = <<~EOS
= Document Title#{attr_entries ? ?\n + (attr_entries.join ?\n) : ''}
ifdef::showtitle[showtitle: set]
ifndef::showtitle[showtitle: not set]
ifdef::notitle[notitle: set]
ifndef::notitle[notitle: not set]
EOS
result = convert_string_to_embedded input, attributes: api_attrs
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 1
assert_xpath '(/*)[1]/self::h1', result, 1
assert_xpath '(/*)[2]/self::*[@class="paragraph"]', result, 1
# NOTE showtitle may not match notitle if never used
assert_includes result, 'notitle: not set'
end
end
test 'should be able to explicitly disable doctitle for embedded document' do
[
[{ 'notitle' => '' }, nil],
[{ 'notitle' => '@' }, nil],
[{ 'notitle' => '@' }, [':!showtitle:']],
[{ 'showtitle' => nil }, nil],
[{ 'showtitle' => false }, nil],
[{ 'showtitle' => '@' }, [':notitle:']],
[{}, [':notitle:']],
[{}, [':!showtitle:']],
[{}, [':!showtitle:', ':notitle:']],
].each do |api_attrs, attr_entries|
input = <<~EOS
= Document Title#{attr_entries ? ?\n + (attr_entries.join ?\n) : ''}
ifdef::showtitle[showtitle: set]
ifndef::showtitle[showtitle: not set]
ifdef::notitle[notitle: set]
ifndef::notitle[notitle: not set]
EOS
result = convert_string_to_embedded input, attributes: api_attrs
assert_xpath '/html', result, 0
assert_xpath '/h1', result, 0
assert_xpath '/*[@class="paragraph"]', result, 1
# NOTE showtitle may not match notitle if never used
assert_includes result, 'notitle: set'
end
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 'should parse header only when docytpe is manpage' do
input = <<~'EOS'
= cmd(1)
Author Name
:doctype: manpage
== Name
cmd - does stuff
EOS
doc = document_from_string input, parse_header_only: true
assert_equal 'cmd(1)', doc.doctitle
assert_equal 'Author Name', doc.author
assert_equal 'cmd', doc.attributes['mantitle']
assert_equal '1', doc.attributes['manvolnum']
assert_nil doc.attributes['manname']
assert_nil doc.attributes['manpurpose']
assert_equal 0, doc.blocks.size
end
test 'should not warn when parsing header only when docytpe is manpage and body is empty' do
input = <<~'EOS'
= cmd(1)
Author Name
:doctype: manpage
EOS
using_memory_logger do |logger|
doc = document_from_string input, parse_header_only: true
assert_empty logger.messages
assert_equal 'cmd(1)', doc.doctitle
assert_equal 'Author Name', doc.author
assert_equal 'cmd', doc.attributes['mantitle']
assert_equal '1', doc.attributes['manvolnum']
assert_nil doc.attributes['manname']
assert_nil doc.attributes['manpurpose']
assert_equal 0, doc.blocks.size
end
end
test 'outputs footnotes in footer' do
input = <<~'EOS'
A footnote footnote:[An example footnote.];
a second footnote with a reference ID footnote:note2[Second footnote.];
and finally a reference to the second footnote footnote:note2[].
EOS
output = convert_string input
assert_css '#footnotes', output, 1
assert_css '#footnotes .footnote', output, 2
assert_css '#footnotes .footnote#_footnotedef_1', output, 1
assert_xpath '//div[@id="footnotes"]/div[@id="_footnotedef_1"]/a[@href="#_footnoteref_1"][text()="1"]', output, 1
text = xmlnodes_at_xpath '//div[@id="footnotes"]/div[@id="_footnotedef_1"]/text()', output
assert_equal '. An example footnote.', text.text.strip
assert_css '#footnotes .footnote#_footnotedef_2', output, 1
assert_xpath '//div[@id="footnotes"]/div[@id="_footnotedef_2"]/a[@href="#_footnoteref_2"][text()="2"]', output, 1
text = xmlnodes_at_xpath '//div[@id="footnotes"]/div[@id="_footnotedef_2"]/text()', output
assert_equal '. Second footnote.', text.text.strip
end
test 'outputs footnotes block in embedded document by default' do
input = 'Text that has supporting information{empty}footnote:[An example footnote.].'
output = convert_string_to_embedded input
assert_css '#footnotes', output, 1
assert_css '#footnotes .footnote', output, 1
assert_css '#footnotes .footnote#_footnotedef_1', output, 1
assert_xpath '/div[@id="footnotes"]/div[@id="_footnotedef_1"]/a[@href="#_footnoteref_1"][text()="1"]', output, 1
text = xmlnodes_at_xpath '/div[@id="footnotes"]/div[@id="_footnotedef_1"]/text()', output
assert_equal '. An example footnote.', text.text.strip
end
test 'does not output footnotes block in embedded document if nofootnotes attribute is set' do
input = 'Text that has supporting information{empty}footnote:[An example footnote.].'
output = convert_string_to_embedded input, attributes: { 'nofootnotes' => '' }
assert_css '#footnotes', output, 0
end
end
context 'Catalog' do
test 'should alias document catalog as document references' do
input = <<~'EOS'
= Document Title
== Section A
Content
== Section B
Content.footnote:[commentary]
EOS
doc = document_from_string input
refute_nil doc.catalog
#assert_equal [:footnotes, :ids, :images, :includes, :indexterms, :links, :refs, :callouts].sort, doc.catalog.keys.sort
assert_equal [:footnotes, :ids, :images, :includes, :links, :refs, :callouts].sort, doc.catalog.keys.sort
assert_same doc.catalog, doc.references
assert_same doc.catalog[:footnotes], doc.references[:footnotes]
assert_same doc.catalog[:refs], doc.references[:refs]
assert_equal '_section_a', (doc.resolve_id 'Section A')
end
test 'should return empty :ids table' do
doc = empty_document
refute_nil doc.catalog[:ids]
assert_empty doc.catalog[:ids]
assert_nil doc.catalog[:ids]['foobar']
end
test 'should register entry in :refs table with reftext when request is made to register entry in :ids table' do
doc = empty_document
doc.register :ids, ['foobar', 'Foo Bar']
assert_empty doc.catalog[:ids]
refute_empty doc.catalog[:refs]
ref = doc.catalog[:refs]['foobar']
assert_equal 'Foo Bar', ref.reftext
assert_equal 'foobar', (doc.resolve_id 'Foo Bar')
end
test 'should record imagesdir when image is registered with catalog' do
doc = empty_document attributes: { 'imagesdir' => 'img' }, catalog_assets: true
doc.register :images, 'diagram.svg'
assert_equal doc.catalog[:images].size, 1
assert_equal 'diagram.svg', doc.catalog[:images][0].target
assert_equal 'img', doc.catalog[:images][0].imagesdir
end
test 'should catalog assets inside nested document' do
input = <<~'EOS'
image::outer.png[]
|===
a|
image::inner.png[]
|===
EOS
doc = document_from_string input, catalog_assets: true
images = doc.catalog[:images]
refute_empty images
assert_equal 2, images.size
assert_equal images.map(&:target), ['outer.png', 'inner.png']
end
end
context 'Backends and Doctypes' do
test 'html5 backend doctype article' do
result = convert_string("= Title\n\nparagraph", 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="content"]//p[text()="paragraph"]', result, 1
end
test 'html5 backend doctype book' do
result = convert_string("= Title\n\nparagraph", 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="content"]//p[text()="paragraph"]', result, 1
end
test 'xhtml5 backend should map to html5 and set htmlsyntax to xml' do
input = 'content'
doc = document_from_string input, backend: :xhtml5
assert_equal 'html5', doc.backend
assert_equal 'xml', (doc.attr 'htmlsyntax')
end
test 'xhtml backend should map to html5 and set htmlsyntax to xml' do
input = 'content'
doc = document_from_string input, backend: :xhtml
assert_equal 'html5', doc.backend
assert_equal 'xml', (doc.attr 'htmlsyntax')
end
test 'honor htmlsyntax attribute passed via API if backend is html' do
input = '---'
doc = document_from_string input, safe: :safe, attributes: { 'htmlsyntax' => 'xml' }
assert_equal 'html5', doc.backend
assert_equal 'xml', (doc.attr 'htmlsyntax')
result = doc.convert standalone: false
assert_equal '<hr/>', result
end
test 'honor htmlsyntax attribute in document header if followed by backend attribute' do
input = <<~'EOS'
:htmlsyntax: xml
:backend: html5
---
EOS
doc = document_from_string input, safe: :safe
assert_equal 'html5', doc.backend
assert_equal 'xml', (doc.attr 'htmlsyntax')
result = doc.convert standalone: false
assert_equal '<hr/>', result
end
test 'does not honor htmlsyntax attribute in document header if not followed by backend attribute' do
input = <<~'EOS'
:backend: html5
:htmlsyntax: xml
---
EOS
result = convert_string_to_embedded input, safe: :safe
assert_equal '<hr>', result
end
test 'should close all short tags when htmlsyntax is xml' do
input = <<~'EOS'
= Document Title
Author Name
v1.0, 2001-01-01
:icons:
:favicon:
image:tiger.png[]
image::tiger.png[]
* [x] one
* [ ] two
|===
|A |B
|===
[horizontal, labelwidth="25%", itemwidth="75%"]
term:: description
NOTE: note
[quote,Author,Source]
____
Quote me.
____
[verse,Author,Source]
____
A tall tale.
____
[options="autoplay,loop"]
video::screencast.ogg[]
video::12345[vimeo]
[options="autoplay,loop"]
audio::podcast.ogg[]
one +
two
'''
EOS
result = convert_string input, safe: :safe, backend: :xhtml
begin
Nokogiri::XML::Document.parse(result) do |config|
config.options = Nokogiri::XML::ParseOptions::STRICT | Nokogiri::XML::ParseOptions::NONET
end
rescue => e
flunk "xhtml5 backend did not generate well-formed XML: #{e.message}\n#{result}"
end
end
test 'xhtml backend should emit elements in proper namespace' do
input = 'content'
result = convert_string input, safe: :safe, backend: :xhtml, keep_namespaces: true
assert_xpath '//*[not(namespace-uri()="http://www.w3.org/1999/xhtml")]', result, 0
end
test 'should parse out subtitle when backend is DocBook' do
input = <<~'EOS'
= Document Title: Subtitle
:doctype: book
text
EOS
result = convert_string input, backend: 'docbook5'
assert_xpath '/book', result, 1
assert_xpath '/book/info/title[text()="Document Title"]', result, 1
assert_xpath '/book/info/subtitle[text()="Subtitle"]', result, 1
end
test 'should be able to set doctype to article when converting to DocBook' do
input = <<~'EOS'
= Title
Author Name
preamble
== First Section
section body
EOS
result = convert_string(input, keep_namespaces: true, attributes: { 'backend' => 'docbook5' })
assert_xpath '/xmlns:article', result, 1
doc = xmlnodes_at_xpath('/xmlns:article', result, 1)
assert_equal 'http://docbook.org/ns/docbook', doc.namespaces['xmlns']
assert_equal 'http://www.w3.org/1999/xlink', doc.namespaces['xmlns:xl']
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
assert_css 'article:root > section[xml|id="_first_section"]', result, 1
end
test 'should set doctype to article by default for document with no title when converting to DocBook' do
result = convert_string('text', attributes: { 'backend' => 'docbook' })
assert_xpath '/article', result, 1
assert_xpath '/article/info/title', result, 1
assert_xpath '/article/info/title[text()="Untitled"]', result, 1
assert_xpath '/article/info/date', result, 1
end
test 'should be able to convert DocBook manpage output when backend is DocBook and doctype is manpage' do
input = <<~'EOS'
= asciidoctor(1)
:mansource: Asciidoctor
:manmanual: Asciidoctor Manual
== NAME
asciidoctor - Process text
== SYNOPSIS
some text
== First Section
section body
EOS
result = convert_string input, keep_namespaces: true, attributes: { 'backend' => 'docbook5', 'doctype' => 'manpage' }
assert_xpath '/xmlns:article', result, 1
assert_xpath '/xmlns:article/xmlns:refentry', result, 1
doc = xmlnodes_at_xpath '/xmlns:article', result, 1
assert_equal 'http://docbook.org/ns/docbook', doc.namespaces['xmlns']
assert_equal 'http://www.w3.org/1999/xlink', doc.namespaces['xmlns:xl']
assert_equal '5.0', (doc.attr 'version')
assert_xpath '/xmlns:article/xmlns:info/xmlns:title[text()="asciidoctor(1)"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refmeta/xmlns:refentrytitle[text()="asciidoctor"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refmeta/xmlns:manvolnum[text()="1"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refmeta/xmlns:refmiscinfo[@class="source"][text()="Asciidoctor"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refmeta/xmlns:refmiscinfo[@class="manual"][text()="Asciidoctor Manual"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refnamediv/xmlns:refname[text()="asciidoctor"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refnamediv/xmlns:refpurpose[text()="Process text"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refsynopsisdiv', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refsynopsisdiv/xmlns:simpara[text()="some text"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refsection', result, 1
assert_css 'article:root > refentry > refsection[xml|id="_first_section"]', result, 1
end
test 'should output non-breaking space for source and manual in docbook manpage output if absent from source' do
input = <<~'EOS'
= asciidoctor(1)
== NAME
asciidoctor - Process text
== SYNOPSIS
some text
EOS
result = convert_string input, keep_namespaces: true, attributes: { 'backend' => 'docbook5', 'doctype' => 'manpage' }
assert_xpath %(/xmlns:article/xmlns:refentry/xmlns:refmeta/xmlns:refmiscinfo[@class="source"][text()="#{decode_char 160}"]), result, 1
assert_xpath %(/xmlns:article/xmlns:refentry/xmlns:refmeta/xmlns:refmiscinfo[@class="manual"][text()="#{decode_char 160}"]), result, 1
end
test 'should apply replacements substitution to value of mantitle attribute used in DocBook output' do
input = <<~'EOS'
= foo\--bar(1)
Author Name
:doctype: manpage
:man manual: Foo Bar Manual
:man source: Foo Bar 1.0
== NAME
foo--bar - puts the foo in your bar
EOS
doc = Asciidoctor.load input, backend: :docbook, standalone: true
assert_equal 'foo\\--bar', (doc.attr 'mantitle')
result = doc.convert
assert_xpath '/xmlns:article/xmlns:info/xmlns:title[text()="foo--bar(1)"]', result, 1
assert_xpath '/xmlns:article/xmlns:refentry/xmlns:refmeta/xmlns:refentrytitle[text()="foo--bar"]', result, 1
end
test 'should be able to set doctype to book when converting to DocBook' do
input = <<~'EOS'
= Title
Author Name
preamble
== First Chapter
chapter body
EOS
result = convert_string(input, keep_namespaces: true, attributes: { 'backend' => 'docbook5', 'doctype' => 'book' })
assert_xpath '/xmlns:book', result, 1
doc = xmlnodes_at_xpath('/xmlns:book', result, 1)
assert_equal 'http://docbook.org/ns/docbook', doc.namespaces['xmlns']
assert_equal 'http://www.w3.org/1999/xlink', doc.namespaces['xmlns:xl']
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
assert_css 'book:root > chapter[xml|id="_first_chapter"]', result, 1
end
test 'should be able to set doctype to book for document with no title when converting to DocBook' do
result = convert_string('text', attributes: { 'backend' => 'docbook5', 'doctype' => 'book' })
assert_xpath '/book', result, 1
assert_xpath '/book/info/date', result, 1
# NOTE simpara cannot be a direct child of book, so content must be treated as a preface
assert_xpath '/book/preface/simpara[text()="text"]', result, 1
end
test 'adds refname to DocBook output for each name defined in NAME section of manpage' do
input = <<~'EOS'
= eve(1)
Andrew Stanton
v1.0.0
:doctype: manpage
:manmanual: EVE
:mansource: EVE
== NAME
eve, islifeform - analyzes an image to determine if it's a picture of a life form
== SYNOPSIS
*eve* ['OPTION']... 'FILE'...
EOS
result = convert_string input, backend: 'docbook5'
assert_xpath '/article/refentry/refnamediv/refname', result, 2
assert_xpath '(/article/refentry/refnamediv/refname)[1][text()="eve"]', result, 1
assert_xpath '(/article/refentry/refnamediv/refname)[2][text()="islifeform"]', result, 1
end
test 'adds a front and back cover image to DocBook 5 when doctype is book' do
input = <<~'EOS'
= Title
:doctype: book
:imagesdir: images
:front-cover-image: image:front-cover.jpg[scaledwidth=210mm]
:back-cover-image: image:back-cover.jpg[]
preamble
== First Chapter
chapter body
EOS
result = convert_string input, attributes: { 'backend' => 'docbook5' }
assert_xpath '//info/cover[@role="front"]', result, 1
assert_xpath '//info/cover[@role="front"]//imagedata[@fileref="images/front-cover.jpg"]', result, 1
assert_xpath '//info/cover[@role="back"]', result, 1
assert_xpath '//info/cover[@role="back"]//imagedata[@fileref="images/back-cover.jpg"]', result, 1
end
test 'should be able to set backend using :backend option key' do
doc = empty_document backend: 'html5'
assert_equal 'html5', doc.attributes['backend']
end
test ':backend option should override backend attribute' do
doc = empty_document backend: 'html5', attributes: { 'backend' => 'docbook5' }
assert_equal 'html5', doc.attributes['backend']
end
test 'should be able to set doctype using :doctype option key' do
doc = empty_document doctype: 'book'
assert_equal 'book', doc.attributes['doctype']
end
test ':doctype option should override doctype attribute' do
doc = empty_document 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 = convert_string input, attributes: { 'backend' => 'docbook5' }
assert_xpath '/article/info/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 '_name', doc.attr('manname-id')
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
refute_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 = convert_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[@id="_name"][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
test 'should output special header block in embeddable HTML for manpage doctype' do
input = <<~'EOS'
= asciidoctor(1)
:doctype: manpage
:showtitle:
== NAME
asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
== SYNOPSIS
*asciidoctor* ['OPTION']... 'FILE'..
EOS
output = convert_string_to_embedded input
assert_xpath '/h1[text()="asciidoctor(1) Manual Page"]', output, 1
assert_xpath '/h1/following-sibling::h2[text()="NAME"]', output, 1
assert_xpath '/h2[@id="_name"][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
end
test 'should output all mannames in name section in man page output' do
input = <<~'EOS'
= eve(1)
:doctype: manpage
== NAME
eve, probe - analyzes an image to determine if it is a picture of a life form
== SYNOPSIS
*eve* [OPTION]... FILE...
EOS
output = convert_string input
assert_css 'body.manpage', output, 1
assert_xpath '//h2[text()="NAME"]/following-sibling::*[@class="sectionbody"]/p[text()="eve, probe - analyzes an image to determine if it is a picture of a life form"]', output, 1
end
end
context 'Secure Asset Path' do
test 'allows us to specify a path relative to the current dir' do
doc = empty_document
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"
using_memory_logger do |logger|
doc = empty_document
secure_path = doc.normalize_asset_path naughty_path
refute_equal naughty_path, secure_path
assert_equal ::File.join(doc.base_dir, 'etc/passwd'), secure_path
assert_message logger, :WARN, 'path is outside of jail; recovering automatically'
end
end
test 'keeps naughty relative paths from getting outside' do
naughty_path = 'safe/ok/../../../../../etc/passwd'
using_memory_logger do
doc = empty_document
secure_path = doc.normalize_asset_path naughty_path
refute_equal naughty_path, secure_path
assert_match(/^#{doc.base_dir}/, secure_path)
end
end
test 'should raise an exception when a converter cannot be resolved before conversion' do
input = <<~'EOS'
= Document Title
text
EOS
exception = assert_raises NotImplementedError do
Asciidoctor.convert input, backend: 'unknownBackend'
end
assert_includes exception.message, 'missing converter for backend \'unknownBackend\''
end
test 'should raise an exception when a converter cannot be resolved while parsing' do
input = <<~'EOS'
= Document Title
== A _Big_ Section
text
EOS
exception = assert_raises NotImplementedError do
Asciidoctor.convert input, backend: 'unknownBackend'
end
assert_includes exception.message, 'missing converter for backend \'unknownBackend\''
end
end
context 'Timing report' do
test 'print_report does not lose precision' do
timings = Asciidoctor::Timings.new
log = timings.instance_variable_get(:@log)
log[:read] = 0.00001
log[:parse] = 0.00003
log[:convert] = 0.00005
timings.print_report(sink = StringIO.new)
expect = ['0.00004', '0.00005', '0.00009']
result = sink.string.split("\n").map {|l| l.sub(/.*:\s*([\d.]+)/, '\1') }
assert_equal expect, result
end
test 'print_report should print 0 for untimed phases' do
Asciidoctor::Timings.new.print_report(sink = StringIO.new)
expect = [].fill('0.00000', 0..2)
result = sink.string.split("\n").map {|l| l.sub(/.*:\s*([\d.]+)/, '\1') }
assert_equal expect, result
end
end
context 'Date time attributes' do
test 'should compute docyear and docdatetime from docdate and doctime' do
doc = Asciidoctor::Document.new [], attributes: { 'docdate' => '2015-01-01', 'doctime' => '10:00:00-0700' }
assert_equal '2015-01-01', (doc.attr 'docdate')
assert_equal '2015', (doc.attr 'docyear')
assert_equal '10:00:00-0700', (doc.attr 'doctime')
assert_equal '2015-01-01 10:00:00-0700', (doc.attr 'docdatetime')
end
test 'should allow docdate and doctime to be overridden' do
doc = Asciidoctor::Document.new [], input_mtime: ::Time.now, attributes: { 'docdate' => '2015-01-01', 'doctime' => '10:00:00-0700' }
assert_equal '2015-01-01', (doc.attr 'docdate')
assert_equal '2015', (doc.attr 'docyear')
assert_equal '10:00:00-0700', (doc.attr 'doctime')
assert_equal '2015-01-01 10:00:00-0700', (doc.attr 'docdatetime')
end
test 'should compute docdatetime from doctime' do
doc = Asciidoctor::Document.new [], attributes: { 'doctime' => '10:00:00-0700' }
assert_equal '10:00:00-0700', (doc.attr 'doctime')
assert (doc.attr 'docdatetime').end_with?(' 10:00:00-0700')
end
test 'should compute docyear from docdate' do
doc = Asciidoctor::Document.new [], attributes: { 'docdate' => '2015-01-01' }
assert_equal '2015', (doc.attr 'docyear')
assert (doc.attr 'docdatetime').start_with?('2015-01-01 ')
end
test 'should allow doctime to be overridden' do
old_source_date_epoch = ENV.delete 'SOURCE_DATE_EPOCH'
begin
doc = Asciidoctor::Document.new [], input_mtime: ::Time.new(2019, 1, 2, 3, 4, 5, "+06:00"), attributes: { 'doctime' => '10:00:00-0700' }
assert_equal '2019-01-02', (doc.attr 'docdate')
assert_equal '2019', (doc.attr 'docyear')
assert_equal '10:00:00-0700', (doc.attr 'doctime')
assert_equal '2019-01-02 10:00:00-0700', (doc.attr 'docdatetime')
ensure
ENV['SOURCE_DATE_EPOCH'] = old_source_date_epoch if old_source_date_epoch
end
end
test 'should allow docdate to be overridden' do
old_source_date_epoch = ENV.delete 'SOURCE_DATE_EPOCH'
begin
doc = Asciidoctor::Document.new [], input_mtime: ::Time.new(2019, 1, 2, 3, 4, 5, "+06:00"), attributes: { 'docdate' => '2015-01-01' }
assert_equal '2015-01-01', (doc.attr 'docdate')
assert_equal '2015', (doc.attr 'docyear')
assert_equal '2015-01-01 03:04:05 +0600', (doc.attr 'docdatetime')
ensure
ENV['SOURCE_DATE_EPOCH'] = old_source_date_epoch if old_source_date_epoch
end
end
end
end
|