Merge branch 'main' into dep-injection

Author: austincondiff

.all-contributorsrc

@@ -647,7 +647,8 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/1909987?v=4",
       "profile": "https://github.com/armartinez",
       "contributions": [
-        "bug"
+        "bug",
+        "code"
       ]
     },
     {

CodeEdit.xcodeproj/project.pbxproj

@@ -0,0 +1,30 @@
+//
+//  ProjectCEWorkspaceSettings.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 27/3/24.
+//
+
+import SwiftUI
+
+extension CEWorkspaceSettingsData {
+    /// Workspace settings for the project tab.
+    struct ProjectSettings: Codable, Hashable, SearchableSettingsPage {
+        var searchKeys: [String] {
+            [
+                "Project Name",
+            ]
+            .map { NSLocalizedString($0, comment: "") }
+        }
+
+        var projectName: String = ""
+
+        init() {}
+
+        /// Explicit decoder init for setting default values when key is not present in `JSON`
+        init(from decoder: Decoder) throws {
+            let container = try decoder.container(keyedBy: CodingKeys.self)
+            self.projectName = try container.decodeIfPresent(String.self, forKey: .projectName) ?? ""
+        }
+    }
+}

CodeEdit/Features/CEWorkspace/Extensions/CEWorkspaceSettingsData+ProjectSettings.swift

@@ -0,0 +1,35 @@
+//
+//  CEWorkspaceSettingsData+TasksSettings.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 27/3/24.
+//
+
+import Foundation
+import Collections
+
+extension CEWorkspaceSettingsData {
+    /// Workspace settings for the tasks tab.
+    struct TasksSettings: Codable, Hashable, SearchableSettingsPage {
+        var items: [CETask] = []
+
+        var searchKeys: [String] {
+            [
+                "Tasks"
+            ]
+                .map { NSLocalizedString($0, comment: "") }
+        }
+
+        /// The tasks functionality behavior of the app
+        var enabled: Bool = true
+
+        init() {}
+
+        /// Explicit decoder init for setting default values when key is not present in `JSON`
+        init(from decoder: Decoder) throws {
+            let container = try decoder.container(keyedBy: CodingKeys.self)
+            self.items = try container.decodeIfPresent([CETask].self, forKey: .items) ?? []
+            self.enabled = try container.decodeIfPresent(Bool.self, forKey: .enabled) ?? true
+        }
+    }
+}

CodeEdit/Features/CEWorkspace/Extensions/CEWorkspaceSettingsData+TasksSettings.swift

@@ -0,0 +1,71 @@
+//
+//  CETask.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 2/4/24.
+//
+
+import SwiftUI
+
+/// CodeEdit task that will be executed by the task manager.
+struct CETask: Identifiable, Hashable, Codable {
+    var id = UUID()
+    var name: String = ""
+    var target: String = ""
+    var workingDirectory: String = ""
+    var command: String = ""
+    var environmentVariables: [EnvironmentVariable]  = []
+
+    var isInvalid: Bool {
+        name.isEmpty ||
+        command.isEmpty ||
+        target.isEmpty ||
+        workingDirectory.isEmpty
+    }
+
+    enum CodingKeys: String, CodingKey {
+        case name
+        case target
+        case workingDirectory
+        case command
+        case environmentVariables
+    }
+
+    struct EnvironmentVariable: Identifiable, Hashable, Codable {
+        var id = UUID()
+        var name: String = ""
+        var value: String = ""
+
+        /// Enables encoding the environment variables as a `name`:`value`pair.
+        private struct CodingKeys: CodingKey {
+            var stringValue: String
+            var intValue: Int?
+
+            init?(stringValue: String) {
+                self.stringValue = stringValue
+                self.intValue = nil
+            }
+
+            /// Required by the CodingKey protocol but not being currently used.
+            init?(intValue: Int) {
+                self.stringValue = "\(intValue)"
+                self.intValue = intValue
+            }
+        }
+
+        init() {}
+
+        init(from decoder: Decoder) throws {
+            let container = try decoder.container(keyedBy: CodingKeys.self)
+            for key in container.allKeys {
+                name = key.stringValue
+                value = try container.decode(String.self, forKey: key)
+            }
+        }
+
+        public func encode(to encoder: Encoder) throws {
+            var container = encoder.container(keyedBy: CodingKeys.self)
+            try container.encode(value, forKey: CodingKeys(stringValue: name)!)
+        }
+    }
+}

CodeEdit/Features/CEWorkspace/Models/CETask.swift

@@ -0,0 +1,73 @@
+//
+//  CEWorkspaceSettings.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 27/3/24.
+//
+
+import SwiftUI
+import Combine
+
+/// The CodeEdit workspace settings model.
+final class CEWorkspaceSettings: ObservableObject {
+    @ObservedObject private var workspace: WorkspaceDocument
+    @Published public var preferences: CEWorkspaceSettingsData = .init()
+
+    private var savedSettings = false
+    private var storeTask: AnyCancellable!
+    private let fileManager = FileManager.default
+
+    private var folderURL: URL? {
+        guard let workspaceURL = workspace.fileURL else {
+            return nil
+        }
+
+        return workspaceURL
+            .appendingPathComponent(".codeedit", isDirectory: true)
+    }
+
+    private var settingsURL: URL? {
+        folderURL?
+            .appendingPathComponent("settings")
+            .appendingPathExtension("json")
+    }
+
+    init(workspaceDocument: WorkspaceDocument) {
+        self.workspace = workspaceDocument
+
+        loadSettings()
+
+        self.storeTask = self.$preferences.throttle(for: 2, scheduler: RunLoop.main, latest: true).sink {
+            if !self.savedSettings, let folderURL = self.folderURL {
+                try? self.fileManager.createDirectory(at: folderURL, withIntermediateDirectories: false)
+                self.savedSettings = true
+            }
+
+            try? self.savePreferences($0)
+        }
+    }
+
+    /// Load and construct ``CEWorkspaceSettings`` model from `.codeedit/settings.json`
+    private func loadSettings() {
+        if let settingsURL = settingsURL {
+            if fileManager.fileExists(atPath: settingsURL.path) {
+                guard let json = try? Data(contentsOf: settingsURL),
+                      let prefs = try? JSONDecoder().decode(CEWorkspaceSettingsData.self, from: json)
+                else { return }
+
+                self.savedSettings = true
+                self.preferences = prefs
+            }
+        }
+    }
+
+    /// Save``CEWorkspaceSettings`` model to `.codeedit/settings.json`
+    private func savePreferences(_ data: CEWorkspaceSettingsData) throws {
+        guard let settingsURL = settingsURL else { return }
+
+        let data = try JSONEncoder().encode(data)
+        let json = try JSONSerialization.jsonObject(with: data)
+        let prettyJSON = try JSONSerialization.data(withJSONObject: json, options: [.prettyPrinted])
+        try prettyJSON.write(to: settingsURL, options: .atomic)
+    }
+}

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettings.swift

@@ -0,0 +1,44 @@
+//
+//  CEWorkspaceSettingsData.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 27/3/24.
+//
+
+import SwiftUI
+import Foundation
+
+/// # Workspace Settings
+///
+/// The model of the workspace settings for `CodeEdit` that control the behavior of some functionality at the workspace
+/// level like the workspace name or defining tasks.  A `JSON` representation is persisted in the workspace's
+/// `./codeedit/settings.json`. file
+struct CEWorkspaceSettingsData: Codable, Hashable {
+    /// The project global settings
+    var project: ProjectSettings = .init()
+
+    /// The tasks settings
+    var tasks: TasksSettings = .init()
+
+    init() {}
+
+    /// Explicit decoder init for setting default values when key is not present in `JSON`
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.project = try container.decodeIfPresent(ProjectSettings.self, forKey: .project) ?? .init()
+        self.tasks = try container.decodeIfPresent(TasksSettings.self, forKey: .tasks) ?? .init()
+    }
+
+    func propertiesOf(_ name: CEWorkspaceSettingsPage.Name) -> [CEWorkspaceSettingsPage] {
+        var settings: [CEWorkspaceSettingsPage] = []
+
+        switch name {
+        case .project:
+            project.searchKeys.forEach { settings.append(.init(name, isSetting: true, settingName: $0)) }
+        case .tasks:
+            tasks.searchKeys.forEach { settings.append(.init(name, isSetting: true, settingName: $0)) }
+        }
+
+        return settings
+    }
+}

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettingsData.swift

