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
|
/*
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 XCTest
@testable import SwiftDocC
import Markdown
class TileTests: XCTestCase {
func testComplex() throws {
let directiveNamesAndTitles = [
(Tile.DirectiveNames.documentation, Tile.Semantics.Title.documentation),
(Tile.DirectiveNames.sampleCode, Tile.Semantics.Title.sampleCode),
].map { ($0.0.rawValue, $0.1.rawValue) }
for (directiveName, title) in directiveNamesAndTitles {
do {
// Empty
let source = "@\(directiveName)"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let tile = Tile(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(tile)
XCTAssertEqual(2, problems.count)
XCTAssertEqual([
"org.swift.docc.Resources.\(directiveName).HasContent",
"org.swift.docc.Resources.\(directiveName).HasLinks",
],problems.map { $0.diagnostic.identifier })
}
do {
// Valid
let destination = URL(string: "https://www.example.com/documentation/arkit")!
let source = """
@\(directiveName)(destination: "\(destination)") {
Browse and search detailed API documentation.
- <doc://org.swift.docc/arkit/augmented_reality_with_the_back_camera>
- <doc://org.swift.docc/arkit/augmented_reality_with_the_front_camera>
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let tile = Tile(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(tile)
XCTAssertTrue(problems.isEmpty)
tile.map { tile in
XCTAssertEqual(title, tile.title)
XCTAssertEqual(destination, tile.destination)
}
}
}
}
func testGeneric() throws {
let directiveNamesAndTitles = [
(Tile.DirectiveNames.downloads, Tile.Semantics.Title.downloads),
(Tile.DirectiveNames.videos, Tile.Semantics.Title.videos),
(Tile.DirectiveNames.forums, Tile.Semantics.Title.forums),
].map { ($0.0.rawValue, $0.1.rawValue) }
for (directiveName, title) in directiveNamesAndTitles {
do {
// Empty
let source = "@\(directiveName)"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let tile = Tile(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(tile)
XCTAssertEqual(1, problems.count)
XCTAssertEqual([
"org.swift.docc.Resources.\(directiveName).HasContent",
],problems.map { $0.diagnostic.identifier })
}
do {
// Valid
let destination = URL(string: "https://www.example.com/documentation/arkit")!
let source = """
@\(directiveName)(destination: "\(destination.absoluteString)") {
Browse and search detailed API documentation.
- <doc://org.swift.docc/arkit/augmented_reality_with_the_back_camera>
- <doc://org.swift.docc/arkit/augmented_reality_with_the_front_camera>
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let tile = Tile(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(tile)
XCTAssertTrue(problems.isEmpty)
tile.map { tile in
XCTAssertEqual(title, tile.title)
XCTAssertEqual(destination, tile.destination)
}
}
}
}
func testDestination() throws {
do {
let destination = URL(string: "https://www.example.com/documentation/technology")!
let source = """
@SampleCode(destination: "\(destination.absoluteString)") {
Browse and search detailed API documentation.
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let tile = Tile(from: directive, source: nil, for: bundle, in: context, problems: &problems)
// Destination is set.
XCTAssertEqual(destination, tile?.destination)
}
do {
let source = """
@SampleCode {
Browse and search detailed API documentation.
- <doc://org.swift.docc/arkit/augmented_reality_with_the_back_camera>
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let tile = Tile(from: directive, source: nil, for: bundle, in: context, problems: &problems)
// Destination is nil.
XCTAssertNotNil(tile)
XCTAssertEqual(nil, tile?.destination)
}
}
func testUnknownTile() throws {
let source = "@UnknownTile"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let tile = Tile(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(tile)
XCTAssertEqual(1, problems.count)
XCTAssertEqual(problems.first?.diagnostic.identifier, "org.swift.docc.Resources.UnknownTile")
XCTAssertEqual(problems.first?.diagnostic.severity, .warning)
}
}
|
