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
|
/*
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
class RenderNodeVariantOverridesApplierTests: XCTestCase {
func testReplacesTopLevelValue() throws {
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.addVariantOverride(pointerComponents: ["kind"], value: RenderNode.Kind.article)
},
assertion: { appliedRenderNode in
XCTAssertEqual(appliedRenderNode.kind, .article)
}
)
}
func testReplacesValueInDictionary() throws {
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.addVariantOverride(
pointerComponents: ["identifier", "interfaceLanguage"],
value: "new interface language"
)
},
assertion: { appliedRenderNode in
XCTAssertEqual(appliedRenderNode.identifier.sourceLanguage.name, "new interface language")
}
)
}
func testReplacesValueInArray() throws {
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.primaryContentSections = [
DeclarationsRenderSection(
declarations: [
DeclarationRenderSection(languages: nil, platforms: [], tokens: []),
]
),
]
renderNode.addVariantOverride(
pointerComponents: ["primaryContentSections", "0"],
value: DeclarationsRenderSection(
declarations: [
DeclarationRenderSection(languages: nil, platforms: [], tokens: []),
DeclarationRenderSection(languages: nil, platforms: [], tokens: []),
]
)
)
},
assertion: { appliedRenderNode in
XCTAssertEqual(
(appliedRenderNode.primaryContentSections.first as? DeclarationsRenderSection)?.declarations.count,
2
)
}
)
}
func testReplacesMultipleValues() throws {
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.metadata.title = "Title"
renderNode.addVariantOverride(
pointerComponents: ["identifier"],
value: ResolvedTopicReference(
bundleIdentifier: "new-bundle-identifier",
path: "/path",
fragment: nil,
sourceLanguage: .objectiveC
)
)
renderNode.addVariantOverride(pointerComponents: ["metadata", "title"], value: "New Title")
},
assertion: { appliedRenderNode in
XCTAssertEqual(appliedRenderNode.identifier.sourceLanguage, .objectiveC)
XCTAssertEqual(appliedRenderNode.metadata.title, "New Title")
}
)
}
func testReplacesValueAtPointerWithEscapedCharacters() throws {
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.references["doc://path/to/symbol"] = TopicRenderReference(
identifier: RenderReferenceIdentifier("doc://path/to/symbol"),
title: "Title",
abstract: [],
url: "",
kind: .symbol,
estimatedTime: nil
)
renderNode.addVariantOverride(
pointerComponents: ["references", "doc://path/to/symbol", "title"],
value: "New Title"
)
},
assertion: { appliedRenderNode in
XCTAssertEqual(
(appliedRenderNode.references["doc://path/to/symbol"] as? TopicRenderReference)?.title,
"New Title"
)
}
)
}
func testRemovesVariantOverrides() throws {
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.metadata.title = "Title"
renderNode.addVariantOverride(pointerComponents: ["metadata", "title"], value: "New Title")
},
assertion: { renderNode in
XCTAssertNil(renderNode.variantOverrides)
}
)
}
func testThrowsErrorForInvalidObjectPointer() {
XCTAssertThrowsError(
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.addVariantOverride(pointerComponents: ["foo"], value: "value")
},
assertion: { renderNode in }
)
) { error in
XCTAssertEqual(
error.localizedDescription,
"""
Invalid dictionary pointer '/foo'. The component 'foo' is not valid for the object with keys \
'hierarchy', 'identifier', 'kind', 'metadata', 'references', 'schemaVersion', 'sections', and \
'variantOverrides'.
"""
)
}
}
func testThrowsErrorForInvalidArrayPointer() {
XCTAssertThrowsError(
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.addVariantOverride(pointerComponents: ["sections", "0"], value: "value")
},
assertion: { renderNode in }
)
) { error in
XCTAssertEqual(
error.localizedDescription,
"Invalid array pointer '/sections/0'. The index '0' is not valid for array of 0 elements."
)
}
}
func testThrowsErrorForInvalidValuePointer() {
XCTAssertThrowsError(
try assertAppliedRenderNode(
configureOriginalNode: { renderNode in
renderNode.addVariantOverride(pointerComponents: ["kind", "0"], value: "value")
},
assertion: { renderNode in }
)
) { error in
XCTAssertEqual(
error.localizedDescription,
"""
Invalid value pointer '/kind/0'. The component '0' is not valid for the non-traversable value \
'"symbol"'.
"""
)
}
}
private func assertAppliedRenderNode(
configureOriginalNode: ((inout RenderNode) -> ())? = nil,
traits: [RenderNode.Variant.Trait] = [.interfaceLanguage("objc")],
assertion: (RenderNode) throws -> ()
) throws {
var renderNode = RenderNode(
identifier: ResolvedTopicReference(
bundleIdentifier: "bundle-identifier",
path: "",
fragment: nil,
sourceLanguage: .swift
),
kind: .symbol
)
configureOriginalNode?(&renderNode)
let transformedData = try RenderNodeVariantOverridesApplier()
.applyVariantOverrides(
in: try RenderJSONEncoder.makeEncoder().encode(renderNode),
for: traits
)
let transformedRenderNode = try RenderJSONDecoder.makeDecoder().decode(RenderNode.self, from: transformedData)
try assertion(transformedRenderNode)
}
}
fileprivate extension RenderNode {
mutating func addVariantOverride(
pointerComponents: [String],
value: Encodable,
traits: [RenderNode.Variant.Trait] = [.interfaceLanguage("objc")],
operation: PatchOperation = .replace
) {
let variantOverrides = self.variantOverrides ?? VariantOverrides()
variantOverrides.add(
VariantOverride(
traits: traits,
patch: [
.replace(
pointer: JSONPointer(pathComponents: pointerComponents),
value: AnyCodable(value)
),
]
)
)
self.variantOverrides = variantOverrides
}
}
|
