Feature/add catalog favorites screen (#40)

* feat(core-database): Updated catalog favorites dao and local datasource
* feat(mobile-app): Added catalog favorites default ui screen
* feat(mobile-app): Added catalog favorites di module definition
* feat(mobile-app): Added catalog favorites ui parts
* feat(mobile-app): Added catalog favorites ui slots
* feat(mobile-app): Added catalog favorites xml resources
* feat(mobile-app): Renamed old files
* feat(mobile-app): Updated catalog favorites ui route definition
* feat(mobile-app): Updated fake catalog favorites local data source features
* feat(mobile-app): Updated fake catalog favorites ui route, ui state, viewmodel and repository

Author: marlonlom

apps/mobile-app/src/main/kotlin/dev/marlonlom/apps/cappajv/di/data_module.kt

@@ -11,6 +11,7 @@ import dev.marlonlom.apps.cappajv.core.database.datasource.LocalDataSource
 import dev.marlonlom.apps.cappajv.core.database.datasource.LocalDataSourceImpl
 import dev.marlonlom.apps.cappajv.core.preferences.UserPreferencesRepository
 import dev.marlonlom.apps.cappajv.dataStore
+import dev.marlonlom.apps.cappajv.features.catalog_favorites.CatalogFavoritesRepository
 import dev.marlonlom.apps.cappajv.features.catalog_list.CatalogListRepository
 import dev.marlonlom.apps.cappajv.features.catalog_search.CatalogSearchRepository
 import org.koin.android.ext.koin.androidContext
@@ -37,6 +38,11 @@ val dataModule = module {
       catalogDataService = get(),
     )
   }
