AtlatestRepositorysigil-doc

sigil-doc / tree / testtest-glossary.sgl

1(import (sigil test) (sigil string) (sigil doc) (sigil doc publication)
2 (sigil doc print) (sigil doc render html) (sigil doc render typst))
3
4(load "test/fixtures/glossary-lesson.sgd")
5(define lesson document)
6(load "test/fixtures/glossary-page.sgd")
7(define glossary-page document)
8(define publications
9 (list (make-publication-document "lesson" lesson)
10 (make-publication-document "glossary" glossary-page)))
11(define index (build-publication-index publications))
12(define (url-for target)
13 (string-append "/" (publication-target-document-id target) ".html#"
14 (publication-target-id target)))
15(define lesson-html
16 (document->html-fragment lesson (make-html-render-context index "lesson" url-for '() 1)))
17(define glossary-html
18 (document->html-fragment glossary-page (make-html-render-context index "glossary" url-for '() 1)))
19(define print-publication
20 (make-print-publication "Glossary Test" #f '("Course Author") publications '()))
21(define typst (print-publication->typst print-publication))
22(define loc (make-srcloc "glossary-test.sgd" 1 1 0 1))
23(define (substring-index text needle)
24 (let ((limit (- (string-length text) (string-length needle))))
25 (let loop ((i 0))
26 (cond ((> i limit) #f)
27 ((string=? (substring text i (+ i (string-length needle))) needle) i)
28 (else (loop (+ i 1)))))))
29(define (some? predicate values)
30 (and (pair? values)
31 (or (predicate (car values))
32 (some? predicate (cdr values)))))
34(test "terms are publication-wide targets with one generated glossary"
35 (assert-equal 2 (length (publication-index-terms index)))
36 (assert-equal 2
37 (length (filter (lambda (record) (eq? 'term (publication-search-record-kind record)))
38 (publication-index-search-records index))))
39 (let ((target (resolve-logical-reference index "binding")))
40 (assert-equal 'term (publication-target-kind target))
41 (assert-equal "glossary" (publication-target-document-id target)))
42 (assert-error
43 (build-publication-index (list (make-publication-document "lesson" lesson)))))
45(test "lesson definitions stay hidden while term references link to glossary"
46 (assert-true (string-contains? lesson-html "href=\"/glossary.html#binding\""))
47 (assert-true (string-contains? lesson-html "class=\"glossary-term\""))
48 (assert-false (string-contains? lesson-html "links a symbol to a location")))
50(test "HTML glossary is alphabetized and contains only populated letters"
51 (assert-true (string-contains? glossary-html "<h2>B</h2>"))
52 (assert-true (string-contains? glossary-html "<h2>E</h2>"))
53 (assert-true (< (or (substring-index glossary-html "id=\"binding\"") 999999)
54 (or (substring-index glossary-html "id=\"environment\"") 999999)))
55 (assert-false (string-contains? glossary-html "<h2>A</h2>"))
56 (assert-true (string-contains? glossary-html "Also: bindings"))
57 (assert-true (string-contains? glossary-html "collection of bindings")))
59(test "term definition targets and references belong to the rendered glossary document"
60 (let* ((definition-section
61 (make-section "inside-definition"
62 (list (make-term-reference "binding" #f loc))
63 (list (make-paragraph
64 (list (make-text "Definition detail." loc)) loc)) loc))
65 (relocated-term
66 (make-term "relocated" "Relocated" '() (list definition-section) loc))
67 (source-doc
68 (make-document 'chapter "Source" '() (list relocated-term) loc))
69 (extended-publications
70 (append publications
71 (list (make-publication-document "source" source-doc))))
72 (extended-index (build-publication-index extended-publications))
73 (target (resolve-logical-reference extended-index "inside-definition"))
74 (outlines
75 (filter (lambda (record)
76 (string=? "inside-definition"
77 (publication-outline-target-id record)))
78 (publication-index-outlines extended-index)))
79 (searches
80 (filter (lambda (record)
81 (string=? "inside-definition"
82 (publication-search-record-target-id record)))
83 (publication-index-search-records extended-index)))
84 (refs
85 (filter (lambda (record)
86 (string=? "binding"
87 (publication-reference-target-id record)))
88 (publication-index-references extended-index)))
89 (source-html
90 (document->html-fragment source-doc
91 (make-html-render-context extended-index "source" url-for '() 1)))
92 (extended-glossary-html
93 (document->html-fragment glossary-page
94 (make-html-render-context extended-index "glossary" url-for '() 1)))
95 (extended-typst
96 (print-publication->typst
97 (make-print-publication "Extended Glossary" #f '()
98 extended-publications '()))))
99 (assert-equal "glossary" (publication-target-document-id target))
100 (assert-equal "binding" (publication-target-title target))
101 (assert-equal 1 (length outlines))
102 (assert-equal "glossary" (publication-outline-document-id (car outlines)))
103 (assert-equal 3 (publication-outline-depth (car outlines)))
104 (assert-equal 1 (length searches))
105 (assert-equal "glossary" (publication-search-record-document-id (car searches)))
106 (assert-equal "binding" (publication-search-record-title (car searches)))
107 (assert-true
108 (some? (lambda (record)
109 (string=? "glossary" (publication-reference-document-id record)))
110 refs))
111 (assert-false (string-contains? source-html "id=\"inside-definition\""))
112 (assert-true (string-contains? extended-glossary-html "<h2>B</h2>"))
113 (assert-true
114 (string-contains? extended-glossary-html
115 "<h3 id=\"heading-inside-definition\""))
116 (assert-false
117 (string-contains? extended-glossary-html
118 "<h1 id=\"heading-inside-definition\""))
119 (assert-true
120 (string-contains? extended-typst
121 "#heading(level: 3, outlined: true)["))
122 (assert-true (string-contains? extended-typst "] <inside-definition>"))))
124(test "Typst glossary is alphabetized, linked, and copyable"
125 (assert-true (string-contains? typst "#heading(level: 2, outlined: true)[B]"))
126 (assert-true (string-contains? typst ")] <binding>"))
127 (assert-true (string-contains? typst "#link(<binding>)["))
128 (assert-true (string-contains? typst "links a symbol to a location")))
130(test "nested glossary Typst hierarchy is relative to its insertion point"
131 (let* ((nested-glossary-page
132 (make-document 'chapter "Nested Glossary" '()
133 (list (make-section "glossary-container"
134 (list (make-text "Terms" loc))
135 (list (make-glossary loc)) loc)) loc))
136 (nested-documents
137 (list (make-publication-document "lesson" lesson)
138 (make-publication-document "nested-glossary" nested-glossary-page)))
139 (nested-typst
140 (print-publication->typst
141 (make-print-publication "Nested Glossary" #f '()
142 nested-documents '()))))
143 (assert-true
144 (string-contains? nested-typst
145 "#heading(level: 2, outlined: true)[#text(\"Terms\")]"))
146 (assert-true
147 (string-contains? nested-typst
148 "#heading(level: 3, outlined: true)[B]"))
149 (assert-true
150 (string-contains? nested-typst
151 "#heading(level: 4, outlined: false, numbering: none)[#text(\"binding\")]"))))
153(test "duplicates and missing term definitions fail before rendering"
154 (let* ((definition (list (make-paragraph (list (make-text "Duplicate" loc)) loc)))
155 (duplicate (make-term "binding" "Binding again" '() definition loc))
156 (duplicate-doc (make-document 'chapter "Duplicate" '() (list duplicate) loc)))
157 (assert-error
158 (build-publication-index
159 (append publications (list (make-publication-document "duplicate" duplicate-doc))))))
160 (let* ((missing-ref (make-term-reference "missing" #f loc))
161 (paragraph (make-paragraph (list missing-ref) loc))
162 (missing-doc (make-document 'chapter "Missing" '() (list paragraph) loc)))
163 (assert-error
164 (build-publication-index
165 (append publications (list (make-publication-document "missing" missing-doc))))))
166 (let* ((definition (list (make-paragraph (list (make-text "Nested" loc)) loc)))
167 (inner (make-term "inner" "Inner" '() definition loc)))
168 (assert-error (make-term "outer" "Outer" '() (list inner) loc))
169 (assert-error
170 (make-term "outer" "Outer" '()
171 (list (make-admonition 'aside #f (list inner) loc)) loc))))
173(test "term references reject non-term targets"
174 (let* ((ordinary
175 (make-section "ordinary" (list (make-text "Ordinary" loc))
176 (list (make-paragraph
177 (list (make-term-reference "ordinary" #f loc)) loc)) loc))
178 (bad-doc (make-document 'chapter "Bad term reference" '() (list ordinary) loc)))
179 (assert-error
180 (build-publication-index
181 (append publications
182 (list (make-publication-document "bad-term-reference" bad-doc)))))))