[GSoC'24] Fix: cloze number incorrect on undo

[criticalAY]

Purpose / Description

Cloze number is reset to 1 or the current cloze number is max of the close number list

Fixes

• Fixes [BUG]: Instant Add Editor - wrong Cloze number #16778

Approach

How does this change address the problem?

How Has This Been Tested?

Oneplus nord ce

Checklist

Please, go through these checks before submitting the PR.

• You have a descriptive commit message with a short title (first line, max 50 chars).
• You have commented your code, particularly in hard-to-understand areas
• You have performed a self-review of your own code
• UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
• UI Changes: You have tested your change using the Google Accessibility Scanner

[david-allison]

You should add a test as well

[ShridharGoel]

LGTM.

[david-allison]

I don't feel the tests are readable.

Subject: [PATCH] aa
---
Index: AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt
--- a/AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt	(revision 3ae8b861623eb072b52b0575a12329ed00460db8)
+++ b/AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt	(date 1722110794241)
@@ -58,34 +58,32 @@
     @Test
     fun `test cloze number reset to 1`() = runViewModelTest {
         val sentenceArray = mutableListOf("Hello", "world")
-        sentenceArray[0] = buildClozeText(sentenceArray[0])
-        sentenceArray[1] = buildClozeText(sentenceArray[1])
+        
+        toggleAllClozeDeletions(sentenceArray)
 
-        assertEquals(intClozeList.size, 2)
+        assertEquals("all clozes are detected", clozeDeletionCount, 2)
 
-        buildClozeText(sentenceArray[0])
-        buildClozeText(sentenceArray[1])
+        toggleAllClozeDeletions(sentenceArray)
 
-        assertEquals(intClozeList.size, 0)
-        assertEquals(currentClozeNumber, 1)
+        assertEquals("all cloze deletions are removed", clozeDeletionCount, 0)
+        assertEquals("cloze number is reset if there are no clozes", currentClozeNumber, 1)
     }
 
     @Test
     fun `test cloze number is reset to max value from cloze list`() = runViewModelTest {
         val sentenceArray = mutableListOf("Hello", "world", "this", "is", "test", "sentence")
 
-        sentenceArray[0] = buildClozeText(sentenceArray[0])
-        sentenceArray[1] = buildClozeText(sentenceArray[1])
-        sentenceArray[2] = buildClozeText(sentenceArray[2])
+        // cloze on the first 3 words
+        toggleClozeDeletions(sentenceArray, 0, 1, 2)
 
-        buildClozeText(sentenceArray[0])
-        buildClozeText(sentenceArray[1])
+        // disable cloze on the first 2, leaving "this" as {{c3::
+        toggleClozeDeletions(sentenceArray, 0, 1)
 
-        assertEquals(currentClozeNumber, 4)
+        assertEquals("cloze number is 'Current Cloze Number + 1'", currentClozeNumber, 4)
 
-        // removing all clozes
-        buildClozeText(sentenceArray[2])
-        assertEquals(currentClozeNumber, 1)
+        // remove the remaining cloze all clozes
+        toggleClozeDeletion(sentenceArray, 2)
+        assertEquals("cloze number is reset if all clozes are removed", currentClozeNumber, 1)
     }
 
     @Test
@@ -234,3 +232,25 @@
         }
     }
 }
+
+context (InstantEditorViewModel)
+private fun toggleAllClozeDeletions(words: MutableList<String>) {
+    for (index in words.indices) {
+        words[index] = buildClozeText(words[index])
+    }
+}
+
+
+context (InstantEditorViewModel)
+@Suppress("SameParameterValue")
+private fun toggleClozeDeletions(words: MutableList<String>, vararg indices: Int) {
+    for (index in indices) {
+        words[index] = buildClozeText(words[index])
+    }
+}
+
+context (InstantEditorViewModel)
+@Suppress("SameParameterValue")
+private fun toggleClozeDeletion(words: MutableList<String>, index: Int) {
+    words[index] = buildClozeText(words[index])
+}
\ No newline at end of file
Index: AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt b/AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt
--- a/AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt	(revision 3ae8b861623eb072b52b0575a12329ed00460db8)
+++ b/AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt	(date 1722109604855)
@@ -60,7 +60,11 @@
         get() = _currentClozeNumber.value
 
     // List to store the cloze integers
-    val intClozeList = mutableListOf<Int>()
+    private val intClozeList = mutableListOf<Int>()
+
+    /** The number of words which are marked as cloze deletions */
+    @VisibleForTesting
+    val clozeDeletionCount get() = intClozeList.size
 
     private val _currentClozeMode = MutableStateFlow(InstantNoteEditorActivity.ClozeMode.INCREMENT)