Release: 2.2.1-rc1

Based on https://gist.github.com/jv-k/703e79306554c26a65a7cfdb9ca119c6

WIP

VERSION

@@ -0,0 +1 @@
+2.2.1-rc1 20201010

app-common/src/main/java/eu/darken/capod/common/bluetooth/BleScanner.kt

@@ -35,7 +35,7 @@ class BleScanner @Inject constructor(
         log(TAG, VERBOSE) { "scan(filters=$filters, scannerMode=$scannerMode, compatMode=$compatMode)" }
         if (compatMode) log(TAG, WARN) { "Using compatibilityMode!" }
 
-        val adapter = bluetoothManager.adapter
+        val adapter = bluetoothManager.adapter ?: throw IllegalStateException("Bluetooth adapter unavailable")
 
         val supportsOffloadFiltering = adapter.isOffloadedFilteringSupported.also {
             log(TAG, if (it) DEBUG else WARN) { "isOffloadedFilteringSupported=$it" }
@@ -45,7 +45,7 @@ class BleScanner @Inject constructor(
             log(TAG, if (it) DEBUG else WARN) { "isOffloadedScanBatchingSupported=$it" }
         } && !compatMode
 
-        val scanner = bluetoothManager.scanner
+        val scanner = bluetoothManager.scanner ?: throw IllegalStateException("BLE scanner unavailable")
 
         val callback = object : ScanCallback() {
             var lastScanAt = System.currentTimeMillis()

app-common/src/main/java/eu/darken/capod/common/bluetooth/BluetoothManager2.kt

@@ -30,12 +30,11 @@ class BluetoothManager2 @Inject constructor(
     private val dispatcherProvider: DispatcherProvider,
 ) {
 
-    val adapter: BluetoothAdapter
+    val adapter: BluetoothAdapter?
         get() = manager.adapter
 
-    val scanner: BluetoothLeScanner
-        get() = adapter.bluetoothLeScanner
-            ?: throw IllegalStateException("Bluetooth is disabled or permissiong missing")
+    val scanner: BluetoothLeScanner?
+        get() = adapter?.bluetoothLeScanner
 
     val isBluetoothEnabled: Flow<Boolean> = callbackFlow {
         send(manager.adapter?.isEnabled ?: false)
@@ -158,7 +157,9 @@ class BluetoothManager2 @Inject constructor(
             }
         }
 
-    fun bondedDevices(): Set<BluetoothDevice> = adapter.bondedDevices
+    fun bondedDevices(): Flow<Set<BluetoothDevice>> = flow {
+        emit(adapter?.bondedDevices ?: throw IllegalStateException("Bluetooth adapter unavailable"))
+    }
 
     suspend fun nudgeConnection(device: BluetoothDevice): Boolean = getBluetoothProfile().map { bluetoothProfile ->
         try {

app-common/src/main/java/eu/darken/capod/reaction/core/autoconnect/AutoConnect.kt

@@ -46,7 +46,8 @@ class AutoConnect @Inject constructor(
                 return@map
             }
 
-            val bondedDevice = bluetoothManager.bondedDevices().firstOrNull { it.address == mainDeviceAddr }
+            val bondedDevice = bluetoothManager.bondedDevices().first().firstOrNull { it.address == mainDeviceAddr }
+
             if (bondedDevice == null) {
                 log(TAG, WARN) { "No bonded device matches $mainDeviceAddr" }
                 return@map

app-common/src/main/res/values-es-rAR/strings.xml

@@ -1,2 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
-<resources xmlns:tools="http://schemas.android.com/tools" tools:ignore="MissingTranslation"></resources>
+<resources xmlns:tools="http://schemas.android.com/tools" tools:ignore="MissingTranslation">
+    <string name="app_name">CAPod</string>
+    <string name="app_name_pro">CAPod Pro</string>
+    <string name="app_name_foss">CAPod FOSS</string>
+    <string name="general_value_not_available_label">N/D</string>
+    <string name="general_error_label">Error</string>
+    <string name="general_grant_permission_action">Conceder permiso</string>
+    <string name="overview_nomaindevice_label">Ningún dispositivo principal</string>
+</resources>

app-common/src/main/res/values-fr/strings.xml

@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources xmlns:tools="http://schemas.android.com/tools" tools:ignore="MissingTranslation">
+    <string name="app_name">CAPod</string>
+    <string name="app_name_pro">CAPod Pro</string>
+    <string name="app_name_foss">CAPod FOSS (libre)</string>
     <string name="general_value_not_available_label">Non disponible</string>
     <string name="general_error_label">Erreur</string>
     <string name="general_grant_permission_action">Accorder l’autorisation</string>
@@ -11,6 +14,7 @@
     <string name="permission_bluetooth_connect_description">Cette appli exige l’autorisation « Connexion Bluetooth » pour interagir avec les appareils jumelés et démarrer les connexions.</string>
     <string name="permission_bluetooth_scan_label">Analyse Bluetooth</string>
     <string name="permission_bluetooth_scan_description">L’autorisation « Analyse Bluetooth » permet à l’appli de découvrir et de réceptionner les données Bluetooth des appareils à proximité tels que vos AirPods.</string>
+    <string name="permission_bluetooth_label">Bluetooth</string>
     <string name="permission_bluetooth_description">Cette appli exige l’autorisation « Bluetooth » pour se connecter aux appareils Bluetooth jumelés.</string>
     <string name="permission_access_fine_location_label">Accéder à la position précise</string>
     <string name="permission_access_fine_location_description">CAPod utilise l’autorisation « position précise » pour recevoir les données « faible énergie » de Bluetooth. Votre casque-micro utilise la technologie « basse énergie » de Bluetooth pour diffuser son état. Cette appli n’utilisera PAS les données Bluetooth pour déterminer votre position.</string>
@@ -48,6 +52,7 @@
     <string name="pods_none_label_short">Aucun appareil</string>
     <string name="pods_charging_label">En charge</string>
     <string name="pods_inear_label">Dans l’oreille</string>
+    <string name="pods_microphone_label">Microphone</string>
     <string name="pods_yours">Les vôtres</string>
     <string name="headset_being_worn_label">Porté</string>
     <string name="pods_case_unknown_state">État inconnu</string>

app-wear/src/main/java/eu/darken/capod/wear/ui/overview/cards/pods/DualPodsCardVH.kt

@@ -29,8 +29,8 @@ class DualPodsCardVH(parent: ViewGroup) :
             }
             text = sb
 
-            if (item.isMainPod) setTypeface(typeface, Typeface.BOLD)
-            else setTypeface(typeface, Typeface.NORMAL)
+            if (item.isMainPod) setTypeface(null, Typeface.BOLD)
+            else setTypeface(null, Typeface.NORMAL)
 
             if (device is DualAirPods && item.showDebug) {
                 append(" [${device.primaryPod.name}]")

app-wear/src/main/java/eu/darken/capod/wear/ui/overview/cards/pods/SinglePodsCardVH.kt

@@ -23,8 +23,8 @@ class SinglePodsCardVH(parent: ViewGroup) :
 
         name.apply {
             text = device.getLabel(context)
-            if (item.isMainPod) setTypeface(typeface, Typeface.BOLD)
-            else setTypeface(typeface, Typeface.NORMAL)
+            if (item.isMainPod) setTypeface(null, Typeface.BOLD)
+            else setTypeface(null, Typeface.NORMAL)
         }
 
         deviceIcon.setImageResource(device.iconRes)

app/src/gplay/res/values-es-rAR/strings.xml

@@ -1,2 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<resources></resources>
+<resources>
+    <string name="upgrades_gplay_unavailable_error">Los servicios de Google Play no están disponibles.</string>
+    <string name="upgrades_no_purchases_found_check_account">No se encontraron compras. ¿Está usando la cuenta correcta?</string>
+</resources>

app/src/main/java/eu/darken/capod/common/uix/PreferenceFragment2.kt

@@ -10,9 +10,7 @@ import androidx.annotation.MenuRes
 import androidx.annotation.XmlRes
 import androidx.appcompat.widget.Toolbar
 import androidx.fragment.app.Fragment
-import androidx.lifecycle.LiveData
 import androidx.preference.PreferenceFragmentCompat
-import androidx.viewbinding.ViewBinding
 import eu.darken.capod.common.preferences.Settings
 import eu.darken.capod.main.ui.settings.SettingsFragment
 
@@ -69,17 +67,4 @@ abstract class PreferenceFragment2
             }
         }
     }
-
-    inline fun <T> LiveData<T>.observe2(
-        crossinline callback: (T) -> Unit
-    ) {
-        observe(viewLifecycleOwner) { callback.invoke(it) }
-    }
-
-    inline fun <T, reified VB : ViewBinding?> LiveData<T>.observe2(
-        ui: VB,
-        crossinline callback: VB.(T) -> Unit
-    ) {
-        observe(viewLifecycleOwner) { callback.invoke(ui, it) }
-    }
 }

app/src/main/java/eu/darken/capod/common/uix/PreferenceFragment3.kt

@@ -0,0 +1,35 @@
+package eu.darken.capod.common.uix
+
+import android.os.Bundle
+import android.view.View
+import androidx.lifecycle.LiveData
+import androidx.viewbinding.ViewBinding
+import eu.darken.capod.common.error.asErrorDialogBuilder
+
+abstract class PreferenceFragment3 : PreferenceFragment2() {
+
+    abstract val vm: ViewModel3
+
+    var onErrorEvent: ((Throwable) -> Boolean)? = null
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+
+        vm.errorEvents.observe2 {
+            val showDialog = onErrorEvent?.invoke(it) ?: true
+            if (showDialog) it.asErrorDialogBuilder(requireContext()).show()
+        }
+    }
+
+    inline fun <T> LiveData<T>.observe2(
+        crossinline callback: (T) -> Unit
+    ) {
+        observe(viewLifecycleOwner) { callback.invoke(it) }
+    }
+
+    inline fun <T, reified VB : ViewBinding?> LiveData<T>.observe2(
+        ui: VB,
+        crossinline callback: VB.(T) -> Unit
+    ) {
+        observe(viewLifecycleOwner) { callback.invoke(ui, it) }
+    }
+}

app/src/main/java/eu/darken/capod/main/ui/overview/cards/pods/DualPodsCardVH.kt

@@ -31,8 +31,8 @@ class DualPodsCardVH(parent: ViewGroup) :
             }
             text = sb
 
-            if (item.isMainPod) setTypeface(typeface, Typeface.BOLD)
-            else setTypeface(typeface, Typeface.NORMAL)
+            if (item.isMainPod) setTypeface(null, Typeface.BOLD)
+            else setTypeface(null, Typeface.NORMAL)
 
             if (device is DualAirPods && item.showDebug) {
                 append(" [${device.primaryPod.name}]")

app/src/main/java/eu/darken/capod/main/ui/overview/cards/pods/SinglePodsCardVH.kt

@@ -23,8 +23,8 @@ class SinglePodsCardVH(parent: ViewGroup) :
 
         name.apply {
             text = device.getLabel(context)
-            if (item.isMainPod) setTypeface(typeface, Typeface.BOLD)
-            else setTypeface(typeface, Typeface.NORMAL)
+            if (item.isMainPod) setTypeface(null, Typeface.BOLD)
+            else setTypeface(null, Typeface.NORMAL)
         }
 
         deviceIcon.setImageResource(device.iconRes)

app/src/main/java/eu/darken/capod/main/ui/overview/cards/pods/UnknownPodDeviceCardVH.kt

@@ -24,8 +24,8 @@ class UnknownPodDeviceCardVH(parent: ViewGroup) :
         val device = item.device
         name.apply {
             text = device.getLabel(context)
-            if (item.isMainPod) setTypeface(typeface, Typeface.BOLD)
-            else setTypeface(typeface, Typeface.NORMAL)
+            if (item.isMainPod) setTypeface(null, Typeface.BOLD)
+            else setTypeface(null, Typeface.NORMAL)
         }
 
         lastSeen.text = device.lastSeenFormatted(item.now)

app/src/main/java/eu/darken/capod/main/ui/settings/general/GeneralSettingsFragment.kt

@@ -10,7 +10,7 @@ import dagger.hilt.android.AndroidEntryPoint
 import eu.darken.capod.R
 import eu.darken.capod.common.bluetooth.ScannerMode
 import eu.darken.capod.common.preferences.PercentSliderPreference
-import eu.darken.capod.common.uix.PreferenceFragment2
+import eu.darken.capod.common.uix.PreferenceFragment3
 import eu.darken.capod.common.upgrade.UpgradeRepo
 import eu.darken.capod.main.core.GeneralSettings
 import eu.darken.capod.main.core.MonitorMode
@@ -19,9 +19,9 @@ import javax.inject.Inject
 
 @Keep
 @AndroidEntryPoint
-class GeneralSettingsFragment : PreferenceFragment2() {
+class GeneralSettingsFragment : PreferenceFragment3() {
 
-    private val vm: GeneralSettingsFragmentVM by viewModels()
+    override val vm: GeneralSettingsFragmentVM by viewModels()
 
     @Inject lateinit var generalSettings: GeneralSettings
     @Inject lateinit var upgradeRepo: UpgradeRepo

app/src/main/java/eu/darken/capod/main/ui/settings/general/GeneralSettingsFragmentVM.kt

@@ -6,7 +6,7 @@ import eu.darken.capod.common.bluetooth.BluetoothManager2
 import eu.darken.capod.common.coroutine.DispatcherProvider
 import eu.darken.capod.common.debug.logging.logTag
 import eu.darken.capod.common.uix.ViewModel3
-import kotlinx.coroutines.flow.flow
+import kotlinx.coroutines.flow.map
 import javax.inject.Inject
 
 @HiltViewModel
@@ -16,9 +16,9 @@ class GeneralSettingsFragmentVM @Inject constructor(
     private val bluetoothManager: BluetoothManager2,
 ) : ViewModel3(dispatcherProvider) {
 
-    val bondedDevices = flow {
-        emit(bluetoothManager.bondedDevices().toList())
-    }.asLiveData2()
+    val bondedDevices = bluetoothManager.bondedDevices()
+        .map { it.toList() }
+        .asLiveData2()
 
     companion object {
         private val TAG = logTag("Settings", "General", "VM")

app/src/main/java/eu/darken/capod/main/ui/settings/general/debug/DebugSettingsFragment.kt

@@ -9,14 +9,14 @@ import dagger.hilt.android.AndroidEntryPoint
 import eu.darken.capod.R
 import eu.darken.capod.common.debug.autoreport.DebugSettings
 import eu.darken.capod.common.observe2
-import eu.darken.capod.common.uix.PreferenceFragment2
+import eu.darken.capod.common.uix.PreferenceFragment3
 import javax.inject.Inject
 
 @Keep
 @AndroidEntryPoint
-class DebugSettingsFragment : PreferenceFragment2() {
+class DebugSettingsFragment : PreferenceFragment3() {
 
-    private val vm: DebugSettingsFragmentVM by viewModels()
+    override val vm: DebugSettingsFragmentVM by viewModels()
 
     @Inject lateinit var debugSettings: DebugSettings
 

app/src/main/java/eu/darken/capod/main/ui/settings/support/SupportFragment.kt

@@ -10,15 +10,15 @@ import dagger.hilt.android.AndroidEntryPoint
 import eu.darken.capod.R
 import eu.darken.capod.common.ClipboardHelper
 import eu.darken.capod.common.observe2
-import eu.darken.capod.common.uix.PreferenceFragment2
+import eu.darken.capod.common.uix.PreferenceFragment3
 import eu.darken.capod.main.core.GeneralSettings
 import javax.inject.Inject
 
 @Keep
 @AndroidEntryPoint
-class SupportFragment : PreferenceFragment2() {
+class SupportFragment : PreferenceFragment3() {
 
-    private val vm: SupportFragmentVM by viewModels()
+    override val vm: SupportFragmentVM by viewModels()
 
     override val preferenceFile: Int = R.xml.preferences_support
     @Inject lateinit var generalSettings: GeneralSettings

app/src/main/java/eu/darken/capod/reaction/ui/ReactionSettingsFragment.kt

@@ -1,5 +1,6 @@
 package eu.darken.capod.reaction.ui
 
+import android.bluetooth.BluetoothDevice
 import android.os.Bundle
 import android.view.View
 import androidx.annotation.Keep
@@ -10,7 +11,7 @@ import androidx.preference.ListPreference
 import androidx.preference.Preference
 import dagger.hilt.android.AndroidEntryPoint
 import eu.darken.capod.R
-import eu.darken.capod.common.uix.PreferenceFragment2
+import eu.darken.capod.common.uix.PreferenceFragment3
 import eu.darken.capod.common.upgrade.UpgradeRepo
 import eu.darken.capod.main.core.GeneralSettings
 import eu.darken.capod.main.core.MonitorMode
@@ -21,9 +22,9 @@ import javax.inject.Inject
 
 @Keep
 @AndroidEntryPoint
-class ReactionSettingsFragment : PreferenceFragment2() {
+class ReactionSettingsFragment : PreferenceFragment3() {
 
-    private val vm: ReactionSettingsFragmentVM by viewModels()
+    override val vm: ReactionSettingsFragmentVM by viewModels()
 
     @Inject lateinit var generalSettings: GeneralSettings
     @Inject lateinit var reactionSettings: ReactionSettings
@@ -35,6 +36,7 @@ class ReactionSettingsFragment : PreferenceFragment2() {
     override val preferenceFile: Int = R.xml.preferences_reactions
 
     private var isPro: Boolean = false
+    private var bondedDevices: List<BluetoothDevice> = emptyList()
     private val autoConnectConditionPref by lazy { findPreference<ListPreference>(settings.autoConnectCondition.key)!! }
 
     override fun onPreferencesCreated() {
@@ -66,10 +68,9 @@ class ReactionSettingsFragment : PreferenceFragment2() {
                 preference.isChecked = false
                 return true
             } else if (generalSettings.mainDeviceAddress.value == null) {
-                val devices = vm.bondedDevices
                 DeviceSelectionDialogFactory(requireContext()).create(
-                    devices = devices,
-                    current = devices.firstOrNull { it.address == generalSettings.mainDeviceAddress.value }
+                    devices = bondedDevices,
+                    current = bondedDevices.firstOrNull { it.address == generalSettings.mainDeviceAddress.value }
                 ) { selected ->
                     generalSettings.mainDeviceAddress.value = selected?.address
                     if (selected != null) preference.isChecked = true
@@ -87,14 +88,21 @@ class ReactionSettingsFragment : PreferenceFragment2() {
         return super.onPreferenceTreeClick(preference)
     }
 
+    // Some UI interactions shortly turn autoConnect on, then off again
+    private val previousMonitorMode by lazy { generalSettings.monitorMode.value }
+
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        settings.autoConnect.flow.asLiveData().observe2 {
-            generalSettings.monitorMode.value = MonitorMode.ALWAYS
-            autoConnectConditionPref.isEnabled = it
+        settings.autoConnect.flow.asLiveData().observe2 { isEnabled ->
+            if (isEnabled) generalSettings.monitorMode.value = MonitorMode.ALWAYS
+            else generalSettings.monitorMode.value = previousMonitorMode
+
+            autoConnectConditionPref.isEnabled = isEnabled
         }
 
         vm.isPro.observe2 { isPro = it }
 
+        vm.bondedDevices.observe2 { bondedDevices = it }
+
         super.onViewCreated(view, savedInstanceState)
     }
 

app/src/main/java/eu/darken/capod/reaction/ui/ReactionSettingsFragmentVM.kt

@@ -18,10 +18,12 @@ class ReactionSettingsFragmentVM @Inject constructor(
     private val upgradeRepo: UpgradeRepo,
 ) : ViewModel3(dispatcherProvider) {
 
-    val bondedDevices = bluetoothManager.bondedDevices().toList()
-
     val isPro = upgradeRepo.upgradeInfo.map { it.isPro }.asLiveData2()
 
+    val bondedDevices = bluetoothManager.bondedDevices()
+        .map { it.toList() }
+        .asLiveData2()
+
     companion object {
         private val TAG = logTag("Settings", "Reaction", "VM")
     }

app/src/main/res/values-fr/strings.xml

@@ -53,6 +53,7 @@
     <string name="settings_support_description">Si vous avez besoin d’aide.</string>
     <string name="issue_tracker_label">Gestionnaire de problèmes</string>
     <string name="issue_tracker_description">Un gestionnaire public de problèmes pour les signalements de bogues et les demandes de fonction (anglais seulement).</string>
+    <string name="discord_label">Discord</string>
     <string name="discord_description">Un endroit à fréquenter où poser des questions.</string>
     <string name="changelog_label">Journal des changements</string>
     <string name="settings_label">Paramètres</string>

app/src/main/res/values-ja/strings.xml

@@ -58,7 +58,7 @@
     <string name="changelog_label">更新の内容</string>
     <string name="settings_label">設定</string>
     <string name="settings_privacy_policy_label">個人情報の取り扱いについて</string>
-    <string name="settings_privacy_policy_desc">責任を持ってデータを取り扱います。</string>
+    <string name="settings_privacy_policy_desc">責任を持ってデータを取り扱います</string>
     <string name="settings_licenses_label">ライセンス情報</string>
     <string name="settings_category_other_label">その他</string>
     <string name="settings_general_label">全般</string>

buildSrc/src/main/java/ProjectConfig.kt

@@ -14,13 +14,16 @@ object ProjectConfig {
     const val targetSdk = 33
 
     object Version {
-        const val major = 2
-        const val minor = 2
-        const val patch = 0
-        const val build = 0
+        val versionProperties = Properties().apply {
+            load(FileInputStream(File("version.properties")))
+        }
+        val major = versionProperties.getProperty("project.versioning.major").toInt()
+        val minor = versionProperties.getProperty("project.versioning.minor").toInt()
+        val patch = versionProperties.getProperty("project.versioning.patch").toInt()
+        val build = versionProperties.getProperty("project.versioning.build").toInt()
 
-        const val name = "${major}.${minor}.${patch}-rc${build}"
-        const val code = major * 10000000 + minor * 100000 + patch * 1000 + build * 10
+        val name = "${major}.${minor}.${patch}-rc${build}"
+        val code = major * 10000000 + minor * 100000 + patch * 1000 + build * 10
     }
 }
 

fastlane/metadata/android/es-AR/full_description.txt

@@ -1,18 +1,18 @@
-CAPod is a companion app for AirPods.
+CAPod es una aplicación complementaria para AirPods.
 
-Features:
+Funciones:
 
-* Battery level for pods and cases.
-* Charging status for pods and case.
-* Additional infos about connection, microphone and case.
-* Can receive and show all nearby devices.
-* Ear detection with automatic play/pause.
-* Automatically connect phone and AirPods.
-* Show popup when case is opened.
+* Nivel de batería para los auriculares y estuches.
+* Indicador de carga de auriculares y estuche.
+* Información adicional de conexión, micrófono y estuche.
+* Puede recibir y mostrar todos los dispositivos cercanos.
+* Detección de oído con reproducción/pausa automática.
+* Conecta automáticamente el teléfono y los AirPods.
+* Muestra un aviso emergente de estuche abierto.
 
-CAPod is ad-free. Some features require an in-app purchase.
+CAPod es libre de publicidad. Algunas funciones requieren compras en la aplicación.
 
-Most popular AirPods and Beats devices are supported.
-If your device is similar to AirPods but not yet supported, send me a short mail.
+Válido para la mayoría de AirPods populares y Beats.
+Si su dispositivo es similar a AirPods pero aún no es compatible, envíeme un correo.
 
-Got a cool idea for a new feature? Reach out!
+¿Tienes una buena idea para una nueva característica? ¡Háznoslo saber!

fastlane/metadata/android/es-AR/short_description.txt

@@ -1 +1 @@
-CAPod is a companion app for AirPods on Android.
+CAPod es una aplicación complementaria para AirPods en Android.

fastlane/metadata/android/es-AR/title.txt

@@ -1 +1 @@
-CAPod - Companion for AirPods
+CAPod - Asistente para AirPods

release.sh

@@ -0,0 +1,458 @@
+#!/bin/bash
+# Based on
+# * https://gist.github.com/jv-k/703e79306554c26a65a7cfdb9ca119c6
+# * https://github.com/jv-k/ver-bump
+
+# █▄▄ █░█ █▀▄▀█ █▀█ ▄▄ █░█ █▀▀ █▀█ █▀ █ █▀█ █▄░█
+# █▄█ █▄█ █░▀░█ █▀▀ ░░ ▀▄▀ ██▄ █▀▄ ▄█ █ █▄█ █░▀█
+#
+#
+# Description:
+#   - This script automates bumping the git software project's version using automation.
+
+#   - It does several things that are typically required for releasing a Git repository, like git tagging,
+#     automatic updating of CHANGELOG.md, and incrementing the version number in various JSON files.
+
+#     - Increments / suggests the current software project's version number
+#     - Adds a Git tag, named after the chosen version number
+#     - Updates CHANGELOG.md
+#     - Updates VERSION file
+#     - Commits files to a new branch
+#     - Pushes to remote (optionally)
+#     - Updates "version" : "x.x.x" tag in JSON files if [-v file1 -v file2...] argument is supplied.
+#
+# Usage:
+#   ./bump-version.sh [-v <version number>] [-m <release message>] [-j <file1>] [-j <file2>].. [-n] [-p] [-b] [-h]
+#
+# Options:
+#   -v <version number>	  Specify a manual version number
+#   -m <release message>	Custom release message.
+#   -f <filename.json>	  Update version number inside JSON files.
+# 			                  * For multiple files, add a separate -f option for each one,
+#	  		                  * For example: ./bump-version.sh -f src/plugin/package.json -f composer.json
+#   -p <repository alias> Push commits to remote repository, eg `-p origin`
+#   -n 	                  Don't perform a commit automatically.
+#	  		                  * You may want to do that yourself, for example.
+#   -b                    Don't create automatic `release-<version>` branch
+#   -h 	                  Show help message.
+
+#
+# Detailed notes:
+#   – The contents of the `VERSION` file which should be a semantic version number such as "1.2.3"
+#     or even "1.2.3-beta+001.ab"
+#
+#   – It pulls a list of changes from git history & prepends to a file called CHANGELOG.md
+#     under the title of the new version # number, allows the user to review and update the changelist
+#
+#   – Creates a Git tag with the version number
+#
+#   - Creates automatic `release-<version>` branch
+#
+#   – Commits the new version to the current repository
+#
+#   – Optionally pushes the commit to remote repository
+#
+#   – Make sure to set execute permissions for the script, eg `$ chmod 755 bump-version.sh`
+#
+# Credits:
+#   – https://github.com/jv-k/bump-version
+#
+#   - Inspired by the scripts from @pete-otaqui and @mareksuscak
+#     https://gist.github.com/pete-otaqui/4188238
+#     https://gist.github.com/mareksuscak/1f206fbc3bb9d97dec9c
+#
+
+NOW="$(date +'%B %d, %Y')"
+
+# ANSI/VT100 colours
+YELLOW='\033[1;33m'
+LIGHTYELLOW='\033[0;33m'
+RED='\033[0;31m'
+LIGHTRED='\033[1;31m'
+GREEN='\033[0;32m'
+LIGHTGREEN='\033[1;32m'
+BLUE='\033[0;34m'
+LIGHTBLUE='\033[1;34m'
+PURPLE='\033[0;35m'
+LIGHTPURPLE='\033[1;35m'
+CYAN='\033[0;36m'
+LIGHTCYAN='\033[1;36m'
+WHITE='\033[1;37m'
+LIGHTGRAY='\033[0;37m'
+DARKGRAY='\033[1;30m'
+BOLD="\033[1m"
+INVERT="\033[7m"
+RESET='\033[0m'
+
+# Default options
+FLAG_JSON="false"
+FLAG_PUSH="false"
+
+I_OK="✅"
+I_STOP="🚫"
+I_ERROR="❌"
+I_END="👋🏻"
+
+S_NORM="${WHITE}"
+S_LIGHT="${LIGHTGRAY}"
+S_NOTICE="${GREEN}"
+S_QUESTION="${YELLOW}"
+S_WARN="${LIGHTRED}"
+S_ERROR="${RED}"
+
+V_SUGGEST="0.1.2-rc5" # This is suggested in case VERSION file or user supplied version via -v is missing
+
+V_MAJOR=""         # 0
+V_MINOR=""         # 1
+V_PATCH=""         # 2
+V_BUILD_TYPE=""    # rc
+V_BUILD_COUNTER="" # 5
+V_NAME=""
+V_CODE=""
+
+SCRIPT_VER="1.0"
+
+GIT_MSG="Release: "
+REL_NOTE=""
+REL_PREFIX="release/"
+PUSH_DEST="origin"
+
+# Show credits & help
+usage() {
+  echo -e "$GREEN" \
+    "\n █▄▄ █░█ █▀▄▀█ █▀█ ▄▄ █░█ █▀▀ █▀█ █▀ █ █▀█ █▄░█  " \
+    "\n █▄█ █▄█ █░▀░█ █▀▀ ░░ ▀▄▀ ██▄ █▀▄ ▄█ █ █▄█ █░▀█  " \
+    "\n\t\t\t\t\t$LIGHTGRAY v${SCRIPT_VER}"
+
+  echo -e " ${S_NORM}${BOLD}Usage:${RESET}" \
+    "\n $0 [-v <version number>] [-m <release message>] [-n] [-p] [-h]" 1>&2
+
+  echo -e "\n ${S_NORM}${BOLD}Options:${RESET}"
+  echo -e " $S_WARN-v$S_NORM <version number>\tSpecify a manual version number"
+  echo -e " $S_WARN-m$S_NORM <release message>\tCustom release message."
+  echo -e " $S_WARN-p$S_NORM \t\t\tPush commits to ORIGIN. "
+  echo -e " $S_WARN-n$S_NORM \t\t\tDon't perform a commit automatically. " \
+    "\n\t\t\t* You may want to do that manually after checking everything, for example."
+  echo -e " $S_WARN-b$S_NORM \t\t\tDon't create automatic \`release-<version>\` branch"
+  echo -e " $S_WARN-h$S_NORM \t\t\tShow this help message. "
+  echo -e "\n ${S_NORM}${BOLD}Original author: $S_LIGHT https://github.com/jv-t/bump-version $RESET"
+  echo -e "\n ${S_NORM}${BOLD}Changes by: $S_LIGHT https://github.com/d4rken $RESET\n"
+}
+
+# If there are no commits in repo, quit, because you can't tag with zero commits.
+check-commits-exist() {
+  git rev-parse HEAD &>/dev/null
+  if [ ! "$?" -eq 0 ]; then
+    echo -e "\n${I_STOP} ${S_ERROR}Your current branch doesn't have any commits yet. Can't tag without at least one commit." >&2
+    echo
+    exit 1
+  fi
+}
+
+exit_abnormal() {
+  echo -e " ${S_LIGHT}––––––"
+  usage # Show help
+  exit 1
+}
+
+# Process script options
+process-arguments() {
+  local OPTIONS OPTIND OPTARG
+
+  # Get positional parameters
+  JSON_FILES=()
+  while getopts ":v:p:m:hbn" OPTIONS; do # Note: Adding the first : before the flags takes control of flags and prevents default error msgs.
+    case "$OPTIONS" in
+    h)
+      # Show help
+      exit_abnormal
+      ;;
+    v)
+      # User has supplied a version number
+      V_USR_SUPPLIED=$OPTARG
+      ;;
+    m)
+      REL_NOTE=$OPTARG
+      # Custom release note
+      echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Release note:" ${S_NORM}"'"$REL_NOTE"'"
+      ;;
+    p)
+      FLAG_PUSH=true
+      PUSH_DEST=${OPTARG} # Replace default with user input
+      echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Pushing to <${S_NORM}${PUSH_DEST}${S_LIGHT}>, as the last action in this script."
+      ;;
+    n)
+      FLAG_NOCOMMIT=true
+      echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Disable commit after tagging."
+      ;;
+    b)
+      FLAG_NOBRANCH=true
+      echo -e "\n${S_LIGHT}Option set: ${S_NOTICE}Disable committing to new branch."
+      ;;
+    \?)
+      echo -e "\n${I_ERROR}${S_ERROR} Invalid option: ${S_WARN}-$OPTARG" >&2
+      echo
+      exit_abnormal
+      ;;
+    :)
+      echo -e "\n${I_ERROR}${S_ERROR} Option ${S_WARN}-$OPTARG ${S_ERROR}requires an argument." >&2
+      echo
+      exit_abnormal
+      ;;
+    esac
+  done
+}
+
+# Suggests version from VERSION file, or grabs from user supplied -v <version>.
+# If none is set, suggest default from options.
+process-version() {
+  V_RAW=""
+
+  V_FILE_REGEX='^([0-9]+\.[0-9]+\.[0-9]+-[a-zA-Z]+[0-9]+) ([0-9]+)$'
+  V_FILE_RAW="$(cat VERSION)"
+  if [ -f VERSION ] && [ -s VERSION ] && [[ $V_FILE_RAW =~ $V_FILE_REGEX ]]; then
+    V_PREV="${BASH_REMATCH[1]}"
+    V_SUGGEST=$V_PREV
+    echo -e "\n${S_NOTICE}Current version from <${S_NORM}VERSION${S_NOTICE}> file: ${S_NORM}$V_PREV"
+  else
+    echo -ne "\n${S_WARN}The [${S_NORM}VERSION${S_WARN}] "
+    if [ ! -f VERSION ]; then
+      echo "VERSION file was not found."
+    elif [ ! -s VERSION ]; then
+      echo "VERSION file is empty."
+    else
+      echo "could not be parsed."
+    fi
+  fi
+
+  # If a version number is supplied by the user with [-v <version number>], then use it
+  if [ -n "$V_USR_SUPPLIED" ]; then
+    echo -e "\n${S_NOTICE}You selected version using [-v]:" "${S_WARN}${V_USR_SUPPLIED}"
+    V_RAW="${V_USR_SUPPLIED}"
+  else
+    echo -ne "\n${S_QUESTION}Enter a new version number [${S_NORM}$V_SUGGEST${S_QUESTION}]: "
+    echo -ne "$S_WARN"
+    read -r V_RAW
+  fi
+
+  if [ -z "$V_RAW" ]; then
+    V_RAW=$V_PREV
+  fi
+
+  if [ -z "$V_RAW" ]; then
+    echo -e "\n${I_STOP} ${S_ERROR}Error: No version was supplied (no file, no CLI)\n"
+    exit_abnormal
+  fi
+
+  SEMVER_REGEX='^([0-9]+)\.([0-9]+)\.([0-9]+)-([a-zA-Z]+)([0-9]+)$'
+
+  echo -e "\n${S_NOTICE}Parsing ${V_RAW}"
+
+  if [[ $V_RAW =~ $SEMVER_REGEX ]]; then
+    echo -e "\n${I_OK} ${S_NOTICE} Successfully parsed ${V_RAW} to ${BASH_REMATCH[0]}"
+    V_MAJOR="${BASH_REMATCH[1]}"
+    echo "V_MAJOR=$V_MAJOR"
+    V_MINOR="${BASH_REMATCH[2]}"
+    echo "V_MINOR=$V_MINOR"
+    V_PATCH="${BASH_REMATCH[3]}"
+    echo "V_PATCH=$V_PATCH"
+    V_BUILD_TYPE="${BASH_REMATCH[4]}"
+    echo "V_BUILD_TYPE=$V_BUILD_TYPE"
+    V_BUILD_COUNTER="${BASH_REMATCH[5]}"
+    echo "V_BUILD_COUNTER=$V_BUILD_COUNTER"
+  else
+    echo -e "\n${I_STOP} ${S_ERROR}Error: Failed to parse $V_RAW\n"
+    exit_abnormal
+  fi
+
+  # If no version was provided, bump the previous version
+  if [ -z "$V_USR_SUPPLIED" ]; then
+    if [ "$V_BUILD_COUNTER" -eq "$V_BUILD_COUNTER" ] 2>/dev/null; then # discard stderr (2) output to black hole (suppress it)
+      V_BUILD_COUNTER=$((V_BUILD_COUNTER + 1))                         # Increment
+    fi
+  fi
+
+  V_NAME="$V_MAJOR.$V_MINOR.$V_PATCH-$V_BUILD_TYPE$V_BUILD_COUNTER"
+  V_CODE=$((V_MAJOR * 10000000 + V_MINOR * 100000 + V_PATCH * 1000 + V_BUILD_COUNTER * 10))
+  echo -e "${S_NOTICE}Setting version to [${S_NORM}${V_NAME} (${V_CODE})${S_NOTICE}] ...."
+}
+
+# Only tag if tag doesn't already exist
+check-tag-exists() {
+  TAG_CHECK_EXISTS=$(git tag -l v"$V_NAME")
+  if [ -n "$TAG_CHECK_EXISTS" ]; then
+    echo -e "\n${I_STOP} ${S_ERROR}Error: A release with that tag version number already exists!\n"
+    exit 0
+  fi
+}
+
+# $1 : version
+# $2 : release note
+create-tag() {
+  if [ -z "$2" ]; then
+    # Default release note
+    git tag -a "v$1" -m "Tag version $1."
+  else
+    # Custom release note
+    git tag -a "v$1" -m "$2"
+  fi
+  echo -e "\n${I_OK} ${S_NOTICE}Added GIT tag"
+}
+
+# Update version.properties which is used by Gradle to generate the `versionName` and `versionCode`
+do-version-properties() {
+  PROPS_FILE_NAME="version.properties"
+  echo -e "\n${S_NOTICE}Parsing ${PROPS_FILE_NAME}:\n"
+
+  V_MAJOR_REGEX='^([a-zA-Z\.]+major)=([0-9]+)$'
+  V_MINOR_REGEX='^([a-zA-Z\.]+minor)=([0-9]+)$'
+  V_PATCH_REGEX='^([a-zA-Z\.]+patch)=([0-9]+)$'
+  V_BUILD_REGEX='^([a-zA-Z\.]+build)=([0-9]+)$'
+
+  PROPS_FILE_NEW=""
+
+  LAST_LINE=$(wc -l <$PROPS_FILE_NAME)
+  CURRENT_LINE=0
+
+  while read -r line; do
+    CURRENT_LINE=$((CURRENT_LINE + 1))
+
+    if [[ $line =~ $V_MAJOR_REGEX ]]; then
+      updated="${BASH_REMATCH[1]}=${V_MAJOR}"
+      echo "Found major, replacing: $line -> $updated"
+      PROPS_FILE_NEW+=$updated
+    elif [[ $line =~ $V_MINOR_REGEX ]]; then
+      updated="${BASH_REMATCH[1]}=${V_MINOR}"
+      echo "Found minor, replacing: $line -> $updated"
+      PROPS_FILE_NEW+=$updated
+    elif [[ $line =~ $V_PATCH_REGEX ]]; then
+      updated="${BASH_REMATCH[1]}=${V_PATCH}"
+      echo "Found patch, replacing: $line -> $updated"
+      PROPS_FILE_NEW+=$updated
+    elif [[ $line =~ $V_BUILD_REGEX ]]; then
+      updated="${BASH_REMATCH[1]}=${V_BUILD_COUNTER}"
+      echo "Found build, replacing: $line -> $updated"
+      PROPS_FILE_NEW+=$updated
+    else
+      PROPS_FILE_NEW+="$line"
+    fi
+
+    if [[ $CURRENT_LINE -ne $LAST_LINE ]]; then
+      PROPS_FILE_NEW+="\n"
+    fi
+
+  done <"$PROPS_FILE_NAME"
+
+  echo -e "$PROPS_FILE_NEW" >"$PROPS_FILE_NAME"
+  git add "$PROPS_FILE_NAME"
+
+  echo -e "\n${I_OK} ${S_NOTICE}Updated [${S_NORM}${PROPS_FILE_NAME}${S_NOTICE}] file"
+}
+
+# Update a version file that can be parsed by third-parties, e.g. F-Droid
+do-versionfile() {
+  [ -f VERSION ] && ACTION_MSG="Updated" || ACTION_MSG="Created"
+
+  echo "${V_NAME} ${V_CODE}" >VERSION # Create file
+  echo -e "\n${I_OK} ${S_NOTICE}${ACTION_MSG} [${S_NORM}VERSION${S_NOTICE}] file"
+
+  # Stage file for commit
+  git add VERSION
+}
+
+# Does the release branch already exist?
+check-branch-exist() {
+  [ "$FLAG_NOBRANCH" = true ] && return
+
+  BRANCH_MSG=$(git rev-parse --verify "${REL_PREFIX}${V_NAME}" 2>&1)
+  if [ "$?" -eq 0 ]; then
+    echo -e "\n${I_STOP} ${S_ERROR}Error: Branch <${S_NORM}${REL_PREFIX}${V_NAME}${S_ERROR}> already exists!\n"
+    exit 1
+  fi
+}
+
+# Create release branch if desired
+do-branch() {
+  [ "$FLAG_NOBRANCH" = true ] && return
+
+  echo -e "\n${S_NOTICE}Creating new release branch..."
+
+  BRANCH_MSG=$(git branch "${REL_PREFIX}${V_NAME}" 2>&1)
+  if [ ! "$?" -eq 0 ]; then
+    echo -e "\n${I_STOP} ${S_ERROR}Error\n$BRANCH_MSG\n"
+    exit 1
+  else
+    BRANCH_MSG=$(git checkout "${REL_PREFIX}${V_NAME}" 2>&1)
+    echo -e "\n${I_OK} ${S_NOTICE}${BRANCH_MSG}"
+  fi
+}
+
+# Stage & commit all files modified by this script
+do-commit() {
+  [ "$FLAG_NOCOMMIT" = true ] && return
+
+  echo -e "\n${S_NOTICE}Committing..."
+  COMMIT_MSG=$(git commit -m "${GIT_MSG}" 2>&1)
+  if [ ! "$?" -eq 0 ]; then
+    echo -e "\n${I_STOP} ${S_ERROR}Error\n$COMMIT_MSG\n"
+    exit 1
+  else
+    echo -e "\n${I_OK} ${S_NOTICE}$COMMIT_MSG"
+  fi
+}
+
+# Pushes files + tags to remote repo. Changes are staged by earlier functions
+do-push() {
+  [ "$FLAG_NOCOMMIT" = true ] && return
+
+  if [ "$FLAG_PUSH" = true ]; then
+    CONFIRM="Y"
+  else
+    echo -ne "\n${S_QUESTION}Push tags to <${S_NORM}${PUSH_DEST}${S_QUESTION}>? [${S_NORM}N/y${S_QUESTION}]: "
+    read CONFIRM
+  fi
+
+  case "$CONFIRM" in
+  [yY][eE][sS] | [yY])
+    echo -e "\n${S_NOTICE}Pushing files + tags to <${S_NORM}${PUSH_DEST}${S_NOTICE}>..."
+
+    PUSH_MSG=$(git push "${PUSH_DEST}" v"$V_NAME" 2>&1) # Push new tag
+    PUSH_MSG+="\n"
+    PUSH_MSG+=$(git push 2>&1) # Push new tag
+
+    if [ ! "$?" -eq 0 ]; then
+      echo -e "\n${I_STOP} ${S_WARN}Warning\n$PUSH_MSG"
+      # exit 1
+    else
+      echo -e "\n${I_OK} ${S_NOTICE}$PUSH_MSG"
+    fi
+    ;;
+  esac
+}
+
+#### Initiate Script ###########################
+
+check-commits-exist
+
+# Process and prepare
+process-arguments "$@"
+process-version
+
+GIT_MSG+="${V_NAME}"
+
+check-branch-exist
+check-tag-exists
+
+echo -e "\n${S_LIGHT}––––––"
+
+# Update steps
+do-version-properties
+do-versionfile
+do-branch
+do-commit
+create-tag "${V_NAME}" "${REL_NOTE}"
+do-push
+
+echo -e "\n${S_LIGHT}––––––"
+echo -e "\n${I_OK} ${S_NOTICE}"Bumped $([ -n "${V_PREV}" ] && echo "${V_PREV} –>" || echo "to ") "$V_NAME"
+echo -e "\n${GREEN}Done ${I_END}\n"

version.properties

@@ -0,0 +1,6 @@
+### Updated by release.sh ###
+project.versioning.major=2
+project.versioning.minor=2
+project.versioning.patch=1
+project.versioning.build=1
+#############################