refactor!: strongly typed values in BuildSettings and BuildFileSettings

.github/workflows/xcodeproj.yml

@@ -31,6 +31,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: jdx/mise-action@v2
       - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: "6.0.2"
       - name: Build
         run: swift build --configuration release
   test:
@@ -49,6 +51,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: jdx/mise-action@v2
       - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: "6.0.2"
       - run: |
           git config --global user.email '[email protected]'
           git config --global user.name 'xcodeproj'

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.10.0
+// swift-tools-version:6.0.0
 
 import PackageDescription
 

Sources/XcodeProj/Extensions/Path+Extras.swift

@@ -43,7 +43,7 @@ extension Path {
                 let matchc = gt.gl_pathc
             #endif
             return (0 ..< Int(matchc)).compactMap { index in
-                if let path = String(validatingUTF8: gt.gl_pathv[index]!) {
+                if let path = String(validatingCString: gt.gl_pathv[index]!) {
                     return Path(path)
                 }
                 return nil

Sources/XcodeProj/Objects/BuildPhase/BuildFileSetting.swift

@@ -0,0 +1,55 @@
+public enum BuildFileSetting: Sendable, Equatable, Hashable {
+    case string(String)
+    case array([String])
+
+    public var stringValue: String? {
+        if case let .string(value) = self {
+            value
+        } else {
+            nil
+        }
+    }
+
+    public var arrayValue: [String]? {
+        if case let .array(value) = self {
+            value
+        } else {
+            nil
+        }
+    }
+}
+
+extension BuildFileSetting: Codable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        do {
+            let string = try container.decode(String.self)
+            self = .string(string)
+        } catch {
+            let array = try container.decode([String].self)
+            self = .array(array)
+        }
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.singleValueContainer()
+        switch self {
+        case let .string(string):
+            try container.encode(string)
+        case let .array(array):
+            try container.encode(array)
+        }
+    }
+}
+
+extension BuildFileSetting: ExpressibleByArrayLiteral {
+    public init(arrayLiteral elements: String...) {
+        self = .array(elements)
+    }
+}
+
+extension BuildFileSetting: ExpressibleByStringInterpolation {
+    public init(stringLiteral value: StringLiteralType) {
+        self = .string(value)
+    }
+}

Sources/XcodeProj/Objects/BuildPhase/PBXBuildFile.swift

@@ -31,7 +31,25 @@ public final class PBXBuildFile: PBXObject {
     }
 
     /// Element settings
-    public var settings: [String: Any]?
+    public var settings: [String: BuildFileSetting]?
+
+    /// Potentially present for `PBXHeadersBuildPhase` : https://buck.build/javadoc/com/facebook/buck/apple/xcode/xcodeproj/PBXBuildFile.html
+    public var attributes: [String]? {
+        if case let .array(attributes) = settings?["ATTRIBUTES"] {
+            attributes
+        } else {
+            nil
+        }
+    }
+
+    /// Potentially present for `PBXSourcesBuildPhase` : https://buck.build/javadoc/com/facebook/buck/apple/xcode/xcodeproj/PBXBuildFile.html
+    public var compilerFlags: String? {
+        if case let .string(compilerFlags) = settings?["COMPILER_FLAGS"] {
+            compilerFlags
+        } else {
+            nil
+        }
+    }
 
     /// Platform filter attribute.
     /// Introduced in: Xcode 11
@@ -53,7 +71,7 @@ public final class PBXBuildFile: PBXObject {
     ///   - settings: build file settings.
     public init(file: PBXFileElement? = nil,
                 product: XCSwiftPackageProductDependency? = nil,
-                settings: [String: Any]? = nil,
+                settings: [String: BuildFileSetting]? = nil,
                 platformFilter: String? = nil,
                 platformFilters: [String]? = nil) {
         fileReference = file?.reference
@@ -84,7 +102,7 @@ public final class PBXBuildFile: PBXObject {
         if let productRefString: String = try container.decodeIfPresent(.productRef) {
             productReference = objectReferenceRepository.getOrCreate(reference: productRefString, objects: objects)
         }
-        settings = try container.decodeIfPresent([String: Any].self, forKey: .settings)
+        settings = try container.decodeIfPresent([String: BuildFileSetting].self, forKey: .settings)
         platformFilter = try container.decodeIfPresent(.platformFilter)
         platformFilters = try container.decodeIfPresent([String].self, forKey: .platformFilters)
         try super.init(from: decoder)

Sources/XcodeProj/Objects/Configuration/BuildSettings.swift

@@ -1,4 +1,82 @@
 import Foundation
 
 /// Build settings.
-public typealias BuildSettings = [String: Any]
+public typealias BuildSettings = [String: BuildSetting]
+
+private let yes = "YES"
+private let no = "NO"
+
+public enum BuildSetting: Sendable, Equatable {
+    case string(String)
+    case array([String])
+
+    public var stringValue: String? {
+        if case let .string(value) = self {
+            value
+        } else {
+            nil
+        }
+    }
+
+    public var boolValue: Bool? {
+        if case let .string(value) = self {
+            switch value {
+            case yes: true
+            case no: false
+            default: nil
+            }
+        } else {
+            nil
+        }
+    }
+
+    public var arrayValue: [String]? {
+        if case let .array(value) = self {
+            value
+        } else {
+            nil
+        }
+    }
+}
+
+extension BuildSetting: CustomStringConvertible {
+    public var description: String {
+        switch self {
+        case let .string(string):
+            string
+        case let .array(array):
+            array.joined(separator: " ")
+        }
+    }
+}
+
+extension BuildSetting: Decodable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        do {
+            let string = try container.decode(String.self)
+            self = .string(string)
+        } catch {
+            let array = try container.decode([String].self)
+            self = .array(array)
+        }
+    }
+}
+
+extension BuildSetting: ExpressibleByArrayLiteral {
+    public init(arrayLiteral elements: String...) {
+        self = .array(elements)
+    }
+}
+
+extension BuildSetting: ExpressibleByStringInterpolation {
+    public init(stringLiteral value: StringLiteralType) {
+        self = .string(value)
+    }
+}
+
+extension BuildSetting: ExpressibleByBooleanLiteral {
+    public init(booleanLiteral value: Bool) {
+        self = .string(value ? yes : no)
+    }
+}

Sources/XcodeProj/Objects/Configuration/XCBuildConfiguration.swift

@@ -59,7 +59,7 @@ public final class XCBuildConfiguration: PBXObject {
         } else {
             baseConfigurationReference = nil
         }
-        buildSettings = try container.decode([String: Any].self, forKey: .buildSettings)
+        buildSettings = try container.decode(BuildSettings.self, forKey: .buildSettings)
         name = try container.decode(.name)
         try super.init(from: decoder)
     }
@@ -75,16 +75,16 @@ public final class XCBuildConfiguration: PBXObject {
     public func append(setting name: String, value: String) {
         guard !value.isEmpty else { return }
 
-        let existing: Any = buildSettings[name] ?? "$(inherited)"
+        let existing: BuildSetting = buildSettings[name] ?? "$(inherited)"
 
         switch existing {
-        case let string as String where string != value:
+        case let .string(string) where string != value:
             let newValue = [string, value].joined(separator: " ")
-            buildSettings[name] = newValue
-        case let array as [String]:
+            buildSettings[name] = .string(newValue)
+        case let .array(array):
             var newValue = array
             newValue.append(value)
-            buildSettings[name] = newValue.uniqued()
+            buildSettings[name] = .array(newValue.uniqued())
         default:
             break
         }

Sources/XcodeProj/Objects/Project/PBXProj.swift

@@ -14,7 +14,8 @@ public final class PBXProj: Decodable {
     public var objectVersion: UInt
 
     /// Project classes.
-    public var classes: [String: Any]
+    /// This appears to always be empty as defined here: http://www.monobjc.net/xcode-project-file-format.html
+    public var classes: [String: [String]]
 
     /// Project root object.
     var rootObjectReference: PBXObjectReference?
@@ -40,7 +41,7 @@ public final class PBXProj: Decodable {
     public init(rootObject: PBXProject? = nil,
                 objectVersion: UInt = Xcode.LastKnown.objectVersion,
                 archiveVersion: UInt = Xcode.LastKnown.archiveVersion,
-                classes: [String: Any] = [:],
+                classes: [String: [String]] = [:],
                 objects: [PBXObject] = []) {
         self.archiveVersion = archiveVersion
         self.objectVersion = objectVersion
@@ -88,7 +89,7 @@ public final class PBXProj: Decodable {
         rootObject: PBXProject? = nil,
         objectVersion: UInt = Xcode.LastKnown.objectVersion,
         archiveVersion: UInt = Xcode.LastKnown.archiveVersion,
-        classes: [String: Any] = [:],
+        classes: [String: [String]] = [:],
         objects: PBXObjects
     ) {
         self.archiveVersion = archiveVersion
@@ -116,7 +117,7 @@ public final class PBXProj: Decodable {
         self.rootObjectReference = objectReferenceRepository.getOrCreate(reference: rootObjectReference, objects: objects)
         objectVersion = try container.decodeIntIfPresent(.objectVersion) ?? 0
         archiveVersion = try container.decodeIntIfPresent(.archiveVersion) ?? 1
-        classes = try container.decodeIfPresent([String: Any].self, forKey: .classes) ?? [:]
+        classes = try container.decodeIfPresent([String: [String]].self, forKey: .classes) ?? [:]
         let objectsDictionary: [String: PBXObjectDictionaryEntry] = try container.decodeIfPresent([String: PBXObjectDictionaryEntry].self, forKey: .objects) ?? [:]
 
         for entry in objectsDictionary {
@@ -261,10 +262,9 @@ extension PBXProj {
 
 extension PBXProj: Equatable {
     public static func == (lhs: PBXProj, rhs: PBXProj) -> Bool {
-        let equalClasses = NSDictionary(dictionary: lhs.classes).isEqual(to: rhs.classes)
-        return lhs.archiveVersion == rhs.archiveVersion &&
+        lhs.archiveVersion == rhs.archiveVersion &&
             lhs.objectVersion == rhs.objectVersion &&
-            equalClasses &&
+            lhs.classes == rhs.classes &&
             lhs.objects == rhs.objects
     }
 }

Sources/XcodeProj/Objects/Project/PBXProject.swift

@@ -108,20 +108,20 @@ public final class PBXProject: PBXObject {
 
     /// Project attributes.
     /// Target attributes will be merged into this
-    public var attributes: [String: Any]
+    public var attributes: [String: ProjectAttribute]
 
     /// Target attribute references.
-    var targetAttributeReferences: [PBXObjectReference: [String: Any]]
+    var targetAttributeReferences: [PBXObjectReference: [String: ProjectAttribute]]
 
     /// Target attributes.
-    public var targetAttributes: [PBXTarget: [String: Any]] {
+    public var targetAttributes: [PBXTarget: [String: ProjectAttribute]] {
         set {
             targetAttributeReferences = [:]
             for item in newValue {
                 targetAttributeReferences[item.key.reference] = item.value
             }
         } get {
-            var attributes: [PBXTarget: [String: Any]] = [:]
+            var attributes: [PBXTarget: [String: ProjectAttribute]] = [:]
             for targetAttributeReference in targetAttributeReferences {
                 if let object: PBXTarget = targetAttributeReference.key.getObject() {
                     attributes[object] = targetAttributeReference.value
@@ -176,7 +176,7 @@ public final class PBXProject: PBXObject {
     /// - Parameters:
     ///   - attributes: attributes that will be set.
     ///   - target: target.
-    public func setTargetAttributes(_ attributes: [String: Any], target: PBXTarget) {
+    public func setTargetAttributes(_ attributes: [String: ProjectAttribute], target: PBXTarget) {
         targetAttributeReferences[target.reference] = attributes
     }
 
@@ -321,8 +321,8 @@ public final class PBXProject: PBXObject {
                 projectRoots: [String] = [],
                 targets: [PBXTarget] = [],
                 packages: [XCRemoteSwiftPackageReference] = [],
-                attributes: [String: Any] = [:],
-                targetAttributes: [PBXTarget: [String: Any]] = [:]) {
+                attributes: [String: ProjectAttribute] = [:],
+                targetAttributes: [PBXTarget: [String: ProjectAttribute]] = [:]) {
         self.name = name
         buildConfigurationListReference = buildConfigurationList.reference
         self.compatibilityVersion = compatibilityVersion
@@ -417,10 +417,12 @@ public final class PBXProject: PBXObject {
         let packageRefeferenceStrings: [String] = try container.decodeIfPresent(.packageReferences) ?? []
         packageReferences = packageRefeferenceStrings.map { referenceRepository.getOrCreate(reference: $0, objects: objects) }
 
-        var attributes = try (container.decodeIfPresent([String: Any].self, forKey: .attributes) ?? [:])
-        var targetAttributeReferences: [PBXObjectReference: [String: Any]] = [:]
-        if let targetAttributes = attributes[PBXProject.targetAttributesKey] as? [String: [String: Any]] {
-            targetAttributes.forEach { targetAttributeReferences[referenceRepository.getOrCreate(reference: $0.key, objects: objects)] = $0.value }
+        var attributes = try (container.decodeIfPresent([String: ProjectAttribute].self, forKey: .attributes) ?? [:])
+        var targetAttributeReferences: [PBXObjectReference: [String: ProjectAttribute]] = [:]
+        if case let .attributeDictionary(targetAttributes) = attributes[PBXProject.targetAttributesKey] {
+            for targetAttribute in targetAttributes {
+                targetAttributeReferences[referenceRepository.getOrCreate(reference: targetAttribute.key, objects: objects)] = targetAttribute.value
+            }
             attributes[PBXProject.targetAttributesKey] = nil
         }
         self.attributes = attributes
@@ -562,16 +564,17 @@ extension PBXProject: PlistSerializable {
             dictionary["packageReferences"] = PlistValue.array(finalPackageReferences)
         }
 
-        var plistAttributes: [String: Any] = attributes
+        var plistAttributes: [String: ProjectAttribute] = attributes
 
         // merge target attributes
-        var plistTargetAttributes: [String: Any] = [:]
+        var plistTargetAttributes: [String: [String: ProjectAttribute]] = [:]
         for (reference, value) in targetAttributeReferences {
-            plistTargetAttributes[reference.value] = value.mapValues { value in
-                (value as? PBXObject)?.reference.value ?? value
-            }
+            plistTargetAttributes[reference.value] = value
+        }
+
+        if !plistTargetAttributes.isEmpty {
+            plistAttributes[PBXProject.targetAttributesKey] = .attributeDictionary(plistTargetAttributes)
         }
-        plistAttributes[PBXProject.targetAttributesKey] = plistTargetAttributes.isEmpty ? nil : plistTargetAttributes
 
         dictionary["attributes"] = plistAttributes.plist()