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
|
/*
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
class CoverageDetailedOutputTests: XCTestCase {
func testEmptyTable() throws {
let source: [CoverageDataEntry] = []
let result = CoverageDataEntry.generateSummary(
of: source,
shouldGenerateBrief: true,
shouldGenerateDetailed: true
)
let expected = """
| Abstract | Curated | Code Listing
Types | (0/0) | (0/0) | (0/0)
Members | (0/0) | (0/0) | (0/0)
Globals | (0/0) | (0/0) | (0/0)
Symbol Name Kind Abstract? Curated? Code Listing? Parameters Language USR
--No Symbols to display--
"""
XCTAssertEqual(result, expected)
}
func testTableWithSingleType() {
let source: [CoverageDataEntry] = [
CoverageDataEntry(
title: "MyDocumentedUncuratedClass",
usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
sourceLanguage: .swift,
availableSourceLanguages: [.swift],
kind: .class,
hasAbstract: true,
isCurated: false,
hasCodeListing: false,
availability: nil,
kindSpecificData: .class(memberStats: [:])),
]
let result = CoverageDataEntry.generateSummary(
of: source,
shouldGenerateBrief: true,
shouldGenerateDetailed: true
)
let expected = """
| Abstract | Curated | Code Listing
Types | \(ratio(1, 1, length: 15)) | \(ratio(0, 1, length: 15)) | \(ratio(0, 1))
Members | (0/0) | (0/0) | (0/0)
Globals | (0/0) | (0/0) | (0/0)
Symbol Name Kind Abstract? Curated? Code Listing? Parameters Language USR
MyDocumentedUncuratedClass | Class | true | false | false | - | Swift | doc://org.swift.docc.example/documentation/MyLibrary/MyClass
"""
XCTAssertEqual(result, expected)
}
func testTableWithOneMemberOneType() {
let source: [CoverageDataEntry] = [
CoverageDataEntry(
title: "MyDocumentedUncuratedClass",
usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass",
sourceLanguage: .swift,
availableSourceLanguages: [.swift],
kind: .class,
hasAbstract: true,
isCurated: false,
hasCodeListing: true,
availability: nil,
kindSpecificData: .class(memberStats: [:])),
CoverageDataEntry(
title: "MyDocumentedUncuratedClassProperty",
usr: "doc://org.swift.docc.example/documentation/MyLibrary/MyClass/myProperty",
sourceLanguage: .swift,
availableSourceLanguages: [.swift],
kind: .instanceProperty,
hasAbstract: false,
isCurated: true,
hasCodeListing: false,
availability: nil,
kindSpecificData: .instanceProperty),
]
let result = CoverageDataEntry.generateSummary(
of: source,
shouldGenerateBrief: false,
shouldGenerateDetailed: true
)
let expected = """
Symbol Name Kind Abstract? Curated? Code Listing? Parameters Language USR
MyDocumentedUncuratedClass | Class | true | false | true | - | Swift | doc://org.swift.docc.example/documentation/MyLibrary/MyClass
MyDocumentedUncuratedClassProp | Instance Property | false | true | false | - | Swift | doc://org.swift.docc.example/documentation/MyLibrary/MyClass/myProperty
"""
XCTAssertEqual(result, expected)
}
}
|
