Merge pull request #399 from wisemen-digital/core-v2

Core v2

Author: DanneD-Wisemen

build.gradle.kts

@@ -1,21 +1,8 @@
-// Top-level build file where you can add configuration options common to all sub-projects/modules.
-buildscript {
-    dependencies {
-        classpath(libs.gradle)
-        classpath(kotlin("gradle-plugin", version = libs.versions.kotlin.get()))
-
-        classpath("androidx.navigation:navigation-safe-args-gradle-plugin:${libs.versions.navigation.get()}")
-
-        // NOTE: Do not place your application dependencies here; they belong
-        // in the individual module build.gradle files
-    }
-}
-
 plugins {
-    alias(libs.plugins.android.library) apply false
     alias(libs.plugins.kotlin.android) apply false
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.ksp) apply false
+    alias(libs.plugins.kotlin.compose) apply false
 }
 
 project.tasks.register("clean", Delete::class) {

core-compose/.gitignore

@@ -0,0 +1 @@
+/build

core-compose/build.gradle.kts

@@ -0,0 +1,55 @@
+plugins {
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+    alias(libs.plugins.kotlin.compose)
+}
+
+android {
+    namespace = "be.appwise.compose.core"
+    compileSdk = 35
+
+    defaultConfig {
+        minSdk = 26
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles("consumer-rules.pro")
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+    kotlinOptions {
+        jvmTarget = "17"
+    }
+    buildFeatures {
+        compose = true
+    }
+}
+
+dependencies {
+    implementation(project(":core"))
+
+    implementation(libs.core.ktx)
+    implementation(libs.appcompat)
+    implementation(libs.material)
+
+    implementation(libs.material3)
+
+    implementation(platform(libs.compose.bom))
+    implementation(libs.ui)
+    implementation(libs.ui.graphics)
+    implementation(libs.ui.tooling)
+    implementation(libs.ui.tooling.preview)
+    debugImplementation(libs.ui.test.manifest)
+    implementation(libs.ui.test.junit4)
+}

core-compose/consumer-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

core-compose/proguard-rules.pro

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+</manifest>

core-compose/src/main/AndroidManifest.xml

@@ -0,0 +1,22 @@
+package be.appwise.compose.core.ui.base
+
+import kotlinx.coroutines.channels.Channel
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.receiveAsFlow
+
+open class BaseComposeStateViewModel<UIState, NavigationType>(initialState: UIState): BaseComposeViewModel() {
+    private val _uiState = MutableStateFlow(initialState)
+    val uiState = _uiState.asStateFlow()
+
+    private val _navigation = Channel<NavigationType>()
+    val navigation = _navigation.receiveAsFlow()
+
+    fun updateUIState(state: UIState) {
+        _uiState.tryEmit(state)
+    }
+
+    fun navigate(navigation: NavigationType) {
+        _navigation.trySend(navigation)
+    }
+}

core-compose/src/main/java/be/appwise/compose/core/ui/base/BaseComposeStateViewModel.kt

@@ -0,0 +1,77 @@
+package be.appwise.compose.core.ui.base
+
+import android.util.Log
+import androidx.compose.animation.AnimatedVisibility
+import androidx.compose.material3.SnackbarHost
+import androidx.compose.material3.SnackbarHostState
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.graphics.vector.ImageVector
+import androidx.compose.ui.platform.LocalContext
+import be.appwise.compose.core.ui.base.snackbar.BaseSnackbar
+import be.appwise.compose.core.ui.base.snackbar.Empty
+import be.appwise.compose.core.ui.base.snackbar.Error
+import be.appwise.compose.core.ui.base.snackbar.SnackbarMessage
+import be.appwise.core.ui.base.BaseViewModel
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+
+open class BaseComposeViewModel: BaseViewModel() {
+    // Snackbar Handling
+    private var snackbarMessageState by mutableStateOf<SnackbarMessage>(Empty)
+
+    override fun vmScopeWithCustomExceptionHandler(onError: (error: Throwable) -> Unit): CoroutineScope {
+        return super.vmScopeWithCustomExceptionHandler {
+            Log.w(this::class.simpleName, "Exception caught: ", it)
+            snackbarMessageState = Error(it.message)
+        }
+    }
+
+    @Composable
+    fun createSnackBarHost(
+        snackBar: (@Composable (message: String, icon: ImageVector?, containerColor: Color) -> Unit)? = null
+    ) {
+        val snackBarHostState = remember {
+            SnackbarHostState()
+        }
+
+        val context = LocalContext.current
+
+        LaunchedEffect(key1 = snackbarMessageState) {
+            if (snackbarMessageState !is Empty) {
+                snackBarHostState.showSnackbar(snackbarMessageState.getMessage(context) ?: "Unknown error")
+                setCoroutineException(null)
+                snackbarMessageState = Empty
+            }
+        }
+
+        SnackbarHost(hostState = snackBarHostState) { snackBarData ->
+            AnimatedVisibility(visible = snackbarMessageState.isNotEmpty()) {
+                val icon = snackbarMessageState.icon
+                val message = snackBarData.visuals.message
+                val containerColor = snackbarMessageState.containerColor ?: Color.Transparent
+
+                snackBar?.invoke(message, icon, containerColor)
+                    ?: BaseSnackbar(
+                        icon = icon,
+                        message = message,
+                        containerColor = containerColor
+                    )
+            }
+        }
+    }
+
+
+    fun showSnackbar(snackbarMessage: SnackbarMessage) = vmScope.launch {
+        snackbarMessageState = snackbarMessage
+    }
+
+    fun showSnackbar(message: String?) = vmScope.launch {
+        snackbarMessageState = Error(message = message ?: return@launch)
+    }
+}

core-compose/src/main/java/be/appwise/compose/core/ui/base/BaseComposeViewModel.kt

@@ -0,0 +1,47 @@
+package be.appwise.compose.core.ui.base.snackbar
+
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.shape.RoundedCornerShape
+import androidx.compose.material3.Icon
+import androidx.compose.material3.Snackbar
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.graphics.vector.ImageVector
+import androidx.compose.ui.unit.dp
+import androidx.compose.ui.zIndex
+
+@Composable
+fun BaseSnackbar(
+    message: String,
+    containerColor: Color,
+    icon: ImageVector? = null,
+) {
+    Snackbar(
+        containerColor = containerColor,
+        modifier = Modifier.padding(8.dp).zIndex(100f),
+        shape = RoundedCornerShape(0.dp)
+    ) {
+        Row(
+            verticalAlignment = Alignment.CenterVertically
+        ) {
+            if(icon != null) {
+                Icon(
+                    icon,
+                    tint = Color.White,
+                    contentDescription = null
+                )
+            }
+            Text(
+                message,
+                color = Color.White,
+                modifier = Modifier
+                    .padding(start = 8.dp)
+                    .weight(1f)
+            )
+        }
+    }
+}

core-compose/src/main/java/be/appwise/compose/core/ui/base/snackbar/BaseSnackbar.kt

@@ -0,0 +1,51 @@
+package be.appwise.compose.core.ui.base.snackbar
+
+import android.content.Context
+import androidx.compose.material.icons.Icons
+import androidx.compose.material.icons.filled.Check
+import androidx.compose.material.icons.filled.Warning
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.graphics.vector.ImageVector
+import java.io.Serializable
+
+
+open class SnackbarMessage(
+    open val message: String? = null,
+    open val icon: ImageVector? = null,
+    open val containerColor: Color? = Color.Transparent,
+    open vararg val formatParams: Any?
+) : Serializable {
+
+    fun getMessage(context: Context) = when {
+        message != null -> message
+        else -> null
+    }
+
+    fun isNotEmpty() = message != null
+}
+
+data object Empty : SnackbarMessage()
+
+class Success(
+    override val message: String? = null,
+    override val icon: ImageVector = Icons.Default.Check,
+    override val containerColor: Color = Color.Green,
+    override vararg val formatParams: Any?
+) : SnackbarMessage(
+    message = message,
+    icon = icon,
+    containerColor = containerColor,
+    *formatParams
+)
+
+class Error(
+    override val message: String? = null,
+    override val icon: ImageVector = Icons.Default.Warning,
+    override val containerColor: Color = Color.Red,
+    override vararg val formatParams: Any?
+) : SnackbarMessage(
+    message = message,
+    icon = icon,
+    containerColor = containerColor,
+    *formatParams
+)