Remove withContext, refactor duplicate methods (#907)

dturner · web-flow · commit 17da41e50e9f · 2023-02-28T11:22:45.000Z
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/Task.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/Task.kt
@@ -32,10 +32,10 @@ import java.util.UUID
  */
 @Entity(tableName = "tasks")
 data class Task @JvmOverloads constructor(
-    @ColumnInfo(name = "title") var title: String = "",
-    @ColumnInfo(name = "description") var description: String = "",
-    @ColumnInfo(name = "completed") var isCompleted: Boolean = false,
-    @PrimaryKey @ColumnInfo(name = "entryid") var id: String = UUID.randomUUID().toString()
+    @ColumnInfo(name = "title") val title: String = "",
+    @ColumnInfo(name = "description") val description: String = "",
+    @ColumnInfo(name = "completed") val isCompleted: Boolean = false,
+    @PrimaryKey @ColumnInfo(name = "entryid") val id: String = UUID.randomUUID().toString()
 ) {
 
     val titleForList: String
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/DefaultTasksRepository.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/DefaultTasksRepository.kt
@@ -17,20 +17,16 @@
 package com.example.android.architecture.blueprints.todoapp.data.source
 
 import com.example.android.architecture.blueprints.todoapp.data.Task
-import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.launch
-import kotlinx.coroutines.withContext
 
 /**
  * Default implementation of [TasksRepository]. Single entry point for managing tasks' data.
  */
 class DefaultTasksRepository(
     private val tasksRemoteDataSource: TasksDataSource,
     private val tasksLocalDataSource: TasksDataSource,
-    private val ioDispatcher: CoroutineDispatcher = Dispatchers.IO
 ) : TasksRepository {
 
     override suspend fun getTasks(forceUpdate: Boolean): List<Task> {
@@ -97,29 +93,17 @@ class DefaultTasksRepository(
         }
     }
 
-    override suspend fun completeTask(task: Task) {
-        coroutineScope {
-            launch { tasksRemoteDataSource.completeTask(task) }
-            launch { tasksLocalDataSource.completeTask(task) }
-        }
-    }
-
     override suspend fun completeTask(taskId: String) {
-        withContext(ioDispatcher) {
-            getTaskWithId(taskId)?.let { completeTask(it) }
-        }
-    }
-
-    override suspend fun activateTask(task: Task) = withContext<Unit>(ioDispatcher) {
         coroutineScope {
-            launch { tasksRemoteDataSource.activateTask(task) }
-            launch { tasksLocalDataSource.activateTask(task) }
+            launch { tasksRemoteDataSource.completeTask(taskId) }
+            launch { tasksLocalDataSource.completeTask(taskId) }
         }
     }
 
     override suspend fun activateTask(taskId: String) {
-        withContext(ioDispatcher) {
-            getTaskWithId(taskId)?.let { activateTask(it) }
+        coroutineScope {
+            launch { tasksRemoteDataSource.activateTask(taskId) }
+            launch { tasksLocalDataSource.activateTask(taskId) }
         }
     }
 
@@ -131,11 +115,9 @@ class DefaultTasksRepository(
     }
 
     override suspend fun deleteAllTasks() {
-        withContext(ioDispatcher) {
-            coroutineScope {
-                launch { tasksRemoteDataSource.deleteAllTasks() }
-                launch { tasksLocalDataSource.deleteAllTasks() }
-            }
+        coroutineScope {
+            launch { tasksRemoteDataSource.deleteAllTasks() }
+            launch { tasksLocalDataSource.deleteAllTasks() }
         }
     }
 
@@ -145,8 +127,4 @@ class DefaultTasksRepository(
             launch { tasksLocalDataSource.deleteTask(taskId) }
         }
     }
-
-    private suspend fun getTaskWithId(id: String): Task? {
-        return tasksLocalDataSource.getTask(id)
-    }
 }
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/TasksDataSource.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/TasksDataSource.kt
@@ -38,12 +38,8 @@ interface TasksDataSource {
 
     suspend fun saveTask(task: Task)
 
-    suspend fun completeTask(task: Task)
-
     suspend fun completeTask(taskId: String)
 
-    suspend fun activateTask(task: Task)
-
     suspend fun activateTask(taskId: String)
 
     suspend fun clearCompletedTasks()
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/TasksRepository.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/TasksRepository.kt
@@ -38,12 +38,8 @@ interface TasksRepository {
 
     suspend fun saveTask(task: Task)
 
-    suspend fun completeTask(task: Task)
-
     suspend fun completeTask(taskId: String)
 
-    suspend fun activateTask(task: Task)
-
     suspend fun activateTask(taskId: String)
 
     suspend fun clearCompletedTasks()
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TasksLocalDataSource.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TasksLocalDataSource.kt
@@ -18,16 +18,12 @@ package com.example.android.architecture.blueprints.todoapp.data.source.local
 
 import com.example.android.architecture.blueprints.todoapp.data.Task
 import com.example.android.architecture.blueprints.todoapp.data.source.TasksDataSource
-import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.withContext
 
 /**
  * Concrete implementation of a data source as a db.
  */
 class TasksLocalDataSource internal constructor(
-    private val tasksDao: TasksDao,
-    private val ioDispatcher: CoroutineDispatcher = Dispatchers.IO
+    private val tasksDao: TasksDao
 ) : TasksDataSource {
 
     override fun getTasksStream() = tasksDao.observeTasks()
@@ -42,43 +38,25 @@ class TasksLocalDataSource internal constructor(
         // NO-OP
     }
 
-    override suspend fun getTasks(): List<Task> = withContext(ioDispatcher) {
-        return@withContext tasksDao.getTasks()
-    }
+    override suspend fun getTasks(): List<Task> = tasksDao.getTasks()
 
-    override suspend fun getTask(taskId: String): Task? = withContext(ioDispatcher) {
-        return@withContext tasksDao.getTaskById(taskId)
-    }
+    override suspend fun getTask(taskId: String): Task? = tasksDao.getTaskById(taskId)
 
-    override suspend fun saveTask(task: Task) = withContext(ioDispatcher) {
-        tasksDao.insertTask(task)
-    }
-
-    override suspend fun completeTask(task: Task) = withContext(ioDispatcher) {
-        tasksDao.updateCompleted(task.id, true)
-    }
+    override suspend fun saveTask(task: Task) = tasksDao.insertTask(task)
 
-    override suspend fun completeTask(taskId: String) {
+    override suspend fun completeTask(taskId: String) =
         tasksDao.updateCompleted(taskId, true)
-    }
-
-    override suspend fun activateTask(task: Task) = withContext(ioDispatcher) {
-        tasksDao.updateCompleted(task.id, false)
-    }
 
-    override suspend fun activateTask(taskId: String) {
+    override suspend fun activateTask(taskId: String) =
         tasksDao.updateCompleted(taskId, false)
-    }
 
-    override suspend fun clearCompletedTasks() = withContext<Unit>(ioDispatcher) {
+    override suspend fun clearCompletedTasks() {
         tasksDao.deleteCompletedTasks()
     }
 
-    override suspend fun deleteAllTasks() = withContext(ioDispatcher) {
-        tasksDao.deleteTasks()
-    }
+    override suspend fun deleteAllTasks() = tasksDao.deleteTasks()
 
-    override suspend fun deleteTask(taskId: String) = withContext<Unit>(ioDispatcher) {
+    override suspend fun deleteTask(taskId: String) {
         tasksDao.deleteTaskById(taskId)
     }
 }
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/remote/TasksRemoteDataSource.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/remote/TasksRemoteDataSource.kt
@@ -80,22 +80,16 @@ object TasksRemoteDataSource : TasksDataSource {
         TASKS_SERVICE_DATA[task.id] = task
     }
 
-    override suspend fun completeTask(task: Task) {
-        val completedTask = Task(task.title, task.description, true, task.id)
-        TASKS_SERVICE_DATA[task.id] = completedTask
-    }
-
     override suspend fun completeTask(taskId: String) {
-        // Not required for the remote data source
-    }
-
-    override suspend fun activateTask(task: Task) {
-        val activeTask = Task(task.title, task.description, false, task.id)
-        TASKS_SERVICE_DATA[task.id] = activeTask
+        TASKS_SERVICE_DATA[taskId]?.let {
+            saveTask(it.copy(isCompleted = true))
+        }
     }
 
     override suspend fun activateTask(taskId: String) {
-        // Not required for the remote data source
+        TASKS_SERVICE_DATA[taskId]?.let {
+            saveTask(it.copy(isCompleted = true))
+        }
     }
 
     override suspend fun clearCompletedTasks() {
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/di/DataModules.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/di/DataModules.kt
@@ -31,7 +31,6 @@ import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.components.SingletonComponent
 import javax.inject.Qualifier
 import javax.inject.Singleton
-import kotlinx.coroutines.CoroutineDispatcher
 
 @Qualifier
 @Retention(AnnotationRetention.RUNTIME)
@@ -50,9 +49,8 @@ object RepositoryModule {
     fun provideTasksRepository(
         @RemoteTasksDataSource remoteDataSource: TasksDataSource,
         @LocalTasksDataSource localDataSource: TasksDataSource,
-        @IoDispatcher ioDispatcher: CoroutineDispatcher
     ): TasksRepository {
-        return DefaultTasksRepository(remoteDataSource, localDataSource, ioDispatcher)
+        return DefaultTasksRepository(remoteDataSource, localDataSource)
     }
 }
 
@@ -69,10 +67,9 @@ object DataSourceModule {
     @LocalTasksDataSource
     @Provides
     fun provideTasksLocalDataSource(
-        database: ToDoDatabase,
-        @IoDispatcher ioDispatcher: CoroutineDispatcher
+        database: ToDoDatabase
     ): TasksDataSource {
-        return TasksLocalDataSource(database.taskDao(), ioDispatcher)
+        return TasksLocalDataSource(database.taskDao())
     }
 }
 
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailViewModel.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailViewModel.kt
@@ -100,10 +100,10 @@ class TaskDetailViewModel @Inject constructor(
     fun setCompleted(completed: Boolean) = viewModelScope.launch {
         val task = uiState.value.task ?: return@launch
         if (completed) {
-            tasksRepository.completeTask(task)
+            tasksRepository.completeTask(task.id)
             showSnackbarMessage(R.string.task_marked_complete)
         } else {
-            tasksRepository.activateTask(task)
+            tasksRepository.activateTask(task.id)
             showSnackbarMessage(R.string.task_marked_active)
         }
     }
diff --git a/app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModel.kt b/app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModel.kt
@@ -113,10 +113,10 @@ class TasksViewModel @Inject constructor(
 
     fun completeTask(task: Task, completed: Boolean) = viewModelScope.launch {
         if (completed) {
-            tasksRepository.completeTask(task)
+            tasksRepository.completeTask(task.id)
             showSnackbarMessage(R.string.task_marked_complete)
         } else {
-            tasksRepository.activateTask(task)
+            tasksRepository.activateTask(task.id)
             showSnackbarMessage(R.string.task_marked_active)
         }
     }
diff --git a/app/src/sharedTest/java/com/example/android/architecture/blueprints/todoapp/data/source/FakeRepository.kt b/app/src/sharedTest/java/com/example/android/architecture/blueprints/todoapp/data/source/FakeRepository.kt
@@ -86,31 +86,16 @@ class FakeRepository : TasksRepository {
         }
     }
 
-    override suspend fun completeTask(task: Task) {
-        val completedTask = Task(task.title, task.description, true, task.id)
-        _savedTasks.update { tasks ->
-            val newTasks = LinkedHashMap<String, Task>(tasks)
-            newTasks[task.id] = completedTask
-            newTasks
-        }
-    }
-
     override suspend fun completeTask(taskId: String) {
-        // Not required for the remote data source.
-        throw NotImplementedError()
-    }
-
-    override suspend fun activateTask(task: Task) {
-        val activeTask = Task(task.title, task.description, false, task.id)
-        _savedTasks.update { tasks ->
-            val newTasks = LinkedHashMap<String, Task>(tasks)
-            newTasks[task.id] = activeTask
-            newTasks
+        _savedTasks.value[taskId]?.let {
+            saveTask(it.copy(isCompleted = true))
         }
     }
 
     override suspend fun activateTask(taskId: String) {
-        throw NotImplementedError()
+        _savedTasks.value[taskId]?.let {
+            saveTask(it.copy(isCompleted = false))
+        }
     }
 
     override suspend fun clearCompletedTasks() {
diff --git a/app/src/sharedTest/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TasksLocalDataSourceTest.kt b/app/src/sharedTest/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TasksLocalDataSourceTest.kt
@@ -24,7 +24,6 @@ import androidx.test.filters.MediumTest
 import com.example.android.architecture.blueprints.todoapp.MainCoroutineRule
 import com.example.android.architecture.blueprints.todoapp.data.Task
 import com.example.android.architecture.blueprints.todoapp.data.source.TasksDataSource
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.test.runTest
 import org.hamcrest.CoreMatchers.`is`
@@ -66,7 +65,7 @@ class TasksLocalDataSourceTest {
             .allowMainThreadQueries()
             .build()
 
-        localDataSource = TasksLocalDataSource(database.taskDao(), Dispatchers.Main)
+        localDataSource = TasksLocalDataSource(database.taskDao())
     }
 
     @After
@@ -96,7 +95,7 @@ class TasksLocalDataSourceTest {
         localDataSource.saveTask(newTask)
 
         // When completed in the persistent repository
-        localDataSource.completeTask(newTask)
+        localDataSource.completeTask(newTask.id)
         val task = localDataSource.getTask(newTask.id)
 
         // Then the task can be retrieved from the persistent repository and is complete
@@ -110,7 +109,7 @@ class TasksLocalDataSourceTest {
         val newTask = Task("Some title", "Some description", true)
         localDataSource.saveTask(newTask)
 
-        localDataSource.activateTask(newTask)
+        localDataSource.activateTask(newTask.id)
 
         // Then the task can be retrieved from the persistent repository and is active
         val task = localDataSource.getTask(newTask.id)
@@ -126,9 +125,9 @@ class TasksLocalDataSourceTest {
         val newTask2 = Task("title2")
         val newTask3 = Task("title3")
         localDataSource.saveTask(newTask1)
-        localDataSource.completeTask(newTask1)
+        localDataSource.completeTask(newTask1.id)
         localDataSource.saveTask(newTask2)
-        localDataSource.completeTask(newTask2)
+        localDataSource.completeTask(newTask2.id)
         localDataSource.saveTask(newTask3)
         // When completed tasks are cleared in the repository
         localDataSource.clearCompletedTasks()
diff --git a/app/src/test/java/com/example/android/architecture/blueprints/todoapp/FakeFailingTasksRemoteDataSource.kt b/app/src/test/java/com/example/android/architecture/blueprints/todoapp/FakeFailingTasksRemoteDataSource.kt
@@ -50,18 +50,10 @@ object FakeFailingTasksRemoteDataSource : TasksDataSource {
         TODO("not implemented")
     }
 
-    override suspend fun completeTask(task: Task) {
-        TODO("not implemented")
-    }
-
     override suspend fun completeTask(taskId: String) {
         TODO("not implemented")
     }
 
-    override suspend fun activateTask(task: Task) {
-        TODO("not implemented")
-    }
-
     override suspend fun activateTask(taskId: String) {
         TODO("not implemented")
     }
diff --git a/app/src/test/java/com/example/android/architecture/blueprints/todoapp/data/source/DefaultTasksRepositoryTest.kt b/app/src/test/java/com/example/android/architecture/blueprints/todoapp/data/source/DefaultTasksRepositoryTest.kt
diff --git a/app/src/test/java/com/example/android/architecture/blueprints/todoapp/data/source/FakeDataSource.kt b/app/src/test/java/com/example/android/architecture/blueprints/todoapp/data/source/FakeDataSource.kt
diff --git a/app/src/test/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailViewModelTest.kt b/app/src/test/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailViewModelTest.kt

Original file line number	Diff line number	Diff line change
`@@ -100,10 +100,10 @@ class TaskDetailViewModel @Inject constructor(`
`100`	`100`	`fun setCompleted(completed: Boolean) = viewModelScope.launch {`
`101`	`101`	`val task = uiState.value.task ?: return@launch`
`102`	`102`	`if (completed) {`
`103`		`- tasksRepository.completeTask(task)`
	`103`	`+ tasksRepository.completeTask(task.id)`
`104`	`104`	`showSnackbarMessage(R.string.task_marked_complete)`
`105`	`105`	`} else {`
`106`		`- tasksRepository.activateTask(task)`
	`106`	`+ tasksRepository.activateTask(task.id)`
`107`	`107`	`showSnackbarMessage(R.string.task_marked_active)`
`108`	`108`	`}`
`109`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,10 +113,10 @@ class TasksViewModel @Inject constructor(`
`113`	`113`
`114`	`114`	`fun completeTask(task: Task, completed: Boolean) = viewModelScope.launch {`
`115`	`115`	`if (completed) {`
`116`		`- tasksRepository.completeTask(task)`
	`116`	`+ tasksRepository.completeTask(task.id)`
`117`	`117`	`showSnackbarMessage(R.string.task_marked_complete)`
`118`	`118`	`} else {`
`119`		`- tasksRepository.activateTask(task)`
	`119`	`+ tasksRepository.activateTask(task.id)`
`120`	`120`	`showSnackbarMessage(R.string.task_marked_active)`
`121`	`121`	`}`
`122`	`122`	`}`