add benchmark user interface within settings

Author: chrisknapp98

Core/Sources/HostApp/Benchmark/DI/BenchmarkModule.swift

@@ -0,0 +1,45 @@
+protocol BenchmarkModuleType {
+    func provide() -> BenchmarkViewModel
+    func provide() -> OutputConfigurationViewModel
+    func provide() -> AddDirectoryViewModel
+}
+
+class BenchmarkModule: BenchmarkModuleType {
+    private var benchmarkSettingsRepository: BenchmarkSettingsRepository?
+    
+    static let shared: BenchmarkModuleType = BenchmarkModule()
+    
+    private func component() -> LocalStorageManager {
+        UserDefaultsLocalStorageManager()
+    }
+    
+    private func component() -> BenchmarkSettingsRepository {
+        if let repository = benchmarkSettingsRepository {
+            return repository
+        } else {
+            let repository = LocalBenchmarkSettingsRepository(
+                localStorageManager: component()
+            )
+            benchmarkSettingsRepository = repository
+            return repository
+        }
+    }
+    
+    func provide() -> BenchmarkViewModel {
+        BenchmarkViewModel(
+            benchmarkSettingsRepository: component()
+        )
+    }
+    
+    func provide() -> OutputConfigurationViewModel {
+        OutputConfigurationViewModel(
+            benchmarkSettingsRepository: component()
+        )
+    }
+    
+    func provide() -> AddDirectoryViewModel {
+        AddDirectoryViewModel(
+            benchmarkSettingsRepository: component()
+        )
+    }
+}

Core/Sources/HostApp/Benchmark/Data/Entity/BenchmarkDirectoryDTO.swift

@@ -0,0 +1,6 @@
+import Foundation
+
+struct BenchmarkDirectoryDTO: Codable {
+    let name: String
+    let url: URL
+}

Core/Sources/HostApp/Benchmark/Data/Repository/LocalBenchmarkSettingsRepository.swift

@@ -0,0 +1,83 @@
+import Combine
+
+class LocalBenchmarkSettingsRepository: BenchmarkSettingsRepository {
+    private let localStorageManager: LocalStorageManager
+    private let benchmarkDirectoriesKey = "benchmarkDirectories"
+    private let benchmarkOutputDirectoryKey = "benchmarkOutputDirectory"
+    private let defaultOutputDirectory = "~Desktop/benchmark_output"
+    
+    private let currentBenchmarkDirectories: CurrentValueSubject<[BenchmarkDirectory], Never> = CurrentValueSubject([])
+    var benchmarkDirectories: AnyPublisher<[BenchmarkDirectory], Never> {
+        currentBenchmarkDirectories.eraseToAnyPublisher()
+    }
+    
+    private let benchmarkOutputDirectory: CurrentValueSubject<String, Never> = CurrentValueSubject("")
+    var outputDirectory: AnyPublisher<String, Never> {
+        benchmarkOutputDirectory.eraseToAnyPublisher()
+    }
+    
+    init(localStorageManager: LocalStorageManager) {
+        self.localStorageManager = localStorageManager
+        if let benchmarkDirectories = try? retrieveBenchmarkDirectories() {
+            currentBenchmarkDirectories.send(benchmarkDirectories)
+        }
+        if let outputDirectory = try? loadBenchmarkOutputDirectory() {
+            benchmarkOutputDirectory.send(outputDirectory)
+        }
+    }
+    
+    func saveBenchmarkDirectory(_ directory: BenchmarkDirectory) throws {
+        let currentEntries = currentBenchmarkDirectories.value
+        let updatedEntries = currentEntries + [directory]
+        let data = updatedEntries.mapToDTOs()
+        try localStorageManager.save(codable: data, key: benchmarkDirectoriesKey)
+        currentBenchmarkDirectories.send(updatedEntries)
+    }
+    
+    func deleteBenchmarkDirectory(_ directory: BenchmarkDirectory) throws {
+        var currentEntries = currentBenchmarkDirectories.value
+        currentEntries.removeAll { $0 == directory }
+        let data = currentEntries.mapToDTOs()
+        try localStorageManager.save(codable: data, key: benchmarkDirectoriesKey)
+        currentBenchmarkDirectories.send(currentEntries)
+    }
+    
+    private func retrieveBenchmarkDirectories() throws -> [BenchmarkDirectory] {
+        let data: [BenchmarkDirectoryDTO] = try localStorageManager.load(key: benchmarkDirectoriesKey)
+        return data.map { $0.mapToDomain() }
+    }
+    
+    func saveBenchmarkOutputDirectory(_ directory: String) throws {
+        try localStorageManager.save(codable: directory, key: benchmarkOutputDirectoryKey)
+        benchmarkOutputDirectory.send(directory)
+    }
+    
+    private func loadBenchmarkOutputDirectory() throws -> String {
+        do {
+            return try localStorageManager.load(key: benchmarkOutputDirectoryKey)
+        } catch LocalStorageError.noDataForKey {
+            try saveBenchmarkOutputDirectory(defaultOutputDirectory)
+            return defaultOutputDirectory
+        }
+            
+    }
+    
+}
+
+extension Array where Element == BenchmarkDirectory {
+    func mapToDTOs() -> [BenchmarkDirectoryDTO] {
+        return self.map { $0.mapToDTO() }
+    }
+}
+
+extension BenchmarkDirectory {
+    func mapToDTO() -> BenchmarkDirectoryDTO {
+        return BenchmarkDirectoryDTO(name: name, url: url)
+    }
+}
+   
+extension BenchmarkDirectoryDTO {
+    func mapToDomain() -> BenchmarkDirectory {
+        return BenchmarkDirectory(name: name, url: url)
+    }
+}

