refactor(card-browser): prefer 'SelectableDeck' class

Prep for another deck selection dialog when moving to a Chip control

Author: david-allison

AnkiDroid/src/main/java/com/ichi2/anki/CardBrowser.kt

@@ -53,7 +53,6 @@ import com.google.android.material.snackbar.Snackbar
 import com.ichi2.anim.ActivityTransitionAnimation.Direction
 import com.ichi2.anki.CollectionManager.TR
 import com.ichi2.anki.CollectionManager.withCol
-import com.ichi2.anki.DeckSpinnerSelection.Companion.ALL_DECKS_ID
 import com.ichi2.anki.browser.BrowserRowCollection
 import com.ichi2.anki.browser.CardBrowserFragment
 import com.ichi2.anki.browser.CardBrowserLaunchOptions
@@ -136,11 +135,7 @@ open class CardBrowser :
             }
 
     override fun onDeckSelected(deck: SelectableDeck?) {
-        when (deck) {
-            is SelectableDeck.AllDecks -> launchCatchingTask { viewModel.setDeckId(ALL_DECKS_ID) }
-            is SelectableDeck.Deck -> launchCatchingTask { viewModel.setDeckId(deck.deckId) }
-            null -> {}
-        }
+        deck?.let { deck -> launchCatchingTask { viewModel.setSelectedDeck(deck) } }
     }
 
     override var fragmented: Boolean
@@ -1297,7 +1292,7 @@ open class CardBrowser :
     fun searchAllDecks() =
         launchCatchingTask {
             // all we need to do is select all decks
-            viewModel.setDeckId(DeckSpinnerSelection.ALL_DECKS_ID)
+            viewModel.setSelectedDeck(SelectableDeck.AllDecks)
         }
 
     /**

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserViewModel.kt

@@ -285,7 +285,14 @@ class CardBrowserViewModel(
     val lastDeckId: DeckId?
         get() = lastDeckIdRepository.lastDeckId
 
-    suspend fun setDeckId(deckId: DeckId) {
+    suspend fun setSelectedDeck(deck: SelectableDeck) =
+        when (deck) {
+            is SelectableDeck.AllDecks -> setSelectedDeck(ALL_DECKS_ID)
+            is SelectableDeck.Deck -> setSelectedDeck(deck.deckId)
+        }
+
+    // TODO: Replace with setSelectedDeck(selectableDeck)
+    suspend fun setSelectedDeck(deckId: DeckId) {
         Timber.i("setting deck: %d", deckId)
         lastDeckIdRepository.lastDeckId = deckId
         restrictOnDeck =
@@ -310,19 +317,22 @@ class CardBrowserViewModel(
 
     suspend fun queryDataForCardEdit(id: CardOrNoteId): CardId = id.toCardId(cardsOrNotes)
 
-    private suspend fun getInitialDeck(): DeckId {
+    private suspend fun getInitialDeck(): SelectableDeck {
         // TODO: Handle the launch intent
         val lastDeckId = lastDeckId
         if (lastDeckId == ALL_DECKS_ID) {
-            return ALL_DECKS_ID
+            return SelectableDeck.AllDecks
         }
 
         // If a valid value for last deck exists then use it, otherwise use libanki selected deck
-        return if (lastDeckId != null && withCol { decks.getLegacy(lastDeckId) != null }) {
-            lastDeckId
-        } else {
-            withCol { decks.selected() }
-        }
+        val idToUse =
+            if (lastDeckId != null && withCol { decks.getLegacy(lastDeckId) != null }) {
+                lastDeckId
+            } else {
+                withCol { decks.selected() }
+            }
+
+        return SelectableDeck.Deck(deckId = idToUse, name = withCol { decks.name(idToUse) })
     }
 
     val flowOfInitCompleted = MutableStateFlow(false)
@@ -414,9 +424,9 @@ class CardBrowserViewModel(
         viewModelScope.launch {
             shouldIgnoreAccents = withCol { config.getBool(ConfigKey.Bool.IGNORE_ACCENTS_IN_SEARCH) }
 
-            val initialDeckId = if (selectAllDecks) ALL_DECKS_ID else getInitialDeck()
+            val initialDeckId = if (selectAllDecks) SelectableDeck.AllDecks else getInitialDeck()
             // PERF: slightly inefficient if the source was lastDeckId
-            setDeckId(initialDeckId)
+            setSelectedDeck(initialDeckId)
             refreshBackendColumns()
 
             val cardsOrNotes = withCol { CardsOrNotes.fromCollection(this@withCol) }

AnkiDroid/src/test/java/com/ichi2/anki/CardBrowserTest.kt

@@ -520,7 +520,7 @@ class CardBrowserTest : RobolectricTest() {
                 not(equalTo(targetDid)),
             )
 
-            b.viewModel.setDeckId(targetDid)
+            b.viewModel.setSelectedDeck(targetDid)
 
             assertThat("The target deck should be selected", b.lastDeckId, equalTo(targetDid))
 
@@ -1169,7 +1169,7 @@ class CardBrowserTest : RobolectricTest() {
             val secondDeckId = requireNotNull(col.decks.idForName("Second"))
 
             browserWithNoNewCards.apply {
-                viewModel.setDeckId(secondDeckId)
+                viewModel.setSelectedDeck(secondDeckId)
                 assertThat(viewModel.deckId, equalTo(secondDeckId))
                 finish()
             }

AnkiDroid/src/test/java/com/ichi2/anki/browser/CardBrowserViewModelTest.kt

@@ -24,7 +24,6 @@ import app.cash.turbine.test
 import com.ichi2.anki.AnkiDroidApp
 import com.ichi2.anki.CardBrowser
 import com.ichi2.anki.CollectionManager
-import com.ichi2.anki.DeckSpinnerSelection
 import com.ichi2.anki.Flag
 import com.ichi2.anki.NoteEditorActivity
 import com.ichi2.anki.NoteEditorFragment
@@ -66,6 +65,7 @@ import com.ichi2.anki.libanki.QueueType.ManuallyBuried
 import com.ichi2.anki.libanki.QueueType.New
 import com.ichi2.anki.libanki.testutils.AnkiTest
 import com.ichi2.anki.model.CardsOrNotes
+import com.ichi2.anki.model.SelectableDeck
 import com.ichi2.anki.model.SortType
 import com.ichi2.anki.model.SortType.NO_SORTING
 import com.ichi2.anki.model.SortType.SORT_FIELD
@@ -161,7 +161,7 @@ class CardBrowserViewModelTest : JvmTest() {
 
             assertThat("All decks should not be selected", !hasSelectedAllDecks())
 
-            setDeckId(DeckSpinnerSelection.ALL_DECKS_ID)
+            setSelectedDeck(SelectableDeck.AllDecks)
 
             assertThat("All decks should be selected", hasSelectedAllDecks())
 
@@ -1022,7 +1022,7 @@ class CardBrowserViewModelTest : JvmTest() {
     fun `deck name with quotes is properly escaped in search query`() =
         runViewModelTest {
             val deckWithQuotes = addDeck("Test\"Quotes\"In\"Deck")
-            setDeckId(deckWithQuotes)
+            setSelectedDeck(deckWithQuotes)
 
             assertThat(
                 "Quotes in deck name should be escaped with backslashes",