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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-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 SwiftDocCTestUtilities
class AutomaticSeeAlsoTests: XCTestCase {
/// Test that a symbol with no authored See Also and with no curated siblings
/// does not have a See Also section.
func testNoSeeAlso() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle") { root in
/// Extension that curates `SideClass`
try """
# ``SideKit``
SideKit module root symbol
## Topics
### Basics
- ``SideClass``
""".write(to: root.appendingPathComponent("documentation/sidekit.md"), atomically: true, encoding: .utf8)
}
// Get a translated render node
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Symbol) as! RenderNode
// Verify there is no See Also
XCTAssertEqual(renderNode.seeAlsoSections.count, 0)
}
/// Test that a symbol with authored See Also and with no curated siblings
/// does include an authored See Also section
func testAuthoredSeeAlso() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle") { root in
/// Extension that curates `SideClass`
try """
# ``SideKit``
SideKit module root symbol
## Topics
### Basics
- ``SideClass``
""".write(to: root.appendingPathComponent("documentation/sidekit.md"), atomically: true, encoding: .utf8)
/// Authored See Also
try """
# ``SideKit/SideClass``
SideClass abstract.
## See Also
- ``SideKit``
""".write(to: root.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
}
// Get a translated render node
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Symbol) as! RenderNode
// Verify there is an authored See Also from markdown
XCTAssertEqual(renderNode.seeAlsoSections.count, 1)
guard renderNode.seeAlsoSections.count == 1 else { return }
XCTAssertEqual(renderNode.seeAlsoSections[0].title, "Related Documentation")
XCTAssertEqual(renderNode.seeAlsoSections[0].identifiers, ["doc://org.swift.docc.example/documentation/SideKit"])
XCTAssertFalse(renderNode.seeAlsoSections[0].generated)
}
/// Test that a symbol with authored See Also and with curated siblings
/// does include both in See Also with authored section first
func testAuthoredAndAutomaticSeeAlso() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle") { root in
/// Extension that curates `SideClass`
try """
# ``SideKit``
SideKit module root symbol
## Topics
### Basics
- ``SideClass``
- <doc:sidearticle>
""".write(to: root.appendingPathComponent("documentation/sidekit.md"), atomically: true, encoding: .utf8)
/// Authored See Also
try """
# ``SideKit/SideClass``
SideClass abstract.
## See Also
- ``SideKit``
""".write(to: root.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
/// Article Sibling
try """
# Side Article
Side Article abstract.
""".write(to: root.appendingPathComponent("documentation/sidearticle.md"), atomically: true, encoding: .utf8)
}
// Get a translated render node
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Symbol) as! RenderNode
// Verify there is an authored See Also & automatically created See Also
XCTAssertEqual(renderNode.seeAlsoSections.count, 2)
guard renderNode.seeAlsoSections.count == 2 else { return }
XCTAssertEqual(renderNode.seeAlsoSections[0].title, "Related Documentation")
XCTAssertEqual(renderNode.seeAlsoSections[0].identifiers, ["doc://org.swift.docc.example/documentation/SideKit"])
XCTAssertEqual(renderNode.seeAlsoSections[1].title, "Basics")
XCTAssertEqual(renderNode.seeAlsoSections[1].identifiers, ["doc://org.swift.docc.example/documentation/Test-Bundle/sidearticle"])
XCTAssertEqual(renderNode.seeAlsoSections[1].generated, true)
// Verify that articles get same automatic See Also sections as symbols
do {
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/Test-Bundle/sidearticle", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Article) as! RenderNode
// Verify there is an automacially created See Also
XCTAssertEqual(renderNode.seeAlsoSections.count, 1)
guard renderNode.seeAlsoSections.count == 1 else { return }
XCTAssertEqual(renderNode.seeAlsoSections[0].title, "Basics")
XCTAssertEqual(renderNode.seeAlsoSections[0].identifiers, ["doc://org.swift.docc.example/documentation/SideKit/SideClass"])
XCTAssertEqual(renderNode.seeAlsoSections[0].generated, true)
}
}
// Duplicate of the `testAuthoredAndAutomaticSeeAlso()` test above
// but with automatic see also creation disabled
func testAuthoredSeeAlsoWithDisabledAutomaticSeeAlso() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle") { root in
/// Article that curates `SideClass`
try """
# ``SideKit``
SideKit module root symbol
## Topics
### Basics
- ``SideClass``
- <doc:sidearticle>
""".write(to: root.appendingPathComponent("documentation/sidekit.md"), atomically: true, encoding: .utf8)
/// Authored See Also
try """
# ``SideKit/SideClass``
SideClass abstract.
@Options {
@AutomaticSeeAlso(disabled)
}
## See Also
- ``SideKit``
""".write(to: root.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
/// Article Sibling
try """
# Side Article
Side Article abstract.
""".write(to: root.appendingPathComponent("documentation/sidearticle.md"), atomically: true, encoding: .utf8)
}
// Get a translated render node
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Symbol) as! RenderNode
// Verify there is an authored See Also but no automatically created See Also
XCTAssertEqual(renderNode.seeAlsoSections.count, 1)
guard renderNode.seeAlsoSections.count == 1 else { return }
XCTAssertEqual(renderNode.seeAlsoSections[0].title, "Related Documentation")
XCTAssertEqual(renderNode.seeAlsoSections[0].identifiers, ["doc://org.swift.docc.example/documentation/SideKit"])
// Verify that article without options directive still gets automatic See Also sections
do {
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/Test-Bundle/sidearticle", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Article) as! RenderNode
// Verify there is an automacially created See Also
XCTAssertEqual(renderNode.seeAlsoSections.count, 1)
guard renderNode.seeAlsoSections.count == 1 else { return }
XCTAssertEqual(renderNode.seeAlsoSections[0].title, "Basics")
XCTAssertEqual(renderNode.seeAlsoSections[0].identifiers, ["doc://org.swift.docc.example/documentation/SideKit/SideClass"])
XCTAssertEqual(renderNode.seeAlsoSections[0].generated, true)
}
}
// Duplicate of the `testAuthoredAndAutomaticSeeAlso()` test above
// but with automatic see also creation globally disabled
func testAuthoredSeeAlsoWithGloballyDisabledAutomaticSeeAlso() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle") { root in
/// Article that curates `SideClass`
try """
# ``SideKit``
SideKit module root symbol
@Options(scope: global) {
@AutomaticSeeAlso(disabled)
}
## Topics
### Basics
- ``SideClass``
- <doc:sidearticle>
""".write(to: root.appendingPathComponent("documentation/sidekit.md"), atomically: true, encoding: .utf8)
/// Authored See Also
try """
# ``SideKit/SideClass``
SideClass abstract.
## See Also
- ``SideKit``
""".write(to: root.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
/// Article Sibling
try """
# Side Article
Side Article abstract.
""".write(to: root.appendingPathComponent("documentation/sidearticle.md"), atomically: true, encoding: .utf8)
}
// Get a translated render node
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Symbol) as! RenderNode
// Verify there is an authored See Also but no automatically created See Also
XCTAssertEqual(renderNode.seeAlsoSections.count, 1)
guard renderNode.seeAlsoSections.count == 1 else { return }
XCTAssertEqual(renderNode.seeAlsoSections[0].title, "Related Documentation")
XCTAssertEqual(renderNode.seeAlsoSections[0].identifiers, ["doc://org.swift.docc.example/documentation/SideKit"])
// Verify that article without options directive still gets automatic See Also sections
do {
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/Test-Bundle/sidearticle", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Article) as! RenderNode
// Verify there is an automacially created See Also
XCTAssertTrue(renderNode.seeAlsoSections.isEmpty)
}
}
func testSeeAlsoWithSymbolAndTutorial() throws {
let exampleDocumentation = Folder(name: "MyKit.docc", content: [
CopyOfFile(original: Bundle.module.url(forResource: "mykit-one-symbol.symbols", withExtension: "json", subdirectory: "Test Resources")!),
// The tutorial has the same file name (excluding the file extension) as the module and as the bundle.
TextFile(name: "MyKit.tutorial", utf8Content: """
@Tutorials(name: "My Tutorials") {
@Intro(title: "My Intro") {
}
}
"""),
TextFile(name: "MyKit.md", utf8Content: """
# ``MyKit``
Curate a symbol and a tutorial together so that the symbol's generated See Also section includes the tutorial.
## Topics
- ``MyKit/MyClass/myFunction()``
- <doc:/tutorials/MyKit>
"""),
])
let tempURL = try createTemporaryDirectory()
let bundleURL = try exampleDocumentation.write(inside: tempURL)
let (_, bundle, context) = try loadBundle(from: bundleURL)
// Get a translated render node
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: "MyKit", path: "/documentation/MyKit/MyClass/myFunction()", sourceLanguage: .swift))
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visit(node.semantic as! Symbol) as! RenderNode
// Verify there is a See Also with the resolved tutorial reference
XCTAssertEqual(renderNode.seeAlsoSections.count, 1)
XCTAssertEqual(renderNode.seeAlsoSections.first?.identifiers, ["doc://MyKit/tutorials/MyKit"])
}
}
|
