Make InstalledSwiftPMConfiguration Codable conformance explicit

Make the conformance to Codable explicit so we can swap in the default swift-testing package version when it wasn't present in the config file.
swiftlang · May 8, 2024 · 165e3fc · 165e3fc
1 parent e4e428a
commit 165e3fc
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 9 deletions.
diff --git a/Sources/PackageModel/InstalledSwiftPMConfiguration.swift b/Sources/PackageModel/InstalledSwiftPMConfiguration.swift
@@ -10,7 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public struct InstalledSwiftPMConfiguration: Codable {
+public struct InstalledSwiftPMConfiguration {
     public struct Version: Codable, CustomStringConvertible {
         let major: Int
         let minor: Int
@@ -42,12 +42,55 @@ public struct InstalledSwiftPMConfiguration: Codable {
                 patch: 0,
                 prereleaseIdentifier: "latest"
             ),
-            swiftTestingVersionForTestTemplate: .init(
-                major: 0,
-                minor: 7,
-                patch: 0,
-                prereleaseIdentifier: nil
-            )
+            swiftTestingVersionForTestTemplate: defaultSwiftTestingVersionForTestTemplate
+        )
+    }
+
+    private static var defaultSwiftTestingVersionForTestTemplate: Version {
+        .init(
+            major: 0,
+            minor: 7,
+            patch: 0,
+            prereleaseIdentifier: nil
+        )
+    }
+}
+
+extension InstalledSwiftPMConfiguration: Codable {
+    enum CodingKeys: CodingKey {
+        case version
+        case swiftSyntaxVersionForMacroTemplate
+        case swiftTestingVersionForTestTemplate
+    }
+
+    public init(from decoder: any Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        self.version = try container.decode(
+            Int.self,
+            forKey: CodingKeys.version
+        )
+        self.swiftSyntaxVersionForMacroTemplate = try container.decode(
+            Version.self,
+            forKey: CodingKeys.swiftSyntaxVersionForMacroTemplate
         )
+        self.swiftTestingVersionForTestTemplate = try container.decodeIfPresent(
+            Version.self,
+            forKey: CodingKeys.swiftTestingVersionForTestTemplate
+        ) ?? InstalledSwiftPMConfiguration.defaultSwiftTestingVersionForTestTemplate
     }
+
+    public func encode(to encoder: any Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try container.encode(self.version, forKey: CodingKeys.version)
+        try container.encode(
+            self.swiftSyntaxVersionForMacroTemplate,
+            forKey: CodingKeys.swiftSyntaxVersionForMacroTemplate
+        )
+        try container.encode(
+            self.swiftTestingVersionForTestTemplate,
+            forKey: CodingKeys.swiftTestingVersionForTestTemplate
+        )
+  }
 }
diff --git a/Sources/PackageModelSyntax/AddTarget.swift b/Sources/PackageModelSyntax/AddTarget.swift
@@ -399,8 +399,8 @@ fileprivate extension PackageDependency {
     static func swiftTesting(
       configuration: InstalledSwiftPMConfiguration
     ) -> PackageDependency {
-        let swiftTestingVersionDefault = configuration
-            .swiftTestingVersionForTestTemplate
+        let swiftTestingVersionDefault =
+            configuration.swiftTestingVersionForTestTemplate
         let swiftTestingVersion = Version(swiftTestingVersionDefault.description)!
 
         return .sourceControl(