Json Progress File

Author: roulpriya

Sources/Swiftly/JsonFileProgressReporter.swift

@@ -0,0 +1,58 @@
+import Foundation
+import SwiftlyCore
+import SystemPackage
+import TSCUtility
+
+enum ProgressInfo: Codable {
+    case step(timestamp: Date, percent: Int, text: String)
+    case complete(success: Bool)
+}
+
+struct JsonFileProgressReporter: ProgressAnimationProtocol {
+    let filePath: FilePath
+    private let encoder: JSONEncoder
+
+    init(filePath: FilePath, encoder: JSONEncoder = JSONEncoder()) {
+        self.filePath = filePath
+        self.encoder = encoder
+    }
+
+    private func writeProgress(_ progress: ProgressInfo) {
+        let jsonData = try? self.encoder.encode(progress)
+        guard let jsonData = jsonData, let jsonString = String(data: jsonData, encoding: .utf8)
+        else {
+            print("Failed to encode progress entry to JSON")
+            return
+        }
+
+        let jsonLine = jsonString + "\n"
+
+        do {
+            try jsonLine.append(to: self.filePath)
+        } catch {
+            print("Failed to write progress entry to \(self.filePath): \(error)")
+        }
+    }
+
+    func update(step: Int, total: Int, text: String) {
+        assert(step <= total)
+        self.writeProgress(
+            ProgressInfo.step(
+                timestamp: Date(),
+                percent: Int(Double(step) / Double(total) * 100),
+                text: text
+            ))
+    }
+
+    func complete(success: Bool) {
+        self.writeProgress(ProgressInfo.complete(success: success))
+    }
+
+    func clear() {
+        do {
+            try FileManager.default.removeItem(atPath: self.filePath.string)
+        } catch {
+            print("Failed to clear progress file at \(self.filePath): \(error)")
+        }
+    }
+}

Sources/SwiftlyCore/FileManager+FilePath.swift

@@ -190,6 +190,22 @@ extension String {
         try self.write(to: URL(fileURLWithPath: path.string), atomically: atomically, encoding: enc)
     }
 
+    public func append(to path: FilePath, encoding enc: String.Encoding = .utf8) throws {
+        if !FileManager.default.fileExists(atPath: path.string) {
+            try self.write(to: path, atomically: true, encoding: enc)
+            return
+        }
+
+        let fileHandle = try FileHandle(forWritingTo: URL(fileURLWithPath: path.string))
+        defer { fileHandle.closeFile() }
+        fileHandle.seekToEndOfFile()
+        if let data = self.data(using: enc) {
+            fileHandle.write(data)
+        } else {
+            throw SwiftlyError(message: "Failed to convert string to data with encoding \(enc)")
+        }
+    }
+
     public init(contentsOf path: FilePath, encoding enc: String.Encoding = .utf8) throws {
         try self.init(contentsOf: URL(fileURLWithPath: path.string), encoding: enc)
     }

Tests/SwiftlyTests/JsonFileProgressReporterTests.swift

@@ -1,4 +1,6 @@
 import Foundation
+@testable import Swiftly
+@testable import SwiftlyCore
 import SystemPackage
 import Testing
 
@@ -100,6 +102,20 @@ import Testing
         try FileManager.default.removeItem(atPath: tempFile.string)
     }
 
+    @Test("Test clear method removes file")
+    func testClearRemovesFile() throws {
+        let tempFile = fs.mktemp(ext: ".json")
+        let reporter = JsonFileProgressReporter(filePath: tempFile)
+
+        reporter.update(step: 1, total: 2, text: "Test")
+
+        #expect(FileManager.default.fileExists(atPath: tempFile.string))
+
+        reporter.clear()
+
+        #expect(!FileManager.default.fileExists(atPath: tempFile.string))
+    }
+
     @Test("Test multiple progress updates create multiple lines")
     func testMultipleUpdatesCreateMultipleLines() async throws {
         let tempFile = fs.mktemp(ext: ".json")