* Centralize library management logic and introduce support for plain text and HTML formats

* Centralize library management logic and introduce support for plain text and HTML formats

* Expand unit test coverage for library state management, UI models, and MainViewModel features.

* Add comprehensive unit tests for PDF reader core logic, preferences, and data persistence

* Add unit tests for EPUB parsing, content loading, search functionality, and reader JavaScript bridges.

* Add unit tests for OPDS parsing and Smart Collection engine, and integrate Kover plugin

* Add comprehensive unit tests

* Centralize library snapshot serialization in the `shared` module and improve filtering and sorting logic.

* Implement text selection, highlighting, and reading state persistence for PDF and EPUB engines in desktop version

* Folder import support for desktop app

* Introduce Smart Shelves with rule-based filtering in desktop version

* Implement shared EPUB annotation serialization and highlight rendering

* Centralize file type capabilities and platform-specific support logic

* Refactor reader state management to use a central reducer

* Implement customizable reader toolbar and advanced formatting settings in shared

* Implement locator-based navigation and customizable highlight palette for desktop app

* Enhance reader customization and expand search functionality in desktop app

* Redesign reader settings and tools into a tabbed control panel in desktop app

* Enhance reader navigation and highlight precision in desktop app

* Implement bidirectional position synchronization and dynamic highlights in the desktop reader

* Implement shared state management and enhanced search for the PDF reader in desktop app

* Add vertical scroll support to the desktop PDF reader

* Implement ink, text, and eraser annotation support in desktop PDF viewer

* Implement PDF bookmarks, Table of Contents, and annotation editing in desktop app

* Implement link handling and navigation for PDF and EPUB readers in desktop app

* Implement PDF jump history for navigation in desktop app

* Enhance PDF ink rendering and annotation capabilities in desktop app

* Implement advanced PDF text annotations with inline editing and rich styling in desktop app

* Add move handle and movement logic for PDF text annotations in desktop app

* Implement local folder synchronization and metadata sidecar support in desktop app

* Implement book metadata extraction and drag-and-drop import for Desktop

* Implement dynamic and custom app theme management for desktop

* Introduce canonical PDF annotation codec and support for multi-segment highlights

* Implement rich text editing and pagination support for the PDF reader in desktop app

* Improve PDF rich text pagination, synchronization, and observability in desktop

* Hide trailing structural page breaks in rich text editor

* Implement a unified JVM book loader and expand supported formats on Desktop

* Add comic archive support for Desktop and enhance MOBI parsing

* Implement shared OPDS catalog support and UI for Android and Desktop

* Improve native WebView lifecycle and surface transition management on Desktop

* Enable Compose Swing interop blending and simplify Desktop WebView management

* Integrate BYOK AI features and Cloud TTS for desktop

* Enhance Desktop TTS with streaming audio and improved secure storage for AI key

* Implement scoped Cloud TTS with synchronized highlighting for EPUB and PDF in desktop app

* Implement custom font management and utility screens in desktop app

* Implement PDFium-based PDF annotation export

* Remove PdfBox dependency and standardize PDF export via Pdfium

* Implement local audio caching and playback controls for Gemini Cloud TTS in desktop app

* Implement reader themes and custom texture support in desktop app

* Redesign non-reader UI with responsive navigation and enhanced library management in desktop app

* Introduce ReaderWorkspaceShell to unify EPUB and PDF reader layouts in desktop app

* Exclude manual-only files from automated sync and import

* Implement customizable Text-to-Speech (TTS) word replacements

* Optimize reader performance with persistent layout caching and decoupled theme rendering

* Improve position restoration during reader reconfiguration in epub pagination

* Use independent thickness for eraser tool and stylus override
This commit is contained in:
Aryan 2026-05-10 10:07:37 +05:30 committed by GitHub
parent 88c7fa7b5c
commit 8366d76dcd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
214 changed files with 53372 additions and 4702 deletions

View file

