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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Foundation
import XCTest
@testable import SwiftDocC
import Markdown
class LinksTests: XCTestCase {
func testMissingBasicRequirements() throws {
do {
let (renderedContent, problems, links) = try parseDirective(Links.self, in: "BookLikeContent") {
"""
@Links(visualStyle: compactGrid)
"""
}
XCTAssertNotNil(links)
XCTAssertEqual(
problems,
["1: warning – org.swift.docc.HasExactlyOneUnorderedList<Links, AnyLink>.InvalidContent"]
)
XCTAssertEqual(renderedContent, [])
}
do {
let (renderedContent, problems, links) = try parseDirective(Links.self, in: "BookLikeContent") {
"""
@Links {
- <doc:MyArticle>
}
"""
}
XCTAssertNil(links)
XCTAssertEqual(
problems,
[
"1: warning – org.swift.docc.HasArgument.visualStyle",
]
)
XCTAssertEqual(renderedContent, [])
}
}
func testInvalidBodyContent() throws {
do {
let (renderedContent, problems, links) = try parseDirective(Links.self, in: "BookLikeContent") {
"""
@Links(visualStyle: compactGrid) {
This is a paragraph of text in 'Links' directive.
And a second paragraph.
}
"""
}
XCTAssertNotNil(links)
XCTAssertEqual(
problems,
[
"1: warning – org.swift.docc.HasExactlyOneUnorderedList<Links, AnyLink>.InvalidContent",
"2: warning – org.swift.docc.HasExactlyOneUnorderedList<Links, AnyLink>.ExtraneousContent",
"4: warning – org.swift.docc.HasExactlyOneUnorderedList<Links, AnyLink>.ExtraneousContent",
]
)
XCTAssertEqual(renderedContent, [])
}
do {
let (renderedContent, problems, links) = try parseDirective(Links.self, in: "BookLikeContent") {
"""
@Links(visualStyle: compactGrid) {
This is a paragraph of text in 'Links' directive.
And a second paragraph preceding a valid link:
- <doc:MyArticle>
}
"""
}
XCTAssertNotNil(links)
XCTAssertEqual(
problems,
[
"2: warning – org.swift.docc.HasExactlyOneUnorderedList<Links, AnyLink>.ExtraneousContent",
"4: warning – org.swift.docc.HasExactlyOneUnorderedList<Links, AnyLink>.ExtraneousContent",
]
)
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.links(RenderBlockContent.Links(
style: .compactGrid,
items: ["doc://org.swift.docc.Book/documentation/BestBook/MyArticle"]
))
]
)
}
do {
let (renderedContent, problems, links) = try parseDirective(Links.self, in: "BookLikeContent") {
"""
@Links(visualStyle: compactGrid) {
- <doc:MyArticle> Link with some trailing content.
}
"""
}
XCTAssertNotNil(links)
XCTAssertEqual(
problems,
[
"2: warning – org.swift.docc.ExtraneousLinksDirectiveItemContent"
]
)
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.links(RenderBlockContent.Links(
style: .compactGrid,
items: [
"doc://org.swift.docc.Book/documentation/BestBook/MyArticle",
]
))
]
)
}
}
func testLinkResolution() throws {
do {
let (renderedContent, problems, links) = try parseDirective(Links.self, in: "BookLikeContent") {
"""
@Links(visualStyle: compactGrid) {
- <doc:MyArticle>
- <doc:TabNavigatorArticle>
- <doc:MyBook>
- <doc:UnknownArticle>
- <doc:MyArticle>
}
"""
}
XCTAssertNotNil(links)
XCTAssertEqual(
problems,
["5: warning – org.swift.docc.unresolvedTopicReference"]
)
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.links(RenderBlockContent.Links(
style: .compactGrid,
items: [
"doc://org.swift.docc.Book/documentation/BestBook/MyArticle",
"doc://org.swift.docc.Book/documentation/BestBook/TabNavigatorArticle",
"doc://org.swift.docc.Book/documentation/MyBook",
"doc://org.swift.docc.Book/documentation/BestBook/MyArticle",
]
))
]
)
}
do {
let (renderedContent, problems, links) = try parseDirective(Links.self, in: "TestBundle") {
"""
@Links(visualStyle: compactGrid) {
- ``MyKit/MyClass``
- ``MyKit/MyClass/myFunction()``
- <doc:TestTutorial>
- <doc:article2>
}
"""
}
XCTAssertNotNil(links)
XCTAssertEqual(problems, [])
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.links(RenderBlockContent.Links(
style: .compactGrid,
items: [
"doc://org.swift.docc.example/documentation/MyKit/MyClass",
"doc://org.swift.docc.example/documentation/MyKit/MyClass/myFunction()",
"doc://org.swift.docc.example/tutorials/Test-Bundle/TestTutorial",
"doc://org.swift.docc.example/documentation/Test-Bundle/article2",
]
))
]
)
}
}
}
|
