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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022-2024 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 XCTest
@testable import SwiftDocC
import Markdown
class DirectiveMirrorTests: XCTestCase {
func testReflectDisplayNameDirective() {
let reflectedDirective = DirectiveMirror(reflecting: DisplayName.self).reflectedDirective
XCTAssertEqual(reflectedDirective.name, "DisplayName")
XCTAssertFalse(reflectedDirective.allowsMarkup)
XCTAssertEqual(reflectedDirective.arguments.count, 2)
XCTAssertEqual(reflectedDirective.arguments["name"]?.unnamed, true)
XCTAssertEqual(reflectedDirective.arguments["name"]?.required, true)
XCTAssertEqual(reflectedDirective.arguments["name"]?.labelDisplayName, "_ name")
XCTAssertEqual(reflectedDirective.arguments["name"]?.propertyLabel, "name")
XCTAssertEqual(reflectedDirective.arguments["style"]?.unnamed, false)
XCTAssertEqual(reflectedDirective.arguments["style"]?.required, false)
XCTAssertEqual(reflectedDirective.arguments["style"]?.labelDisplayName, "style")
XCTAssertEqual(reflectedDirective.arguments["style"]?.propertyLabel, "style")
XCTAssertEqual(reflectedDirective.arguments["style"]?.allowedValues, ["conceptual", "symbol"])
}
func testReflectTitleHeadingDirective() {
let reflectedDirective = DirectiveMirror(reflecting: TitleHeading.self).reflectedDirective
XCTAssertEqual(reflectedDirective.name, "TitleHeading")
XCTAssertFalse(reflectedDirective.allowsMarkup)
XCTAssertEqual(reflectedDirective.arguments.count, 1)
XCTAssertEqual(reflectedDirective.arguments["heading"]?.unnamed, true)
XCTAssertEqual(reflectedDirective.arguments["heading"]?.required, true)
XCTAssertEqual(reflectedDirective.arguments["heading"]?.labelDisplayName, "_ heading")
XCTAssertEqual(reflectedDirective.arguments["heading"]?.propertyLabel, "heading")
}
func testReflectMetadataDirective() {
let reflectedDirective = DirectiveMirror(reflecting: Metadata.self).reflectedDirective
XCTAssertEqual(reflectedDirective.name, "Metadata")
XCTAssertFalse(reflectedDirective.allowsMarkup)
XCTAssert(reflectedDirective.arguments.isEmpty)
XCTAssertEqual(reflectedDirective.childDirectives.count, 12)
XCTAssertEqual(
reflectedDirective.childDirectives["DocumentationExtension"]?.propertyLabel,
"documentationOptions"
)
XCTAssertEqual(
reflectedDirective.childDirectives["DocumentationExtension"]?.requirements,
.zeroOrOne
)
XCTAssertEqual(
reflectedDirective.childDirectives["DocumentationExtension"]?.storedAsArray,
false
)
XCTAssertEqual(
reflectedDirective.childDirectives["DocumentationExtension"]?.storedAsOptional,
true
)
XCTAssertEqual(
reflectedDirective.childDirectives["TechnologyRoot"]?.propertyLabel,
"technologyRoot"
)
XCTAssertEqual(
reflectedDirective.childDirectives["TechnologyRoot"]?.requirements,
.zeroOrOne
)
XCTAssertEqual(
reflectedDirective.childDirectives["TechnologyRoot"]?.storedAsArray,
false
)
XCTAssertEqual(
reflectedDirective.childDirectives["TechnologyRoot"]?.storedAsOptional,
true
)
}
func testReflectIntroDirective() {
let reflectedDirective = DirectiveMirror(reflecting: Intro.self).reflectedDirective
XCTAssertEqual(reflectedDirective.name, "Intro")
XCTAssert(reflectedDirective.allowsMarkup)
XCTAssertFalse(reflectedDirective.requiresMarkup)
XCTAssertEqual(reflectedDirective.arguments.count, 1)
XCTAssertEqual(reflectedDirective.arguments["title"]?.unnamed, false)
XCTAssertEqual(reflectedDirective.arguments["title"]?.required, true)
XCTAssertEqual(reflectedDirective.arguments["title"]?.labelDisplayName, "title")
XCTAssertEqual(reflectedDirective.arguments["title"]?.propertyLabel, "title")
XCTAssertEqual(reflectedDirective.arguments["title"]?.storedAsOptional, false)
XCTAssertEqual(reflectedDirective.childDirectives.count, 2)
XCTAssertEqual(reflectedDirective.childDirectives["Video"]?.propertyLabel, "video")
XCTAssertEqual(reflectedDirective.childDirectives["Video"]?.storedAsOptional, true)
XCTAssertEqual(reflectedDirective.childDirectives["Video"]?.requirements, .zeroOrOne)
XCTAssertEqual(reflectedDirective.childDirectives["Image"]?.propertyLabel, "image")
XCTAssertEqual(reflectedDirective.childDirectives["Image"]?.storedAsOptional, true)
XCTAssertEqual(reflectedDirective.childDirectives["Image"]?.requirements, .zeroOrOne)
}
func testReflectStackDirective() {
let reflectedDirective = DirectiveMirror(reflecting: Stack.self).reflectedDirective
XCTAssertEqual(reflectedDirective.name, "Stack")
XCTAssertFalse(reflectedDirective.allowsMarkup)
XCTAssertFalse(reflectedDirective.requiresMarkup)
XCTAssert(reflectedDirective.arguments.isEmpty)
XCTAssertEqual(reflectedDirective.childDirectives.count, 1)
XCTAssertEqual(reflectedDirective.childDirectives["ContentAndMedia"]?.propertyLabel, "contentAndMedia")
XCTAssertEqual(reflectedDirective.childDirectives["ContentAndMedia"]?.storedAsOptional, false)
XCTAssertEqual(reflectedDirective.childDirectives["ContentAndMedia"]?.requirements, .oneOrMore)
XCTAssertEqual(reflectedDirective.childDirectives["ContentAndMedia"]?.storedAsArray, true)
}
}
private extension RandomAccessCollection<DirectiveMirror.ReflectedArgument> {
/// Look for an argument named `name` or log an XCTest failure.
subscript(
_ name: some StringProtocol,
file: StaticString = #filePath,
line: UInt = #line
) -> DirectiveMirror.ReflectedArgument? {
let match = first { argument in
if argument.name.isEmpty && argument.propertyLabel == name {
return true
} else if argument.name == name {
return true
} else {
return false
}
}
guard let match else {
XCTFail("Expected argument named \(name.singleQuoted)", file: file, line: line)
return nil
}
return match
}
}
private extension RandomAccessCollection<DirectiveMirror.ReflectedChildDirective> {
/// Look for an argument named `name` or log an XCTest failure.
subscript(
_ name: some StringProtocol,
file: StaticString = #filePath,
line: UInt = #line
) -> DirectiveMirror.ReflectedChildDirective? {
let match = first { childDirective in
return childDirective.name == name
}
guard let match else {
XCTFail("Expected child directive named \(name.singleQuoted)", file: file, line: line)
return nil
}
return match
}
}
|
