refactor(auto-advance): remove ViewModel dependency

BrayanDSO · BrayanDSO · commit 0f8fd6e2026e · 2025-12-28T11:11:33.000-03:00
that makes easier to test the class
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerViewModel.kt b/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerViewModel.kt
@@ -16,6 +16,7 @@
 package com.ichi2.anki.ui.windows.reviewer
 
 import androidx.lifecycle.SavedStateHandle
+import androidx.lifecycle.viewModelScope
 import anki.collection.OpChanges
 import anki.frontend.SetSchedulingStatesRequest
 import anki.scheduler.CardAnswer.Rating
@@ -60,7 +61,10 @@ import com.ichi2.anki.servicelayer.isSuspendNoteAvailable
 import com.ichi2.anki.settings.Prefs
 import com.ichi2.anki.tryRedo
 import com.ichi2.anki.tryUndo
+import com.ichi2.anki.ui.windows.reviewer.autoadvance.AnswerAction
 import com.ichi2.anki.ui.windows.reviewer.autoadvance.AutoAdvance
+import com.ichi2.anki.ui.windows.reviewer.autoadvance.AutoAdvanceAction
+import com.ichi2.anki.ui.windows.reviewer.autoadvance.QuestionAction
 import com.ichi2.anki.utils.CollectionPreferences
 import com.ichi2.anki.utils.Destination
 import com.ichi2.anki.utils.ext.answerCard
@@ -83,7 +87,8 @@ class ReviewerViewModel(
     val savedStateHandle: SavedStateHandle,
 ) : CardViewerViewModel(),
     ChangeManager.Subscriber,
