writing category values on bottomsheet

Author: pablobaldez

Diff for: core/androidx/src/main/kotlin/br/com/mob1st/core/androidx/parcelables/BundleExtensions.kt

@@ -2,6 +2,7 @@ package br.com.mob1st.core.androidx.parcelables
 
 import android.os.Build
 import android.os.Bundle
+import android.os.Parcel
 import android.os.Parcelable
 
 /**
@@ -18,3 +19,18 @@ inline fun <reified T : Parcelable> Bundle.getParcelableAs(key: String): T? =
         @Suppress("DEPRECATION")
         getParcelable(key) as? T
     }
+
+/**
+ * Reads a [Parcelable] from the [Parcel].
+ * It casts the result to the type [T], using different [Parcelable] methods depending on the Android version.
+ * The android version is checked in order to safely call the correct [Parcel.readParcelable] method.
+ * @param T The type of the [Parcelable] to be returned.
+ * @return The [Parcelable] casted to the type [T] or null if the [Parcelable] is not found or if the cast fails.
+ */
+inline fun <reified T : Parcelable> Parcel.readParcelableAs(): T? =
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+        readParcelable(T::class.java.classLoader, T::class.java)
+    } else {
+        @Suppress("DEPRECATION")
+        readParcelable(T::class.java.classLoader)
+    }

Diff for: core/kotlinx/src/main/kotlin/br/com/mob1st/core/kotlinx/errors/Checks.kt renamed to core/kotlinx/src/main/kotlin/br/com/mob1st/core/kotlinx/checks/Checks.kt

@@ -1,4 +1,4 @@
-package br.com.mob1st.core.kotlinx.errors
+package br.com.mob1st.core.kotlinx.checks
 
 /**
  * Checks if the value is not null and is of type [T].
@@ -11,3 +11,13 @@ inline fun <reified T> checkIs(value: Any?): T {
     }
     return value
 }
+
+/**
+ * Invokes the given [block] if the this receiver is a type of [T]
+ * @param block The block to be invoked
+ */
+inline fun <reified T> Any.ifIs(block: (T) -> Unit) {
+    if (this is T) {
+        block(this)
+    }
+}

Diff for: core/kotlinx/src/main/kotlin/br/com/mob1st/core/kotlinx/errors/Exceptions.kt

@@ -0,0 +1,7 @@
+package br.com.mob1st.core.kotlinx.structures
+
+enum class AsyncTaskStatus {
+    IDLE,
+    RUNNING,
+    COMPLETED,
+}

Diff for: core/kotlinx/src/main/kotlin/br/com/mob1st/core/kotlinx/structures/AsyncTaskStatus.kt

