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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2023 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 ImageMediaTests: XCTestCase {
func testEmpty() throws {
let source = """
@Image
"""
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 image = ImageMedia(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(image)
XCTAssertEqual(1, problems.count)
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual([
"org.swift.docc.HasArgument.source",
], problems.map { $0.diagnostic.identifier })
}
func testValid() throws {
let imageSource = "/path/to/image"
let alt = "This is an image"
let source = """
@Image(source: "\(imageSource)", alt: "\(alt)")
"""
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 image = ImageMedia(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(image)
XCTAssertTrue(problems.isEmpty)
image.map { image in
XCTAssertEqual(imageSource, image.source.path)
XCTAssertEqual(alt, image.altText)
}
}
func testSpacesInSource() throws {
for imageSource in ["my image.png", "my%20image.png"] {
let alt = "This is an image"
let source = """
@Image(source: "\(imageSource)", alt: "\(alt)")
"""
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 image = ImageMedia(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(image)
XCTAssertTrue(problems.isEmpty)
image.map { image in
XCTAssertEqual(imageSource.removingPercentEncoding!, image.source.path)
XCTAssertEqual(alt, image.altText)
}
}
}
func testIncorrectArgumentLabels() throws {
let source = """
@Image(imgSource: "/img/path", altText: "Text")
"""
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 image = ImageMedia(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(image)
XCTAssertEqual(3, problems.count)
XCTAssertFalse(problems.containsErrors)
let expectedIds = [
"org.swift.docc.UnknownArgument",
"org.swift.docc.HasArgument.source",
]
let problemIds = problems.map(\.diagnostic.identifier)
for id in expectedIds {
XCTAssertTrue(problemIds.contains(id))
}
}
func testRenderImageDirectiveInReferenceMarkup() throws {
do {
let (renderedContent, problems, image) = try parseDirective(ImageMedia.self, in: "BookLikeContent") {
"""
@Image(source: "figure1")
"""
}
XCTAssertNotNil(image)
XCTAssertEqual(problems, [])
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.paragraph(RenderBlockContent.Paragraph(
inlineContent: [.image(
identifier: RenderReferenceIdentifier("figure1"),
metadata: nil
)]
))
]
)
}
do {
let (renderedContent, problems, image) = try parseDirective(ImageMedia.self, in: "BookLikeContent") {
"""
@Image(source: "unknown-image")
"""
}
XCTAssertNotNil(image)
XCTAssertEqual(problems, ["1: warning – org.swift.docc.unresolvedResource.Image"])
XCTAssertEqual(renderedContent, [])
}
}
func testRenderImageDirectiveWithCaption() throws {
let (renderedContent, problems, image) = try parseDirective(ImageMedia.self, in: "BookLikeContent") {
"""
@Image(source: "figure1") {
This is my caption.
}
"""
}
XCTAssertNotNil(image)
XCTAssertEqual(problems, [])
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.paragraph(RenderBlockContent.Paragraph(
inlineContent: [.image(
identifier: RenderReferenceIdentifier("figure1"),
metadata: RenderContentMetadata(abstract: [.text("This is my caption.")])
)]
))
]
)
}
func testImageDirectiveDiagnosesDeviceFrameByDefault() throws {
let (renderedContent, problems, image) = try parseDirective(ImageMedia.self, in: "BookLikeContent") {
"""
@Image(source: "figure1", deviceFrame: phone)
"""
}
XCTAssertNotNil(image)
XCTAssertEqual(problems, ["1: warning – org.swift.docc.UnknownArgument"])
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.paragraph(RenderBlockContent.Paragraph(
inlineContent: [.image(
identifier: RenderReferenceIdentifier("figure1"),
metadata: nil
)]
))
]
)
}
func testRenderImageDirectiveWithDeviceFrame() throws {
enableFeatureFlag(\.isExperimentalDeviceFrameSupportEnabled)
let (renderedContent, problems, image) = try parseDirective(ImageMedia.self, in: "BookLikeContent") {
"""
@Image(source: "figure1", deviceFrame: phone)
"""
}
XCTAssertNotNil(image)
XCTAssertEqual(problems, [])
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.paragraph(RenderBlockContent.Paragraph(
inlineContent: [.image(
identifier: RenderReferenceIdentifier("figure1"),
metadata: RenderContentMetadata(deviceFrame: "phone")
)]
))
]
)
}
func testRenderImageDirectiveWithDeviceFrameAndCaption() throws {
enableFeatureFlag(\.isExperimentalDeviceFrameSupportEnabled)
let (renderedContent, problems, image) = try parseDirective(ImageMedia.self, in: "BookLikeContent") {
"""
@Image(source: "figure1", deviceFrame: laptop) {
This is my caption.
}
"""
}
XCTAssertNotNil(image)
XCTAssertEqual(problems, [])
XCTAssertEqual(
renderedContent,
[
RenderBlockContent.paragraph(RenderBlockContent.Paragraph(
inlineContent: [.image(
identifier: RenderReferenceIdentifier("figure1"),
metadata: RenderContentMetadata(abstract: [.text("This is my caption.")], deviceFrame: "laptop")
)]
))
]
)
}
func testImageDirectiveDoesNotResolveVideoReference() throws {
// First check that the Video exists
let (_, videoProblems, _) = try parseDirective(VideoMedia.self, in: "TestBundle") {
"""
@Video(source: "introvideo")
"""
}
XCTAssertEqual(videoProblems, [])
// Then check that it doesn't resolve as an image
let (renderedContent, imageProblems, image) = try parseDirective(ImageMedia.self, in: "TestBundle") {
"""
@Image(source: "introvideo")
"""
}
XCTAssertNotNil(image)
XCTAssertEqual(imageProblems, ["1: warning – org.swift.docc.unresolvedResource.Image"])
XCTAssertEqual(renderedContent, [])
}
}
|
