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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 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
import Markdown
@testable import SwiftDocC
class CallToActionTests: XCTestCase {
func testInvalidWithNoArguments() throws {
let source = "@CallToAction"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "SampleBundle")
directive.map { directive in
var problems = [Problem]()
XCTAssertEqual(CallToAction.directiveName, directive.name)
let callToAction = CallToAction(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(callToAction)
XCTAssertEqual(2, problems.count)
let diagnosticIdentifiers = Set(problems.map { $0.diagnostic.identifier })
XCTAssertTrue(diagnosticIdentifiers.contains("org.swift.docc.\(CallToAction.self).missingLink"))
XCTAssertTrue(diagnosticIdentifiers.contains("org.swift.docc.\(CallToAction.self).missingLabel"))
}
}
func testInvalidWithoutLink() throws {
func assertMissingLink(source: String) throws {
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "SampleBundle")
directive.map { directive in
var problems = [Problem]()
XCTAssertEqual(CallToAction.directiveName, directive.name)
let callToAction = CallToAction(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(callToAction)
XCTAssertEqual(1, problems.count)
let diagnosticIdentifiers = Set(problems.map { $0.diagnostic.identifier })
XCTAssertTrue(diagnosticIdentifiers.contains("org.swift.docc.\(CallToAction.self).missingLink"))
}
}
try assertMissingLink(source: "@CallToAction(label: \"Button\")")
try assertMissingLink(source: "@CallToAction(purpose: download)")
}
func testInvalidWithoutLabel() throws {
func assertMissingLabel(source: String) throws {
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "SampleBundle")
directive.map { directive in
var problems = [Problem]()
XCTAssertEqual(CallToAction.directiveName, directive.name)
let callToAction = CallToAction(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(callToAction)
XCTAssertEqual(1, problems.count)
let diagnosticIdentifiers = Set(problems.map { $0.diagnostic.identifier })
XCTAssertTrue(diagnosticIdentifiers.contains("org.swift.docc.\(CallToAction.self).missingLabel"))
}
}
try assertMissingLabel(source: "@CallToAction(url: \"https://example.com/sample.zip\"")
try assertMissingLabel(source: "@CallToAction(file: \"Downloads/plus.svg\"")
}
func testInvalidTooManyLinks() throws {
let source = "@CallToAction(url: \"https://example.com/sample.zip\", file: \"Downloads/plus.svg\", purpose: download)"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "SampleBundle")
directive.map { directive in
var problems = [Problem]()
XCTAssertEqual(CallToAction.directiveName, directive.name)
let callToAction = CallToAction(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(callToAction)
XCTAssertEqual(1, problems.count)
let diagnosticIdentifiers = Set(problems.map { $0.diagnostic.identifier })
XCTAssertTrue(diagnosticIdentifiers.contains("org.swift.docc.\(CallToAction.self).tooManyLinks"))
}
}
func testValidDirective() throws {
func assertValidDirective(source: String) throws {
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "SampleBundle")
directive.map { directive in
var problems = [Problem]()
XCTAssertEqual(CallToAction.directiveName, directive.name)
let callToAction = CallToAction(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(callToAction)
XCTAssert(problems.isEmpty)
}
}
let validLinks: [String] = [
"url: \"https://example.com/sample.zip\"",
"file: \"Downloads/plus.svg\""
]
var validLabels: [String] = [
"label: \"Button\""
]
for buttonKind in CallToAction.Purpose.allCases {
validLabels.append("purpose: \(buttonKind)")
// Having both a kind and a label is valid
validLabels.append("purpose: \(buttonKind), label: \"Button\"")
}
for link in validLinks {
for label in validLabels {
try assertValidDirective(source: "@CallToAction(\(link), \(label))")
}
}
}
func testDefaultLabel() throws {
func assertExpectedLabel(source: String, expectedDefaultLabel: String, expectedSampleCodeLabel: String) throws {
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = try XCTUnwrap(document.child(at: 0) as? BlockDirective)
let (bundle, context) = try testBundleAndContext(named: "SampleBundle")
var problems = [Problem]()
XCTAssertEqual(CallToAction.directiveName, directive.name)
let callToAction = try XCTUnwrap(CallToAction(from: directive, source: nil, for: bundle, in: context, problems: &problems))
XCTAssert(problems.isEmpty)
XCTAssertEqual(callToAction.buttonLabel(for: nil), expectedDefaultLabel)
XCTAssertEqual(callToAction.buttonLabel(for: .article), expectedDefaultLabel)
XCTAssertEqual(callToAction.buttonLabel(for: .sampleCode), expectedSampleCodeLabel)
}
var validLabels: [(arg: String, defaultLabel: String, sampleCodeLabel: String)] = []
for buttonKind in CallToAction.Purpose.allCases {
let expectedDefaultLabel: String
let expectedSampleCodeLabel: String
switch buttonKind {
case .download:
expectedDefaultLabel = "Download"
expectedSampleCodeLabel = "Download"
case .link:
expectedDefaultLabel = "Visit"
expectedSampleCodeLabel = "View Source"
}
validLabels.append(("purpose: \(buttonKind)", expectedDefaultLabel, expectedSampleCodeLabel))
// Ensure that adding a label argument overrides the kind's default label
validLabels.append(("purpose: \(buttonKind), label: \"Button\"", "Button", "Button"))
}
for (arg, defaultLabel, sampleCodeLabel) in validLabels {
let directive = "@CallToAction(file: \"Downloads/plus.svg\", \(arg))"
try assertExpectedLabel(
source: directive,
expectedDefaultLabel: defaultLabel,
expectedSampleCodeLabel: sampleCodeLabel
)
}
}
}
|
