feat: order groups by when they most recently opened

Author: sds100

app/schemas/io.github.sds100.keymapper.data.db.AppDatabase/17.json

@@ -462,17 +462,21 @@ class BackupManagerImpl(
                     .toSet()
                     .also { groupUids.addAll(it) }
 
+                val currentTime = System.currentTimeMillis()
+
                 for (group in backupContent.groups) {
-                    var movedGroup = group
+                    // Set the last opened date to now so that the imported group
+                    // shows as the most recent.
+                    var modifiedGroup = group.copy(lastOpenedDate = currentTime)
 
                     // If the group's parent wasn't backed up or doesn't exist
                     // then set it the parent to the root group
                     if (!groupUids.contains(group.parentUid)) {
-                        movedGroup = movedGroup.copy(parentUid = null)
+                        modifiedGroup = modifiedGroup.copy(parentUid = null)
                     }
 
                     RepositoryUtils.saveUniqueName(
-                        movedGroup,
+                        modifiedGroup,
                         saveBlock = { groupRepository.insert(it) },
                         renameBlock = { entity, suffix ->
                             entity.copy(name = "${entity.name} $suffix")

app/src/main/java/io/github/sds100/keymapper/backup/BackupManager.kt

@@ -38,6 +38,7 @@ import io.github.sds100.keymapper.data.migration.Migration5To6
 import io.github.sds100.keymapper.data.migration.Migration6To7
 import io.github.sds100.keymapper.data.migration.Migration8To9
 import io.github.sds100.keymapper.data.migration.Migration9To10
+import io.github.sds100.keymapper.data.migration.fingerprintmaps.AutoMigration16To17
 
 /**
  * Created by sds100 on 24/01/2020.
@@ -51,6 +52,8 @@ import io.github.sds100.keymapper.data.migration.Migration9To10
         AutoMigration(from = 14, to = 15, spec = AutoMigration14To15::class),
         // This deletes the folder name column from key maps
         AutoMigration(from = 15, to = 16, spec = AutoMigration15To16::class),
+        // This adds last opened timestamp to groups
+        AutoMigration(from = 16, to = 17, spec = AutoMigration16To17::class),
     ],
 )
 @TypeConverters(
@@ -62,7 +65,7 @@ import io.github.sds100.keymapper.data.migration.Migration9To10
 abstract class AppDatabase : RoomDatabase() {
     companion object {
         const val DATABASE_NAME = "key_map_database"
-        const val DATABASE_VERSION = 16
+        const val DATABASE_VERSION = 17
 
         val MIGRATION_1_2 = object : Migration(1, 2) {
 

app/src/main/java/io/github/sds100/keymapper/data/db/AppDatabase.kt

@@ -20,6 +20,7 @@ interface GroupDao {
         const val KEY_CONSTRAINTS = "constraints"
         const val KEY_CONSTRAINT_MODE = "constraint_mode"
         const val KEY_PARENT_UID = "parent_uid"
+        const val KEY_LAST_OPENED_DATE = "last_opened_date"
     }
 
     @Query("SELECT * FROM $TABLE_NAME")
@@ -54,4 +55,7 @@ interface GroupDao {
 
     @Query("DELETE FROM $TABLE_NAME WHERE $KEY_UID IN (:uid)")
     suspend fun deleteByUid(vararg uid: String)
+
+    @Query("UPDATE $TABLE_NAME SET $KEY_LAST_OPENED_DATE = (:timestamp) WHERE $KEY_UID IS (:groupUid)")
+    suspend fun setLastOpenedDate(groupUid: String, timestamp: Long)
 }

app/src/main/java/io/github/sds100/keymapper/data/db/dao/GroupDao.kt

@@ -8,6 +8,7 @@ import androidx.room.Index
 import androidx.room.PrimaryKey
 import com.github.salomonbrys.kotson.byArray
 import com.github.salomonbrys.kotson.byInt
+import com.github.salomonbrys.kotson.byNullableLong
 import com.github.salomonbrys.kotson.byNullableString
 import com.github.salomonbrys.kotson.byString
 import com.github.salomonbrys.kotson.jsonDeserializer
@@ -51,6 +52,10 @@ data class GroupEntity(
     @SerializedName(NAME_PARENT_UID)
     val parentUid: String?,
 
+    @ColumnInfo(name = GroupDao.KEY_LAST_OPENED_DATE)
+    @SerializedName(NAME_LAST_OPENED_DATE)
+    val lastOpenedDate: Long?,
+
 ) : Parcelable {
     companion object {
         // DON'T CHANGE THESE. Used for JSON serialization and parsing.
@@ -59,6 +64,7 @@ data class GroupEntity(
         const val NAME_CONSTRAINTS = "constraints"
         const val NAME_CONSTRAINT_MODE = "constraint_mode"
         const val NAME_PARENT_UID = "parent_uid"
+        const val NAME_LAST_OPENED_DATE = "last_opened_date"
 
         val DESERIALIZER = jsonDeserializer {
             val uid by it.json.byString(NAME_UID)
@@ -69,8 +75,9 @@ data class GroupEntity(
 
             val constraintMode by it.json.byInt(NAME_CONSTRAINT_MODE)
             val parentUid by it.json.byNullableString(NAME_PARENT_UID)
+            val lastOpenedDate by it.json.byNullableLong(NAME_LAST_OPENED_DATE)
 
-            GroupEntity(uid, name, constraintList, constraintMode, parentUid)
+            GroupEntity(uid, name, constraintList, constraintMode, parentUid, lastOpenedDate)
         }
     }
 }

app/src/main/java/io/github/sds100/keymapper/data/entities/GroupEntity.kt

@@ -0,0 +1,5 @@
+package io.github.sds100.keymapper.data.migration.fingerprintmaps
+
+import androidx.room.migration.AutoMigrationSpec
+
+class AutoMigration16To17 : AutoMigrationSpec

app/src/main/java/io/github/sds100/keymapper/data/migration/fingerprintmaps/AutoMigration16To17.kt

@@ -27,6 +27,7 @@ interface GroupRepository {
     suspend fun insert(groupEntity: GroupEntity)
     suspend fun update(groupEntity: GroupEntity)
     fun delete(uid: String)
+    suspend fun setLastOpenedDate(groupUid: String, timestamp: Long)
 }
 
 class RoomGroupRepository(
@@ -81,4 +82,10 @@ class RoomGroupRepository(
             }
         }
     }
+
+    override suspend fun setLastOpenedDate(groupUid: String, timestamp: Long) {
+        withContext(dispatchers.io()) {
+            dao.setLastOpenedDate(groupUid, timestamp)
+        }
+    }
 }

app/src/main/java/io/github/sds100/keymapper/data/repositories/GroupRepository.kt

@@ -10,6 +10,7 @@ data class Group(
     val name: String,
     val constraintState: ConstraintState,
     val parentUid: String?,
+    val lastOpenedDate: Long,
 )
 
 object GroupEntityMapper {
@@ -24,6 +25,7 @@ object GroupEntityMapper {
             name = entity.name,
             constraintState = ConstraintState(constraintList, constraintMode),
             parentUid = entity.parentUid,
+            lastOpenedDate = entity.lastOpenedDate ?: System.currentTimeMillis(),
         )
     }
 
@@ -36,6 +38,7 @@ object GroupEntityMapper {
             },
             constraintMode = ConstraintModeEntityMapper.toEntity(group.constraintState.mode),
             parentUid = group.parentUid,
+            lastOpenedDate = group.lastOpenedDate,
         )
     }
 }

app/src/main/java/io/github/sds100/keymapper/groups/Group.kt

@@ -55,7 +55,9 @@ class ListKeyMapsUseCaseImpl(
     private val group: Flow<GroupWithSubGroups> = groupUid.flatMapLatest { groupUid ->
         if (groupUid == null) {
             groupRepository.getGroupsByParent(null).map { subGroupEntities ->
-                val subGroups = subGroupEntities.map(GroupEntityMapper::fromEntity)
+                val subGroups = subGroupEntities
+                    .map(GroupEntityMapper::fromEntity)
+                    .sortedByDescending { it.lastOpenedDate }
                 GroupWithSubGroups(group = null, subGroups = subGroups)
             }
         } else {
@@ -105,7 +107,11 @@ class ListKeyMapsUseCaseImpl(
 
     override suspend fun newGroup() {
         val defaultName = resourceProvider.getString(R.string.default_group_name)
-        val group = GroupEntity(parentUid = groupUid.value, name = defaultName)
+        val group = GroupEntity(
+            parentUid = groupUid.value,
+            name = defaultName,
+            lastOpenedDate = System.currentTimeMillis(),
+        )
 
         ensureUniqueName(group) {
             groupRepository.insert(it)
@@ -177,6 +183,8 @@ class ListKeyMapsUseCaseImpl(
                     list.plus(group.uid)
                 }
             }
+
+            groupRepository.setLastOpenedDate(group.uid, System.currentTimeMillis())
         }
     }