refactor nav abstraction

stslex · Oct 17, 2023 · 7881a1a · 7881a1a
1 parent c4f5ee8
commit 7881a1a
Show file tree

Hide file tree

Showing 41 changed files with 154 additions and 160 deletions.
diff --git a/app/src/main/java/st/slex/csplashscreen/di/main/MainModule.kt b/app/src/main/java/st/slex/csplashscreen/di/main/MainModule.kt
@@ -2,7 +2,7 @@ package st.slex.csplashscreen.di.main
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
-import com.stslex93.notes.core.ui.base.ViewModelFactory
+import st.slex.csplashscreen.core.ui.base.ViewModelFactory
 import dagger.Binds
 import dagger.Module
 import dagger.multibindings.IntoMap

diff --git a/core/ui/src/main/java/st/slex/csplashscreen/core/ui/base/BaseViewModel.kt b/core/ui/src/main/java/st/slex/csplashscreen/core/ui/base/BaseViewModel.kt
@@ -4,13 +4,15 @@ import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import kotlinx.coroutines.flow.SharedFlow
 import kotlinx.coroutines.flow.StateFlow
+import st.slex.csplashscreen.core.ui.mvi.Router
 import st.slex.csplashscreen.core.ui.mvi.Store
 import st.slex.csplashscreen.core.ui.mvi.Store.Action
 import st.slex.csplashscreen.core.ui.mvi.Store.Event
 import st.slex.csplashscreen.core.ui.mvi.Store.State
 
