Merge pull request #54 from ruffCode/navigation-animation

migrate to navigation-animation, update deps closes #48 closes #53

Author: ruffCode

README.md

@@ -1,6 +1,8 @@
 ![yaba logo](./assets/yaba.png)
+[![yaba](https://img.shields.io/badge/MAD-Score-green)](https://madscorecard.withgoogle.com/scorecards/117769992/)
 
 # yaba (yet another budgeting app)
+
 ![yaba logo](./assets/dark.gif) ![yaba logo](./assets/light.gif)
 
 ## Kotlin Multiplatform Mobile ready (*only the Android app is being developed as I am just starting to learn Swift*)
@@ -9,8 +11,11 @@
 
 #### An app which uses Plaid's APIs and allows users to track the balances and transactions for any financial institution they choose to link.
 
-The [backend](https://github.com/ruffCode/yaba-server) is using Plaid's sandbox API, so you can
-only get fake data.
+#### *This is a work in progress and for now, only the Android app is being developed as I am just
+starting to learn Swift.*
+
+The [backend](https://github.com/ruffCode/yaba-server) is using Plaid's sandbox API, so you can only
+get fake data.
 
 ## Usage
 
@@ -19,15 +24,17 @@ only get fake data.
 ````shell script
 ./gradlew installSandboxDebug
 ````
+
 Register with any email address you'd like, the format needs to be valid but nothing will be emailed
 to you.
 
 #### *You can also grab the latest signed APK from the releases tab.*
 
 ### Linking financial institutions
 
-When linking a financial institution use the sandbox credentials below. If prompted for an MFA method,
-choose any of them and enter 1234 for the code. Bank of America does prompt for MFA so take note when linking.
+When linking a financial institution use the sandbox credentials below. If prompted for an MFA
+method, choose any of them and enter 1234 for the code. Bank of America does prompt for MFA so take
+note when linking.
 
 ```
 username: custom_user1 or custom_user2
@@ -36,25 +43,33 @@ pin: credential_good (when required)
 MFA code: 1234 (when required)
 ```
 
+*With some institutions, Chase being one, the above credentials will not work, use the following:*
+
+```
+username: user_good
+password: pass_good
+```
+
 Please see [Plaid sandbox test credentials](https://plaid.com/docs/sandbox/test-credentials/) for
 MFA credentials if the institution you are attempting to link requires them.
 
 ### Using a local server
 
-* Clone or fork the backend from [https://github.com/ruffCode/yaba-server](https://github.com/ruffCode/yaba-server)
-* Enable staging build type by uncommenting "localServerUrl" in `gradle.properties` and insert the url of your local
-  instance
-* If using an insecure host, change the domain value in `staging/res/xms/network-security-config.xml`
+* Clone or fork the backend
+  from [https://github.com/ruffCode/yaba-server](https://github.com/ruffCode/yaba-server)
+* Enable staging build type by uncommenting "localServerUrl" in `gradle.properties` and insert the
+  url of your local instance
+* If using an insecure host, change the domain value
+  in `staging/res/xms/network-security-config.xml`
 * Install ```./gradlew installSandboxStaging ```
 
-
 ## Prior Art
 
 ### [tivi by Chris Banes](https://github.com/chisbanes/tivi)
 
 This project is a great example of how to build a large and stable project. I was greatly inspired
-by Chris' state management technique and do use some of his code, including Flow extensions, observers
-and interactors. Credit is given where used.
+by Chris' state management technique and do use some of his code, including Flow extensions,
+observers and interactors. Credit is given where used.
 
 ### [KaMPKit by Touchlab](https://github.com/touchlab/KaMPKit)
 

androidApp/build.gradle.kts

@@ -10,12 +10,13 @@ plugins {
     id("io.sentry.android.gradle") version "2.1.4"
 }
 
+
 val hasReleaseKey: Boolean = project.rootProject.file("release/yaba-release.jks").exists()
 
 dependencies {
 
     implementation(projects.data)
-    implementation("androidx.core:core-ktx:1.7.0-alpha02")
+//    implementation("androidx.core:core-ktx:1.7.0-beta01")
     implementation("com.google.android.material:material:1.4.0")
     implementation(Lib.Compose.animation)
     implementation(Lib.Compose.foundation)
@@ -30,17 +31,20 @@ dependencies {
     implementation(platform(Lib.KotlinX.Coroutines.bom))
     implementation(Lib.KotlinX.Coroutines.core)
     implementation(Lib.KotlinX.Coroutines.android)
-    implementation(Lib.Koin.core)
+
     implementation(Lib.Koin.android)
     implementation(Lib.Koin.compose)
     implementation(Lib.kermit)
     implementation(Lib.KotlinX.dateTime)
     implementation(Lib.KotlinX.Serialization.json)
-    implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.4.0-alpha03")
+    implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.4.0-beta01")
+    implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0-beta01")
+    implementation("androidx.lifecycle:lifecycle-viewmodel-compose:2.4.0-beta01")
     implementation("androidx.activity:activity-compose:1.3.1")
-    //2.4.0-alpha05 uses crossfade by default and breaks the app
-    implementation("androidx.navigation:navigation-compose:2.4.0-alpha04")
-    implementation("androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha07")
+
+    implementation(Lib.Accompanist.navigationAnimation)
+
+    implementation("androidx.lifecycle:lifecycle-viewmodel-savedstate:2.4.0-beta01")
     implementation("androidx.constraintlayout:constraintlayout-compose:1.0.0-beta02")
     implementation("androidx.core:core-splashscreen:1.0.0-alpha01")
     implementation("com.plaid.link:sdk-core:3.5.1")
@@ -72,6 +76,8 @@ dependencies {
     testImplementation(Lib.AndroidXTest.robolectric)
     testImplementation(Lib.AndroidXTest.mockito)
     testImplementation(Lib.KotlinX.Coroutines.test)
+    debugImplementation(Lib.leakCanary)
+    implementation(Lib.logCat)
 }
 
 android {
@@ -165,17 +171,18 @@ android {
         freeCompilerArgs = freeCompilerArgs + listOf(
             "-Xopt-in=kotlin.RequiresOptIn",
             "-Xskip-prerelease-check",
-            "-Xuse-experimental=kotlin.Experimental",
-            "-Xuse-experimental=kotlinx.coroutines.ExperimentalCoroutinesApi",
-            "-Xuse-experimental=kotlinx.coroutines.FlowPreview",
-            "-Xuse-experimental=kotlin.ExperimentalStdlibApi",
-            "-Xuse-experimental=androidx.compose.foundation.ExperimentalFoundationApi",
-            "-Xuse-experimental=androidx.compose.material.ExperimentalMaterialApi",
-            "-Xuse-experimental=androidx.compose.animation.ExperimentalAnimationApi",
-            "-Xuse-experimental=kotlin.time.ExperimentalTime",
-            "-Xuse-experimental=androidx.compose.ui.ExperimentalComposeUiApi",
-            "-Xuse-experimental=org.koin.core.KoinExperimentalAPI",
-            "-Xuse-experimental=coil.annotation.ExperimentalCoilApi"
+            "-Xopt-in=kotlin.Experimental",
+            "-Xopt-in=kotlinx.coroutines.ExperimentalCoroutinesApi",
+            "-Xopt-in=kotlinx.coroutines.FlowPreview",
+            "-Xopt-in=kotlin.ExperimentalStdlibApi",
+            "-Xopt-in=androidx.compose.foundation.ExperimentalFoundationApi",
+            "-Xopt-in=androidx.compose.material.ExperimentalMaterialApi",
+            "-Xopt-in=androidx.compose.animation.ExperimentalAnimationApi",
+            "-Xopt-in=kotlin.time.ExperimentalTime",
+            "-Xopt-in=androidx.compose.ui.ExperimentalComposeUiApi",
+            "-Xopt-in=org.koin.core.KoinExperimentalAPI",
+            "-Xopt-in=coil.annotation.ExperimentalCoilApi",
+            "-Xopt-in=kotlinx.serialization.ExperimentalSerializationApi"
         )
     }
     packagingOptions {

androidApp/src/main/kotlin/tech/alexib/yaba/android/MainActivity.kt

@@ -29,12 +29,10 @@ import androidx.compose.runtime.staticCompositionLocalOf
 import androidx.compose.ui.graphics.Color
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
 import androidx.core.view.WindowCompat
-import co.touchlab.kermit.Kermit
 import com.google.accompanist.insets.ProvideWindowInsets
 import com.google.accompanist.systemuicontroller.rememberSystemUiController
 import org.koin.core.component.KoinComponent
 import org.koin.core.component.inject
-import org.koin.core.parameter.parametersOf
 import org.koin.core.qualifier.named
 import tech.alexib.yaba.android.ui.MainAppLayout
 import tech.alexib.yaba.android.ui.theme.YabaTheme
@@ -52,7 +50,6 @@ val LocalIsSandBoxProvider = staticCompositionLocalOf<IsSandbox>() {
 class MainActivity : AppCompatActivity(), KoinComponent {
 
     private val appSettings: AppSettings by inject()
-    private val log: Kermit by inject { parametersOf("MainActivity") }
     private val isSandBox: Boolean by inject(named("isSandbox"))
 
     @SuppressLint("SourceLockedOrientationActivity")

androidApp/src/main/kotlin/tech/alexib/yaba/android/MainApp.kt

@@ -23,6 +23,8 @@ import androidx.work.await
 import io.sentry.SentryLevel
 import io.sentry.android.core.SentryAndroid
 import kotlinx.coroutines.runBlocking
+import logcat.AndroidLogcatLogger
+import logcat.LogPriority
 import org.koin.android.ext.koin.androidContext
 import org.koin.androidx.workmanager.koin.workManagerFactory
 import org.koin.core.qualifier.named
@@ -57,7 +59,7 @@ class MainApp : Application() {
             workManagerFactory()
             modules(createAppModule(serverUrl, isSandbox), viewModelModule)
         }
-
+        AndroidLogcatLogger.installOnDebuggableApp(this, minPriority = LogPriority.VERBOSE)
         SentryAndroid.init(this) { options ->
             options.setBeforeSend { event, _ ->
                 if (SentryLevel.DEBUG == event.level) {

androidApp/src/main/kotlin/tech/alexib/yaba/android/di/viewModelModule.kt

@@ -1,6 +1,8 @@
 package tech.alexib.yaba.android.di
 
+import kotlinx.coroutines.Dispatchers
 import org.koin.androidx.viewmodel.dsl.viewModel
+import org.koin.core.parameter.parametersOf
 import org.koin.dsl.module
 import tech.alexib.yaba.android.fcm.PushTokenManagerImpl
 import tech.alexib.yaba.android.ui.accounts.AccountsScreenViewModel
@@ -24,15 +26,17 @@ val viewModelModule = module {
     viewModel { LoginScreenViewModel(get(), get()) }
     viewModel { RegisterScreenViewModel() }
     viewModel { SettingsScreenViewModel() }
-    viewModel { PlaidLinkViewModel(get()) }
-    viewModel { PlaidLinkResultScreenViewModel() }
+    single { PlaidLinkViewModel(get()) }
+    single {
+        PlaidLinkResultScreenViewModel()
+    }
     viewModel { BiometricSetupScreenViewModel() }
     viewModel { HomeViewModel() }
     viewModel { PlaidItemsScreenViewModel() }
-    viewModel { PlaidItemDetailScreenViewModel() }
+    viewModel { PlaidItemDetailScreenViewModel(get()) }
     viewModel { TransactionListScreenViewModel() }
-    viewModel { TransactionDetailScreenViewModel() }
+    viewModel { TransactionDetailScreenViewModel(get()) }
     single<PushTokenManager> { PushTokenManagerImpl() }
     viewModel { AccountsScreenViewModel() }
-    viewModel { AccountDetailScreenViewModel() }
+    viewModel { AccountDetailScreenViewModel(get(), get()) }
 }