Allowing override LastUpgradeCheck and LastUpgradeVersion

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 #### Added
 - Allow specifying a `github` name like `JohnSundell/Ink` instead of a full `url` for Swift Packages [#1029](https://github.com/yonaskolb/XcodeGen/pull/1029) @yonaskolb
+- Added explicity `LastUpgradeCheck` and `LastUpgradeVersion` override support so it's possible to override these properties without using the `project.xcodeVersion`. [1013](https://github.com/yonaskolb/XcodeGen/pull/1013) @Andre113
 - Added `macroExpansion` for `run` in `schemes` [#1036](https://github.com/yonaskolb/XcodeGen/pull/1036) @freddi-kit
 - Added `askForAppToLaunch` for `profile` in `schemes`  [#1035](https://github.com/yonaskolb/XcodeGen/pull/1035) @freddi-kit
 

Docs/ProjectSpec.md

@@ -39,7 +39,7 @@ You can also use environment variables in your configuration file, by using `${S
 - [x] **name**:  **String** - Name of the generated project
 - [ ] **include**:  **[Include](#include)** - One or more paths to other specs
 - [ ] **options**: **[Options](#options)** - Various options to override default behaviour
-- [ ] **attributes**: **[String: Any]** - The PBXProject attributes. This is for advanced use. This defaults to ``{"LastUpgradeCheck": "XcodeVersion"}`` with `xcodeVersion` being set by [Options](#options)`.xcodeVersion`
+- [ ] **attributes**: **[String: Any]** - The PBXProject attributes. This is for advanced use. If no value is set for `LastUpgradeCheck`, it will be defaulted to ``{"LastUpgradeCheck": "XcodeVersion"}`` with `xcodeVersion` being set by [Options](#options)`.xcodeVersion`
 - [ ] **configs**: **[Configs](#configs)** - Project build configurations. Defaults to `Debug` and `Release` configs
 - [ ] **configFiles**: **[Config Files](#config-files)** - `.xcconfig` files per config
 - [ ] **settings**: **[Settings](#settings)** - Project specific settings. Default base and config type settings will be applied first before any settings defined here

Sources/XcodeGenKit/PBXProjGenerator.swift

@@ -285,9 +285,16 @@ public class PBXProjGenerator {
             }.flatMap { $0 }
         ).sorted()
 
-        var projectAttributes: [String: Any] = ["LastUpgradeCheck": project.xcodeVersion]
-            .merged(project.attributes)
-
+        var projectAttributes: [String: Any] = project.attributes
+
+        // Set default LastUpgradeCheck if user did not specify
+        let lastUpgradeKey = "LastUpgradeCheck"
+        if !projectAttributes.contains(where: { (key, value) -> Bool in
+            key == lastUpgradeKey && value is String
+        }) {
+            projectAttributes[lastUpgradeKey] = project.xcodeVersion
+        }
+
         if !assetTags.isEmpty {
             projectAttributes["knownAssetTags"] = assetTags
         }

Sources/XcodeGenKit/SchemeGenerator.swift

@@ -295,9 +295,11 @@ public class SchemeGenerator {
             postActions: scheme.archive?.postActions.map(getExecutionAction) ?? []
         )
 
+        let lastUpgradeVersion = project.attributes["LastUpgradeCheck"] as? String ?? project.xcodeVersion
+
         return XCScheme(
             name: scheme.name,
-            lastUpgradeVersion: project.xcodeVersion,
+            lastUpgradeVersion: lastUpgradeVersion,
             version: project.schemeVersion,
             buildAction: buildAction,
             testAction: testAction,

Sources/XcodeGenKit/Version.swift

@@ -3,7 +3,7 @@ import ProjectSpec
 
 extension Project {
 
-    var xcodeVersion: String {
+    public var xcodeVersion: String {
         XCodeVersion.parse(options.xcodeVersion ?? "12.0")
     }
 

Tests/XcodeGenKitTests/PBXProjGeneratorTests.swift

@@ -261,5 +261,43 @@ class PBXProjGeneratorTests: XCTestCase {
             }
         }
     }
-
+
+    func testDefaultLastUpgradeCheckWhenUserDidSpecifyInvalidValue() throws {
+        let lastUpgradeKey = "LastUpgradeCheck"
+        let attributes: [String: Any] = [lastUpgradeKey: 1234]
+        let project = Project(name: "Test", attributes: attributes)
+        let projGenerator = PBXProjGenerator(project: project)
+
+        let pbxProj = try projGenerator.generate()
+
+        for pbxProject in pbxProj.projects {
+            XCTAssertEqual(pbxProject.attributes[lastUpgradeKey] as? String, project.xcodeVersion)
+        }
+    }
+
+    func testOverrideLastUpgradeCheckWhenUserDidSpecifyValue() throws {
+        let lastUpgradeKey = "LastUpgradeCheck"
+        let lastUpgradeValue = "1234"
+        let attributes: [String: Any] = [lastUpgradeKey: lastUpgradeValue]
+        let project = Project(name: "Test", attributes: attributes)
+        let projGenerator = PBXProjGenerator(project: project)
+
+        let pbxProj = try projGenerator.generate()
+
+        for pbxProject in pbxProj.projects {
+            XCTAssertEqual(pbxProject.attributes[lastUpgradeKey] as? String, lastUpgradeValue)
+        }
+    }
+
+    func testDefaultLastUpgradeCheckWhenUserDidNotSpecifyValue() throws {
+        let lastUpgradeKey = "LastUpgradeCheck"
+        let project = Project(name: "Test")
+        let projGenerator = PBXProjGenerator(project: project)
+
+        let pbxProj = try projGenerator.generate()
+
+        for pbxProject in pbxProj.projects {
+            XCTAssertEqual(pbxProject.attributes[lastUpgradeKey] as? String, project.xcodeVersion)
+        }
+    }
 }

Tests/XcodeGenKitTests/SchemeGeneratorTests.swift

@@ -434,6 +434,32 @@ class SchemeGeneratorTests: XCTestCase {
             }
         }
     }
+
+    func testOverrideLastUpgradeVersionWhenUserDidSpecify() throws {
+        var target = app
+        target.scheme = TargetScheme()
+
+        let lastUpgradeKey = "LastUpgradeCheck"
+        let lastUpgradeValue = "1234"
+        let attributes: [String: Any] = [lastUpgradeKey: lastUpgradeValue]
+        let project = Project(name: "test", targets: [target, framework], attributes: attributes)
+        let xcodeProject = try project.generateXcodeProject()
+
+        let xcscheme = try unwrap(xcodeProject.sharedData?.schemes.first)
+        XCTAssertEqual(xcscheme.lastUpgradeVersion, lastUpgradeValue)
+    }
+
+
+    func testDefaultLastUpgradeVersionWhenUserDidNotSpecify() throws {
+        var target = app
+        target.scheme = TargetScheme()
+
+        let project = Project(name: "test", targets: [target, framework])
+        let xcodeProject = try project.generateXcodeProject()
+
+        let xcscheme = try unwrap(xcodeProject.sharedData?.schemes.first)
+        XCTAssertEqual(xcscheme.lastUpgradeVersion, project.xcodeVersion)
+    }
 
     // MARK: - Helpers