-open class BaseViewModel<out S : State, out E : Event, in A : Action>(
-    private val store: Store<S, E, A>
+open class BaseViewModel<out S : State, out E : Event, in A : Action, in N : Event.Navigation>(
+    private val store: Store<S, E, A>,
+    private val router: Router<N>
 ) : ViewModel() {
 
     val state: StateFlow<S> = store.state
@@ -24,6 +26,10 @@ open class BaseViewModel<out S : State, out E : Event, in A : Action>(
         store.processAction(action)
     }
 
+    fun navigate(event: N) {
+        router(event)
+    }
+
     override fun onCleared() {
         super.onCleared()
         store.destroy()

diff --git a/core/ui/src/main/java/st/slex/csplashscreen/core/ui/base/ViewModelFactory.kt b/core/ui/src/main/java/st/slex/csplashscreen/core/ui/base/ViewModelFactory.kt
@@ -1,4 +1,4 @@
-package com.stslex93.notes.core.ui.base
+package st.slex.csplashscreen.core.ui.base
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider

diff --git a/core/ui/src/main/java/st/slex/csplashscreen/core/ui/mvi/Router.kt b/core/ui/src/main/java/st/slex/csplashscreen/core/ui/mvi/Router.kt
@@ -0,0 +1,5 @@
+package st.slex.csplashscreen.core.ui.mvi
+
+fun interface Router<in E : Store.Event.Navigation> {
+    operator fun invoke(event: E)
+}
diff --git a/core/ui/src/main/java/st/slex/csplashscreen/core/ui/mvi/Store.kt b/core/ui/src/main/java/st/slex/csplashscreen/core/ui/mvi/Store.kt
@@ -19,6 +19,10 @@ interface Store<out S : State, out E : Event, in A : Action> {
     fun destroy()
 
     interface State
-    interface Event
+
+    interface Event {
+        interface Navigation : Event
+    }
+
     interface Action
 }
diff --git a/...ction/src/main/java/st/slex/csplashscreen/feature/collection/di/SingleCollectionModule.kt b/...ction/src/main/java/st/slex/csplashscreen/feature/collection/di/SingleCollectionModule.kt
@@ -2,7 +2,7 @@ package st.slex.csplashscreen.feature.collection.di
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
-import com.stslex93.notes.core.ui.base.ViewModelFactory
+import st.slex.csplashscreen.core.ui.base.ViewModelFactory
 import dagger.Binds
 import dagger.Module
 import dagger.multibindings.IntoMap

diff --git a/...rc/main/java/st/slex/csplashscreen/feature/collection/navigation/SingleCollectionGraph.kt b/...rc/main/java/st/slex/csplashscreen/feature/collection/navigation/SingleCollectionGraph.kt
@@ -44,7 +44,7 @@ fun NavGraphBuilder.singleCollectionGraph(
 
         viewModel.event.CollectAsEvent { event ->
             when (event) {
-                is Event.Navigation -> viewModel.processNavigation(event)
+                is Event.Navigation -> viewModel.navigate(event)
             }
         }
 

diff --git a/...c/main/java/st/slex/csplashscreen/feature/collection/navigation/SingleCollectionRouter.kt b/...c/main/java/st/slex/csplashscreen/feature/collection/navigation/SingleCollectionRouter.kt
@@ -1,8 +1,6 @@
 package st.slex.csplashscreen.feature.collection.navigation
 
-interface SingleCollectionRouter {
+import st.slex.csplashscreen.core.ui.mvi.Router
+import st.slex.csplashscreen.feature.collection.ui.store.SingleCollectionStore.Event.Navigation
 
-    fun navToImage(uuid: String)
-
-    fun navToProfile(username: String)
-}
+interface SingleCollectionRouter : Router<Navigation>
diff --git a/...in/java/st/slex/csplashscreen/feature/collection/navigation/SingleCollectionRouterImpl.kt b/...in/java/st/slex/csplashscreen/feature/collection/navigation/SingleCollectionRouterImpl.kt
@@ -2,17 +2,25 @@ package st.slex.csplashscreen.feature.collection.navigation
 
 import st.slex.csplashscreen.core.navigation.NavigationScreen
 import st.slex.csplashscreen.core.ui.di.Navigator
+import st.slex.csplashscreen.feature.collection.ui.store.SingleCollectionStore.Event.Navigation
 import javax.inject.Inject
 
 class SingleCollectionRouterImpl @Inject constructor(
     private val navigator: Navigator
 ) : SingleCollectionRouter {
 
-    override fun navToImage(uuid: String) {
-        navigator(NavigationScreen.ImageDetailScreen(uuid))
+    override fun invoke(event: Navigation) {
+        when (event) {
+            is Navigation.ImageDetail -> navToImage(event)
+            is Navigation.Profile -> navToProfile(event)
+        }
     }
 
-    override fun navToProfile(username: String) {
-        navigator(NavigationScreen.UserScreen(username))
+    private fun navToImage(event: Navigation.ImageDetail) {
+        navigator(NavigationScreen.ImageDetailScreen(event.uuid))
+    }
+
+    private fun navToProfile(event: Navigation.Profile) {
+        navigator(NavigationScreen.UserScreen(event.username))
     }
 }
diff --git a/...on/src/main/java/st/slex/csplashscreen/feature/collection/ui/SingleCollectionViewModel.kt b/...on/src/main/java/st/slex/csplashscreen/feature/collection/ui/SingleCollectionViewModel.kt
@@ -11,13 +11,5 @@ import javax.inject.Inject
 
 class SingleCollectionViewModel @Inject constructor(
     store: SingleCollectionStore,
-    private val router: SingleCollectionRouter
-) : BaseViewModel<State, Event, Action>(store) {
-
-    fun processNavigation(event: Navigation) {
-        when (event) {
-            is Navigation.ImageDetail -> router.navToImage(event.uuid)
-            is Navigation.Profile -> router.navToProfile(event.username)
-        }
-    }
-}
+    router: SingleCollectionRouter
+) : BaseViewModel<State, Event, Action, Navigation>(store, router)
diff --git a/.../src/main/java/st/slex/csplashscreen/feature/collection/ui/store/SingleCollectionStore.kt b/.../src/main/java/st/slex/csplashscreen/feature/collection/ui/store/SingleCollectionStore.kt
@@ -21,7 +21,7 @@ interface SingleCollectionStore : Store<State, Event, Action> {
     sealed interface Event : Store.Event {
 
         @Stable
-        sealed interface Navigation : Event {
+        sealed interface Navigation : Event, Store.Event.Navigation {
 
             @Stable
             data class Profile(

diff --git a/...ure/favourite/src/main/java/st/slex/csplashscreen/feature/favourite/di/FavouriteModule.kt b/...ure/favourite/src/main/java/st/slex/csplashscreen/feature/favourite/di/FavouriteModule.kt
@@ -2,7 +2,7 @@ package st.slex.csplashscreen.feature.favourite.di
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
-import com.stslex93.notes.core.ui.base.ViewModelFactory
+import st.slex.csplashscreen.core.ui.base.ViewModelFactory
 import dagger.Binds
 import dagger.Module
 import dagger.multibindings.IntoMap

diff --git a/...ourite/src/main/java/st/slex/csplashscreen/feature/favourite/navigation/FavouriteGraph.kt b/...ourite/src/main/java/st/slex/csplashscreen/feature/favourite/navigation/FavouriteGraph.kt
@@ -35,7 +35,7 @@ fun NavGraphBuilder.favouriteGraph(
 
         viewModel.event.CollectAsEvent { event ->
             when (event) {
-                is Event.Navigation -> viewModel.processNavigation(event)
+                is Event.Navigation -> viewModel.navigate(event)
             }
         }
 

diff --git a/...urite/src/main/java/st/slex/csplashscreen/feature/favourite/navigation/FavouriteRouter.kt b/...urite/src/main/java/st/slex/csplashscreen/feature/favourite/navigation/FavouriteRouter.kt
@@ -1,11 +1,6 @@
 package st.slex.csplashscreen.feature.favourite.navigation
 
-interface FavouriteRouter {
-
-    fun navToUser(username: String)
-
-    fun navToImage(uuid: String)
-
-    fun navHome()
-}
+import st.slex.csplashscreen.core.ui.mvi.Router
+import st.slex.csplashscreen.feature.favourite.ui.store.FavouriteStore
 
+interface FavouriteRouter : Router<FavouriteStore.Event.Navigation>
diff --git a/...e/src/main/java/st/slex/csplashscreen/feature/favourite/navigation/FavouriteRouterImpl.kt b/...e/src/main/java/st/slex/csplashscreen/feature/favourite/navigation/FavouriteRouterImpl.kt
@@ -2,21 +2,30 @@ package st.slex.csplashscreen.feature.favourite.navigation
 
 import st.slex.csplashscreen.core.navigation.NavigationScreen
 import st.slex.csplashscreen.core.ui.di.Navigator
+import st.slex.csplashscreen.feature.favourite.ui.store.FavouriteStore
 import javax.inject.Inject
 
 class FavouriteRouterImpl @Inject constructor(
     private val navigator: Navigator
 ) : FavouriteRouter {
 
-    override fun navToUser(username: String) {
-        navigator(NavigationScreen.UserScreen(username))
+    override fun invoke(event: FavouriteStore.Event.Navigation) {
+        when (event) {
+            FavouriteStore.Event.Navigation.Home -> navHome()
+            is FavouriteStore.Event.Navigation.Image -> navToImage(event)
+            is FavouriteStore.Event.Navigation.User -> navToUser(event)
+        }
     }
 
-    override fun navToImage(uuid: String) {
-        navigator(NavigationScreen.ImageDetailScreen(uuid))
+    private fun navToUser(event: FavouriteStore.Event.Navigation.User) {
+        navigator(NavigationScreen.UserScreen(event.username))
     }
 
-    override fun navHome() {
+    private fun navToImage(event: FavouriteStore.Event.Navigation.Image) {
+        navigator(NavigationScreen.ImageDetailScreen(event.uuid))
+    }
+
+    private fun navHome() {
         navigator(NavigationScreen.Home)
     }
 }
diff --git a/.../favourite/src/main/java/st/slex/csplashscreen/feature/favourite/ui/FavouriteViewModel.kt b/.../favourite/src/main/java/st/slex/csplashscreen/feature/favourite/ui/FavouriteViewModel.kt
@@ -5,19 +5,11 @@ import st.slex.csplashscreen.feature.favourite.navigation.FavouriteRouter
 import st.slex.csplashscreen.feature.favourite.ui.store.FavouriteStore
 import st.slex.csplashscreen.feature.favourite.ui.store.FavouriteStore.Action
 import st.slex.csplashscreen.feature.favourite.ui.store.FavouriteStore.Event
+import st.slex.csplashscreen.feature.favourite.ui.store.FavouriteStore.Event.Navigation
 import st.slex.csplashscreen.feature.favourite.ui.store.FavouriteStore.State
 import javax.inject.Inject
 
 class FavouriteViewModel @Inject constructor(
-    private val router: FavouriteRouter,
+    router: FavouriteRouter,
     store: FavouriteStore
-) : BaseViewModel<State, Event, Action>(store) {
-
-    fun processNavigation(event: Event.Navigation) {
-        when (event) {
-            Event.Navigation.Home -> router.navHome()
-            is Event.Navigation.Image -> router.navToImage(event.uuid)
-            is Event.Navigation.User -> router.navToUser(event.username)
-        }
-    }
-}
+) : BaseViewModel<State, Event, Action, Navigation>(store, router)
diff --git a/...avourite/src/main/java/st/slex/csplashscreen/feature/favourite/ui/store/FavouriteStore.kt b/...avourite/src/main/java/st/slex/csplashscreen/feature/favourite/ui/store/FavouriteStore.kt
@@ -20,7 +20,7 @@ interface FavouriteStore : Store<State, Event, Action> {
     sealed interface Event : Store.Event {
 
         @Stable
-        sealed interface Navigation : Event {
+        sealed interface Navigation : Event, Store.Event.Navigation {
 
             @Stable
             data class User(

diff --git a/feature/home/src/main/java/st/slex/csplashscreen/feature/home/di/HomeModule.kt b/feature/home/src/main/java/st/slex/csplashscreen/feature/home/di/HomeModule.kt
@@ -2,7 +2,7 @@ package st.slex.csplashscreen.feature.home.di
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
-import com.stslex93.notes.core.ui.base.ViewModelFactory
+import st.slex.csplashscreen.core.ui.base.ViewModelFactory
 import dagger.Binds
 import dagger.Module
 import dagger.multibindings.IntoMap

diff --git a/feature/home/src/main/java/st/slex/csplashscreen/feature/home/navigation/HomeGraph.kt b/feature/home/src/main/java/st/slex/csplashscreen/feature/home/navigation/HomeGraph.kt
@@ -35,7 +35,7 @@ fun NavGraphBuilder.homeGraph(
 
         viewModel.event.CollectAsEvent { event ->
             when (event) {
-                is HomeStore.Event.Navigation -> viewModel.processNavigation(event)
+                is HomeStore.Event.Navigation -> viewModel.navigate(event)
             }
         }
 

diff --git a/feature/home/src/main/java/st/slex/csplashscreen/feature/home/navigation/HomeRouter.kt b/feature/home/src/main/java/st/slex/csplashscreen/feature/home/navigation/HomeRouter.kt
@@ -1,11 +1,6 @@
 package st.slex.csplashscreen.feature.home.navigation
 
-interface HomeRouter {
-
-    fun navToProfile(username: String)
-
-    fun navToImage(uuid: String)
-
-    fun navToCollection(uuid: String)
-}
+import st.slex.csplashscreen.core.ui.mvi.Router
+import st.slex.csplashscreen.feature.home.ui.store.HomeStore
 
+interface HomeRouter : Router<HomeStore.Event.Navigation>
diff --git a/feature/home/src/main/java/st/slex/csplashscreen/feature/home/navigation/HomeRouterImpl.kt b/feature/home/src/main/java/st/slex/csplashscreen/feature/home/navigation/HomeRouterImpl.kt
@@ -2,21 +2,30 @@ package st.slex.csplashscreen.feature.home.navigation
 
 import st.slex.csplashscreen.core.navigation.NavigationScreen
 import st.slex.csplashscreen.core.ui.di.Navigator
+import st.slex.csplashscreen.feature.home.ui.store.HomeStore.Event.Navigation
 import javax.inject.Inject
 
 class HomeRouterImpl @Inject constructor(
     private val navigator: Navigator
 ) : HomeRouter {
 
-    override fun navToProfile(username: String) {
-        navigator(NavigationScreen.UserScreen(username))
+    override fun invoke(event: Navigation) {
+        when (event) {
+            is Navigation.Collection -> navToCollection(event)
+            is Navigation.Image -> navToImage(event)
+            is Navigation.User -> navToProfile(event)
+        }
     }
 
-    override fun navToImage(uuid: String) {
-        navigator(NavigationScreen.ImageDetailScreen(uuid))
+    private fun navToProfile(event: Navigation.User) {
+        navigator(NavigationScreen.UserScreen(event.username))
     }
 
-    override fun navToCollection(uuid: String) {
-        navigator(NavigationScreen.CollectionScreen(uuid))
+    private fun navToImage(event: Navigation.Image) {
+        navigator(NavigationScreen.ImageDetailScreen(event.uuid))
+    }
+
+    private fun navToCollection(event: Navigation.Collection) {
+        navigator(NavigationScreen.CollectionScreen(event.uuid))
     }
 }
diff --git a/feature/home/src/main/java/st/slex/csplashscreen/feature/home/ui/HomeViewModel.kt b/feature/home/src/main/java/st/slex/csplashscreen/feature/home/ui/HomeViewModel.kt
@@ -5,19 +5,11 @@ import st.slex.csplashscreen.feature.home.navigation.HomeRouter
 import st.slex.csplashscreen.feature.home.ui.store.HomeStore
 import st.slex.csplashscreen.feature.home.ui.store.HomeStore.Action
 import st.slex.csplashscreen.feature.home.ui.store.HomeStore.Event
+import st.slex.csplashscreen.feature.home.ui.store.HomeStore.Event.Navigation
 import st.slex.csplashscreen.feature.home.ui.store.HomeStore.State
 import javax.inject.Inject
 
 class HomeViewModel @Inject constructor(
-    private val router: HomeRouter,
+    router: HomeRouter,
     store: HomeStore
-) : BaseViewModel<State, Event, Action>(store) {
-
-    fun processNavigation(event: Event.Navigation) {
-        when (event) {
-            is Event.Navigation.Collection -> router.navToCollection(event.uuid)
-            is Event.Navigation.Image -> router.navToImage(event.uuid)
-            is Event.Navigation.User -> router.navToProfile(event.username)
-        }
-    }
-}
+) : BaseViewModel<State, Event, Action, Navigation>(store, router)
diff --git a/feature/home/src/main/java/st/slex/csplashscreen/feature/home/ui/store/HomeStore.kt b/feature/home/src/main/java/st/slex/csplashscreen/feature/home/ui/store/HomeStore.kt
@@ -22,7 +22,7 @@ interface HomeStore : Store<State, Event, Action> {
     sealed interface Event : Store.Event {
 
         @Stable
-        sealed interface Navigation : Event {
+        sealed interface Navigation : Event, Store.Event.Navigation {
 
             @Stable
             data class User(

diff --git a/.../src/main/java/st/slex/csplashscreen/feature/feature_photo_detail/di/ImageDetailModule.kt b/.../src/main/java/st/slex/csplashscreen/feature/feature_photo_detail/di/ImageDetailModule.kt
@@ -2,7 +2,7 @@ package st.slex.csplashscreen.feature.feature_photo_detail.di
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
-import com.stslex93.notes.core.ui.base.ViewModelFactory
+import st.slex.csplashscreen.core.ui.base.ViewModelFactory
 import dagger.Binds
 import dagger.Module
 import dagger.multibindings.IntoMap

diff --git a/...in/java/st/slex/csplashscreen/feature/feature_photo_detail/navigation/ImageDetailGraph.kt b/...in/java/st/slex/csplashscreen/feature/feature_photo_detail/navigation/ImageDetailGraph.kt
@@ -41,7 +41,7 @@ fun NavGraphBuilder.imageDetailGraph(
 
         viewModel.event.CollectAsEvent { event ->
             when (event) {
-                is ImageDetailStore.Event.Navigation -> viewModel.processNavigation(event)
+                is ImageDetailStore.Event.Navigation -> viewModel.navigate(event)
             }
         }
 

diff --git a/...n/java/st/slex/csplashscreen/feature/feature_photo_detail/navigation/ImageDetailRouter.kt b/...n/java/st/slex/csplashscreen/feature/feature_photo_detail/navigation/ImageDetailRouter.kt
@@ -1,9 +1,6 @@
 package st.slex.csplashscreen.feature.feature_photo_detail.navigation
 
-interface ImageDetailRouter {
-
-    fun navToSearch(tag: String)
-
-    fun navToProfile(username: String)
-}
+import st.slex.csplashscreen.core.ui.mvi.Router
+import st.slex.csplashscreen.feature.feature_photo_detail.ui.store.ImageDetailStore.Event.Navigation
 
+interface ImageDetailRouter : Router<Navigation>