checkpoint

Author: ncooke3

scripts/quickstart_spm_xcodeproj.sh

@@ -17,88 +17,95 @@
 # Modify a .xcodeproj to use a specific branch, version, or commit for the
 # firebase-ios-sdk SPM dependency.
 
-set -euo pipefail
-
-# --- Helper functions ---
-usage() {
-  echo "Usage: $0 <path_to.xcodeproj> [--version <version> | --revision <revision> | --prerelease]"
-  echo "Example: $0 path/to/MyProject.xcodeproj --version 10.24.0"
-  exit 1
-}
+set -xeuo pipefail
 
 # --- Argument parsing ---
 if [[ $# -lt 2 ]]; then
-  usage
+  echo "Modify a .xcodeproj to use a specific branch, version, or commit for the"
+  echo "firebase-ios-sdk SPM dependency.\n"
+  echo "Usage: $0 <path_to.xcodeproj> [--version <version> | --revision <revision> | --prerelease | --branch <branch>]"
+  exit 1
 fi
 
 XCODEPROJ_PATH="$1"
 shift
 MODE="$1"
 shift
 
-# Validate Xcode project path
-if [[ ! -d "$XCODEPROJ_PATH" || ! "$XCODEPROJ_PATH" == *.xcodeproj ]]; then
-    echo "Error: Invalid Xcode project path provided: $XCODEPROJ_PATH"
-    exit 1
-fi
 PBXPROJ_PATH="${XCODEPROJ_PATH}/project.pbxproj"
-if [[ ! -f "$PBXPROJ_PATH" ]]; then
-    echo "Error: project.pbxproj not found at ${PBXPROJ_PATH}"
-    exit 1
-fi
 
+# Regex matches SemVer `firebase-ios-sdk` dependency in project.pbxproj:
+# {
+#   isa = XCRemoteSwiftPackageReference;
+#	  repositoryURL = "https://github.com/firebase/firebase-ios-sdk.git";
+#   requirement = {
+#     kind = upToNextMajorVersion;
+#	    minimumVersion = xx.yy.zz;
+#	  };
+# };
+REQUIREMENT_REGEX='({'\
+'\s*isa = XCRemoteSwiftPackageReference;'\
+'\s*repositoryURL = "https://github\.com/firebase/firebase-ios-sdk(?:\.git)?";'\
+'\s*requirement = {\s*)kind = upToNextMajorVersion;'\
+'\s*minimumVersion = \d+\.\d+\.\d+;'\
+'(\s*};'\
+'\s*};)'
+
+# Define the replacement regex based on the selected mode.
 case "$MODE" in
   --version)
-    if [[ $# -lt 1 ]]; then usage; fi
+    if [[ $# -lt 1 ]]; then echo "Error: Missing version for --version"; exit 1; fi
     VERSION="$1"
-    # Release testing: Point to CocoaPods-{VERSION} tag (as a branch)
-    export REPLACEMENT_VALUE
-    REPLACEMENT_VALUE=$(printf '{\n\t\t\t\tkind = branch;\n\t\t\t\tbranch = "%s";\n\t\t\t}' "$VERSION")
+    REPLACEMENT_REGEX="\1kind = branch;\n\t\t\t\tbranch = \"$VERSION\";\2"
     ;;
   --prerelease)
-    # Prerelease testing: Point to the tip of the main branch
     COMMIT_HASH=$(git ls-remote https://github.com/firebase/firebase-ios-sdk.git main | cut -f1)
     if [[ -z "$COMMIT_HASH" ]]; then
         echo "Error: Failed to get remote revision for main branch."
         exit 1
     fi
-    export REPLACEMENT_VALUE
-    REPLACEMENT_VALUE=$(printf '{\n\t\t\t\tkind = revision;\n\t\t\t\trevision = "%s";\n\t\t\t}' "$COMMIT_HASH")
+    REPLACEMENT_REGEX="\1kind = revision;\n\t\t\t\trevision = \"$COMMIT_HASH\";\2"
     ;;
   --revision)
-    if [[ $# -lt 1 ]]; then usage; fi
+    if [[ $# -lt 1 ]]; then echo "Error: Missing revision for --revision"; exit 1; fi
     REVISION="$1"
-    # PR testing: Point to the specific commit hash of the current branch
-    export REPLACEMENT_VALUE
-    REPLACEMENT_VALUE=$(printf '{\n\t\t\t\tkind = revision;\n\t\t\t\trevision = "%s";\n\t\t\t}' "$REVISION")
+    REPLACEMENT_REGEX="\1kind = revision;\n\t\t\t\trevision = \"$REVISION\";\2"
+    ;;
+  --branch)
+    if [[ $# -lt 1 ]]; then echo "Error: Missing branch name for --branch"; exit 1; fi
+    BRANCH_NAME="$1"
+    REPLACEMENT_REGEX="\1kind = branch;\n\t\t\t\tbranch = \"$BRANCH_NAME\";\2"
     ;;
   *)
-    usage
+    echo "Invalid mode: $MODE"
+    exit 1
     ;;
 esac
 
-# Read the original content to check for changes later.
-ORIGINAL_CONTENT=$(<"$PBXPROJ_PATH")
+# Make a temporary backup of the original file.
+# This will be used to check if any changes were made.
+TEMP_FILE=$(mktemp)
+cp "$PBXPROJ_PATH" "$TEMP_FILE"
 
-# Use perl to perform the replacement.
-# -0777: Slurp the whole file into one string.
-# -i: Edit in-place.
-# -p: Loop over the input.
-# -e: Execute the script.
-# The `e` flag in `s/.../.../ge` evaluates the replacement as a Perl expression.
-# This allows us to use an environment variable for the replacement string,
-# avoiding quoting issues with shell variables.
-perl -0777 -i -pe 's#(repositoryURL = "https://github.com/firebase/firebase-ios-sdk\.git";\s*requirement = )\{[^\}]+\};#$1 . $ENV{"REPLACEMENT_VALUE"} . ";"#ge' "$PBXPROJ_PATH" || {
+# Performs the replacement using Perl.
+#
+# -0777 Enables reading all input in one go (slurp), rather than line-by-line.
+# -p Causes Perl to loop through the input line by line.
+# -i Edits the file in place.
+# -e Provides the expression to execute.
+perl -0777 -i -pe "s#$REQUIREMENT_REGEX#$REPLACEMENT_REGEX#g" "$PBXPROJ_PATH" || {
   echo "Failed to update the Xcode project's SPM dependency."
   exit 1
 }
 
-# Verify that the file was changed.
-UPDATED_CONTENT=$(<"$PBXPROJ_PATH")
-if [[ "$ORIGINAL_CONTENT" == "$UPDATED_CONTENT" ]]; then
+# Silently compare the modified file with the temporary backup.
+# If they are the same, cmp will return 0 (success), and the 'if' block will run.
+if cmp -s "$PBXPROJ_PATH" "$TEMP_FILE"; then
   echo "Failed to find and replace the firebase-ios-sdk dependency. Check the regex pattern and project file structure."
+  # Restore the original file from the backup
+  mv "$TEMP_FILE" "$PBXPROJ_PATH"
   exit 1
-}
+fi
 
 echo "Successfully updated SPM dependency in $PBXPROJ_PATH"