A fully functional Android app built entirely with Kotlin and Jetpack Compose
Move new UseCase and tests into separate files
Don Turnere536c396f9bf
diff --git a/core/domain/src/main/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCase.kt b/core/domain/src/main/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCase.ktindex fdb9eb6d9..db274bbbd 100644--- a/core/domain/src/main/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCase.kt+++ b/core/domain/src/main/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCase.kt@@ -24,11 +24,7 @@ import com.google.samples.apps.nowinandroid.core.model.data.NewsResourceimport com.google.samples.apps.nowinandroid.core.model.data.UserDataimport kotlinx.coroutines.flow.Flowimport kotlinx.coroutines.flow.combine-import kotlinx.coroutines.flow.distinctUntilChangedimport kotlinx.coroutines.flow.filterNot-import kotlinx.coroutines.flow.flatMapLatest-import kotlinx.coroutines.flow.flowOf-import kotlinx.coroutines.flow.mapimport javax.inject.Inject/**@@ -55,56 +51,6 @@ class GetUserNewsResourcesUseCase @Inject constructor(}.mapToUserNewsResources(userDataRepository.userData)}-class GetFollowedUserNewsResourcesUseCase @Inject constructor(- private val userDataRepository: UserDataRepository,- val getUserNewsResources: GetUserNewsResourcesUseCase,-) {- /**- * Returns a list of UserNewsResources for topics which the user is following- */- operator fun invoke(): Flow<List<UserNewsResource>> =- /**- * This sequence of flow transformation functions does the following:- *- * - map: maps the user data into a set of followed topic IDs or null if we should return- * an empty list- * - distinctUntilChanged: will only emit a set of followed topic IDs if it's changed. This- * avoids calling potentially expensive operations (like setting up a new flow) when nothing- * has changed.- * - flatMapLatest: getUserNewsResources returns a flow, so we have a flow inside a- * flow. flatMapLatest moves the inner flow (the one we want to return) to the outer flow- * and cancels any previous flows created by getUserNewsResources.- */- userDataRepository.userData- .map { userData ->- if (shouldShowEmptyFeed(userData)) {- null- } else {- userData.followedTopics- }- }- .distinctUntilChanged()- .flatMapLatest { followedTopics ->- if (followedTopics == null) {- flowOf(emptyList())- } else {- getUserNewsResources(filterTopicIds = followedTopics)- }- }-- /**- * If the user hasn't completed the onboarding and hasn't selected any interests- * show an empty news list to clearly demonstrate that their selections affect the- * news articles they will see.- *- * Note: It should not be possible for the user to get into a state where the onboarding- * is not displayed AND they haven't followed any topics, however, this method is to safeguard- * against that scenario in future.- */- private fun shouldShowEmptyFeed(userData: UserData) =- !userData.shouldHideOnboarding && userData.followedTopics.isEmpty()-}-private fun Flow<List<NewsResource>>.mapToUserNewsResources(userDataStream: Flow<UserData>,): Flow<List<UserNewsResource>> =diff --git a/core/domain/src/test/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCaseTest.kt b/core/domain/src/test/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCaseTest.ktindex 8674c4026..32ee8773c 100644--- a/core/domain/src/test/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCaseTest.kt+++ b/core/domain/src/test/java/com/google/samples/apps/nowinandroid/core/domain/GetUserNewsResourcesUseCaseTest.kt@@ -83,55 +83,6 @@ class GetUserNewsResourcesUseCaseTest {}}-class GetFollowedUserNewsResourcesUseCaseTest {-- @get:Rule- val mainDispatcherRule = MainDispatcherRule()-- private val newsRepository = TestNewsRepository()- private val userDataRepository = TestUserDataRepository()- private val getUserNewsResourcesUseCase =- GetUserNewsResourcesUseCase(newsRepository, userDataRepository)-- val useCase =- GetFollowedUserNewsResourcesUseCase(userDataRepository, getUserNewsResourcesUseCase)-- @Test- fun whenOnboardingShownAndNoTopicsFollowed_emptyListIsReturned() = runTest {- val followedNewsResources = useCase()-- // Send some news resources and empty user data- newsRepository.sendNewsResources(sampleNewsResources)- userDataRepository.setUserData(emptyUserData)-- // Check that an empty list is returned- assertEquals(- emptyList(),- followedNewsResources.first(),- )- }-- @Test- fun whenTopicsAreFollowed_correctNewsResourcesAreReturned() = runTest {- val followedNewsResources = useCase()-- // Send some news resources and user data with a followed topic- newsRepository.sendNewsResources(sampleNewsResources)-- val userData = emptyUserData.copy(- followedTopics = setOf(sampleTopic1.id),- )- userDataRepository.setUserData(userData)-- assertEquals(- sampleNewsResources- .filter { it.topics.contains(sampleTopic1) }- .mapToUserNewsResources(userData),- followedNewsResources.first(),- )- }-}-private val sampleTopic1 = Topic(id = "Topic1",name = "Headlines",diff --git a/feature/foryou/src/main/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModel.kt b/feature/foryou/src/main/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModel.ktindex 85268e894..259cc31f2 100644--- a/feature/foryou/src/main/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModel.kt+++ b/feature/foryou/src/main/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModel.kt@@ -21,13 +21,18 @@ import androidx.lifecycle.viewModelScopeimport com.google.samples.apps.nowinandroid.core.data.repository.UserDataRepositoryimport com.google.samples.apps.nowinandroid.core.data.util.SyncStatusMonitorimport com.google.samples.apps.nowinandroid.core.domain.GetFollowableTopicsUseCase-import com.google.samples.apps.nowinandroid.core.domain.GetFollowedUserNewsResourcesUseCase+import com.google.samples.apps.nowinandroid.core.domain.GetUserNewsResourcesUseCase+import com.google.samples.apps.nowinandroid.core.domain.model.UserNewsResource+import com.google.samples.apps.nowinandroid.core.model.data.UserDataimport com.google.samples.apps.nowinandroid.core.ui.NewsFeedUiStateimport dagger.hilt.android.lifecycle.HiltViewModelimport kotlinx.coroutines.flow.Flowimport kotlinx.coroutines.flow.SharingStartedimport kotlinx.coroutines.flow.StateFlowimport kotlinx.coroutines.flow.combine+import kotlinx.coroutines.flow.distinctUntilChanged+import kotlinx.coroutines.flow.flatMapLatest+import kotlinx.coroutines.flow.flowOfimport kotlinx.coroutines.flow.mapimport kotlinx.coroutines.flow.stateInimport kotlinx.coroutines.launch@@ -37,7 +42,7 @@ import javax.inject.Injectclass ForYouViewModel @Inject constructor(syncStatusMonitor: SyncStatusMonitor,private val userDataRepository: UserDataRepository,- getFollowedUserNewsResources: GetFollowedUserNewsResourcesUseCase,+ private val getUserNewsResources: GetUserNewsResourcesUseCase,getFollowableTopics: GetFollowableTopicsUseCase,) : ViewModel() {@@ -51,15 +56,13 @@ class ForYouViewModel @Inject constructor(initialValue = false,)- val feedState: StateFlow<NewsFeedUiState> =- getFollowedUserNewsResources().map {- NewsFeedUiState.Success(it)- }- .stateIn(- scope = viewModelScope,- started = SharingStarted.WhileSubscribed(5_000),- initialValue = NewsFeedUiState.Loading,- )+ val feedState: StateFlow<NewsFeedUiState> = getFollowedUserNewsResources()+ .map(NewsFeedUiState::Success)+ .stateIn(+ scope = viewModelScope,+ started = SharingStarted.WhileSubscribed(5_000),+ initialValue = NewsFeedUiState.Loading,+ )val onboardingUiState: StateFlow<OnboardingUiState> =combine(@@ -95,4 +98,66 @@ class ForYouViewModel @Inject constructor(userDataRepository.setShouldHideOnboarding(true)}}++ /**+ * This sequence of flow transformation functions does the following:+ *+ * - map: maps the user data into a set of followed topic IDs or null if we should return+ * an empty list+ * - distinctUntilChanged: will only emit a set of followed topic IDs if it's changed. This+ * avoids calling potentially expensive operations (like setting up a new flow) when nothing+ * has changed.+ * - flatMapLatest: getUserNewsResources returns a flow, so we have a flow inside a+ * flow. flatMapLatest moves the inner flow (the one we want to return) to the outer flow+ * and cancels any previous flows created by getUserNewsResources.+ */+ private fun getFollowedUserNewsResources(): Flow<List<UserNewsResource>> =+ userDataRepository.userData+ .map { userData ->+ if (userData.shouldShowEmptyFeed()) {+ null+ } else {+ userData.followedTopics+ }+ }+ .distinctUntilChanged()+ .flatMapLatest { followedTopics ->+ if (followedTopics == null) {+ flowOf(emptyList())+ } else {+ getUserNewsResources(filterTopicIds = followedTopics)+ }+ }}++// Alternative approach (not currently being called)+private fun Flow<UserData>.getFollowedUserNewsResources(+ getUserNewsResources: GetUserNewsResourcesUseCase,+): Flow<List<UserNewsResource>> =+ map { userData ->+ if (userData.shouldShowEmptyFeed()) {+ null+ } else {+ userData.followedTopics+ }+ }+ .distinctUntilChanged()+ .flatMapLatest { followedTopics ->+ if (followedTopics == null) {+ flowOf(emptyList())+ } else {+ getUserNewsResources(filterTopicIds = followedTopics)+ }+ }++/**+ * If the user hasn't completed the onboarding and hasn't selected any interests+ * show an empty news list to clearly demonstrate that their selections affect the+ * news articles they will see.+ *+ * Note: It should not be possible for the user to get into a state where the onboarding+ * is not displayed AND they haven't followed any topics, however, this method is to safeguard+ * against that scenario in future.+ */+private fun UserData.shouldShowEmptyFeed() =+ !shouldHideOnboarding && followedTopics.isEmpty()diff --git a/feature/foryou/src/test/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModelTest.kt b/feature/foryou/src/test/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModelTest.ktindex c335f7603..9e51758f0 100644--- a/feature/foryou/src/test/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModelTest.kt+++ b/feature/foryou/src/test/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouViewModelTest.kt@@ -17,7 +17,6 @@package com.google.samples.apps.nowinandroid.feature.foryouimport com.google.samples.apps.nowinandroid.core.domain.GetFollowableTopicsUseCase-import com.google.samples.apps.nowinandroid.core.domain.GetFollowedUserNewsResourcesUseCaseimport com.google.samples.apps.nowinandroid.core.domain.GetUserNewsResourcesUseCaseimport com.google.samples.apps.nowinandroid.core.domain.model.FollowableTopicimport com.google.samples.apps.nowinandroid.core.domain.model.UserNewsResource@@ -61,10 +60,6 @@ class ForYouViewModelTest {newsRepository = newsRepository,userDataRepository = userDataRepository,)- private val getFollowedUserNewsResourcesUseCase = GetFollowedUserNewsResourcesUseCase(- userDataRepository = userDataRepository,- getUserNewsResources = getUserNewsResourcesUseCase,- )private val getFollowableTopicsUseCase = GetFollowableTopicsUseCase(topicsRepository = topicsRepository,@@ -77,7 +72,7 @@ class ForYouViewModelTest {viewModel = ForYouViewModel(syncStatusMonitor = syncStatusMonitor,userDataRepository = userDataRepository,- getFollowedUserNewsResources = getFollowedUserNewsResourcesUseCase,+ getUserNewsResources = getUserNewsResourcesUseCase,getFollowableTopics = getFollowableTopicsUseCase,)}