Skip to content

Commit b27288d

Browse files
QuietMisdreavusd-ronnqvist
QuietMisdreavus
and
d-ronnqvist
authored
accept sameShape constraint kind from SymbolKit (#1290)
* accept sameShape constraint kind from SymbolKit rdar://129338238 * review: create a test fixture for sameShape constraints * Use merged version of SymbolKit changes * Fix failure in newly added test --------- Co-authored-by: David Rönnqvist <ronnqvist@apple.com>
1 parent 55fbcce commit b27288d

File tree

4 files changed

+357
-1
lines changed

4 files changed

+357
-1
lines changed

‎Package.resolved‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Sources/SwiftDocC/Model/Rendering/Symbol/ConformanceSection.swift‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ extension Constraint.Kind {
2020
case .conformance: return "conforms to"
2121
case .sameType: return "is"
2222
case .superclass: return "inherits"
23+
case .sameShape: return "is the same shape as"
2324
}
2425
}
2526
}

‎Tests/SwiftDocCTests/Rendering/ConstraintsRenderSectionTests.swift‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
import Foundation
1212
import XCTest
1313
@testable import SwiftDocC
14+
import SwiftDocCTestUtilities
1415
import SymbolKit
1516

1617
fileprivate let jsonDecoder = JSONDecoder()
@@ -273,6 +274,39 @@ class ConstraintsRenderSectionTests: XCTestCase {
273274
// Verify we've removed the "Self." prefix in the type names
274275
XCTAssertEqual(renderReference.conformance?.constraints.map(flattenInlineElements).joined(), "Element conforms to MyProtocol and Index conforms to Equatable.")
275276
}
277+
278+
func testRenderSameShape() async throws {
279+
let symbolGraphFile = Bundle.module.url(
280+
forResource: "SameShapeConstraint",
281+
withExtension: "symbols.json",
282+
subdirectory: "Test Resources"
283+
)!
284+
285+
let catalog = Folder(name: "unit-test.docc", content: [
286+
InfoPlist(displayName: "SameShapeConstraint", identifier: "com.test.example"),
287+
CopyOfFile(original: symbolGraphFile),
288+
])
289+
290+
let (_, context) = try await loadBundle(catalog: catalog)
291+
292+
// Compile docs and verify contents
293+
let node = try context.entity(with: ResolvedTopicReference(bundleID: context.inputs.id, path: "/documentation/SameShapeConstraint/function(_:)", sourceLanguage: .swift))
294+
let symbol = node.semantic as! Symbol
295+
var translator = RenderNodeTranslator(context: context, identifier: node.reference)
296+
let renderNode = translator.visitSymbol(symbol) as! RenderNode
297+
298+
guard let renderReference = renderNode.references.first(where: { (key, value) -> Bool in
299+
return key.hasSuffix("function(_:)")
300+
})?.value as? TopicRenderReference else {
301+
XCTFail("Did not find render reference to function(_:)")
302+
return
303+
}
304+
305+
// The symbol graph only defines constraints on the `swiftGenerics` mixin,
306+
// which docc doesn't load or render.
307+
// However, this test should still run without crashing on decoding the symbol graph.
308+
XCTAssertEqual(renderReference.conformance?.constraints.map(flattenInlineElements).joined(), nil)
309+
}
276310
}
277311

