NF: Transform Deck into a class value

The first interest of this change is that we are not deep cloning all
decks when creating a Deck object which should save a little bit of
time, especially loading time on collection with a lot of decks.

Instead, we have a better typing at zero runtime cost.

The second interest is that we are certain that the fact that the Deck
is implemented as a JSONObject is hidden from the developer using this
class. Instead, they can only use the provided extension, or add the
one they needs.

While most changes are relatively trivial, moving the implementation
from everywhere in the code to Deck.kt, there are some extra changes
that were needed.

I moved `getLongOrNull` to PythonExtension given that it implements
the behavior of a Python function we want to reuse, this seems more
consistent.

As value class can't be lateinit, I hardcoded
AppCompatPreferenceActivity as being a getter for the backing field
`_deck: Deck?`.

I added in testutils/JsonUtils helper method that accepts a json
holder, and a string representing the expected json, to simplify the
use of those methods.

The code used sometime `optLong("id")` and sometime
`getLong("id")`. There seems to be no reason for the difference
between both use case, and just be random choice from the
developer. Anyway, if a deck lacks an id, any place using
`getLong("id")` would have caused the code to crash, so replacing the
`optLong` by `getLong` would, in the worst case, move the time at
which the user is asked to clean their database.

There seems to be a single key we sometime set to JSONObject.NULL, it
was `delays`. For the sake of typing, the property `delays` in `deck`
is thus of type `JSONArray?`. When the value `null` is assigned to
this property, `NULL` is saved in the object, and reciprocally.

There is no need to check whether `deck` has "empty" key before
removing it. It's not even more efficient.

Author: Arthur-Milchior

AnkiDroid/src/androidTest/java/com/ichi2/anki/tests/ContentProviderTest.kt

@@ -930,7 +930,7 @@ class ContentProviderTest : InstrumentedTest() {
                 assertNotNull("Check that the deck we received actually exists", deck)
                 assertEquals(
                     "Check that the received deck has the correct name",
-                    deck.getString("name"),
+                    deck.name,
                     deckName,
                 )
             }
@@ -964,7 +964,7 @@ class ContentProviderTest : InstrumentedTest() {
                 )
                 assertEquals(
                     "Check that received deck name equals real deck name",
-                    realDeck.getString("name"),
+                    realDeck.name,
                     returnedDeckName,
                 )
             }

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

