refactor: Cleanup and improve state management logic in reader (#228)

* Remove the existing reader bottom sheet menu for now, to add a better option later. * Change reader data to progress data * improve state management logic in reader detail screen --------- Signed-off-by: starry-shivam <[email protected]>
Pool-Of-Tears · Sep 27, 2024 · b62d804 · b62d804
1 parent 4ad8b45
commit b62d804
Show file tree

Hide file tree

Showing 19 changed files with 638 additions and 833 deletions.
diff --git a/.idea/deploymentTargetSelector.xml b/.idea/deploymentTargetSelector.xml
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
@@ -37,7 +37,7 @@
         </activity>
 
         <activity
-            android:name=".ui.screens.reader.activities.ReaderActivity"
+            android:name=".ui.screens.reader.main.activities.ReaderActivity"
             android:configChanges="orientation|screenSize|uiMode|locale|layoutDirection|screenLayout"
             android:exported="true">
             <intent-filter>

diff --git a/app/src/main/java/com/starry/myne/MainViewModel.kt b/app/src/main/java/com/starry/myne/MainViewModel.kt
@@ -28,7 +28,7 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.starry.myne.database.library.LibraryDao
-import com.starry.myne.database.reader.ReaderDao
+import com.starry.myne.database.progress.ProgressDao
 import com.starry.myne.ui.navigation.BottomBarScreen
 import com.starry.myne.ui.navigation.Screens
 import com.starry.myne.ui.screens.welcome.viewmodels.WelcomeDataStore
@@ -43,7 +43,7 @@ import javax.inject.Inject
 class MainViewModel @Inject constructor(
     private val welcomeDataStore: WelcomeDataStore,
     private val libraryDao: LibraryDao,
-    private val readerDao: ReaderDao
+    private val progressDao: ProgressDao
 ) :
     ViewModel() {
     private val _isLoading: MutableState<Boolean> = mutableStateOf(true)
@@ -86,7 +86,7 @@ class MainViewModel @Inject constructor(
         onComplete: (List<ShortcutInfo>) -> Unit
     ) {
         viewModelScope.launch(Dispatchers.IO) {
-            val libraryItems = readerDao.getAllReaderItems()
+            val libraryItems = progressDao.getAllReaderItems()
                 .sortedByDescending { it.lastReadTime }
                 .take(limit - 1).mapNotNull {
                     libraryDao.getItemById(it.libraryItemId)

diff --git a/app/src/main/java/com/starry/myne/database/MyneDatabase.kt b/app/src/main/java/com/starry/myne/database/MyneDatabase.kt
@@ -24,12 +24,12 @@ import androidx.room.RoomDatabase
 import androidx.room.migration.Migration
 import com.starry.myne.database.library.LibraryDao
 import com.starry.myne.database.library.LibraryItem
-import com.starry.myne.database.reader.ReaderDao
-import com.starry.myne.database.reader.ReaderData
+import com.starry.myne.database.progress.ProgressDao
+import com.starry.myne.database.progress.ProgressData
 import com.starry.myne.helpers.Constants
 
 @Database(
-    entities = [LibraryItem::class, ReaderData::class],
+    entities = [LibraryItem::class, ProgressData::class],
     version = 5,
     exportSchema = true,
     autoMigrations = [
@@ -41,7 +41,7 @@ import com.starry.myne.helpers.Constants
 abstract class MyneDatabase : RoomDatabase() {
 
     abstract fun getLibraryDao(): LibraryDao
-    abstract fun getReaderDao(): ReaderDao
+    abstract fun getReaderDao(): ProgressDao
 
     companion object {
 

diff --git a/app/src/main/java/com/starry/myne/database/library/LibraryItem.kt b/app/src/main/java/com/starry/myne/database/library/LibraryItem.kt
@@ -27,6 +27,15 @@ import java.text.StringCharacterIterator
 import java.util.Date
 import java.util.Locale
 
+/**
+ * Data class for storing the library items (books).
+ *
+ * @param bookId The ID of the book.
+ * @param title The title of the book.
+ * @param authors The authors of the book.
+ * @param filePath The path to the book file.
+ * @param createdAt The time when the book was added to the library.
+ */
 @Entity(tableName = "book_library")
 data class LibraryItem(
     @ColumnInfo(name = "book_id")

diff --git a/.../starry/myne/database/reader/ReaderDao.kt → ...rry/myne/database/progress/ProgressDao.kt b/.../starry/myne/database/reader/ReaderDao.kt → ...rry/myne/database/progress/ProgressDao.kt
@@ -15,7 +15,7 @@
  */
 
 
-package com.starry.myne.database.reader
+package com.starry.myne.database.progress
 
 import androidx.room.Dao
 import androidx.room.Insert
@@ -26,23 +26,23 @@ import kotlinx.coroutines.flow.Flow
 
 
 @Dao
-interface ReaderDao {
+interface ProgressDao {
 
     @Insert(onConflict = OnConflictStrategy.REPLACE)
-    fun insert(readerData: ReaderData)
+    fun insert(progressData: ProgressData)
 
     @Query("DELETE FROM reader_table WHERE library_item_id = :libraryItemId")
     fun delete(libraryItemId: Int)
 
     @Update
-    fun update(readerData: ReaderData)
+    fun update(progressData: ProgressData)
 
     @Query("SELECT * FROM reader_table WHERE library_item_id = :libraryItemId")
-    fun getReaderData(libraryItemId: Int): ReaderData?
+    fun getReaderData(libraryItemId: Int): ProgressData?
 
     @Query("SELECT * FROM reader_table")
-    fun getAllReaderItems(): List<ReaderData>
+    fun getAllReaderItems(): List<ProgressData>
 
     @Query("SELECT * FROM reader_table WHERE library_item_id = :libraryItemId")
-    fun getReaderDataAsFlow(libraryItemId: Int): Flow<ReaderData>?
+    fun getReaderDataAsFlow(libraryItemId: Int): Flow<ProgressData>?
 }
diff --git a/...starry/myne/database/reader/ReaderData.kt → ...ry/myne/database/progress/ProgressData.kt b/...starry/myne/database/reader/ReaderData.kt → ...ry/myne/database/progress/ProgressData.kt
@@ -15,15 +15,23 @@
  */
 
 
-package com.starry.myne.database.reader
+package com.starry.myne.database.progress
 
 import androidx.room.ColumnInfo
 import androidx.room.Entity
 import androidx.room.PrimaryKey
 import java.util.Locale
 
+/**
+ * Data class for storing the reading progress of a library item (book).
+ *
+ * @param libraryItemId The ID of the library item.
+ * @param lastChapterIndex The index of the last chapter read.
+ * @param lastChapterOffset The offset of the last chapter read.
+ * @param lastReadTime The time when the last chapter was read.
+ */
 @Entity(tableName = "reader_table")
-data class ReaderData(
+data class ProgressData(
     @ColumnInfo(name = "library_item_id") val libraryItemId: Int,
     @ColumnInfo(name = "last_chapter_index") val lastChapterIndex: Int,
     @ColumnInfo(name = "last_chapter_offset") val lastChapterOffset: Int,

diff --git a/app/src/main/java/com/starry/myne/ui/common/BookDetailTopUI.kt b/app/src/main/java/com/starry/myne/ui/common/BookDetailTopUI.kt
@@ -155,7 +155,7 @@ fun BookDetailTopUI(
                     color = MaterialTheme.colorScheme.onBackground,
                 )
 
-                progressPercent?.let {
+                if (!progressPercent.isNullOrBlank()) {
                     Text(
                         text = "$progressPercent% Completed",
                         modifier = Modifier.padding(start = 12.dp, end = 8.dp),
@@ -167,7 +167,6 @@ fun BookDetailTopUI(
                         color = MaterialTheme.colorScheme.onBackground,
                     )
                 }
-
                 Spacer(modifier = Modifier.height(50.dp))
             }
         }

diff --git a/app/src/main/java/com/starry/myne/ui/navigation/NavGraph.kt b/app/src/main/java/com/starry/myne/ui/navigation/NavGraph.kt
@@ -31,7 +31,7 @@ import com.starry.myne.ui.screens.categories.composables.CategoryDetailScreen
 import com.starry.myne.ui.screens.detail.composables.BookDetailScreen
 import com.starry.myne.ui.screens.home.composables.HomeScreen
 import com.starry.myne.ui.screens.library.composables.LibraryScreen
-import com.starry.myne.ui.screens.reader.composables.ReaderDetailScreen
+import com.starry.myne.ui.screens.reader.detail.ReaderDetailScreen
 import com.starry.myne.ui.screens.settings.composables.AboutScreen
 import com.starry.myne.ui.screens.settings.composables.OSLScreen
 import com.starry.myne.ui.screens.settings.composables.SettingsScreen