[xcodegen] NFC: Factor out xcodeClassName in serialization logic

Author: hamishknight

utils/swift-xcodegen/Sources/SwiftXcodeGen/Xcodeproj/XcodeProjectModelSerialization.swift

@@ -43,6 +43,7 @@ extension Xcode.Project {
 }
 
 extension Xcode.Project: PropertyListSerializable {
+  fileprivate var xcodeClassName: String { "PBXProject" }
 
   /// Generates and returns the contents of a `project.pbxproj` plist.  Does
   /// not generate any ancillary files, such as a set of schemes.
@@ -77,7 +78,7 @@ extension Xcode.Project: PropertyListSerializable {
     // by Xcode when it opens the project and notices that they are missing.
     // Note: we also skip schemes, since they are not in the project plist.
     var dict = [String: PropertyList]()
-    dict["isa"] = .string("PBXProject")
+    dict["isa"] = .string(xcodeClassName)
     // Since the project file is generated, we opt out of upgrade-checking.
     // FIXME: Should we really?  Why would we not want to get upgraded?
     dict["attributes"] = .dictionary(["LastUpgradeCheck": .string("9999"),
@@ -108,26 +109,35 @@ extension Xcode.Project: PropertyListSerializable {
 }
 
 extension Xcode.Reference: PropertyListSerializable {
-  fileprivate dynamic func serialize(
+  fileprivate var xcodeClassName: String {
+    switch self {
+    case is Xcode.Group:
+      "PBXGroup"
+    case let fileRef as Xcode.FileReference:
+      fileRef.isBuildableFolder ? "PBXFileSystemSynchronizedRootGroup"
+                                : "PBXFileReference"
+    default:
+      fatalError("Unhandled subclass")
+    }
+  }
+
+  fileprivate func serialize(
     to serializer: PropertyListSerializer
   ) throws -> [String : PropertyList] {
     var dict = [String: PropertyList]()
+    dict["isa"] = .string(xcodeClassName)
     dict["path"] = .string(path)
     if let name = name {
       dict["name"] = .string(name)
     }
     dict["sourceTree"] = .string(pathBase.rawValue)
 
-    let xcodeClassName: String
     switch self {
     case let group as Xcode.Group:
-      xcodeClassName = "PBXGroup"
       dict["children"] = try .array(group.subitems.map({ reference in
         try .identifier(serializer.serialize(object: reference))
       }))
     case let fileRef as Xcode.FileReference:
-      xcodeClassName = fileRef.isBuildableFolder 
-        ? "PBXFileSystemSynchronizedRootGroup" : "PBXFileReference"
       if let fileType = fileRef.fileType {
         dict["explicitFileType"] = .string(fileType)
       }
@@ -138,19 +148,21 @@ extension Xcode.Reference: PropertyListSerializable {
     default:
       fatalError("Unhandled subclass")
     }
-    dict["isa"] = .string(xcodeClassName)
     return dict
   }
 }
 
 extension Xcode.Target: PropertyListSerializable {
+  fileprivate var xcodeClassName: String {
+    productType == nil ? "PBXAggregateTarget" : "PBXNativeTarget"
+  }
 
   /// Called by the Serializer to serialize the Target.
   fileprivate func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
     // Create either a `PBXNativeTarget` or an `PBXAggregateTarget` plist
     // dictionary (depending on whether or not we have a product type).
     var dict = [String: PropertyList]()
-    dict["isa"] = .string(productType == nil ? "PBXAggregateTarget" : "PBXNativeTarget")
+    dict["isa"] = .string(xcodeClassName)
     dict["name"] = .string(name)
     // Build settings are a bit tricky; in Xcode, each is stored in a named
     // XCBuildConfiguration object, and the list of build configurations is
@@ -169,14 +181,16 @@ extension Xcode.Target: PropertyListSerializable {
     /// glue between our value-based settings structures and the Xcode
     /// project model's identity-based TargetDependency objects.
     class TargetDependency: PropertyListSerializable {
+      var xcodeClassName: String { "PBXTargetDependency" }
+
       var target: Xcode.Target
       init(target: Xcode.Target) {
         self.target = target
       }
       func serialize(to serializer: PropertyListSerializer) -> [String: PropertyList] {
         // Create a `PBXTargetDependency` plist dictionary.
         var dict = [String: PropertyList]()
-        dict["isa"] = .string("PBXTargetDependency")
+        dict["isa"] = .string(xcodeClassName)
         dict["target"] = .identifier(serializer.id(of: target))
         return dict
       }
@@ -202,91 +216,60 @@ extension Xcode.Target: PropertyListSerializable {
   }
 }
 
-/// Private helper function that constructs and returns a partial property list
-/// dictionary for build phases.  The caller can add to the returned dictionary.
-/// FIXME:  It would be nicer to be able to use inheritance to serialize the
-/// attributes inherited from BuildPhase, but but in Swift 3.0 we get an error
-/// that "declarations in extensions cannot override yet".
-fileprivate func makeBuildPhaseDict(
-  buildPhase: Xcode.BuildPhase,
-  serializer: PropertyListSerializer,
-  xcodeClassName: String
-) throws -> [String: PropertyList] {
-  var dict = [String: PropertyList]()
-  dict["isa"] = .string(xcodeClassName)
-  dict["files"] = try .array(buildPhase.files.map({ file in
-    try .identifier(serializer.serialize(object: file))
-  }))
-  return dict
+extension PropertyListSerializable where Self: Xcode.BuildPhase {
+  /// Helper function that constructs and returns the base property list
+  /// dictionary for build phases.
+  fileprivate func makeBuildPhaseDict(
+    serializer: PropertyListSerializer
+  ) throws -> [String: PropertyList] {
+    var dict = [String: PropertyList]()
+    dict["isa"] = .string(xcodeClassName)
+    dict["files"] = try .array(files.map({ file in
+      try .identifier(serializer.serialize(object: file))
+    }))
+    return dict
+  }
+
+  /// Default serialization implementation.
+  fileprivate func serialize(
+    to serializer: PropertyListSerializer
+  ) throws -> [String: PropertyList] {
+    try makeBuildPhaseDict(serializer: serializer)
+  }
 }
 
 extension Xcode.HeadersBuildPhase: PropertyListSerializable {
-
-  /// Called by the Serializer to serialize the HeadersBuildPhase.
-  fileprivate func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
-    // Create a `PBXHeadersBuildPhase` plist dictionary.
-    // FIXME:  It would be nicer to be able to use inheritance for the code
-    // inherited from BuildPhase, but but in Swift 3.0 we get an error that
-    // "declarations in extensions cannot override yet".
-    return try makeBuildPhaseDict(buildPhase: self, serializer: serializer, xcodeClassName: "PBXHeadersBuildPhase")
-  }
+  fileprivate var xcodeClassName: String { "PBXHeadersBuildPhase" }
 }
 
 extension Xcode.SourcesBuildPhase: PropertyListSerializable {
-
-  /// Called by the Serializer to serialize the SourcesBuildPhase.
-  fileprivate func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
-    // Create a `PBXSourcesBuildPhase` plist dictionary.
-    // FIXME:  It would be nicer to be able to use inheritance for the code
-    // inherited from BuildPhase, but but in Swift 3.0 we get an error that
-    // "declarations in extensions cannot override yet".
-    return try makeBuildPhaseDict(buildPhase: self, serializer: serializer, xcodeClassName: "PBXSourcesBuildPhase")
-  }
+  fileprivate var xcodeClassName: String { "PBXSourcesBuildPhase" }
 }
 
 extension Xcode.FrameworksBuildPhase: PropertyListSerializable {
-
-  /// Called by the Serializer to serialize the FrameworksBuildPhase.
-  fileprivate func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
-    // Create a `PBXFrameworksBuildPhase` plist dictionary.
-    // FIXME:  It would be nicer to be able to use inheritance for the code
-    // inherited from BuildPhase, but but in Swift 3.0 we get an error that
-    // "declarations in extensions cannot override yet".
-    return try makeBuildPhaseDict(buildPhase: self, serializer: serializer, xcodeClassName: "PBXFrameworksBuildPhase")
-  }
+  fileprivate var xcodeClassName: String { "PBXFrameworksBuildPhase" }
 }
 
 extension Xcode.CopyFilesBuildPhase: PropertyListSerializable {
+  fileprivate var xcodeClassName: String { "PBXCopyFilesBuildPhase" }
 
-  /// Called by the Serializer to serialize the FrameworksBuildPhase.
-  fileprivate func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
-    // Create a `PBXCopyFilesBuildPhase` plist dictionary.
-    // FIXME:  It would be nicer to be able to use inheritance for the code
-    // inherited from BuildPhase, but but in Swift 3.0 we get an error that
-    // "declarations in extensions cannot override yet".
-    var dict = try makeBuildPhaseDict(
-      buildPhase: self,
-      serializer: serializer,
-      xcodeClassName: "PBXCopyFilesBuildPhase"
-    )
+  fileprivate func serialize(
+    to serializer: PropertyListSerializer
+  ) throws -> [String: PropertyList] {
+    var dict = try makeBuildPhaseDict(serializer: serializer)
     dict["dstPath"] = .string("")   // FIXME: needs to be real
     dict["dstSubfolderSpec"] = .string("")   // FIXME: needs to be real
     return dict
   }
 }
 
 extension Xcode.ShellScriptBuildPhase: PropertyListSerializable {
+  fileprivate var xcodeClassName: String { "PBXShellScriptBuildPhase" }
 
-  /// Called by the Serializer to serialize the ShellScriptBuildPhase.
-  fileprivate func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
-    // Create a `PBXShellScriptBuildPhase` plist dictionary.
-    // FIXME:  It would be nicer to be able to use inheritance for the code
-    // inherited from BuildPhase, but but in Swift 3.0 we get an error that
-    // "declarations in extensions cannot override yet".
-    var dict = try makeBuildPhaseDict(
-      buildPhase: self,
-      serializer: serializer,
-      xcodeClassName: "PBXShellScriptBuildPhase")
+  fileprivate func serialize(
+    to serializer: PropertyListSerializer
+  ) throws -> [String: PropertyList] {
+    var dict = try makeBuildPhaseDict(serializer: serializer)
     dict["shellPath"] = .string("/bin/sh")   // FIXME: should be settable
     dict["shellScript"] = .string(script)
     dict["inputPaths"] = .array(inputs.map { .string($0) })
@@ -297,12 +280,13 @@ extension Xcode.ShellScriptBuildPhase: PropertyListSerializable {
 }
 
 extension Xcode.BuildFile: PropertyListSerializable {
+  fileprivate var xcodeClassName: String { "PBXBuildFile" }
 
   /// Called by the Serializer to serialize the BuildFile.
   fileprivate func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
     // Create a `PBXBuildFile` plist dictionary.
     var dict = [String: PropertyList]()
-    dict["isa"] = .string("PBXBuildFile")
+    dict["isa"] = .string(xcodeClassName)
     if let fileRef = fileRef {
       dict["fileRef"] = .identifier(serializer.id(of: fileRef))
     }
@@ -317,6 +301,7 @@ extension Xcode.BuildFile: PropertyListSerializable {
 }
 
 extension Xcode.BuildSettingsTable: PropertyListSerializable {
+  fileprivate var xcodeClassName: String { "XCConfigurationList" }
 
   /// Called by the Serializer to serialize the BuildFile.  It is serialized
   /// as an XCBuildConfigurationList and two additional XCBuildConfiguration
@@ -331,6 +316,8 @@ extension Xcode.BuildSettingsTable: PropertyListSerializable {
       var overlaySettings: BuildSettings
       let xcconfigFileRef: Xcode.FileReference?
 
+      var xcodeClassName: String { "XCBuildConfiguration" }
+
       init(
         name: String,
         baseSettings: BuildSettings,
@@ -346,7 +333,7 @@ extension Xcode.BuildSettingsTable: PropertyListSerializable {
       func serialize(to serializer: PropertyListSerializer) throws -> [String: PropertyList] {
         // Create a `XCBuildConfiguration` plist dictionary.
         var dict = [String: PropertyList]()
-        dict["isa"] = .string("XCBuildConfiguration")
+        dict["isa"] = .string(xcodeClassName)
         dict["name"] = .string(name)
         // Combine the base settings and the overlay settings.
         dict["buildSettings"] = try combineBuildSettingsPropertyLists(
@@ -363,7 +350,7 @@ extension Xcode.BuildSettingsTable: PropertyListSerializable {
 
     // Create a `XCConfigurationList` plist dictionary.
     var dict = [String: PropertyList]()
-    dict["isa"] = .string("XCConfigurationList")
+    dict["isa"] = .string(xcodeClassName)
     dict["buildConfigurations"] = .array([
       // We use a private wrapper to "objectify" our two build settings
       // structures (which, being structs, are value types).
@@ -535,6 +522,9 @@ fileprivate protocol PropertyListSerializable: AnyObject {
   /// matters.  So this is acceptable for now in the interest of getting it
   /// done.
 
+  /// The ID for the `isa` field of the object.
+  var xcodeClassName: String { get }
+
   /// A custom ID to use for the instance, if enabled.
   ///
   /// This ID must be unique across the entire serialized graph.