@ -0,0 +1,90 @@
package com.aryan.reader.data
import com.aryan.reader.FileType
import org.junit.Assert.assertEquals
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Test
class FolderBookMetadataTest {
@Test
fun `metadata JSON round trips nullable reader progress fields`() {
val metadata = FolderBookMetadata(
bookId = "book-1",
title = "Title",
author = null,
displayName = "Title.epub",
type = "EPUB",
lastChapterIndex = 4,
lastPage = null,
lastPositionCfi = "/4/2:10",
progressPercentage = 42.5f,
isRecent = false,
lastModifiedTimestamp = 1234L,
bookmarksJson = """[{"chapter":4}]""",
locatorBlockIndex = 99,
locatorCharOffset = null,
customName = "Custom",
highlightsJson = """[{"id":"h1"}]"""
)
val decoded = FolderBookMetadata.fromJsonString(metadata.toJsonString())
assertEquals(metadata.copy(author = null, lastPage = null, locatorCharOffset = null), decoded)
}
@Test
fun `fromJsonString applies legacy defaults for missing optional fields`() {
val decoded = FolderBookMetadata.fromJsonString("""{"bookId":"legacy"}""")
assertEquals("legacy", decoded.bookId)
assertEquals("Unknown", decoded.displayName)
assertEquals("PDF", decoded.type)
assertEquals(0f, decoded.progressPercentage)
assertTrue(decoded.isRecent)
assertEquals(0L, decoded.lastModifiedTimestamp)
assertNull(decoded.title)
assertNull(decoded.lastChapterIndex)
assertNull(decoded.locatorBlockIndex)
}
@Test
fun `toRecentFileItem maps metadata and falls back to EPUB for unknown type`() {
val metadata = FolderBookMetadata(
bookId = "book-2",
title = "Remote Title",
author = "Author",
displayName = "Remote.bin",
type = "NOT_A_TYPE",
lastChapterIndex = 2,
lastPage = 12,
lastPositionCfi = "/6",
progressPercentage = 75f,
isRecent = true,
lastModifiedTimestamp = 500L,
bookmarksJson = "bookmarks",
locatorBlockIndex = 7,
locatorCharOffset = 8,
customName = "Shelf Name",
highlightsJson = "highlights"
)
val item = metadata.toRecentFileItem(
uriString = "content://book",
coverPath = "/covers/book.png",
sourceFolderUri = "content://folder"
)
assertEquals("book-2", item.bookId)
assertEquals(FileType.EPUB, item.type)
assertEquals("Remote Title", item.title)
assertEquals("Author", item.author)
assertEquals(12, item.lastPage)
assertEquals(7, item.locatorBlockIndex)
assertEquals(8, item.locatorCharOffset)
assertEquals("content://folder", item.sourceFolderUri)
assertEquals("Shelf Name", item.customName)
assertEquals("highlights", item.highlightsJson)
}
}

View file

@ -0,0 +1,138 @@
package com.aryan.reader.data
import androidx.room.Room
import com.aryan.reader.FileType
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.test.runTest
import org.junit.After
import org.junit.Assert.assertEquals
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.RobolectricTestRunner
import org.robolectric.RuntimeEnvironment
@RunWith(RobolectricTestRunner::class)
class RecentFileDaoReadingPositionTest {
private lateinit var db: AppDatabase
private lateinit var dao: RecentFileDao
@Before
fun setUp() {
db = Room.inMemoryDatabaseBuilder(
RuntimeEnvironment.getApplication(),
AppDatabase::class.java
).allowMainThreadQueries().build()
dao = db.recentFileDao()
}
@After
fun tearDown() {
db.close()
}
@Test
fun `updateEpubReadingPosition persists cfi locator progress and timestamps`() = runTest {
dao.insertOrUpdateFile(recentFileEntity())
dao.updateEpubReadingPosition(
bookId = "book-1",
cfi = "/4/2/6:33",
chapterIndex = 7,
blockIndex = 42,
charOffset = 33,
progress = 58.5f,
timestamp = 9_000L
)
val saved = dao.getFileByUri("content://books/one")!!
assertEquals("/4/2/6:33", saved.lastPositionCfi)
assertEquals(7, saved.lastChapterIndex)
assertEquals(42, saved.locatorBlockIndex)
assertEquals(33, saved.locatorCharOffset)
assertEquals(58.5f, saved.progressPercentage)
assertEquals(9_000L, saved.timestamp)
assertEquals(9_000L, saved.lastModifiedTimestamp)
}
@Test
fun `updateEpubReadingPosition can persist locator when webview cfi is unavailable`() = runTest {
dao.insertOrUpdateFile(recentFileEntity(lastPositionCfi = "/old:1"))
dao.updateEpubReadingPosition(
bookId = "book-1",
cfi = null,
chapterIndex = 2,
blockIndex = 9,
charOffset = 0,
progress = 12f,
timestamp = 2_000L
)
val saved = dao.getFileByBookId("book-1")!!
assertNull(saved.lastPositionCfi)
assertEquals(2, saved.lastChapterIndex)
assertEquals(9, saved.locatorBlockIndex)
assertEquals(0, saved.locatorCharOffset)
assertEquals(12f, saved.progressPercentage)
}
@Test
fun `recent file summary exposes persisted cfi and locator fields for reader restore`() = runTest {
dao.insertOrUpdateFile(recentFileEntity())
dao.updateEpubReadingPosition(
bookId = "book-1",
cfi = "/6/4:12",
chapterIndex = 3,
blockIndex = 21,
charOffset = 12,
progress = 44f,
timestamp = 3_000L
)
val item = dao.getRecentFiles().first().single().toRecentFileItem()
assertEquals("/6/4:12", item.lastPositionCfi)
assertEquals(3, item.lastChapterIndex)
assertEquals(21, item.locatorBlockIndex)
assertEquals(12, item.locatorCharOffset)
assertEquals(44f, item.progressPercentage)
assertTrue(item.isRecent)
}
private fun recentFileEntity(lastPositionCfi: String? = null): RecentFileEntity {
return RecentFileEntity(
bookId = "book-1",
uriString = "content://books/one",
type = FileType.EPUB,
displayName = "One.epub",
timestamp = 1_000L,
coverImagePath = null,
title = "One",
author = "Author",
lastChapterIndex = null,
lastPage = null,
lastPositionCfi = lastPositionCfi,
progressPercentage = null,
isRecent = true,
isAvailable = true,
lastModifiedTimestamp = 1_000L,
isDeleted = false,
locatorBlockIndex = null,
locatorCharOffset = null,
bookmarks = null,
sourceFolderUri = null,
isReflowPreferred = false,
customName = null,
highlights = null,
fileSize = 123L,
seriesName = null,
seriesIndex = null,
description = null,
folderTextMetadataParsed = false
)
}
}

