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
|
/*
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 AbstractContainsFormattedTextOnlyTests: XCTestCase {
var checker = AbstractContainsFormattedTextOnly(sourceFile: nil)
private func verifyDiagnostic(diagnostic: Diagnostic, expectedIdentifier: String, expectedRange: SourceRange) {
XCTAssertEqual(expectedIdentifier, diagnostic.identifier)
XCTAssertEqual(expectedRange, diagnostic.range)
}
func testFormattedText() {
let source = """
# Title
This __is__ an *abstract*.
This paragraph isn't [analyzed](http://example.com/image.jpg).
"""
let document = Document(parsing: source, options: [])
checker.visit(document)
XCTAssertTrue(checker.problems.isEmpty)
}
func testTopLevelImage() {
let source = """
# Title
 Abstract.
"""
let document = Document(parsing: source, options: [])
checker.visit(document)
guard checker.problems.count == 1 else {
XCTFail("Expected 1 problems")
return
}
let problem = checker.problems[0]
XCTAssertTrue(problem.possibleSolutions.isEmpty)
let image = document.child(at: 1)!.child(at: 0)! as! Image
verifyDiagnostic(diagnostic: problem.diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsImage", expectedRange: image.range!)
}
func testTopLevelLink() {
let source = """
# Title
More info [here](http://example.com/image.jpg).
"""
let document = Document(parsing: source, options: [])
checker.visit(document)
guard checker.problems.count == 1 else {
XCTFail("Expected 1 problem")
return
}
let problem = checker.problems[0]
XCTAssertTrue(problem.possibleSolutions.isEmpty)
let link = document.child(at: 1)!.child(at: 1)! as! Link
verifyDiagnostic(diagnostic: problem.diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsLink", expectedRange: link.range!)
}
func testMultipleTopLevelInvalidElements() {
let source = """
# Title
 Hello [there](http://example.com/) World 
"""
let document = Document(parsing: source, options: [])
checker.visit(document)
guard checker.problems.count == 3 else {
XCTFail("Expected 3 problems")
return
}
let abstract = document.child(at: 1)!
let image1 = abstract.child(at: 0)! as! Image
let image2 = abstract.child(at: 2)! as! Link
let image3 = abstract.child(at: 4)! as! Image
verifyDiagnostic(diagnostic: checker.problems[0].diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsImage", expectedRange: image1.range!)
verifyDiagnostic(diagnostic: checker.problems[1].diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsLink", expectedRange: image2.range!)
verifyDiagnostic(diagnostic: checker.problems[2].diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsImage", expectedRange: image3.range!)
}
func testLinkWithinEmphasis() {
let source = """
# Title
Hello *[world](http://example.com)*.
"""
let document = Document(parsing: source, options: [])
checker.visit(document)
guard checker.problems.count == 1 else {
XCTFail("Expected 1 problem")
return
}
let link = document.child(at: 1)!.child(at: 1)!.child(at: 0)! as! Link
verifyDiagnostic(diagnostic: checker.problems[0].diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsLink", expectedRange: link.range!)
}
func testImagesWithinBold() {
let source = """
# Title
Hello **** World
"""
let document = Document(parsing: source, options: [])
checker.visit(document)
guard checker.problems.count == 1 else {
XCTFail("Expected 1 problem")
return
}
let image = document.child(at: 1)!.child(at: 1)!.child(at: 0)! as! Image
verifyDiagnostic(diagnostic: checker.problems[0].diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsImage", expectedRange: image.range!)
}
func testImageInALink() {
let source = """
# Title
Hello **[](http://example.com)** World.
"""
let document = Document(parsing: source, options: [])
checker.visit(document)
guard checker.problems.count == 2 else {
XCTFail("Expected 2 problems")
return
}
let link = document.child(at: 1)!.child(at: 1)!.child(at: 0)! as! Link
let image = document.child(at: 1)!.child(at: 1)!.child(at: 0)!.child(at: 0)! as! Image
verifyDiagnostic(diagnostic: checker.problems[0].diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsLink", expectedRange: link.range!)
verifyDiagnostic(diagnostic: checker.problems[1].diagnostic, expectedIdentifier: "org.swift.docc.SummaryContainsImage", expectedRange: image.range!)
}
}
|