@@ -13,6 +13,8 @@ value class Money(
      */
     operator fun plus(other: Money) = Money(cents + other.cents)
 
+    operator fun plus(other: Int) = Money(cents + other)
+
     /**
      * Subtracts two [Money] values generating a new one.
      */

Diff for: core/kotlinx/src/main/kotlin/br/com/mob1st/core/kotlinx/structures/Money.kt

@@ -14,7 +14,7 @@ class StandardAndroidNavigationApi(
     }
 
     override fun back() {
-        navHostController.popBackStack(route = false, inclusive = false)
+        navHostController.popBackStack()
     }
 
     override fun up() {

Diff for: core/navigation/android/src/main/kotlin/br/com/mob1st/twocents/core/navigation/android/StandardAndroidNavigationApi.kt

@@ -31,7 +31,7 @@ private val categoriesModule = module {
         CategoryViewModel(
             default = get(),
             consumableDelegate = CategoryViewModel.consumableDelegate(),
-            intent = params.get(),
+            args = params.get(),
             getCategoryDetail = get(),
             setCategory = get(),
             categoryStateHandle = CategoryStateHandle(get()),

Diff for: features/finances/impl/src/main/kotlin/br/com/mob1st/features/finances/impl/dependencies/UiModule.kt

@@ -1,7 +1,9 @@
 package br.com.mob1st.features.finances.impl.domain.usecases
 
+import br.com.mob1st.core.observability.events.AnalyticsEvent
 import br.com.mob1st.core.observability.events.AnalyticsReporter
 import br.com.mob1st.features.finances.impl.domain.entities.Category
+import br.com.mob1st.features.finances.impl.domain.entities.Recurrences
 import br.com.mob1st.features.finances.impl.domain.infra.repositories.CategoryRepository
 
 internal class SetCategoryUseCase(
@@ -12,6 +14,24 @@ internal class SetCategoryUseCase(
         category: Category,
     ) {
         categoryRepository.set(category)
-        TODO()
+        analyticsReporter.report(AnalyticsEvent.categorySent(category))
+    }
+
+    private fun AnalyticsEvent.Companion.categorySent(
+        category: Category,
+    ) = AnalyticsEvent(
+        name = "category_sent",
+        params = mapOf(
+            "category_id" to category.id,
+            "category_name" to category.name,
+            "amount" to category.amount.cents,
+            category.recurrences.keyValue(),
+        ),
+    )
+
+    private fun Recurrences.keyValue() = when (this) {
+        is Recurrences.Fixed -> "fixed" to day.value
+        Recurrences.Variable -> "variable" to "weekly"
+        is Recurrences.Seasonal -> "seasonal" to daysOfYear.map { it.value }.joinToString { "," }
     }
 }

Diff for: features/finances/impl/src/main/kotlin/br/com/mob1st/features/finances/impl/domain/usecases/SetCategoryUseCase.kt

@@ -3,9 +3,9 @@ package br.com.mob1st.features.finances.impl.ui.builder.steps
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import br.com.mob1st.core.androidx.viewmodels.launchIn
+import br.com.mob1st.core.kotlinx.checks.checkIs
 import br.com.mob1st.core.kotlinx.coroutines.DefaultCoroutineDispatcher
 import br.com.mob1st.core.kotlinx.coroutines.stateInWhileSubscribed
-import br.com.mob1st.core.kotlinx.errors.checkIs
 import br.com.mob1st.core.state.extensions.errorHandler
 import br.com.mob1st.core.state.managers.AsyncLoadingState
 import br.com.mob1st.core.state.managers.ConsumableDelegate

Diff for: features/finances/impl/src/main/kotlin/br/com/mob1st/features/finances/impl/ui/builder/steps/BudgetBuilderStepViewModel.kt

@@ -9,7 +9,7 @@ import arrow.optics.copy
 import arrow.optics.optics
 import br.com.mob1st.core.design.organisms.snack.SnackbarState
 import br.com.mob1st.core.design.organisms.snack.snackbar
-import br.com.mob1st.core.kotlinx.errors.checkIs
+import br.com.mob1st.core.kotlinx.checks.checkIs
 import br.com.mob1st.features.finances.impl.R
 import br.com.mob1st.features.finances.impl.domain.entities.BudgetBuilderAction
 import br.com.mob1st.features.finances.impl.domain.entities.CategoryDefaultValues

Diff for: features/finances/impl/src/main/kotlin/br/com/mob1st/features/finances/impl/ui/builder/steps/BuilderStepConsumables.kt

@@ -2,25 +2,55 @@ package br.com.mob1st.features.finances.impl.ui.category.detail
 
 import androidx.compose.runtime.Immutable
 import arrow.optics.optics
+import br.com.mob1st.core.design.organisms.snack.SnackbarState
 import br.com.mob1st.features.finances.impl.domain.entities.Recurrences
-import br.com.mob1st.features.utils.errors.CommonErrorSnackbarState
 
+/**
+ * Consumables for the category detail screen.
+ * @property dialog The dialog to be shown.
+ * @property snackbarState The snackbar to be shown.
+ * @property isSubmitted Indicates if the form was submitted or not.
+ */
 @Immutable
 @optics
 data class CategoryDetailConsumables(
     val dialog: Dialog? = null,
-    val commonErrorSnackbarState: CommonErrorSnackbarState? = null,
+    val snackbarState: SnackbarState? = null,
+    val isSubmitted: Boolean = false,
 ) {
+    /**
+     * The possible dialogs that can be consumed in the category detail screen.
+     */
     sealed interface Dialog
 
+    /**
+     * Show the proper [Dialog] for the given [recurrences].
+     * @param recurrences The recurrences to be shown.
+     * @return A new [CategoryDetailConsumables] with the dialog set.
+     */
+    fun showDialog(recurrences: Recurrences): CategoryDetailConsumables {
+        return copy(dialog = CategoryCalendarDialog(recurrences))
+    }
+
+    /**
+     * For [optics] generation.
+     */
     companion object
 }
 
+/**
+ * Allows the user to type a new name for the category
+ * @property name The name typed by the user that can be set as the new category name.
+ */
 @Immutable
 data class CategoryNameDialog(
     val name: String,
 ) : CategoryDetailConsumables.Dialog
 
+/**
+ * Allows the user to set a new recurrence date for the category.
+ * @property recurrences The recurrences that can be set as the new category recurrences.
+ */
 @Immutable
 data class CategoryCalendarDialog(
     val recurrences: Recurrences,

Diff for: features/finances/impl/src/main/kotlin/br/com/mob1st/features/finances/impl/ui/category/detail/CategoryDetailConsumables.kt

@@ -39,7 +39,7 @@ internal fun CategoryDetailPage(
     onSubmit: () -> Unit,
 ) {
     val viewModel = koinViewModel<CategoryViewModel>(
-        parameters = { parametersOf(args.toIntent()) },
+        parameters = { parametersOf(args) },
     )
     val uiState by viewModel.uiState.collectAsStateWithLifecycle()
     val consumables by viewModel.consumableUiState.collectAsStateWithLifecycle()
@@ -58,18 +58,18 @@ internal fun CategoryDetailPage(
     CategoryPageSideEffects(
         snackbarHostState = snackbarHostState,
         args = args,
-        isSubmitted = uiState.isDone,
+        isSubmitted = consumables.isSubmitted,
         consumables = consumables,
         onDismissSnackbar = {
-            viewModel.consume(CategoryDetailConsumables.nullableCommonErrorSnackbarState)
+            viewModel.consume(CategoryDetailConsumables.nullableSnackbarState)
         },
         onSubmit = onSubmit,
     )
 }
 
 @Composable
 private fun CategoryDetailPageScaffold(
-    uiState: CategoryDetailState,
+    uiState: CategoryDetailUiState,
     dialog: CategoryDetailConsumables.Dialog?,
     snackbarHostState: SnackbarHostState,
     onClickKey: (Key) -> Unit,
@@ -94,7 +94,7 @@ private fun CategoryDetailPageScaffold(
 @Composable
 private fun CategoryDetailPageContent(
     modifier: Modifier,
-    uiState: CategoryDetailState,
+    uiState: CategoryDetailUiState,
     dialog: CategoryDetailConsumables.Dialog?,
     onClickKey: (Key) -> Unit,
     onDismissDialog: () -> Unit,
@@ -117,22 +117,22 @@ private fun CategoryDetailPageContent(
 @Composable
 private fun Header(
     modifier: Modifier,
-    uiState: CategoryDetailState,
+    uiState: CategoryDetailUiState,
 ) {
     Box(modifier = modifier) {
         when (uiState) {
-            is CategoryDetailState.Loaded -> {
+            is CategoryDetailUiState.Loaded -> {
                 LoadedHeader(uiState = uiState)
             }
 
-            CategoryDetailState.Loading -> {}
+            CategoryDetailUiState.Loading -> {}
         }
     }
 }
 
 @Composable
 private fun LoadedHeader(
-    uiState: CategoryDetailState.Loaded,
+    uiState: CategoryDetailUiState.Loaded,
 ) {
     Column(
         modifier = Modifier.fillMaxSize(),
@@ -186,7 +186,7 @@ private fun CategoryPageSideEffects(
     }
     SnackbarSideEffect(
         snackbarHostState = snackbarHostState,
-        snackbarVisuals = consumables.commonErrorSnackbarState?.resolve(),
+        snackbarVisuals = consumables.snackbarState?.resolve(),
         onDismiss = onDismissSnackbar,
         onPerformAction = {},
     )
@@ -211,8 +211,9 @@ private fun CategoryViewModel.onClickKey(key: Key) {
 private fun CategoryDetailScaffoldPreview() {
     PreviewTheme {
         CategoryDetailPageScaffold(
-            uiState = CategoryDetailState.Loaded(
+            uiState = CategoryDetailUiState.Loaded(
                 category = CategoryFixtures.category,
+                entry = CategoryEntry(CategoryFixtures.category),
             ),
             dialog = null,
             snackbarHostState = SnackbarHostState(),