View file

@ -0,0 +1,54 @@
package com.aryan.reader.data
import com.aryan.reader.FileType
import org.junit.Assert.assertEquals
import org.junit.Test
class RecentFileItemReadingPositionMappingTest {
@Test
fun `recent file entity mapping preserves epub cfi locator and progress fields`() {
val item = recentFileItem()
val roundTripped = item.toRecentFileEntity().toRecentFileItem()
assertEquals(item.lastPositionCfi, roundTripped.lastPositionCfi)
assertEquals(item.lastChapterIndex, roundTripped.lastChapterIndex)
assertEquals(item.locatorBlockIndex, roundTripped.locatorBlockIndex)
assertEquals(item.locatorCharOffset, roundTripped.locatorCharOffset)
assertEquals(item.progressPercentage, roundTripped.progressPercentage)
}
@Test
fun `cloud metadata mapping preserves epub cfi locator and progress fields`() {
val item = recentFileItem()
val roundTripped = item.toBookMetadata().toRecentFileItem()
assertEquals(item.lastPositionCfi, roundTripped.lastPositionCfi)
assertEquals(item.lastChapterIndex, roundTripped.lastChapterIndex)
assertEquals(item.locatorBlockIndex, roundTripped.locatorBlockIndex)
assertEquals(item.locatorCharOffset, roundTripped.locatorCharOffset)
assertEquals(item.progressPercentage, roundTripped.progressPercentage)
}
private fun recentFileItem(): RecentFileItem {
return RecentFileItem(
bookId = "book-1",
uriString = "content://books/one",
type = FileType.EPUB,
displayName = "One.epub",
timestamp = 1_000L,
title = "One",
author = "Author",
lastChapterIndex = 4,
lastPositionCfi = "/4/2/6:88",
locatorBlockIndex = 30,
locatorCharOffset = 88,
progressPercentage = 61.5f,
lastModifiedTimestamp = 2_000L,
bookmarksJson = """[{"cfi":"/4/2"}]""",
highlightsJson = """[{"cfi":"/4/2/6:88"}]"""
)
}
}

View file

