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
|
/*
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
public class ExternalLinkTitleTests: XCTestCase {
private func getTranslatorAndBlockContentForMarkup(_ markupSource: String) throws -> (translator: RenderNodeTranslator, content: [RenderBlockContent]) {
let document = Document(parsing: markupSource, options: [.parseBlockDirectives, .parseSymbolLinks])
let testReference = ResolvedTopicReference(bundleIdentifier: "org.swift.docc", path: "/test", sourceLanguage: .swift)
let node = DocumentationNode(reference: testReference,
kind: .article,
sourceLanguage: .swift,
name: .conceptual(title: "Title"),
markup: document,
semantic: Semantic())
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let result = translator.visit(MarkupContainer(document.children)) as! [RenderBlockContent]
return (translator, result)
}
func testPlainTextExternalLinkTitle() throws {
let markupSource = """
# Test
This is a plain text link: [Example](https://www.example.com).
"""
let (translator, content) = try getTranslatorAndBlockContentForMarkup(markupSource)
guard case let .paragraph(firstParagraph) = content[1] else {
XCTFail("Unexpected render tree.")
return
}
let expectedReferenceIdentifier = RenderReferenceIdentifier.init(forExternalLink: "https://www.example.com")
XCTAssertEqual(firstParagraph.inlineContent[1], RenderInlineContent.reference(identifier: expectedReferenceIdentifier, isActive: true, overridingTitle: nil, overridingTitleInlineContent: nil))
let linkReference = translator.linkReferences[expectedReferenceIdentifier.identifier]
XCTAssertNotNil(linkReference, "Link reference should have been collected by translator.")
let expectedLinkTitle: [RenderInlineContent] = [
.text("Example"),
]
XCTAssertEqual(linkReference?.title, "Example")
XCTAssertEqual(linkReference?.titleInlineContent, expectedLinkTitle, "Plain text title should have been rendered.")
}
func testEmphasisExternalLinkTitle() throws {
let markupSource = """
# Test
This is an emphasized text link: [*Apple*](https://www.example.com).
"""
let (translator, content) = try getTranslatorAndBlockContentForMarkup(markupSource)
guard case let .paragraph(firstParagraph) = content[1] else {
XCTFail("Unexpected render tree.")
return
}
let expectedReferenceIdentifier = RenderReferenceIdentifier.init(forExternalLink: "https://www.example.com")
XCTAssertEqual(firstParagraph.inlineContent[1], RenderInlineContent.reference(identifier: expectedReferenceIdentifier, isActive: true, overridingTitle: nil, overridingTitleInlineContent: nil))
let linkReference = translator.linkReferences[expectedReferenceIdentifier.identifier]
XCTAssertNotNil(linkReference, "Link reference should have been collected by translator.")
let expectedLinkTitle: [RenderInlineContent] = [
.emphasis(inlineContent: [.text("Apple")]),
]
XCTAssertEqual(linkReference?.title, "Apple")
XCTAssertEqual(linkReference?.titleInlineContent, expectedLinkTitle, "Emphasized text title should have been rendered.")
}
func testStrongExternalLinkTitle() throws {
let markupSource = """
# Test
This is a strong text link: [**Apple**](https://www.example.com).
"""
let (translator, content) = try getTranslatorAndBlockContentForMarkup(markupSource)
guard case let .paragraph(firstParagraph) = content[1] else {
XCTFail("Unexpected render tree.")
return
}
let expectedReferenceIdentifier = RenderReferenceIdentifier.init(forExternalLink: "https://www.example.com")
XCTAssertEqual(firstParagraph.inlineContent[1], RenderInlineContent.reference(identifier: expectedReferenceIdentifier, isActive: true, overridingTitle: nil, overridingTitleInlineContent: nil))
let linkReference = translator.linkReferences[expectedReferenceIdentifier.identifier]
XCTAssertNotNil(linkReference, "Link reference should have been collected by translator.")
let expectedLinkTitle: [RenderInlineContent] = [
.strong(inlineContent: [.text("Apple")]),
]
XCTAssertEqual(linkReference?.title, "Apple")
XCTAssertEqual(linkReference?.titleInlineContent, expectedLinkTitle, "Strong text title should have been rendered.")
}
func testCodeVoiceExternalLinkTitle() throws {
let markupSource = """
# Test
This is a code voice text link: [`Apple`](https://www.example.com).
"""
let (translator, content) = try getTranslatorAndBlockContentForMarkup(markupSource)
guard case let .paragraph(firstParagraph) = content[1] else {
XCTFail("Unexpected render tree.")
return
}
let expectedReferenceIdentifier = RenderReferenceIdentifier.init(forExternalLink: "https://www.example.com")
XCTAssertEqual(firstParagraph.inlineContent[1], RenderInlineContent.reference(identifier: expectedReferenceIdentifier, isActive: true, overridingTitle: nil, overridingTitleInlineContent: nil))
let linkReference = translator.linkReferences[expectedReferenceIdentifier.identifier]
XCTAssertNotNil(linkReference, "Link reference should have been collected by translator.")
let expectedLinkTitle: [RenderInlineContent] = [
.codeVoice(code: "Apple"),
]
XCTAssertEqual(linkReference?.title, "Apple")
XCTAssertEqual(linkReference?.titleInlineContent, expectedLinkTitle, "Code voice text title should have been rendered.")
}
func testMixedExternalLinkTitle() throws {
let markupSource = """
# Test
This is a mixed text link: [**This** *is* a `fancy` _link_ title.](https://www.example.com).
"""
let (translator, content) = try getTranslatorAndBlockContentForMarkup(markupSource)
guard case let .paragraph(firstParagraph) = content[1] else {
XCTFail("Unexpected render tree.")
return
}
let expectedReferenceIdentifier = RenderReferenceIdentifier.init(forExternalLink: "https://www.example.com")
XCTAssertEqual(firstParagraph.inlineContent[1], RenderInlineContent.reference(identifier: expectedReferenceIdentifier, isActive: true, overridingTitle: nil, overridingTitleInlineContent: nil))
let linkReference = translator.linkReferences[expectedReferenceIdentifier.identifier]
XCTAssertNotNil(linkReference, "Link reference should have been collected by translator.")
let expectedLinkTitle: [RenderInlineContent] = [
.strong(inlineContent: [.text("This")]),
.text(" "),
.emphasis(inlineContent: [.text("is")]),
.text(" a "),
.codeVoice(code: "fancy"),
.text(" "),
.emphasis(inlineContent: [.text("link")]),
.text(" title."),
]
XCTAssertEqual(linkReference?.title, "This is a fancy link title.")
XCTAssertEqual(linkReference?.titleInlineContent, expectedLinkTitle, "Mixed text title should have been rendered.")
}
func testMultipleLinksWithEqualURL() throws {
let markupSource = """
# Test
This is a strong text link: [**Apple**](https://www.example.com).
This is an emphasized text link: [*Apple*](https://www.example.com).
"""
let (translator, content) = try getTranslatorAndBlockContentForMarkup(markupSource)
guard case let .paragraph(firstParagraph) = content[1] else {
XCTFail("Unexpected render tree.")
return
}
let paragraphContent = firstParagraph.inlineContent
let expectedReferenceIdentifier = RenderReferenceIdentifier.init(forExternalLink: "https://www.example.com")
XCTAssertEqual(paragraphContent[1], RenderInlineContent.reference(identifier: expectedReferenceIdentifier, isActive: true, overridingTitle: nil, overridingTitleInlineContent: nil))
let linkReference = translator.linkReferences[expectedReferenceIdentifier.identifier]
XCTAssertNotNil(linkReference, "Link reference should have been collected by translator.")
let firstExpectedLinkTitle: [RenderInlineContent] = [
.strong(inlineContent: [.text("Apple")]),
]
XCTAssertEqual(linkReference?.title, "Apple")
XCTAssertEqual(linkReference?.titleInlineContent, firstExpectedLinkTitle, "Stronge text title should have been rendered.")
let secondExpectedLinkTitle: [RenderInlineContent] = [
.emphasis(inlineContent: [.text("Apple")]),
]
XCTAssertEqual(paragraphContent[5],
RenderInlineContent.reference(identifier: expectedReferenceIdentifier, isActive: true, overridingTitle: "Apple", overridingTitleInlineContent: secondExpectedLinkTitle),
"Second reference to same link should have overriden link title.")
}
}
|
