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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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 DeclarationsRenderSectionTests: XCTestCase {
func testDecodingTokens() throws {
let values: [(DeclarationRenderSection.Token.Kind, String)] = [
(.keyword, "keyword"),
(.attribute, "attribute"),
(.number, "number"),
(.string, "string"),
(.identifier, "identifier"),
(.typeIdentifier, "typeIdentifier"),
(.genericParameter, "genericParameter"),
(.text, "text"),
(.internalParam, "internalParam"),
(.externalParam, "externalParam"),
(.label, "label"),
]
for (token, string) in values {
let jsonData = """
{
"kind": "declarations",
"declarations": [
{
"platforms": [],
"tokens": [
{
"text": "",
"kind": "\(string)"
}
],
"otherDeclarations": {
"declarations": [
{
"identifier": "identifier",
"tokens": [
{
"text": "",
"kind": "\(string)"
}
]
}
],
"displayIndex": 0
}
}
]
}
""".data(using: .utf8)!
XCTAssertEqual(
try JSONDecoder().decode(DeclarationsRenderSection.self, from: jsonData),
DeclarationsRenderSection(declarations: [
DeclarationRenderSection(
languages: nil,
platforms: [],
tokens: [.init(text: "", kind: token)],
otherDeclarations: DeclarationRenderSection.OtherDeclarations(
declarations: [.init(tokens: [.init(text: "", kind: token)], identifier: "identifier")],
displayIndex: 0
)
),
])
)
}
}
func testDoNotEmitOtherDeclarationsIfEmpty() throws {
let encoder = RenderJSONEncoder.makeEncoder(prettyPrint: true)
let encodedData = try encoder.encode(
DeclarationsRenderSection(declarations: [
DeclarationRenderSection(
languages: nil,
platforms: [],
tokens: [.init(text: "", kind: .string)]
)]
)
)
let encodedJsonString = try XCTUnwrap(String(data: encodedData, encoding: .utf8))
XCTAssertFalse(encodedJsonString.contains("otherDeclarations"))
XCTAssertFalse(encodedJsonString.contains("indexInOtherDeclarations"))
}
func testRoundTrip() throws {
let jsonData = """
{
"kind": "declarations",
"declarations": [
{
"platforms": [],
"tokens": [
{
"text": "",
"kind": "label"
}
],
"otherDeclarations": {
"declarations": [
{
"identifier": "identifier",
"tokens": [
{
"text": "",
"kind": "label"
}
]
}
],
"displayIndex": 0
}
}
]
}
""".data(using: .utf8)!
let value = try JSONDecoder().decode(DeclarationsRenderSection.self, from: jsonData)
try assertRoundTripCoding(value)
}
func testAlternateDeclarations() throws {
let (bundle, context) = try testBundleAndContext(named: "AlternateDeclarations")
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/AlternateDeclarations/MyClass/present(completion:)",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let declarationsSection = try XCTUnwrap(renderNode.primaryContentSections.compactMap({ $0 as? DeclarationsRenderSection }).first)
XCTAssertEqual(declarationsSection.declarations.count, 2)
XCTAssert(declarationsSection.declarations.allSatisfy({ $0.platforms == [.iOS, .macOS] }))
}
func testHighlightDiff() throws {
enableFeatureFlag(\.isExperimentalOverloadedSymbolPresentationEnabled)
let symbolGraphFile = Bundle.module.url(
forResource: "FancyOverloads",
withExtension: "symbols.json",
subdirectory: "Test Resources"
)!
let tempURL = try createTempFolder(content: [
Folder(name: "unit-test.docc", content: [
InfoPlist(displayName: "FancyOverloads", identifier: "com.test.example"),
CopyOfFile(original: symbolGraphFile),
])
])
let (_, bundle, context) = try loadBundle(from: tempURL)
// Make sure that type decorators like arrays, dictionaries, and optionals are correctly highlighted.
do {
// func overload1(param: Int) {} // <- overload group
// func overload1(param: Int?) {}
// func overload1(param: [Int]) {}
// func overload1(param: [Int]?) {}
// func overload1(param: Set<Int>) {}
// func overload1(param: [Int: Int]) {}
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/FancyOverloads/overload1(param:)-8nk5z",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let declarationsSection = try XCTUnwrap(renderNode.primaryContentSections.compactMap({ $0 as? DeclarationsRenderSection }).first)
XCTAssertEqual(declarationsSection.declarations.count, 1)
let declarations = try XCTUnwrap(declarationsSection.declarations.first)
XCTAssertEqual(
declarationAndHighlights(for: declarations.tokens),
[
"func overload1(param: Int)",
" ",
]
)
XCTAssertEqual(
declarations.otherDeclarations?.declarations.flatMap({ declarationAndHighlights(for: $0.tokens) }),
[
"func overload1(param: Int?)",
" ~ ",
"func overload1(param: Set<Int>)",
" ~~~~ ~ ",
"func overload1(param: [Int : Int])",
" ~ ~~~~~~ ",
"func overload1(param: [Int])",
" ~ ~ ",
"func overload1(param: [Int]?)",
" ~ ~~ ",
]
)
}
// Verify the behavior of the highlighter in the face of tuples and closures, which can
// confuse the differencing code with excess parentheses and commas.
do {
// func overload2(p1: Int, p2: Int) {}
// func overload2(p1: (Int, Int), p2: Int) {}
// func overload2(p1: Int, p2: (Int, Int)) {}
// func overload2(p1: (Int) -> (), p2: Int) {}
// func overload2(p1: (Int) -> Int, p2: Int) {}
// func overload2(p1: (Int) -> Int?, p2: Int) {}
// func overload2(p1: ((Int) -> Int)?, p2: Int) {} // <- overload group
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/FancyOverloads/overload2(p1:p2:)-4p1sq",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let declarationsSection = try XCTUnwrap(renderNode.primaryContentSections.compactMap({ $0 as? DeclarationsRenderSection }).first)
XCTAssertEqual(declarationsSection.declarations.count, 1)
let declarations = try XCTUnwrap(declarationsSection.declarations.first)
XCTAssertEqual(
declarationAndHighlights(for: declarations.tokens),
[
"func overload2(p1: ((Int) -> Int)?, p2: Int)",
" ~~ ~~~~~~~~~~ "
]
)
XCTAssertEqual(
declarations.otherDeclarations?.declarations.flatMap({ declarationAndHighlights(for: $0.tokens) }),
[
"func overload2(p1: (Int) -> (), p2: Int)",
" ~ ~~~~~~~ ",
"func overload2(p1: (Int) -> Int, p2: Int)",
" ~ ~~~~~~~~ ",
"func overload2(p1: (Int) -> Int?, p2: Int)",
" ~ ~~~~~~~~~ ",
// FIXME: adjust the token processing so that the comma inside the tuple isn't treated as common?
// (it breaks the declaration pretty-printer in Swift-DocC-Render and causes it to skip pretty-printing)
"func overload2(p1: (Int, Int), p2: Int)",
" ~ ~~~~~ ",
// FIXME: adjust the token processing so that the common parenthesis is always the final one
"func overload2(p1: Int, p2: (Int, Int))",
" ~ ~~~~~ ~",
"func overload2(p1: Int, p2: Int)",
" ",
]
)
}
// Verify that the presence of type parameters doesn't cause the opening parenthesis of an
// argument list to also be highlighted, since it is combined into the same token as the
// closing angle bracket in the symbol graph. Also ensure that the leading space of the
// rendered where clause is not highlighted.
do {
// func overload3(_ p: [Int: Int]) {} // <- overload group
// func overload3<T: Hashable>(_ p: [T: T]) {}
// func overload3<K: Hashable, V>(_ p: [K: V]) {}
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/FancyOverloads/overload3(_:)-xql2",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let declarationsSection = try XCTUnwrap(renderNode.primaryContentSections.compactMap({ $0 as? DeclarationsRenderSection }).first)
XCTAssertEqual(declarationsSection.declarations.count, 1)
let declarations = try XCTUnwrap(declarationsSection.declarations.first)
XCTAssertEqual(
declarationAndHighlights(for: declarations.tokens),
[
"func overload3(_ p: [Int : Int])",
" ~~~ ~~~ ",
]
)
XCTAssertEqual(
declarations.otherDeclarations?.declarations.flatMap({ declarationAndHighlights(for: $0.tokens) }),
[
"func overload3<K, V>(_ p: [K : V]) where K : Hashable",
" ~~~~~~ ~ ~ ~~~~~~~~~~~~~~~~~~",
"func overload3<T>(_ p: [T : T]) where T : Hashable",
" ~~~ ~ ~ ~~~~~~~~~~~~~~~~~~",
]
)
}
}
func testDontHighlightWhenOverloadsAreDisabled() throws {
let symbolGraphFile = Bundle.module.url(
forResource: "FancyOverloads",
withExtension: "symbols.json",
subdirectory: "Test Resources"
)!
let tempURL = try createTempFolder(content: [
Folder(name: "unit-test.docc", content: [
InfoPlist(displayName: "FancyOverloads", identifier: "com.test.example"),
CopyOfFile(original: symbolGraphFile),
])
])
let (_, bundle, context) = try loadBundle(from: tempURL)
for hash in ["7eht8", "8p1lo", "858ja"] {
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/FancyOverloads/overload3(_:)-\(hash)",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let declarationsSection = try XCTUnwrap(renderNode.primaryContentSections.compactMap({ $0 as? DeclarationsRenderSection }).first)
XCTAssertEqual(declarationsSection.declarations.count, 1)
let declarations = try XCTUnwrap(declarationsSection.declarations.first)
XCTAssert(declarations.tokens.allSatisfy({ $0.highlight == nil }))
}
}
}
/// Render a list of declaration tokens as a plain-text decoration and as a plain-text rendering of which characters are highlighted.
func declarationAndHighlights(for tokens: [DeclarationRenderSection.Token]) -> [String] {
[
tokens.map({ $0.text }).joined(),
tokens.map({ String(repeating: $0.highlight == .changed ? "~" : " ", count: $0.text.count) }).joined()
]
}
|
