Skip to content

Commit e81df98

Browse files
cpisciottacpisciotta
committed
Refactor Parser to return CaptureGroup
1 parent 4c27514 commit e81df98

File tree

9 files changed

+52
-62
lines changed

9 files changed

+52
-62
lines changed

‎Sources/XcbeautifyLib/CaptureGroups.swift

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
import Foundation
22

3-
protocol CaptureGroup {
3+
package protocol CaptureGroup {
44
static var outputType: OutputType { get }
55
static var regex: XcbeautifyLib.Regex { get }
66
init?(groups: [String])
77
}
88

99
extension CaptureGroup {
10+
var outputType: OutputType { Self.outputType }
11+
1012
static var pattern: String { regex.pattern }
1113
var pattern: String { Self.regex.pattern }
1214
}

‎Sources/XcbeautifyLib/Formatter.swift

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
import Foundation
22

3-
class Formatter {
3+
package class Formatter {
44

55
private let colored: Bool
66
private let renderer: OutputRendering
77
private let additionalLines: () -> String?
8-
private(set) var preserveUnbeautifiedLines = false
98

10-
init(
9+
package init(
1110
colored: Bool = true,
1211
renderer: Renderer,
13-
preserveUnbeautifiedLines: Bool = false,
1412
additionalLines: @escaping () -> (String?)
1513
) {
1614
self.colored = colored
@@ -22,11 +20,10 @@ class Formatter {
2220
self.renderer = GitHubActionsRenderer()
2321
}
2422

25-
self.preserveUnbeautifiedLines = preserveUnbeautifiedLines
2623
self.additionalLines = additionalLines
2724
}
2825

29-
func format(captureGroup: CaptureGroup) -> String? {
26+
package func format(captureGroup: CaptureGroup) -> String? {
3027
return renderer.beautify(
3128
group: captureGroup,
3229
additionalLines: additionalLines

‎Sources/XcbeautifyLib/Parser.swift

+4-18
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
import Foundation
22

33
package class Parser {
4-
private let formatter: XcbeautifyLib.Formatter
5-
64
package private(set) var outputType = OutputType.undefined
75

86
private lazy var captureGroupTypes: [CaptureGroup.Type] = [
@@ -94,21 +92,9 @@ package class Parser {
9492

9593
// MARK: - Init
9694

97-
package init(
98-
colored: Bool = true,
99-
renderer: Renderer,
100-
preserveUnbeautifiedLines: Bool = false,
101-
additionalLines: @escaping () -> (String?)
102-
) {
103-
self.formatter = Formatter(
104-
colored: colored,
105-
renderer: renderer,
106-
preserveUnbeautifiedLines: preserveUnbeautifiedLines,
107-
additionalLines: additionalLines
108-
)
109-
}
95+
package init() { }
11096

111-
package func parse(line: String) -> String? {
97+
package func parse(line: String) -> CaptureGroup? {
11298
if line.isEmpty {
11399
outputType = .undefined
114100
return nil
@@ -120,7 +106,7 @@ package class Parser {
120106

121107
// Nothing found?
122108
outputType = OutputType.undefined
123-
return formatter.preserveUnbeautifiedLines ? line : nil
109+
return nil
124110
}
125111

126112
guard let captureGroupType = captureGroupTypes[safe: idx] else {
@@ -139,7 +125,7 @@ package class Parser {
139125
// Move found parser to the top, so next time it will be checked first
140126
captureGroupTypes.insert(captureGroupTypes.remove(at: idx), at: 0)
141127

142-
return formatter.format(captureGroup: captureGroup)
128+
return captureGroup
143129
}
144130
}
145131

‎Sources/XcbeautifyLib/Regex.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
final class Regex {
3+
package final class Regex {
44
let pattern: String
55

66
private lazy var regex: NSRegularExpression? = {

‎Sources/XcbeautifyLib/XCBeautifier.swift

+16-3
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,35 @@ import Foundation
22

33
public struct XCBeautifier {
44
private let parser: Parser
5+
private let formatter: Formatter
6+
private let preserveUnbeautifiedLines: Bool
57

68
public init(
79
colored: Bool,
810
renderer: Renderer,
911
preserveUnbeautifiedLines: Bool,
1012
additionalLines: @escaping () -> String?
1113
) {
12-
parser = Parser(
14+
parser = Parser()
15+
16+
formatter = Formatter(
1317
colored: colored,
1418
renderer: renderer,
15-
preserveUnbeautifiedLines: preserveUnbeautifiedLines,
1619
additionalLines: additionalLines
1720
)
21+
22+
self.preserveUnbeautifiedLines = preserveUnbeautifiedLines
1823
}
1924

2025
public func format(line: String) -> String? {
21-
parser.parse(line: line)
26+
guard let captureGroup = parser.parse(line: line) else {
27+
if preserveUnbeautifiedLines {
28+
return line
29+
} else {
30+
return nil
31+
}
32+
}
33+
34+
return formatter.format(captureGroup: captureGroup)
2235
}
2336
}

‎Sources/xcbeautify/Xcbeautify.swift

+11-3
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,24 @@ struct Xcbeautify: ParsableCommand {
5858
return line
5959
}
6060

61-
let parser = Parser(
61+
let parser = Parser()
62+
63+
let formatter = XcbeautifyLib.Formatter(
6264
colored: !disableColoredOutput,
6365
renderer: renderer,
64-
preserveUnbeautifiedLines: preserveUnbeautified,
6566
additionalLines: { readLine() }
6667
)
6768

6869
while let line = readLine() {
6970
guard !line.isEmpty else { continue }
70-
guard let formatted = parser.parse(line: line) else { continue }
71+
guard let captureGroup = parser.parse(line: line) else {
72+
if preserveUnbeautified {
73+
output.write(.undefined, line)
74+
}
75+
76+
continue
77+
}
78+
guard let formatted = formatter.format(captureGroup: captureGroup) else { continue }
7179
output.write(parser.outputType, formatted)
7280
}
7381

‎Tests/XcbeautifyLibTests/ParsingTests/ParsingTests.swift

+4-26
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,7 @@ final class ParsingTests: XCTestCase {
88
var buildLog: [String] = try String(contentsOf: url)
99
.components(separatedBy: .newlines)
1010

11-
let parser = Parser(
12-
colored: false,
13-
renderer: .terminal,
14-
preserveUnbeautifiedLines: false,
15-
additionalLines: {
16-
guard !buildLog.isEmpty else {
17-
XCTFail("The build log should never be empty when fetching additional lines.")
18-
return nil
19-
}
20-
return buildLog.removeFirst()
21-
}
22-
)
11+
let parser = Parser()
2312

2413
var uncapturedOutput = 0
2514

@@ -36,7 +25,7 @@ final class ParsingTests: XCTestCase {
3625
// It uses `XCTAssertEqual` instead of `XCTAssertLessThanOrEqual` as a reminder.
3726
// Update this magic number whenever `uncapturedOutput` is less than the current magic number.
3827
// There's a regression whenever `uncapturedOutput` is greater than the current magic number.
39-
XCTAssertEqual(uncapturedOutput, 2218)
28+
XCTAssertEqual(uncapturedOutput, 833)
4029
}
4130

4231
func testLargeXcodebuildLog() throws {
@@ -45,18 +34,7 @@ final class ParsingTests: XCTestCase {
4534
var buildLog: [String] = try String(contentsOf: url)
4635
.components(separatedBy: .newlines)
4736

48-
let parser = Parser(
49-
colored: false,
50-
renderer: .terminal,
51-
preserveUnbeautifiedLines: false,
52-
additionalLines: {
53-
guard !buildLog.isEmpty else {
54-
XCTFail("The build log should never be empty when fetching additional lines.")
55-
return nil
56-
}
57-
return buildLog.removeFirst()
58-
}
59-
)
37+
let parser = Parser()
6038

6139
var uncapturedOutput = 0
6240

@@ -73,6 +51,6 @@ final class ParsingTests: XCTestCase {
7351
// It uses `XCTAssertEqual` instead of `XCTAssertLessThanOrEqual` as a reminder.
7452
// Update this magic number whenever `uncapturedOutput` is less than the current magic number.
7553
// There's a regression whenever `uncapturedOutput` is greater than the current magic number.
76-
XCTAssertEqual(uncapturedOutput, 77104)
54+
XCTAssertEqual(uncapturedOutput, 28964)
7755
}
7856
}

‎Tests/XcbeautifyLibTests/RendererTests/GitHubActionsRendererTests.swift

+5-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@ import XCTest
33

44
final class GitHubActionsRendererTests: XCTestCase {
55
var parser: Parser!
6+
var formatter: XcbeautifyLib.Formatter!
67

78
override func setUpWithError() throws {
89
try super.setUpWithError()
9-
parser = Parser(colored: false, renderer: .gitHubActions, additionalLines: { nil })
10+
parser = Parser()
11+
formatter = Formatter(colored: false, renderer: .gitHubActions, additionalLines: { nil })
1012
}
1113

1214
private func logFormatted(_ string: String) -> String? {
13-
parser.parse(line: string)
15+
guard let captureGroup = parser.parse(line: string) else { return nil }
16+
return formatter.format(captureGroup: captureGroup)
1417
}
1518

1619
func testAggregateTarget() {

‎Tests/XcbeautifyLibTests/RendererTests/TerminalRendererTests.swift

+5-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@ import XCTest
33

44
final class TerminalRendererTests: XCTestCase {
55
var parser: Parser!
6+
var formatter: XcbeautifyLib.Formatter!
67

78
override func setUpWithError() throws {
89
try super.setUpWithError()
9-
parser = Parser(colored: false, renderer: .terminal, additionalLines: { nil })
10+
parser = Parser()
11+
formatter = Formatter(colored: false, renderer: .terminal, additionalLines: { nil })
1012
}
1113

1214
private func noColoredFormatted(_ string: String) -> String? {
13-
parser.parse(line: string)
15+
guard let captureGroup = parser.parse(line: string) else { return nil }
16+
return formatter.format(captureGroup: captureGroup)
1417
}
1518

1619
func testAggregateTarget() {

0 commit comments

Comments
 (0)