@ -0,0 +1,148 @@
package com.aryan.reader.data
import android.content.Context
import com.aryan.reader.FileType
import io.mockk.Runs
import io.mockk.coEvery
import io.mockk.coVerify
import io.mockk.every
import io.mockk.just
import io.mockk.mockk
import io.mockk.mockkObject
import io.mockk.slot
import io.mockk.unmockkObject
import kotlinx.coroutines.flow.flowOf
import kotlinx.coroutines.test.runTest
import org.junit.After
import org.junit.Assert.assertEquals
import org.junit.Before
import org.junit.Test
import java.io.File
class RecentFilesRepositoryReadingPositionMergeTest {
private lateinit var context: Context
private lateinit var recentFileDao: RecentFileDao
private lateinit var repository: RecentFilesRepository
@Before
fun setUp() {
val testRoot = File("build/test-tmp/RecentFilesRepositoryReadingPositionMergeTest/${System.nanoTime()}")
val filesDir = File(testRoot, "files").apply { mkdirs() }
val cacheDir = File(testRoot, "cache").apply { mkdirs() }
context = mockk(relaxed = true)
every { context.applicationContext } returns context
every { context.filesDir } returns filesDir
every { context.cacheDir } returns cacheDir
recentFileDao = mockk()
val shelfDao = mockk<ShelfDao>()
val tagDao = mockk<TagDao>()
val db = mockk<AppDatabase>()
every { db.recentFileDao() } returns recentFileDao
every { db.shelfDao() } returns shelfDao
every { db.tagDao() } returns tagDao
every { shelfDao.getAllActiveShelves() } returns flowOf(emptyList())
every { shelfDao.getAllBookShelfCrossRefs() } returns flowOf(emptyList())
every { tagDao.getAllTags() } returns flowOf(emptyList())
every { tagDao.getAllBookTagCrossRefs() } returns flowOf(emptyList())
mockkObject(AppDatabase.Companion)
every { AppDatabase.getDatabase(any()) } returns db
repository = RecentFilesRepository(context)
}
@After
fun tearDown() {
unmockkObject(AppDatabase.Companion)
}
@Test
fun `addRecentFile preserves existing reading position when incoming metadata omits it`() = runTest {
val inserted = slot<RecentFileEntity>()
coEvery { recentFileDao.getFileByBookId("book-1") } returns existingEntity()
coEvery { recentFileDao.insertOrUpdateFile(capture(inserted)) } just Runs
repository.addRecentFile(
RecentFileItem(
bookId = "book-1",
uriString = "content://new",
type = FileType.EPUB,
displayName = "New.epub",
timestamp = 2_000L,
isRecent = true
)
)
assertEquals("/4/2/6:44", inserted.captured.lastPositionCfi)
assertEquals(6, inserted.captured.lastChapterIndex)
assertEquals(24, inserted.captured.locatorBlockIndex)
assertEquals(44, inserted.captured.locatorCharOffset)
assertEquals(71.5f, inserted.captured.progressPercentage)
coVerify { recentFileDao.insertOrUpdateFile(any()) }
}
@Test
fun `addRecentFile uses incoming reading position when newer metadata includes it`() = runTest {
val inserted = slot<RecentFileEntity>()
coEvery { recentFileDao.getFileByBookId("book-1") } returns existingEntity()
coEvery { recentFileDao.insertOrUpdateFile(capture(inserted)) } just Runs
repository.addRecentFile(
RecentFileItem(
bookId = "book-1",
uriString = "content://new",
type = FileType.EPUB,
displayName = "New.epub",
timestamp = 2_000L,
lastChapterIndex = 8,
lastPositionCfi = "/6/4:12",
locatorBlockIndex = 31,
locatorCharOffset = 12,
progressPercentage = 82f,
isRecent = true
)
)
assertEquals("/6/4:12", inserted.captured.lastPositionCfi)
assertEquals(8, inserted.captured.lastChapterIndex)
assertEquals(31, inserted.captured.locatorBlockIndex)
assertEquals(12, inserted.captured.locatorCharOffset)
assertEquals(82f, inserted.captured.progressPercentage)
}
private fun existingEntity(): RecentFileEntity {
return RecentFileEntity(
bookId = "book-1",
uriString = "content://old",
type = FileType.EPUB,
displayName = "Old.epub",
timestamp = 1_000L,
coverImagePath = "/covers/old.png",
title = "Old",
author = "Author",
lastChapterIndex = 6,
lastPage = null,
lastPositionCfi = "/4/2/6:44",
progressPercentage = 71.5f,
isRecent = true,
isAvailable = true,
lastModifiedTimestamp = 1_500L,
isDeleted = false,
locatorBlockIndex = 24,
locatorCharOffset = 44,
bookmarks = "bookmarks",
sourceFolderUri = "content://folder",
isReflowPreferred = false,
customName = "Custom",
highlights = "highlights",
fileSize = 123L,
seriesName = "Series",
seriesIndex = 1.0,
description = "Description",
folderTextMetadataParsed = true
)
}
}

View file

