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
|
# frozen_string_literal: true
require_relative 'spec_helper'
describe 'Asciidoctor::PDF::Converter - Title Page' do
context 'book doctype' do
it 'should not include title page if notitle attribute is set' do
pdf = to_pdf <<~'EOS', doctype: :book, analyze: :page
= Document Title
:notitle:
body
EOS
(expect pdf.pages).to have_size 1
(expect pdf.pages[0][:strings]).not_to include 'Document Title'
end
it 'should not include title page if title_page key in theme is false' do
pdf = to_pdf <<~'EOS', doctype: :book, pdf_theme: { title_page: false }, analyze: :page
= Document Title
body
EOS
(expect pdf.pages).to have_size 1
(expect pdf.pages[0][:strings]).not_to include 'Document Title'
end
it 'should not include title page if showtitle attribute is unset when Asciidoctor >= 2.0.11' do
pdf = to_pdf <<~'EOS', doctype: :book, analyze: :page
= Document Title
:!showtitle:
body
EOS
if (Gem::Version.new Asciidoctor::VERSION) >= (Gem::Version.new '2.0.11')
(expect pdf.pages[0][:strings]).not_to include 'Document Title'
else
(expect pdf.pages[0][:strings]).to include 'Document Title'
end
end
it 'should place document title on title page when doctype is book' do
pdf = to_pdf <<~'EOS', doctype: :book, analyze: true
= Document Title
body
EOS
(expect pdf.pages).to have_size 2
text = pdf.text
(expect text).to have_size 2
(expect pdf.pages[0][:text]).to have_size 1
doctitle_text = pdf.pages[0][:text][0]
(expect doctitle_text[:string]).to eql 'Document Title'
(expect doctitle_text[:font_size]).to be 27
(expect pdf.pages[1][:text]).to have_size 1
end
it 'should create book with only a title page if doctitle is specified and body is empty' do
pdf = to_pdf '= Title Page Only', doctype: :book, analyze: true
(expect pdf.pages).to have_size 1
(expect pdf.lines).to eql ['Title Page Only']
end
it 'should include revision number, date, and remark on title page' do
pdf = to_pdf <<~'EOS', analyze: true
= Document Title
Author Name
v1.0, 2019-01-01: Draft
:doctype: book
EOS
(expect pdf.lines).to include 'Version 1.0, 2019-01-01: Draft'
end
it 'should display author names under document title on title page' do
pdf = to_pdf <<~'EOS', analyze: true
= Document Title
Doc Writer; Antonín Dvořák
:doctype: book
body
EOS
title_page_lines = pdf.lines pdf.find_text page_number: 1
(expect title_page_lines).to eql ['Document Title', 'Doc Writer, Antonín Dvořák']
end
it 'should not overwrite url property when promoting authors for use on title page' do
pdf_theme = {
title_page_authors_content_with_email: '{author} // {email}',
title_page_authors_content_with_url: '{author} // {url}',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
Doc Writer <https://example.org/doc>; Junior Writer <jr@example.org>
:doctype: book
:url: https://opensource.org
{url}
EOS
title_page_lines = pdf.lines pdf.find_text page_number: 1
(expect title_page_lines).to eql ['Document Title', 'Doc Writer // https://example.org/doc, Junior Writer // jr@example.org']
body_lines = pdf.lines pdf.find_text page_number: 2
(expect body_lines).to eql %w(https://opensource.org)
end
it 'should not carry over url from one author to the next' do
pdf_theme = { title_page_authors_content_with_url: '{author} // {url}' }
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
Doc Writer <https://example.org/doc>; Junior Writer
:doctype: book
:url: https://opensource.org
{url}
EOS
title_page_lines = pdf.lines pdf.find_text page_number: 1
(expect title_page_lines).to eql ['Document Title', 'Doc Writer // https://example.org/doc, Junior Writer']
body_lines = pdf.lines pdf.find_text page_number: 2
(expect body_lines).to eql %w(https://opensource.org)
end
it 'should apply base font style when document has title page' do
pdf = to_pdf <<~'EOS', pdf_theme: { base_font_style: 'bold' }, analyze: true
= Document Title
Author Name
v1.0, 2020-01-01
:doctype: book
bold body
EOS
(expect pdf.pages).to have_size 2
(expect pdf.text.map {|it| it[:font_name] }.uniq).to eql %w(NotoSerif-Bold)
end
end
context 'title-page attribute' do
it 'should not include title page if notitle attribute is set' do
pdf = to_pdf <<~'EOS', analyze: :page
= Document Title
:title-page:
:notitle:
what's it gonna do?
EOS
(expect pdf.pages).to have_size 1
(expect pdf.pages[0][:strings]).not_to include 'Document Title'
end
it 'should place document title on title page if title-page attribute is set' do
pdf = to_pdf <<~'EOS', analyze: :page
= Document Title
:title-page:
body
EOS
(expect pdf.pages).to have_size 2
(expect pdf.pages[0][:strings]).to include 'Document Title'
(expect pdf.pages[1][:strings]).to include 'body'
end
it 'should create document with only a title page if body is empty and title-page is set' do
pdf = to_pdf '= Title Page Only', attribute_overrides: { 'title-page' => '' }, analyze: true
(expect pdf.pages).to have_size 1
(expect pdf.lines).to eql ['Title Page Only']
end
end
context 'Logo' do
it 'should add logo specified by title-logo-image document attribute to title page' do
pdf = to_pdf <<~'EOS'
= Document Title
:doctype: book
:title-logo-image: image:tux.png[]
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
it 'should not add border to raster logo image if border is specified for image block in theme' do
pdf_theme = { image_border_width: 1, image_border_color: '000000' }
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: :line
= Document Title
:doctype: book
:title-logo-image: image:tux.png[]
content
EOS
(expect pdf.lines).to be_empty
end
it 'should not add border to SVG logo image if border is specified for image block in theme' do
pdf_theme = { image_border_width: 1, image_border_color: '0000EE' }
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: :line
= Document Title
:doctype: book
:title-logo-image: image:square.svg[]
content
EOS
image_border_lines = pdf.lines.select {|it| it[:color] == '0000EE' }
(expect image_border_lines).to be_empty
end
it 'should add remote logo specified by title-logo-image document attribute to title page' do
with_local_webserver do |base_url|
[%(#{base_url}/tux.png), %(image:#{base_url}/tux.png[])].each do |image_url|
pdf = to_pdf <<~EOS, attribute_overrides: { 'allow-uri-read' => '' }
= Document Title
:doctype: book
:title-logo-image: #{image_url}
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
end
end
it 'should add logo specified by title-logo-image document attribute with data URI to title page' do
image_data = File.binread fixture_file 'tux.png'
encoded_image_data = [image_data].pack 'm0'
image_url = %(image:data:image/jpg;base64,#{encoded_image_data}[])
pdf = to_pdf <<~EOS
= Document Title
:doctype: book
:title-logo-image: #{image_url}
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
it 'should use image format for title logo specified by format attribute' do
source_file = (dest_file = fixture_file 'square') + '.svg'
FileUtils.cp source_file, dest_file
pdf = to_pdf <<~EOS, enable_footer: true, analyze: :rect
= Document Title
:title-page:
:title-logo-image: image:#{dest_file}[format=svg]
EOS
(expect pdf.rectangles).to have_size 1
rect = pdf.rectangles[0]
(expect rect[:width]).to eql 200.0
(expect rect[:height]).to eql 200.0
ensure
File.unlink dest_file
end
it 'should not allow PDF to be used as title logo image' do
(expect do
pdf = to_pdf <<~'EOS'
= Document Title
:doctype: book
:title-logo-image: image:red-green-blue.pdf[page=1]
EOS
# QUESTION: should we validate page background color?
(expect pdf.pages).to have_size 1
end).to log_message severity: :ERROR, message: '~PDF format not supported for title page logo image'
end
it 'should position logo using value of top attribute with vh units on image macro in title-logo-image attribute' do
pdf = to_pdf <<~'EOS', analyze: :image
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left,top=0vh]
EOS
left_margin = 0.67 * 72
page_height = 841.89 # ~11.69in
images = pdf.images
(expect images).to have_size 1
title_page_image = images[0]
(expect title_page_image[:x]).to eql left_margin
(expect title_page_image[:y]).to eql page_height
end
it 'should position logo using value of top attribute with in units on image macro in title-logo-image attribute' do
pdf = to_pdf <<~'EOS', analyze: :image
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left,top=1in]
EOS
left_margin = 0.67 * 72
top_margin = 0.5 * 72
page_height = 841.89 # ~11.69in
images = pdf.images
(expect images).to have_size 1
title_page_image = images[0]
(expect title_page_image[:x]).to eql left_margin
(expect title_page_image[:y]).to eql (page_height - top_margin - 72)
end
it 'should position logo using value of top attribute with unrecognized units on image macro in title-logo-image attribute' do
pdf = to_pdf <<~'EOS', analyze: :image
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left,top=1ft]
EOS
left_margin = 0.67 * 72
top_margin = 0.5 * 72
page_height = 841.89 # ~11.69in
images = pdf.images
(expect images).to have_size 1
title_page_image = images[0]
(expect title_page_image[:x]).to eql left_margin
(expect title_page_image[:y]).to eql (page_height - top_margin - 1)
end
it 'should align logo using value of align attribute specified on image macro', visual: true do
to_file = to_pdf_file <<~'EOS', 'title-page-logo-align-attribute.pdf'
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left]
EOS
(expect to_file).to visually_match 'title-page-logo-align-left.pdf'
end
it 'should inherit align value from title page if align not specified on logo in theme' do
pdf_theme = {
title_page_logo_align: nil,
title_page_text_align: 'center',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: :image
= Document Title
:doctype: book
:title-logo-image: image:tux.png[]
EOS
images = pdf.images
(expect images).to have_size 1
(expect images[0][:x]).to be > 48.24
end
it 'should inherit align attribute if value on macro is invalid' do
pdf_theme = {
title_page_logo_align: nil,
title_page_text_align: 'left',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: :image
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=foo]
EOS
images = pdf.images
(expect images).to have_size 1
(expect images[0][:x]).to eql 48.24
end
it 'should allow left margin to be set for left-aligned logo image' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_logo_margin_left: 10 }, analyze: :image
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left]
EOS
left_margin = 0.67 * 72
images = pdf.images
(expect images).to have_size 1
title_page_image = images[0]
(expect title_page_image[:page_number]).to be 1
(expect title_page_image[:x]).to eql left_margin + 10.0
end
it 'should allow right margin to be set for right-aligned logo image' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_logo_margin_right: 10 }, analyze: :image
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=right]
EOS
right_margin = (8.27 - 0.67) * 72
images = pdf.images
(expect images).to have_size 1
title_page_image = images[0]
(expect title_page_image[:page_number]).to be 1
(expect title_page_image[:x]).to be_within(0.5).of(right_margin - 10.0 - title_page_image[:width])
end
it 'should resize raster logo to keep it on title page' do
pdf = to_pdf <<~'EOS', analyze: :image
= Document Title
:title-page:
:title-logo-image: image:cover.jpg[pdfwidth=100%,top=70%]
content
EOS
(expect pdf.page_count).to eql 2
images = pdf.images
(expect images).to have_size 1
logo_image = images[0]
(expect logo_image[:page_number]).to be 1
(expect logo_image[:y]).to be < 300
end
it 'should resize SVG logo to keep it on title page' do
pdf = to_pdf <<~'EOS', analyze: :line
= Document Title
:title-page:
:title-logo-image: image:red-blue-squares.svg[pdfwidth=50%,top=70%]
content
EOS
(expect pdf.lines.map {|it| it[:page_number] }.uniq).to eql [1]
end
end
context 'Background' do
it 'should set background image of title page from title-page-background-image attribute' do
pdf = to_pdf <<~'EOS'
= The Amazing
Author Name
:doctype: book
:title-page-background-image: image:bg.png[]
beginning
<<<
middle
<<<
end
EOS
(expect pdf.pages).to have_size 4
[1, 0, 0, 0].each_with_index do |expected_num_images, idx|
images = get_images pdf, idx.next
(expect images).to have_size expected_num_images
end
end
it 'should set background image of title page when document has image cover page' do
pdf = to_pdf <<~'EOS'
= The Amazing
Author Name
:doctype: book
:front-cover-image: image:cover.jpg[]
:title-page-background-image: image:bg.png[]
beginning
<<<
middle
<<<
end
EOS
(expect pdf.pages).to have_size 5
[1, 1, 0, 0, 0].each_with_index do |expected_num_images, idx|
images = get_images pdf, idx.next
(expect images).to have_size expected_num_images
end
end
it 'should set background image of title page and body pages when document has PDF cover page' do
pdf = to_pdf <<~'EOS'
= The Amazing
Author Name
:doctype: book
:front-cover-image: image:blue-letter.pdf[]
:title-page-background-image: image:tux.png[]
:page-background-image: image:bg.png[]
beginning
<<<
middle
<<<
end
EOS
images_by_page = []
(expect pdf.pages).to have_size 5
[0, 1, 1, 1, 1].each_with_index do |expected_num_images, idx|
images = get_images pdf, idx.next
images_by_page << images
(expect images).to have_size expected_num_images
end
(expect images_by_page[1][0].data).not_to eql images_by_page[2][0].data
(expect images_by_page[2..-1].uniq {|it| it[0].data }).to have_size 1
end
it 'should not create extra blank page when document has cover page and raster page background image' do
image_data = File.binread fixture_file 'cover.jpg'
pdf = to_pdf <<~'EOS'
= The Amazing
Author Name
:doctype: book
:front-cover-image: image:blue-letter.pdf[]
:title-page-background-image: image:cover.jpg[]
:page-background-image: image:tux.png[]
EOS
(expect pdf.pages).to have_size 2
images_by_page = []
[0, 1].each_with_index do |expected_num_images, idx|
images = get_images pdf, idx.next
images_by_page << images
(expect images).to have_size expected_num_images
end
(expect images_by_page[1][0].data).to eql image_data
cover_page_contents = pdf.objects[(pdf.page 1).page_object[:Contents][0]].data
(expect (cover_page_contents.split ?\n).slice 0, 3).to eql ['q', '/DeviceRGB cs', '0.0 0.0 1.0 scn']
end
it 'should not create extra blank page when document has cover page and SVG page background image', visual: true do
to_file = to_pdf_file <<~'EOS', 'title-page-background-image-svg-with-cover.pdf'
= The Amazing
Author Name
:doctype: book
:front-cover-image: image:blue-letter.pdf[]
:title-page-background-image: image:example-stamp.svg[]
:page-background-image: image:watermark.svg[]
content
EOS
(expect to_file).to visually_match 'title-page-background-image-svg-with-cover.pdf'
end
it 'should not create extra blank page when document has PDF cover page and doctype is book' do
pdf = to_pdf <<~'EOS', analyze: true
= Document Title
:doctype: book
:front-cover-image: image:red-green-blue.pdf[page=1]
EOS
(expect pdf.pages).to have_size 2
doctitle_text = pdf.find_unique_text 'Document Title'
(expect doctitle_text[:page_number]).to eql 2
end
it 'should be able to set size and position of title page background image', visual: true do
to_file = to_pdf_file <<~'EOS', 'title-page-background-image-size-position.pdf'
= Document Title
:doctype: book
:title-page-background-image: image:tux.png[fit=none,position=bottom left]
content
EOS
(expect to_file).to visually_match 'title-page-background-image-size-position.pdf'
end
end
context 'Theming' do
it 'should allow theme to control margins around elements' do
reference_pdf_theme = {
title_page_authors_margin_top: 5,
title_page_revision_margin_top: 5,
}
pdf_theme = {
title_page_title_margin_top: 10,
title_page_title_margin_bottom: 5,
title_page_subtitle_margin_top: 5,
title_page_subtitle_margin_bottom: 10,
title_page_authors_margin_top: nil,
title_page_authors_margin_bottom: 10,
title_page_revision_margin_top: nil,
title_page_revision_margin_bottom: 10,
}
input = <<~'EOS'
= Document Title: Subtitle
:doctype: book
Author Name
v1.0
EOS
reference_pdf = to_pdf input, pdf_theme: reference_pdf_theme, analyze: true
pdf = to_pdf input, pdf_theme: pdf_theme, analyze: true
reference_title_page_texts = reference_pdf.find_text page_number: 1
title_page_texts = pdf.find_text page_number: 1
(expect title_page_texts[0][:y]).to eql (reference_title_page_texts[0][:y] - 10)
(expect title_page_texts[1][:y]).to eql (reference_title_page_texts[1][:y] - 20)
(expect title_page_texts[2][:y]).to eql (reference_title_page_texts[2][:y] - 25)
(expect title_page_texts[3][:y]).to eql (reference_title_page_texts[3][:y] - 30)
end
it 'should allow theme to customize content of authors line' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_authors_content: '{url}[{author}]' }
= Document Title
Doc Writer <doc@example.org>; Junior Writer <https://github.com/ghost>
:doctype: book
body
EOS
(expect (pdf.page 1).text).to include 'Doc Writer, Junior Writer'
annotations = get_annotations pdf, 1
(expect annotations).to have_size 2
author1_annotation = annotations[0]
(expect author1_annotation[:Subtype]).to be :Link
(expect author1_annotation[:A][:URI]).to eql 'mailto:doc@example.org'
author2_annotation = annotations[1]
(expect author2_annotation[:Subtype]).to be :Link
(expect author2_annotation[:A][:URI]).to eql 'https://github.com/ghost'
end
it 'should normalize whitespace in authors content' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_authors_content: %({url}\n[{author}]) }, analyze: true
= Document Title
Doc Writer <doc@example.org>
:doctype: book
body
EOS
(expect pdf.lines).to include 'mailto:doc@example.org [Doc Writer]'
end
it 'should drop lines with missing attribute reference in authors content' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_authors_content: %(keep: {firstname}\ndrop{no-such-attr}\nkeep: {lastname}) }, analyze: true
= Document Title
Doc Writer <doc@example.org>
:doctype: book
body
EOS
(expect pdf.lines).to include 'keep: Doc keep: Writer'
end
it 'should honor explicit hard line breaks in authors content' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_authors_content: %({firstname} +\n{lastname}) }, analyze: true
= Document Title
Doc Writer <doc@example.org>
:doctype: book
body
EOS
title_page_lines = pdf.lines pdf.find_text page_number: 1
(expect title_page_lines).to eql ['Document Title', 'Doc', 'Writer']
end
it 'should allow author name and email to be placed on separate lines' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_authors_content_with_email: %({author} +\n{email}) }, analyze: true
= Document Title
Doc Writer <doc@example.org>
:doctype: book
body
EOS
title_page_lines = pdf.lines pdf.find_text page_number: 1
(expect title_page_lines).to eql ['Document Title', 'Doc Writer', 'doc@example.org']
end
it 'should allow theme to customize content of authors line by available metadata' do
pdf_theme = {
title_page_authors_content_name_only: '{authorinitials}',
title_page_authors_content_with_email: '{lastname}, {firstname} <{email}>',
title_page_authors_content_with_url: '{url}[{author}]',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title
Doc Writer <doc@example.org>; Junior Writer <https://github.com/ghost>; Jane Doe
:doctype: book
body
EOS
(expect (pdf.page 1).text).to include 'Writer, Doc <doc@example.org>, Junior Writer, JD'
annotations = get_annotations pdf, 1
(expect annotations).to have_size 2
author1_annotation = annotations[0]
(expect author1_annotation[:Subtype]).to be :Link
(expect author1_annotation[:A][:URI]).to eql 'mailto:doc@example.org'
author2_annotation = annotations[1]
(expect author2_annotation[:Subtype]).to be :Link
(expect author2_annotation[:A][:URI]).to eql 'https://github.com/ghost'
end
it 'should allow theme to customize style of link in authors line using custom role' do
pdf_theme = {
role_author_font_color: '00AA00',
title_page_authors_content: '{url}[{author},role=author]',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
Junior Writer <https://github.com/ghost>
:doctype: book
body
EOS
author_text = (pdf.find_text 'Junior Writer')[0]
(expect author_text[:font_color]).to eql '00AA00'
end
it 'should be able to use an icon in an author entry' do
pdf_theme = {
title_page_authors_content: '{author} {url}[icon:twitter[]]',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
Doc Writer <https://twitter.com/asciidoctor>
:icons: font
:doctype: book
body
EOS
title_page_lines = pdf.lines pdf.find_text page_number: 1
(expect title_page_lines).to include %(Doc Writer \uf099)
end
it 'should allow delimiter for authors and revision info to be set' do
pdf_theme = {
title_page_authors_delimiter: ' / ',
title_page_revision_delimiter: ' - ',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
Doc Writer; Junior Writer
v1.0, 2019-01-01
:doctype: book
content
EOS
lines = pdf.lines
(expect lines).to include 'Doc Writer / Junior Writer'
(expect lines).to include 'Version 1.0 - 2019-01-01'
end
it 'should add logo specified by title_page_logo_image theme key to title page' do
pdf_theme = {
__dir__: fixtures_dir,
title_page_logo_image: 'image:tux.png[]',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, attribute_overrides: { 'docdir' => fixtures_dir }
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
it 'should use title page logo image if specified as absolute path' do
%w({docdir}/tux.png image:{docdir}/tux.png[]).each do |title_page_logo_image|
pdf_theme = { title_page_logo_image: title_page_logo_image }
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, attribute_overrides: { 'docdir' => fixtures_dir }
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
end
it 'should resolve title page logo image specified using path in theme relative to themesdir' do
pdf_theme = {
__dir__: fixtures_dir,
title_page_logo_image: 'tux.png',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
it 'should resolve title page logo image specified using path in theme relative to themesdir in classloader', if: RUBY_ENGINE == 'jruby' do
require fixture_file 'pdf-themes.jar'
pdf = to_pdf <<~'EOS', attribute_overrides: { 'pdf-theme' => 'uri:classloader:/pdf-themes/title-page-logo-image-theme.yml' }
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
it 'should resolve title page logo image with absolute path for theme loaded from classloader', if: RUBY_ENGINE == 'jruby' do
require fixture_file 'pdf-themes.jar'
pdf = to_pdf <<~'EOS', attribute_overrides: { 'pdf-theme' => 'uri:classloader:/pdf-themes/title-page-logo-image-from-fixturesdir-theme.yml', 'fixturesdir' => fixtures_dir }
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
it 'should ignore missing attribute reference when resolve title page logo image from theme' do
(expect do
to_pdf <<~'EOS', pdf_theme: { title_page_logo_image: 'image:{no-such-attribute}{attribute-missing}.png[]' }, attribute_overrides: { 'attribute-missing' => 'warn' }
= Document Title
:doctype: book
EOS
end).to log_message severity: :WARN, message: '~skip.png'
end
it 'should add remote logo specified by title_page_logo_image theme key to title page' do
with_local_webserver do |base_url|
[%(#{base_url}/tux.png), %(image:#{base_url}/tux.png[])].each do |image_url|
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_logo_image: image_url }, attribute_overrides: { 'allow-uri-read' => '' }
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
end
end
it 'should add logo specified by title-logo-image document attribute with data URI to title page' do
image_data = File.binread fixture_file 'tux.png'
encoded_image_data = [image_data].pack 'm0'
image_url = %(image:data:image/jpg;base64,#{encoded_image_data}[])
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_logo_image: image_url }
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 204
(expect images[0].hash[:Height]).to be 240
end
it 'should resolve title page logo image from theme relative to themedir' do
pdf_theme = {
__dir__: examples_dir,
title_page_logo_image: 'image:sample-logo.jpg[]',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title
:doctype: book
EOS
images = get_images pdf, 1
(expect images).to have_size 1
(expect images[0].hash[:Width]).to be 331
(expect images[0].hash[:Height]).to be 369
end
it 'should move logo down from top margin of page by % value of title_page_logo_top key' do
[nil, '10%'].each do |top|
pdf_theme = {
title_page_logo_top: top,
}
pdf = to_pdf <<~'EOS', analyze: :image, pdf_theme: pdf_theme
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left]
image::tux.png[]
EOS
left_margin = 0.67 * 72
top_margin = 0.5 * 72
bottom_margin = 0.67 * 72
page_height = 841.89 # ~11.69in
images = pdf.images
(expect images).to have_size 2
title_page_image = images[0]
reference_image = images[1]
(expect title_page_image[:page_number]).to be 1
(expect reference_image[:page_number]).to be 2
(expect title_page_image[:x]).to eql left_margin
(expect title_page_image[:x]).to eql reference_image[:x]
effective_page_height = page_height - top_margin - bottom_margin
expected_top = reference_image[:y] - (effective_page_height * (top.to_f / 100))
(expect title_page_image[:y]).to eql expected_top
end
end
it 'should move logo down from top margin of page by numeric value of title_page_logo_top key' do
pdf_theme = { title_page_logo_top: 20 }
pdf = to_pdf <<~'EOS', analyze: :image, pdf_theme: pdf_theme
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left]
image::tux.png[]
EOS
left_margin = 0.67 * 72
images = pdf.images
(expect images).to have_size 2
title_page_image = images[0]
reference_image = images[1]
(expect title_page_image[:page_number]).to be 1
(expect reference_image[:page_number]).to be 2
(expect title_page_image[:x]).to eql left_margin
(expect title_page_image[:x]).to eql reference_image[:x]
expected_top = reference_image[:y] - 20
(expect title_page_image[:y]).to eql expected_top
end
it 'should move logo down from top margin of page by pt value of title_page_logo_top key' do
pdf_theme = {
title_page_logo_top: '20pt',
}
pdf = to_pdf <<~'EOS', analyze: :image, pdf_theme: pdf_theme
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left]
image::tux.png[]
EOS
left_margin = 0.67 * 72
images = pdf.images
(expect images).to have_size 2
title_page_image = images[0]
reference_image = images[1]
(expect title_page_image[:page_number]).to be 1
(expect reference_image[:page_number]).to be 2
(expect title_page_image[:x]).to eql left_margin
(expect title_page_image[:x]).to eql reference_image[:x]
expected_top = reference_image[:y] - 20
(expect title_page_image[:y]).to eql expected_top
end
it 'should move logo down from top of page by vh value of title_page_logo_top key' do
pdf_theme = {
title_page_logo_top: '5vh',
}
pdf = to_pdf <<~'EOS', analyze: :image, pdf_theme: pdf_theme
= Document Title
:doctype: book
:title-logo-image: image:tux.png[align=left]
EOS
left_margin = 0.67 * 72
page_height = 841.89 # ~11.69in
images = pdf.images
(expect images).to have_size 1
title_page_image = images[0]
(expect title_page_image[:page_number]).to be 1
(expect title_page_image[:x]).to eql left_margin
expected_top = page_height - (page_height * 0.05)
(expect title_page_image[:y]).to eql expected_top
end
it 'should move title down from top margin by % value of title_page_title_top key' do
pdf_theme = {
title_page_title_top: '10%',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
:doctype: book
content
EOS
page_height = 841.89 # ~11.69in
top_margin = 0.5 * 72
bottom_margin = 0.67 * 72
doctitle_text = (pdf.find_text 'Document Title')[0]
(expect doctitle_text[:page_number]).to be 1
effective_page_height = page_height - top_margin - bottom_margin
expected_top = page_height - top_margin - (effective_page_height * 0.10)
(expect doctitle_text[:y] + doctitle_text[:font_size]).to be_within(0.5).of(expected_top)
end
it 'should move title down from top margin by numeric value of title_page_title_top key' do
pdf_theme = { title_page_title_top: 20 }
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
:doctype: book
content
EOS
page_height = 841.89 # ~11.69in
top_margin = 0.5 * 72
doctitle_text = (pdf.find_text 'Document Title')[0]
(expect doctitle_text[:page_number]).to be 1
expected_top = page_height - top_margin - 20
(expect doctitle_text[:y] + doctitle_text[:font_size]).to be_within(0.5).of(expected_top)
end
it 'should move title down from top margin by pt value of title_page_title_top key' do
pdf_theme = {
title_page_title_top: '20pt',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
:doctype: book
content
EOS
page_height = 841.89 # ~11.69in
top_margin = 0.5 * 72
doctitle_text = (pdf.find_text 'Document Title')[0]
(expect doctitle_text[:page_number]).to be 1
expected_top = page_height - top_margin - 20
(expect doctitle_text[:y] + doctitle_text[:font_size]).to be_within(0.5).of(expected_top)
end
it 'should move title down from top of page by vh value of title_page_title_top key' do
pdf_theme = {
title_page_title_top: '0vh',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
:doctype: book
content
EOS
page_height = 841.89 # ~11.69in
doctitle_text = (pdf.find_text 'Document Title')[0]
(expect doctitle_text[:page_number]).to be 1
(expect doctitle_text[:y] + doctitle_text[:font_size]).to be_within(0.5).of(page_height)
end
it 'should allow left margin of elements on title page to be configured' do
input = <<~'EOS'
= Book Title: Bring Out Your Dead Trees
Author Name
v1.0, 2001-01-01
body
EOS
pdf_theme = { title_page_text_align: 'left' }
pdf = to_pdf input, doctype: :book, pdf_theme: pdf_theme, analyze: true
expected_x = (pdf.find_text page_number: 1).map {|it| it[:x] + 10 }
pdf_theme.update \
title_page_title_margin_left: 10,
title_page_subtitle_margin_left: 10,
title_page_authors_margin_left: 10,
title_page_revision_margin_left: 10
pdf = to_pdf input, doctype: :book, pdf_theme: pdf_theme, analyze: true
actual_x = (pdf.find_text page_number: 1).map {|it| it[:x] }
(expect actual_x).to eql expected_x
end
it 'should allow right margin of elements on title page to be configured' do
input = <<~'EOS'
= Book Title: Bring Out Your Dead Trees
Author Name
v1.0, 2001-01-01
body
EOS
pdf = to_pdf input, doctype: :book, analyze: true
expected_x = (pdf.find_text page_number: 1).map {|it| it[:x] - 10 }
pdf_theme = {
title_page_title_margin_right: 10,
title_page_subtitle_margin_right: 10,
title_page_authors_margin_right: 10,
title_page_revision_margin_right: 10,
}
pdf = to_pdf input, doctype: :book, pdf_theme: pdf_theme, analyze: true
actual_x = (pdf.find_text page_number: 1).map {|it| it[:x] }
(expect actual_x).to eql expected_x
end
it 'should be able to set background color of title page', visual: true do
pdf_theme = {
title_page_background_color: '000000',
title_page_title_font_color: 'EFEFEF',
title_page_authors_font_color: 'DBDBDB',
}
to_file = to_pdf_file <<~'EOS', 'title-page-background-color.pdf', pdf_theme: pdf_theme
= Dark and Stormy
Author Name
:doctype: book
body
EOS
(expect to_file).to visually_match 'title-page-background-color.pdf'
end
it 'should set background color when document has PDF cover page' do
pdf = to_pdf <<~'EOS', pdf_theme: { title_page_background_color: 'eeeeee' }
= The Amazing
Author Name
:doctype: book
:front-cover-image: image:blue-letter.pdf[]
:title-page-background-image: none
:page-background-image: image:bg.png[]
beginning
<<<
middle
<<<
end
EOS
images_by_page = []
(expect pdf.pages).to have_size 5
[0, 0, 1, 1, 1].each_with_index do |expected_num_images, idx|
images = get_images pdf, idx.next
images_by_page << images
(expect images).to have_size expected_num_images
end
(expect images_by_page[2..-1].uniq {|it| it[0].data }).to have_size 1
end
it 'should use title page background specified in theme resolved relative to theme dir' do
[true, false].each do |macro|
pdf_theme = {
__dir__: fixtures_dir,
title_page_background_image: (macro ? 'image:bg.png[]' : 'bg.png'),
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title
:doctype: book
content
EOS
(expect pdf.pages).to have_size 2
(expect get_images pdf, 1).to have_size 1
(expect get_images pdf, 2).to have_size 0
end
end
it 'should not use page background on title page if title-page-background-image attribute is set to none' do
pdf_theme = {
title_page_background_image: %(image:#{fixture_file 'bg.png'}[]),
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title
:doctype: book
:title-page-background-image: none
content
EOS
(expect pdf.pages).to have_size 2
(expect get_images pdf).to be_empty
end
it 'should not use page background on title page if page_background is set to none in theme' do
pdf_theme = {
page_background_image: %(image:#{fixture_file 'bg.png'}[]),
title_page_background_image: 'none',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title
:doctype: book
== Chapter 1
content
== Chapter 2
content
EOS
(expect pdf.pages).to have_size 3
(expect get_images pdf, 1).to have_size 0
(expect get_images pdf, 2).to have_size 1
(expect get_images pdf, 3).to have_size 1
end
it 'should allow theme to disable elements on title page' do
pdf_theme = {
title_page_subtitle_display: 'none',
title_page_authors_display: 'none',
title_page_revision_display: 'none',
title_page_logo_display: 'none',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title: Subtitle
:doctype: book
:title-logo-image: image:tux.png[]
Author Name
v1.0, 2020-01-01
first page of content
EOS
(expect pdf.pages).to have_size 2
(expect (pdf.page 1).text).to eql 'Document Title'
(expect get_images pdf, 1).to be_empty
end
it 'should only display subtitle if document has subtitle and title is disabled' do
pdf_theme = {
title_page_title_display: 'none',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title: Subtitle
:doctype: book
first page of content
EOS
title_page_lines = pdf.lines pdf.find_text page_number: 1
(expect title_page_lines).to eql %w(Subtitle)
end
it 'should advanced past title page if all elements are disabled' do
pdf_theme = {
title_page_title_display: 'none',
title_page_subtitle_display: 'none',
title_page_authors_display: 'none',
title_page_revision_display: 'none',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title: Subtitle
:doctype: book
:title-page-background-image: image:cover.jpg[]
Author Name
v1.0, 2020-01-01
first page of content
EOS
(expect pdf.pages).to have_size 2
title_page_text = (pdf.page 1).text
(expect title_page_text).to be_empty
image_data = File.binread fixture_file 'cover.jpg'
title_page_images = get_images pdf, 1
(expect title_page_images).to have_size 1
(expect title_page_images[0].data).to eql image_data
end
it 'should not remove title page if all elements are disabled' do
pdf_theme = {
title_page_title_display: 'none',
title_page_subtitle_display: 'none',
title_page_authors_display: 'none',
title_page_revision_display: 'none',
}
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme
= Document Title: Subtitle
:doctype: book
:title-page-background-image: image:cover.jpg[]
Author Name
v1.0, 2020-01-01
EOS
(expect pdf.pages).to have_size 1
title_page_text = (pdf.page 1).text
(expect title_page_text).to be_empty
image_data = File.binread fixture_file 'cover.jpg'
title_page_images = get_images pdf, 1
(expect title_page_images).to have_size 1
(expect title_page_images[0].data).to eql image_data
end
it 'should truncate contents of title page so it does not exceed the height of a single page' do
pdf_theme = {
title_page_title_top: '50%',
title_page_title_font_size: 92,
title_page_authors_margin_top: 36,
title_page_authors_font_size: 64,
}
pdf = nil
(expect do
pdf = to_pdf <<~'EOS', pdf_theme: pdf_theme, analyze: true
= Document Title
Author Name
v1.0
:doctype: book
== First Chapter
content
EOS
end).to log_message severity: :WARN, message: 'the title page contents has been truncated to prevent it from overrunning the bounds of a single page'
(expect pdf.pages).to have_size 2
author_text = pdf.find_unique_text 'Author Name'
(expect author_text[:page_number]).to eql 1
revision_text = pdf.find_unique_text 'Version 1.0'
(expect revision_text).to be_nil
chapter_title_text = pdf.find_unique_text 'First Chapter'
(expect chapter_title_text[:page_number]).to eql 2
end
end
end
|