Add better error handling messages

Author: Eric Miller

.gitignore

@@ -20,6 +20,7 @@ xcuserdata/
 iOS/
 Unity/
 ubconfig.json
+refreshprojects.swift
 
 ## Other
 *.moved-aside

Sources/UBKit/Models/UBKitError.swift

@@ -7,16 +7,43 @@
 
 import Foundation
 
-enum UBKitError: Error {
+enum UBKitError: Error, CustomStringConvertible {
     case error(Error)
     case unableToCreateFile(String)
-    case invalidFolder
+    case invalidFolder(String)
     case invalidXcodeProject
     case missingGroup(String)
     case invalidUnityProject
-    case unableToCreateXcodeProjectGroup
+    case unableToCreateXcodeProjectGroup(String)
     case unableToSaveXcodeProject
     case waitTimedOut
-    case shellCommand
+    case shellCommand(String)
     case invalidConfigFile
+
+    var description: String {
+        switch self {
+        case .error(let err):
+            return err.localizedDescription
+        case .unableToCreateFile(let str):
+            return "Unable to create \(str)"
+        case .invalidFolder(let str):
+            return "Invalid Folder: \(str)"
+        case .invalidXcodeProject:
+            return "Invalid Xcode Project"
+        case .missingGroup(let str):
+            return "Could not find \(str)"
+        case .invalidUnityProject:
+            return "Invalid Unity Project"
+        case .unableToCreateXcodeProjectGroup(let str):
+            return "Could not create Xcode Group: \(str)"
+        case .unableToSaveXcodeProject:
+            return "Unable To Save Xcode Project"
+        case .waitTimedOut:
+            return "Wait Timed Out"
+        case .shellCommand(let str):
+            return "Failed to execute shell command: \(str)"
+        case .invalidConfigFile:
+            return "Invalid config file"
+        }
+    }
 }

Sources/UBKit/UBKit.swift

@@ -25,7 +25,7 @@ public final class UBKit {
 
             }
         } catch {
-            completion(UBKitError.invalidFolder)
+            completion(UBKitError.invalidFolder(workingPath.appending("/ubconfig.json")))
         }
 
         let taskResult = kitManager.performTasks()

Sources/UBKit/Workers/FileCopier.swift

@@ -112,7 +112,8 @@ private extension FileCopier {
             let pathStrings = try fileManager.contentsOfDirectory(atPath: xcodeProjectPath)
             for pathString in pathStrings {
                 let path = Path("../".appending(pathString))
-                if (getBuildPhaseForPath(path) == .sources || getBuildPhaseForPath(path) == .headers) && pathString.hasPrefix("Unity") {
+                if (getBuildPhaseForPath(path) == .sources || getBuildPhaseForPath(path) == .headers) &&
+                    pathString.hasPrefix("Unity") {
                     guard let source = generateSourceFile(path: path, in: targetGroup, name: pathString) else {
                         return .failure(UBKitError.unableToCreateFile(path.string))
                     }
@@ -197,7 +198,7 @@ private extension FileCopier {
                     let path = Path(pathString)
                     if getBuildPhaseForPath(path) == nil {
                         guard let group = generateGroup(path.string) else {
-                            return .failure(UBKitError.unableToCreateXcodeProjectGroup)
+                            return .failure(UBKitError.unableToCreateXcodeProjectGroup(path.string))
                         }
                         group.path = path.string
                         parentGroup.children.append(group.reference)

Sources/UBKit/Workers/ProjectRefresher.swift

@@ -73,7 +73,7 @@ private extension ProjectRefresher {
             if statusCode == 0 {
                 return .success
             } else {
-                return .failure(UBKitError.shellCommand)
+                return .failure(UBKitError.shellCommand("Initialize Unity Project"))
             }
         case .timedOut:
             return .failure(UBKitError.waitTimedOut)

Sources/UBKit/Workers/UnityProject.swift

@@ -42,7 +42,7 @@ class UnityProject {
 
     func create() -> Result {
         guard UBKit.validatePath(unityAppPath, isDirectory: false) else {
-            return .failure(UBKitError.invalidFolder)
+            return .failure(UBKitError.invalidFolder(unityAppPath))
         }
 
         let unityFolderResult = createUnityFolder()
@@ -104,7 +104,7 @@ private extension UnityProject {
             if statusCode == 0 {
                 return .success
             } else {
-                return .failure(UBKitError.shellCommand)
+                return .failure(UBKitError.shellCommand("Generate Unity Project"))
             }
         case .timedOut:
             return .failure(UBKitError.waitTimedOut)
@@ -114,8 +114,7 @@ private extension UnityProject {
     func createUnityEditorScripts() -> Result {
         let assetsFilePath = workingPath.appending(projectName).appending("/Assets/")
         guard UBKit.validatePath(assetsFilePath, isDirectory: true) else {
-
-            return .failure(UBKitError.invalidFolder)
+            return .failure(UBKitError.invalidFolder(assetsFilePath))
         }
         let editorFilePath = assetsFilePath.appending("Editor/")
         let scenesFilePath = assetsFilePath.appending("Scenes/")

Sources/UBKit/Workers/XcodeProject.swift

@@ -97,7 +97,7 @@ private extension XcodeProject {
 
     func createSpecFile() -> Result {
         guard UBKit.validatePath(workingPath, isDirectory: true) else {
-            return .failure(UBKitError.invalidFolder)
+            return .failure(UBKitError.invalidFolder(workingPath))
         }
 
         let contents = File.specFile(
@@ -128,7 +128,7 @@ private extension XcodeProject {
 
     func createSourceFiles() -> Result {
         guard UBKit.validatePath(projectPath, isDirectory: true) else {
-            return .failure(UBKitError.invalidFolder)
+            return .failure(UBKitError.invalidFolder(projectPath))
         }
 
         guard fileManager.createFile(
@@ -171,7 +171,7 @@ private extension XcodeProject {
 
     func createAssetCatalog() -> Result {
         guard UBKit.validatePath(projectPath, isDirectory: true) else {
-            return .failure(UBKitError.invalidFolder)
+            return .failure(UBKitError.invalidFolder(projectPath))
         }
 
         let assetsFilePath = projectPath.appending("Assets.xcassets/")