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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
|
/*
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 Foundation
@testable import SwiftDocC
import Markdown
import XCTest
class RenderContentMetadataTests: XCTestCase {
func testImageMetadata() throws {
let metadata = RenderContentMetadata(anchor: "anchor", title: "title", abstract: [
RenderInlineContent.text("Content"),
])
let image = RenderInlineContent.image(identifier: .init("image-1"), metadata: metadata)
let data = try JSONEncoder().encode(image)
let roundtrip = try JSONDecoder().decode(RenderInlineContent.self, from: data)
guard case RenderInlineContent.image(_, let metadataRoundtrip) = roundtrip else {
XCTFail("Didn't decode image correctly")
return
}
XCTAssertEqual(metadata, metadataRoundtrip)
}
func testTableMetadata() throws {
let metadata = RenderContentMetadata(anchor: "anchor", title: "title", abstract: [
RenderInlineContent.text("Content"),
])
let table = RenderBlockContent.table(.init(header: .both, rows: [], extendedData: [], metadata: metadata))
let data = try JSONEncoder().encode(table)
let roundtrip = try JSONDecoder().decode(RenderBlockContent.self, from: data)
guard case RenderBlockContent.table(let t) = roundtrip else {
XCTFail("Didn't decode table correctly")
return
}
XCTAssertEqual(metadata, t.metadata)
}
func testCodeListingMetadata() throws {
let metadata = RenderContentMetadata(anchor: "anchor", title: "title", abstract: [
RenderInlineContent.text("Content"),
])
let code = RenderBlockContent.codeListing(.init(syntax: nil, code: [], metadata: metadata))
let data = try JSONEncoder().encode(code)
let roundtrip = try JSONDecoder().decode(RenderBlockContent.self, from: data)
guard case RenderBlockContent.codeListing(let roundtripListing) = roundtrip else {
XCTFail("Didn't decode code listing correctly")
return
}
XCTAssertEqual(metadata, roundtripListing.metadata)
}
func testRenderingTables() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var renderContentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/path", fragment: nil, sourceLanguage: .swift))
let source = """
| Column 1 | Column 2 |
| ------------- | ------------- |
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
"""
let document = Document(parsing: source)
// Verifies that a markdown table renders correctly.
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!))
let renderedTable = try XCTUnwrap(result.first as? RenderBlockContent)
let renderCell: ([RenderBlockContent]) -> String = { cell in
return cell.reduce(into: "") { (result, element) in
switch element {
case .paragraph(let p):
guard let para = p.inlineContent.first else { return }
result.append(para.plainText)
default: XCTFail("Unexpected element"); return
}
}
}
switch renderedTable {
case .table(let t):
XCTAssertEqual(t.header, .row)
XCTAssertEqual(t.rows.count, 3)
guard t.rows.count == 3 else { return }
XCTAssertEqual(t.rows[0].cells.map(renderCell), ["Column 1", "Column 2"])
XCTAssertEqual(t.rows[1].cells.map(renderCell), ["Cell 1", "Cell 2"])
XCTAssertEqual(t.rows[2].cells.map(renderCell), ["Cell 3", "Cell 4"])
XCTAssertNil(t.alignments)
default: XCTFail("Unexpected element")
}
}
func testRenderingTableSpans() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var renderContentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/path", fragment: nil, sourceLanguage: .swift))
let source = """
| one | two | three |
| --- | --- | ----- |
| big || small |
| ^ || small |
"""
let document = Document(parsing: source)
// Verifies that a markdown table renders correctly.
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!))
let renderedTable = try XCTUnwrap(result.first as? RenderBlockContent)
let renderCell: ([RenderBlockContent]) -> String = { cell in
return cell.reduce(into: "") { (result, element) in
switch element {
case .paragraph(let p):
guard let para = p.inlineContent.first else { return }
result.append(para.plainText)
default: XCTFail("Unexpected element"); return
}
}
}
let expectedExtendedData: [RenderBlockContent.TableCellExtendedData] = [
.init(rowIndex: 1, columnIndex: 0, colspan: 2, rowspan: 2),
.init(rowIndex: 1, columnIndex: 1, colspan: 0, rowspan: 1),
.init(rowIndex: 2, columnIndex: 0, colspan: 2, rowspan: 0),
.init(rowIndex: 2, columnIndex: 1, colspan: 0, rowspan: 1)
]
switch renderedTable {
case .table(let t):
XCTAssertEqual(t.header, .row)
XCTAssertEqual(t.rows.count, 3)
guard t.rows.count == 3 else { return }
XCTAssertEqual(t.rows[0].cells.map(renderCell), ["one", "two", "three"])
XCTAssertEqual(t.rows[1].cells.map(renderCell), ["big", "", "small"])
XCTAssertEqual(t.rows[2].cells.map(renderCell), ["", "", "small"])
for expectedData in expectedExtendedData {
XCTAssert(t.extendedData.contains(expectedData))
}
XCTAssertNil(t.alignments)
default: XCTFail("Unexpected element")
}
try assertRoundTripCoding(renderedTable)
}
func testRenderingTableColumnAlignments() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var renderContentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/path", fragment: nil, sourceLanguage: .swift))
let source = """
| one | two | three | four |
| :-- | --: | :---: | ---- |
| one | two | three | four |
"""
let document = Document(parsing: source)
// Verifies that a markdown table renders correctly.
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!))
let renderedTable = try XCTUnwrap(result.first as? RenderBlockContent)
let renderCell: ([RenderBlockContent]) -> String = { cell in
return cell.reduce(into: "") { (result, element) in
switch element {
case .paragraph(let p):
guard let para = p.inlineContent.first else { return }
result.append(para.plainText)
default: XCTFail("Unexpected element"); return
}
}
}
switch renderedTable {
case .table(let t):
XCTAssertEqual(t.header, .row)
XCTAssertEqual(t.rows.count, 2)
guard t.rows.count == 2 else { return }
XCTAssertEqual(t.rows[0].cells.map(renderCell), ["one", "two", "three", "four"])
XCTAssertEqual(t.rows[1].cells.map(renderCell), ["one", "two", "three", "four"])
XCTAssertEqual(t.alignments, [.left, .right, .center, .unset])
default: XCTFail("Unexpected element")
}
try assertRoundTripCoding(renderedTable)
}
/// Verifies that a table with `nil` alignments and a table with all-unset alignments still compare as equal.
func testRenderedTableEquality() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var renderContentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/path", fragment: nil, sourceLanguage: .swift))
let source = """
| Column 1 | Column 2 |
| ------------- | ------------- |
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
"""
let document = Document(parsing: source)
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!))
let renderedTable = try XCTUnwrap(result.first as? RenderBlockContent)
guard case let .table(decodedTable) = renderedTable else {
XCTFail("Unexpected RenderBlockContent element")
return
}
XCTAssertNil(decodedTable.alignments)
var modifiedTable = decodedTable
modifiedTable.alignments = [.unset, .unset]
XCTAssertEqual(decodedTable, modifiedTable)
}
/// Verifies that two tables with otherwise-identical contents but different column alignments compare as unequal.
func testRenderedTableInequality() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var renderContentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/path", fragment: nil, sourceLanguage: .swift))
let decodedTableWithUnsetColumns: RenderBlockContent.Table
do {
let source = """
| Column 1 | Column 2 |
| ------------- | ------------- |
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
"""
let document = Document(parsing: source)
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!))
let renderedTable = try XCTUnwrap(result.first as? RenderBlockContent)
guard case let .table(decodedTable) = renderedTable else {
XCTFail("Unexpected RenderBlockContent element")
return
}
decodedTableWithUnsetColumns = decodedTable
}
let decodedTableWithLeftColumns: RenderBlockContent.Table
do {
let source = """
| Column 1 | Column 2 |
| :------------ | :------------ |
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
"""
let document = Document(parsing: source)
// Verifies that a markdown table renders correctly.
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!))
let renderedTable = try XCTUnwrap(result.first as? RenderBlockContent)
guard case let .table(decodedTable) = renderedTable else {
XCTFail("Unexpected RenderBlockContent element")
return
}
decodedTableWithLeftColumns = decodedTable
}
XCTAssertNotEqual(decodedTableWithUnsetColumns, decodedTableWithLeftColumns)
}
func testStrikethrough() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var renderContentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/path", fragment: nil, sourceLanguage: .swift))
let source = """
~~Striken~~ text.
"""
let document = Document(parsing: source)
// Verifies that a markdown strikethrough text renders correctly.
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!.child(at: 0)!))
let element = try XCTUnwrap(result.first as? RenderInlineContent)
switch element {
case .strikethrough(inlineContent: let content):
switch content.first {
case .text(let string): XCTAssertEqual(string, "Striken")
default: XCTFail("Unexpected element")
}
default: XCTFail("Unexpected element")
}
}
func testHeadingAnchorShouldBeEncoded() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var renderContentCompiler = RenderContentCompiler(context: context, bundle: bundle, identifier: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/path", fragment: nil, sourceLanguage: .swift))
let source = """
## テスト
"""
let document = Document(parsing: source)
let result = try XCTUnwrap(renderContentCompiler.visit(document.child(at: 0)!))
let element = try XCTUnwrap(result.first as? RenderBlockContent)
switch element {
case .heading(let heading):
XCTAssertEqual(heading.level, 2)
XCTAssertEqual(heading.text, "テスト")
XCTAssertEqual(heading.anchor, "%E3%83%86%E3%82%B9%E3%83%88", "The UTF-8 representation of テスト is E3 83 86 E3 82 B9 E3 83 88")
default: XCTFail("Unexpected element")
}
}
}
|