Fix cloze number when existing clozes are present

[Alok-Silswal]

Purpose / Description

Instant Note was not displaying cloze number properly with cloze text.

Fixes

• Fixes Adding additional clozes doesn't work properly for Instant Cards in AnkiDroid #20350

Approach

• Cloze counter is derived from actual text.
• Added syncClozeState(text) function that makes cloze counter consistent with actual text to reflect correct cloze value by scanning text.
• Mode switching was simplified so that changing modes does not change the counter by itself.

How Has This Been Tested?

• Verified that existing unit tests pass (InstantEditorViewModelTest.kt).

• Tested on my phone (Android 14, Xiaomi / HyperOS) using a debug build.

Used the following two texts for testing:

This is the {{c1::first cloze}}. This should be the second cloze.

This is the {{c1::first cloze}}. This should be the {{c2::second cloze}}. Similarly, this one as {{c3::third cloze}}.

Two screen recording attached as evidence.

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

Cloze_fix_evidence_1.mp4

Cloze_fix_evidence_2.mp4

[david-allison]

Could you add a unit test?

[Alok-Silswal]

Could you add a unit test?

In InstantEditorViewModelTest.kt?

[david-allison]

Yep

[Alok-Silswal]

Done!
@david-allison Does it suffice?

[david-allison]

minor guidance: Could you spend a little more time on the self-review phase of submissions, it looks like a lot of code was changed unnecessarily

If I'm wrong, could you add tests to showcase the bugs you're fixing

The test you added was great! Failed on main, passes on your branch

[Alok-Silswal]

Could you add a unit test?

Actually, this needs 3 different unit test cases (one already committed) as mentioned by me in #20350 (comment) i.e.

On first load, the existing c1 is not detected, so the cloze counter starts from 1 again, and the next insertion reuses c1.

After toggling [...] +, the state refresh causes the existing cloze to be detected correctly, and further insertions increment as expected.

---

I tested this further with text that already has multiple clozes (c1, c2, c3).

Observations:

• On first load, when I select a new word in [...] + mode, it does not continue from c4. It starts again from c1.
• The next selections then go c2, c3, but this numbering is clearly independent of the existing clozes in the text.
• After toggling [...] +, selecting another word still does not continue from the highest existing index. Instead, it starts from c2.

So the counter does not seem to be derived from the current clozes present in the text. It looks like it’s using some local counter that gets reset or out of sync.

---

[Alok-Silswal]

@david-allison On deeper inspection, I found that there is no unit case to verify the cloze counter adjustment when switching from INCREMENT to NO_INCREMENT mode and vice-versa for cloze text.

Shall I add that unit test case in this PR only, or open a separate Issue for that? I have the function ready for that.

[david-allison]

When you're bugfixing, keep the commit as lean as possible:

• fix
• test

If you notice more tests could be added, feel free to either add them as a new commit, or raise a separate PR. No issue necessary

[david-allison]

Cheers