@@ -993,7 +993,7 @@ open class DeckPicker :
                     override fun onQueryTextChange(newText: String): Boolean {
                         val adapter = recyclerView.adapter as DeckAdapter
                         launchCatchingTask {
-                            val selectedDeckId = withCol { decks.current().getLong("id") }
+                            val selectedDeckId = withCol { decks.current().id }
                             dueTree?.let {
                                 adapter.submit(
                                     data = it.filterAndFlatten(newText),
@@ -2333,7 +2333,7 @@ open class DeckPicker :
         deckListAdapter.submit(
             data = tree.filterAndFlatten(currentFilter),
             hasSubDecks = tree.children.any { it.children.any() },
-            currentDeckId = withCol { decks.current().getLong("id") },
+            currentDeckId = withCol { decks.current().id },
         )
 
         // Set the "x due" subtitle
@@ -2347,7 +2347,7 @@ open class DeckPicker :
         }.onFailure {
             Timber.w(it, "Failed to set the due count as the subtitle in the toolbar")
         }
-        val current = withCol { decks.current().optLong("id") }
+        val current = withCol { decks.current().id }
         if (viewModel.focusedDeck != current) {
             scrollDecklistToDeck(current)
             viewModel.focusedDeck = current

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

@@ -30,12 +30,12 @@ import androidx.core.content.edit
 import com.ichi2.anki.analytics.UsageAnalytics
 import com.ichi2.annotations.NeedsTest
 import com.ichi2.libanki.Collection
+import com.ichi2.libanki.Deck.Term
 import com.ichi2.preferences.StepsPreference.Companion.convertFromJSON
 import com.ichi2.preferences.StepsPreference.Companion.convertToJSON
 import com.ichi2.themes.Themes
 import com.ichi2.ui.AppCompatPreferenceActivity
 import com.ichi2.utils.stringIterable
-import org.json.JSONArray
 import org.json.JSONException
 import org.json.JSONObject
 import timber.log.Timber
@@ -59,92 +59,90 @@ class FilteredDeckOptions :
             "{'search'=\"\", 'steps'=\"1 10 20\", 'order'=0}",
         )
 
-    inner class DeckPreferenceHack : AppCompatPreferenceActivity<FilteredDeckOptions.DeckPreferenceHack>.AbstractPreferenceHack() {
-        var secondFilter = false
+    inner class DeckPreferenceHack : AppCompatPreferenceActivity<DeckPreferenceHack>.AbstractPreferenceHack() {
+        val hasSecondFilter: Boolean
+            get() = deck.secondFilter != null
 
         override fun cacheValues() {
             Timber.d("cacheValues()")
-            val ar = deck.getJSONArray("terms").getJSONArray(0)
-            secondFilter = deck.getJSONArray("terms").length() > 1
-            val ar2: JSONArray?
-            values["search"] = ar.getString(0)
-            values["limit"] = ar.getString(1)
-            values["order"] = ar.getString(2)
-            if (secondFilter) {
-                ar2 = deck.getJSONArray("terms").getJSONArray(1)
-                values["search_2"] = ar2.getString(0)
-                values["limit_2"] = ar2.getString(1)
-                values["order_2"] = ar2.getString(2)
+            deck.firstFilter.apply {
+                values["search"] = search
+                values["limit"] = limit
+                values["order"] = order.toString()
             }
-            val delays = deck.optJSONArray("delays")
+            deck.secondFilter?.apply {
+                values["search_2"] = search
+                values["limit_2"] = limit
+                values["order_2"] = order.toString()
+            }
+            val delays = deck.delays
             if (delays != null) {
                 values["steps"] = convertFromJSON(delays)
                 values["stepsOn"] = java.lang.Boolean.toString(true)
             } else {
                 values["steps"] = "1 10"
                 values["stepsOn"] = java.lang.Boolean.toString(false)
             }
-            values["resched"] = java.lang.Boolean.toString(deck.getBoolean("resched"))
-            values["previewAgainSecs"] = deck.getString("previewAgainSecs")
-            values["previewHardSecs"] = deck.getString("previewHardSecs")
-            values["previewGoodSecs"] = deck.getString("previewGoodSecs")
+            values["resched"] = java.lang.Boolean.toString(deck.resched)
+            values["previewAgainSecs"] = deck.previewAgainSecs
+            values["previewHardSecs"] = deck.previewHardSecs
+            values["previewGoodSecs"] = deck.previewGoodSecs
         }
 
-        inner class Editor : AppCompatPreferenceActivity<FilteredDeckOptions.DeckPreferenceHack>.AbstractPreferenceHack.Editor() {
+        inner class Editor : AppCompatPreferenceActivity<DeckPreferenceHack>.AbstractPreferenceHack.Editor() {
             override fun commit(): Boolean {
                 Timber.d("commit() changes back to database")
                 for ((key, value) in update.valueSet()) {
                     Timber.i("Change value for key '%s': %s", key, value)
-                    val ar = deck.getJSONArray("terms")
-                    if (pref.secondFilter) {
+                    deck.secondFilter?.apply {
                         when (key) {
                             "search_2" -> {
-                                ar.getJSONArray(1).put(0, value)
+                                search = value as String
                             }
                             "limit_2" -> {
-                                ar.getJSONArray(1).put(1, value)
+                                limit = value as String
                             }
                             "order_2" -> {
-                                ar.getJSONArray(1).put(2, (value as String).toInt())
+                                order = (value as String).toInt()
                             }
                         }
                     }
                     when (key) {
                         "search" -> {
-                            ar.getJSONArray(0).put(0, value)
+                            deck.firstFilter.search = value as String
                         }
 
                         "limit" -> {
-                            ar.getJSONArray(0).put(1, value)
+                            deck.firstFilter.limit = value as String
                         }
                         "order" -> {
-                            ar.getJSONArray(0).put(2, (value as String).toInt())
+                            deck.firstFilter.order = (value as String).toInt()
                         }
                         "resched" -> {
-                            deck.put("resched", value)
+                            deck.resched = value as Boolean
                         }
                         "previewAgainSecs" -> {
-                            deck.put("previewAgainSecs", value)
+                            deck.previewAgainSecs = value as String
                         }
                         "previewHardSecs" -> {
-                            deck.put("previewHardSecs", value)
+                            deck.previewHardSecs = value as String
                         }
                         "previewGoodSecs" -> {
-                            deck.put("previewGoodSecs", value)
+                            deck.previewGoodSecs = value as String
                         }
                         "stepsOn" -> {
                             val on = value as Boolean
                             if (on) {
                                 val steps = convertToJSON(values["steps"]!!)
                                 if (steps!!.length() > 0) {
-                                    deck.put("delays", steps)
+                                    deck.delays = steps
                                 }
                             } else {
-                                deck.put("delays", JSONObject.NULL)
+                                deck.delays = null
                             }
                         }
                         "steps" -> {
-                            deck.put("delays", convertToJSON((value as String)))
+                            deck.delays = convertToJSON((value as String))
                         }
                         "preset" -> {
                             val i: Int = (value as String).toInt()
@@ -210,7 +208,7 @@ class FilteredDeckOptions :
             return
         }
         val extras = intent.extras
-        deck = if (extras != null && extras.containsKey("did")) {
+        deck = if (extras?.containsKey("did") == true) {
             col.decks.get(extras.getLong("did"))
         } else {
             null
@@ -238,7 +236,7 @@ class FilteredDeckOptions :
         if (title.contains("XXX")) {
             title =
                 try {
-                    title.replace("XXX", deck.getString("name"))
+                    title.replace("XXX", deck.name)
                 } catch (e: JSONException) {
                     Timber.w(e)
                     title.replace("XXX", "???")
@@ -282,7 +280,7 @@ class FilteredDeckOptions :
         if (prefChanged) {
             // Rebuild the filtered deck if a setting has changed
             try {
-                col.sched.rebuildDyn(deck.getLong("id"))
+                col.sched.rebuildDyn(deck.id)
             } catch (e: JSONException) {
                 Timber.e(e)
             }
@@ -336,7 +334,7 @@ class FilteredDeckOptions :
         newOrderPref.value = pref.getString("order", "0")
         newOrderPrefSecond.setEntries(R.array.cram_deck_conf_order_labels)
         newOrderPrefSecond.setEntryValues(R.array.cram_deck_conf_order_values)
-        if (pref.secondFilter) {
+        if (pref.hasSecondFilter) {
             newOrderPrefSecond.value = pref.getString("order_2", "5")
         }
     }
@@ -345,7 +343,7 @@ class FilteredDeckOptions :
     private fun setupSecondFilterListener() {
         val secondFilterSign = findPreference("filterSecond") as CheckBoxPreference
         val secondFilter = findPreference("secondFilter") as PreferenceCategory
-        if (pref.secondFilter) {
+        if (pref.hasSecondFilter) {
             secondFilter.isEnabled = true
             secondFilterSign.isChecked = true
         }
@@ -355,15 +353,14 @@ class FilteredDeckOptions :
                     return@OnPreferenceChangeListener true
                 }
                 if (!newValue) {
-                    deck.getJSONArray("terms").remove(1)
+                    deck.secondFilter = null
                     secondFilter.isEnabled = false
                 } else {
                     secondFilter.isEnabled = true
                     /**Link to the defaults used in AnkiDesktop
                      * <https://github.com/ankitects/anki/blob/1b15069b248a8f86f9bd4b3c66a9bfeab8dfb2b8/qt/aqt/filtered_deck.py#L148-L149>
                      */
-                    val narr = JSONArray(listOf("", 20, 5))
-                    deck.getJSONArray("terms").put(1, narr)
+                    deck.secondFilter = Term("", 20.toString(), 5)
                     val newOrderPrefSecond = findPreference("order_2") as ListPreference
                     newOrderPrefSecond.value = "5"
                 }

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

@@ -2649,7 +2649,7 @@ class NoteEditor :
 
         getColUnsafe.notetypes.setCurrent(model)
         val currentDeck = getColUnsafe.decks.current()
-        currentDeck.put("mid", newId)
+        currentDeck.noteTypeId = newId
         getColUnsafe.decks.save(currentDeck)
 
         // Update deck

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

@@ -43,7 +43,6 @@ import com.ichi2.anki.CollectionManager.withCol
 import com.ichi2.anki.dialogs.customstudy.CustomStudyDialog
 import com.ichi2.anki.snackbar.showSnackbar
 import com.ichi2.anki.ui.internationalization.toSentenceCase
-import com.ichi2.anki.utils.ext.description
 import com.ichi2.anki.utils.ext.showDialogFragment
 import com.ichi2.libanki.ChangeManager
 import com.ichi2.libanki.Collection
@@ -422,8 +421,8 @@ class StudyOptionsFragment :
             if (loadWithDeckOptions) {
                 loadWithDeckOptions = false
                 val deck = col!!.decks.current()
-                if (deck.isFiltered && deck.has("empty")) {
-                    deck.remove("empty")
+                if (deck.isFiltered) {
+                    deck.removeEmpty()
                 }
                 launchCatchingTask { rebuildCram() }
             } else {
@@ -553,7 +552,7 @@ class StudyOptionsFragment :
             // Set the deck name
             val deck = col.decks.current()
             // Main deck name
-            val fullName = deck.getString("name")
+            val fullName = deck.name
             val name = Decks.path(fullName)
             val nameBuilder = StringBuilder()
             if (name.isNotEmpty()) {

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/EditDeckDescriptionDialog.kt

@@ -28,7 +28,6 @@ import com.ichi2.anki.CollectionManager.withCol
 import com.ichi2.anki.R
 import com.ichi2.anki.StudyOptionsFragment
 import com.ichi2.anki.launchCatchingTask
-import com.ichi2.anki.utils.ext.description
 import com.ichi2.anki.utils.ext.update
 import com.ichi2.libanki.DeckId
 import com.ichi2.themes.Themes

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/customstudy/CustomStudyDialog.kt

@@ -63,7 +63,6 @@ import com.ichi2.anki.withProgress
 import com.ichi2.annotations.NeedsTest
 import com.ichi2.libanki.Collection
 import com.ichi2.libanki.Consts
-import com.ichi2.libanki.Consts.DynPriority
 import com.ichi2.libanki.Deck
 import com.ichi2.libanki.DeckId
 import com.ichi2.libanki.undoableOp
@@ -78,7 +77,6 @@ import com.ichi2.utils.setPaddingRelative
 import com.ichi2.utils.textAsIntOrNull
 import com.ichi2.utils.title
 import net.ankiweb.rsdroid.exceptions.BackendDeckIsFilteredException
-import org.json.JSONObject
 import timber.log.Timber
 
 /**
@@ -439,10 +437,10 @@ class CustomStudyDialog(
             } else {
                 Timber.i("Emptying dynamic deck '%s' for custom study", customStudyDeck)
                 // safe to empty
-                collection.sched.emptyDyn(cur.getLong("id"))
+                collection.sched.emptyDyn(cur.id)
                 // reuse; don't delete as it may have children
                 dyn = cur
-                decks.select(cur.getLong("id"))
+                decks.select(cur.id)
             }
         } else {
             Timber.i("Creating Dynamic Deck '%s' for custom study", customStudyDeck)
@@ -455,13 +453,13 @@ class CustomStudyDialog(
                 }
         }
         // and then set various options
-        dyn.put("delays", JSONObject.NULL)
-        val ar = dyn.getJSONArray("terms")
-        ar.getJSONArray(0).put(0, """deck:"$deckToStudyName" terms[0]""")
-        ar.getJSONArray(0).put(1, terms[1])
-        @DynPriority val priority = terms[2] as Int
-        ar.getJSONArray(0).put(2, priority)
-        dyn.put("resched", true)
+        dyn.delays = null
+        dyn.firstFilter.apply {
+            search = """deck:"$deckToStudyName" terms[0]"""
+            limit = terms[1] as String
+            order = terms[2] as Int
+        }
+        dyn.resched = true
         // Rebuild the filtered deck
         Timber.i("Rebuilding Custom Study Deck")
         // PERF: Should be in background

AnkiDroid/src/main/java/com/ichi2/anki/provider/CardContentProvider.kt

@@ -34,7 +34,6 @@ import com.ichi2.anki.CollectionManager
 import com.ichi2.anki.CrashReportService
 import com.ichi2.anki.Ease
 import com.ichi2.anki.FlashCardsContract
-import com.ichi2.anki.utils.ext.description
 import com.ichi2.libanki.Card
 import com.ichi2.libanki.CardTemplate
 import com.ichi2.libanki.Collection
@@ -979,7 +978,7 @@ class CardContentProvider : ContentProvider() {
                     try {
                         val deckDesc = values.getAsString(FlashCardsContract.Deck.DECK_DESC)
                         if (deckDesc != null) {
-                            deck.put("desc", deckDesc)
+                            deck.description = deckDesc
                         }
                     } catch (e: JSONException) {
                         Timber.e(e, "Could not set a field of new deck %s", deckName)

AnkiDroid/src/main/java/com/ichi2/anki/services/ReminderService.kt

@@ -149,7 +149,7 @@ class ReminderService : BroadcastReceiver() {
             for (node in dues) {
                 val deck: Deck? = col.decks.get(node.did)
                 // Dynamic deck has no "conf", so are not added here.
-                if (deck != null && deck.optLong("conf") == dConfId) {
+                if (deck != null && deck.conf == dConfId) {
                     decks.add(node)
                 }
             }

AnkiDroid/src/main/java/com/ichi2/anki/utils/ext/Deck.kt

@@ -20,12 +20,6 @@ import com.ichi2.libanki.Deck
 import com.ichi2.libanki.DeckId
 import com.ichi2.libanki.Decks
 
-var Deck.description: String
-    get() = optString("desc", "")
-    set(value) {
-        put("desc", value)
-    }
-
 fun Decks.update(
     did: DeckId,
     block: Deck.() -> Unit,