Merge pull request #18 from DevelopersBreach/rework-simplify-topics-screen-implementation

Rework/simplify topics screen implementation, remove redundant resources

Author: RajashekarRaju

README.md

@@ -4,6 +4,42 @@
 
 ---
 
+## 🎯 Roadmap
+
+### Roadmap v0.1.0
+
+- [x] Add initial `README` with project overview
+- [x] Add `ktlint` configuration for code style enforcement
+- [x] Integrate `Arrow Core` for exception handling
+- [x] Add `Kermit` logging library and replace println statements
+- [x] Configure GitHub Actions workflow
+- [x] Implement section-wise scroll behavior on the `Detail Screen` for better navigation
+- [x] Replace the search icon on the `Topic Card` to improve visual consistency
+- [x] Hide API key from code by using expect/actual for OpenAPI key
+- [x] Switch AI integration from OpenAI to Gemini
+- [x] Refactor network layer for cleaner architecture
+- [ ] Create a separate module for reusable UI components
+
+---
+
+### Roadmap v0.2.0
+
+- [ ] Assign unique IDs to objects and enforce consistent ordering logic
+- [ ] Correct usage of visibility modifiers across the codebase
+- [ ] Introduce common `@Preview` annotations for reusable Composable previews
+- [ ] Add inline code formatting support for syntax display on the `Detail Screen`
+- [ ] Implement caching on the `Detail Screen` to store previously viewed topic data
+- [ ] Implement dynamic topic loading in `TopicRepository` to support scalability
+- [ ] Integrate Room database to persist bookmark states
+- [ ] Add a `Home Page` for navigation
+- [ ] Add a `Quiz Page` to host topic-based quizzes
+- [ ] Add a button in `DetailScreen` to attempt a quiz for that topic
+- [ ] Add a `Contributors Page` to showcase project contributors
+- [ ] Add a `Settings Page` with basic preferences
+- [ ] Implement a `Splash Screen`
+
+---
+
 Kotlin Dictionary is a student-led, cross-platform app designed to help learners dive deep into the Kotlin programming language. It serves as an interactive reference where you can explore topics with clear explanations and reinforce your learning through quizzes.   
 ✨ _The data is powered by AI tools which help automate content generation, ensure consistency, and speed up the documentation._
 
@@ -49,23 +85,4 @@ Here are a couple of early previews from the Android version of the app:
 
 ## ⚠️ Disclaimer
 
-This is an educational project developed by students. Expect rapid changes, experiments, and ongoing improvements as part of the learning journey. 😊
-
----
-
-## 🎢 Roadmap
-
-- [x] Add `ktlint` configuration for code style enforcement.
-- [x] Integrate `Arrow Core` for exception handling.
-- [x] Add a centralized logger.
-- [ ] Create a separate module for reusable UI components.
-- [x] Configure GitHub Actions workflow.
-- [ ] Assign unique IDs to objects and enforce consistent ordering logic.
-- [ ] Correct usage of visibility modifiers across the codebase.
-- [ ] Introduce common @Preview annotations for reusable Composable previews.
-- [ ] Implement section-wise scroll behavior on the `Detail Screen` for better navigation.
-- [ ] Add inline code formatting support for syntax display on the `Detail Screen`.
-- [x] Replace the search icon on the `Topic Card` to improve visual consistency.
-- [ ] Implement caching on the `Detail Screen` to store previously viewed topic data.
-- [x] Switch AI integration from OpenAI to Gemini.
-- [ ] Refactor network layer for cleaner architecture.
+This is an educational project developed by students. Expect rapid changes, experiments, and ongoing improvements as part of the learning journey. 😊

composeApp/src/androidMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/previews/PreviewUtils.kt

@@ -5,25 +5,17 @@ import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.Kotl
 import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.Section
 import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.Syntax
 import com.developersbreach.kotlindictionarymultiplatform.data.topic.model.Topic
-import com.developersbreach.kotlindictionarymultiplatform.data.topic.model.TopicUi
+import com.developersbreach.kotlindictionarymultiplatform.ui.screens.topic.ItemTopic
 
