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
|
/*
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 StepTests: XCTestCase {
func testEmpty() throws {
let source = """
@Step
"""
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 step = Step(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertEqual([
"org.swift.docc.HasContent",
], problems.map { $0.diagnostic.identifier })
XCTAssertNotNil(step)
step.map {
XCTAssertTrue($0.content.isEmpty)
XCTAssertTrue($0.caption.isEmpty)
}
}
func testValid() throws {
let source = """
@Step {
This is the step's content.
This is the step's caption.
> Important: This is important.
@Image(source: test.png, alt: "Test 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 step = Step(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertTrue(problems.isEmpty)
XCTAssertNotNil(step)
let expectedDump = """
Step @1:1-9:2
├─ MarkupContainer (1 element)
└─ MarkupContainer (2 elements)
"""
let expectedContentDump = """
├─ Paragraph @2:4-2:31
│ └─ Text @2:4-2:31 "This is the step’s content."
"""
let expectedCaptionDump = """
├─ Paragraph @4:4-4:31
│ └─ Text @4:4-4:31 "This is the step’s caption."
"""
step.map { step in
XCTAssertEqual(expectedDump, step.dump())
XCTAssertEqual(1, step.content.count)
step.content.first.map { content in
XCTAssertEqual(expectedContentDump, content.debugDescription(options: .printSourceLocations))
}
XCTAssertEqual(2, step.caption.count)
step.caption.first.map { caption in
XCTAssertEqual(expectedCaptionDump, caption.debugDescription(options: .printSourceLocations))
}
}
}
func testExtraneousContent() throws {
let source = """
@Step {
This is the step's content.
@Image(source: test.png, alt: "Test image")
- A
- B
This is the step's caption.
> Important: This is not extraneous.
This is an extranous paragraph.
> Note: More than one aside is technically allowed per design.
}
"""
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 step = Step(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertEqual(2, problems.count)
XCTAssertEqual([
"org.swift.docc.Step.ExtraneousContent",
"org.swift.docc.Step.ExtraneousContent",
], problems.map { $0.diagnostic.identifier })
XCTAssertNotNil(step)
let expectedDump = """
Step @1:1-16:2
├─ MarkupContainer (1 element)
└─ MarkupContainer (3 elements)
"""
let expectedContentDump = """
├─ Paragraph @2:4-2:31
│ └─ Text @2:4-2:31 "This is the step’s content."
"""
let expectedCaptionDump = """
├─ Paragraph @9:4-9:31
│ └─ Text @9:4-9:31 "This is the step’s caption."
├─ BlockQuote @11:4-11:40
│ └─ Paragraph @11:6-11:40
│ └─ Text @11:6-11:40 "Important: This is not extraneous."
└─ BlockQuote @15:4-15:66
└─ Paragraph @15:6-15:66
└─ Text @15:6-15:66 "Note: More than one aside is technically allowed per design."
"""
step.map { step in
XCTAssertEqual(expectedDump, step.dump())
XCTAssertEqual(1, step.content.count)
XCTAssertEqual(expectedContentDump, step.content.elements.map { $0.debugDescription(options: .printSourceLocations) }.joined(separator: "\n"))
XCTAssertEqual(3, step.caption.count)
XCTAssertEqual(expectedCaptionDump, step.caption.elements.map { $0.debugDescription(options: .printSourceLocations) }.joined(separator: "\n"))
}
}
}
|