278312
fileprivate func flattenInlineElements(el: RenderInlineContent) -> String {

‎Tests/SwiftDocCTests/Test Resources/SameShapeConstraint.symbols.json‎

Lines changed: 321 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,321 @@
1+
{
2+
"metadata": {
3+
"formatVersion": {
4+
"major": 0,
5+
"minor": 6,
6+
"patch": 0
7+
},
8+
"generator": "Apple Swift version 6.2 (swiftlang-6.2.0.19.9 clang-1700.3.19.1)"
9+
},
10+
"module": {
11+
"name": "SameShapeConstraint",
12+
"platform": {
13+
"architecture": "arm64",
14+
"vendor": "apple",
15+
"operatingSystem": {
16+
"name": "macosx",
17+
"minimumVersion": {
18+
"major": 12,
19+
"minor": 4
20+
}
21+
}
22+
}
23+
},
24+
"symbols": [
25+
{
26+
"kind": {
27+
"identifier": "swift.func",
28+
"displayName": "Function"
29+
},
30+
"identifier": {
31+
"precise": "s:13SameShapeConstraint8functionyyx_q_txQp_t_tRvzRv_q_Rhzr0_lF",
32+
"interfaceLanguage": "swift"
33+
},
34+
"pathComponents": [
35+
"function(_:)"
36+
],
37+
"names": {
38+
"title": "function(_:)",
39+
"subHeading": [
40+
{
41+
"kind": "keyword",
42+
"spelling": "func"
43+
},
44+
{
45+
"kind": "text",
46+
"spelling": " "
47+
},
48+
{
49+
"kind": "identifier",
50+
"spelling": "function"
51+
},
52+
{
53+
"kind": "text",
54+
"spelling": "<each "
55+
},
56+
{
57+
"kind": "genericParameter",
58+
"spelling": "Element0"
59+
},
60+
{
61+
"kind": "text",
62+
"spelling": ", each "
63+
},
64+
{
65+
"kind": "genericParameter",
66+
"spelling": "Element1"
67+
},
68+
{
69+
"kind": "text",
70+
"spelling": ">(("
71+
},
72+
{
73+
"kind": "keyword",
74+
"spelling": "repeat"
75+
},
76+
{
77+
"kind": "text",
78+
"spelling": " ("
79+
},
80+
{
81+
"kind": "keyword",
82+
"spelling": "each"
83+
},
84+
{
85+
"kind": "text",
86+
"spelling": " "
87+
},
88+
{
89+
"kind": "typeIdentifier",
90+
"spelling": "Element0",
91+
"preciseIdentifier": "s:13SameShapeConstraint8functionyyx_q_txQp_t_tRvzRv_q_Rhzr0_lF8Element0L_xmfp"
92+
},
93+
{
94+
"kind": "text",
95+
"spelling": ", "
96+
},
97+
{
98+
"kind": "keyword",
99+
"spelling": "each"
100+
},
101+
{
102+
"kind": "text",
103+
"spelling": " "
104+
},
105+
{
106+
"kind": "typeIdentifier",
107+
"spelling": "Element1",
108+
"preciseIdentifier": "s:13SameShapeConstraint8functionyyx_q_txQp_t_tRvzRv_q_Rhzr0_lF8Element1L_q_mfp"
109+
},
110+
{
111+
"kind": "text",
112+
"spelling": ")))"
113+
}
114+
]
115+
},
116+
"functionSignature": {
117+
"parameters": [
118+
{
119+
"name": "_",
120+
"declarationFragments": [
121+
{
122+
"kind": "identifier",
123+
"spelling": "_"
124+
},
125+
{
126+
"kind": "text",
127+
"spelling": ": ("
128+
},
129+
{
130+
"kind": "keyword",
131+
"spelling": "repeat"
132+
},
133+
{
134+
"kind": "text",
135+
"spelling": " ("
136+
},
137+
{
138+
"kind": "keyword",
139+
"spelling": "each"
140+
},
141+
{
142+
"kind": "text",
143+
"spelling": " "
144+
},
145+
{
146+
"kind": "typeIdentifier",
147+
"spelling": "Element0",
148+
"preciseIdentifier": "s:13SameShapeConstraint8functionyyx_q_txQp_t_tRvzRv_q_Rhzr0_lF8Element0L_xmfp"
149+
},
150+
{
151+
"kind": "text",
152+
"spelling": ", "
153+
},
154+
{
155+
"kind": "keyword",
156+
"spelling": "each"
157+
},
158+
{
159+
"kind": "text",
160+
"spelling": " "
161+
},
162+
{
163+
"kind": "typeIdentifier",
164+
"spelling": "Element1",
165+
"preciseIdentifier": "s:13SameShapeConstraint8functionyyx_q_txQp_t_tRvzRv_q_Rhzr0_lF8Element1L_q_mfp"
166+
},
167+
{
168+
"kind": "text",
169+
"spelling": "))"
170+
}
171+
]
172+
}
173+
],
174+
"returns": [
175+
{
176+
"kind": "text",
177+
"spelling": "()"
178+
}
179+
]
180+
},
181+
"swiftGenerics": {
182+
"parameters": [
183+
{
184+
"name": "Element0",
185+
"index": 0,
186+
"depth": 0
187+
},
188+
{
189+
"name": "Element1",
190+
"index": 1,
191+
"depth": 0
192+
}
193+
],
194+
"constraints": [
195+
{
196+
"kind": "sameShape",
197+
"lhs": "each Element0",
198+
"rhs": "each Element1"
199+
}
200+
]
201+
},
202+
"declarationFragments": [
203+
{
204+
"kind": "keyword",
205+
"spelling": "func"
206+
},
207+
{
208+
"kind": "text",
209+
"spelling": " "
210+
},
211+
{
212+
"kind": "identifier",
213+
"spelling": "function"
214+
},
215+
{
216+
"kind": "text",
217+
"spelling": "<each "
218+
},
219+
{
220+
"kind": "genericParameter",
221+
"spelling": "Element0"
222+
},
223+
{
224+
"kind": "text",
225+
"spelling": ", each "
226+
},
227+
{
228+
"kind": "genericParameter",
229+
"spelling": "Element1"
230+
},
231+
{
232+
"kind": "text",
233+
"spelling": ">("
234+
},
235+
{
236+
"kind": "externalParam",
237+
"spelling": "_"
238+
},
239+
{
240+
"kind": "text",
241+
"spelling": ": ("
242+
},
243+
{
244+
"kind": "keyword",
245+
"spelling": "repeat"
246+
},
247+
{
248+
"kind": "text",
249+
"spelling": " ("
250+
},
251+
{
252+
"kind": "keyword",
253+
"spelling": "each"
254+
},
255+
{
256+
"kind": "text",
257+
"spelling": " "
258+
},
259+
{
260+
"kind": "typeIdentifier",
261+
"spelling": "Element0",
262+
"preciseIdentifier": "s:13SameShapeConstraint8functionyyx_q_txQp_t_tRvzRv_q_Rhzr0_lF8Element0L_xmfp"
263+
},
264+
{
265+
"kind": "text",
266+
"spelling": ", "
267+
},
268+
{
269+
"kind": "keyword",
270+
"spelling": "each"
271+
},
272+
{
273+
"kind": "text",
274+
"spelling": " "
275+
},
276+
{
277+
"kind": "typeIdentifier",
278+
"spelling": "Element1",
279+
"preciseIdentifier": "s:13SameShapeConstraint8functionyyx_q_txQp_t_tRvzRv_q_Rhzr0_lF8Element1L_q_mfp"
280+
},
281+
{
282+
"kind": "text",
283+
"spelling": "))) "
284+
},
285+
{
286+
"kind": "keyword",
287+
"spelling": "where"
288+
},
289+
{
290+
"kind": "text",
291+
"spelling": " (repeat (each "
292+
},
293+
{
294+
"kind": "typeIdentifier",
295+
"spelling": "Element0"
296+
},
297+
{
298+
"kind": "text",
299+
"spelling": ", each "
300+
},
301+
{
302+
"kind": "typeIdentifier",
303+
"spelling": "Element1"
304+
},
305+
{
306+
"kind": "text",
307+
"spelling": ")) : Any"
308+
}
309+
],
310+
"accessLevel": "public",
311+
"location": {
312+
"uri": "file:///path/to/SameShapeConstraint/SwiftClass.swift",
313+
"position": {
314+
"line": 9,
315+
"character": 12
316+
}
317+
}
318+
}
319+
],
320+
"relationships": []
321+
}

0 commit comments

Comments
 (0)