AboutActivity to Jetpack Compose (#2489)

* WIP

* test: Add test tags for compose components

* test: Add basic test for compose about screen

* refactor: Add defaults for `AboutScreenContent`

* refactor: Move compose tests to unit tests

* refactor: Make `showRateOnGooglePlay` default to `app/build.gradle.kts/defaultConfig` value

* refactor: Best practise to make previews private to reduce pollution

* refactor: Best practise apply theme as high as possible for most cases

* style: Format AboutActivity.kt

* test: Add more comprehensive tests for about screen

* test: Fix configuration of compose tests

* Fix Gradle setup

* Fix build issues

* Adjust text sizing

* Use full black OLED theme in Compose if chosen in settings

---------

Co-authored-by: LooKeR <iamlooker@proton.me>

app/src/main/java/protect/card_locker/AboutActivity.kt

@@ -1,149 +1,167 @@
 package protect.card_locker
 
 import android.os.Bundle
-import android.text.Spanned
-import android.view.MenuItem
-import android.view.View
-import android.widget.ScrollView
-import android.widget.TextView
+import androidx.activity.ComponentActivity
+import androidx.activity.OnBackPressedDispatcher
+import androidx.activity.compose.setContent
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.verticalScroll
+import androidx.compose.material3.ExperimentalMaterial3Api
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Scaffold
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.platform.testTag
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.text.AnnotatedString
+import androidx.compose.ui.text.SpanStyle
+import androidx.compose.ui.text.TextLinkStyles
+import androidx.compose.ui.text.fromHtml
+import androidx.compose.ui.text.style.TextDecoration
+import androidx.compose.ui.tooling.preview.Preview
+import protect.card_locker.compose.CatimaAboutSection
+import protect.card_locker.compose.CatimaTopAppBar
+import protect.card_locker.compose.theme.CatimaTheme
 
-import androidx.annotation.StringRes
-import androidx.core.view.isVisible
-
-import com.google.android.material.dialog.MaterialAlertDialogBuilder
-
-import protect.card_locker.databinding.AboutActivityBinding
-
-class AboutActivity : CatimaAppCompatActivity() {
-    private companion object {
-        private const val TAG = "Catima"
-    }
-
-    private lateinit var binding: AboutActivityBinding
+class AboutActivity : ComponentActivity() {
     private lateinit var content: AboutContent
 
+    @OptIn(ExperimentalMaterial3Api::class)
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
-        binding = AboutActivityBinding.inflate(layoutInflater)
         content = AboutContent(this)
         title = content.pageTitle
-        setContentView(binding.root)
-        setSupportActionBar(binding.toolbar)
-        enableToolbarBackButton()
 
-        binding.apply {
-            creditsSub.text = content.copyrightShort
-            versionHistorySub.text = content.versionHistory
-
-            versionHistory.tag = "https://catima.app/changelog/"
-            translate.tag = "https://hosted.weblate.org/engage/catima/"
-            license.tag = "https://github.com/CatimaLoyalty/Android/blob/main/LICENSE"
-            repo.tag = "https://github.com/CatimaLoyalty/Android/"
-            privacy.tag = "https://catima.app/privacy-policy/"
-            reportError.tag = "https://github.com/CatimaLoyalty/Android/issues"
-            rate.tag = "https://play.google.com/store/apps/details?id=me.hackerchick.catima"
-            donate.tag = "https://catima.app/donate"
-
-            // Hide Google Play rate button if not on Google Play
-            rate.isVisible = BuildConfig.showRateOnGooglePlay
-            // Hide donate button on Google Play (Google Play doesn't allow donation links)
-            donate.isVisible = BuildConfig.showDonate
-        }
-
-        bindClickListeners()
-    }
-
-    override fun onOptionsItemSelected(item: MenuItem): Boolean {
-        return when (item.itemId) {
-            android.R.id.home -> {
-                finish()
-                true
+        setContent {
+            CatimaTheme {
+                AboutScreenContent(
+                    content = content,
+                    showDonate = BuildConfig.showDonate,
+                    showRateOnGooglePlay = BuildConfig.showRateOnGooglePlay,
+                    onBackPressedDispatcher = onBackPressedDispatcher
+                )
             }
-
-            else -> super.onOptionsItemSelected(item)
-        }
-    }
-
-    override fun onDestroy() {
-        super.onDestroy()
-        content.destroy()
-        clearClickListeners()
-    }
-
-    private fun bindClickListeners() {
-        binding.apply {
-            versionHistory.setOnClickListener { showHistory(it) }
-            translate.setOnClickListener { openExternalBrowser(it) }
-            license.setOnClickListener { showLicense(it) }
-            repo.setOnClickListener { openExternalBrowser(it) }
-            privacy.setOnClickListener { showPrivacy(it) }
-            reportError.setOnClickListener { openExternalBrowser(it) }
-            rate.setOnClickListener { openExternalBrowser(it) }
-            donate.setOnClickListener { openExternalBrowser(it) }
-            credits.setOnClickListener { showCredits() }
-        }
-    }
-
-    private fun clearClickListeners() {
-        binding.apply {
-            versionHistory.setOnClickListener(null)
-            translate.setOnClickListener(null)
-            license.setOnClickListener(null)
-            repo.setOnClickListener(null)
-            privacy.setOnClickListener(null)
-            reportError.setOnClickListener(null)
-            rate.setOnClickListener(null)
-            donate.setOnClickListener(null)
-            credits.setOnClickListener(null)
-        }
-    }
-
-    private fun showCredits() {
-        showHTML(R.string.credits, content.contributorInfo, null)
-    }
-
-    private fun showHistory(view: View) {
-        showHTML(R.string.version_history, content.historyInfo, view)
-    }
-
-    private fun showLicense(view: View) {
-        showHTML(R.string.license, content.licenseInfo, view)
-    }
-
-    private fun showPrivacy(view: View) {
-        showHTML(R.string.privacy_policy, content.privacyInfo, view)
-    }
-
-    private fun showHTML(@StringRes title: Int, text: Spanned, view: View?) {
-        val dialogContentPadding = resources.getDimensionPixelSize(R.dimen.alert_dialog_content_padding)
-        val textView = TextView(this).apply {
-            setText(text)
-            Utils.makeTextViewLinksClickable(this, text)
-        }
-
-        val scrollView = ScrollView(this).apply {
-            addView(textView)
-            setPadding(dialogContentPadding, dialogContentPadding / 2, dialogContentPadding, 0)
-        }
-
-        MaterialAlertDialogBuilder(this).apply {
-            setTitle(title)
-            setView(scrollView)
-            setPositiveButton(R.string.ok, null)
-
-            // Add View online button if an URL is linked to this view
-            view?.tag?.let {
-                setNeutralButton(R.string.view_online) { _, _ -> openExternalBrowser(view) }
-            }
-
-            show()
-        }
-    }
-
-    private fun openExternalBrowser(view: View) {
-        val tag = view.tag
-        if (tag is String && tag.startsWith("https://")) {
-            OpenWebLinkHandler().openBrowser(this, tag)
         }
     }
 }
+
+@Composable
+fun AboutScreenContent(
+    content: AboutContent,
+    showDonate: Boolean = true,
+    showRateOnGooglePlay: Boolean = false,
+    onBackPressedDispatcher: OnBackPressedDispatcher? = null,
+) {
+    Scaffold(
+        topBar = { CatimaTopAppBar(content.pageTitle.toString(), onBackPressedDispatcher) }
+    ) { innerPadding ->
+        Column(
+            modifier = Modifier
+                .padding(innerPadding)
+                .verticalScroll(rememberScrollState())
+        ) {
+            CatimaAboutSection(
+                stringResource(R.string.version_history),
+                content.versionHistory,
+                modifier = Modifier.testTag("card_version_history"),
+                onClickUrl = "https://catima.app/changelog/",
+                onClickDialogText = AnnotatedString.fromHtml(
+                    htmlString = content.historyHtml,
+                    linkStyles = TextLinkStyles(
+                        style = SpanStyle(
+                            textDecoration = TextDecoration.Underline,
+                            color = MaterialTheme.colorScheme.primary
+                        )
+                    )
+                )
+            )
+            CatimaAboutSection(
+                stringResource(R.string.credits),
+                content.copyrightShort,
+                modifier = Modifier.testTag("card_credits"),
+                onClickDialogText = AnnotatedString.fromHtml(
+                    htmlString = content.contributorInfoHtml,
+                    linkStyles = TextLinkStyles(
+                        style = SpanStyle(
+                            textDecoration = TextDecoration.Underline,
+                            color = MaterialTheme.colorScheme.primary
+                        )
+                    )
+                )
+            )
+            CatimaAboutSection(
+                stringResource(R.string.help_translate_this_app),
+                stringResource(R.string.translate_platform),
+                modifier = Modifier.testTag("card_translate"),
+                onClickUrl = "https://hosted.weblate.org/engage/catima/"
+            )
+            CatimaAboutSection(
+                stringResource(R.string.license),
+                stringResource(R.string.app_license),
+                modifier = Modifier.testTag("card_license"),
+                onClickUrl = "https://github.com/CatimaLoyalty/Android/blob/main/LICENSE",
+                onClickDialogText = AnnotatedString.fromHtml(
+                    htmlString = content.licenseHtml,
+                    linkStyles = TextLinkStyles(
+                        style = SpanStyle(
+                            textDecoration = TextDecoration.Underline,
+                            color = MaterialTheme.colorScheme.primary
+                        )
+                    )
+                )
+            )
+            CatimaAboutSection(
+                stringResource(R.string.source_repository),
+                stringResource(R.string.on_github),
+                modifier = Modifier.testTag("card_source_github"),
+                onClickUrl = "https://github.com/CatimaLoyalty/Android/"
+            )
+            CatimaAboutSection(
+                stringResource(R.string.privacy_policy),
+                stringResource(R.string.and_data_usage),
+                modifier = Modifier.testTag("card_privacy_policy"),
+                onClickUrl = "https://catima.app/privacy-policy/",
+                onClickDialogText = AnnotatedString.fromHtml(
+                    htmlString = content.privacyHtml,
+                    linkStyles = TextLinkStyles(
+                        style = SpanStyle(
+                            textDecoration = TextDecoration.Underline,
+                            color = MaterialTheme.colorScheme.primary
+                        )
+                    )
+                )
+            )
+            if (showDonate) {
+                CatimaAboutSection(
+                    stringResource(R.string.donate),
+                    "",
+                    modifier = Modifier.testTag("card_donate"),
+                    onClickUrl = "https://catima.app/donate"
+                )
+            }
+            if (showRateOnGooglePlay) {
+                CatimaAboutSection(
+                    stringResource(R.string.rate_this_app),
+                    stringResource(R.string.on_google_play),
+                    modifier = Modifier.testTag("card_rate_google"),
+                    onClickUrl = "https://play.google.com/store/apps/details?id=me.hackerchick.catima"
+                )
+            }
+            CatimaAboutSection(
+                stringResource(R.string.report_error),
+                stringResource(R.string.on_github),
+                modifier = Modifier.testTag("card_report_error"),
+                onClickUrl = "https://github.com/CatimaLoyalty/Android/issues"
+            )
+        }
+    }
+}
+
+@Preview
+@Composable
+private fun AboutActivityPreview() {
+    AboutScreenContent(AboutContent(LocalContext.current))
+}

app/src/main/java/protect/card_locker/AboutContent.java

@@ -3,11 +3,8 @@ package protect.card_locker;
 import android.content.Context;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
-import android.text.Spanned;
 import android.util.Log;
 
-import androidx.core.text.HtmlCompat;
-
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Calendar;
@@ -55,7 +52,7 @@ public class AboutContent {
         return context.getString(R.string.app_copyright_short);
     }
 
-    public String getContributors() {
+    public String getContributorsHtml() {
         String contributors;
         try {
             contributors = "<br/>" + Utils.readTextFile(context, R.raw.contributors);
@@ -65,7 +62,7 @@ public class AboutContent {
         return contributors.replace("\n", "<br />");
     }
 
-    public String getHistory() {
+    public String getHistoryHtml() {
         String versionHistory;
         try {
             versionHistory = Utils.readTextFile(context, R.raw.changelog)
@@ -77,7 +74,7 @@ public class AboutContent {
                 .replace("\n", "<br />");
     }
 
-    public String getLicense() {
+    public String getLicenseHtml() {
         try {
             return Utils.readTextFile(context, R.raw.license);
         }  catch (IOException ignored) {
@@ -85,7 +82,7 @@ public class AboutContent {
         }
     }
 
-    public String getPrivacy() {
+    public String getPrivacyHtml() {
         String privacyPolicy;
         try {
             privacyPolicy = Utils.readTextFile(context, R.raw.privacy)
@@ -97,7 +94,7 @@ public class AboutContent {
                 .replace("\n", "<br />");
     }
 
-    public String getThirdPartyLibraries() {
+    public String getThirdPartyLibrariesHtml() {
         final List<ThirdPartyInfo> usedLibraries = new ArrayList<>();
         usedLibraries.add(new ThirdPartyInfo("ACRA", "https://github.com/ACRA/acra", "Apache 2.0"));
         usedLibraries.add(new ThirdPartyInfo("Color Picker", "https://github.com/jaredrummler/ColorPicker", "Apache 2.0"));
@@ -116,7 +113,7 @@ public class AboutContent {
         return result.toString();
     }
 
-    public String getUsedThirdPartyAssets() {
+    public String getUsedThirdPartyAssetsHtml() {
         final List<ThirdPartyInfo> usedAssets = new ArrayList<>();
         usedAssets.add(new ThirdPartyInfo("Android icons", "https://fonts.google.com/icons?selected=Material+Icons", "Apache 2.0"));
 
@@ -129,31 +126,19 @@ public class AboutContent {
         return result.toString();
     }
 
-    public Spanned getContributorInfo() {
+    public String getContributorInfoHtml() {
         StringBuilder contributorInfo = new StringBuilder();
         contributorInfo.append(getCopyright());
         contributorInfo.append("<br/><br/>");
         contributorInfo.append(context.getString(R.string.app_copyright_old));
         contributorInfo.append("<br/><br/>");
-        contributorInfo.append(String.format(context.getString(R.string.app_contributors), getContributors()));
+        contributorInfo.append(String.format(context.getString(R.string.app_contributors), getContributorsHtml()));
         contributorInfo.append("<br/><br/>");
-        contributorInfo.append(String.format(context.getString(R.string.app_libraries), getThirdPartyLibraries()));
+        contributorInfo.append(String.format(context.getString(R.string.app_libraries), getThirdPartyLibrariesHtml()));
         contributorInfo.append("<br/><br/>");
-        contributorInfo.append(String.format(context.getString(R.string.app_resources), getUsedThirdPartyAssets()));
+        contributorInfo.append(String.format(context.getString(R.string.app_resources), getUsedThirdPartyAssetsHtml()));
 
-        return HtmlCompat.fromHtml(contributorInfo.toString(), HtmlCompat.FROM_HTML_MODE_COMPACT);
-    }
-
-    public Spanned getHistoryInfo() {
-        return HtmlCompat.fromHtml(getHistory(), HtmlCompat.FROM_HTML_MODE_COMPACT);
-    }
-
-    public Spanned getLicenseInfo() {
-        return HtmlCompat.fromHtml(getLicense(), HtmlCompat.FROM_HTML_MODE_LEGACY);
-    }
-
-    public Spanned getPrivacyInfo() {
-        return HtmlCompat.fromHtml(getPrivacy(), HtmlCompat.FROM_HTML_MODE_COMPACT);
+        return contributorInfo.toString();
     }
 
     public String getVersionHistory() {

app/src/main/java/protect/card_locker/MainActivity.kt

@@ -58,8 +58,8 @@ class MainActivity : CatimaAppCompatActivity(), CardAdapterListener {
     private var selectedTab: Int = 0
     private lateinit var groupsTabLayout: TabLayout
     private lateinit var mUpdateLoyaltyCardListRunnable: Runnable
-    private lateinit var mBarcodeScannerLauncher: ActivityResultLauncher<Intent?>
-    private lateinit var mSettingsLauncher: ActivityResultLauncher<Intent?>
+    private lateinit var mBarcodeScannerLauncher: ActivityResultLauncher<Intent>
+    private lateinit var mSettingsLauncher: ActivityResultLauncher<Intent>
 
     private val mCurrentActionModeCallback: ActionMode.Callback = object : ActionMode.Callback {
         override fun onCreateActionMode(inputMode: ActionMode, inputMenu: Menu?): Boolean {

app/src/main/java/protect/card_locker/OpenWebLinkHandler.java

@@ -1,18 +1,17 @@
 package protect.card_locker;
 
+import android.app.Activity;
 import android.content.ActivityNotFoundException;
 import android.content.Intent;
 import android.net.Uri;
 import android.util.Log;
 import android.widget.Toast;
 
-import androidx.appcompat.app.AppCompatActivity;
-
 public class OpenWebLinkHandler {
 
     private static final String TAG = "Catima";
 
-    public void openBrowser(AppCompatActivity activity, String url) {
+    public void openBrowser(Activity activity, String url) {
         if (url == null) {
             return;
         }

app/src/main/java/protect/card_locker/ScanActivity.kt

@@ -538,7 +538,7 @@ class ScanActivity : CatimaAppCompatActivity() {
 
     override fun onRequestPermissionsResult(
         requestCode: Int,
-        permissions: Array<String?>,
+        permissions: Array<String>,
         grantResults: IntArray
     ) {
         super.onRequestPermissionsResult(requestCode, permissions, grantResults)
@@ -548,7 +548,7 @@ class ScanActivity : CatimaAppCompatActivity() {
 
     override fun onMockedRequestPermissionsResult(
         requestCode: Int,
-        permissions: Array<String?>,
+        permissions: Array<String>,
         grantResults: IntArray
     ) {
         val granted =

app/src/main/java/protect/card_locker/compose/AboutActivity.kt

@@ -0,0 +1,97 @@
+package protect.card_locker.compose
+
+import androidx.activity.compose.LocalActivity
+import androidx.compose.foundation.clickable
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.verticalScroll
+import androidx.compose.material3.AlertDialog
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.text.AnnotatedString
+import androidx.compose.ui.unit.dp
+import protect.card_locker.OpenWebLinkHandler
+import protect.card_locker.R
+
+@Composable
+fun CatimaAboutSection(
+    title: String,
+    message: String,
+    modifier: Modifier = Modifier,
+    onClickUrl: String? = null,
+    onClickDialogText: AnnotatedString? = null,
+) {
+    val activity = LocalActivity.current
+
+    val openDialog = remember { mutableStateOf(false) }
+
+    Row(
+        modifier = modifier
+            .padding(horizontal = 16.dp, vertical = 8.dp)
+            .clickable {
+                if (onClickDialogText != null) {
+                    openDialog.value = true
+                } else if (onClickUrl != null) {
+                    OpenWebLinkHandler().openBrowser(activity, onClickUrl)
+                }
+            }
+    ) {
+        Column(modifier = Modifier.weight(1F)) {
+            Text(
+                text = title,
+                style = MaterialTheme.typography.titleMedium
+            )
+            Text(text = message)
+        }
+        Text(modifier = Modifier.align(Alignment.CenterVertically),
+            text = ">",
+            style = MaterialTheme.typography.bodyMedium
+        )
+    }
+    if (openDialog.value && onClickDialogText != null) {
+        AlertDialog(
+            icon = {},
+            title = {
+                Text(text = title)
+            },
+            text = {
+                Text(
+                    text = onClickDialogText,
+                    modifier = Modifier.verticalScroll(rememberScrollState())
+                )
+            },
+            onDismissRequest = {
+                openDialog.value = false
+            },
+            confirmButton = {
+                TextButton(
+                    onClick = {
+                        openDialog.value = false
+                    }
+                ) {
+                    Text(stringResource(R.string.ok))
+                }
+            },
+            dismissButton = {
+                if (onClickUrl != null) {
+                    TextButton(
+                        onClick = {
+                            OpenWebLinkHandler().openBrowser(activity, onClickUrl)
+                        }
+                    ) {
+                        Text(stringResource(R.string.view_online))
+                    }
+                }
+            }
+        )
+    }
+}

app/src/main/java/protect/card_locker/compose/Catima.kt

@@ -0,0 +1,34 @@
+package protect.card_locker.compose
+
+import androidx.activity.OnBackPressedDispatcher
+import androidx.compose.material.icons.Icons
+import androidx.compose.material.icons.automirrored.filled.ArrowBack
+import androidx.compose.material3.ExperimentalMaterial3Api
+import androidx.compose.material3.Icon
+import androidx.compose.material3.IconButton
+import androidx.compose.material3.Text
+import androidx.compose.material3.TopAppBar
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.testTag
+import androidx.compose.ui.res.stringResource
+import protect.card_locker.R
+
+@OptIn(ExperimentalMaterial3Api::class)
+@Composable
+fun CatimaTopAppBar(title: String, onBackPressedDispatcher: OnBackPressedDispatcher?) {
+    TopAppBar(
+        modifier = Modifier.testTag("topbar_catima"),
+        title = { Text(text = title) },
+        navigationIcon = {
+            if (onBackPressedDispatcher != null) {
+                IconButton(onClick = { onBackPressedDispatcher.onBackPressed() }) {
+                    Icon(
+                        imageVector = Icons.AutoMirrored.Filled.ArrowBack,
+                        contentDescription = stringResource(R.string.back)
+                    )
+                }
+            }
+        }
+    )
+}

app/src/main/java/protect/card_locker/compose/theme/Theme.kt

@@ -0,0 +1,51 @@
+package protect.card_locker.compose.theme
+
+import android.os.Build
+import androidx.appcompat.app.AppCompatDelegate
+import androidx.compose.foundation.isSystemInDarkTheme
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.darkColorScheme
+import androidx.compose.material3.dynamicDarkColorScheme
+import androidx.compose.material3.dynamicLightColorScheme
+import androidx.compose.material3.lightColorScheme
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.res.colorResource
+import protect.card_locker.R
+import protect.card_locker.preferences.Settings
+
+@Composable
+fun CatimaTheme(content: @Composable () -> Unit) {
+    val context = LocalContext.current
+    val settings = Settings(context)
+
+    val isDynamicColorSupported = Build.VERSION.SDK_INT >= Build.VERSION_CODES.S
+
+    val lightTheme = if (isDynamicColorSupported) {
+        dynamicLightColorScheme(context)
+    } else {
+        lightColorScheme(primary = colorResource(id = R.color.md_theme_light_primary))
+    }
+
+    var darkTheme = if (isDynamicColorSupported) {
+        dynamicDarkColorScheme(context)
+    } else {
+        darkColorScheme(primary = colorResource(id = R.color.md_theme_dark_primary))
+    }
+
+    if (settings.oledDark) {
+        darkTheme = darkTheme.copy(background = Color.Black)
+    }
+
+    val colorScheme = when (settings.theme) {
+        AppCompatDelegate.MODE_NIGHT_NO -> lightTheme
+        AppCompatDelegate.MODE_NIGHT_YES -> darkTheme
+        else -> if (isSystemInDarkTheme()) darkTheme else lightTheme
+    }
+
+    MaterialTheme(
+        colorScheme = colorScheme,
+        content = content
+    )
+}