From 7aa19b314d790a897c1119c64059368baa9be309 Mon Sep 17 00:00:00 2001
From: Chen Asraf <casraf@pm.me>
Date: Mon, 12 Aug 2024 00:08:19 +0300
Subject: [PATCH] build: refactor buid scripts to sh file

---
 README.md          |  17 ++++
 script_runner.yaml | 136 +++++-----------------------
 tool/build.sh      | 220 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 261 insertions(+), 112 deletions(-)
 create mode 100644 tool/build.sh

diff --git a/README.md b/README.md
index e9180c62..9d05b631 100644
--- a/README.md
+++ b/README.md
@@ -90,6 +90,23 @@ don't hesitate to open an appropriate issue and I will do my best to reply promp
 As mentioned above, Firebase secret keys must be your own, and so are the databases and services
 related to them. This project requires Firebase auth and Cloud Firestore to function.
 
+#### Build Tools
+
+Use `script_runner` to run build scripts.
+
+You can use these examples to start:
+
+```sh
+dart pub global activate script_runner
+
+scr -h # see all commands + help
+scr -ls [search_term] # find scripts by name, or list all scripts
+
+# e.g.
+scr -ls android # see all possible android-related scripts
+scr android:build:release # build for android release
+```
+
 ### Translations
 
 This app is currently only available in English. However, it's possible to contribute translations
diff --git a/script_runner.yaml b/script_runner.yaml
index da01a149..827c8c06 100644
--- a/script_runner.yaml
+++ b/script_runner.yaml
@@ -1,173 +1,83 @@
-shell: /bin/zsh
+run_cond shell: /bin/zsh
 scripts:
   # ===============================================================================================
   # Android
   # ===============================================================================================
   - name: android:build:apk
-    cmd: flutter build apk
+    cmd: build android --build --apk
     description: Build Android APK only
   - name: android:build:bundle
-    cmd: flutter build appbundle
+    cmd: build android --build --aab
     description: Build Android unified bundle (for Play Store release)
   - name: android:build:all
-    cmd: android:build:apk && android:build:bundle
+    cmd: build android --build --apk --aab
     description: Build Android unified bundle + standalone APK
   - name: android:push
     description: Push APK to ADB-connected device
-    cmd: |-
-      name=$(dart run btool get packageName)
-      version=$(dart run btool get packageVersion)
-      source="$(pwd)/build/app/outputs/flutter-apk/app-release.apk"
-      target="/sdcard/Download/$name-$version.apk"
-      adb push $source $target
+    cmd: build android --push
   - name: android:install
-    cmd: |-
-      adb uninstall app.dungeonpaper
-      adb install -r build/app/outputs/flutter-apk/app-release.apk
+    cmd: build android --install
     description: Install APK on Android (does not build)
   - name: android:full
-    cmd: android:build:apk && android:push && android:install
+    cmd: scr android:build:all --install --push
     description: Build, push and install APK to ADB connected device
   - name: android:release
-    cmd: |-
-      name=$(dart run btool get packageName)
-      version=$(dart run btool get packageVersion)
-      bundleout="$name-$version.aab"
-      bundle=build/app/outputs/bundle/release/app-release.aab
-      mkdir -p release/android
-      android:build:bundle && cp "$bundle" "release/android/$bundleout"
-      android:symbols:collect
-      [[ ! -f "$(which open)" ]] || open release/android
+    cmd: build android --release
     description: Builds, collects debug symbols, and places the output in release/ dir.
   - name: android:symbols:collect
