improvement: introduce DeckPickerViewModel #17690
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* | ||
| * Copyright (c) 2024 David Allison <davidallisongithub@gmail.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.deckpicker | ||
|
|
||
| import androidx.annotation.CheckResult | ||
| import androidx.lifecycle.ViewModel | ||
| import androidx.lifecycle.viewModelScope | ||
| import anki.i18n.GeneratedTranslations | ||
| import com.ichi2.anki.CollectionManager.TR | ||
| import com.ichi2.anki.CollectionManager.withCol | ||
| import com.ichi2.anki.DeckPicker | ||
| import com.ichi2.libanki.Consts | ||
| import com.ichi2.libanki.DeckId | ||
| import com.ichi2.libanki.undoableOp | ||
| import kotlinx.coroutines.flow.MutableSharedFlow | ||
| import kotlinx.coroutines.launch | ||
|
|
||
| /** @see [DeckPicker] */ | ||
| class DeckPickerViewModel : ViewModel() { | ||
| /** | ||
| * @see deleteDeck | ||
| * @see DeckDeletionResult | ||
| */ | ||
| val deckDeletedNotification = MutableSharedFlow<DeckDeletionResult>() | ||
|
There was a problem hiding this comment. This could be part of an 'undoableSnackbar' flow, didn't seem useful |
||
|
|
||
| /** | ||
| * Keep track of which deck was last given focus in the deck list. If we find that this value | ||
| * has changed between deck list refreshes, we need to recenter the deck list to the new current | ||
| * deck. | ||
| */ | ||
| // TODO: This should later be handled as a Flow | ||
| var focusedDeck: DeckId = 0 | ||
|
|
||
| /** | ||
| * Deletes the provided deck, child decks. and all cards inside. | ||
| * | ||
| * This is a slow operation and should be inside `withProgress` | ||
| * | ||
| * @param did ID of the deck to delete | ||
| */ | ||
| @CheckResult // This is a slow operation and should be inside `withProgress` | ||
| fun deleteDeck(did: DeckId) = | ||
| viewModelScope.launch { | ||
| val deckName = withCol { decks.get(did)!!.name } | ||
| val changes = undoableOp { decks.remove(listOf(did)) } | ||
| // After deletion: decks.current() reverts to Default, necessitating `focusedDeck` | ||
| // to match and avoid unnecessary scrolls in `renderPage()`. | ||
| focusedDeck = Consts.DEFAULT_DECK_ID | ||
|
|
||
| deckDeletedNotification.emit( | ||
| DeckDeletionResult(deckName = deckName, cardsDeleted = changes.count), | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Deletes the currently selected deck | ||
| * | ||
| * This is a slow operation and should be inside `withProgress` | ||
| */ | ||
| @CheckResult | ||
| fun deleteSelectedDeck() = | ||
| viewModelScope.launch { | ||
| val targetDeckId = withCol { decks.selected() } | ||
| deleteDeck(targetDeckId).join() | ||
| } | ||
lukstbit marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| /** Result of [DeckPickerViewModel.deleteDeck] */ | ||
| data class DeckDeletionResult( | ||
| val deckName: String, | ||
| val cardsDeleted: Int, | ||
| ) { | ||
| /** | ||
| * @see GeneratedTranslations.browsingCardsDeletedWithDeckname | ||
| */ | ||
| // TODO: Somewhat questionable meaning: {count} cards deleted from {deck_name}. | ||
| @CheckResult | ||
| fun toHumanReadableString() = | ||
| TR.browsingCardsDeletedWithDeckname( | ||
| count = cardsDeleted, | ||
| deckName = deckName, | ||
| ) | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SanjaySargam
showDeleteDeckConfirmationDialogis only used when pressing 'DEL', in all other cases, we delete unconditionally and show an 'undo' snackbarWas this intentional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it is intentional.