Add Settings Dialog with Theme Mode Selection and Proto DataStore Persistence

app/build.gradle.kts

@@ -87,8 +87,10 @@ dependencies {
   // features
   implementation(projects.feature.home)
   implementation(projects.feature.details)
+  implementation(projects.feature.settings)
 
   // cores
+  implementation(projects.core.data)
   implementation(projects.core.model)
   implementation(projects.core.designsystem)
   implementation(projects.core.navigation)

app/src/main/kotlin/com/skydoves/pokedex/compose/MainActivity.kt

@@ -20,20 +20,47 @@ import android.os.Bundle
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
 import androidx.activity.enableEdgeToEdge
+import androidx.activity.viewModels
+import androidx.compose.foundation.isSystemInDarkTheme
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.setValue
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
+import androidx.lifecycle.Lifecycle
+import androidx.lifecycle.lifecycleScope
+import androidx.lifecycle.repeatOnLifecycle
 import com.skydoves.pokedex.compose.ui.PokedexMain
 import dagger.hilt.android.AndroidEntryPoint
+import kotlinx.coroutines.flow.collect
+import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.launch
 
 @AndroidEntryPoint
 class MainActivity : ComponentActivity() {
 
+  private val viewModel: MainActivityViewModel by viewModels()
+
   override fun onCreate(savedInstanceState: Bundle?) {
-    installSplashScreen()
+    val splashScreen = installSplashScreen()
     enableEdgeToEdge()
     super.onCreate(savedInstanceState)
 
+    var uiState: MainActivityUiState by mutableStateOf(value = MainActivityUiState.Loading)
+
+    lifecycleScope.launch {
+      lifecycle.repeatOnLifecycle(state = Lifecycle.State.STARTED) {
+        viewModel.userData
+          .onEach { uiState = it }
+          .collect()
+      }
+    }
+
+    splashScreen.setKeepOnScreenCondition { uiState.shouldKeepSplashScreen() }
+
     setContent {
-      PokedexMain()
+      PokedexMain(
+        darkTheme = (uiState.shouldUseDarkTheme(isSystemDarkTheme = isSystemInDarkTheme())),
+      )
     }
   }
 }

app/src/main/kotlin/com/skydoves/pokedex/compose/MainActivityViewModel.kt

@@ -0,0 +1,61 @@
+/*
+ * Designed and developed by 2024 skydoves (Jaewoong Eum)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.skydoves.pokedex.compose
+
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewModelScope
+import com.skydoves.pokedex.compose.MainActivityUiState.Loading
+import com.skydoves.pokedex.compose.core.data.repository.userdata.UserDataRepository
+import com.skydoves.pokedex.compose.core.model.UiTheme
+import com.skydoves.pokedex.compose.core.model.UserData
+import dagger.hilt.android.lifecycle.HiltViewModel
+import kotlinx.coroutines.flow.SharingStarted
+import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.stateIn
+import javax.inject.Inject
+
+@HiltViewModel
+class MainActivityViewModel @Inject constructor(
+  userDataRepository: UserDataRepository,
+) : ViewModel() {
+
+  val userData = userDataRepository.userData
+    .map(MainActivityUiState::Success)
+    .stateIn(
+      scope = viewModelScope,
+      started = SharingStarted.WhileSubscribed(5_000),
+      initialValue = Loading,
+    )
+}
+
+sealed interface MainActivityUiState {
+  data object Loading : MainActivityUiState
+  data class Success(val userData: UserData) : MainActivityUiState {
+    fun shouldUseDarkTheme(isSystemDarkTheme: Boolean): Boolean = when (userData.uiTheme) {
+      UiTheme.FOLLOW_SYSTEM -> isSystemDarkTheme
+      UiTheme.DARK -> true
+      UiTheme.LIGHT -> false
+    }
+  }
+}
+
+fun MainActivityUiState.shouldKeepSplashScreen() = this is Loading
+
+fun MainActivityUiState.shouldUseDarkTheme(isSystemDarkTheme: Boolean) = when (this) {
+  Loading -> isSystemDarkTheme
+  is MainActivityUiState.Success -> shouldUseDarkTheme(isSystemDarkTheme = isSystemDarkTheme)
+}

app/src/main/kotlin/com/skydoves/pokedex/compose/navigation/PokedexNavHost.kt

@@ -25,6 +25,7 @@ import androidx.navigation3.runtime.NavKey
 import androidx.navigation3.runtime.entryProvider
 import androidx.navigation3.runtime.rememberNavBackStack
 import androidx.navigation3.runtime.rememberSaveableStateHolderNavEntryDecorator
+import androidx.navigation3.scene.DialogSceneStrategy
 import androidx.navigation3.ui.LocalNavAnimatedContentScope
 import androidx.navigation3.ui.NavDisplay
 import com.skydoves.compose.stability.runtime.TraceRecomposition
@@ -33,12 +34,14 @@ import com.skydoves.pokedex.compose.core.navigation.PokedexNavigatorImpl
 import com.skydoves.pokedex.compose.core.navigation.PokedexScreen
 import com.skydoves.pokedex.compose.feature.details.PokedexDetails
 import com.skydoves.pokedex.compose.feature.home.PokedexHome
+import com.skydoves.pokedex.compose.feature.settings.PokedexSettings
 
 @OptIn(ExperimentalSharedTransitionApi::class)
 @Composable
 @TraceRecomposition
 fun PokedexNavHost() {
   val backStack = rememberNavBackStack(PokedexScreen.Home)
+  val dialogStrategy = remember { DialogSceneStrategy<NavKey>() }
   val navigator = remember(backStack) { PokedexNavigatorImpl(backStack) }
 
   CompositionLocalProvider(
@@ -48,6 +51,7 @@ fun PokedexNavHost() {
       NavDisplay(
         backStack = backStack,
         onBack = { backStack.removeLastOrNull() },
+        sceneStrategy = dialogStrategy,
         entryDecorators = listOf(rememberSaveableStateHolderNavEntryDecorator()),
         entryProvider = entryProvider<NavKey> {
           entry<PokedexScreen.Home> {
@@ -64,6 +68,12 @@ fun PokedexNavHost() {
               pokemon = screen.pokemon,
             )
           }
+
+          entry<PokedexScreen.Settings>(
+            metadata = DialogSceneStrategy.dialog(),
+          ) {
+            PokedexSettings()
+          }
         },
       )
     }

app/src/main/kotlin/com/skydoves/pokedex/compose/ui/PokedexMain.kt

@@ -23,8 +23,8 @@ import com.skydoves.pokedex.compose.navigation.PokedexNavHost
 
 @Composable
 @TraceRecomposition
-fun PokedexMain() {
-  PokedexTheme {
+fun PokedexMain(darkTheme: Boolean) {
+  PokedexTheme(darkTheme = darkTheme) {
     PokedexNavHost()
   }
 }

build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
   alias(libs.plugins.android.library) apply false
   alias(libs.plugins.android.test) apply false
   alias(libs.plugins.kotlin.android) apply false
+  alias(libs.plugins.kotlin.jvm) apply false
   alias(libs.plugins.kotlin.parcelize) apply false
   alias(libs.plugins.kotlinx.serialization) apply false
   alias(libs.plugins.ksp) apply false

core/common/.gitignore

@@ -0,0 +1 @@
+/build

core/common/build.gradle.kts

@@ -0,0 +1,12 @@
+plugins {
+  alias(libs.plugins.kotlin.jvm)
+  alias(libs.plugins.ksp)
+}
+
+dependencies {
+  implementation(libs.hilt.core)
+  implementation(libs.kotlinx.coroutines.core)
+
+  ksp(libs.hilt.compiler)
+}
+

core/network/src/main/kotlin/com/skydoves/pokedex/compose/core/network/PokedexAppDispatchers.kt → core/common/src/main/java/com/skydoves/pokedex/compose/core/common/network/PokedexAppDispatchers.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.skydoves.pokedex.compose.core.network
+package com.skydoves.pokedex.compose.core.common.network
 
 import javax.inject.Qualifier
 import kotlin.annotation.AnnotationRetention.RUNTIME

core/common/src/main/java/com/skydoves/pokedex/compose/core/common/network/PokedexAppScope.kt

@@ -0,0 +1,7 @@
+package com.skydoves.pokedex.compose.core.common.network
+
+import javax.inject.Qualifier
+
+@Retention(AnnotationRetention.RUNTIME)
+@Qualifier
+annotation class PokedexAppScope()

core/common/src/main/java/com/skydoves/pokedex/compose/core/common/network/di/CoroutineScopesModule.kt

@@ -0,0 +1,25 @@
+package com.skydoves.pokedex.compose.core.common.network.di
+
+import com.skydoves.pokedex.compose.core.common.network.Dispatcher
+import com.skydoves.pokedex.compose.core.common.network.PokedexAppDispatchers
+import com.skydoves.pokedex.compose.core.common.network.PokedexAppScope
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.SupervisorJob
+import javax.inject.Singleton
+
+@Module
+@InstallIn(SingletonComponent::class)
+internal object CoroutineScopesModule {
+
+    @Provides
+    @Singleton
+    @PokedexAppScope
+    fun providesCoroutineScope(
+      @Dispatcher(PokedexAppDispatchers.IO) dispatcher: CoroutineDispatcher,
+    ): CoroutineScope = CoroutineScope(SupervisorJob() + dispatcher)
+}

core/common/src/main/java/com/skydoves/pokedex/compose/core/common/network/di/DispatchersModule.kt

@@ -0,0 +1,19 @@
+package com.skydoves.pokedex.compose.core.common.network.di
+
+import com.skydoves.pokedex.compose.core.common.network.Dispatcher
+import com.skydoves.pokedex.compose.core.common.network.PokedexAppDispatchers
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Dispatchers
+
+@Module
+@InstallIn(SingletonComponent::class)
+internal object DispatchersModule {
+
+  @Provides
+  @Dispatcher(PokedexAppDispatchers.IO)
+  fun providesIODispatcher(): CoroutineDispatcher = Dispatchers.IO
+}

core/data/build.gradle.kts

@@ -29,6 +29,7 @@ dependencies {
   api(projects.core.model)
   implementation(projects.core.network)
   implementation(projects.core.database)
+  implementation(projects.core.datastore)
   testImplementation(projects.core.test)
 
   // kotlinx
@@ -47,4 +48,5 @@ dependencies {
   testImplementation(libs.androidx.test.core)
   testImplementation(libs.mockito.core)
   testImplementation(libs.mockito.kotlin)
+  testImplementation(libs.protobuf.kotlin.lite)
 }

core/data/src/main/kotlin/com/skydoves/pokedex/compose/core/data/di/DataModule.kt

@@ -20,6 +20,8 @@ import com.skydoves.pokedex.compose.core.data.repository.details.DetailsReposito
 import com.skydoves.pokedex.compose.core.data.repository.details.DetailsRepositoryImpl
 import com.skydoves.pokedex.compose.core.data.repository.home.HomeRepository
 import com.skydoves.pokedex.compose.core.data.repository.home.HomeRepositoryImpl
+import com.skydoves.pokedex.compose.core.data.repository.userdata.UserDataRepository
+import com.skydoves.pokedex.compose.core.data.repository.userdata.UserDataRepositoryImpl
 import dagger.Binds
 import dagger.Module
 import dagger.hilt.InstallIn
@@ -34,4 +36,7 @@ internal interface DataModule {
 
   @Binds
   fun bindsDetailRepository(detailsRepositoryImpl: DetailsRepositoryImpl): DetailsRepository
+
+  @Binds
+  fun bindsUserDataRepository(userDataRepositoryImpl: UserDataRepositoryImpl): UserDataRepository
 }

core/data/src/main/kotlin/com/skydoves/pokedex/compose/core/data/repository/details/DetailsRepositoryImpl.kt

@@ -18,12 +18,12 @@ package com.skydoves.pokedex.compose.core.data.repository.details
 
 import androidx.annotation.VisibleForTesting
 import androidx.annotation.WorkerThread
+import com.skydoves.pokedex.compose.core.common.network.Dispatcher
+import com.skydoves.pokedex.compose.core.common.network.PokedexAppDispatchers
 import com.skydoves.pokedex.compose.core.database.PokemonInfoDao
 import com.skydoves.pokedex.compose.core.database.entitiy.mapper.asDomain
 import com.skydoves.pokedex.compose.core.database.entitiy.mapper.asEntity
 import com.skydoves.pokedex.compose.core.model.PokemonInfo
-import com.skydoves.pokedex.compose.core.network.Dispatcher
-import com.skydoves.pokedex.compose.core.network.PokedexAppDispatchers
 import com.skydoves.pokedex.compose.core.network.model.PokemonErrorResponse
 import com.skydoves.pokedex.compose.core.network.model.mapper.ErrorResponseMapper
 import com.skydoves.pokedex.compose.core.network.service.PokedexClient

core/data/src/main/kotlin/com/skydoves/pokedex/compose/core/data/repository/home/HomeRepositoryImpl.kt

@@ -18,12 +18,12 @@ package com.skydoves.pokedex.compose.core.data.repository.home
 
 import androidx.annotation.VisibleForTesting
 import androidx.annotation.WorkerThread
+import com.skydoves.pokedex.compose.core.common.network.Dispatcher
+import com.skydoves.pokedex.compose.core.common.network.PokedexAppDispatchers
 import com.skydoves.pokedex.compose.core.database.PokemonDao
 import com.skydoves.pokedex.compose.core.database.entitiy.mapper.asDomain
 import com.skydoves.pokedex.compose.core.database.entitiy.mapper.asEntity
 import com.skydoves.pokedex.compose.core.model.Pokemon
-import com.skydoves.pokedex.compose.core.network.Dispatcher
-import com.skydoves.pokedex.compose.core.network.PokedexAppDispatchers
 import com.skydoves.pokedex.compose.core.network.service.PokedexClient
 import com.skydoves.sandwich.ApiResponse
 import com.skydoves.sandwich.message

core/network/src/main/kotlin/com/skydoves/pokedex/compose/core/network/di/DispatchersModule.kt → core/data/src/main/kotlin/com/skydoves/pokedex/compose/core/data/repository/userdata/FakeUserDataRepository.kt

@@ -14,22 +14,18 @@
  * limitations under the License.
  */
 
-package com.skydoves.pokedex.compose.core.network.di
+package com.skydoves.pokedex.compose.core.data.repository.userdata
 
-import com.skydoves.pokedex.compose.core.network.Dispatcher
-import com.skydoves.pokedex.compose.core.network.PokedexAppDispatchers
-import dagger.Module
-import dagger.Provides
-import dagger.hilt.InstallIn
-import dagger.hilt.components.SingletonComponent
-import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.Dispatchers
+import com.skydoves.pokedex.compose.core.model.UiTheme
+import com.skydoves.pokedex.compose.core.model.UserData
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flowOf
 
-@Module
-@InstallIn(SingletonComponent::class)
-internal object DispatchersModule {
+class FakeUserDataRepository : UserDataRepository {
+  override val userData: Flow<UserData> = flowOf(
+    UserData(uiTheme = UiTheme.FOLLOW_SYSTEM),
+  )
 
-  @Provides
-  @Dispatcher(PokedexAppDispatchers.IO)
-  fun providesIODispatcher(): CoroutineDispatcher = Dispatchers.IO
+  override suspend fun setUiTheme(uiTheme: UiTheme) {
+  }
 }

core/data/src/main/kotlin/com/skydoves/pokedex/compose/core/data/repository/userdata/UserDataRepository.kt

@@ -0,0 +1,28 @@
+/*
+ * Designed and developed by 2024 skydoves (Jaewoong Eum)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.skydoves.pokedex.compose.core.data.repository.userdata
+
+import com.skydoves.pokedex.compose.core.model.UiTheme
+import com.skydoves.pokedex.compose.core.model.UserData
+import kotlinx.coroutines.flow.Flow
+
+interface UserDataRepository {
+
+  val userData: Flow<UserData>
+
+  suspend fun setUiTheme(uiTheme: UiTheme)
+}