Closes #8751: Added methods to rename top site entries

components/feature/top-sites/src/androidTest/java/mozilla/components/feature/top/sites/db/PinnedSiteDaoTest.kt

@@ -57,6 +57,29 @@ class PinnedSiteDaoTest {
         assertEquals(topSite, pinnedSites[0])
     }
 
+    @Test
+    fun testUpdatingTopSite() {
+        val topSite = PinnedSiteEntity(
+                title = "Mozilla",
+                url = "https://www.mozilla.org",
+                isDefault = false,
+                createdAt = 200
+        ).also {
+            it.id = pinnedSiteDao.insertPinnedSite(it)
+        }
+
+        topSite.title = "Mozilla (IT)"
+        topSite.url = "https://www.mozilla.org/it"
+        pinnedSiteDao.updatePinnedSite(topSite)
+
+        val pinnedSites = pinnedSiteDao.getPinnedSites()
+
+        assertEquals(1, pinnedSites.size)
+        assertEquals(topSite, pinnedSites[0])
+        assertEquals(topSite.title, pinnedSites[0].title)
+        assertEquals(topSite.url, pinnedSites[0].url)
+    }
+
     @Test
     fun testRemovingTopSite() {
         val topSite1 = PinnedSiteEntity(

components/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/DefaultTopSitesStorage.kt

@@ -51,6 +51,16 @@ class DefaultTopSitesStorage(
         }
     }
 
+    override fun renameTopSite(topSite: TopSite, title: String) {
+        scope.launch {
+            if (topSite.type != FRECENT) {
+                pinnedSitesStorage.renamePinnedSite(topSite, title)
+            }
+
+            notifyObservers { onStorageUpdated() }
+        }
+    }
+
     override fun removeTopSite(topSite: TopSite) {
         scope.launch {
             if (topSite.type != FRECENT) {

components/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/PinnedSiteStorage.kt

@@ -67,6 +67,18 @@ class PinnedSiteStorage(context: Context) {
         pinnedSiteDao.getPinnedSites().map { entity -> entity.toTopSite() }
     }
 
+    /**
+     * Renames the given pinned site.
+     *
+     * @param site The pinned site.
+     * @param title The new title for the top site.
+     */
+    suspend fun renamePinnedSite(site: TopSite, title: String) = withContext(IO) {
+        val pinnedSite = site.toPinnedSite()
+        pinnedSite.title = title
+        pinnedSiteDao.updatePinnedSite(pinnedSite)
+    }
+
     /**
      * Removes the given pinned site.
      *

components/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/TopSitesStorage.kt

@@ -20,6 +20,14 @@ interface TopSitesStorage : Observable<TopSitesStorage.Observer> {
      */
     fun addTopSite(title: String, url: String, isDefault: Boolean = false)
 
+    /**
+     * Renames the given [TopSite].
+     *
+     * @param topSite The top site.
+     * @param title The new title for the top site.
+     */
+    fun renameTopSite(topSite: TopSite, title: String)
+
     /**
      * Removes the given [TopSite].
      *

components/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/TopSitesUseCases.kt

@@ -23,6 +23,21 @@ class TopSitesUseCases(topSitesStorage: TopSitesStorage) {
         }
     }
 
+    /**
+     * Rename a top site use case.
+     */
+    class RenameTopSiteUseCase internal constructor(private val storage: TopSitesStorage) {
+        /**
+         * Renames the given [TopSite].
+         *
+         * @param topSite The top site.
+         * @param title The new title for the top site.
+         */
+        operator fun invoke(topSite: TopSite, title: String) {
+            storage.renameTopSite(topSite, title)
+        }
+    }
+
     /**
      * Remove a top site use case.
      */
@@ -41,6 +56,10 @@ class TopSitesUseCases(topSitesStorage: TopSitesStorage) {
         AddPinnedSiteUseCase(topSitesStorage)
     }
 
+    val renameTopSites: RenameTopSiteUseCase by lazy {
+        RenameTopSiteUseCase(topSitesStorage)
+    }
+
     val removeTopSites: RemoveTopSiteUseCase by lazy {
         RemoveTopSiteUseCase(topSitesStorage)
     }

components/feature/top-sites/src/main/java/mozilla/components/feature/top/sites/db/PinnedSiteDao.kt

@@ -10,6 +10,7 @@ import androidx.room.Delete
 import androidx.room.Insert
 import androidx.room.Query
 import androidx.room.Transaction
+import androidx.room.Update
 
 /**
  * Internal DAO for accessing [PinnedSiteEntity] instances.
@@ -20,6 +21,10 @@ internal interface PinnedSiteDao {
     @Insert
     fun insertPinnedSite(site: PinnedSiteEntity): Long
 
+    @WorkerThread
+    @Update
+    fun updatePinnedSite(site: PinnedSiteEntity)
+
     @WorkerThread
     @Delete
     fun deletePinnedSite(site: PinnedSiteEntity)

components/feature/top-sites/src/test/java/mozilla/components/feature/top/sites/TopSitesUseCasesTest.kt

@@ -27,6 +27,18 @@ class TopSitesUseCasesTest {
         )
     }
 
+    @Test
+    fun `RenameTopSiteUseCase`() = runBlocking {
+        val topSitesStorage: TopSitesStorage = mock()
+        val topSite: TopSite = mock()
+        val useCases = TopSitesUseCases(topSitesStorage)
+
+        val title = "New title"
+        useCases.renameTopSites(topSite, title)
+
+        verify(topSitesStorage).renameTopSite(topSite, title)
+    }
+
     @Test
     fun `RemoveTopSiteUseCase`() = runBlocking {
         val topSitesStorage: TopSitesStorage = mock()

docs/changelog.md

@@ -24,6 +24,9 @@ permalink: /changelog/
 * **feature-downloads**
   * 🚒 Bug fixed [issue #8585](https://github.com/mozilla-mobile/android-components/issues/8784) create download directory when it doesn't exists for more information see [mozilla-mobile/fenix#15527](https://github.com/mozilla-mobile/fenix/issues/5829).
 
+* **feature-top-sites**
+  * Added methods to rename top site entries.
+
 # 63.0.0
 
 * [Commits](https://github.com/mozilla-mobile/android-components/compare/v62.0.0...v63.0.0)