+  single<CatalogFavoritesRepository> {
+    CatalogFavoritesRepository(
+      localDataSource = get(),
+    )
+  }
   single<CatalogSearchRepository> {
     CatalogSearchRepository(
       localDataSource = get(),

apps/mobile-app/src/main/kotlin/dev/marlonlom/apps/cappajv/di/viewmodels_module.kt

@@ -6,6 +6,7 @@
 package dev.marlonlom.apps.cappajv.di
 
 import dev.marlonlom.apps.cappajv.features.catalog_detail.CatalogDetailViewModel
+import dev.marlonlom.apps.cappajv.features.catalog_favorites.CatalogFavoritesViewModel
 import dev.marlonlom.apps.cappajv.features.catalog_list.CatalogListViewModel
 import dev.marlonlom.apps.cappajv.features.catalog_search.CatalogSearchViewModel
 import dev.marlonlom.apps.cappajv.features.settings.SettingsViewModel
@@ -15,6 +16,7 @@ import org.koin.dsl.module
 val viewModelsModule = module {
   includes(dataModule)
   viewModelOf(::CatalogListViewModel)
+  viewModelOf(::CatalogFavoritesViewModel)
   viewModelOf(::CatalogSearchViewModel)
   viewModelOf(::CatalogDetailViewModel)
   viewModelOf(::SettingsViewModel)

apps/mobile-app/src/main/kotlin/dev/marlonlom/apps/cappajv/features/catalog_favorites/CatalogFavoritesRepository.kt

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2024 Marlonlom
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dev.marlonlom.apps.cappajv.features.catalog_favorites
+
+import dev.marlonlom.apps.cappajv.core.database.datasource.LocalDataSource
+import dev.marlonlom.apps.cappajv.core.database.entities.CatalogItemTuple
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.map
+
+/**
+ * Catalog favorites repository.
+ *
+ * @author marlonlom
+ *
+ * @property localDataSource Local data source.
+ */
+class CatalogFavoritesRepository(
+  private val localDataSource: LocalDataSource,
+) {
+
+  /** Returns Favorite catalog items list as flow. */
+  val favoritesListFlow: Flow<List<CatalogItemTuple>> = localDataSource.getFavorites().map { f ->
+    f.map {
+      CatalogItemTuple(
+        it.id,
+        it.title,
+        it.picture,
+        it.category,
+        it.samplePunctuation,
+        it.punctuationsCount
+      )
+    }
+  }
+
+  /**
+   * Deletes a catalog item marked as favorite, using its provided id.
+   *
+   * @param catalogId Catalog item id.
+   */
+  suspend fun deleteFavorite(catalogId: Long) = localDataSource.deleteFavorite(catalogId)
+}

apps/mobile-app/src/main/kotlin/dev/marlonlom/apps/cappajv/features/catalog_favorites/CatalogFavoritesRoute.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2024 Marlonlom
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dev.marlonlom.apps.cappajv.features.catalog_favorites
+
+import androidx.compose.foundation.ExperimentalFoundationApi
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
+import dev.marlonlom.apps.cappajv.features.catalog_favorites.screens.CatalogFavoritesRouteScreen
+import dev.marlonlom.apps.cappajv.ui.main.CappajvAppState
+import org.koin.androidx.compose.koinViewModel
+import timber.log.Timber
+
+/**
+ * Catalog favorites route composable ui.
+ *
+ * @author marlonlom
+ *
+ * @param appState Application ui state.
+ * @param viewModel Catalog favorites viewmodel.
+ */
+@ExperimentalFoundationApi
+@Composable
+fun CatalogFavoritesRoute(
+  appState: CappajvAppState,
+  viewModel: CatalogFavoritesViewModel = koinViewModel(),
+) {
+  val favoritesListState by viewModel.favoritesListState.collectAsStateWithLifecycle()
+  CatalogFavoritesRouteScreen(
+    appState = appState,
+    favoritesListState = favoritesListState,
+    onFavoriteItemClicked = { catalogId, isRouting ->
+      Timber.d("[CatalogFavoritesRoute] clicked item[$catalogId], isRouting=$isRouting ")
+    },
+    onFavoriteItemRemoved = viewModel::deleteFavorite,
+  )
+}

apps/mobile-app/src/main/kotlin/dev/marlonlom/apps/cappajv/features/catalog_favorites/CatalogFavoritesUiState.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2024 Marlonlom
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dev.marlonlom.apps.cappajv.features.catalog_favorites
+
+import dev.marlonlom.apps.cappajv.core.database.entities.CatalogItemTuple
+
+/**
+ * Catalog favorites ui state.
+ *
+ * @author marlonlom
+ */
+sealed class CatalogFavoritesUiState {
+
+  /**
+   * Empty results phase of catalog favorites ui state.
+   *
+   * @author marlonlom
+   */
+  data object Empty : CatalogFavoritesUiState()
+
+  /**
+   * Fetching phase of catalog favorites ui state.
+   *
+   * @author marlonlom
+   */
+  data object Fetching : CatalogFavoritesUiState()
+
+  /**
+   * Success result phase of catalog favorites ui state.
+   *
+   * @author marlonlom
+   *
+   * @property results
+   */
+  data class Success(val results: List<CatalogItemTuple>) : CatalogFavoritesUiState()
+
+}

apps/mobile-app/src/main/kotlin/dev/marlonlom/apps/cappajv/features/catalog_favorites/CatalogFavoritesViewModel.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2024 Marlonlom
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package dev.marlonlom.apps.cappajv.features.catalog_favorites
+
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewModelScope
+import dev.marlonlom.apps.cappajv.features.catalog_favorites.CatalogFavoritesUiState.Empty
+import dev.marlonlom.apps.cappajv.features.catalog_favorites.CatalogFavoritesUiState.Fetching
+import dev.marlonlom.apps.cappajv.features.catalog_favorites.CatalogFavoritesUiState.Success
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.SharingStarted
+import kotlinx.coroutines.flow.stateIn
+import kotlinx.coroutines.flow.update
+import kotlinx.coroutines.launch
+
+class CatalogFavoritesViewModel(
+  private val repository: CatalogFavoritesRepository
+) : ViewModel() {
+
+  private val _favoritesListState = MutableStateFlow<CatalogFavoritesUiState>(Empty)
+  val favoritesListState = _favoritesListState.stateIn(
+    scope = viewModelScope,
+    started = SharingStarted.Eagerly,
+    initialValue = Empty
+  )
+
+  init {
+    this.fetchAllFavorites()
+  }
+
+  private fun fetchAllFavorites() {
+    viewModelScope.launch {
+      _favoritesListState.update { Fetching }
+      repository.favoritesListFlow.collect { list ->
+        _favoritesListState.update { if (list.isEmpty()) Empty else Success(list) }
+      }
+    }
+  }
+
+  fun deleteFavorite(catalogId: Long) {
+    viewModelScope.launch {
+      repository.deleteFavorite(catalogId)
+    }
+  }
+}