reduce code duplication

Author: andreia-ferreira

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/AbstractTaskViewModel.kt

@@ -15,9 +15,13 @@
  */
 package org.groundplatform.android.ui.datacollection.tasks
 
+import androidx.lifecycle.viewModelScope
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.flow.update
 import org.groundplatform.android.R
 import org.groundplatform.android.model.job.Job
@@ -37,7 +41,11 @@ abstract class AbstractTaskViewModel internal constructor() : AbstractViewModel(
   private val _taskDataFlow: MutableStateFlow<TaskData?> = MutableStateFlow(null)
   val taskTaskData: StateFlow<TaskData?> = _taskDataFlow.asStateFlow()
 
-  abstract val taskActionButtonStates: StateFlow<List<ButtonActionState>>
+  open val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
+    taskTaskData
+      .map { getButtonStates(it) }
+      .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
+  }
 
   lateinit var task: Task
   private lateinit var taskPositionInterface: TaskPositionInterface
@@ -53,6 +61,16 @@ abstract class AbstractTaskViewModel internal constructor() : AbstractViewModel(
     setValue(taskData)
   }
 
+  /**
+   * Returns the list of button states for the given task data.
+   *
+   * By default it returns a list of [ButtonAction.PREVIOUS], [ButtonAction.SKIP] (if applicable),
+   * [ButtonAction.NEXT]/[ButtonAction.DONE]. Override this method to customize button
+   * configuration.
+   */
+  protected open fun getButtonStates(taskData: TaskData?): List<ButtonActionState> =
+    listOf(getPreviousButton(), getSkipButton(taskData), getNextButton(taskData))
+
   /** Checks if the current value is valid and updates error value. */
   fun validate(): Int? = validate(task, taskTaskData.value)
 
