Merge pull request #338 from wisemen-digital/feature/base-classes-v2

Feature/base classes 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/build.gradle.kts

@@ -1,14 +1,15 @@
 plugins {
     id("com.android.library")
     id("org.jetbrains.kotlin.android")
+    alias(libs.plugins.kotlin.compose)
 }
 
 android {
     namespace = "be.appwise.compose.core"
-    compileSdk = 34
+    compileSdk = 35
 
     defaultConfig {
-        minSdk = 21
+        minSdk = 26
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
         consumerProguardFiles("consumer-rules.pro")
@@ -30,14 +31,25 @@ android {
     kotlinOptions {
         jvmTarget = "17"
     }
+    buildFeatures {
+        compose = true
+    }
 }
 
 dependencies {
+    implementation(project(":core"))
+
+    implementation(libs.core.ktx)
+    implementation(libs.appcompat)
+    implementation(libs.material)
+
+    implementation(libs.material3)
 
-    implementation("androidx.core:core-ktx:1.12.0")
-    implementation("androidx.appcompat:appcompat:1.6.1")
-    implementation("com.google.android.material:material:1.10.0")
-    testImplementation("junit:junit:4.13.2")
-    androidTestImplementation("androidx.test.ext:junit:1.1.5")
-    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+    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/src/main/java/be/appwise/compose/core/ui/base/BaseComposeStateViewModel.kt

@@ -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/BaseComposeViewModel.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/snackbar/BaseSnackbar.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/SnackbarTypes.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
+)

core/build.gradle.kts

@@ -8,10 +8,10 @@ plugins {
 }
 
 android {
-    compileSdk = 34
+    compileSdk = 35
 
     defaultConfig {
-        minSdk = 21
+        minSdk = 26
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
         consumerProguardFiles("consumer-rules.pro")
@@ -44,11 +44,9 @@ android {
 dependencies {
     implementation(libs.startup.runtime)
 
-    testImplementation(libs.mockk)
-    testImplementation(libs.junit)
-    androidTestImplementation(libs.junit.ext)
-    androidTestImplementation(libs.test.runner)
-    androidTestImplementation(libs.espresso.core)
+    // https://github.com/Ereza/CustomActivityOnCrash
+    implementation(libs.customactivityoncrash)
+
     api(libs.core.ktx)
 
     api(libs.multidex)
@@ -98,8 +96,11 @@ dependencies {
     // Time manipulation for Java 7
     api(libs.joda.time)
 
-    // https://github.com/Ereza/CustomActivityOnCrash
-    implementation(libs.customactivityoncrash)
+    testImplementation(libs.mockk)
+    testImplementation(libs.junit)
+    androidTestImplementation(libs.junit.ext)
+    androidTestImplementation(libs.test.runner)
+    androidTestImplementation(libs.espresso.core)
 }
 
 val sourceJar: Task by tasks.creating(Jar::class) {

core/src/main/java/be/appwise/core/ui/base/BaseActivity.kt

@@ -1,10 +1,12 @@
 package be.appwise.core.ui.base
 
+import androidx.annotation.ColorRes
 import androidx.annotation.DrawableRes
 import androidx.annotation.StringRes
 import androidx.appcompat.app.AppCompatActivity
 import androidx.appcompat.widget.Toolbar
 import androidx.core.content.ContextCompat
+import androidx.core.view.WindowInsetsControllerCompat
 import be.appwise.core.R
 import be.appwise.core.extensions.activity.showSnackbar
 import com.orhanobut.logger.Logger
@@ -52,4 +54,9 @@ open class BaseActivity : AppCompatActivity() {
         showSnackbar(throwable.message ?: getString(R.string.error_default))
         Logger.t("BaseActivity").e(throwable, throwable.message ?: getString(R.string.error_default))
     }
-}
+
+    fun setStatusBarColor(@ColorRes statusBarColor: Int, isDarkMode: Boolean = false) {
+        WindowInsetsControllerCompat(window, window.decorView).isAppearanceLightStatusBars = !isDarkMode
+        window.statusBarColor = ContextCompat.getColor(this, statusBarColor)
+    }
+}

core/src/main/java/be/appwise/core/ui/base/BaseApp.kt

@@ -0,0 +1,24 @@
+package be.appwise.core.ui.base
+
+import android.app.Application
+import be.appwise.core.BuildConfig
+import be.appwise.core.core.CoreApp
+import com.orhanobut.hawk.Hawk
+
+class BaseApp: Application() {
+    fun init(appName: String) {
+        Hawk.init(this).build()
+
+        initCore(appName)
+    }
+
+    private fun initCore(appName: String) {
+        CoreApp.init {
+            initializeLogger(appName, BuildConfig.DEBUG)
+
+            if(BuildConfig.DEBUG) {
+                initializeErrorActivity(true)
+            }
+        }
+    }
+}

core/src/main/java/be/appwise/core/ui/base/BaseBindingActivity.kt

@@ -0,0 +1,20 @@
+package be.appwise.core.ui.base
+
+import android.os.Bundle
+import androidx.annotation.LayoutRes
+import androidx.databinding.DataBindingUtil
+import androidx.databinding.ViewDataBinding
+
+abstract class BaseBindingActivity<B : ViewDataBinding>: BaseActivity() {
+    protected lateinit var mBinding: B
+        private set
+
+    @LayoutRes
+    protected abstract fun getLayout(): Int
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        mBinding = DataBindingUtil.setContentView(this, getLayout())
+        mBinding.lifecycleOwner = this
+        super.onCreate(savedInstanceState)
+    }
+}