Create a document launch view model

The view model will handle most of the facilities the view themselves hosted.

Author: alicerunsonfedora

MCMaps/MCMapsApp.swift

@@ -114,7 +114,9 @@ struct MCMapsApp: App {
             }
         #endif
 
-        DocumentLaunchView(displayCreationWindow: $displayCreationWindow, proxyMap: $proxyMap)
+        DocumentLaunchView(
+            viewModel: DocumentLaunchViewModel(displayCreationWindow: $displayCreationWindow, proxyMap: $proxyMap)
+        )
 
         #if os(macOS)
             Window("About \(Self.appName)", id: "about") {

MCMaps/Resources/Alidade.docc/Alidade.md

@@ -83,6 +83,7 @@ contributors to read through.
 - ``CartographyRoute``
 - ``CartographyMapViewModel``
 - ``CartographyPinViewModel``
+- ``DocumentLaunchViewModel``
 
 ### Services
 
@@ -96,7 +97,6 @@ contributors to read through.
 ### Maps
 
 - ``CartographyOrnamentMap``
-- ``MapOrnament``
 - ``CartographyMapView``
 - ``CartographyMapViewState``
 

MCMaps/View Models/DocumentLaunchViewModel.swift

@@ -0,0 +1,71 @@
+//
+//  DocumentLaunchViewModel.swift
+//  MCMaps
+//
+//  Created by Marquis Kurt on 15-03-2025.
+//
+
+import SwiftUI
+
+/// A view model used to handle creating documents in a document launch view.
+///
+/// This is generally used by the document launch view to handle creating a new file, and displaying the form for
+/// setting the Minecraft version and seed.
+class DocumentLaunchViewModel {
+    /// The currently selected file.
+    var selectedFileURL: Binding<URL?>
+
+    /// Whether to display the creation window form.
+    var displayCreationWindow: Binding<Bool>
+
+    /// A proxy map used to create the file with a specified Minecraft version and seed.
+    var proxyMap: Binding<CartographyMap>
+
+    private var selectedFile: URL?
+
+    init(displayCreationWindow: Binding<Bool>, proxyMap: Binding<CartographyMap>) {
+        self.selectedFileURL = .constant(.documentsDirectory)
+        self.displayCreationWindow = displayCreationWindow
+        self.proxyMap = proxyMap
+        self.selectedFileURL = Binding { [self] in
+            return selectedFile
+        } set: { [self] newValue in
+            selectedFile = newValue
+        }
+    }
+
+    /// Sanitizes the specified URL, dropping the `mcmap` suffix.
+    func sanitize(url: URL) -> String {
+        return url.lastPathComponent.replacingOccurrences(of: ".mcmap", with: "")
+    }
+
+    /// Displays a human-friendly version of a file URL.
+    func friendlyUrl(_ url: URL, for currentUser: String = NSUserName()) -> String {
+        let originalDirectory = url.standardizedFileURL.deletingLastPathComponent()
+        if !url.contains(components: ["Users", currentUser]) {
+            return originalDirectory.standardizedFileURL.relativePath
+        }
+        var newPath = URL(filePath: "~/")
+        var newComponents = originalDirectory.pathComponents.dropFirst(3)
+        if newComponents.contains("com~apple~CloudDocs") {
+            newPath = URL(filePath: "iCloud Drive/")
+            newComponents = newComponents.dropFirst(3)
+        }
+        for component in newComponents {
+            newPath = newPath.appending(component: component)
+        }
+        return newPath.relativePath
+    }
+
+    /// Whether the specified file URL is in the Mobile Documents directory.
+    func isInMobileDocuments(_ url: URL, for currentUser: String = NSUserName()) -> Bool {
+        return url.standardizedFileURL.contains(components: ["Users", currentUser, "com~apple~CloudDocs"])
+    }
+
+    #if os(macOS)
+        @available(macOS 15.0, *)
+        func showInFinder(url: URL) async {
+            NSWorkspace.shared.activateFileViewerSelecting([url])
+        }
+    #endif
+}

MCMaps/Views/DocumentLaunchView/DocumentLaunchView+Desktop.swift

@@ -5,30 +5,20 @@
 //  Created by Marquis Kurt on 15-03-2025.
 //
 
+import Observation
 import SwiftUI
 
 #if os(macOS)
     /// A launch view that lets players create and open files easily.
     ///
     /// This will generally be displayed when the app is first loaded.
     struct DocumentLaunchView: Scene {
-        /// Whether the creation window should be visible.
-        ///
-        /// Applicable to iOS and iPadOS.
-        @Binding var displayCreationWindow: Bool
-
-        /// The proxy map used to create a file temporarily.
-        ///
-        /// Applicable to iOS and iPadOS.
-        @Binding var proxyMap: CartographyMap
+        var viewModel: DocumentLaunchViewModel
 
         @Environment(\.dismissWindow) private var dismissWindow
         @Environment(\.newDocument) private var newDocument
         @Environment(\.openDocument) private var openDocument
 
-        @State private var selectedFile: URL?
-        @State private var displayCreationSheet = false
-
         @ScaledMetric private var fileHeight = 36.0
         @ScaledMetric private var filePaddingH = 4.0
         @ScaledMetric private var filePaddingV = 2.0
@@ -69,23 +59,27 @@ import SwiftUI
                 .frame(width: 600, height: 400)
                 .toolbarVisibility(.hidden, for: .windowToolbar)
                 .containerBackground(.thinMaterial, for: .window)
-                .sheet(isPresented: $displayCreationSheet) {
+                .sheet(isPresented: viewModel.displayCreationWindow) {
                     NavigationStack {
-                        MapCreatorForm(worldName: $proxyMap.name, mcVersion: $proxyMap.mcVersion, seed: $proxyMap.seed)
-                            .navigationTitle("Create Map")
-                            .formStyle(.grouped)
-                            .toolbar {
-                                ToolbarItem(placement: .confirmationAction) {
-                                    Button("Create") {
-                                        createDocument()
-                                    }
+                        MapCreatorForm(
+                            worldName: viewModel.proxyMap.name,
+                            mcVersion: viewModel.proxyMap.mcVersion,
+                            seed: viewModel.proxyMap.seed
+                        )
+                        .navigationTitle("Create Map")
+                        .formStyle(.grouped)
+                        .toolbar {
+                            ToolbarItem(placement: .confirmationAction) {
+                                Button("Create") {
+                                    createDocument()
                                 }
-                                ToolbarItem(placement: .cancellationAction) {
-                                    Button("Cancel", role: .cancel) {
-                                        displayCreationSheet = false
-                                    }
+                            }
+                            ToolbarItem(placement: .cancellationAction) {
+                                Button("Cancel", role: .cancel) {
+                                    viewModel.displayCreationWindow.wrappedValue = false
                                 }
                             }
+                        }
                     }
                 }
             }
@@ -122,7 +116,7 @@ import SwiftUI
                 Spacer()
                 VStack(alignment: .leading) {
                     Button {
-                        displayCreationSheet.toggle()
+                        viewModel.displayCreationWindow.wrappedValue.toggle()
                     } label: {
                         HStack {
                             Label("Create a Map", systemImage: "document.badge.plus")
@@ -167,7 +161,7 @@ import SwiftUI
         }
 
         private var recentDocumentsList: some View {
-            List(selection: $selectedFile) {
+            List(selection: viewModel.selectedFileURL) {
                 ForEach(recentDocuments, id: \.self) { url in
                     HStack {
                         Image("File Preview")
@@ -178,14 +172,14 @@ import SwiftUI
                             .padding(.horizontal, filePaddingH)
                             .frame(height: fileHeight)
                         VStack(alignment: .leading) {
-                            Text(sanitize(url: url))
+                            Text(viewModel.sanitize(url: url))
                                 .font(.headline)
                             HStack {
-                                if isInMobileDocuments(url) {
+                                if viewModel.isInMobileDocuments(url) {
                                     Image(systemName: "icloud")
                                         .foregroundStyle(.blue)
                                 }
-                                Text(friendlyUrl(url))
+                                Text(viewModel.friendlyUrl(url))
                                     .foregroundStyle(.secondary)
                             }
                         }
@@ -202,7 +196,7 @@ import SwiftUI
                 if urls.count == 1, let url = urls.first {
                     Button {
                         Task {
-                            await showInFinder(url: url)
+                            await viewModel.showInFinder(url: url)
                         }
                     } label: {
                         Label("Show in Finder", systemImage: "folder")
@@ -216,11 +210,11 @@ import SwiftUI
         }
 
         private func createDocument() {
-            proxyMap.pins.append(CartographyMapPin(position: .zero, name: "Spawn Point"))
-            proxyMap.recentLocations?.append(.zero)
-            let newFile = CartographyMapFile(map: proxyMap)
+            viewModel.proxyMap.wrappedValue.pins.append(CartographyMapPin(position: .zero, name: "Spawn Point"))
+            viewModel.proxyMap.wrappedValue.recentLocations?.append(.zero)
+            let newFile = CartographyMapFile(map: viewModel.proxyMap.wrappedValue)
             newDocument(newFile)
-            displayCreationSheet = false
+            viewModel.displayCreationWindow.wrappedValue = false
             Task {
                 // NOTE(alicerunsonfedora): WTF is this bullshit? Can't you just dismiss normally you dirty fuck?
                 try await Task.sleep(nanoseconds: 1000)
@@ -236,35 +230,6 @@ import SwiftUI
                 } catch {}
             }
         }
-
-        private func sanitize(url: URL) -> String {
-            return url.lastPathComponent.replacingOccurrences(of: ".mcmap", with: "")
-        }
-
-        private func friendlyUrl(_ url: URL, for currentUser: String = NSUserName()) -> String {
-            let originalDirectory = url.standardizedFileURL.deletingLastPathComponent()
-            if !url.contains(components: ["Users", currentUser]) {
-                return originalDirectory.standardizedFileURL.relativePath
-            }
-            var newPath = URL(filePath: "~/")
-            var newComponents = originalDirectory.pathComponents.dropFirst(3)
-            if newComponents.contains("com~apple~CloudDocs") {
-                newPath = URL(filePath: "iCloud Drive/")
-                newComponents = newComponents.dropFirst(3)
-            }
-            for component in newComponents {
-                newPath = newPath.appending(component: component)
-            }
-            return newPath.relativePath
-        }
-
-        private func isInMobileDocuments(_ url: URL, for currentUser: String = NSUserName()) -> Bool {
-            return url.standardizedFileURL.contains(components: ["Users", currentUser, "com~apple~CloudDocs"])
-        }
-
-        private func showInFinder(url: URL) async {
-            NSWorkspace.shared.activateFileViewerSelecting([url])
-        }
     }
 
     #if DEBUG
@@ -280,17 +245,17 @@ import SwiftUI
 
                 @available(macOS 15.0, *)
                 func friendlyUrl(_ url: URL, for currentUser: String) -> String {
-                    target.friendlyUrl(url, for: currentUser)
+                    target.viewModel.friendlyUrl(url, for: currentUser)
                 }
 
                 @available(macOS 15.0, *)
                 func isInMobileDocuments(_ url: URL, for currentUser: String) -> Bool {
-                    target.isInMobileDocuments(url, for: currentUser)
+                    target.viewModel.isInMobileDocuments(url, for: currentUser)
                 }
 
                 @available(macOS 15.0, *)
                 func sanitize(url: URL) -> String {
-                    target.sanitize(url: url)
+                    target.viewModel.sanitize(url: url)
                 }
             }
         }

MCMaps/Views/DocumentLaunchView/DocumentLaunchView+Mobile.swift

@@ -13,43 +13,43 @@ import SwiftUI
     /// This will generally be displayed when the app is first loaded.
     @available(iOS 18.0, *)
     struct DocumentLaunchView: Scene {
-        @State private var creationContinuation: CheckedContinuation<CartographyMapFile?, any Error>?
-        /// Whether the creation window should be visible.
-        ///
-        /// Applicable to iOS and iPadOS.
-        @Binding var displayCreationWindow: Bool
+        typealias DocumentContinuation = CheckedContinuation<CartographyMapFile, any Error>
+        @State private var creationContinuation: DocumentContinuation?
 
-        /// The proxy map used to create a file temporarily.
-        ///
-        /// Applicable to iOS and iPadOS.
-        @Binding var proxyMap: CartographyMap
+        var viewModel: DocumentLaunchViewModel
 
         var body: some Scene {
             DocumentGroupLaunchScene {
                 NewDocumentButton("Create Map", for: CartographyMapFile.self) {
-                    try await withCheckedThrowingContinuation { continuation in
+                    try await withCheckedThrowingContinuation { (continuation: DocumentContinuation) in
                         self.creationContinuation = continuation
-                        self.displayCreationWindow = true
+                        self.viewModel.displayCreationWindow.wrappedValue = true
                     }
                 }
-                .sheet(isPresented: $displayCreationWindow) {
+                .sheet(isPresented: viewModel.displayCreationWindow) {
                     NavigationStack {
-                        MapCreatorForm(worldName: $proxyMap.name, mcVersion: $proxyMap.mcVersion, seed: $proxyMap.seed)
+                        MapCreatorForm(
+                            worldName: viewModel.proxyMap.name,
+                            mcVersion: viewModel.proxyMap.mcVersion,
+                            seed: viewModel.proxyMap.seed
+                        )
                             .navigationTitle("Create Map")
                             .toolbar {
                                 ToolbarItem(placement: .confirmationAction) {
                                     Button("Create") {
-                                        creationContinuation?.resume(returning: .init(map: proxyMap))
+                                        let file: CartographyMapFile = .init(map: viewModel.proxyMap.wrappedValue)
+                                        creationContinuation?
+                                            .resume(returning: file)
                                         creationContinuation = nil
-                                        displayCreationWindow = false
+                                        viewModel.displayCreationWindow.wrappedValue = false
                                     }
                                 }
 
                                 ToolbarItem(placement: .cancellationAction) {
                                     Button("Cancel") {
                                         creationContinuation?.resume(throwing: CocoaError(CocoaError.userCancelled))
                                         creationContinuation = nil
-                                        displayCreationWindow = false
+                                        viewModel.displayCreationWindow.wrappedValue = false
                                     }
                                 }
                             }
@@ -74,7 +74,7 @@ import SwiftUI
                     self.target = target
                 }
                 @available(iOS 18.0, *)
-                var creationContinuation: CheckedContinuation<CartographyMapFile?, any Error>? {
+                var creationContinuation: DocumentContinuation? {
                     target.creationContinuation
                 }
             }