Cleanup variable and function names

Author: ceruleanotter

app/src/main/java/com/example/android/architecture/blueprints/todoapp/addedittask/AddEditTaskFragment.kt

@@ -27,7 +27,7 @@ import com.example.android.architecture.blueprints.todoapp.EventObserver
 import com.example.android.architecture.blueprints.todoapp.R
 import com.example.android.architecture.blueprints.todoapp.databinding.AddtaskFragBinding
 import com.example.android.architecture.blueprints.todoapp.tasks.ADD_EDIT_RESULT_OK
-import com.example.android.architecture.blueprints.todoapp.util.getVmFactory
+import com.example.android.architecture.blueprints.todoapp.util.getViewModelFactory
 import com.example.android.architecture.blueprints.todoapp.util.setupRefreshLayout
 import com.example.android.architecture.blueprints.todoapp.util.setupSnackbar
 import com.google.android.material.snackbar.Snackbar
@@ -41,7 +41,9 @@ class AddEditTaskFragment : Fragment() {
 
     private val args: AddEditTaskFragmentArgs by navArgs()
 
-    private val viewModel by viewModels<AddEditTaskViewModel> { getVmFactory() }
+    private val viewModel by viewModels<AddEditTaskViewModel> {
+        getViewModelFactory()
+    }
 
     override fun onCreateView(
         inflater: LayoutInflater, container: ViewGroup?,
@@ -65,7 +67,7 @@ class AddEditTaskFragment : Fragment() {
     }
 
     private fun setupSnackbar() {
-        view?.setupSnackbar(this, viewModel.snackbarMessage, Snackbar.LENGTH_SHORT)
+        view?.setupSnackbar(this, viewModel.snackbarText, Snackbar.LENGTH_SHORT)
     }
 
     private fun setupNavigation() {

app/src/main/java/com/example/android/architecture/blueprints/todoapp/addedittask/AddEditTaskViewModel.kt

@@ -44,10 +44,10 @@ class AddEditTaskViewModel(
     val dataLoading: LiveData<Boolean> = _dataLoading
 
     private val _snackbarText = MutableLiveData<Event<Int>>()
-    val snackbarMessage: LiveData<Event<Int>> = _snackbarText
+    val snackbarText: LiveData<Event<Int>> = _snackbarText
 
-    private val _taskUpdated = MutableLiveData<Event<Unit>>()
-    val taskUpdatedEvent: LiveData<Event<Unit>> = _taskUpdated
+    private val _taskUpdatedEvent = MutableLiveData<Event<Unit>>()
+    val taskUpdatedEvent: LiveData<Event<Unit>> = _taskUpdatedEvent
 
     private var taskId: String? = null
 
@@ -124,7 +124,7 @@ class AddEditTaskViewModel(
 
     private fun createTask(newTask: Task) = viewModelScope.launch {
         tasksRepository.saveTask(newTask)
-        _taskUpdated.value = Event(Unit)
+        _taskUpdatedEvent.value = Event(Unit)
     }
 
     private fun updateTask(task: Task) {
@@ -133,7 +133,7 @@ class AddEditTaskViewModel(
         }
         viewModelScope.launch {
             tasksRepository.saveTask(task)
-            _taskUpdated.value = Event(Unit)
+            _taskUpdatedEvent.value = Event(Unit)
         }
     }
 }

app/src/main/java/com/example/android/architecture/blueprints/todoapp/statistics/StatisticsFragment.kt

@@ -24,7 +24,7 @@ import androidx.fragment.app.Fragment
 import androidx.fragment.app.viewModels
 import com.example.android.architecture.blueprints.todoapp.R
 import com.example.android.architecture.blueprints.todoapp.databinding.StatisticsFragBinding
-import com.example.android.architecture.blueprints.todoapp.util.getVmFactory
+import com.example.android.architecture.blueprints.todoapp.util.getViewModelFactory
 import com.example.android.architecture.blueprints.todoapp.util.setupRefreshLayout
 
 /**
@@ -34,7 +34,7 @@ class StatisticsFragment : Fragment() {
 
     private lateinit var viewDataBinding: StatisticsFragBinding
 
-    private val statisticsViewModel by viewModels<StatisticsViewModel> { getVmFactory() }
+    private val viewModel by viewModels<StatisticsViewModel> { getViewModelFactory() }
 
     override fun onCreateView(
         inflater: LayoutInflater, container: ViewGroup?,
@@ -49,9 +49,9 @@ class StatisticsFragment : Fragment() {
 
     override fun onActivityCreated(savedInstanceState: Bundle?) {
         super.onActivityCreated(savedInstanceState)
-        viewDataBinding.viewmodel = statisticsViewModel
+        viewDataBinding.viewmodel = viewModel
         viewDataBinding.lifecycleOwner = this.viewLifecycleOwner
         this.setupRefreshLayout(viewDataBinding.refreshLayout)
-        statisticsViewModel.start()
+        viewModel.start()
     }
 }

app/src/main/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailFragment.kt

@@ -30,7 +30,7 @@ import com.example.android.architecture.blueprints.todoapp.EventObserver
 import com.example.android.architecture.blueprints.todoapp.R
 import com.example.android.architecture.blueprints.todoapp.databinding.TaskdetailFragBinding
 import com.example.android.architecture.blueprints.todoapp.tasks.DELETE_RESULT_OK
-import com.example.android.architecture.blueprints.todoapp.util.getVmFactory
+import com.example.android.architecture.blueprints.todoapp.util.getViewModelFactory
 import com.example.android.architecture.blueprints.todoapp.util.setupRefreshLayout
 import com.example.android.architecture.blueprints.todoapp.util.setupSnackbar
 import com.google.android.material.snackbar.Snackbar
@@ -43,23 +43,23 @@ class TaskDetailFragment : Fragment() {
 
     private val args: TaskDetailFragmentArgs by navArgs()
 
-    private val viewModel by viewModels<TaskDetailViewModel> { getVmFactory() }
+    private val viewModel by viewModels<TaskDetailViewModel> { getViewModelFactory() }
 
     override fun onActivityCreated(savedInstanceState: Bundle?) {
         super.onActivityCreated(savedInstanceState)
         setupFab()
-        view?.setupSnackbar(this, viewModel.snackbarMessage, Snackbar.LENGTH_SHORT)
+        view?.setupSnackbar(this, viewModel.snackbarText, Snackbar.LENGTH_SHORT)
         setupNavigation()
         this.setupRefreshLayout(viewDataBinding.refreshLayout)
     }
 
     private fun setupNavigation() {
-        viewModel.deleteTaskCommand.observe(this, EventObserver {
+        viewModel.deleteTaskEvent.observe(this, EventObserver {
             val action = TaskDetailFragmentDirections
                 .actionTaskDetailFragmentToTasksFragment(DELETE_RESULT_OK)
             findNavController().navigate(action)
         })
-        viewModel.editTaskCommand.observe(this, EventObserver {
+        viewModel.editTaskEvent.observe(this, EventObserver {
             val action = TaskDetailFragmentDirections
                 .actionTaskDetailFragmentToAddEditTaskFragment(
                     args.taskId,

app/src/main/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailViewModel.kt

@@ -46,14 +46,14 @@ class TaskDetailViewModel(
     private val _dataLoading = MutableLiveData<Boolean>()
     val dataLoading: LiveData<Boolean> = _dataLoading
 
-    private val _editTaskCommand = MutableLiveData<Event<Unit>>()
-    val editTaskCommand: LiveData<Event<Unit>> = _editTaskCommand
+    private val _editTaskEvent = MutableLiveData<Event<Unit>>()
+    val editTaskEvent: LiveData<Event<Unit>> = _editTaskEvent
 
-    private val _deleteTaskCommand = MutableLiveData<Event<Unit>>()
-    val deleteTaskCommand: LiveData<Event<Unit>> = _deleteTaskCommand
+    private val _deleteTaskEvent = MutableLiveData<Event<Unit>>()
+    val deleteTaskEvent: LiveData<Event<Unit>> = _deleteTaskEvent
 
     private val _snackbarText = MutableLiveData<Event<Int>>()
-    val snackbarMessage: LiveData<Event<Int>> = _snackbarText
+    val snackbarText: LiveData<Event<Int>> = _snackbarText
 
     private val taskId: String?
         get() = _task.value?.id
@@ -67,12 +67,12 @@ class TaskDetailViewModel(
     fun deleteTask() = viewModelScope.launch {
         taskId?.let {
             tasksRepository.deleteTask(it)
-            _deleteTaskCommand.value = Event(Unit)
+            _deleteTaskEvent.value = Event(Unit)
         }
     }
 
     fun editTask() {
-        _editTaskCommand.value = Event(Unit)
+        _editTaskEvent.value = Event(Unit)
     }
 
     fun setCompleted(completed: Boolean) = viewModelScope.launch {

app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksFragment.kt

@@ -32,7 +32,7 @@ import com.example.android.architecture.blueprints.todoapp.EventObserver
 import com.example.android.architecture.blueprints.todoapp.R
 import com.example.android.architecture.blueprints.todoapp.data.Task
 import com.example.android.architecture.blueprints.todoapp.databinding.TasksFragBinding
-import com.example.android.architecture.blueprints.todoapp.util.getVmFactory
+import com.example.android.architecture.blueprints.todoapp.util.getViewModelFactory
 import com.example.android.architecture.blueprints.todoapp.util.setupRefreshLayout
 import com.example.android.architecture.blueprints.todoapp.util.setupSnackbar
 import com.google.android.material.floatingactionbutton.FloatingActionButton
@@ -44,7 +44,7 @@ import timber.log.Timber
  */
 class TasksFragment : Fragment() {
 
-    private val viewModel by viewModels<TasksViewModel> { getVmFactory() }
+    private val viewModel by viewModels<TasksViewModel> { getViewModelFactory() }
 
     private val args: TasksFragmentArgs by navArgs()
 
@@ -110,7 +110,7 @@ class TasksFragment : Fragment() {
     }
 
     private fun setupSnackbar() {
-        view?.setupSnackbar(this, viewModel.snackbarMessage, Snackbar.LENGTH_SHORT)
+        view?.setupSnackbar(this, viewModel.snackbarText, Snackbar.LENGTH_SHORT)
         arguments?.let {
             viewModel.showEditResultMessage(args.userMessage)
         }

app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModel.kt

@@ -58,7 +58,7 @@ class TasksViewModel(
     val tasksAddViewVisible: LiveData<Boolean> = _tasksAddViewVisible
 
     private val _snackbarText = MutableLiveData<Event<Int>>()
-    val snackbarMessage: LiveData<Event<Int>> = _snackbarText
+    val snackbarText: LiveData<Event<Int>> = _snackbarText
 
     private var _currentFiltering = TasksFilterType.ALL_TASKS
 

app/src/main/java/com/example/android/architecture/blueprints/todoapp/util/FragmentExt.kt

@@ -23,7 +23,7 @@ import androidx.fragment.app.Fragment
 import com.example.android.architecture.blueprints.todoapp.TodoApplication
 import com.example.android.architecture.blueprints.todoapp.ViewModelFactory
 
-fun Fragment.getVmFactory(): ViewModelFactory {
+fun Fragment.getViewModelFactory(): ViewModelFactory {
     val repository = (requireContext().applicationContext as TodoApplication).taskRepository
     return ViewModelFactory(repository)
 }

app/src/test/java/com/example/android/architecture/blueprints/todoapp/addedittask/AddEditTaskViewModelTest.kt

@@ -149,6 +149,6 @@ class AddEditTaskViewModelTest {
         addEditTaskViewModel.saveTask()
 
         // Then the snackbar shows an error
-        assertSnackbarMessage(addEditTaskViewModel.snackbarMessage, string.empty_task_message)
+        assertSnackbarMessage(addEditTaskViewModel.snackbarText, string.empty_task_message)
     }
 }

app/src/test/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailViewModelTest.kt

@@ -81,7 +81,7 @@ class TaskDetailViewModelTest {
 
         // Then the task is completed and the snackbar shows the correct message
         assertThat(tasksRepository.tasksServiceData[task.id]?.isCompleted).isTrue()
-        assertSnackbarMessage(taskDetailViewModel.snackbarMessage, R.string.task_marked_complete)
+        assertSnackbarMessage(taskDetailViewModel.snackbarText, R.string.task_marked_complete)
     }
 
     @Test
@@ -98,7 +98,7 @@ class TaskDetailViewModelTest {
 
         // Then the task is not completed and the snackbar shows the correct message
         assertThat(tasksRepository.tasksServiceData[task.id]?.isCompleted).isFalse()
-        assertSnackbarMessage(taskDetailViewModel.snackbarMessage, R.string.task_marked_active)
+        assertSnackbarMessage(taskDetailViewModel.snackbarText, R.string.task_marked_active)
 
     }
 
@@ -117,7 +117,7 @@ class TaskDetailViewModelTest {
     @Test
     fun updateSnackbar_nullValue() {
         // Before setting the Snackbar text, get its current value
-        val snackbarText = taskDetailViewModel.snackbarMessage.value
+        val snackbarText = taskDetailViewModel.snackbarText.value
 
         // Check that the value is null
         assertThat(snackbarText).isNull()
@@ -129,7 +129,7 @@ class TaskDetailViewModelTest {
         taskDetailViewModel.editTask()
 
         // Then the event is triggered
-        val value = getValue(taskDetailViewModel.editTaskCommand)
+        val value = getValue(taskDetailViewModel.editTaskEvent)
         assertThat(value.getContentIfNotHandled()).isNotNull()
     }