Add ability to encode ProjectSpec to JSON

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Next Version
 
+#### Added
+
+- Added ability to encode ProjectSpec to JSON [#545](https://github.com/yonaskolb/XcodeGen/pull/545) @ryohey
+
 ## 2.5.0
 
 #### Added

Sources/ProjectSpec/AggregateTarget.swift

@@ -62,6 +62,19 @@ extension AggregateTarget: NamedJSONDictionaryConvertible {
     }
 }
 
+extension AggregateTarget: JSONEncodable {
+    public func toJSONValue() -> Any {
+        return [
+            "settings": settings.toJSONValue(),
+            "targets": targets,
+            "configFiles": configFiles,
+            "attributes": attributes,
+            "buildScripts": buildScripts.map { $0.toJSONValue() },
+            "scheme": scheme?.toJSONValue()
+        ] as [String: Any?]
+    }
+}
+
 extension AggregateTarget: PathContainer {
 
     static var pathProperties: [PathProperty] {

Sources/ProjectSpec/BuildRule.swift

@@ -80,3 +80,29 @@ extension BuildRule: JSONObjectConvertible {
         name = jsonDictionary.json(atKeyPath: "name")
     }
 }
+
+extension BuildRule: JSONEncodable {
+    public func toJSONValue() -> Any {
+        var dict: [String: Any?] = [
+            "outputFiles": outputFiles,
+            "outputFilesCompilerFlags": outputFilesCompilerFlags,
+            "name": name
+        ]
+
+        switch fileType {
+        case .pattern(let string):
+            dict["filePattern"] = string
+        case .type(let string):
+            dict["fileType"] = string
+        }
+
+        switch action {
+        case .compilerSpec(let string):
+            dict["compilerSpec"] = string
+        case .script(let string):
+            dict["script"] = string
+        }
+
+        return dict
+    }
+}

Sources/ProjectSpec/BuildScript.swift

@@ -2,6 +2,8 @@ import Foundation
 import JSONUtilities
 
 public struct BuildScript: Equatable {
+    public static let runOnlyWhenInstallingDefault = false
+    public static let showEnvVarsDefault = true
 
     public var script: ScriptType
     public var name: String?
@@ -26,8 +28,8 @@ public struct BuildScript: Equatable {
         inputFileLists: [String] = [],
         outputFileLists: [String] = [],
         shell: String? = nil,
-        runOnlyWhenInstalling: Bool = false,
-        showEnvVars: Bool = true
+        runOnlyWhenInstalling: Bool = runOnlyWhenInstallingDefault,
+        showEnvVars: Bool = showEnvVarsDefault
     ) {
         self.script = script
         self.name = name
@@ -57,8 +59,34 @@ extension BuildScript: JSONObjectConvertible {
             script = .path(path)
         }
         shell = jsonDictionary.json(atKeyPath: "shell")
-        runOnlyWhenInstalling = jsonDictionary.json(atKeyPath: "runOnlyWhenInstalling") ?? false
-        showEnvVars = jsonDictionary.json(atKeyPath: "showEnvVars") ?? true
+        runOnlyWhenInstalling = jsonDictionary.json(atKeyPath: "runOnlyWhenInstalling") ?? BuildScript.runOnlyWhenInstallingDefault
+        showEnvVars = jsonDictionary.json(atKeyPath: "showEnvVars") ?? BuildScript.showEnvVarsDefault
+    }
+}
+extension BuildScript: JSONEncodable {
+    public func toJSONValue() -> Any {
+        var dict: [String: Any?] = [
+            "inputFiles": inputFiles,
+            "inputFileLists": inputFileLists,
+            "outputFiles": outputFiles,
+            "outputFileLists": outputFileLists,
+            "runOnlyWhenInstalling": runOnlyWhenInstalling,
+            "name": name,
+            "shell": shell
+        ]
+
+        if showEnvVars != BuildScript.showEnvVarsDefault {
+            dict["showEnvVars"] = showEnvVars
+        }
+
+        switch script {
+        case .path(let string):
+            dict["path"] = string
+        case .script(let string):
+            dict["script"] = string
+        }
+
+        return dict
     }
 }
 

Sources/ProjectSpec/Dependency.swift

@@ -2,24 +2,27 @@ import Foundation
 import JSONUtilities
 
 public struct Dependency: Equatable {
+    public static let removeHeadersDefault = true
+    public static let implicitDefault = false
+    public static let weakLinkDefault = false
 
     public var type: DependencyType
     public var reference: String
     public var embed: Bool?
     public var codeSign: Bool?
-    public var removeHeaders: Bool = true
+    public var removeHeaders: Bool = removeHeadersDefault
     public var link: Bool?
-    public var implicit: Bool = false
-    public var weakLink: Bool = false
+    public var implicit: Bool = implicitDefault
+    public var weakLink: Bool = weakLinkDefault
 
     public init(
         type: DependencyType,
         reference: String,
         embed: Bool? = nil,
         codeSign: Bool? = nil,
         link: Bool? = nil,
-        implicit: Bool = false,
-        weakLink: Bool = false
+        implicit: Bool = implicitDefault,
+        weakLink: Bool = weakLinkDefault
     ) {
         self.type = type
         self.reference = reference
@@ -81,6 +84,42 @@ extension Dependency: JSONObjectConvertible {
     }
 }
 
+extension Dependency: JSONEncodable {
+    public func toJSONValue() -> Any {
+        var dict: [String: Any?] = [
+            "embed": embed,
+            "codeSign": codeSign,
+            "link": link
+        ]
+
+        if removeHeaders != Dependency.removeHeadersDefault {
+            dict["removeHeaders"] = removeHeaders
+        }
+        if implicit != Dependency.implicitDefault {
+            dict["implicit"] = implicit
+        }
+        if weakLink != Dependency.weakLinkDefault {
+            dict["weak"] = weakLink
+        }
+
+        switch type {
+        case .target:
+            dict["target"] = reference
+        case .framework:
+            dict["framework"] = reference
+        case .carthage(let findFrameworks):
+            dict["carthage"] = reference
+            if let findFrameworks = findFrameworks {
+                dict["findFrameworks"] = findFrameworks
+            }
+        case .sdk:
+            dict["sdk"] = reference
+        }
+
+        return dict
+    }
+}
+
 extension Dependency: PathContainer {
 
     static var pathProperties: [PathProperty] {

Sources/ProjectSpec/DeploymentTarget.swift

@@ -78,3 +78,14 @@ extension DeploymentTarget: JSONObjectConvertible {
         macOS = try parseVersion("macOS")
     }
 }
+
+extension DeploymentTarget: JSONEncodable {
+    public func toJSONValue() -> Any {
+        return [
+            "iOS": iOS?.string,
+            "tvOS": tvOS?.string,
+            "watchOS": watchOS?.string,
+            "macOS": macOS?.string,
+        ]
+    }
+}

Sources/ProjectSpec/Encoding.swift

@@ -0,0 +1,7 @@
+import Foundation
+import JSONUtilities
+
+public protocol JSONEncodable {
+    // returns JSONDictionary or JSONArray or JSONRawType or nil
+    func toJSONValue() -> Any
+}

Sources/ProjectSpec/Plist.swift

@@ -25,6 +25,15 @@ extension Plist: JSONObjectConvertible {
     }
 }
 
+extension Plist: JSONEncodable {
+    public func toJSONValue() -> Any {
+        return [
+            "path": path,
+            "properties": properties
+        ]
+    }
+}
+
 extension Plist: PathContainer {
 
     static var pathProperties: [PathProperty] {

Sources/ProjectSpec/Project.swift

@@ -230,3 +230,31 @@ extension BuildSettingsContainer {
         return configFiles.values.map { Path($0) }
     }
 }
+
+extension Project: JSONEncodable {
+    public func toJSONValue() -> Any {
+        return toJSONDictionary()
+    }
+
+    public func toJSONDictionary() -> JSONDictionary {
+        let targetPairs = targets.map { ($0.name, $0.toJSONValue()) }
+        let configsPairs = configs.map { ($0.name, $0.type?.rawValue) }
+        let aggregateTargetsPairs = aggregateTargets.map { ($0.name, $0.toJSONValue()) }
+        let schemesPairs = schemes.map { ($0.name, $0.toJSONValue()) }
+
+        return [
+            "name": name,
+            "options": options.toJSONValue(),
+            "settings": settings.toJSONValue(),
+            "fileGroups": fileGroups,
+            "configFiles": configFiles,
+            "include": include,
+            "attributes": attributes,
+            "targets": Dictionary(uniqueKeysWithValues: targetPairs),
+            "configs": Dictionary(uniqueKeysWithValues: configsPairs),
+            "aggregateTargets": Dictionary(uniqueKeysWithValues: aggregateTargetsPairs),
+            "schemes": Dictionary(uniqueKeysWithValues: schemesPairs),
+            "settingGroups": settingGroups.mapValues { $0.toJSONValue() }
+        ]
+    }
+}