Update config decoding

Author: Eric Miller

Sources/UBKit/Files/Config/config.swift

@@ -28,11 +28,18 @@ extension File {
     class func configFile() -> Data? {
         let file = """
         {
-            "project_name": "",
-            "bundle_id": "<com.example.project_name>",
-            "unity_path": "<path_to_Unity>",
-            "unity_version": "",
-            "unity_scene_name": ""
+            "ios": {
+                "projectName": "",
+                "bundleId": "<com.example.project_name>",
+                "projectPath": ""
+            },
+            "unity": {
+                "projectName": "",
+                "applicationPath": "<path_to_Unity>",
+                "version": "",
+                "projectPath": "",
+                "unity_scene_name": ""
+            }
         }
         """.data(using: .utf8)
         return file

Sources/UBKit/Models/Config.swift

@@ -23,64 +23,116 @@
 
 import Foundation
 
-struct Config {
-
-    struct Keys {
-        static let projectName = "project_name"
-        static let bundleID = "bundle_id"
-        static let unityPath = "unity_path"
-        static let unityVersion = "unity_version"
-        static let unitySceneName = "unity_scene_name"
+struct Config: Decodable {
+
+    enum ConfigKeys: String, CodingKey {
+        case ios
+        case unity
     }
 
+    let iOS: iOSConfig
+    let unity: UnityConfig
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: ConfigKeys.self)
+        self.iOS = try iOSConfig(from: container.superDecoder(forKey: .ios))
+        self.unity = try UnityConfig(from: container.superDecoder(forKey: .unity))
+    }
+}
+
+struct iOSConfig: Decodable {
     let projectName: String
-    let bundleID: String
-    let unityPath: String
-    let unityVersion: String
-    let unitySceneName: String
-    let unityProjectPath: String
-    let iOSProjectPath: String
+    let bundleId: String
+    let projectPath: String
 
-    let relativeIOSBuildPath: String
-    let relativeUnityClassesPath: String
-    let relativeUnityLibrariesPath: String
-    let relativeUnityDataPath: String
-
-
-    init?(json: [String : String], currentPath: String) {
-        guard let projectName = json[Keys.projectName],
-            let bundleID = json[Keys.bundleID], !bundleID.isEmpty,
-            let unityPath = json[Config.Keys.unityPath], !unityPath.isEmpty,
-            let unityVersion = json[Config.Keys.unityVersion], !unityVersion.isEmpty,
-            let sceneName = json[Config.Keys.unitySceneName] else {
-                return nil
+    private enum Keys: String, CodingKey {
+        case projectName
+        case bundleId
+        case projectPath
+    }
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: Keys.self)
+        let projectName = try container.decode(String.self, forKey: .projectName)
+        guard !projectName.isEmpty else {
+            throw UBKitError.invalidConfigArgument(Keys.projectName.rawValue)
+        }
+
+        let bundleId = try container.decode(String.self, forKey: .bundleId)
+        guard !bundleId.isEmpty else {
+            throw UBKitError.invalidConfigArgument(Keys.bundleId.rawValue)
         }
 
-        if projectName.isEmpty {
-            guard let folderName = currentPath.components(separatedBy: "/").last else {
-                return nil
-            }
-            self.projectName = folderName
+        let projectPath: String
+        if let path = try? container.decode(String.self, forKey: .projectPath), !path.isEmpty {
+            projectPath = path
         } else {
-            self.projectName = projectName
+            projectPath = FileManager.default.currentDirectoryPath.appending("/iOS/")
         }
 
-        if sceneName.isEmpty {
-            self.unitySceneName = self.projectName
+        self.projectName = projectName
+        self.bundleId = bundleId
+        self.projectPath = projectPath
+    }
+}
+
+struct UnityConfig {
+    let projectName: String
+    let applicationPath: String
+    let version: String
+    let projectPath: String
+    let sceneNames: [String]
+    let relativeIOSBuildPath: String
+    let relativeClassesPath: String
+    let relativeLibrariesPath: String
+    let relativeDataPath: String
+
+    private enum Keys: String, CodingKey {
+        case applicationPath
+        case version
+        case projectPath
+        case projectName
+        case sceneNames
+    }
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: Keys.self)
+        let projectName = try container.decode(String.self, forKey: .projectName)
+        guard !projectName.isEmpty else {
+            throw UBKitError.invalidConfigArgument(Keys.projectName.rawValue)
+        }
+
+        let appPath = try container.decode(String.self, forKey: .applicationPath)
+        guard !appPath.isEmpty else {
+            throw UBKitError.invalidConfigArgument(Keys.applicationPath.rawValue)
+        }
+
+        let version = try container.decode(String.self, forKey: .version)
+        guard !version.isEmpty else {
+            throw UBKitError.invalidConfigArgument(Keys.version.rawValue)
+        }
+
+        let projectPath: String
+        if let path = try? container.decode(String.self, forKey: .projectPath), !path.isEmpty {
+            projectPath = path
         } else {
-            self.unitySceneName = sceneName
+            projectPath = FileManager.default.currentDirectoryPath.appending("/Unity/")
         }
 
-        self.bundleID = bundleID
-        self.unityPath = unityPath
-        self.unityVersion = unityVersion
+        let sceneNames = try container.decode([String].self, forKey: .sceneNames)
+        guard sceneNames.count > 0 else {
+            throw UBKitError.invalidConfigArgument(Keys.sceneNames.rawValue)
+        }
 
-        self.unityProjectPath = currentPath.appending("/Unity/")
-        self.iOSProjectPath = currentPath.appending("/iOS/")
+        self.projectName = projectName
+        self.applicationPath = appPath
+        self.version = version
+        self.projectPath = projectPath
+        self.sceneNames = sceneNames
 
-        self.relativeIOSBuildPath = self.projectName.appending("/ios_build/")
-        self.relativeUnityClassesPath = self.projectName.appending("/ios_build/Classes/")
-        self.relativeUnityLibrariesPath = self.projectName.appending("/ios_build/Libraries/")
-        self.relativeUnityDataPath = self.projectName.appending("/ios_build/Data/")
+        self.relativeIOSBuildPath = projectName.appending("/ios_build/")
+        self.relativeClassesPath = self.relativeIOSBuildPath.appending("Classes/")
+        self.relativeLibrariesPath = self.relativeIOSBuildPath.appending("Libraries/")
+        self.relativeDataPath = self.relativeIOSBuildPath.appending("Data/")
     }
 }

Sources/UBKit/Models/UBKitError.swift

@@ -36,7 +36,8 @@ public enum UBKitError: Error, CustomStringConvertible {
     case unableToSaveXcodeProject
     case waitTimedOut
     case shellCommand(String)
-    case invalidConfigFile
+    case invalidConfigArgument(String)
+    case invalidConfigFile(Error)
 
     public var description: String {
         switch self {
@@ -64,8 +65,14 @@ public enum UBKitError: Error, CustomStringConvertible {
             return "Wait Timed Out"
         case .shellCommand(let str):
             return "Failed to execute shell command: \(str)"
-        case .invalidConfigFile:
-            return "Invalid config file"
+        case .invalidConfigArgument(let str):
+            return "Invalid config argument: \(str)"
+        case .invalidConfigFile(let err):
+            if let ubError = err as? UBKitError {
+                return ubError.description
+            } else {
+                return "Invalid config file: \(err.localizedDescription)"
+            }
         }
     }
 }

Sources/UBKit/Models/Unity.swift …rces/UBKit/Models/UnityCommandLine.swiftSources/UBKit/Models/Unity.swift renamed to Sources/UBKit/Models/UnityCommandLine.swift Sources/UBKit/Models/Unity.swift renamed to Sources/UBKit/Models/UnityCommandLine.swift

@@ -1,5 +1,5 @@
 //
-//  Unity.swift
+//  UnityCommandLine.swift
 //
 //  Copyright (c) 2017 Handsome
 //
@@ -26,7 +26,7 @@ import Foundation
 /**
  A helper class for interacting with the Unity command line.
  */
-struct Unity {
+struct UnityCommandLine {
     static let buildAction = "iOSBuilder.Perform"
     static let refreshAction = "iOSRefresher.Perform"
 

Sources/UBKit/UBKit.swift

@@ -43,24 +43,19 @@ public final class UBKit {
             completion(UBKitError.invalidArguments(arguments[1]))
             return
         }
-
+        
         let workingPath = fileManager.currentDirectoryPath.appending("/")
         if arg != .initialize {
-            do {
-                guard let fileData = fileManager.contents(atPath: workingPath.appending("ubconfig.json")) else {
-                    completion(UBKitError.invalidFolder(workingPath.appending("ubconfig.json")))
-                    return
-                }
-                if let configJSON = try JSONSerialization.jsonObject(with: fileData, options: .allowFragments) as? [String : String] {
-                    guard let config = Config(json: configJSON, currentPath: fileManager.currentDirectoryPath) else {
-                        completion(UBKitError.invalidConfigFile)
-                        return
-                    }
-                    kitManager = UBKitManager(config: config)
-                }
+            guard let fileData = fileManager.contents(atPath: workingPath.appending("ubconfig.json")) else {
+                completion(UBKitError.invalidFolder(workingPath.appending("ubconfig.json")))
+                return
+            }
 
+            do {
+                let config = try JSONDecoder().decode(Config.self, from: fileData)
+                kitManager = UBKitManager(config: config)
             } catch {
-                completion(error)
+                completion(UBKitError.invalidConfigFile(error))
                 return
             }
         }

Sources/UBKit/UBKitManager.swift

@@ -128,22 +128,13 @@ private extension UBKitManager {
         let fileCopier = FileCopier(config: config)
         return fileCopier.copyFiles(refresh: refresh)
     }
-
-    func refreshProjects() -> Result {
-        let refresher = ProjectRefresher(config: config)
-        return refresher.refresh()
-    }
 }
 
 // MARK: - Refresh
 private extension UBKitManager {
 
     func refreshXcodeProject() -> Result {
-        let refreshResult = refreshProjects()
-        guard refreshResult == .success else {
-            return refreshResult
-        }
-
-        return .success
+        let unityProject = UnityProject(config: config)
+        return unityProject.refresh()
     }
 }

Sources/UBKit/Workers/FileCopier.swift

@@ -48,9 +48,9 @@ class FileCopier {
 
     init(config: Config) {
         self.config = config
-        self.workingPath = config.unityProjectPath
-        self.xcodeProjectPath = config.iOSProjectPath
-        self.xcodeProjectFilePath = String(format: "%@%@%@", xcodeProjectPath, config.projectName, ".xcodeproj")
+        self.workingPath = config.unity.projectPath
+        self.xcodeProjectPath = config.iOS.projectPath
+        self.xcodeProjectFilePath = String(format: "%@%@%@", xcodeProjectPath, config.iOS.projectName, ".xcodeproj")
     }
 
     func copyFiles(refresh: Bool) -> Result {
@@ -77,7 +77,7 @@ class FileCopier {
         }
 
         print("Adding Unity files to Xcode project")
-        let classesPath = workingPath.appending(config.relativeUnityClassesPath)
+        let classesPath = workingPath.appending(config.unity.relativeClassesPath)
         guard let classesGroup = classesGroup else {
             return .failure(UBKitError.invalidUnityProject)
         }
@@ -86,7 +86,7 @@ class FileCopier {
             return addClassesFilesResult
         }
 
-        let librariesPath = workingPath.appending(config.relativeUnityLibrariesPath)
+        let librariesPath = workingPath.appending(config.unity.relativeLibrariesPath)
         guard let libsGroup = libsGroup else {
             return .failure(UBKitError.invalidUnityProject)
         }
@@ -132,8 +132,8 @@ private extension FileCopier {
             return .failure(UBKitError.invalidXcodeProject("Missing sources build phase"))
         }
 
-        guard let targetGroup = project.pbxproj.groups.filter({ $0.path == config.projectName }).first else {
-            return .failure(UBKitError.missingGroup(config.projectName))
+        guard let targetGroup = project.pbxproj.groups.filter({ $0.path == config.iOS.projectName }).first else {
+            return .failure(UBKitError.missingGroup(config.iOS.projectName))
         }
 
         do {
@@ -252,14 +252,14 @@ private extension FileCopier {
         }
 
         if let classesGroup = generateGroup("Classes", sourceTree: .absolute) {
-            classesGroup.path = workingPath.appending(config.relativeUnityClassesPath)
+            classesGroup.path = workingPath.appending(config.unity.relativeClassesPath)
             project.pbxproj.addObject(classesGroup)
             self.classesGroup = classesGroup
             unityGroup.children.append(classesGroup.reference)
         }
 
         if let librariesGroup = generateGroup("Libraries", sourceTree: .absolute) {
-            librariesGroup.path = workingPath.appending(config.relativeUnityLibrariesPath)
+            librariesGroup.path = workingPath.appending(config.unity.relativeLibrariesPath)
             project.pbxproj.addObject(librariesGroup)
             self.libsGroup = librariesGroup
             unityGroup.children.append(librariesGroup.reference)
@@ -308,7 +308,7 @@ private extension FileCopier {
             return .failure(UBKitError.invalidXcodeProject("Missing sources build phase"))
         }
 
-        guard let mainTarget = project.pbxproj.nativeTargets.filter({ $0.name == config.projectName }).first else {
+        guard let mainTarget = project.pbxproj.nativeTargets.filter({ $0.name == config.iOS.projectName }).first else {
             return .failure(UBKitError.invalidXcodeProject("Missing main target"))
         }
 
@@ -401,7 +401,7 @@ private extension FileCopier {
         let fileReference = PBXFileReference(reference: generateUUID(PBXFileReference.self, "data".appending(nameSalt)),
                                                                 sourceTree: .absolute)
         fileReference.name = "Data"
-        fileReference.path = workingPath.appending(config.relativeUnityDataPath)
+        fileReference.path = workingPath.appending(config.unity.relativeDataPath)
         fileReference.lastKnownFileType = "folder"
         unityGroup.children.append(fileReference.reference)
         project.pbxproj.addObject(fileReference)
@@ -538,7 +538,7 @@ private extension FileCopier {
     }
 
     func generateSourceFile(path: Path, in group: PBXGroup, name: String) -> SourceFile? {
-        let referencePath = Path(xcodeProjectPath.appending(config.projectName).appending("/").appending(config.projectName))
+        let referencePath = Path(xcodeProjectPath.appending(config.iOS.projectName).appending("/").appending(config.iOS.projectName))
         guard let fileReference = getFileReference(path: path, inPath: referencePath, name: name) else {
             return nil
         }