-fun sampleCodeSnippet(): String {
+internal fun sampleCodeSnippet(): String {
     return """
         fun greet(name: String): String {
             return "Hello, Sam!"
         }
         """.trimIndent()
 }
 
-fun topic(): String {
-    return "Smart Casts"
-}
-
-fun subtitle(): String {
-    return "Automatic casting of immutable values"
-}
-
-fun fakeTopicDetails(): KotlinTopicDetails {
+internal fun fakeTopicDetails(): KotlinTopicDetails {
     return KotlinTopicDetails(
         topicId = "smart-cast",
         topicName = "Smart Cast",
@@ -59,7 +51,7 @@ fun fakeTopicDetails(): KotlinTopicDetails {
     )
 }
 
-fun sampleTopicList(): List<Topic> {
+private fun sampleTopicList(): List<Topic> {
     return listOf(
         Topic("Smart Casts"),
         Topic("Null Safety"),
@@ -69,9 +61,9 @@ fun sampleTopicList(): List<Topic> {
     )
 }
 
-fun sampleTopicUiList(): List<TopicUi> {
+internal fun sampleTopicUiList(): List<ItemTopic> {
     return sampleTopicList().map { topic ->
-        TopicUi(
+        ItemTopic(
             name = topic.name,
             initial = topic.name.firstOrNull()?.uppercase() ?: "",
             isBookmarked = true,

composeApp/src/androidMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/previews/detail/CodeExampleBoxPreview.kt

@@ -11,7 +11,7 @@ import com.developersbreach.kotlindictionarymultiplatform.ui.theme.KotlinDiction
 
 @PreviewLightDark
 @Composable
-fun CodeExampleBoxPreview() {
+private fun CodeExampleBoxPreview() {
     KotlinDictionaryTheme {
         CodeExampleBox(
             code = sampleCodeSnippet(),

composeApp/src/androidMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/previews/detail/DetailScreenPreview.kt

@@ -9,7 +9,7 @@ import com.developersbreach.kotlindictionarymultiplatform.ui.theme.KotlinDiction
 
 @PreviewLightDark
 @Composable
-fun DetailScreenPreview() {
+private fun DetailScreenPreview() {
     KotlinDictionaryTheme {
         DetailScreenUI(
             detailUiState = fakeTopicDetails().toDetailUi(),

composeApp/src/androidMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/previews/topic/SearchFieldPreview.kt

@@ -1,85 +1,22 @@
 package com.developersbreach.kotlindictionarymultiplatform.previews.topic
 
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.collectAsState
-import androidx.compose.runtime.getValue
 import androidx.compose.ui.tooling.preview.PreviewLightDark
-import com.developersbreach.kotlindictionarymultiplatform.data.topic.model.Topic
-import com.developersbreach.kotlindictionarymultiplatform.data.topic.model.TopicUi
-import com.developersbreach.kotlindictionarymultiplatform.previews.sampleTopicList
-import com.developersbreach.kotlindictionarymultiplatform.ui.components.UiState
-import com.developersbreach.kotlindictionarymultiplatform.ui.components.UiStateHandler
+import com.developersbreach.kotlindictionarymultiplatform.previews.sampleTopicUiList
 import com.developersbreach.kotlindictionarymultiplatform.ui.screens.topic.TopicScreenUI
 import com.developersbreach.kotlindictionarymultiplatform.ui.theme.KotlinDictionaryTheme
-import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.StateFlow
-
-// Fake ViewModel for previews
-class FakeTopicViewModel : TopicViewModelFakeBase() {
-    override val topics = MutableStateFlow<UiState<List<Topic>>>(UiState.Success(sampleTopicList()))
-    override val searchQuery = MutableStateFlow("")
-    override val filteredTopics = MutableStateFlow(
-        sampleTopicList().map { topic ->
-            TopicUi(
-                name = topic.name,
-                initial = topic.name.firstOrNull()?.uppercase() ?: "",
-                isBookmarked = true,
-            )
-        },
-    )
-    override val bookmarkedStates = MutableStateFlow(List(sampleTopicList().size) { true })
-
-    override fun updateSearchQuery(
-        newQuery: String,
-    ) {}
-
-    override fun toggleBookmark(
-        index: Int,
-    ) {}
-}
-
-// Base class to avoid needing Android ViewModel
-abstract class TopicViewModelFakeBase {
-    abstract val topics: StateFlow<UiState<List<Topic>>>
-    abstract val searchQuery: StateFlow<String>
-    abstract val filteredTopics: StateFlow<List<TopicUi>>
-    abstract val bookmarkedStates: StateFlow<List<Boolean>>
-
-    abstract fun updateSearchQuery(
-        newQuery: String,
-    )
-
-    abstract fun toggleBookmark(
-        index: Int,
-    )
-}
-
-@Composable
-fun TopicScreenContent(
-    viewModel: TopicViewModelFakeBase,
-    onTopicClick: (String) -> Unit = {},
-) {
-    val topicState by viewModel.topics.collectAsState()
-    val filteredTopics by viewModel.filteredTopics.collectAsState()
-    val searchQuery by viewModel.searchQuery.collectAsState()
-    val bookmarkedStates by viewModel.bookmarkedStates.collectAsState()
-
-    UiStateHandler(uiState = topicState) {
-        TopicScreenUI(
-            topics = filteredTopics,
-            bookmarkedStates = bookmarkedStates,
-            searchQuery = searchQuery,
-            onQueryChange = viewModel::updateSearchQuery,
-            onBookmarkClick = viewModel::toggleBookmark,
-            onTopicClick = onTopicClick,
-        )
-    }
-}
 
 @PreviewLightDark
 @Composable
-fun TopicScreenPreview() {
+private fun TopicScreenPreview() {
     KotlinDictionaryTheme {
-        TopicScreenContent(viewModel = FakeTopicViewModel())
+        TopicScreenUI(
+            topics = sampleTopicUiList(),
+            bookmarkedStates = listOf(),
+            searchQuery = "Search",
+            onQueryChange = { },
+            onBookmarkClick = { },
+            onTopicClick = { },
+        )
     }
 }