Cleaned up

nsmirosh · Oct 15, 2024 · 095d5dc · 095d5dc
1 parent 305c5ac
commit 095d5dc
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 67 deletions.
diff --git a/app/src/main/java/nick/mirosh/newsapp/data/repository/NewsRepository.kt b/app/src/main/java/nick/mirosh/newsapp/data/repository/NewsRepository.kt
@@ -2,7 +2,7 @@ package nick.mirosh.newsapp.data.repository
 
 import nick.mirosh.newsapp.data.database.ArticleDao
 import nick.mirosh.newsapp.domain.ErrorType
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.repository.NewsRepository
 import nick.mirosh.newsapp.domain.mapper.news.DTOtoDatabaseArticleMapper
 import nick.mirosh.newsapp.domain.mapper.news.DatabaseToDomainArticleMapper
@@ -21,43 +21,43 @@ class NewsRepositoryImpl @Inject constructor(
     private val databaseToDomainArticleMapper: DatabaseToDomainArticleMapper,
     private val dtoToDatabaseArticleMapper: DTOtoDatabaseArticleMapper,
 ) : NewsRepository {
-    override suspend fun getNewsArticles(): Resource<List<Article>> {
+    override suspend fun getNewsArticles(): Result<List<Article>> {
         return try {
             newsRemoteDataSource?.getHeadlines()?.let {
                 newsLocalDataSource.insertAll(dtoToDatabaseArticleMapper.map(it))
             }
-            Resource.Success(
+            Result.Success(
                 databaseToDomainArticleMapper.map(getAllArticlesFromDb())
             )
         } catch (e: Exception) {
             e.logStackTrace(tag)
-            Resource.Error(ErrorType.General)
+            Result.Error(ErrorType.General)
         }
     }
 
 
     override suspend fun getFavoriteArticles() =
         try {
-            Resource.Success(
+            Result.Success(
                 databaseToDomainArticleMapper.map(
                     newsLocalDataSource.getLikedArticles()
                 )
             )
         } catch (e: Exception) {
             e.logStackTrace(tag)
-            Resource.Error(ErrorType.General)
+            Result.Error(ErrorType.General)
         }
 
     override suspend fun updateArticle(article: Article) =
         try {
             val updatedRowId = newsLocalDataSource.insert(article.asDatabaseModel())
             if (updatedRowId != -1L)
-                Resource.Success(article)
+                Result.Success(article)
             else
-                Resource.Error(ErrorType.General)
+                Result.Error(ErrorType.General)
         } catch (e: Exception) {
             e.logStackTrace(tag)
-            Resource.Error(ErrorType.General)
+            Result.Error(ErrorType.General)
         }
 
     private suspend fun getAllArticlesFromDb() =

diff --git a/app/src/main/java/nick/mirosh/newsapp/domain/Resource.kt b/app/src/main/java/nick/mirosh/newsapp/domain/Resource.kt
diff --git a/app/src/main/java/nick/mirosh/newsapp/domain/Result.kt b/app/src/main/java/nick/mirosh/newsapp/domain/Result.kt
@@ -0,0 +1,21 @@
+package nick.mirosh.newsapp.domain
+
+/**
+ * Represents a result that can either contain successful data or an error.
+ *
+ */
+sealed class Result<out T> {
+    /**
+     * Represents successful data.
+     *
+     * @property data Data of generic type T.
+     */
+    data class Success<out T>(val data: T) : Result<T>()
+
+    /**
+     * Represents a failure.
+     *
+     * @property error The type of error, represented by ErrorType.
+     */
+    data class Error(val error: ErrorType) : Result<Nothing>()
+}
diff --git a/app/src/main/java/nick/mirosh/newsapp/domain/feed/repository/NewsRepository.kt b/app/src/main/java/nick/mirosh/newsapp/domain/feed/repository/NewsRepository.kt
@@ -1,10 +1,10 @@
 package nick.mirosh.newsapp.domain.feed.repository
 
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.model.Article
 
 interface NewsRepository {
-    suspend fun getNewsArticles(): Resource<List<Article>>
-    suspend fun getFavoriteArticles(): Resource<List<Article>>
-    suspend fun updateArticle(article: Article): Resource<Article>
+    suspend fun getNewsArticles(): Result<List<Article>>
+    suspend fun getFavoriteArticles(): Result<List<Article>>
+    suspend fun updateArticle(article: Article): Result<Article>
 }
diff --git a/app/src/main/java/nick/mirosh/newsapp/domain/feed/usecase/FetchArticlesUsecase.kt b/app/src/main/java/nick/mirosh/newsapp/domain/feed/usecase/FetchArticlesUsecase.kt
@@ -4,7 +4,7 @@ import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.withContext
 import nick.mirosh.newsapp.di.IoDispatcher
 import nick.mirosh.newsapp.di.Universal
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.model.Article
 import nick.mirosh.newsapp.domain.feed.repository.NewsRepository
 import javax.inject.Inject
@@ -14,7 +14,7 @@ class FetchArticlesUsecase @Inject constructor(
     @IoDispatcher private val coroutineDispatcher: CoroutineDispatcher,
 ) {
 
-    suspend operator fun invoke(): Resource<List<Article>> {
+    suspend operator fun invoke(): Result<List<Article>> {
         return withContext(coroutineDispatcher) {
             repository.getNewsArticles()
         }

diff --git a/app/src/main/java/nick/mirosh/newsapp/domain/feed/usecase/LikeArticleUsecase.kt b/app/src/main/java/nick/mirosh/newsapp/domain/feed/usecase/LikeArticleUsecase.kt
@@ -4,7 +4,7 @@ import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.withContext
 import nick.mirosh.newsapp.di.Cache
 import nick.mirosh.newsapp.di.IoDispatcher
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.model.Article
 import nick.mirosh.newsapp.domain.feed.repository.NewsRepository
 import javax.inject.Inject
@@ -14,7 +14,7 @@ class LikeArticleUsecase @Inject constructor(
     @IoDispatcher private val coroutineDispatcher: CoroutineDispatcher,
 ) {
 
-    suspend operator fun invoke(article: Article): Resource<Article> {
+    suspend operator fun invoke(article: Article): Result<Article> {
         return withContext(coroutineDispatcher) {
             repository.updateArticle(article.copy(liked = !article.liked))
         }

diff --git a/...src/main/java/nick/mirosh/newsapp/domain/usecase/articles/FetchFavoriteArticlesUsecase.kt b/...src/main/java/nick/mirosh/newsapp/domain/usecase/articles/FetchFavoriteArticlesUsecase.kt
@@ -4,7 +4,7 @@ import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.withContext
 import nick.mirosh.newsapp.di.Cache
 import nick.mirosh.newsapp.di.IoDispatcher
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.model.Article
 import nick.mirosh.newsapp.domain.feed.repository.NewsRepository
 import javax.inject.Inject
@@ -14,7 +14,7 @@ class FetchFavoriteArticlesUsecase @Inject constructor(
     @IoDispatcher private val coroutineDispatcher: CoroutineDispatcher,
 ) {
 
-    suspend operator fun invoke(): Resource<List<Article>> {
+    suspend operator fun invoke(): Result<List<Article>> {
         return withContext(coroutineDispatcher) {
             repository.getFavoriteArticles()
         }

diff --git a/app/src/main/java/nick/mirosh/newsapp/ui/FeedViewModel.kt b/app/src/main/java/nick/mirosh/newsapp/ui/FeedViewModel.kt
@@ -7,7 +7,7 @@ import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.launch
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.model.Article
 import nick.mirosh.newsapp.domain.feed.usecase.FetchArticlesUsecase
 import nick.mirosh.newsapp.domain.feed.usecase.LikeArticleUsecase
@@ -44,26 +44,26 @@ class FeedViewModel @Inject constructor(
     private suspend fun fetchArticles() {
         _uiState.value = FeedUIState.Loading
         _uiState.value = when (val result = fetchArticlesUsecase()) {
-            is Resource.Success -> {
+            is Result.Success -> {
                 _articles.clear()
                 _articles.addAll(result.data)
                 FeedUIState.Feed(articles)
             }
 
-            is Resource.Error -> FeedUIState.Failed
+            is Result.Error -> FeedUIState.Failed
         }
     }
 
     //https://stackoverflow.com/questions/74699081/jetpack-compose-lazy-column-all-items-recomposes-when-a-single-item-update
     fun onLikeClick(article: Article) {
         viewModelScope.launch {
             when (val result = likeArticleUsecase(article)) {
-                is Resource.Success -> {
+                is Result.Success -> {
                     val index = articles.indexOfFirst { it.url == result.data.url }
                     _articles[index] = result.data
                 }
 
-                is Resource.Error -> {
+                is Result.Error -> {
                     MyLogger.e("MainViewModel", "Error: ${result.error}")
                 }
             }

diff --git a/app/src/main/java/nick/mirosh/newsapp/ui/favorite_articles/FavoriteArticlesViewModel.kt b/app/src/main/java/nick/mirosh/newsapp/ui/favorite_articles/FavoriteArticlesViewModel.kt
@@ -6,7 +6,7 @@ import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.launch
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.usecase.articles.FetchFavoriteArticlesUsecase
 import nick.mirosh.newsapp.utils.MyLogger
 import javax.inject.Inject
@@ -22,13 +22,13 @@ class FavoriteArticlesViewModel @Inject constructor(
     init {
         viewModelScope.launch {
             when (val result = fetchFavoriteArticlesUsecase()) {
-                is Resource.Success ->
+                is nick.mirosh.newsapp.domain.Resource.Result.Success ->
                     _uiState.value = if (result.data.isEmpty())
                         FavoriteArticlesUIState.FavoriteArticlesEmpty
                     else
                         FavoriteArticlesUIState.FavoriteArticles(result.data)
 
-                is Resource.Error -> {
+                is nick.mirosh.newsapp.domain.Resource.Result.Error -> {
                     _uiState.value = FavoriteArticlesUIState.Failed
                     MyLogger.e("FavoriteArticlesViewModel", "Error = ${result.error}")
                 }

diff --git a/app/src/test/java/nick/mirosh/newsapp/FavoriteArticlesViewModelTest.kt b/app/src/test/java/nick/mirosh/newsapp/FavoriteArticlesViewModelTest.kt
@@ -4,7 +4,7 @@ import kotlinx.coroutines.flow.take
 import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.test.runTest
 import nick.mirosh.newsapp.domain.ErrorType
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.model.Article
 import nick.mirosh.newsapp.domain.usecase.articles.FetchFavoriteArticlesUsecase
 import nick.mirosh.newsapp.helpers.MainDispatcherRule
@@ -35,7 +35,7 @@ class FavoriteArticlesViewModelTest {
     fun init_withEmptyArticleResponse_sends_FavoriteArticlesEmptyEvent_toTheUI() = runTest {
 
         //Arrange
-        val result = Resource.Success(listOf<Article>())
+        val result = Result.Success(listOf<Article>())
         `when`(fetchFavoriteArticlesUsecase.invoke()).thenReturn(result)
 
         //Act
@@ -52,7 +52,7 @@ class FavoriteArticlesViewModelTest {
     fun init_withEmptyArticleResponse_sends_FavoriteArticlesEvent_toTheUI() = runTest {
 
         //Arrange
-        val result = Resource.Success(listOf(likedArticle))
+        val result = Result.Success(listOf(likedArticle))
         `when`(fetchFavoriteArticlesUsecase.invoke()).thenReturn(result)
 
         //Act
@@ -69,7 +69,7 @@ class FavoriteArticlesViewModelTest {
     fun init_withEmptyArticleResponse_sends_Error_toTheUI() = runTest {
 
         //Arrange
-        val result = Resource.Error(ErrorType.General)
+        val result = Result.Error(ErrorType.General)
         `when`(fetchFavoriteArticlesUsecase.invoke()).thenReturn(result)
 
         //Act

diff --git a/app/src/test/java/nick/mirosh/newsapp/FeedViewModelTest.kt b/app/src/test/java/nick/mirosh/newsapp/FeedViewModelTest.kt
@@ -1,20 +1,14 @@
 package nick.mirosh.newsapp
 
-import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.cancel
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.flow
 import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.flow.take
 import kotlinx.coroutines.flow.toList
-import kotlinx.coroutines.test.StandardTestDispatcher
-import kotlinx.coroutines.test.UnconfinedTestDispatcher
 import kotlinx.coroutines.test.advanceUntilIdle
-import kotlinx.coroutines.test.resetMain
 import kotlinx.coroutines.test.runTest
-import kotlinx.coroutines.test.setMain
 import nick.mirosh.newsapp.domain.ErrorType
-import nick.mirosh.newsapp.domain.Resource
+import nick.mirosh.newsapp.domain.Result
 import nick.mirosh.newsapp.domain.feed.model.Article
 import nick.mirosh.newsapp.domain.feed.usecase.FetchArticlesUsecase
 import nick.mirosh.newsapp.domain.feed.usecase.LikeArticleUsecase
@@ -58,7 +52,7 @@ class FeedViewModelTest {
     ) {
         //Arrange
         val articles = listOf<Article>()
-        val result = Resource.Success(articles)
+        val result = Result.Success(articles)
         `when`(fetchArticlesUsecase.invoke()).thenReturn(result)
         `when`(networkConnectivityUseCase.invoke()).thenReturn(flowOf(true))
 
@@ -77,7 +71,7 @@ class FeedViewModelTest {
     @Test
     fun init_getsTheArticleListWithFailure_sendsFailedEventToUI() = runTest {
         //Arrange
-        val result = Resource.Error(ErrorType.General)
+        val result = Result.Error(ErrorType.General)
         `when`(fetchArticlesUsecase.invoke()).thenReturn(result)
         `when`(networkConnectivityUseCase.invoke()).thenReturn(flowOf ( true ))
         val expected = FeedUIState.Failed
@@ -97,11 +91,11 @@ class FeedViewModelTest {
     @Test
     fun onLikeClick_withValidArticle_updatesArticlesList() = runTest {
         //Arrange
-        val fetchArticlesResult = Resource.Success(listOf(notLikedArticle))
+        val fetchArticlesResult = Result.Success(listOf(notLikedArticle))
         `when`(fetchArticlesUsecase.invoke()).thenReturn(fetchArticlesResult)
         `when`(networkConnectivityUseCase.invoke()).thenReturn(flow { emit(true) })
 
-        val result = Resource.Success(likedArticle)
+        val result = Result.Success(likedArticle)
         `when`(likeArticleUsecase.invoke(notLikedArticle)).thenReturn(result)
         val expected = listOf(likedArticle)
 
@@ -125,11 +119,11 @@ class FeedViewModelTest {
     @Test
     fun onLikeClick_withFailure_doesNotUpdateArticleList() = runTest {
         //Arrange
-        val fetchArticlesResult = Resource.Success(listOf(notLikedArticle))
+        val fetchArticlesResult = Result.Success(listOf(notLikedArticle))
         `when`(fetchArticlesUsecase.invoke()).thenReturn(fetchArticlesResult)
         `when`(networkConnectivityUseCase.invoke()).thenReturn(flow { emit(true) })
 
-        val result = Resource.Error(ErrorType.General)
+        val result = Result.Error(ErrorType.General)
         `when`(likeArticleUsecase.invoke(notLikedArticle)).thenReturn(result)
         val expected = listOf(notLikedArticle)