@@ -0,0 +1,50 @@
+//
+//  CEWorkspaceSettingsPage.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 27/3/24.
+//
+
+import Foundation
+import SwiftUI
+
+/// Represents a workspace settings tab.
+struct CEWorkspaceSettingsPage: Hashable, Equatable, Identifiable {
+    /// Sidebar icon, with a base color and SF Symbol
+    enum IconResource: Equatable, Hashable {
+        case system(_ name: String)
+        case symbol(_ name: String)
+        case asset(_ name: String)
+    }
+
+    /// All the workspace settings pages
+    enum Name: String {
+        case project = "Project"
+        case tasks = "Tasks"
+    }
+
+    let id: UUID = UUID()
+
+    let name: Name
+    let baseColor: Color?
+    let isSetting: Bool
+    let settingName: String
+    var nameString: LocalizedStringKey {
+        LocalizedStringKey(name.rawValue)
+    }
+    let icon: IconResource?
+
+    init(
+        _ name: Name,
+        baseColor: Color? = nil,
+        icon: IconResource? = nil,
+        isSetting: Bool = false,
+        settingName: String = ""
+    ) {
+        self.name = name
+        self.baseColor = baseColor
+        self.icon = icon
+        self.isSetting = isSetting
+        self.settingName = settingName
+    }
+}

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettingsPage.swift

@@ -0,0 +1,23 @@
+//
+//  CEWorkpaceSettingsSearchResult.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 27/3/24.
+//
+
+import SwiftUI
+
+// TODO: Extend this struct further to support setting "flashing"
+final class CEWorkspaceSettingsSearchResult: Identifiable {
+    let id: UUID = UUID()
+    let pageFound: Bool
+    let pages: [CEWorkspaceSettingsPage]
+
+    init(
+        pageFound: Bool,
+        pages: [CEWorkspaceSettingsPage]
+    ) {
+        self.pageFound = pageFound
+        self.pages = pages
+    }
+}

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettingsSearchResult.swift

@@ -0,0 +1,19 @@
+//
+//  PageAndCEWorkspaceSettings.swift
+//  CodeEdit
+//
+//  Created by Axel Martinez on 27/3/24.
+//
+
+import Foundation
+
+struct PageAndCEWorkspaceSettings: Identifiable, Equatable {
+    let id: UUID = UUID()
+    let page: CEWorkspaceSettingsPage
+    let settings: [CEWorkspaceSettingsPage]
+
+    init(_ page: CEWorkspaceSettingsPage) {
+        self.page = page
+        self.settings = CEWorkspaceSettingsData().propertiesOf(page.name)
+    }
+}