-    cmd: |-
-      dir="$(pwd)/release/android"
-      name=$(dart run btool get packageName)
-      version=$(dart run btool get packageVersion)
-      filename="symbols-$name-$version.zip"
-      mkdir release
-      cd build/app/intermediates/merged_native_libs/release/out/lib
-      zip -r "$dir/$filename" */*
+    cmd: build android --symbols
     description: Create a zip of the debug symbols for Android
 
   # ===============================================================================================
   # iOS
   # ===============================================================================================
   - name: ios:build:app
-    cmd: flutter build ios
+    cmd: build ios --build --app
     description: Build iOS APP file
   - name: ios:build:bundle
-    cmd: flutter build ipa
+    cmd: build ios --build --ipa
     description: Build iOS IPA file
   - name: ios:build:all
-    cmd: ios:build:app && ios:build:bundle
+    cmd: build ios --build --app --ipa
     description: Build iOS IPA + APP
   - name: ios:pod:update
-    cmd: pushd ios; pod repo update && pod install; popd
+    cmd: build ios --repo-update
     description: Install Pods for iOS
   - name: ios:release
-    cmd: |-
-      name=$(dart run btool get packageName)
-      version=$(dart run btool get packageVersion)
-      bundleout="$name-$version.ipa"
-      bundle="build/ios/ipa/Dungeon Paper.ipa"
-      mkdir -p release/ios
-      ios:build:bundle && cp "$bundle" "release/ios/$bundleout"
-      [[ ! -f "$(which open)" ]] || open release/ios
+    cmd: build ios --release
     description: Builds, and places the output in release/ dir.
 
   # ===============================================================================================
   # macOS
   # ===============================================================================================
   - name: macos:build:app
-    cmd: flutter build macos
+    cmd: build macos --build
     description: Build macOS App
   - name: macos:build:all
     cmd: macos:build:app
     description: 'Alias for: Build macOS App'
   - name: macos:pod:update
-    cmd: pushd macos; pod repo update && pod install; popd
+    cmd: build macos --repo-update
     description: Install Pods for macOS
   - name: macos:release
-    cmd: macos:build:app && macos:pack
+    cmd: build macos --build --pack
     description: Builds, and places the output in release/ dir.
   - name: macos:pack
     description: Package macOS app into pkg file
-    cmd: |-
-      app="build/macos/Build/Products/Release/Dungeon Paper.app"
-      title="Dungeon Paper"
-      name=$(dart run btool get packageName)
-      version=$(dart run btool get packageVersion)
-      outdir="release/macos"
-      tmp="$outdir/pack.temp.dmg"
-      dmgout="$name-$version.dmg"
-      source="macos/build/dmg"
-
-      rm -rf "$source"
-      mkdir -p "$source/.background"
-      cp -r "$app" "$source"
-      cp "assets/images/dmg_bg.png" "$source/.background/background.png"
-      ln -s "/Applications" "$source/Applications"
-      size=$(du -sk "$source" | awk '{print $1}')
-      size=$(($size + (1024 * 10)))
-      echo "Creating DMG: $dmgout"
-      hdiutil create -srcfolder "$source" -volname "$title" -fs HFS+ \
-        -fsargs "-c c=64,a=16,e=16" -format UDRW -size "${size}k" "$tmp"
-      echo "Attaching $tmp"
-      device=$(hdiutil attach -readwrite -noverify -noautoopen "$tmp" | \
-         egrep '^/dev/' | sed 1q | awk '{print $1}')
-      sleep 0.5
-      echo "Making layout modifications"
-      echo "
-        tell application \"Finder\"
-          tell disk \"$title\"
-            open
-            set current view of container window to icon view
-            set toolbar visible of container window to false
-            set statusbar visible of container window to false
-            set the bounds of container window to {400, 200, 900, 500}
-            set theViewOptions to the icon view options of container window
-            set arrangement of theViewOptions to not arranged
-            set icon size of theViewOptions to 112
-            set background picture of theViewOptions to file \".background:background.png\"
-            # make new alias file at container window to POSIX file \"/Applications\" with properties {name:\"Applications\"}
-            set position of item \"$title\" of container window to {112, 112}
-            set position of item \"Applications\" of container window to {387, 112}
-            close
-            open
-            update without registering applications
-            delay 5
-            close
-          end tell
-        end tell
-      " | osascript
-      chmod -Rf go-w "/Volumes/$title"
-      sync
-      sync
-      echo "Detaching $tmp"
-      hdiutil detach "$device"
-      echo "Converting $tmp to $dmgout"
-      [[ -f "release/macos/$dmgout" ]] && rm "$outdir/$dmgout"
-      hdiutil convert "$tmp" -format UDZO -imagekey zlib-level=9 -o "$outdir/$dmgout"
-      rm -f "$tmp"
-      webdir="../dungeon-paper-website/public/downloads/macos"
-      mkdir -p "$webdir"
-      cp "$outdir/$dmgout" "$webdir"
-      cp "$webdir/$dmgout" "$webdir/$name-latest.dmg"
-      [[ ! -f "$(which open)" ]] || open release/macos
+    cmd: build macos --pack
 
   # ===============================================================================================
   # Web
   # ===============================================================================================
   - name: web:build
-    cmd: flutter build web
+    cmd: build web --build
     description: Build Web app
   - name: web:publish
-    cmd: firebase deploy --only hosting
+    cmd: build web --publish
     description: Publish web version using Firebase (requires build)
   - name: web:release
-    cmd: web:build && web:publish
-    descrition: Build & publish web version using Firebase
+    cmd: build web --build --publish
+    description: Build & publish web version using Firebase
 
   # ===============================================================================================
   # All
@@ -182,6 +92,8 @@ scripts:
   # ===============================================================================================
   # Utils
   # ===============================================================================================
+  - name: build
+    cmd: . tool/build.sh
   - name: format
     cmd: dart format --line-length 120
     description: Format all Dart files
diff --git a/tool/build.sh b/tool/build.sh
new file mode 100644
index 00000000..711954ff
--- /dev/null
+++ b/tool/build.sh
@@ -0,0 +1,220 @@
+#!/usr/bin/env bash
+
+name=$(dart run btool get packageName)
+version=$(dart run btool get packageVersion)
+basen="$name-$version"
+dn="Dungeon Paper"
+
+android_push_to_device() {
+  local src
+  src="$(pwd)/build/app/outputs/flutter-apk/app-release.apk"
+  local target="/sdcard/Download/$basen.apk"
+  adb push "$src" "$target"
+}
+
+android_install() {
+  adb uninstall app.dungeonpaper
+  adb install -r build/app/outputs/flutter-apk/app-release.apk
+}
+
+android_release() {
+  bundleout="$basen.aab"
+  bundle=build/app/outputs/bundle/release/app-release.aab
+  mkdir -p release/android
+  cp "$bundle" "release/android/$bundleout"
+  android_collect_symbols
+  [[ ! -f "$(which open)" ]] || open release/android
+}
+
+android_collect_symbols() {
+  dir="$(pwd)/release/android"
+  filename="symbols-$basen.zip"
+  mkdir release
+  cd build/app/intermediates/merged_native_libs/release/out/lib || exit
+  zip -r "$dir/$filename" ./*/*
+  [[ ! -f "$(which open)" ]] || open release/android
+}
+
+ios_release() {
+  bundleout="$basen.ipa"
+  bundle="build/ios/ipa/$dn.ipa"
+  mkdir -p release/ios
+  cp "$bundle" "release/ios/$bundleout"
+  [[ ! -f "$(which open)" ]] || open release/ios
+}
+
+macos_pack() {
+  app="build/macos/Build/Products/Release/$dn.app"
+  title="$dn"
+  outdir="release/macos"
+  tmp="$outdir/pack.temp.dmg"
+  dmgout="$basen.dmg"
+  source="macos/build/dmg"
+
+  rm -rf "$source"
+  mkdir -p "$source/.background"
+  cp -r "$app" "$source"
+  cp "assets/images/dmg_bg.png" "$source/.background/background.png"
+  ln -s "/Applications" "$source/Applications"
+  size=$(du -sk "$source" | awk '{print $1}')
+  size=$((size + (1024 * 10)))
+
+  echo "Creating DMG: $dmgout"
+  hdiutil create -srcfolder "$source" -volname "$title" -fs HFS+ \
+    -fsargs "-c c=64,a=16,e=16" -format UDRW -size "${size}k" "$tmp"
+  echo "Attaching $tmp"
+  device=$(hdiutil attach -readwrite -noverify -noautoopen "$tmp" | \
+     grep -E '^/dev/' | sed 1q | awk '{print $1}')
+  sleep 0.5
+
+  echo "Making layout modifications"
+  echo "
+    tell application \"Finder\"
+      tell disk \"$title\"
+        open
+        set current view of container window to icon view
+        set toolbar visible of container window to false
+        set statusbar visible of container window to false
+        set the bounds of container window to {400, 200, 900, 500}
+        set theViewOptions to the icon view options of container window
+        set arrangement of theViewOptions to not arranged
+        set icon size of theViewOptions to 112
+        set background picture of theViewOptions to file \".background:background.png\"
+        # make new alias file at container window to POSIX file \"/Applications\" with properties {name:\"Applications\"}
+        set position of item \"$title\" of container window to {112, 112}
+        set position of item \"Applications\" of container window to {387, 112}
+        close
+        open
+        update without registering applications
+        delay 5
+        close
+      end tell
+    end tell
+  " | osascript
+  chmod -Rf go-w "/Volumes/$title"
+  sync
+  sync
+
+  echo "Detaching $tmp"
+  hdiutil detach "$device"
+
+  echo "Converting $tmp to $dmgout"
+  [[ -f "release/macos/$dmgout" ]] && rm "$outdir/$dmgout"
+  hdiutil convert "$tmp" -format UDZO -imagekey zlib-level=9 -o "$outdir/$dmgout"
+  rm -f "$tmp"
+  webdir="../dungeon-paper-website/public/downloads/macos"
+  mkdir -p "$webdir"
+
+  [[ ! -f "$(which open)" ]] || open release/macos
+}
+
+run_cond() {
+  cond="$1"
+  shift
+  cmd="$*"
+  if [[ $# -lt 1 ]]; then
+    if [[ -n $cond ]]; then return 0; else return 1; fi
+  fi
+  if [[ -n $cond ]]; then
+    $cmd
+  fi
+}
+
+main() {
+  if [[ $# -gt 0 ]]; then
+    case $1 in
+      "android")
+        shift
+        while [[ $# -gt 0 ]]; do
+          case $1 in
+            --build) build=1 ;;
+            --apk) build=1; apk=1 ;;
+            --aap) build=1; aab=1 ;;
+            --push) push=1 ;;
+            --install) install=1 ;;
+            --release) release=1; build=1; aab=1 ;;
+            --symbols) symbols=1 ;;
+            *) echo "Unknown command or option: android $1. Available flags: --build, --apk, --aap, --push, --install, --release" ;;
+          esac
+          shift
+        done
+        if run_cond "$build"; then
+          run_cond "$apk" 'flutter build apk'
+          run_cond "$aab" 'flutter build appbundle'
+        fi
+        if run_cond "$release"; then
+          android_release
+        elif run_cond "$symbols"; then
+          android_collect_symbols
+        fi
+        run_cond "$push" android_push_to_device
+        run_cond "$install" android_install
+        ;;
+      ios)
+        shift
+        while [[ $# -gt 0 ]]; do
+          case $1 in
+            --build) build=1 ;;
+            --app) build=1; app=1 ;;
+            --ipa) build=1; ipa=1 ;;
+            --release) release=1; build=1; ipa=1 ;;
+            --repo-update) repo_update=1 ;;
+            *) echo "Unknown command or option: ios $1. Available flags: --build, --app, --ipa, --release, --repo-update" ;;
+          esac
+          shift
+        done
+        if run_cond "$repo_update"; then
+          pushd ios || exit
+          pod repo update && pod install
+          popd || exit
+        fi
+        if run_cond "$build"; then
+          run_cond "$app" 'flutter build app'
+          run_cond "$ipa" 'flutter build ipa'
+        fi
+        # TODO get existing github release or create new one, then upload artifact as asset (replace existing if needed)
+        ;;
+      macos)
+        shift
+        while [[ $# -gt 0 ]]; do
+          case $1 in
+            --build) build=1 ;;
+            --pack) release=1; pack=1 ;;
+            --repo-update) repo_update=1 ;;
+            *) echo "Unknown command or option: ios $1. Available flags: --build, --pack, --repo-update" ;;
+          esac
+          shift
+        done
+        if run_cond "$repo_update"; then
+          pushd macos || exit
+          pod repo update && pod install
+          popd || exit
+        fi
+        run_cond "$build" 'flutter build macos'
+        run_cond "$pack" macos_pack
+        run_cond "$release" ios_release
+        ;;
+      web)
+        shift
+        while [[ $# -gt 0 ]]; do
+          case $1 in
+            --build) build=1 ;;
+            --publish) publish=1 ;;
+            --release) build=1; publish=1; ;;
+            *) echo "Unknown command or option: ios $1. Available flags: --build, --publish, --release" ;;
+          esac
+          shift
+        done
+        run_cond "$build" 'flutter build web'
+        run_cond "$publish" 'firebase deploy --only hosting'
+        ;;
+      *)
+        echo "Unknown command: $1"
+        ;;
+    esac
+  else
+    echo "Usage: build.sh <android|ios|macos|web> [flags]"
+  fi
+}
+
+main "$@"
\ No newline at end of file