Reorganize ProductType declaration

Move ProductType Codable conformance closer to declaration

Author: mattt

Sources/PackageModel/PackageModel+Codable.swift

@@ -11,42 +11,6 @@
 import Foundation
 import TSCBasic
 
-extension ProductType: Codable {
-    private enum CodingKeys: String, CodingKey {
-        case library, executable, test
-    }
-
-    public func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: CodingKeys.self)
-        switch self {
-        case let .library(a1):
-            var unkeyedContainer = container.nestedUnkeyedContainer(forKey: .library)
-            try unkeyedContainer.encode(a1)
-        case .executable:
-            try container.encodeNil(forKey: .executable)
-        case .test:
-            try container.encodeNil(forKey: .test)
-        }
-    }
-
-    public init(from decoder: Decoder) throws {
-        let values = try decoder.container(keyedBy: CodingKeys.self)
-        guard let key = values.allKeys.first(where: values.contains) else {
-            throw DecodingError.dataCorrupted(.init(codingPath: decoder.codingPath, debugDescription: "Did not find a matching key"))
-        }
-        switch key {
-        case .library:
-            var unkeyedValues = try values.nestedUnkeyedContainer(forKey: key)
-            let a1 = try unkeyedValues.decode(ProductType.LibraryType.self)
-            self = .library(a1)
-        case .test:
-            self = .test
-        case .executable:
-            self = .executable
-        }
-    }
-}
-
 extension SystemPackageProviderDescription: Codable {
     private enum CodingKeys: String, CodingKey {
         case brew, apt, yum

Sources/PackageModel/Product.swift

@@ -11,8 +11,45 @@
 import TSCBasic
 import TSCUtility
 
+public class Product: Codable {
+
+    /// The name of the product.
+    public let name: String
+
+    /// The type of product to create.
+    public let type: ProductType
+
+    /// The list of targets to combine to form the product.
+    ///
+    /// This is never empty, and is only the targets which are required to be in
+    /// the product, but not necessarily their transitive dependencies.
+    @PolymorphicCodableArray
+    public var targets: [Target]
+
+    /// The path to linux main file.
+    public let linuxMain: AbsolutePath?
+
+    /// The suffix for REPL product name.
+    public static let replProductSuffix: String = "__REPL"
+
+    public init(name: String, type: ProductType, targets: [Target], linuxMain: AbsolutePath? = nil) {
+        precondition(!targets.isEmpty)
+        if type == .executable {
+            assert(targets.filter({ $0.type == .executable }).count == 1,
+                   "Executable products should have exactly one executable target.")
+        }
+        if linuxMain != nil {
+            assert(type == .test, "Linux main should only be set on test products")
+        }
+        self.name = name
+        self.type = type
+        self._targets = .init(wrappedValue: targets)
+        self.linuxMain = linuxMain 
+    }
+}
+
 /// The type of product.
-public enum ProductType: CustomStringConvertible, Equatable {
+public enum ProductType: Equatable {
 
     /// The type of library.
     public enum LibraryType: String, Codable {
@@ -35,7 +72,17 @@ public enum ProductType: CustomStringConvertible, Equatable {
 
     /// A test product.
     case test
-    
+}
+
+// MARK: - CustomStringConvertible
+
+extension Product: CustomStringConvertible {
+    public var description: String {
+        return "<Product: \(name)>"
+    }
+}
+
+extension ProductType: CustomStringConvertible {
     public var description: String {
         switch self {
         case .executable:
@@ -55,45 +102,40 @@ public enum ProductType: CustomStringConvertible, Equatable {
     }
 }
 
-public class Product: Codable {
-
-    /// The name of the product.
-    public let name: String
-
-    /// The type of product to create.
-    public let type: ProductType
-
-    /// The list of targets to combine to form the product.
-    ///
-    /// This is never empty, and is only the targets which are required to be in
-    /// the product, but not necessarily their transitive dependencies.
-    @PolymorphicCodableArray
-    public var targets: [Target]
-
-    /// The path to linux main file.
-    public let linuxMain: AbsolutePath?
+// MARK: - Codable
 
-    /// The suffix for REPL product name.
-    public static let replProductSuffix: String = "__REPL"
+extension ProductType: Codable {
+    private enum CodingKeys: String, CodingKey {
+        case library, executable, test
+    }
 
-    public init(name: String, type: ProductType, targets: [Target], linuxMain: AbsolutePath? = nil) {
-        precondition(!targets.isEmpty)
-        if type == .executable {
-            assert(targets.filter({ $0.type == .executable }).count == 1,
-                   "Executable products should have exactly one executable target.")
-        }
-        if linuxMain != nil {
-            assert(type == .test, "Linux main should only be set on test products")
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        switch self {
+        case let .library(a1):
+            var unkeyedContainer = container.nestedUnkeyedContainer(forKey: .library)
+            try unkeyedContainer.encode(a1)
+        case .executable:
+            try container.encodeNil(forKey: .executable)
+        case .test:
+            try container.encodeNil(forKey: .test)
         }
-        self.name = name
-        self.type = type
-        self._targets = .init(wrappedValue: targets)
-        self.linuxMain = linuxMain 
     }
-}
 
-extension Product: CustomStringConvertible {
-    public var description: String {
-        return "<Product: \(name)>"
+    public init(from decoder: Decoder) throws {
+        let values = try decoder.container(keyedBy: CodingKeys.self)
+        guard let key = values.allKeys.first(where: values.contains) else {
+            throw DecodingError.dataCorrupted(.init(codingPath: decoder.codingPath, debugDescription: "Did not find a matching key"))
+        }
+        switch key {
+        case .library:
+            var unkeyedValues = try values.nestedUnkeyedContainer(forKey: key)
+            let a1 = try unkeyedValues.decode(ProductType.LibraryType.self)
+            self = .library(a1)
+        case .test:
+            self = .test
+        case .executable:
+            self = .executable
+        }
     }
 }