-    BindingProcessor<ReviewerBinding, ViewerAction> {
+    BindingProcessor<ReviewerBinding, ViewerAction>,
+    AutoAdvance.ActionListener {
     private var queueState: Deferred<CurrentQueueState?> =
         asyncIO {
             withCol { sched.currentQueueState() }
@@ -122,7 +127,7 @@ class ReviewerViewModel(
     private val stateMutationKey = TimeManager.time.intTimeMS().toString()
     private var typedAnswer = ""
 
-    private val autoAdvance = AutoAdvance(this)
+    private val autoAdvance = AutoAdvance(viewModelScope, this, currentCard)
     private val isHtmlTypeAnswerEnabled = Prefs.isHtmlTypeAnswerEnabled
     val answerTimer = AnswerTimer()
 
@@ -716,6 +721,18 @@ class ReviewerViewModel(
         return true
     }
 
+    override suspend fun onAutoAdvanceAction(action: AutoAdvanceAction) {
+        when (action) {
+            QuestionAction.SHOW_ANSWER -> onShowAnswer()
+            QuestionAction.SHOW_REMINDER -> actionFeedbackFlow.emit(TR.studyingQuestionTimeElapsed())
+            AnswerAction.BURY_CARD -> buryCard()
+            AnswerAction.ANSWER_AGAIN -> answerCard(Rating.AGAIN)
+            AnswerAction.ANSWER_GOOD -> answerCard(Rating.GOOD)
+            AnswerAction.ANSWER_HARD -> answerCard(Rating.HARD)
+            AnswerAction.SHOW_REMINDER -> actionFeedbackFlow.emit(TR.studyingAnswerTimeElapsed())
+        }
+    }
+
     // Based in https://github.com/ankitects/anki/blob/1f95d030bbc7ebcc004ffe1e2be2a320c9fe1e94/qt/aqt/reviewer.py#L201
     // and https://github.com/ankitects/anki/blob/1f95d030bbc7ebcc004ffe1e2be2a320c9fe1e94/qt/aqt/reviewer.py#L219
     override fun opExecuted(
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/AnswerAction.kt b/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/AnswerAction.kt
@@ -20,7 +20,7 @@ import com.ichi2.anki.libanki.DeckConfig.Companion.ANSWER_ACTION
 
 enum class AnswerAction(
     val code: Int,
-) {
+) : AutoAdvanceAction {
     BURY_CARD(0),
     ANSWER_AGAIN(1),
     ANSWER_GOOD(2),
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/AutoAdvance.kt b/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/AutoAdvance.kt
@@ -15,15 +15,13 @@
  */
 package com.ichi2.anki.ui.windows.reviewer.autoadvance
 
-import anki.scheduler.CardAnswer.Rating
-import com.ichi2.anki.CollectionManager.TR
 import com.ichi2.anki.asyncIO
-import com.ichi2.anki.launchCatchingIO
 import com.ichi2.anki.libanki.Card
-import com.ichi2.anki.reviewer.AutomaticAnswerAction
-import com.ichi2.anki.ui.windows.reviewer.ReviewerViewModel
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.delay
+import kotlinx.coroutines.launch
 
 /**
  * Implementation of the `Auto Advance` deck options
@@ -36,8 +34,18 @@ import kotlinx.coroutines.delay
  * @see AutoAdvanceSettings
  */
 class AutoAdvance(
-    val viewModel: ReviewerViewModel,
+    private val scope: CoroutineScope,
+    private val listener: ActionListener,
+    initialCard: Deferred<Card>,
 ) {
+    /**
+     * Listens to the `Auto Advance` actions set in Deck options,
+     * which can be either a [QuestionAction] or a [AnswerAction].
+     */
+    fun interface ActionListener {
+        suspend fun onAutoAdvanceAction(action: AutoAdvanceAction)
+    }
+
     var isEnabled = false
         set(value) {
             field = value
@@ -49,9 +57,8 @@ class AutoAdvance(
     private var answerActionJob: Job? = null
 
     private var settings =
-        viewModel.asyncIO {
-            val card = viewModel.currentCard.await()
-            AutoAdvanceSettings.createInstance(card.currentDeckId())
+        scope.asyncIO {
+            AutoAdvanceSettings.createInstance(initialCard.await().currentDeckId())
         }
 
     private suspend fun durationToShowQuestionFor() = settings.await().durationToShowQuestionFor
@@ -72,7 +79,7 @@ class AutoAdvance(
     fun onCardChange(card: Card) {
         cancelQuestionAndAnswerActionJobs()
         settings =
-            viewModel.asyncIO {
+            scope.asyncIO {
                 AutoAdvanceSettings.createInstance(card.currentDeckId())
             }
     }
@@ -82,12 +89,9 @@ class AutoAdvance(
         if (!durationToShowQuestionFor().isPositive() || !isEnabled) return
 
         questionActionJob =
-            viewModel.launchCatchingIO {
+            scope.launch {
                 delay(durationToShowQuestionFor())
-                when (questionAction()) {
-                    QuestionAction.SHOW_ANSWER -> viewModel.onShowAnswer()
-                    QuestionAction.SHOW_REMINDER -> showReminder(TR.studyingQuestionTimeElapsed())
-                }
+                listener.onAutoAdvanceAction(questionAction())
             }
     }
 
@@ -96,21 +100,9 @@ class AutoAdvance(
         if (!durationToShowAnswerFor().isPositive() || !isEnabled) return
 
         answerActionJob =
-            viewModel.launchCatchingIO {
+            scope.launch {
                 delay(durationToShowAnswerFor())
-                when (answerAction()) {
-                    AnswerAction.BURY_CARD -> viewModel.buryCard()
-                    AnswerAction.ANSWER_AGAIN -> viewModel.answerCard(Rating.AGAIN)
-                    AnswerAction.ANSWER_HARD -> viewModel.answerCard(Rating.HARD)
-                    AnswerAction.ANSWER_GOOD -> viewModel.answerCard(Rating.GOOD)
-                    AnswerAction.SHOW_REMINDER -> showReminder(TR.studyingAnswerTimeElapsed())
-                }
+                listener.onAutoAdvanceAction(answerAction())
             }
     }
-
-    private fun showReminder(message: String) {
-        viewModel.launchCatchingIO {
-            viewModel.actionFeedbackFlow.emit(message)
-        }
-    }
 }
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/AutoAdvanceAction.kt b/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/AutoAdvanceAction.kt
@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2025 Brayan Oliveira <69634269+brayandso@users.noreply.github.com>
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 3 of the License, or (at your option) any later
+ * version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.ichi2.anki.ui.windows.reviewer.autoadvance
+
+/**
+ * Common interface for all actions triggered by Auto Advance.
+ * Implemented by [QuestionAction] and [AnswerAction].
+ */
+sealed interface AutoAdvanceAction
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/QuestionAction.kt b/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/autoadvance/QuestionAction.kt
@@ -20,7 +20,7 @@ import com.ichi2.anki.libanki.DeckConfig.Companion.QUESTION_ACTION
 
 enum class QuestionAction(
     val code: Int,
-) {
+) : AutoAdvanceAction {
     SHOW_ANSWER(0),
     SHOW_REMINDER(1),
     ;

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import com.ichi2.anki.libanki.DeckConfig.Companion.QUESTION_ACTION`
`20`	`20`
`21`	`21`	`enum class QuestionAction(`
`22`	`22`	`val code: Int,`
`23`		`-) {`
	`23`	`+) : AutoAdvanceAction {`
`24`	`24`	`SHOW_ANSWER(0),`
`25`	`25`	`SHOW_REMINDER(1),`
`26`	`26`	`;`