xcode-select prefers non-RC over RC (#108)

* Adds PlistBuddyReader

* Updates ICommandRunner to take array of args

* Logs build number of selected Xcode version

* Prefers non-RC

* Checks for RC when comparing versions

Author: simonbs

xcode-select/__test__/FileSystemXcodeVersionRepository.test.ts

@@ -163,3 +163,17 @@ test("It omits build number when plist value is missing", async () => {
   const xcodeVersions = await repository.getXcodeVersions()
   expect(xcodeVersions[0].name).toBe("Xcode 14.3.0")
 })
+
+test("It includes RC in the Xcode version name", async () => {
+  const fileSystem = new MockFileSystem()
+  fileSystem.dirContents = ["/Users/runner/Applications/Xcode_26.2-RC.app"]
+  const semanticVersionParser = new SemanticVersionParser()
+  const xcodeVersionParser = new XcodeVersionParser({ semanticVersionParser })
+  const repository = new FileSystemXcodeVersionRepository({
+    fileSystem,
+    xcodeVersionParser,
+    plistReader: new MockPlistReader()
+  })
+  const xcodeVersions = await repository.getXcodeVersions()
+  expect(xcodeVersions[0].name).toContain("RC")
+})

xcode-select/__test__/XcodeVersionMatcher.test.ts

@@ -130,3 +130,13 @@ test("It prefers release version of beta version", async () => {
   expect(xcodeVersion?.isBeta).toEqual(false)
   expect(xcodeVersion?.betaNumber).toBeNull()
 })
+
+test("It prefers release version over release candidate", async () => {
+  const repository = new MockXcodeVersionRepository()
+  repository.addXcodeVersion(26, 2, 0, false, false)
+  repository.addXcodeVersion(26, 2, 0, false, true)
+  const needle = new SemanticVersionTemplate(26, 2, 0)
+  const matcher = new XcodeVersionMatcher({ xcodeVersionRepository: repository })
+  const xcodeVersion = await matcher.findXcodeVersion(needle)
+  expect(xcodeVersion?.isReleaseCandidate).toBe(false)
+})

xcode-select/__test__/XcodeVersionParser.test.ts

@@ -63,12 +63,13 @@ test("It parses XcodeVersion for release candidate", () => {
     semanticVersionParser: new SemanticVersionParser()
   })
   const xcodeVersion = parser.parseFilePath(filePath)
-  expect(xcodeVersion?.name).toEqual("Xcode 15.0.0")
+  expect(xcodeVersion?.name).toEqual("Xcode 15.0.0 RC")
   expect(xcodeVersion?.version.major).toEqual(15)
   expect(xcodeVersion?.version.minor).toEqual(0)
   expect(xcodeVersion?.version.patch).toEqual(0)
   expect(xcodeVersion?.isBeta).toBeFalsy()
   expect(xcodeVersion?.betaNumber).toBeNull()
+  expect(xcodeVersion?.isReleaseCandidate).toBeTruthy()
 })
 
 test("It parses XcodeVersion for abbreviated release candidate", () => {
@@ -77,12 +78,13 @@ test("It parses XcodeVersion for abbreviated release candidate", () => {
     semanticVersionParser: new SemanticVersionParser()
   })
   const xcodeVersion = parser.parseFilePath(filePath)
-  expect(xcodeVersion?.name).toEqual("Xcode 15.0.0")
+  expect(xcodeVersion?.name).toEqual("Xcode 15.0.0 RC")
   expect(xcodeVersion?.version.major).toEqual(15)
   expect(xcodeVersion?.version.minor).toEqual(0)
   expect(xcodeVersion?.version.patch).toEqual(0)
   expect(xcodeVersion?.isBeta).toBeFalsy()
   expect(xcodeVersion?.betaNumber).toBeNull()
+  expect(xcodeVersion?.isReleaseCandidate).toBeTruthy()
 })
 
 test("It parses XcodeVersion for 2nd beta version", () => {

xcode-select/__test__/mock/MockXcodeVersionRepository.ts

@@ -5,11 +5,17 @@ import IXcodeVersionRepository from "../../src/XcodeVersion/IXcodeVersionReposit
 export default class MockXcodeVersionRepository implements IXcodeVersionRepository {
   private xcodeVersions: XcodeVersion[] = []
 
-  addXcodeVersion(major: number, minor: number = 0, patch: number = 0, isBeta: boolean = false) {
+  addXcodeVersion(
+    major: number,
+    minor: number = 0,
+    patch: number = 0,
+    isBeta: boolean = false,
+    isReleaseCandidate: boolean = false
+  ) {
     const name = "Xcode " + [major, minor, patch].filter(e => e != null).join(".")
     const filePath = "/Users/runner/Applications/" + name + ".app"
     const version = new SemanticVersion(major, minor, patch)
-    const xcodeVersion = new XcodeVersion(filePath, version, isBeta)
+    const xcodeVersion = new XcodeVersion(filePath, version, isBeta, null, isReleaseCandidate)
     this.xcodeVersions.push(xcodeVersion)
   }
 

xcode-select/dist/index.js

@@ -54,6 +54,7 @@ export default class FileSystemXcodeVersionRepository implements IXcodeVersionRe
           && e.version.patch === xcodeVersion.version.patch
           && e.isBeta === xcodeVersion.isBeta
           && e.betaNumber === xcodeVersion.betaNumber
+          && e.isReleaseCandidate === xcodeVersion.isReleaseCandidate
       })
       if (existing.length == 0) {
         result.push(xcodeVersion)

xcode-select/src/XcodeVersion/FileSystemXcodeVersionRepository.ts

@@ -5,19 +5,22 @@ export default class XcodeVersion {
   private _version: SemanticVersion
   private _isBeta: boolean
   private _betaNumber: number | null
+  private _isReleaseCandidate: boolean
   private _buildNumber: string | null
 
   constructor(
     filePath: string, 
     version: SemanticVersion, 
     isBeta: boolean = false, 
     betaNumber: number | null = null,
+    isReleaseCandidate: boolean = false,
     buildNumber: string | null = null
   ) {
     this._filePath = filePath
     this._version = version
     this._isBeta = isBeta
     this._betaNumber = betaNumber
+    this._isReleaseCandidate = isReleaseCandidate
     this._buildNumber = buildNumber
   }
 
@@ -37,6 +40,10 @@ export default class XcodeVersion {
     return this._betaNumber
   }
 
+  get isReleaseCandidate(): boolean {
+    return this._isReleaseCandidate
+  }
+
   get buildNumber(): string | null {
     return this._buildNumber
   }
@@ -47,6 +54,7 @@ export default class XcodeVersion {
       this.version,
       this.isBeta,
       this.betaNumber,
+      this.isReleaseCandidate,
       buildNumber
     )
   }
@@ -59,6 +67,9 @@ export default class XcodeVersion {
         str += " " + this.betaNumber
       }
     }
+    if (this.isReleaseCandidate) {
+      str += " RC"
+    }
     if (this.buildNumber != null) {
       str += " (" + this.buildNumber + ")"
     }
@@ -75,6 +86,10 @@ export function xcodeVersionSort(lhs: XcodeVersion, rhs: XcodeVersion): number {
     return -1
   } else if (!lhs.isBeta && rhs.isBeta) {
     return 1
+  } else if (lhs.isReleaseCandidate && !rhs.isReleaseCandidate) {
+    return -1
+  } else if (!lhs.isReleaseCandidate && rhs.isReleaseCandidate) {
+    return 1
   } else if (lhs.isBeta && rhs.isBeta && lhs.betaNumber != null && rhs.betaNumber != null) {
     if (lhs.betaNumber < rhs.betaNumber) {
       return -1

xcode-select/src/XcodeVersion/XcodeVersion.ts

@@ -23,6 +23,9 @@ export default class XcodeVersionMatcher {
         if (lhs.isBeta !== rhs.isBeta) {
           return lhs.isBeta ? -1 : 1
         }
+        if (lhs.isReleaseCandidate !== rhs.isReleaseCandidate) {
+          return lhs.isReleaseCandidate ? -1 : 1
+        }
         return 0
       })
       .reverse()

xcode-select/src/XcodeVersion/XcodeVersionMatcher.ts

@@ -27,8 +27,13 @@ export default class XcodeVersionParser implements IXcodeVersionParser {
       .replace(/beta.*$/i, "")
       // Remove anything after the version number.
       .replace(/[^0-9]+$/, "")
+    const lowerName = name.toLowerCase()
     // Check if it is a beta version.
-    const isBeta = name.toLowerCase().includes("beta")
+    const isBeta = lowerName.includes("beta")
+    const isReleaseCandidate = lowerName.includes("rc")
+      || lowerName.includes("release candidate")
+      || lowerName.includes("release.candidate")
+      || lowerName.includes("releasecandidate")
     // Extract the b eta number if available.
     let betaNumber: number | null = null
     if (isBeta) {
@@ -44,6 +49,6 @@ export default class XcodeVersionParser implements IXcodeVersionParser {
     if (version == null) {
       return null
     }
-    return new XcodeVersion(filePath, version, isBeta, betaNumber)
+    return new XcodeVersion(filePath, version, isBeta, betaNumber, isReleaseCandidate)
   }
 }