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
|
/*
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 SymbolKit
fileprivate let jsonDecoder = JSONDecoder()
fileprivate let jsonEncoder = JSONEncoder()
class ConstraintsRenderSectionTests: XCTestCase {
func testSingleConstraint() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "sameType", "lhs" : "Label", "rhs" : "Text" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
XCTAssertEqual(renderNode.metadata.conformance?.constraints.map(flattenInlineElements).joined(), "Label is Text.")
}
func testSingleRedundantConstraint() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "sameType", "lhs" : "Self", "rhs" : "MyClass" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
XCTAssertNil(renderNode.metadata.conformance)
}
func testSingleRedundantConstraintForLeaves() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC10myFunctionyyF" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "sameType", "lhs" : "Self", "rhs" : "MyClass" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass/myFunction()", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
XCTAssertNil(renderNode.metadata.conformance)
}
func testPreservesNonRedundantConstraints() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC10myFunctionyyF" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "sameType", "lhs" : "Self", "rhs" : "MyClass" },
{ "kind" : "sameType", "lhs" : "Element", "rhs" : "MyClass" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass/myFunction()", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
XCTAssertEqual(renderNode.metadata.conformance?.constraints.map(flattenInlineElements).joined(), "Element is MyClass.")
}
func testGroups2Constraints() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC10myFunctionyyF" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "conformance", "lhs" : "Element", "rhs" : "MyProtocol" },
{ "kind" : "conformance", "lhs" : "Element", "rhs" : "Equatable" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass/myFunction()", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
XCTAssertEqual(renderNode.metadata.conformance?.constraints.map(flattenInlineElements).joined(), "Element conforms to MyProtocol and Equatable.")
}
func testGroups3Constraints() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC10myFunctionyyF" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "conformance", "lhs" : "Element", "rhs" : "MyProtocol" },
{ "kind" : "conformance", "lhs" : "Element", "rhs" : "Equatable" },
{ "kind" : "conformance", "lhs" : "Element", "rhs" : "Hashable" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass/myFunction()", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
XCTAssertEqual(renderNode.metadata.conformance?.constraints.map(flattenInlineElements).joined(), "Element conforms to MyProtocol, Equatable, and Hashable.")
}
func testRenderReferences() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC10myFunctionyyF" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "conformance", "lhs" : "Element", "rhs" : "MyProtocol" },
{ "kind" : "conformance", "lhs" : "Element", "rhs" : "Equatable" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
guard let renderReference = renderNode.references.first(where: { (key, value) -> Bool in
return key.hasSuffix("myFunction()")
})?.value as? TopicRenderReference else {
XCTFail("Did not find render reference to myFunction()")
return
}
XCTAssertEqual(renderReference.conformance?.constraints.map(flattenInlineElements).joined(), "Element conforms to MyProtocol and Equatable.")
}
func testRenderReferencesWithNestedTypeInSelf() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:]) { bundleURL in
// Add constraints to `MyClass`
let graphURL = bundleURL.appendingPathComponent("mykit-iOS.symbols.json")
var graph = try jsonDecoder.decode(SymbolGraph.self, from: try Data(contentsOf: graphURL))
// "Inject" generic constraints
graph.symbols = try graph.symbols.mapValues({ symbol -> SymbolGraph.Symbol in
guard symbol.identifier.precise == "s:5MyKit0A5ClassC10myFunctionyyF" else { return symbol }
var symbol = symbol
symbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] = try jsonDecoder.decode(SymbolGraph.Symbol.Swift.Extension.self, from: """
{"extendedModule": "MyKit",
"constraints": [
{ "kind" : "conformance", "lhs" : "Self.Element", "rhs" : "MyProtocol" },
{ "kind" : "conformance", "lhs" : "Self.Index", "rhs" : "Equatable" }
]}
""".data(using: .utf8)!)
return symbol
})
try jsonEncoder.encode(graph).write(to: graphURL)
}
// Compile docs and verify contents
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/MyClass", sourceLanguage: .swift))
let symbol = node.semantic as! Symbol
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = translator.visitSymbol(symbol) as! RenderNode
guard let renderReference = renderNode.references.first(where: { (key, value) -> Bool in
return key.hasSuffix("myFunction()")
})?.value as? TopicRenderReference else {
XCTFail("Did not find render reference to myFunction()")
return
}
// Verify we've removed the "Self." prefix in the type names
XCTAssertEqual(renderReference.conformance?.constraints.map(flattenInlineElements).joined(), "Element conforms to MyProtocol and Index conforms to Equatable.")
}
}
fileprivate func flattenInlineElements(el: RenderInlineContent) -> String {
switch el {
case .text(let text): return text
case .codeVoice(let text): return text
default: return ""
}
}
|