@@ -87,14 +105,14 @@ abstract class AbstractTaskViewModel internal constructor() : AbstractViewModel(
 
   fun hasNoData(): Boolean = taskTaskData.value.isNullOrEmpty()
 
-  fun getPreviousButtonState(): ButtonActionState =
+  fun getPreviousButton(): ButtonActionState =
     ButtonActionState(
       action = ButtonAction.PREVIOUS,
       isEnabled = !taskPositionInterface.isFirst(),
       isVisible = true,
     )
 
-  fun getNextButtonState(taskData: TaskData?, hideIfEmpty: Boolean = false): ButtonActionState {
+  fun getNextButton(taskData: TaskData?, hideIfEmpty: Boolean = false): ButtonActionState {
     val isVisible = if (hideIfEmpty) taskData.isNotNullOrEmpty() else true
     return if (taskPositionInterface.isLastWithValue(taskData)) {
       ButtonActionState(
@@ -111,14 +129,14 @@ abstract class AbstractTaskViewModel internal constructor() : AbstractViewModel(
     }
   }
 
-  fun getSkipButtonState(taskData: TaskData?): ButtonActionState =
+  fun getSkipButton(taskData: TaskData?): ButtonActionState =
     ButtonActionState(
       action = ButtonAction.SKIP,
       isEnabled = isTaskOptional(),
       isVisible = isTaskOptional() && taskData.isNullOrEmpty(),
     )
 
-  fun getUndoButtonState(
+  fun getUndoButton(
     taskData: TaskData?,
     isVisible: Boolean = taskData.isNotNullOrEmpty(),
   ): ButtonActionState =

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/date/DateTaskViewModel.kt

@@ -15,23 +15,12 @@
  */
 package org.groundplatform.android.ui.datacollection.tasks.date
 
-import androidx.lifecycle.viewModelScope
 import java.util.Date
 import javax.inject.Inject
-import kotlinx.coroutines.flow.SharingStarted
-import kotlinx.coroutines.flow.StateFlow
-import kotlinx.coroutines.flow.map
-import kotlinx.coroutines.flow.stateIn
 import org.groundplatform.android.model.submission.DateTimeTaskData.Companion.fromMillis
-import org.groundplatform.android.ui.datacollection.components.refactor.ButtonActionState
 import org.groundplatform.android.ui.datacollection.tasks.AbstractTaskViewModel
 
 class DateTaskViewModel @Inject constructor() : AbstractTaskViewModel() {
-  override val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
-    taskTaskData
-      .map { listOf(getPreviousButtonState(), getSkipButtonState(it), getNextButtonState(it)) }
-      .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
-  }
 
   fun updateResponse(date: Date) {
     setValue(fromMillis(date.time))

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/instruction/InstructionTaskViewModel.kt

@@ -15,20 +15,13 @@
  */
 package org.groundplatform.android.ui.datacollection.tasks.instruction
 
-import androidx.lifecycle.viewModelScope
 import javax.inject.Inject
-import kotlinx.coroutines.flow.SharingStarted
-import kotlinx.coroutines.flow.StateFlow
-import kotlinx.coroutines.flow.map
-import kotlinx.coroutines.flow.stateIn
+import org.groundplatform.android.model.submission.TaskData
 import org.groundplatform.android.ui.datacollection.components.refactor.ButtonActionState
 import org.groundplatform.android.ui.datacollection.tasks.AbstractTaskViewModel
 
-@Suppress("EmptyClassBlock")
 class InstructionTaskViewModel @Inject constructor() : AbstractTaskViewModel() {
-  override val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
-    taskTaskData
-      .map { listOf(getPreviousButtonState(), getNextButtonState(it)) }
-      .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
-  }
+
+  override fun getButtonStates(taskData: TaskData?): List<ButtonActionState> =
+    listOf(getPreviousButton(), getNextButton(taskData))
 }

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/location/CaptureLocationTaskViewModel.kt

@@ -25,7 +25,6 @@ import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.combine
-import kotlinx.coroutines.flow.distinctUntilChanged
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.flow.update
@@ -56,14 +55,13 @@ class CaptureLocationTaskViewModel @Inject constructor() : AbstractMapTaskViewMo
   override val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
     combine(isCaptureEnabled, taskTaskData) { captureEnabled, taskData ->
         listOf(
-          getPreviousButtonState(),
-          getSkipButtonState(taskData),
-          getUndoButtonState(taskData),
-          getCaptureLocationButtonState(captureEnabled, taskData),
-          getNextButtonState(taskData, hideIfEmpty = true),
+          getPreviousButton(),
+          getSkipButton(taskData),
+          getUndoButton(taskData),
+          getCaptureLocationButton(captureEnabled, taskData),
+          getNextButton(taskData, hideIfEmpty = true),
         )
       }
-      .distinctUntilChanged()
       .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
   }
 
@@ -90,7 +88,7 @@ class CaptureLocationTaskViewModel @Inject constructor() : AbstractMapTaskViewMo
     }
   }
 
-  private fun getCaptureLocationButtonState(
+  private fun getCaptureLocationButton(
     captureEnabled: Boolean,
     taskData: TaskData?,
   ): ButtonActionState =

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/multiplechoice/MultipleChoiceTaskViewModel.kt

@@ -15,13 +15,9 @@
  */
 package org.groundplatform.android.ui.datacollection.tasks.multiplechoice
 
-import androidx.lifecycle.viewModelScope
 import javax.inject.Inject
 import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
-import kotlinx.coroutines.flow.map
-import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.flow.update
 import org.groundplatform.android.R
 import org.groundplatform.android.common.Constants
@@ -32,18 +28,11 @@ import org.groundplatform.android.model.submission.TaskData
 import org.groundplatform.android.model.task.MultipleChoice.Cardinality.SELECT_MULTIPLE
 import org.groundplatform.android.model.task.Option
 import org.groundplatform.android.model.task.Task
-import org.groundplatform.android.ui.datacollection.components.refactor.ButtonActionState
 import org.groundplatform.android.ui.datacollection.tasks.AbstractTaskViewModel
 import org.groundplatform.android.ui.datacollection.tasks.TaskPositionInterface
 
 class MultipleChoiceTaskViewModel @Inject constructor() : AbstractTaskViewModel() {
 
-  override val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
-    taskTaskData
-      .map { listOf(getPreviousButtonState(), getSkipButtonState(it), getNextButtonState(it)) }
-      .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
-  }
-
   private val _items: MutableStateFlow<List<MultipleChoiceItem>> = MutableStateFlow(emptyList())
   val items: StateFlow<List<MultipleChoiceItem>> = _items
 

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/number/NumberTaskViewModel.kt

@@ -17,26 +17,15 @@ package org.groundplatform.android.ui.datacollection.tasks.number
 
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.asLiveData
-import androidx.lifecycle.viewModelScope
 import javax.inject.Inject
-import kotlinx.coroutines.flow.SharingStarted
-import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.filterIsInstance
 import kotlinx.coroutines.flow.map
-import kotlinx.coroutines.flow.stateIn
 import org.groundplatform.android.model.submission.NumberTaskData
 import org.groundplatform.android.model.submission.TaskData
-import org.groundplatform.android.ui.datacollection.components.refactor.ButtonActionState
 import org.groundplatform.android.ui.datacollection.tasks.AbstractTaskViewModel
 
 class NumberTaskViewModel @Inject constructor() : AbstractTaskViewModel() {
 
-  override val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
-    taskTaskData
-      .map { listOf(getPreviousButtonState(), getSkipButtonState(it), getNextButtonState(it)) }
-      .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
-  }
-
   /** Transcoded text to be displayed for the current [TaskData]. */
   val responseText: LiveData<String> =
     taskTaskData.filterIsInstance<NumberTaskData?>().map { it?.number ?: "" }.asLiveData()

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/photo/PhotoTaskViewModel.kt

@@ -22,15 +22,13 @@ import androidx.lifecycle.viewModelScope
 import java.io.IOException
 import javax.inject.Inject
 import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.flow.SharingStarted
-import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.filterIsInstance
 import kotlinx.coroutines.flow.map
-import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.groundplatform.android.data.remote.firebase.FirebaseStorageManager
 import org.groundplatform.android.model.submission.PhotoTaskData
+import org.groundplatform.android.model.submission.TaskData
 import org.groundplatform.android.model.submission.isNotNullOrEmpty
 import org.groundplatform.android.repository.UserMediaRepository
 import org.groundplatform.android.ui.datacollection.components.refactor.ButtonActionState
@@ -40,19 +38,6 @@ import timber.log.Timber
 class PhotoTaskViewModel @Inject constructor(private val userMediaRepository: UserMediaRepository) :
   AbstractTaskViewModel() {
 
-  override val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
-    taskTaskData
-      .map {
-        listOf(
-          getPreviousButtonState(),
-          getUndoButtonState(it),
-          getSkipButtonState(it),
-          getNextButtonState(it),
-        )
-      }
-      .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
-  }
-
   /**
    * Task id waiting for a photo result. As only one photo result is returned at a time, we can
    * directly map it 1:1 with the task waiting for a photo result.
@@ -73,6 +58,14 @@ class PhotoTaskViewModel @Inject constructor(private val userMediaRepository: Us
 
   val isPhotoPresent: LiveData<Boolean> = taskTaskData.map { it.isNotNullOrEmpty() }.asLiveData()
 
+  override fun getButtonStates(taskData: TaskData?): List<ButtonActionState> =
+    listOf(
+      getPreviousButton(),
+      getUndoButton(taskData),
+      getSkipButton(taskData),
+      getNextButton(taskData),
+    )
+
   suspend fun createImageFileUri(): Uri {
     val file = userMediaRepository.createImageFile(task.id)
     return userMediaRepository.getUriForFile(file)

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/point/DropPinTaskViewModel.kt

@@ -55,11 +55,11 @@ constructor(
     taskTaskData
       .map {
         listOf(
-          getPreviousButtonState(),
-          getSkipButtonState(it),
-          getUndoButtonState(it),
+          getPreviousButton(),
+          getSkipButton(it),
+          getUndoButton(it),
           getDropPinButtonState(it),
-          getNextButtonState(it, hideIfEmpty = true),
+          getNextButton(it, hideIfEmpty = true),
         )
       }
       .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/polygon/DrawAreaTaskViewModel.kt

@@ -150,13 +150,13 @@ internal constructor(
     combine(taskTaskData, merge(draftArea, draftUpdates)) { taskData, currentFeature ->
         val isClosed = (currentFeature?.geometry as? LineString)?.isClosed() ?: false
         listOfNotNull(
-          getPreviousButtonState(),
-          getSkipButtonState(taskData),
-          getUndoButtonState(taskData, true),
-          getRedoButtonState(taskData),
-          getAddPointButtonState(isClosed, isTooClose.value),
+          getPreviousButton(),
+          getSkipButton(taskData),
+          getUndoButton(taskData, true),
+          getRedoButton(taskData),
+          getAddPointButton(isClosed, isTooClose.value),
           getCompleteButton(isClosed, isMarkedComplete.value, hasSelfIntersection),
-          getNextButtonState(taskData).takeIf { isMarkedComplete() },
+          getNextButton(taskData).takeIf { isMarkedComplete() },
         )
       }
       .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
@@ -422,24 +422,21 @@ internal constructor(
     vibrationHelper.vibrate()
   }
 
-  private fun getRedoButtonState(taskData: TaskData?): ButtonActionState =
+  private fun getRedoButton(taskData: TaskData?): ButtonActionState =
     ButtonActionState(
       action = ButtonAction.REDO,
       isEnabled = redoVertexStack.isNotEmpty() && taskData.isNotNullOrEmpty(),
       isVisible = true,
     )
 
-  private fun getAddPointButtonState(
-    isPolygonClosed: Boolean,
-    isTooClose: Boolean,
-  ): ButtonActionState =
+  private fun getAddPointButton(isPolygonClosed: Boolean, isTooClose: Boolean): ButtonActionState =
     ButtonActionState(
       action = ButtonAction.ADD_POINT,
       isEnabled = !isPolygonClosed && !isTooClose,
       isVisible = !isPolygonClosed,
     )
 
-  fun getCompleteButton(
+  private fun getCompleteButton(
     isClosed: Boolean,
     isMarkedComplete: Boolean,
     hasSelfIntersection: Boolean,

app/src/main/java/org/groundplatform/android/ui/datacollection/tasks/text/TextTaskViewModel.kt

@@ -17,29 +17,18 @@ package org.groundplatform.android.ui.datacollection.tasks.text
 
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.asLiveData
-import androidx.lifecycle.viewModelScope
 import javax.inject.Inject
-import kotlinx.coroutines.flow.SharingStarted
-import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.filterIsInstance
 import kotlinx.coroutines.flow.map
-import kotlinx.coroutines.flow.stateIn
 import org.groundplatform.android.R
 import org.groundplatform.android.common.Constants
 import org.groundplatform.android.model.submission.TaskData
 import org.groundplatform.android.model.submission.TextTaskData
 import org.groundplatform.android.model.task.Task
-import org.groundplatform.android.ui.datacollection.components.refactor.ButtonActionState
 import org.groundplatform.android.ui.datacollection.tasks.AbstractTaskViewModel
 
 class TextTaskViewModel @Inject constructor() : AbstractTaskViewModel() {
 
-  override val taskActionButtonStates: StateFlow<List<ButtonActionState>> by lazy {
-    taskTaskData
-      .map { listOf(getPreviousButtonState(), getSkipButtonState(it), getNextButtonState(it)) }
-      .stateIn(viewModelScope, SharingStarted.Lazily, emptyList())
-  }
-
   /** Transcoded text to be displayed for the current [TaskData]. */
   val responseText: LiveData<String> =
     taskTaskData.filterIsInstance<TextTaskData?>().map { it?.text ?: "" }.asLiveData()