Core/Sources/HostApp/Benchmark/Domain/Entity/BenchmarkDirectory.swift

@@ -0,0 +1,6 @@
+import Foundation
+
+struct BenchmarkDirectory: Hashable {
+    let name: String
+    let url: URL
+}

Core/Sources/HostApp/Benchmark/Domain/Repository/BenchmarkSettingsRepository.swift

@@ -0,0 +1,9 @@
+import Combine
+
+protocol BenchmarkSettingsRepository {
+    var benchmarkDirectories: AnyPublisher<[BenchmarkDirectory], Never> { get }
+    var outputDirectory: AnyPublisher<String, Never> { get }
+    func saveBenchmarkDirectory(_ directory: BenchmarkDirectory) throws
+    func deleteBenchmarkDirectory(_ directory: BenchmarkDirectory) throws
+    func saveBenchmarkOutputDirectory(_ directory: String) throws
+}

Core/Sources/HostApp/Benchmark/LocalStorage/Data/Entity/LocalStorageError.swift

@@ -0,0 +1,5 @@
+enum LocalStorageError: Error {
+    case encodingError
+    case noDataForKey
+    case decodingError
+}

Core/Sources/HostApp/Benchmark/LocalStorage/Data/Manager/UserDefaultsLocalStorageManager.swift

@@ -0,0 +1,30 @@
+import Foundation
+
+class UserDefaultsLocalStorageManager: LocalStorageManager {
+    
+    private let userDefaults: UserDefaults = UserDefaults()
+    
+    func save<T: Codable>(codable: T, key: String) throws {
+        let encoder = JSONEncoder()
+        guard let encoded = try? encoder.encode(codable) else {
+            throw LocalStorageError.encodingError
+        }
+        userDefaults.set(encoded, forKey: key)
+    }
+    
+    func load<T: Codable>(key: String) throws -> T {
+        guard let data = userDefaults.data(forKey: key) else {
+            throw LocalStorageError.noDataForKey
+        }
+        let decoder = JSONDecoder()
+        guard let decoded = try? decoder.decode(T.self, from: data) else {
+            throw LocalStorageError.decodingError
+        }
+        return decoded
+    }
+    
+    func delete(key: String) {
+        userDefaults.removeObject(forKey: key)
+    }
+    
+}

Core/Sources/HostApp/Benchmark/LocalStorage/Domain/Manager/LocalStorageManager.swift

@@ -0,0 +1,5 @@
+protocol LocalStorageManager {
+    func save<T: Codable>(codable: T, key: String) throws
+    func load<T: Codable>(key: String) throws -> T
+    func delete(key: String)
+}

Core/Sources/HostApp/Benchmark/Presentation/View/AddDirectoryButtonView.swift

@@ -0,0 +1,22 @@
+import SwiftUI
+
+struct AddDirectoryButtonView: View {
+    private let module: BenchmarkModuleType
+    @State private var isShowingSheet = false
+    
+    init(module: BenchmarkModuleType) {
+        self.module = module
+    }
+    
+    var body: some View {
+        Button {
+            isShowingSheet.toggle()
+        } label : {
+            Label("add directory", systemImage: "plus")
+                .foregroundStyle(.foreground) // to remove green accent color from system image
+        }
+        .sheet(isPresented: $isShowingSheet) {
+            AddDirectoryView(module: module)
+        }
+    }
+}

Core/Sources/HostApp/Benchmark/Presentation/View/AddDirectoryView.swift

@@ -0,0 +1,44 @@
+import SwiftUI
+
+struct AddDirectoryView: View {
+    @State private var currentDirectoryName: String = ""
+    @State private var currentDirectory: String = ""
+    @StateObject var viewModel: AddDirectoryViewModel
+    @Environment(\.dismiss) private var dismiss
+    
+    private let labelWidth: CGFloat = 100
+    
+    init(module: BenchmarkModuleType) {
+        _viewModel = StateObject(wrappedValue: module.provide())
+    }
+    
+    var body: some View {
+        VStack {
+            HStack {
+                Text("Name")
+                    .frame(width: labelWidth, alignment: .leading)
+                TextField("Name", text: $currentDirectoryName, prompt: Text("Project X"))
+                    .textFieldStyle(PlainTextFieldStyle())
+            }
+            HStack {
+                Text("Directory")
+                    .frame(width: labelWidth, alignment: .leading)
+                TextField("Directory", text: $currentDirectory, prompt: Text("/path/to/directory"))
+                    .textFieldStyle(PlainTextFieldStyle())
+            }
+            
+        }
+        .padding()
+        
+        HStack {
+            Button("Cancel") {
+                dismiss()
+            }
+            Button("Save") {
+                viewModel.saveNewDirectory(name: currentDirectoryName, directory: currentDirectory)
+                dismiss()
+            }
+        }
+        .padding([.horizontal, .bottom])
+    }
+}