@ -0,0 +1,143 @@
package com.aryan.reader.data
import com.aryan.reader.FileType
import org.junit.Assert.assertEquals
import org.junit.Assert.assertFalse
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Test
class SmartCollectionEngineTest {
@Test
fun `definition JSON round trips and ignores unknown fields`() {
val definition = SmartCollectionDefinition(
matchAll = false,
rules = listOf(
SmartRule(SmartField.TITLE, SmartOperator.CONTAINS, "dune"),
SmartRule(SmartField.PROGRESS, SmartOperator.GREATER_THAN, "50")
)
)
val encoded = SmartCollectionEngine.toJson(definition)
val decoded = SmartCollectionEngine.fromJson(
encoded.replaceFirst("{", """{"unknown":"kept-for-forward-compat",""")
)
assertEquals(definition, decoded)
}
@Test
fun `fromJson returns null for blank malformed and incompatible payloads`() {
assertNull(SmartCollectionEngine.fromJson(null))
assertNull(SmartCollectionEngine.fromJson(" "))
assertNull(SmartCollectionEngine.fromJson("{not json"))
assertNull(SmartCollectionEngine.fromJson("""{"matchAll":true,"rules":[{"field":"NOPE"}]}"""))
}
@Test
fun `matchAll requires every rule while matchAny accepts a single matching rule`() {
val book = book(
title = "Dune Messiah",
author = "Frank Herbert",
progressPercentage = 41f,
type = FileType.EPUB
)
val titleAndHighProgress = SmartCollectionDefinition(
matchAll = true,
rules = listOf(
SmartRule(SmartField.TITLE, SmartOperator.CONTAINS, "dune"),
SmartRule(SmartField.PROGRESS, SmartOperator.GREATER_THAN, "80")
)
)
val titleOrHighProgress = titleAndHighProgress.copy(matchAll = false)
assertFalse(SmartCollectionEngine.evaluate(book, titleAndHighProgress))
assertTrue(SmartCollectionEngine.evaluate(book, titleOrHighProgress))
}
@Test
fun `string folder file type and tag rules are case insensitive`() {
val book = book(
displayName = "fallback-name.pdf",
title = null,
author = "Ursula K. Le Guin",
sourceFolderUri = "content://library/Sci-Fi",
type = FileType.PDF,
tags = listOf(
TagEntity(id = "t1", name = "Classic Science Fiction", createdAt = 1L),
TagEntity(id = "t2", name = "Queued", createdAt = 2L)
)
)
assertTrue(
SmartCollectionEngine.evaluate(
book,
SmartCollectionDefinition(
rules = listOf(
SmartRule(SmartField.TITLE, SmartOperator.EQUALS, "fallback-name.pdf"),
SmartRule(SmartField.AUTHOR, SmartOperator.CONTAINS, "le guin"),
SmartRule(SmartField.FOLDER, SmartOperator.CONTAINS, "SCI-FI"),
SmartRule(SmartField.FILE_TYPE, SmartOperator.EQUALS, "pdf"),
SmartRule(SmartField.TAG, SmartOperator.CONTAINS, "science")
)
)
)
)
}
@Test
fun `numeric rules handle equals greater less missing progress and invalid values`() {
val startedBook = book(progressPercentage = 33.5f)
val missingProgressBook = book(progressPercentage = null)
assertTrue(matchesProgress(startedBook, SmartOperator.EQUALS, "33.5"))
assertTrue(matchesProgress(startedBook, SmartOperator.GREATER_THAN, "33"))
assertTrue(matchesProgress(startedBook, SmartOperator.LESS_THAN, "34"))
assertFalse(matchesProgress(startedBook, SmartOperator.GREATER_THAN, "not-a-number"))
assertTrue(matchesProgress(missingProgressBook, SmartOperator.EQUALS, "0"))
}
@Test
fun `empty definitions never match`() {
assertFalse(SmartCollectionEngine.evaluate(book(), SmartCollectionDefinition()))
}
private fun matchesProgress(
book: RecentFileItem,
operator: SmartOperator,
value: String
): Boolean {
return SmartCollectionEngine.evaluate(
book,
SmartCollectionDefinition(
rules = listOf(SmartRule(SmartField.PROGRESS, operator, value))
)
)
}
private fun book(
bookId: String = "book-id",
displayName: String = "display.epub",
title: String? = "Display",
author: String? = null,
progressPercentage: Float? = null,
sourceFolderUri: String? = null,
type: FileType = FileType.EPUB,
tags: List<TagEntity> = emptyList()
): RecentFileItem {
return RecentFileItem(
bookId = bookId,
uriString = "content://book/$bookId",
type = type,
displayName = displayName,
timestamp = 1L,
title = title,
author = author,
progressPercentage = progressPercentage,
sourceFolderUri = sourceFolderUri,
tags = tags
)
}
}