├── app
├── .gitignore
├── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ │ └── android
│ │ │ │ └── template
│ │ │ │ ├── utils
│ │ │ │ ├── .keep
│ │ │ │ └── extenstions
│ │ │ │ │ ├── .keep
│ │ │ │ │ └── viewmodel
│ │ │ │ │ └── ViewModelExtensions.kt
│ │ │ │ ├── providers
│ │ │ │ ├── .keep
│ │ │ │ └── dispatchers
│ │ │ │ │ ├── DispatcherProvider.kt
│ │ │ │ │ └── DispatcherProviderImpl.kt
│ │ │ │ ├── compose
│ │ │ │ ├── uistate
│ │ │ │ │ ├── models
│ │ │ │ │ │ ├── EmptyEvent.kt
│ │ │ │ │ │ ├── EmptyUiState.kt
│ │ │ │ │ │ └── ErrorState.kt
│ │ │ │ │ ├── mappers
│ │ │ │ │ │ └── ExceptionMappers.kt
│ │ │ │ │ └── viewmodel
│ │ │ │ │ │ └── UiStateViewModel.kt
│ │ │ │ ├── theme
│ │ │ │ │ ├── Color.kt
│ │ │ │ │ ├── Type.kt
│ │ │ │ │ └── Theme.kt
│ │ │ │ └── components
│ │ │ │ │ ├── loading
│ │ │ │ │ └── Loading.kt
│ │ │ │ │ ├── error
│ │ │ │ │ └── ErrorDialog.kt
│ │ │ │ │ └── uistate
│ │ │ │ │ └── UiStateScreen.kt
│ │ │ │ ├── features
│ │ │ │ ├── tasks
│ │ │ │ │ ├── models
│ │ │ │ │ │ ├── TaskListDestination.kt
│ │ │ │ │ │ ├── TaskListEvent.kt
│ │ │ │ │ │ └── TaskListUiState.kt
│ │ │ │ │ ├── components
│ │ │ │ │ │ ├── TaskList.kt
│ │ │ │ │ │ ├── TaskListTopBar.kt
│ │ │ │ │ │ └── TaskItem.kt
│ │ │ │ │ ├── TaskListScreen.kt
│ │ │ │ │ └── TaskListViewModel.kt
│ │ │ │ ├── taskdetail
│ │ │ │ │ ├── models
│ │ │ │ │ │ ├── TaskDetailDestination.kt
│ │ │ │ │ │ └── TaskDetailUiState.kt
│ │ │ │ │ ├── components
│ │ │ │ │ │ ├── TaskDetailContent.kt
│ │ │ │ │ │ └── TaskDetailTopBar.kt
│ │ │ │ │ ├── TaskDetailScreen.kt
│ │ │ │ │ └── TaskDetailViewModel.kt
│ │ │ │ └── main
│ │ │ │ │ ├── MainActivity.kt
│ │ │ │ │ └── MainNavHost.kt
│ │ │ │ ├── TemplateApp.kt
│ │ │ │ └── di
│ │ │ │ └── modules
│ │ │ │ └── DispatcherModule.kt
│ │ ├── res
│ │ │ ├── mipmap-hdpi
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-mdpi
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-xhdpi
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-xxhdpi
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-xxxhdpi
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── values
│ │ │ │ ├── themes.xml
│ │ │ │ ├── colors.xml
│ │ │ │ └── strings.xml
│ │ │ ├── mipmap-anydpi
│ │ │ │ ├── ic_launcher.xml
│ │ │ │ └── ic_launcher_round.xml
│ │ │ ├── xml
│ │ │ │ ├── backup_rules.xml
│ │ │ │ └── data_extraction_rules.xml
│ │ │ └── drawable
│ │ │ │ ├── ic_launcher_foreground.xml
│ │ │ │ └── ic_launcher_background.xml
│ │ └── AndroidManifest.xml
│ └── test
│ │ └── java
│ │ └── com
│ │ └── android
│ │ └── template
│ │ ├── utils
│ │ └── MockkUtils.kt
│ │ └── features
│ │ ├── taskdetail
│ │ └── TaskDetailViewModelTest.kt
│ │ └── tasks
│ │ └── TaskListViewModelTest.kt
├── proguard-rules.pro
└── build.gradle.kts
├── data
├── .gitignore
├── consumer-rules.pro
├── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ │ └── android
│ │ │ │ └── template
│ │ │ │ └── data
│ │ │ │ ├── remote
│ │ │ │ ├── models
│ │ │ │ │ ├── requests
│ │ │ │ │ │ └── .keep
│ │ │ │ │ └── responses
│ │ │ │ │ │ ├── errors
│ │ │ │ │ │ └── ErrorResponse.kt
│ │ │ │ │ │ └── tasks
│ │ │ │ │ │ └── TaskResponse.kt
│ │ │ │ ├── services
│ │ │ │ │ └── TasksService.kt
│ │ │ │ ├── interceptors
│ │ │ │ │ └── HeaderInterceptor.kt
│ │ │ │ └── adapters
│ │ │ │ │ ├── errors
│ │ │ │ │ ├── ErrorHandlingCallAdapterFactory.kt
│ │ │ │ │ ├── ErrorHandlingCallAdapter.kt
│ │ │ │ │ └── ErrorHandlingCallback.kt
│ │ │ │ │ └── mappers
│ │ │ │ │ └── ErrorMappers.kt
│ │ │ │ ├── storages
│ │ │ │ ├── databases
│ │ │ │ │ └── .keep
│ │ │ │ └── datastore
│ │ │ │ │ ├── .keep
│ │ │ │ │ └── preferences
│ │ │ │ │ ├── PreferencesDataStore.kt
│ │ │ │ │ └── PreferencesDataStoreImpl.kt
│ │ │ │ ├── repositories
│ │ │ │ ├── tasks
│ │ │ │ │ ├── mappers
│ │ │ │ │ │ └── TaskMappers.kt
│ │ │ │ │ └── TasksRepositoryImpl.kt
│ │ │ │ └── preferences
│ │ │ │ │ └── PreferencesRepositoryImpl.kt
│ │ │ │ └── di
│ │ │ │ └── modules
│ │ │ │ ├── StoragesModule.kt
│ │ │ │ ├── RepositoriesModule.kt
│ │ │ │ └── RemoteModule.kt
│ │ └── AndroidManifest.xml
│ └── test
│ │ └── java
│ │ └── com
│ │ └── android
│ │ └── template
│ │ └── data
│ │ ├── repositories
│ │ ├── tasks
│ │ │ ├── mappers
│ │ │ │ └── TaskMappersKtTest.kt
│ │ │ └── TasksRepositoryImplTest.kt
│ │ └── preferences
│ │ │ └── PreferencesRepositoryImplTest.kt
│ │ └── remote
│ │ └── adapters
│ │ ├── mappers
│ │ └── ErrorMappersKtTest.kt
│ │ └── errors
│ │ └── ErrorHandlingCallbackTest.kt
├── proguard-rules.pro
└── build.gradle.kts
├── domain
├── .gitignore
├── consumer-rules.pro
├── src
│ ├── main
│ │ ├── AndroidManifest.xml
│ │ └── java
│ │ │ └── com
│ │ │ └── android
│ │ │ └── template
│ │ │ └── domain
│ │ │ ├── models
│ │ │ ├── tasks
│ │ │ │ └── Task.kt
│ │ │ └── errors
│ │ │ │ ├── ApiException.kt
│ │ │ │ ├── NoConnectionException.kt
│ │ │ │ └── UnauthorizedException.kt
│ │ │ ├── repositories
│ │ │ ├── preferences
│ │ │ │ └── PreferencesRepository.kt
│ │ │ └── tasks
│ │ │ │ └── TasksRepository.kt
│ │ │ ├── usecases
│ │ │ ├── tasks
│ │ │ │ ├── GetTaskListUseCase.kt
│ │ │ │ ├── CreateTaskUseCase.kt
│ │ │ │ └── GetTaskUseCase.kt
│ │ │ └── preferences
│ │ │ │ ├── IsFirstRunUseCase.kt
│ │ │ │ └── SetFirstRunUseCase.kt
│ │ │ └── utils
│ │ │ └── NullSafetyExtensions.kt
│ └── test
│ │ └── java
│ │ └── com
│ │ └── android
│ │ └── template
│ │ └── domain
│ │ ├── usecases
│ │ ├── tasks
│ │ │ ├── CreateTaskUseCaseTest.kt
│ │ │ ├── GetTaskUseCaseTest.kt
│ │ │ └── GetTaskListUseCaseTest.kt
│ │ └── preferences
│ │ │ ├── SetFirstRunUseCaseTest.kt
│ │ │ └── IsFirstRunUseCaseTest.kt
│ │ └── utils
│ │ └── NullSafetyExtensionsKtTest.kt
├── proguard-rules.pro
└── build.gradle.kts
├── gradle
├── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
└── libs.versions.toml
├── .gitignore
├── gradle.properties
├── settings.gradle.kts
├── README.md
├── gradlew.bat
└── gradlew
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/data/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/data/consumer-rules.pro:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/domain/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/domain/consumer-rules.pro:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/utils/.keep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/providers/.keep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/utils/extenstions/.keep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/models/requests/.keep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/storages/databases/.keep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/storages/datastore/.keep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/uistate/models/EmptyEvent.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.uistate.models
2 |
3 | data object EmptyEvent
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/uistate/models/EmptyUiState.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.uistate.models
2 |
3 | data object EmptyUiState
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/data/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/domain/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | .gradle
3 | /local.properties
4 | /.idea
5 | .DS_Store
6 | /build
7 | /captures
8 | .externalNativeBuild
9 | .cxx
10 | local.properties
11 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huuphuoc1396/android-template/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/values/themes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/models/tasks/Task.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.models.tasks
2 |
3 | data class Task(
4 | val id: String = "",
5 | val content: String = "",
6 | )
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/models/TaskListDestination.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks.models
2 |
3 | import kotlinx.serialization.Serializable
4 |
5 | @Serializable
6 | internal data object TaskListDestination
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/models/errors/ApiException.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.models.errors
2 |
3 | data class ApiException(
4 | val code: Int = 0,
5 | override val message: String = "",
6 | ) : RuntimeException()
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/models/errors/NoConnectionException.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.models.errors
2 |
3 | data class NoConnectionException(
4 | override val message: String = "No connection",
5 | ) : Exception()
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/models/errors/UnauthorizedException.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.models.errors
2 |
3 | data class UnauthorizedException(
4 | override val message: String = "Unauthorized",
5 | ) : RuntimeException()
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/taskdetail/models/TaskDetailDestination.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.taskdetail.models
2 |
3 | import kotlinx.serialization.Serializable
4 |
5 | @Serializable
6 | internal data class TaskDetailDestination(val taskId: String)
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/taskdetail/models/TaskDetailUiState.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.taskdetail.models
2 |
3 | import com.android.template.domain.models.tasks.Task
4 |
5 | internal data class TaskDetailUiState(
6 | val task: Task = Task(),
7 | )
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
2 | org.gradle.parallel=true
3 | android.useAndroidX=true
4 | kotlin.code.style=official
5 | android.nonTransitiveRClass=true
6 | android.disableMinifyLocalDependenciesForLibraries=false
7 | android.enableR8.fullMode=false
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Sat Jul 20 11:01:51 ICT 2024
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
5 | zipStoreBase=GRADLE_USER_HOME
6 | zipStorePath=wrapper/dists
7 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/models/TaskListEvent.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks.models
2 |
3 | internal sealed class TaskListEvent {
4 |
5 | data object FirstRun : TaskListEvent()
6 |
7 | data class OpenTaskDetail(val taskId: String) : TaskListEvent()
8 | }
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/repositories/preferences/PreferencesRepository.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.repositories.preferences
2 |
3 | import kotlinx.coroutines.flow.Flow
4 |
5 | interface PreferencesRepository {
6 |
7 | fun isFirstRun(): Flow
8 |
9 | suspend fun setFirstRun(isFirstRun: Boolean)
10 | }
--------------------------------------------------------------------------------
/app/src/test/java/com/android/template/utils/MockkUtils.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.utils
2 |
3 | import io.mockk.mockkStatic
4 | import io.mockk.unmockkStatic
5 |
6 | internal fun mockkSavedStateHandle() = mockkStatic("androidx.navigation.SavedStateHandleKt")
7 |
8 | internal fun unmockkSavedStateHandle() = unmockkStatic("androidx.navigation.SavedStateHandleKt")
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/storages/datastore/preferences/PreferencesDataStore.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.storages.datastore.preferences
2 |
3 | import kotlinx.coroutines.flow.Flow
4 |
5 | internal interface PreferencesDataStore {
6 |
7 | fun isFirstRun(): Flow
8 |
9 | suspend fun setFirstRun(isFirstRun: Boolean)
10 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/uistate/models/ErrorState.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.uistate.models
2 |
3 | import androidx.annotation.StringRes
4 |
5 | data class ErrorState(
6 | val message: String = "",
7 | @StringRes
8 | val messageRes: Int = -1,
9 | ) {
10 | fun hasError() = message.isNotEmpty() || messageRes != -1
11 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/theme/Color.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.theme
2 |
3 | import androidx.compose.ui.graphics.Color
4 |
5 | val Purple80 = Color(0xFFD0BCFF)
6 | val PurpleGrey80 = Color(0xFFCCC2DC)
7 | val Pink80 = Color(0xFFEFB8C8)
8 |
9 | val Purple40 = Color(0xFF6650a4)
10 | val PurpleGrey40 = Color(0xFF625b71)
11 | val Pink40 = Color(0xFF7D5260)
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/providers/dispatchers/DispatcherProvider.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.providers.dispatchers
2 |
3 | import kotlinx.coroutines.CoroutineDispatcher
4 |
5 | interface DispatcherProvider {
6 | val default: CoroutineDispatcher
7 | val main: CoroutineDispatcher
8 | val io: CoroutineDispatcher
9 | val immediate: CoroutineDispatcher
10 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/models/responses/errors/ErrorResponse.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.models.responses.errors
2 |
3 | import com.google.gson.annotations.SerializedName
4 |
5 | data class ErrorResponse(
6 | @SerializedName("code")
7 | val code: Int? = null,
8 | @SerializedName("message")
9 | val message: String? = null,
10 | )
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/models/responses/tasks/TaskResponse.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.models.responses.tasks
2 |
3 | import com.google.gson.annotations.SerializedName
4 |
5 | internal data class TaskResponse(
6 | @SerializedName("id")
7 | val id: String? = null,
8 | @SerializedName("content")
9 | val content: String? = null,
10 | )
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/models/TaskListUiState.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks.models
2 |
3 | import com.android.template.domain.models.tasks.Task
4 | import kotlinx.collections.immutable.PersistentList
5 | import kotlinx.collections.immutable.persistentListOf
6 |
7 | internal data class TaskListUiState(
8 | val tasks: PersistentList = persistentListOf(),
9 | )
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/usecases/tasks/GetTaskListUseCase.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.tasks
2 |
3 | import com.android.template.domain.repositories.tasks.TasksRepository
4 | import javax.inject.Inject
5 |
6 | class GetTaskListUseCase @Inject constructor(
7 | private val tasksRepository: TasksRepository
8 | ) {
9 |
10 | operator fun invoke() = tasksRepository.getTaskList()
11 | }
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/repositories/tasks/TasksRepository.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.repositories.tasks
2 |
3 | import com.android.template.domain.models.tasks.Task
4 | import kotlinx.coroutines.flow.Flow
5 |
6 | interface TasksRepository {
7 |
8 | fun getTaskList(): Flow>
9 |
10 | fun getTask(id: String): Flow
11 |
12 | suspend fun createTask(task: Task): Task
13 | }
--------------------------------------------------------------------------------
/app/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #FFBB86FC
4 | #FF6200EE
5 | #FF3700B3
6 | #FF03DAC5
7 | #FF018786
8 | #FF000000
9 | #FFFFFFFF
10 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/TemplateApp.kt:
--------------------------------------------------------------------------------
1 | package com.android.template
2 |
3 | import android.app.Application
4 | import dagger.hilt.android.HiltAndroidApp
5 | import timber.log.Timber
6 |
7 | @HiltAndroidApp
8 | class TemplateApp : Application() {
9 |
10 | override fun onCreate() {
11 | super.onCreate()
12 | if (BuildConfig.DEBUG) {
13 | Timber.plant(Timber.DebugTree())
14 | }
15 | }
16 | }
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/usecases/preferences/IsFirstRunUseCase.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.preferences
2 |
3 | import com.android.template.domain.repositories.preferences.PreferencesRepository
4 | import javax.inject.Inject
5 |
6 | class IsFirstRunUseCase @Inject constructor(
7 | private val preferencesRepository: PreferencesRepository
8 | ) {
9 |
10 | operator fun invoke() = preferencesRepository.isFirstRun()
11 | }
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/usecases/preferences/SetFirstRunUseCase.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.preferences
2 |
3 | import com.android.template.domain.repositories.preferences.PreferencesRepository
4 | import javax.inject.Inject
5 |
6 | class SetFirstRunUseCase @Inject constructor(
7 | private val preferencesRepository: PreferencesRepository
8 | ) {
9 |
10 | suspend operator fun invoke(isFirstRun: Boolean) = preferencesRepository.setFirstRun(isFirstRun)
11 | }
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/usecases/tasks/CreateTaskUseCase.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.tasks
2 |
3 | import com.android.template.domain.models.tasks.Task
4 | import com.android.template.domain.repositories.tasks.TasksRepository
5 | import javax.inject.Inject
6 |
7 | class CreateTaskUseCase @Inject constructor(
8 | private val tasksRepository: TasksRepository,
9 | ) {
10 |
11 | suspend operator fun invoke(task: Task): Task = tasksRepository.createTask(task)
12 | }
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/usecases/tasks/GetTaskUseCase.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.tasks
2 |
3 | import com.android.template.domain.models.tasks.Task
4 | import com.android.template.domain.repositories.tasks.TasksRepository
5 | import kotlinx.coroutines.flow.Flow
6 | import javax.inject.Inject
7 |
8 | class GetTaskUseCase @Inject constructor(
9 | private val tasksRepository: TasksRepository,
10 | ) {
11 |
12 | operator fun invoke(id: String): Flow = tasksRepository.getTask(id)
13 | }
--------------------------------------------------------------------------------
/domain/src/main/java/com/android/template/domain/utils/NullSafetyExtensions.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.utils
2 |
3 | fun Boolean?.orFalse() = this ?: false
4 |
5 | fun Boolean?.orTrue() = this ?: true
6 |
7 | fun Int?.orZero() = this ?: 0
8 |
9 | fun Long?.orZero() = this ?: 0L
10 |
11 | fun Float?.orZero() = this ?: 0f
12 |
13 | fun Double?.orZero() = this ?: 0.0
14 |
15 | fun String?.orEmpty() = this ?: ""
16 |
17 | fun List?.orEmpty() = this ?: emptyList()
18 |
19 | fun Map?.orEmpty() = this ?: emptyMap()
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/repositories/tasks/mappers/TaskMappers.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.repositories.tasks.mappers
2 |
3 | import com.android.template.data.remote.models.responses.tasks.TaskResponse
4 | import com.android.template.domain.models.tasks.Task
5 | import com.android.template.domain.utils.orEmpty
6 |
7 | internal fun TaskResponse.toTask() = Task(
8 | id = id.orEmpty(),
9 | content = content.orEmpty(),
10 | )
11 |
12 | internal fun List.toTaskList() = map { response -> response.toTask() }
--------------------------------------------------------------------------------
/app/src/main/res/xml/backup_rules.xml:
--------------------------------------------------------------------------------
1 |
8 |
9 |
13 |
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/services/TasksService.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.services
2 |
3 | import com.android.template.data.remote.models.responses.tasks.TaskResponse
4 | import retrofit2.http.GET
5 | import retrofit2.http.POST
6 | import retrofit2.http.Path
7 |
8 | internal interface TasksService {
9 |
10 | @GET("/api/tasks")
11 | suspend fun getTaskList(): List
12 |
13 | @GET("/api/tasks/{id}")
14 | suspend fun getTask(@Path("id") id: String): TaskResponse
15 |
16 | @POST("/api/tasks")
17 | suspend fun createTask(): TaskResponse
18 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/interceptors/HeaderInterceptor.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.interceptors
2 |
3 | import okhttp3.Interceptor
4 | import okhttp3.Response
5 | import javax.inject.Inject
6 |
7 | internal class HeaderInterceptor @Inject constructor() : Interceptor {
8 |
9 | override fun intercept(chain: Interceptor.Chain): Response {
10 | val request = chain.request().newBuilder()
11 | .addHeader("Accept", "application/json")
12 | .addHeader("Content-Type", "application/json")
13 | .build()
14 | return chain.proceed(request)
15 | }
16 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/di/modules/StoragesModule.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.di.modules
2 |
3 | import com.android.template.data.storages.datastore.preferences.PreferencesDataStore
4 | import com.android.template.data.storages.datastore.preferences.PreferencesDataStoreImpl
5 | import dagger.Binds
6 | import dagger.Module
7 | import dagger.hilt.InstallIn
8 | import dagger.hilt.components.SingletonComponent
9 |
10 | @Module
11 | @InstallIn(SingletonComponent::class)
12 | internal interface StoragesModule {
13 |
14 | @Binds
15 | fun providePreferencesDataStore(impl: PreferencesDataStoreImpl): PreferencesDataStore
16 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/di/modules/DispatcherModule.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.di.modules
2 |
3 | import com.android.template.providers.dispatchers.DispatcherProvider
4 | import com.android.template.providers.dispatchers.DispatcherProviderImpl
5 | import dagger.Binds
6 | import dagger.Module
7 | import dagger.hilt.InstallIn
8 | import dagger.hilt.components.SingletonComponent
9 | import javax.inject.Singleton
10 |
11 | @Module
12 | @InstallIn(SingletonComponent::class)
13 | internal interface DispatcherModule {
14 |
15 | @Binds
16 | @Singleton
17 | fun bindDispatcherProvider(impl: DispatcherProviderImpl): DispatcherProvider
18 | }
--------------------------------------------------------------------------------
/app/src/main/res/xml/data_extraction_rules.xml:
--------------------------------------------------------------------------------
1 |
6 |
7 |
8 |
12 |
13 |
19 |
--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | pluginManagement {
2 | repositories {
3 | google {
4 | content {
5 | includeGroupByRegex("com\\.android.*")
6 | includeGroupByRegex("com\\.google.*")
7 | includeGroupByRegex("androidx.*")
8 | }
9 | }
10 | mavenCentral()
11 | gradlePluginPortal()
12 | }
13 | }
14 | dependencyResolutionManagement {
15 | repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
16 | repositories {
17 | google()
18 | mavenCentral()
19 | }
20 | }
21 |
22 | rootProject.name = "Android Template"
23 | include(":app")
24 | include(":data")
25 | include(":domain")
26 |
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | Template
3 | Error
4 | Sorry, an error occurred. Please try again.
5 | No internet connection. Please check your connection and try again.
6 | Unauthorized. Please login again.
7 | OK
8 | Welcome to the app!
9 | Tasks
10 | Task Detail
11 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/providers/dispatchers/DispatcherProviderImpl.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.providers.dispatchers
2 |
3 | import kotlinx.coroutines.CoroutineDispatcher
4 | import kotlinx.coroutines.Dispatchers
5 | import javax.inject.Inject
6 |
7 | class DispatcherProviderImpl @Inject constructor() : DispatcherProvider {
8 | override val default: CoroutineDispatcher
9 | get() = Dispatchers.Default
10 |
11 | override val main: CoroutineDispatcher
12 | get() = Dispatchers.Main
13 |
14 | override val io: CoroutineDispatcher
15 | get() = Dispatchers.IO
16 |
17 | override val immediate: CoroutineDispatcher
18 | get() = Dispatchers.Main.immediate
19 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/repositories/preferences/PreferencesRepositoryImpl.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.repositories.preferences
2 |
3 | import com.android.template.data.storages.datastore.preferences.PreferencesDataStore
4 | import com.android.template.domain.repositories.preferences.PreferencesRepository
5 | import javax.inject.Inject
6 |
7 | internal class PreferencesRepositoryImpl @Inject constructor(
8 | private val preferencesDataStore: PreferencesDataStore,
9 | ) : PreferencesRepository {
10 |
11 | override fun isFirstRun() = preferencesDataStore.isFirstRun()
12 |
13 | override suspend fun setFirstRun(isFirstRun: Boolean) =
14 | preferencesDataStore.setFirstRun(isFirstRun)
15 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/main/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.main
2 |
3 | import android.os.Bundle
4 | import androidx.activity.ComponentActivity
5 | import androidx.activity.compose.setContent
6 | import androidx.activity.enableEdgeToEdge
7 | import com.android.template.compose.theme.TemplateTheme
8 | import dagger.hilt.android.AndroidEntryPoint
9 |
10 | @AndroidEntryPoint
11 | internal class MainActivity : ComponentActivity() {
12 |
13 | override fun onCreate(savedInstanceState: Bundle?) {
14 | super.onCreate(savedInstanceState)
15 | enableEdgeToEdge()
16 | setContent {
17 | TemplateTheme {
18 | MainNavHost()
19 | }
20 | }
21 | }
22 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/utils/extenstions/viewmodel/ViewModelExtensions.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.utils.extenstions.viewmodel
2 |
3 | import androidx.lifecycle.ViewModel
4 | import androidx.lifecycle.viewModelScope
5 | import kotlinx.coroutines.CoroutineScope
6 | import kotlinx.coroutines.CoroutineStart
7 | import kotlinx.coroutines.Job
8 | import kotlinx.coroutines.launch
9 | import kotlin.coroutines.CoroutineContext
10 | import kotlin.coroutines.EmptyCoroutineContext
11 |
12 | fun ViewModel.launch(
13 | context: CoroutineContext = EmptyCoroutineContext,
14 | start: CoroutineStart = CoroutineStart.DEFAULT,
15 | block: suspend CoroutineScope.() -> Unit,
16 | ): Job {
17 | return viewModelScope.launch(
18 | context = context,
19 | start = start,
20 | block = block,
21 | )
22 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/adapters/errors/ErrorHandlingCallAdapterFactory.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.adapters.errors
2 |
3 | import retrofit2.CallAdapter
4 | import retrofit2.Retrofit
5 | import java.lang.reflect.ParameterizedType
6 | import java.lang.reflect.Type
7 |
8 | internal class ErrorHandlingCallAdapterFactory : CallAdapter.Factory() {
9 | override fun get(
10 | returnType: Type,
11 | annotations: Array,
12 | retrofit: Retrofit,
13 | ): CallAdapter<*, *> {
14 | val responseType = getParameterUpperBound(0, returnType as ParameterizedType)
15 | return ErrorHandlingCallAdapter(responseType)
16 | }
17 |
18 | companion object {
19 | fun create() = ErrorHandlingCallAdapterFactory()
20 | }
21 | }
22 |
23 |
24 |
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/data/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/domain/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/di/modules/RepositoriesModule.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.di.modules
2 |
3 | import com.android.template.data.repositories.preferences.PreferencesRepositoryImpl
4 | import com.android.template.data.repositories.tasks.TasksRepositoryImpl
5 | import com.android.template.domain.repositories.preferences.PreferencesRepository
6 | import com.android.template.domain.repositories.tasks.TasksRepository
7 | import dagger.Binds
8 | import dagger.Module
9 | import dagger.hilt.InstallIn
10 | import dagger.hilt.components.SingletonComponent
11 |
12 | @Module
13 | @InstallIn(SingletonComponent::class)
14 | internal interface RepositoriesModule {
15 |
16 | @Binds
17 | fun bindTasksRepository(impl: TasksRepositoryImpl): TasksRepository
18 |
19 | @Binds
20 | fun providePreferencesRepository(impl: PreferencesRepositoryImpl): PreferencesRepository
21 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/adapters/errors/ErrorHandlingCallAdapter.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.adapters.errors
2 |
3 | import retrofit2.Call
4 | import retrofit2.CallAdapter
5 | import retrofit2.Callback
6 | import java.lang.reflect.Type
7 |
8 | internal class ErrorHandlingCallAdapter(
9 | private val responseType: Type,
10 | ) : CallAdapter> {
11 |
12 | override fun responseType(): Type = responseType
13 |
14 | override fun adapt(call: Call): Call = MappingApiErrorCall(call)
15 |
16 | private class MappingApiErrorCall(
17 | private val delegate: Call,
18 | ) : Call by delegate {
19 | override fun enqueue(callback: Callback) {
20 | delegate.enqueue(ErrorHandlingCallback(callback))
21 | }
22 |
23 | override fun clone(): Call = MappingApiErrorCall(delegate.clone())
24 | }
25 | }
--------------------------------------------------------------------------------
/domain/src/test/java/com/android/template/domain/usecases/tasks/CreateTaskUseCaseTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.tasks
2 |
3 | import com.android.template.domain.models.tasks.Task
4 | import com.android.template.domain.repositories.tasks.TasksRepository
5 | import io.kotest.matchers.shouldBe
6 | import io.mockk.coEvery
7 | import io.mockk.mockk
8 | import kotlinx.coroutines.test.runTest
9 | import org.junit.Test
10 |
11 | internal class CreateTaskUseCaseTest {
12 |
13 | private val tasksRepository = mockk()
14 | private val useCase = CreateTaskUseCase(tasksRepository)
15 |
16 | @Test
17 | fun `createTask returns task`() = runTest {
18 | // Given
19 | val task = mockk()
20 | coEvery { tasksRepository.createTask(task) } returns task
21 |
22 | // When
23 | val result = useCase(task)
24 |
25 | // Then
26 | result shouldBe task
27 | }
28 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/uistate/mappers/ExceptionMappers.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.uistate.mappers
2 |
3 | import android.content.Context
4 | import com.android.template.R
5 | import com.android.template.compose.uistate.models.ErrorState
6 | import com.android.template.domain.models.errors.ApiException
7 | import com.android.template.domain.models.errors.NoConnectionException
8 | import com.android.template.domain.models.errors.UnauthorizedException
9 |
10 | fun Throwable?.toErrorState(): ErrorState {
11 | return when (this) {
12 | is ApiException -> ErrorState(message = message)
13 | is NoConnectionException -> ErrorState(messageRes = R.string.error_message_no_internet_connection)
14 | is UnauthorizedException -> ErrorState(messageRes = R.string.error_message_unauthorized)
15 | else -> ErrorState(messageRes = R.string.error_message_generic)
16 | }
17 | }
18 |
19 | fun ErrorState.toString(context: Context): String =
20 | message.ifEmpty { context.getString(messageRes) }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/taskdetail/components/TaskDetailContent.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.taskdetail.components
2 |
3 | import androidx.compose.foundation.layout.fillMaxSize
4 | import androidx.compose.foundation.layout.padding
5 | import androidx.compose.material3.MaterialTheme
6 | import androidx.compose.material3.Text
7 | import androidx.compose.runtime.Composable
8 | import androidx.compose.ui.Modifier
9 | import androidx.compose.ui.tooling.preview.Preview
10 | import androidx.compose.ui.unit.dp
11 | import com.android.template.domain.models.tasks.Task
12 |
13 | @Composable
14 | internal fun TaskDetailContent(task: Task, modifier: Modifier = Modifier) {
15 | Text(
16 | text = task.content,
17 | modifier = modifier
18 | .fillMaxSize()
19 | .padding(16.dp),
20 | style = MaterialTheme.typography.bodyLarge,
21 | )
22 | }
23 |
24 | @Preview
25 | @Composable
26 | internal fun TaskDetailContentPreview() {
27 | TaskDetailContent(task = Task(content = "Task content"))
28 | }
--------------------------------------------------------------------------------
/domain/src/test/java/com/android/template/domain/usecases/tasks/GetTaskUseCaseTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.tasks
2 |
3 | import app.cash.turbine.test
4 | import com.android.template.domain.models.tasks.Task
5 | import com.android.template.domain.repositories.tasks.TasksRepository
6 | import io.kotest.matchers.shouldBe
7 | import io.mockk.every
8 | import io.mockk.mockk
9 | import kotlinx.coroutines.flow.flowOf
10 | import kotlinx.coroutines.test.runTest
11 | import org.junit.Test
12 |
13 | internal class GetTaskUseCaseTest {
14 |
15 | private val tasksRepository = mockk()
16 | private val useCase = GetTaskUseCase(tasksRepository)
17 |
18 | @Test
19 | fun `getTask returns task`() = runTest {
20 | // Given
21 | val id = "1"
22 | val task = mockk()
23 | every { tasksRepository.getTask(id) } returns flowOf(task)
24 |
25 | // When
26 | val result = useCase(id)
27 |
28 | // Then
29 | result.test {
30 | expectMostRecentItem() shouldBe task
31 | }
32 | }
33 | }
--------------------------------------------------------------------------------
/domain/src/test/java/com/android/template/domain/usecases/tasks/GetTaskListUseCaseTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.tasks
2 |
3 | import app.cash.turbine.test
4 | import com.android.template.domain.models.tasks.Task
5 | import com.android.template.domain.repositories.tasks.TasksRepository
6 | import io.kotest.matchers.shouldBe
7 | import io.mockk.every
8 | import io.mockk.mockk
9 | import kotlinx.coroutines.flow.Flow
10 | import kotlinx.coroutines.flow.flowOf
11 | import kotlinx.coroutines.test.runTest
12 | import org.junit.Test
13 |
14 | internal class GetTaskListUseCaseTest {
15 |
16 | private val tasksRepository = mockk()
17 | private val useCase = GetTaskListUseCase(tasksRepository)
18 |
19 | @Test
20 | fun `getTaskList returns tasks`() = runTest {
21 | // Given
22 | val taskList = mockk>()
23 | every { tasksRepository.getTaskList() } returns flowOf(taskList)
24 |
25 | // When
26 | val result: Flow> = useCase()
27 |
28 | // Then
29 | result.test { expectMostRecentItem() shouldBe taskList }
30 | }
31 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/theme/Type.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.theme
2 |
3 | import androidx.compose.material3.Typography
4 | import androidx.compose.ui.text.TextStyle
5 | import androidx.compose.ui.text.font.FontFamily
6 | import androidx.compose.ui.text.font.FontWeight
7 | import androidx.compose.ui.unit.sp
8 |
9 | // Set of Material typography styles to start with
10 | val Typography = Typography(
11 | bodyLarge = TextStyle(
12 | fontFamily = FontFamily.Default,
13 | fontWeight = FontWeight.Normal,
14 | fontSize = 16.sp,
15 | lineHeight = 24.sp,
16 | letterSpacing = 0.5.sp
17 | )
18 | /* Other default text styles to override
19 | titleLarge = TextStyle(
20 | fontFamily = FontFamily.Default,
21 | fontWeight = FontWeight.Normal,
22 | fontSize = 22.sp,
23 | lineHeight = 28.sp,
24 | letterSpacing = 0.sp
25 | ),
26 | labelSmall = TextStyle(
27 | fontFamily = FontFamily.Default,
28 | fontWeight = FontWeight.Medium,
29 | fontSize = 11.sp,
30 | lineHeight = 16.sp,
31 | letterSpacing = 0.5.sp
32 | )
33 | */
34 | )
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/components/TaskList.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks.components
2 |
3 | import androidx.compose.foundation.lazy.LazyColumn
4 | import androidx.compose.material3.HorizontalDivider
5 | import androidx.compose.runtime.Composable
6 | import androidx.compose.ui.Modifier
7 | import androidx.compose.ui.tooling.preview.Preview
8 | import com.android.template.domain.models.tasks.Task
9 |
10 | @Composable
11 | internal fun TaskList(
12 | tasks: List,
13 | modifier: Modifier = Modifier,
14 | onClick: (Task) -> Unit = {},
15 | ) {
16 | LazyColumn(modifier = modifier) {
17 | items(tasks.size, key = { index -> tasks[index].id }) { index ->
18 | val task = tasks[index]
19 | TaskItem(task = task, onClick = { onClick(task) })
20 | HorizontalDivider()
21 | }
22 | }
23 | }
24 |
25 | @Preview
26 | @Composable
27 | internal fun TaskListPreview() {
28 | TaskList(
29 | tasks = List(3) { index ->
30 | Task(
31 | id = "$index",
32 | content = "Content $index",
33 | )
34 | },
35 | )
36 | }
37 |
38 |
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/adapters/errors/ErrorHandlingCallback.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.adapters.errors
2 |
3 | import com.android.template.data.remote.adapters.mappers.toThrowable
4 | import com.android.template.domain.models.errors.NoConnectionException
5 | import retrofit2.Call
6 | import retrofit2.Callback
7 | import retrofit2.Response
8 | import java.io.InterruptedIOException
9 | import java.net.UnknownHostException
10 |
11 | internal class ErrorHandlingCallback(
12 | private val delegate: Callback,
13 | ) : Callback {
14 | override fun onResponse(call: Call, response: Response) {
15 | if (response.isSuccessful) {
16 | delegate.onResponse(call, response)
17 | } else {
18 | delegate.onFailure(call, response.toThrowable())
19 | }
20 | }
21 |
22 | override fun onFailure(call: Call, throwable: Throwable) {
23 | when (throwable) {
24 | is UnknownHostException,
25 | is InterruptedIOException -> delegate.onFailure(call, NoConnectionException())
26 |
27 | else -> delegate.onFailure(call, throwable)
28 | }
29 | }
30 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/storages/datastore/preferences/PreferencesDataStoreImpl.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.storages.datastore.preferences
2 |
3 | import android.content.Context
4 | import androidx.datastore.preferences.core.booleanPreferencesKey
5 | import androidx.datastore.preferences.core.edit
6 | import dagger.hilt.android.qualifiers.ApplicationContext
7 | import io.github.osipxd.security.crypto.encryptedPreferencesDataStore
8 | import kotlinx.coroutines.flow.map
9 | import javax.inject.Inject
10 |
11 | private const val FILE_NAME = "android_template"
12 | private val Context.preferences by encryptedPreferencesDataStore(FILE_NAME)
13 |
14 | internal class PreferencesDataStoreImpl @Inject constructor(
15 | @ApplicationContext
16 | private val context: Context,
17 | ) : PreferencesDataStore {
18 |
19 | override fun isFirstRun() = context.preferences.data.map { it[KEY_IS_FIRST] ?: true }
20 |
21 | override suspend fun setFirstRun(isFirstRun: Boolean) {
22 | context.preferences.edit { preferences -> preferences[KEY_IS_FIRST] = isFirstRun }
23 | }
24 |
25 | companion object {
26 | private val KEY_IS_FIRST = booleanPreferencesKey("is_first")
27 | }
28 | }
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
18 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/remote/adapters/mappers/ErrorMappers.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.adapters.mappers
2 |
3 | import com.android.template.data.remote.models.responses.errors.ErrorResponse
4 | import com.android.template.domain.models.errors.ApiException
5 | import com.android.template.domain.models.errors.UnauthorizedException
6 | import com.android.template.domain.utils.orEmpty
7 | import com.android.template.domain.utils.orZero
8 | import com.google.gson.Gson
9 | import retrofit2.Response
10 | import timber.log.Timber
11 | import java.net.HttpURLConnection
12 |
13 | internal fun Response<*>.toThrowable(): Throwable {
14 | if (code() == HttpURLConnection.HTTP_UNAUTHORIZED) {
15 | return UnauthorizedException()
16 | }
17 | val jsonString = errorBody()?.string()
18 | val errorResponse = try {
19 | val gson = Gson()
20 | gson.fromJson(jsonString, ErrorResponse::class.java)
21 | } catch (exception: Exception) {
22 | Timber.e(exception, "Error parsing: \n$jsonString")
23 | return exception
24 | }
25 | return ApiException(
26 | code = errorResponse?.code.orZero(),
27 | message = errorResponse?.message.orEmpty(),
28 | )
29 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/components/loading/Loading.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.components.loading
2 |
3 | import androidx.compose.foundation.clickable
4 | import androidx.compose.foundation.layout.Box
5 | import androidx.compose.foundation.layout.fillMaxSize
6 | import androidx.compose.material3.CircularProgressIndicator
7 | import androidx.compose.material3.MaterialTheme
8 | import androidx.compose.runtime.Composable
9 | import androidx.compose.ui.Alignment
10 | import androidx.compose.ui.Modifier
11 | import androidx.compose.ui.graphics.StrokeCap
12 | import androidx.compose.ui.tooling.preview.Preview
13 | import androidx.compose.ui.unit.dp
14 |
15 | @Composable
16 | fun Loading(modifier: Modifier = Modifier) {
17 | Box(
18 | modifier = modifier
19 | .fillMaxSize()
20 | .clickable(false) {},
21 | contentAlignment = Alignment.Center,
22 | ) {
23 | CircularProgressIndicator(
24 | strokeCap = StrokeCap.Round,
25 | strokeWidth = 4.dp,
26 | trackColor = MaterialTheme.colorScheme.primary.copy(alpha = 0.2f),
27 | )
28 | }
29 | }
30 |
31 | @Preview
32 | @Composable
33 | internal fun LoadingPreview() {
34 | Loading()
35 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/taskdetail/TaskDetailScreen.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.taskdetail
2 |
3 | import androidx.compose.foundation.layout.padding
4 | import androidx.compose.material3.Scaffold
5 | import androidx.compose.runtime.Composable
6 | import androidx.compose.ui.Modifier
7 | import androidx.hilt.navigation.compose.hiltViewModel
8 | import androidx.navigation.NavController
9 | import com.android.template.compose.components.uistate.UiStateScreen
10 | import com.android.template.features.taskdetail.components.TaskDetailContent
11 | import com.android.template.features.taskdetail.components.TaskDetailTopBar
12 |
13 | @Composable
14 | internal fun TaskDetailScreen(
15 | navController: NavController,
16 | modifier: Modifier = Modifier,
17 | viewModel: TaskDetailViewModel = hiltViewModel(),
18 | ) {
19 | UiStateScreen(viewModel = viewModel) { uiState ->
20 | Scaffold(
21 | modifier = modifier,
22 | topBar = { TaskDetailTopBar(onBackClick = navController::navigateUp) },
23 | ) { innerPadding ->
24 | TaskDetailContent(
25 | task = uiState.task,
26 | modifier = modifier.padding(innerPadding),
27 | )
28 | }
29 | }
30 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/components/error/ErrorDialog.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.components.error
2 |
3 | import androidx.compose.foundation.shape.RoundedCornerShape
4 | import androidx.compose.material3.AlertDialog
5 | import androidx.compose.material3.Text
6 | import androidx.compose.material3.TextButton
7 | import androidx.compose.runtime.Composable
8 | import androidx.compose.ui.Modifier
9 | import androidx.compose.ui.res.stringResource
10 | import androidx.compose.ui.tooling.preview.Preview
11 | import androidx.compose.ui.unit.dp
12 | import com.android.template.R
13 |
14 | @Composable
15 | fun ErrorDialog(
16 | message: String,
17 | onDismiss: () -> Unit,
18 | modifier: Modifier = Modifier,
19 | ) {
20 | AlertDialog(
21 | shape = RoundedCornerShape(16.dp),
22 | onDismissRequest = onDismiss,
23 | modifier = modifier,
24 | confirmButton = { TextButton(onClick = onDismiss) { Text(text = stringResource(id = R.string.ok)) } },
25 | title = { Text(text = stringResource(id = R.string.error_title)) },
26 | text = { Text(text = message) },
27 | )
28 | }
29 |
30 | @Preview
31 | @Composable
32 | internal fun ErrorDialogPreview() {
33 | ErrorDialog(
34 | message = "Error message",
35 | onDismiss = {},
36 | )
37 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/components/TaskListTopBar.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks.components
2 |
3 | import androidx.compose.material.icons.Icons
4 | import androidx.compose.material.icons.filled.Add
5 | import androidx.compose.material3.ExperimentalMaterial3Api
6 | import androidx.compose.material3.Icon
7 | import androidx.compose.material3.IconButton
8 | import androidx.compose.material3.Text
9 | import androidx.compose.material3.TopAppBar
10 | import androidx.compose.runtime.Composable
11 | import androidx.compose.ui.Modifier
12 | import androidx.compose.ui.res.stringResource
13 | import androidx.compose.ui.tooling.preview.Preview
14 | import com.android.template.R
15 |
16 | @Composable
17 | @OptIn(ExperimentalMaterial3Api::class)
18 | internal fun TaskListTopBar(
19 | modifier: Modifier = Modifier,
20 | onCreateTaskClick: () -> Unit = {},
21 | ) {
22 | TopAppBar(
23 | title = { Text(text = stringResource(id = R.string.task_list_title)) },
24 | modifier = modifier,
25 | actions = {
26 | IconButton(onClick = onCreateTaskClick) {
27 | Icon(Icons.Filled.Add, null)
28 | }
29 | },
30 | )
31 | }
32 |
33 | @Preview
34 | @Composable
35 | internal fun TaskListTopBarPreview() {
36 | TaskListTopBar()
37 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/main/MainNavHost.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.main
2 |
3 | import androidx.compose.runtime.Composable
4 | import androidx.compose.ui.Modifier
5 | import androidx.navigation.NavHostController
6 | import androidx.navigation.compose.NavHost
7 | import androidx.navigation.compose.composable
8 | import androidx.navigation.compose.rememberNavController
9 | import com.android.template.features.taskdetail.TaskDetailScreen
10 | import com.android.template.features.taskdetail.models.TaskDetailDestination
11 | import com.android.template.features.tasks.TaskListScreen
12 | import com.android.template.features.tasks.models.TaskListDestination
13 |
14 | @Composable
15 | internal fun MainNavHost(
16 | modifier: Modifier = Modifier,
17 | navController: NavHostController = rememberNavController(),
18 | ) {
19 | NavHost(
20 | navController = navController,
21 | startDestination = TaskListDestination,
22 | modifier = modifier,
23 | ) {
24 | composable {
25 | TaskListScreen(
26 | navController = navController,
27 | )
28 | }
29 |
30 | composable {
31 | TaskDetailScreen(
32 | navController = navController,
33 | )
34 | }
35 | }
36 | }
--------------------------------------------------------------------------------
/domain/src/test/java/com/android/template/domain/usecases/preferences/SetFirstRunUseCaseTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.preferences
2 |
3 | import com.android.template.domain.repositories.preferences.PreferencesRepository
4 | import io.mockk.coEvery
5 | import io.mockk.coVerify
6 | import io.mockk.every
7 | import io.mockk.mockk
8 | import kotlinx.coroutines.test.runTest
9 | import org.junit.Test
10 |
11 | internal class SetFirstRunUseCaseTest {
12 |
13 | private val preferencesRepository = mockk()
14 | private val useCase = SetFirstRunUseCase(preferencesRepository)
15 |
16 | @Test
17 | fun `setFirstRun is called with true`() = runTest{
18 | // Given
19 | val expected = true
20 | coEvery { preferencesRepository.setFirstRun(expected) } returns Unit
21 |
22 | // When
23 | useCase(expected)
24 |
25 | // Then
26 | coVerify { preferencesRepository.setFirstRun(expected) }
27 | }
28 |
29 | @Test
30 | fun `setFirstRun is called with false`() = runTest{
31 | // Given
32 | val expected = false
33 | coEvery { preferencesRepository.setFirstRun(expected) } returns Unit
34 |
35 | // When
36 | useCase(expected)
37 |
38 | // Then
39 | coVerify { preferencesRepository.setFirstRun(expected) }
40 | }
41 | }
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/repositories/tasks/TasksRepositoryImpl.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.repositories.tasks
2 |
3 | import com.android.template.data.remote.services.TasksService
4 | import com.android.template.data.repositories.tasks.mappers.toTask
5 | import com.android.template.data.repositories.tasks.mappers.toTaskList
6 | import com.android.template.domain.models.tasks.Task
7 | import com.android.template.domain.repositories.tasks.TasksRepository
8 | import kotlinx.coroutines.flow.Flow
9 | import kotlinx.coroutines.flow.flow
10 | import javax.inject.Inject
11 |
12 | internal class TasksRepositoryImpl @Inject constructor(
13 | private val tasksService: TasksService,
14 | ) : TasksRepository {
15 |
16 | override fun getTaskList(): Flow> {
17 | return flow {
18 | val taskResponses = tasksService.getTaskList()
19 | val taskList = taskResponses.toTaskList()
20 | emit(taskList)
21 | }
22 | }
23 |
24 | override fun getTask(id: String): Flow {
25 | return flow {
26 | val taskResponse = tasksService.getTask(id)
27 | val task = taskResponse.toTask()
28 | emit(task)
29 | }
30 | }
31 |
32 | override suspend fun createTask(task: Task): Task {
33 | return tasksService.createTask().toTask()
34 | }
35 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/taskdetail/components/TaskDetailTopBar.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.taskdetail.components
2 |
3 | import androidx.compose.material.icons.Icons
4 | import androidx.compose.material.icons.automirrored.outlined.ArrowBack
5 | import androidx.compose.material3.ExperimentalMaterial3Api
6 | import androidx.compose.material3.Icon
7 | import androidx.compose.material3.IconButton
8 | import androidx.compose.material3.Text
9 | import androidx.compose.material3.TopAppBar
10 | import androidx.compose.runtime.Composable
11 | import androidx.compose.ui.Modifier
12 | import androidx.compose.ui.res.stringResource
13 | import androidx.compose.ui.tooling.preview.Preview
14 | import com.android.template.R
15 |
16 | @Composable
17 | @OptIn(ExperimentalMaterial3Api::class)
18 | internal fun TaskDetailTopBar(
19 | modifier: Modifier = Modifier,
20 | onBackClick: () -> Unit = {},
21 | ) {
22 | TopAppBar(
23 | title = { Text(text = stringResource(id = R.string.task_detail_title)) },
24 | modifier = modifier,
25 | navigationIcon = {
26 | IconButton(onClick = onBackClick) {
27 | Icon(Icons.AutoMirrored.Outlined.ArrowBack, contentDescription = null)
28 | }
29 | },
30 | )
31 | }
32 |
33 | @Preview
34 | @Composable
35 | internal fun TaskDetailTopBarPreview() {
36 | TaskDetailTopBar()
37 | }
--------------------------------------------------------------------------------
/domain/src/test/java/com/android/template/domain/usecases/preferences/IsFirstRunUseCaseTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.usecases.preferences
2 |
3 | import app.cash.turbine.test
4 | import com.android.template.domain.repositories.preferences.PreferencesRepository
5 | import io.kotest.matchers.shouldBe
6 | import io.mockk.every
7 | import io.mockk.mockk
8 | import kotlinx.coroutines.flow.flowOf
9 | import kotlinx.coroutines.test.runTest
10 | import org.junit.Test
11 |
12 | internal class IsFirstRunUseCaseTest {
13 |
14 | private val preferencesRepository = mockk()
15 | private val useCase = IsFirstRunUseCase(preferencesRepository)
16 |
17 | @Test
18 | fun `isFirstRun returns true`() = runTest {
19 | // Given
20 | val expected = true
21 | every { preferencesRepository.isFirstRun() } returns flowOf(expected)
22 |
23 | // When
24 | val result = useCase()
25 |
26 | // Then
27 | result.test {
28 | expectMostRecentItem() shouldBe expected
29 | }
30 | }
31 |
32 | @Test
33 | fun `isFirstRun returns false`() = runTest {
34 | // Given
35 | val expected = false
36 | every { preferencesRepository.isFirstRun() } returns flowOf(expected)
37 |
38 | // When
39 | val result = useCase()
40 |
41 | // Then
42 | result.test {
43 | expectMostRecentItem() shouldBe expected
44 | }
45 | }
46 | }
--------------------------------------------------------------------------------
/domain/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.android.library)
3 | alias(libs.plugins.jetbrains.kotlin.android)
4 | alias(libs.plugins.hilt.android)
5 | alias(libs.plugins.kotlin.kapt)
6 | }
7 |
8 | android {
9 | namespace = "com.android.template.domain"
10 | compileSdk = libs.versions.compileSdk.get().toInt()
11 |
12 | defaultConfig {
13 | minSdk = libs.versions.minSdk.get().toInt()
14 |
15 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
16 | consumerProguardFiles("consumer-rules.pro")
17 | }
18 |
19 | buildTypes {
20 | release {
21 | isMinifyEnabled = false
22 | proguardFiles(
23 | getDefaultProguardFile("proguard-android-optimize.txt"),
24 | "proguard-rules.pro"
25 | )
26 | }
27 | }
28 | compileOptions {
29 | sourceCompatibility = JavaVersion.VERSION_1_8
30 | targetCompatibility = JavaVersion.VERSION_1_8
31 | }
32 | kotlinOptions {
33 | jvmTarget = "1.8"
34 | }
35 | }
36 |
37 | dependencies {
38 | implementation(libs.kotlinx.coroutines.android)
39 |
40 | implementation(libs.hilt.android)
41 | kapt(libs.hilt.compiler)
42 |
43 | implementation(libs.timber)
44 |
45 | testImplementation(libs.junit)
46 | testImplementation(libs.mockk)
47 | testImplementation(libs.kotest)
48 | testImplementation(libs.turbine)
49 | testImplementation(libs.kotlinx.coroutines.test)
50 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/taskdetail/TaskDetailViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.taskdetail
2 |
3 | import androidx.lifecycle.SavedStateHandle
4 | import androidx.navigation.toRoute
5 | import com.android.template.compose.uistate.models.EmptyEvent
6 | import com.android.template.compose.uistate.viewmodel.UiStateViewModel
7 | import com.android.template.domain.usecases.tasks.GetTaskUseCase
8 | import com.android.template.features.taskdetail.models.TaskDetailDestination
9 | import com.android.template.features.taskdetail.models.TaskDetailUiState
10 | import com.android.template.providers.dispatchers.DispatcherProvider
11 | import dagger.hilt.android.lifecycle.HiltViewModel
12 | import javax.inject.Inject
13 |
14 | @HiltViewModel
15 | internal class TaskDetailViewModel @Inject constructor(
16 | savedStateHandle: SavedStateHandle,
17 | private val dispatcherProvider: DispatcherProvider,
18 | private val getTaskUseCase: GetTaskUseCase,
19 | ) : UiStateViewModel(TaskDetailUiState()) {
20 |
21 | init {
22 | val taskId = savedStateHandle.toRoute().taskId
23 | getTask(taskId)
24 | }
25 |
26 | private fun getTask(taskId: String) {
27 | getTaskUseCase(taskId).collectSafe(
28 | context = dispatcherProvider.io,
29 | hasLoading = true,
30 | onError = ::showError,
31 | ) { task ->
32 | updateUiState { copy(task = task) }
33 | }
34 | }
35 | }
--------------------------------------------------------------------------------
/data/src/test/java/com/android/template/data/repositories/tasks/mappers/TaskMappersKtTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.repositories.tasks.mappers
2 |
3 | import com.android.template.data.remote.models.responses.tasks.TaskResponse
4 | import com.android.template.domain.models.tasks.Task
5 | import io.kotest.matchers.shouldBe
6 | import org.junit.Test
7 |
8 | internal class TaskMappersKtTest {
9 |
10 | @Test
11 | fun `map TaskResponse to Task`() {
12 | val taskResponse = TaskResponse(id = "123", content = "Test Name")
13 | val expectedTask = Task(id = "123", content = "Test Name")
14 |
15 | val actualModel = taskResponse.toTask()
16 |
17 | actualModel shouldBe expectedTask
18 | }
19 |
20 | @Test
21 | fun `map null TaskResponse to Task`() {
22 | val taskResponse = TaskResponse()
23 | val expectedTask = Task()
24 |
25 | val actualModel = taskResponse.toTask()
26 |
27 | actualModel shouldBe expectedTask
28 | }
29 |
30 | @Test
31 | fun `map list of TaskResponse to list of Task`() {
32 | val taskResponseList = listOf(
33 | TaskResponse(id = "123", content = "Test Name"),
34 | TaskResponse(id = "456", content = "Test Name 2")
35 | )
36 | val expectedTaskList = listOf(
37 | Task(id = "123", content = "Test Name"),
38 | Task(id = "456", content = "Test Name 2")
39 | )
40 |
41 | val actualTaskList = taskResponseList.toTaskList()
42 |
43 | actualTaskList shouldBe expectedTaskList
44 | }
45 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/components/TaskItem.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks.components
2 |
3 | import androidx.compose.foundation.clickable
4 | import androidx.compose.foundation.layout.Box
5 | import androidx.compose.foundation.layout.fillMaxWidth
6 | import androidx.compose.foundation.layout.height
7 | import androidx.compose.foundation.layout.padding
8 | import androidx.compose.material3.MaterialTheme
9 | import androidx.compose.material3.Text
10 | import androidx.compose.runtime.Composable
11 | import androidx.compose.ui.Alignment
12 | import androidx.compose.ui.Modifier
13 | import androidx.compose.ui.text.style.TextOverflow
14 | import androidx.compose.ui.tooling.preview.Preview
15 | import androidx.compose.ui.unit.dp
16 | import com.android.template.domain.models.tasks.Task
17 |
18 | @Composable
19 | internal fun TaskItem(
20 | task: Task,
21 | modifier: Modifier = Modifier,
22 | onClick: () -> Unit = {}
23 | ) {
24 | Box(
25 | modifier = modifier
26 | .fillMaxWidth()
27 | .height(56.dp)
28 | .clickable { onClick() },
29 | contentAlignment = Alignment.CenterStart,
30 | ) {
31 | Text(
32 | text = task.content,
33 | modifier = Modifier.padding(16.dp),
34 | style = MaterialTheme.typography.titleMedium,
35 | overflow = TextOverflow.Ellipsis,
36 | )
37 | }
38 | }
39 |
40 | @Preview
41 | @Composable
42 | internal fun TaskItemPreview() {
43 | TaskItem(
44 | task = Task(
45 | id = "1",
46 | content = "Content 1",
47 | )
48 | )
49 | }
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
8 |
9 |
15 |
18 |
21 |
22 |
23 |
24 |
30 |
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/theme/Theme.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.theme
2 |
3 | import android.os.Build
4 | import androidx.compose.foundation.isSystemInDarkTheme
5 | import androidx.compose.material3.MaterialTheme
6 | import androidx.compose.material3.darkColorScheme
7 | import androidx.compose.material3.dynamicDarkColorScheme
8 | import androidx.compose.material3.dynamicLightColorScheme
9 | import androidx.compose.material3.lightColorScheme
10 | import androidx.compose.runtime.Composable
11 | import androidx.compose.ui.platform.LocalContext
12 |
13 | private val DarkColorScheme = darkColorScheme(
14 | primary = Purple80,
15 | secondary = PurpleGrey80,
16 | tertiary = Pink80
17 | )
18 |
19 | private val LightColorScheme = lightColorScheme(
20 | primary = Purple40,
21 | secondary = PurpleGrey40,
22 | tertiary = Pink40
23 |
24 | /* Other default colors to override
25 | background = Color(0xFFFFFBFE),
26 | surface = Color(0xFFFFFBFE),
27 | onPrimary = Color.White,
28 | onSecondary = Color.White,
29 | onTertiary = Color.White,
30 | onBackground = Color(0xFF1C1B1F),
31 | onSurface = Color(0xFF1C1B1F),
32 | */
33 | )
34 |
35 | @Composable
36 | fun TemplateTheme(
37 | darkTheme: Boolean = isSystemInDarkTheme(),
38 | // Dynamic color is available on Android 12+
39 | dynamicColor: Boolean = true,
40 | content: @Composable () -> Unit
41 | ) {
42 | val colorScheme = when {
43 | dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> {
44 | val context = LocalContext.current
45 | if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context)
46 | }
47 |
48 | darkTheme -> DarkColorScheme
49 | else -> LightColorScheme
50 | }
51 |
52 | MaterialTheme(
53 | colorScheme = colorScheme,
54 | typography = Typography,
55 | content = content
56 | )
57 | }
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Android Template
2 |
3 | Welcome to the Android Template repository! This project is designed to help you kickstart your Android development with best practices and the latest technologies.
4 |
5 | ## Key Features
6 |
7 | - **Clean Architecture**: Ensures a robust, scalable, and testable codebase.
8 | - **MVVM**: Facilitates separation of concerns and promotes a cleaner architecture.
9 | - **Jetpack Compose**: Modern toolkit for building native UI with less code.
10 | - **Navigation Component**: Simplifies navigation and passing data between destinations.
11 | - **Hilt**: Reduces boilerplate for dependency injection.
12 | - **Encrypted DataStore**: Secure storage for key-value pairs.
13 | - **Coroutines and Flow**: Simplifies asynchronous programming and stream handling.
14 | - **Retrofit**: Type-safe HTTP client.
15 | - **Unit Testing**: Reliable and bug-free code using JUnit and MockK.
16 |
17 | ## Getting Started
18 |
19 | ### Prerequisites
20 |
21 | - **Android Studio**
22 | - **JDK 11**
23 |
24 | ### Installation
25 |
26 | 1. **Clone the repository**:
27 | ```bash
28 | git clone https://github.com/huuphuoc1396/android-template.git
29 | ```
30 | 2. **Open the project** in Android Studio.
31 | 3. **Build the project**.
32 |
33 | ### Project Structure
34 |
35 | - **presentation** (`app`): UI components and ViewModels.
36 | - **`domain`**: Use cases, models, and repository interfaces.
37 | - **`data`**: Data sources, repositories, and mappers.
38 |
39 | ### Contributing
40 |
41 | Contributions are welcome! Please follow these steps:
42 |
43 | 1. **Fork the repository**.
44 | 2. **Create a new branch** for your feature or bugfix.
45 | 3. **Commit your changes**.
46 | 4. **Push to your branch**.
47 | 5. **Create a pull request**.
48 |
49 | ### License
50 |
51 | This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
52 |
53 | ### Contact
54 |
55 | For any inquiries, please reach out to [Phuoc Bui](https://github.com/huuphuoc1396).
--------------------------------------------------------------------------------
/data/src/main/java/com/android/template/data/di/modules/RemoteModule.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.di.modules
2 |
3 | import com.android.template.data.BuildConfig
4 | import com.android.template.data.remote.adapters.errors.ErrorHandlingCallAdapterFactory
5 | import com.android.template.data.remote.interceptors.HeaderInterceptor
6 | import com.android.template.data.remote.services.TasksService
7 | import dagger.Module
8 | import dagger.Provides
9 | import dagger.hilt.InstallIn
10 | import dagger.hilt.components.SingletonComponent
11 | import okhttp3.OkHttpClient
12 | import okhttp3.logging.HttpLoggingInterceptor
13 | import retrofit2.Retrofit
14 | import retrofit2.converter.gson.GsonConverterFactory
15 | import javax.inject.Singleton
16 |
17 | @Module
18 | @InstallIn(SingletonComponent::class)
19 | internal class RemoteModule {
20 |
21 | @Provides
22 | @Singleton
23 | fun provideHttpLoggingInterceptor(): HttpLoggingInterceptor {
24 | return HttpLoggingInterceptor().apply {
25 | level = HttpLoggingInterceptor.Level.BODY
26 | }
27 | }
28 |
29 | @Provides
30 | @Singleton
31 | fun provideOkHttpClient(
32 | headerInterceptor: HeaderInterceptor,
33 | httpLoggingInterceptor: HttpLoggingInterceptor,
34 | ): OkHttpClient {
35 | return OkHttpClient.Builder()
36 | .addInterceptor(headerInterceptor)
37 | .addInterceptor(httpLoggingInterceptor)
38 | .build()
39 | }
40 |
41 | @Provides
42 | @Singleton
43 | fun provideRetrofit(okHttpClient: OkHttpClient): Retrofit {
44 | return Retrofit.Builder()
45 | .baseUrl(BuildConfig.BASE_URL)
46 | .addConverterFactory(GsonConverterFactory.create())
47 | .addCallAdapterFactory(ErrorHandlingCallAdapterFactory.create())
48 | .client(okHttpClient)
49 | .build()
50 | }
51 |
52 | @Provides
53 | @Singleton
54 | fun provideTasksService(retrofit: Retrofit): TasksService {
55 | return retrofit.create(TasksService::class.java)
56 | }
57 | }
--------------------------------------------------------------------------------
/data/src/test/java/com/android/template/data/repositories/tasks/TasksRepositoryImplTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.repositories.tasks
2 |
3 | import app.cash.turbine.test
4 | import com.android.template.data.remote.models.responses.tasks.TaskResponse
5 | import com.android.template.data.remote.services.TasksService
6 | import com.android.template.data.repositories.tasks.mappers.toTask
7 | import com.android.template.data.repositories.tasks.mappers.toTaskList
8 | import io.kotest.matchers.shouldBe
9 | import io.mockk.coEvery
10 | import io.mockk.mockk
11 | import kotlinx.coroutines.test.runTest
12 | import org.junit.Test
13 |
14 | internal class TasksRepositoryImplTest {
15 |
16 | private val tasksService: TasksService = mockk()
17 | private val repository = TasksRepositoryImpl(tasksService)
18 |
19 | @Test
20 | fun `getTaskList returns tasks`() = runTest {
21 | // Given
22 | val responses = listOf(TaskResponse())
23 | val expected = responses.toTaskList()
24 | coEvery { tasksService.getTaskList() } returns responses
25 |
26 | // When
27 | val result = repository.getTaskList()
28 |
29 | // Then
30 | result.test {
31 | expectMostRecentItem() shouldBe expected
32 | }
33 | }
34 |
35 | @Test
36 | fun `getTask returns task`() = runTest {
37 | // Given
38 | val id = "id"
39 | val response = TaskResponse()
40 | val expected = response.toTask()
41 | coEvery { tasksService.getTask(id) } returns response
42 |
43 | // When
44 | val result = repository.getTask(id)
45 |
46 | // Then
47 | result.test {
48 | expectMostRecentItem() shouldBe expected
49 | }
50 | }
51 |
52 | @Test
53 | fun `createTask returns task`() = runTest {
54 | // Given
55 | val response = TaskResponse()
56 | val task = response.toTask()
57 | coEvery { tasksService.createTask() } returns response
58 |
59 | // When
60 | val result = repository.createTask(task)
61 |
62 | // Then
63 | result shouldBe task
64 | }
65 | }
--------------------------------------------------------------------------------
/data/src/test/java/com/android/template/data/repositories/preferences/PreferencesRepositoryImplTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.repositories.preferences
2 |
3 | import app.cash.turbine.test
4 | import com.android.template.data.storages.datastore.preferences.PreferencesDataStore
5 | import io.kotest.matchers.shouldBe
6 | import io.mockk.coEvery
7 | import io.mockk.coVerify
8 | import io.mockk.every
9 | import io.mockk.mockk
10 | import kotlinx.coroutines.flow.flowOf
11 | import kotlinx.coroutines.test.runTest
12 | import org.junit.Test
13 |
14 | internal class PreferencesRepositoryImplTest {
15 |
16 | private val preferencesDataStore = mockk()
17 | private val repository = PreferencesRepositoryImpl(preferencesDataStore)
18 |
19 | @Test
20 | fun `isFirstRun returns true`() = runTest {
21 | // Given
22 | val expected = true
23 | every { preferencesDataStore.isFirstRun() } returns flowOf(expected)
24 |
25 | // When
26 | val result = repository.isFirstRun()
27 |
28 | // Then
29 | result.test {
30 | expectMostRecentItem() shouldBe expected
31 | }
32 | }
33 |
34 | @Test
35 | fun `isFirstRun returns false`() = runTest {
36 | // Given
37 | val expected = false
38 | every { preferencesDataStore.isFirstRun() } returns flowOf(expected)
39 |
40 | // When
41 | val result = repository.isFirstRun()
42 |
43 | // Then
44 | result.test {
45 | expectMostRecentItem() shouldBe expected
46 | }
47 | }
48 |
49 | @Test
50 | fun `setFirstRun is true`() = runTest {
51 | // Given
52 | val isFirstRun = true
53 | coEvery { preferencesDataStore.setFirstRun(isFirstRun) } returns Unit
54 |
55 | // When
56 | repository.setFirstRun(isFirstRun)
57 |
58 | // Then
59 | coVerify { preferencesDataStore.setFirstRun(isFirstRun) }
60 | }
61 |
62 | @Test
63 | fun `setFirstRun is false`() = runTest {
64 | // Given
65 | val isFirstRun = false
66 | coEvery { preferencesDataStore.setFirstRun(isFirstRun) } returns Unit
67 |
68 | // When
69 | repository.setFirstRun(isFirstRun)
70 |
71 | // Then
72 | coVerify { preferencesDataStore.setFirstRun(isFirstRun) }
73 | }
74 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/TaskListScreen.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks
2 |
3 | import android.content.Context
4 | import android.widget.Toast
5 | import androidx.compose.foundation.layout.fillMaxSize
6 | import androidx.compose.foundation.layout.padding
7 | import androidx.compose.material3.Scaffold
8 | import androidx.compose.runtime.Composable
9 | import androidx.compose.ui.Modifier
10 | import androidx.compose.ui.platform.LocalContext
11 | import androidx.hilt.navigation.compose.hiltViewModel
12 | import androidx.navigation.NavController
13 | import com.android.template.R
14 | import com.android.template.compose.components.uistate.UiStateScreen
15 | import com.android.template.features.taskdetail.models.TaskDetailDestination
16 | import com.android.template.features.tasks.components.TaskList
17 | import com.android.template.features.tasks.components.TaskListTopBar
18 | import com.android.template.features.tasks.models.TaskListEvent
19 |
20 | @Composable
21 | internal fun TaskListScreen(
22 | navController: NavController,
23 | modifier: Modifier = Modifier,
24 | viewModel: TaskListViewModel = hiltViewModel(),
25 | ) {
26 | val context = LocalContext.current
27 | UiStateScreen(
28 | viewModel = viewModel,
29 | onEvent = { event ->
30 | handleEvent(
31 | event = event,
32 | context = context,
33 | navController = navController,
34 | )
35 | },
36 | ) { uiState ->
37 | Scaffold(
38 | modifier = modifier.fillMaxSize(),
39 | topBar = { TaskListTopBar(onCreateTaskClick = viewModel::createTask) },
40 | ) { innerPadding ->
41 | TaskList(
42 | tasks = uiState.tasks,
43 | modifier = Modifier.padding(innerPadding),
44 | onClick = viewModel::openTaskDetail
45 | )
46 | }
47 | }
48 | }
49 |
50 | private fun handleEvent(
51 | event: TaskListEvent,
52 | context: Context,
53 | navController: NavController,
54 | ) {
55 | when (event) {
56 | is TaskListEvent.FirstRun -> {
57 | Toast.makeText(context, R.string.first_run_message, Toast.LENGTH_SHORT).show()
58 | }
59 |
60 | is TaskListEvent.OpenTaskDetail -> {
61 | navController.navigate(TaskDetailDestination(taskId = event.taskId))
62 | }
63 | }
64 | }
65 |
66 |
--------------------------------------------------------------------------------
/data/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.android.library)
3 | alias(libs.plugins.jetbrains.kotlin.android)
4 | alias(libs.plugins.hilt.android)
5 | alias(libs.plugins.kotlin.kapt)
6 | }
7 |
8 | android {
9 | namespace = "com.android.template.data"
10 | compileSdk = libs.versions.compileSdk.get().toInt()
11 |
12 | defaultConfig {
13 | minSdk = libs.versions.minSdk.get().toInt()
14 |
15 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
16 | consumerProguardFiles("consumer-rules.pro")
17 | }
18 |
19 | buildTypes {
20 | release {
21 | isMinifyEnabled = false
22 | proguardFiles(
23 | getDefaultProguardFile("proguard-android-optimize.txt"),
24 | "proguard-rules.pro"
25 | )
26 |
27 | buildConfigField(
28 | type = "String",
29 | name = "BASE_URL",
30 | value = "\"https://669b63f7276e45187d355230.mockapi.io\"",
31 | )
32 | }
33 |
34 | debug {
35 | buildConfigField(
36 | type = "String",
37 | name = "BASE_URL",
38 | value = "\"https://669b63f7276e45187d355230.mockapi.io\"",
39 | )
40 | }
41 | }
42 | compileOptions {
43 | sourceCompatibility = JavaVersion.VERSION_1_8
44 | targetCompatibility = JavaVersion.VERSION_1_8
45 | }
46 | kotlinOptions {
47 | jvmTarget = "1.8"
48 | }
49 | buildFeatures {
50 | buildConfig = true
51 | }
52 | }
53 |
54 | dependencies {
55 | implementation(project(":domain"))
56 |
57 | implementation(libs.kotlinx.coroutines.android)
58 |
59 | implementation(libs.hilt.android)
60 | kapt(libs.hilt.compiler)
61 |
62 | implementation(libs.room.runtime)
63 | kapt(libs.room.compiler)
64 |
65 | implementation(libs.retrofit)
66 | implementation(libs.retrofit.converter.gson)
67 | implementation(libs.okhttp3.logging)
68 | implementation(libs.gson)
69 |
70 | implementation(libs.security.crypto.datastore)
71 | implementation(libs.security.crypto.datastore.preferences)
72 |
73 | implementation(libs.timber)
74 |
75 | testImplementation(libs.junit)
76 | testImplementation(libs.mockk)
77 | testImplementation(libs.kotest)
78 | testImplementation(libs.turbine)
79 | testImplementation(libs.kotlinx.coroutines.test)
80 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/components/uistate/UiStateScreen.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.components.uistate
2 |
3 | import androidx.compose.animation.AnimatedVisibility
4 | import androidx.compose.animation.fadeIn
5 | import androidx.compose.animation.fadeOut
6 | import androidx.compose.foundation.layout.Box
7 | import androidx.compose.foundation.layout.fillMaxSize
8 | import androidx.compose.runtime.Composable
9 | import androidx.compose.runtime.LaunchedEffect
10 | import androidx.compose.runtime.getValue
11 | import androidx.compose.ui.Modifier
12 | import androidx.compose.ui.platform.LocalContext
13 | import androidx.lifecycle.Lifecycle
14 | import androidx.lifecycle.compose.LocalLifecycleOwner
15 | import androidx.lifecycle.compose.collectAsStateWithLifecycle
16 | import androidx.lifecycle.flowWithLifecycle
17 | import com.android.template.compose.components.error.ErrorDialog
18 | import com.android.template.compose.components.loading.Loading
19 | import com.android.template.compose.uistate.mappers.toString
20 | import com.android.template.compose.uistate.viewmodel.UiStateViewModel
21 |
22 | @Composable
23 | fun UiStateScreen(
24 | viewModel: UiStateViewModel,
25 | lifecycle: Lifecycle = LocalLifecycleOwner.current.lifecycle,
26 | lifecycleState: Lifecycle.State = Lifecycle.State.RESUMED,
27 | onEvent: (Event) -> Unit = {},
28 | content: @Composable (uiState: UiState) -> Unit,
29 | ) {
30 | val context = LocalContext.current
31 | val uiState by viewModel.uiState.collectAsStateWithLifecycle()
32 | val error by viewModel.error.collectAsStateWithLifecycle()
33 | val isLoading by viewModel.isLoading.collectAsStateWithLifecycle()
34 |
35 | Box(modifier = Modifier.fillMaxSize()) {
36 | content(uiState)
37 | AnimatedVisibility(
38 | visible = isLoading,
39 | enter = fadeIn(),
40 | exit = fadeOut(),
41 | content = { Loading() },
42 | )
43 | if (error.hasError()) {
44 | ErrorDialog(
45 | message = error.toString(context),
46 | onDismiss = viewModel::hideError,
47 | )
48 | }
49 | }
50 |
51 | LaunchedEffect(Unit) {
52 | viewModel.singleEvent.flowWithLifecycle(
53 | lifecycle = lifecycle,
54 | minActiveState = lifecycleState,
55 | ).collect { event ->
56 | onEvent(event)
57 | }
58 | }
59 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/features/tasks/TaskListViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks
2 |
3 | import com.android.template.compose.uistate.viewmodel.UiStateViewModel
4 | import com.android.template.domain.models.tasks.Task
5 | import com.android.template.domain.usecases.preferences.IsFirstRunUseCase
6 | import com.android.template.domain.usecases.preferences.SetFirstRunUseCase
7 | import com.android.template.domain.usecases.tasks.CreateTaskUseCase
8 | import com.android.template.domain.usecases.tasks.GetTaskListUseCase
9 | import com.android.template.domain.utils.orTrue
10 | import com.android.template.features.tasks.models.TaskListEvent
11 | import com.android.template.features.tasks.models.TaskListUiState
12 | import com.android.template.providers.dispatchers.DispatcherProvider
13 | import dagger.hilt.android.lifecycle.HiltViewModel
14 | import kotlinx.collections.immutable.toPersistentList
15 | import kotlinx.coroutines.flow.firstOrNull
16 | import javax.inject.Inject
17 |
18 | @HiltViewModel
19 | internal class TaskListViewModel @Inject constructor(
20 | private val dispatcherProvider: DispatcherProvider,
21 | private val createTaskUseCase: CreateTaskUseCase,
22 | private val getTaskListUseCase: GetTaskListUseCase,
23 | private val isFirstRunUseCase: IsFirstRunUseCase,
24 | private val setFirstRunUseCase: SetFirstRunUseCase,
25 | ) : UiStateViewModel(TaskListUiState()) {
26 |
27 | init {
28 | getTaskList()
29 | checkFirstRun()
30 | }
31 |
32 | private fun checkFirstRun() {
33 | launchSafe {
34 | val isFirstRun = isFirstRunUseCase().firstOrNull().orTrue()
35 | if (isFirstRun) {
36 | setFirstRunUseCase(false)
37 | sendEvent(TaskListEvent.FirstRun)
38 | }
39 | }
40 | }
41 |
42 | private fun getTaskList() {
43 | getTaskListUseCase().collectSafe(
44 | context = dispatcherProvider.io,
45 | hasLoading = true,
46 | onError = ::showError,
47 | ) { tasks ->
48 | updateUiState { copy(tasks = tasks.toPersistentList()) }
49 | }
50 | }
51 |
52 | fun createTask() {
53 | launchSafe(
54 | context = dispatcherProvider.io,
55 | hasLoading = true,
56 | onError = ::showError,
57 | ) {
58 | val createdTask = createTaskUseCase(Task())
59 | val tasks = getUiState().tasks.toMutableList() + createdTask
60 | updateUiState { copy(tasks = tasks.toPersistentList()) }
61 | }
62 | }
63 |
64 | fun openTaskDetail(task: Task) {
65 | sendEvent(TaskListEvent.OpenTaskDetail(task.id))
66 | }
67 | }
--------------------------------------------------------------------------------
/data/src/test/java/com/android/template/data/remote/adapters/mappers/ErrorMappersKtTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.adapters.mappers
2 |
3 | import com.android.template.domain.models.errors.ApiException
4 | import com.android.template.domain.models.errors.UnauthorizedException
5 | import com.google.gson.JsonSyntaxException
6 | import io.kotest.matchers.should
7 | import io.kotest.matchers.shouldBe
8 | import io.kotest.matchers.types.beInstanceOf
9 | import io.mockk.every
10 | import io.mockk.mockk
11 | import org.junit.Test
12 | import retrofit2.Response
13 |
14 | internal class ErrorMappersKtTest {
15 |
16 | @Test
17 | fun `toThrowable returns UnauthorizedException for 401 response`() {
18 | // Given
19 | val response = mockk>()
20 | val code = 401
21 | every { response.code() } returns code
22 |
23 | // When
24 | val result = response.toThrowable()
25 |
26 | // Then
27 | result shouldBe UnauthorizedException()
28 | }
29 |
30 | @Test
31 | fun `toThrowable returns UnauthorizedException for 404 response`() {
32 | // Given
33 | val response = mockk>()
34 | val code = 404
35 | val json = "{\"code\":404,\"message\":\"Not Found\"}"
36 | every { response.code() } returns code
37 | every { response.errorBody()?.string() } returns json
38 |
39 | // When
40 | val result = response.toThrowable()
41 |
42 | // Then
43 | result shouldBe ApiException(code = 404, message = "Not Found")
44 | }
45 |
46 | @Test
47 | fun `toThrowable returns JsonSyntaxException for parsing error`() {
48 | // Given
49 | val response = mockk>()
50 | val code = 404
51 | val json = "error"
52 | every { response.code() } returns code
53 | every { response.errorBody()?.string() } returns json
54 |
55 | // When
56 | val result = response.toThrowable()
57 |
58 | // Then
59 | result should beInstanceOf()
60 | }
61 |
62 | @Test
63 | fun `toThrowable returns default ApiException for empty response`() {
64 | // Given
65 | val response = mockk>()
66 | val code = 404
67 | val json = "{}"
68 | every { response.code() } returns code
69 | every { response.errorBody()?.string() } returns json
70 |
71 | // When
72 | val result = response.toThrowable()
73 |
74 | // Then
75 | result shouldBe ApiException()
76 | }
77 |
78 | @Test
79 | fun `toThrowable returns default ApiException for null errorBody`() {
80 | // Given
81 | val response = mockk>()
82 | val code = 404
83 | every { response.code() } returns code
84 | every { response.errorBody() } returns null
85 |
86 | // When
87 | val result = response.toThrowable()
88 |
89 | // Then
90 | result shouldBe ApiException()
91 | }
92 | }
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 |
17 | @if "%DEBUG%" == "" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 |
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 |
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%" == "" set DIRNAME=.
29 | set APP_BASE_NAME=%~n0
30 | set APP_HOME=%DIRNAME%
31 |
32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
34 |
35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
37 |
38 | @rem Find java.exe
39 | if defined JAVA_HOME goto findJavaFromJavaHome
40 |
41 | set JAVA_EXE=java.exe
42 | %JAVA_EXE% -version >NUL 2>&1
43 | if "%ERRORLEVEL%" == "0" goto execute
44 |
45 | echo.
46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
47 | echo.
48 | echo Please set the JAVA_HOME variable in your environment to match the
49 | echo location of your Java installation.
50 |
51 | goto fail
52 |
53 | :findJavaFromJavaHome
54 | set JAVA_HOME=%JAVA_HOME:"=%
55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
56 |
57 | if exist "%JAVA_EXE%" goto execute
58 |
59 | echo.
60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
61 | echo.
62 | echo Please set the JAVA_HOME variable in your environment to match the
63 | echo location of your Java installation.
64 |
65 | goto fail
66 |
67 | :execute
68 | @rem Setup the command line
69 |
70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
71 |
72 |
73 | @rem Execute Gradle
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
75 |
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 |
80 | :fail
81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 |
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 |
89 | :omega
90 |
--------------------------------------------------------------------------------
/app/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.android.application)
3 | alias(libs.plugins.jetbrains.kotlin.android)
4 | alias(libs.plugins.hilt.android)
5 | alias(libs.plugins.kotlin.kapt)
6 | alias(libs.plugins.kotlin.seriazation)
7 | alias(libs.plugins.kotlin.compose.compiler)
8 | }
9 |
10 | android {
11 | namespace = "com.android.template"
12 | compileSdk = libs.versions.compileSdk.get().toInt()
13 |
14 | defaultConfig {
15 | applicationId = "com.android.template"
16 | minSdk = libs.versions.minSdk.get().toInt()
17 | targetSdk = libs.versions.targetSdk.get().toInt()
18 | versionCode = 1
19 | versionName = "0.0.1"
20 |
21 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
22 | vectorDrawables {
23 | useSupportLibrary = true
24 | }
25 | }
26 |
27 | buildTypes {
28 | release {
29 | isMinifyEnabled = false
30 | proguardFiles(
31 | getDefaultProguardFile("proguard-android-optimize.txt"),
32 | "proguard-rules.pro"
33 | )
34 | }
35 | }
36 | compileOptions {
37 | sourceCompatibility = JavaVersion.VERSION_1_8
38 | targetCompatibility = JavaVersion.VERSION_1_8
39 | }
40 | kotlinOptions {
41 | jvmTarget = "1.8"
42 | }
43 | buildFeatures {
44 | buildConfig = true
45 | compose = true
46 | }
47 | composeOptions {
48 | kotlinCompilerExtensionVersion = "1.5.14"
49 | }
50 | packaging {
51 | resources {
52 | excludes += "/META-INF/{AL2.0,LGPL2.1}"
53 | }
54 | }
55 | }
56 |
57 | dependencies {
58 | implementation(project(":data"))
59 | implementation(project(":domain"))
60 |
61 | implementation(libs.androidx.core.ktx)
62 | implementation(libs.androidx.lifecycle.runtime.ktx)
63 | implementation(libs.androidx.lifecycle.viewmodel.compose)
64 | implementation(libs.androidx.activity.compose)
65 |
66 | implementation(platform(libs.androidx.compose.bom))
67 | implementation(libs.androidx.ui)
68 | implementation(libs.androidx.ui.graphics)
69 | implementation(libs.androidx.ui.tooling.preview)
70 | implementation(libs.androidx.material3)
71 | implementation(libs.androidx.navigation.compose)
72 |
73 | implementation(libs.kotlinx.coroutines.android)
74 | implementation(libs.kotlinx.collections.immutable)
75 | implementation(libs.kotlinx.serialization.json)
76 |
77 | implementation(libs.hilt.android)
78 | kapt(libs.hilt.compiler)
79 | implementation(libs.hilt.navigation.compose)
80 |
81 | implementation(libs.timber)
82 |
83 | testImplementation(libs.junit)
84 | testImplementation(libs.junit)
85 | testImplementation(libs.mockk)
86 | testImplementation(libs.kotest)
87 | testImplementation(libs.turbine)
88 | testImplementation(libs.kotlinx.coroutines.test)
89 | androidTestImplementation(libs.androidx.junit)
90 | androidTestImplementation(libs.androidx.espresso.core)
91 | androidTestImplementation(platform(libs.androidx.compose.bom))
92 | androidTestImplementation(libs.androidx.ui.test.junit4)
93 | debugImplementation(libs.androidx.ui.tooling)
94 | debugImplementation(libs.androidx.ui.test.manifest)
95 | }
--------------------------------------------------------------------------------
/data/src/test/java/com/android/template/data/remote/adapters/errors/ErrorHandlingCallbackTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.data.remote.adapters.errors
2 |
3 | import androidx.datastore.preferences.protobuf.Any
4 | import com.android.template.domain.models.errors.NoConnectionException
5 | import io.mockk.every
6 | import io.mockk.mockk
7 | import io.mockk.verify
8 | import org.junit.Test
9 | import retrofit2.Callback
10 | import java.net.UnknownHostException
11 |
12 | class ErrorHandlingCallbackTest {
13 |
14 | private val response = mockk>()
15 | private val call = mockk>()
16 | private val delegate = mockk>()
17 | private val errorHandlingCallback = ErrorHandlingCallback(delegate)
18 |
19 | @Test
20 | fun `onResponse should call delegate onResponse when response is successful`() {
21 | // Given
22 | every { response.isSuccessful } returns true
23 | every { delegate.onResponse(call, response) } returns Unit
24 |
25 | // When
26 | errorHandlingCallback.onResponse(call, response)
27 |
28 | // Then
29 | verify { delegate.onResponse(call, response) }
30 | }
31 |
32 | @Test
33 | fun `onResponse should call delegate onFailure with throwable for unsuccessful response`() {
34 | // Given
35 | every { response.isSuccessful } returns false
36 | every { response.code() } returns 500
37 | every { response.errorBody()?.string() } returns "error"
38 | every { delegate.onFailure(call, any()) } returns Unit
39 |
40 | // When
41 | errorHandlingCallback.onResponse(call, response)
42 |
43 | // Then
44 | verify { delegate.onFailure(call, any()) }
45 | }
46 |
47 | @Test
48 | fun `onFailure should call delegate onFailure with NoConnectionException for UnknownHostException`() {
49 | // Given
50 | val unknownHostException = mockk()
51 | every { response.isSuccessful } returns false
52 | every { delegate.onFailure(call, any()) } returns Unit
53 |
54 | // When
55 | errorHandlingCallback.onFailure(call, unknownHostException)
56 |
57 | // Then
58 | verify { delegate.onFailure(call, NoConnectionException()) }
59 | }
60 |
61 | @Test
62 | fun `onFailure should call delegate onFailure with NoConnectionException for InterruptedIOException`() {
63 | // Given
64 | val interruptedIOException = mockk()
65 | every { response.isSuccessful } returns false
66 | every { delegate.onFailure(call, any()) } returns Unit
67 |
68 | // When
69 | errorHandlingCallback.onFailure(call, interruptedIOException)
70 |
71 | // Then
72 | verify { delegate.onFailure(call, NoConnectionException()) }
73 | }
74 |
75 | @Test
76 | fun `onFailure should call delegate onFailure with throwable for other exceptions`() {
77 | // Given
78 | val throwable = mockk()
79 | every { response.isSuccessful } returns false
80 | every { delegate.onFailure(call, any()) } returns Unit
81 |
82 | // When
83 | errorHandlingCallback.onFailure(call, throwable)
84 |
85 | // Then
86 | verify { delegate.onFailure(call, throwable) }
87 | }
88 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/android/template/compose/uistate/viewmodel/UiStateViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.compose.uistate.viewmodel
2 |
3 | import androidx.lifecycle.ViewModel
4 | import androidx.lifecycle.viewModelScope
5 | import com.android.template.compose.uistate.mappers.toErrorState
6 | import com.android.template.compose.uistate.models.ErrorState
7 | import com.android.template.utils.extenstions.viewmodel.launch
8 | import kotlinx.coroutines.Job
9 | import kotlinx.coroutines.channels.Channel
10 | import kotlinx.coroutines.flow.Flow
11 | import kotlinx.coroutines.flow.MutableStateFlow
12 | import kotlinx.coroutines.flow.StateFlow
13 | import kotlinx.coroutines.flow.asStateFlow
14 | import kotlinx.coroutines.flow.catch
15 | import kotlinx.coroutines.flow.flowOn
16 | import kotlinx.coroutines.flow.launchIn
17 | import kotlinx.coroutines.flow.onEach
18 | import kotlinx.coroutines.flow.onStart
19 | import kotlinx.coroutines.flow.receiveAsFlow
20 | import kotlinx.coroutines.flow.update
21 | import timber.log.Timber
22 | import kotlin.coroutines.CoroutineContext
23 | import kotlin.coroutines.EmptyCoroutineContext
24 |
25 | abstract class UiStateViewModel(initialUiState: UiState) : ViewModel() {
26 |
27 | private val _uiState = MutableStateFlow(initialUiState)
28 | val uiState: StateFlow
29 | get() = _uiState.asStateFlow()
30 |
31 | private val _error = MutableStateFlow(ErrorState())
32 | val error: StateFlow
33 | get() = _error.asStateFlow()
34 |
35 | private val _isLoading = MutableStateFlow(false)
36 | val isLoading: StateFlow
37 | get() = _isLoading.asStateFlow()
38 |
39 | private val _singleEvent = Channel(Channel.BUFFERED)
40 | val singleEvent: Flow
41 | get() = _singleEvent.receiveAsFlow()
42 |
43 | open fun getUiState(): UiState = _uiState.value
44 |
45 | open fun updateUiState(update: UiState.() -> UiState) {
46 | _uiState.update { it.update() }
47 | }
48 |
49 | open fun showError(throwable: Throwable) {
50 | _error.update { throwable.toErrorState() }
51 | }
52 |
53 | open fun hideError() {
54 | _error.update { ErrorState() }
55 | }
56 |
57 | open fun showLoading() {
58 | _isLoading.update { true }
59 | }
60 |
61 | open fun hideLoading() {
62 | _isLoading.update { false }
63 | }
64 |
65 | open fun sendEvent(event: Event) {
66 | launch { _singleEvent.send(event) }
67 | }
68 |
69 | fun launchSafe(
70 | context: CoroutineContext = EmptyCoroutineContext,
71 | onError: (Throwable) -> Unit = {},
72 | hasLoading: Boolean = false,
73 | block: suspend () -> Unit,
74 | ): Job {
75 | if (hasLoading) showLoading()
76 | return launch(context) {
77 | try {
78 | block()
79 | } catch (e: Throwable) {
80 | Timber.e(e)
81 | onError(e)
82 | }
83 | if (hasLoading) hideLoading()
84 | }
85 | }
86 |
87 | fun Flow.collectSafe(
88 | context: CoroutineContext = EmptyCoroutineContext,
89 | hasLoading: Boolean = false,
90 | onError: (Throwable) -> Unit = {},
91 | block: suspend (T) -> Unit,
92 | ): Job = flowOn(context)
93 | .onStart { if (hasLoading) showLoading() }
94 | .catch { e ->
95 | Timber.e(e)
96 | onError(e)
97 | if (hasLoading) hideLoading()
98 | }
99 | .onEach {
100 | block(it)
101 | if (hasLoading) hideLoading()
102 | }
103 | .launchIn(viewModelScope)
104 | }
--------------------------------------------------------------------------------
/app/src/test/java/com/android/template/features/taskdetail/TaskDetailViewModelTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.taskdetail
2 |
3 | import androidx.lifecycle.SavedStateHandle
4 | import androidx.navigation.toRoute
5 | import app.cash.turbine.test
6 | import com.android.template.compose.uistate.mappers.toErrorState
7 | import com.android.template.domain.models.errors.NoConnectionException
8 | import com.android.template.domain.models.tasks.Task
9 | import com.android.template.domain.usecases.tasks.GetTaskUseCase
10 | import com.android.template.features.taskdetail.models.TaskDetailDestination
11 | import com.android.template.features.taskdetail.models.TaskDetailUiState
12 | import com.android.template.providers.dispatchers.DispatcherProvider
13 | import com.android.template.utils.mockkSavedStateHandle
14 | import com.android.template.utils.unmockkSavedStateHandle
15 | import io.kotest.matchers.shouldBe
16 | import io.mockk.every
17 | import io.mockk.mockk
18 | import kotlinx.coroutines.Dispatchers
19 | import kotlinx.coroutines.ExperimentalCoroutinesApi
20 | import kotlinx.coroutines.flow.flow
21 | import kotlinx.coroutines.flow.flowOf
22 | import kotlinx.coroutines.test.StandardTestDispatcher
23 | import kotlinx.coroutines.test.advanceUntilIdle
24 | import kotlinx.coroutines.test.resetMain
25 | import kotlinx.coroutines.test.runTest
26 | import kotlinx.coroutines.test.setMain
27 | import org.junit.After
28 | import org.junit.Before
29 | import org.junit.Test
30 |
31 | @OptIn(ExperimentalCoroutinesApi::class)
32 | internal class TaskDetailViewModelTest {
33 | private val testDispatcher = StandardTestDispatcher()
34 |
35 | private val savedStateHandle: SavedStateHandle = mockk(relaxed = true)
36 | private val dispatcherProvider: DispatcherProvider = mockk()
37 | private val getTaskUseCase: GetTaskUseCase = mockk()
38 |
39 | private lateinit var taskDetailViewModel: TaskDetailViewModel
40 |
41 | @Before
42 | fun setUp() {
43 | Dispatchers.setMain(testDispatcher)
44 | mockkSavedStateHandle()
45 | every { dispatcherProvider.io } returns testDispatcher
46 | }
47 |
48 | @After
49 | fun tearDown() {
50 | Dispatchers.resetMain()
51 | unmockkSavedStateHandle()
52 | }
53 |
54 | @Test
55 | fun `getTask is success`() = runTest {
56 | // Given
57 | val task = Task(id = "1", content = "Task 1")
58 | every { getTaskUseCase("1") } returns flowOf(task)
59 | every {
60 | savedStateHandle.toRoute()
61 | } returns TaskDetailDestination(taskId = "1")
62 |
63 | // When
64 | taskDetailViewModel = createTaskDetailViewModel()
65 | advanceUntilIdle()
66 |
67 | // Then
68 | taskDetailViewModel.uiState.test {
69 | expectMostRecentItem() shouldBe TaskDetailUiState(task = task)
70 | }
71 | }
72 |
73 | @Test
74 | fun `getTask is fail`() = runTest {
75 | // Given
76 | val error = NoConnectionException()
77 | val errorState = error.toErrorState()
78 | every { getTaskUseCase("1") } returns flow { throw error }
79 | every {
80 | savedStateHandle.toRoute()
81 | } returns TaskDetailDestination(taskId = "1")
82 |
83 | // When
84 | taskDetailViewModel = createTaskDetailViewModel()
85 | advanceUntilIdle()
86 |
87 | // Then
88 | taskDetailViewModel.error.test {
89 | expectMostRecentItem() shouldBe errorState
90 | }
91 | }
92 |
93 | private fun createTaskDetailViewModel() = TaskDetailViewModel(
94 | savedStateHandle = savedStateHandle,
95 | dispatcherProvider = dispatcherProvider,
96 | getTaskUseCase = getTaskUseCase,
97 | )
98 | }
--------------------------------------------------------------------------------
/gradle/libs.versions.toml:
--------------------------------------------------------------------------------
1 | [versions]
2 | compileSdk = "34"
3 | minSdk = "28"
4 | targetSdk = "34"
5 | agp = "8.6.1"
6 | kotlin = "2.0.0"
7 | kotlinCoroutines = "1.8.1"
8 | kotlinSerialization = "1.7.2"
9 | kotlinxCollectionsImmutable = "0.3.8"
10 | coreKtx = "1.13.1"
11 | junit = "4.13.2"
12 | junitVersion = "1.2.1"
13 | espressoCore = "3.6.1"
14 | lifecycleRuntimeKtx = "2.8.6"
15 | activityCompose = "1.9.2"
16 | composeBom = "2024.09.03"
17 | navigationCompose = "2.8.2"
18 | hilt = "2.51.1"
19 | hiltNavigationCompose = "1.2.0"
20 | room = "2.6.1"
21 | retrofit = "2.11.0"
22 | gson = "2.10.1"
23 | securityCryptoDatastore = "1.0.0"
24 | mockk = "1.12.1"
25 | kotest = "5.0.0"
26 | turbine = "1.1.0"
27 | logging-interceptor = "4.12.0"
28 | timber = "5.0.1"
29 |
30 | [libraries]
31 | androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
32 | androidx-lifecycle-runtime-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" }
33 | androidx-lifecycle-viewmodel-compose = { group = "androidx.lifecycle", name = "lifecycle-viewmodel-compose", version.ref = "lifecycleRuntimeKtx" }
34 | androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" }
35 |
36 | androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" }
37 | androidx-ui = { group = "androidx.compose.ui", name = "ui" }
38 | androidx-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" }
39 | androidx-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling" }
40 | androidx-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" }
41 | androidx-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }
42 | androidx-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" }
43 | androidx-material3 = { group = "androidx.compose.material3", name = "material3" }
44 | androidx-navigation-compose = { group = "androidx.navigation", name = "navigation-compose", version.ref = "navigationCompose" }
45 |
46 | junit = { group = "junit", name = "junit", version.ref = "junit" }
47 | androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
48 | androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
49 |
50 | kotlinx-serialization-json = { group = "org.jetbrains.kotlinx", name = "kotlinx-serialization-json", version.ref = "kotlinSerialization" }
51 | kotlinx-collections-immutable = { group = "org.jetbrains.kotlinx", name = "kotlinx-collections-immutable", version.ref = "kotlinxCollectionsImmutable" }
52 | kotlinx-coroutines-android = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-android", version.ref = "kotlinCoroutines" }
53 | kotlinx-coroutines-test = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-test", version.ref = "kotlinCoroutines" }
54 |
55 | hilt-android = { group = "com.google.dagger", name = "hilt-android", version.ref = "hilt" }
56 | hilt-compiler = { group = "com.google.dagger", name = "hilt-compiler", version.ref = "hilt" }
57 | hilt-navigation-compose = { group = "androidx.hilt", name = "hilt-navigation-compose", version.ref = "hiltNavigationCompose" }
58 |
59 | room-runtime = { group = "androidx.room", name = "room-runtime", version.ref = "room" }
60 | room-compiler = { group = "androidx.room", name = "room-compiler", version.ref = "room" }
61 |
62 | retrofit = { group = "com.squareup.retrofit2", name = "retrofit", version.ref = "retrofit" }
63 | retrofit-converter-gson = { group = "com.squareup.retrofit2", name = "converter-gson", version.ref = "retrofit" }
64 | okhttp3-logging = { group = "com.squareup.okhttp3", name = "logging-interceptor", version.ref = "logging-interceptor" }
65 |
66 | gson = { group = "com.google.code.gson", name = "gson", version.ref = "gson" }
67 |
68 | security-crypto-datastore = { group = "io.github.osipxd", name = "security-crypto-datastore", version.ref = "securityCryptoDatastore" }
69 | security-crypto-datastore-preferences = { group = "io.github.osipxd", name = "security-crypto-datastore-preferences", version.ref = "securityCryptoDatastore" }
70 |
71 | mockk = { group = "io.mockk", name = "mockk", version.ref = "mockk" }
72 | kotest = { group = "io.kotest", name = "kotest-runner-junit5", version.ref = "kotest" }
73 | turbine = { group = "app.cash.turbine", name = "turbine", version.ref = "turbine" }
74 | timber = { group = "com.jakewharton.timber", name = "timber", version.ref = "timber" }
75 |
76 | [plugins]
77 | android-application = { id = "com.android.application", version.ref = "agp" }
78 | jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
79 | android-library = { id = "com.android.library", version.ref = "agp" }
80 | hilt-android = { id = "com.google.dagger.hilt.android", version.ref = "hilt" }
81 | kotlin-kapt = { id = "org.jetbrains.kotlin.kapt", version.ref = "kotlin" }
82 | kotlin-seriazation = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
83 | kotlin-compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
84 |
--------------------------------------------------------------------------------
/domain/src/test/java/com/android/template/domain/utils/NullSafetyExtensionsKtTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.domain.utils
2 |
3 | import io.kotest.matchers.shouldBe
4 | import org.junit.Test
5 |
6 | internal class NullSafetyExtensionsKtTest {
7 |
8 | @Test
9 | fun `Boolean orFalse returns default`() {
10 | // Given
11 | val nullableBoolean: Boolean? = null
12 |
13 | // When
14 | val result = nullableBoolean.orFalse()
15 |
16 | // Then
17 | result shouldBe false
18 | }
19 |
20 | @Test
21 | fun `Boolean orFalse returns value`() {
22 | // Given
23 | val nullableBoolean = true
24 |
25 | // When
26 | val result = nullableBoolean.orFalse()
27 |
28 | // Then
29 | result shouldBe true
30 | }
31 |
32 | @Test
33 | fun `Boolean orTrue returns default`() {
34 | // Given
35 | val nullableBoolean: Boolean? = null
36 |
37 | // When
38 | val result = nullableBoolean.orTrue()
39 |
40 | // Then
41 | result shouldBe true
42 | }
43 |
44 | @Test
45 | fun `Boolean orTrue returns value`() {
46 | // Given
47 | val nullableBoolean = false
48 |
49 | // When
50 | val result = nullableBoolean.orTrue()
51 |
52 | // Then
53 | result shouldBe false
54 | }
55 |
56 | @Test
57 | fun `String orEmpty returns default`() {
58 | // Given
59 | val nullableString: String? = null
60 |
61 | // When
62 | val result = nullableString.orEmpty()
63 |
64 | // Then
65 | result shouldBe ""
66 | }
67 |
68 | @Test
69 | fun `String orEmpty returns value`() {
70 | // Given
71 | val nullableString = "Hello"
72 |
73 | // When
74 | val result = nullableString.orEmpty()
75 |
76 | // Then
77 | result shouldBe "Hello"
78 | }
79 |
80 | @Test
81 | fun `Int orZero returns default`() {
82 | // Given
83 | val nullableInt: Int? = null
84 |
85 | // When
86 | val result = nullableInt.orZero()
87 |
88 | // Then
89 | result shouldBe 0
90 | }
91 |
92 | @Test
93 | fun `Int orZero returns value`() {
94 | // Given
95 | val nullableInt = 10
96 |
97 | // When
98 | val result = nullableInt.orZero()
99 |
100 | // Then
101 | result shouldBe 10
102 | }
103 |
104 | @Test
105 | fun `Long orZero returns default`() {
106 | // Given
107 | val nullableLong: Long? = null
108 |
109 | // When
110 | val result = nullableLong.orZero()
111 |
112 | // Then
113 | result shouldBe 0L
114 | }
115 |
116 | @Test
117 | fun `Long orZero returns value`() {
118 | // Given
119 | val nullableLong = 10L
120 |
121 | // When
122 | val result = nullableLong.orZero()
123 |
124 | // Then
125 | result shouldBe 10L
126 | }
127 |
128 | @Test
129 | fun `Float orZero returns default`() {
130 | // Given
131 | val nullableFloat: Float? = null
132 |
133 | // When
134 | val result = nullableFloat.orZero()
135 |
136 | // Then
137 | result shouldBe 0f
138 | }
139 |
140 | @Test
141 | fun `Float orZero returns value`() {
142 | // Given
143 | val nullableFloat = 10f
144 |
145 | // When
146 | val result = nullableFloat.orZero()
147 |
148 | // Then
149 | result shouldBe 10f
150 | }
151 |
152 | @Test
153 | fun `Double orZero returns default`() {
154 | // Given
155 | val nullableDouble: Double? = null
156 |
157 | // When
158 | val result = nullableDouble.orZero()
159 |
160 | // Then
161 | result shouldBe 0.0
162 | }
163 |
164 | @Test
165 | fun `Double orZero returns value`() {
166 | // Given
167 | val nullableDouble = 10.0
168 |
169 | // When
170 | val result = nullableDouble.orZero()
171 |
172 | // Then
173 | result shouldBe 10.0
174 | }
175 |
176 | @Test
177 | fun `List orEmpty returns default`() {
178 | // Given
179 | val nullableList: List? = null
180 |
181 | // When
182 | val result = nullableList.orEmpty()
183 |
184 | // Then
185 | result shouldBe emptyList()
186 | }
187 |
188 | @Test
189 | fun `List orEmpty returns value`() {
190 | // Given
191 | val nullableList = listOf("Hello")
192 |
193 | // When
194 | val result = nullableList.orEmpty()
195 |
196 | // Then
197 | result shouldBe listOf("Hello")
198 | }
199 |
200 | @Test
201 | fun `Map orEmpty returns default`() {
202 | // Given
203 | val nullableMap: Map? = null
204 |
205 | // When
206 | val result = nullableMap.orEmpty()
207 |
208 | // Then
209 | result shouldBe emptyMap()
210 | }
211 |
212 | @Test
213 | fun `Map orEmpty returns value`() {
214 | // Given
215 | val nullableMap = mapOf("key" to "value")
216 |
217 | // When
218 | val result = nullableMap.orEmpty()
219 |
220 | // Then
221 | result shouldBe mapOf("key" to "value")
222 | }
223 | }
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
10 |
15 |
20 |
25 |
30 |
35 |
40 |
45 |
50 |
55 |
60 |
65 |
70 |
75 |
80 |
85 |
90 |
95 |
100 |
105 |
110 |
115 |
120 |
125 |
130 |
135 |
140 |
145 |
150 |
155 |
160 |
165 |
170 |
171 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | #
4 | # Copyright 2015 the original author or authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 |
19 | ##############################################################################
20 | ##
21 | ## Gradle start up script for UN*X
22 | ##
23 | ##############################################################################
24 |
25 | # Attempt to set APP_HOME
26 | # Resolve links: $0 may be a link
27 | PRG="$0"
28 | # Need this for relative symlinks.
29 | while [ -h "$PRG" ] ; do
30 | ls=`ls -ld "$PRG"`
31 | link=`expr "$ls" : '.*-> \(.*\)$'`
32 | if expr "$link" : '/.*' > /dev/null; then
33 | PRG="$link"
34 | else
35 | PRG=`dirname "$PRG"`"/$link"
36 | fi
37 | done
38 | SAVED="`pwd`"
39 | cd "`dirname \"$PRG\"`/" >/dev/null
40 | APP_HOME="`pwd -P`"
41 | cd "$SAVED" >/dev/null
42 |
43 | APP_NAME="Gradle"
44 | APP_BASE_NAME=`basename "$0"`
45 |
46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48 |
49 | # Use the maximum available, or set MAX_FD != -1 to use that value.
50 | MAX_FD="maximum"
51 |
52 | warn () {
53 | echo "$*"
54 | }
55 |
56 | die () {
57 | echo
58 | echo "$*"
59 | echo
60 | exit 1
61 | }
62 |
63 | # OS specific support (must be 'true' or 'false').
64 | cygwin=false
65 | msys=false
66 | darwin=false
67 | nonstop=false
68 | case "`uname`" in
69 | CYGWIN* )
70 | cygwin=true
71 | ;;
72 | Darwin* )
73 | darwin=true
74 | ;;
75 | MINGW* )
76 | msys=true
77 | ;;
78 | NONSTOP* )
79 | nonstop=true
80 | ;;
81 | esac
82 |
83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84 |
85 |
86 | # Determine the Java command to use to start the JVM.
87 | if [ -n "$JAVA_HOME" ] ; then
88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
89 | # IBM's JDK on AIX uses strange locations for the executables
90 | JAVACMD="$JAVA_HOME/jre/sh/java"
91 | else
92 | JAVACMD="$JAVA_HOME/bin/java"
93 | fi
94 | if [ ! -x "$JAVACMD" ] ; then
95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
96 |
97 | Please set the JAVA_HOME variable in your environment to match the
98 | location of your Java installation."
99 | fi
100 | else
101 | JAVACMD="java"
102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
103 |
104 | Please set the JAVA_HOME variable in your environment to match the
105 | location of your Java installation."
106 | fi
107 |
108 | # Increase the maximum file descriptors if we can.
109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
110 | MAX_FD_LIMIT=`ulimit -H -n`
111 | if [ $? -eq 0 ] ; then
112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
113 | MAX_FD="$MAX_FD_LIMIT"
114 | fi
115 | ulimit -n $MAX_FD
116 | if [ $? -ne 0 ] ; then
117 | warn "Could not set maximum file descriptor limit: $MAX_FD"
118 | fi
119 | else
120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
121 | fi
122 | fi
123 |
124 | # For Darwin, add options to specify how the application appears in the dock
125 | if $darwin; then
126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
127 | fi
128 |
129 | # For Cygwin or MSYS, switch paths to Windows format before running java
130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
133 |
134 | JAVACMD=`cygpath --unix "$JAVACMD"`
135 |
136 | # We build the pattern for arguments to be converted via cygpath
137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
138 | SEP=""
139 | for dir in $ROOTDIRSRAW ; do
140 | ROOTDIRS="$ROOTDIRS$SEP$dir"
141 | SEP="|"
142 | done
143 | OURCYGPATTERN="(^($ROOTDIRS))"
144 | # Add a user-defined pattern to the cygpath arguments
145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
147 | fi
148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
149 | i=0
150 | for arg in "$@" ; do
151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
153 |
154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
156 | else
157 | eval `echo args$i`="\"$arg\""
158 | fi
159 | i=`expr $i + 1`
160 | done
161 | case $i in
162 | 0) set -- ;;
163 | 1) set -- "$args0" ;;
164 | 2) set -- "$args0" "$args1" ;;
165 | 3) set -- "$args0" "$args1" "$args2" ;;
166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;;
167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
172 | esac
173 | fi
174 |
175 | # Escape application args
176 | save () {
177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
178 | echo " "
179 | }
180 | APP_ARGS=`save "$@"`
181 |
182 | # Collect all arguments for the java command, following the shell quoting and substitution rules
183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
184 |
185 | exec "$JAVACMD" "$@"
186 |
--------------------------------------------------------------------------------
/app/src/test/java/com/android/template/features/tasks/TaskListViewModelTest.kt:
--------------------------------------------------------------------------------
1 | package com.android.template.features.tasks
2 |
3 | import app.cash.turbine.test
4 | import com.android.template.compose.uistate.mappers.toErrorState
5 | import com.android.template.domain.models.errors.NoConnectionException
6 | import com.android.template.domain.models.tasks.Task
7 | import com.android.template.domain.usecases.preferences.IsFirstRunUseCase
8 | import com.android.template.domain.usecases.preferences.SetFirstRunUseCase
9 | import com.android.template.domain.usecases.tasks.CreateTaskUseCase
10 | import com.android.template.domain.usecases.tasks.GetTaskListUseCase
11 | import com.android.template.features.tasks.models.TaskListEvent
12 | import com.android.template.features.tasks.models.TaskListUiState
13 | import com.android.template.providers.dispatchers.DispatcherProvider
14 | import io.kotest.matchers.shouldBe
15 | import io.mockk.coEvery
16 | import io.mockk.every
17 | import io.mockk.mockk
18 | import kotlinx.coroutines.Dispatchers
19 | import kotlinx.coroutines.ExperimentalCoroutinesApi
20 | import kotlinx.coroutines.flow.flow
21 | import kotlinx.coroutines.flow.flowOf
22 | import kotlinx.coroutines.test.StandardTestDispatcher
23 | import kotlinx.coroutines.test.advanceUntilIdle
24 | import kotlinx.coroutines.test.resetMain
25 | import kotlinx.coroutines.test.runTest
26 | import kotlinx.coroutines.test.setMain
27 | import org.junit.After
28 | import org.junit.Before
29 | import org.junit.Test
30 |
31 | @OptIn(ExperimentalCoroutinesApi::class)
32 | internal class TaskListViewModelTest {
33 |
34 | private val testDispatcher = StandardTestDispatcher()
35 |
36 | private val dispatcherProvider: DispatcherProvider = mockk()
37 | private val createTaskUseCase: CreateTaskUseCase = mockk()
38 | private val getTaskListUseCase: GetTaskListUseCase = mockk()
39 | private val isFirstRunUseCase: IsFirstRunUseCase = mockk()
40 | private val setFirstRunUseCase: SetFirstRunUseCase = mockk()
41 |
42 | private lateinit var taskListViewModel: TaskListViewModel
43 |
44 | @Before
45 | fun setUp() {
46 | Dispatchers.setMain(testDispatcher)
47 | every { dispatcherProvider.io } returns testDispatcher
48 | }
49 |
50 | @After
51 | fun tearDown() {
52 | Dispatchers.resetMain()
53 | }
54 |
55 | @Test
56 | fun `getTaskList is success`() = runTest {
57 | // Given
58 | val tasks = giveTaskList()
59 |
60 | // When
61 | taskListViewModel = createTaskListViewModel()
62 | advanceUntilIdle()
63 |
64 | // Then
65 | taskListViewModel.uiState.test {
66 | expectMostRecentItem() shouldBe TaskListUiState(tasks = tasks)
67 | }
68 | }
69 |
70 | @Test
71 | fun `getTaskList is fail`() = runTest {
72 | // Given
73 | val error = NoConnectionException()
74 | val errorState = error.toErrorState()
75 | every { getTaskListUseCase() } returns flow { throw error }
76 |
77 | // When
78 | taskListViewModel = createTaskListViewModel()
79 | advanceUntilIdle()
80 |
81 | // Then
82 | taskListViewModel.error.test {
83 | expectMostRecentItem() shouldBe errorState
84 | }
85 | }
86 |
87 | @Test
88 | fun `createTask is success`() = runTest {
89 | // Given
90 | val tasks = giveTaskList()
91 |
92 | val newTask = Task()
93 | coEvery { createTaskUseCase(newTask) } returns newTask
94 |
95 | // When
96 | taskListViewModel = createTaskListViewModel()
97 | advanceUntilIdle()
98 |
99 | taskListViewModel.createTask()
100 | advanceUntilIdle()
101 |
102 | // Then
103 | taskListViewModel.uiState.test {
104 | expectMostRecentItem() shouldBe TaskListUiState(tasks = tasks + newTask)
105 | }
106 | }
107 |
108 | @Test
109 | fun `createTask is fail`() = runTest {
110 | // Given
111 | val tasks = giveTaskList()
112 |
113 | val error = NoConnectionException()
114 | val errorState = error.toErrorState()
115 | val newTask = Task()
116 | coEvery { createTaskUseCase(newTask) } throws error
117 |
118 | // When
119 | taskListViewModel = createTaskListViewModel()
120 | advanceUntilIdle()
121 |
122 | taskListViewModel.createTask()
123 | advanceUntilIdle()
124 |
125 | // Then
126 | taskListViewModel.uiState.test {
127 | expectMostRecentItem() shouldBe TaskListUiState(tasks = tasks)
128 | }
129 | taskListViewModel.error.test {
130 | expectMostRecentItem() shouldBe errorState
131 | }
132 | }
133 |
134 | @Test
135 | fun `isFirstRun is true`() = runTest {
136 | // Given
137 | giveTaskList()
138 |
139 | val expected = true
140 | every { isFirstRunUseCase() } returns flowOf(expected)
141 | coEvery { setFirstRunUseCase(false) } returns Unit
142 |
143 | // When
144 | taskListViewModel = createTaskListViewModel()
145 | advanceUntilIdle()
146 |
147 | // Then
148 | taskListViewModel.singleEvent.test {
149 | expectMostRecentItem() shouldBe TaskListEvent.FirstRun
150 | }
151 | }
152 |
153 | @Test
154 | fun `isFirstRun is false`() = runTest {
155 | // Given
156 | giveTaskList()
157 |
158 | val expected = false
159 | every { isFirstRunUseCase() } returns flowOf(expected)
160 |
161 | // When
162 | taskListViewModel = createTaskListViewModel()
163 | advanceUntilIdle()
164 |
165 | // Then
166 | taskListViewModel.singleEvent.test {
167 | expectNoEvents()
168 | }
169 | }
170 |
171 | @Test
172 | fun `openTaskDetail calls`() = runTest {
173 | // Given
174 | val tasks = giveTaskList()
175 |
176 | // When
177 | taskListViewModel = createTaskListViewModel()
178 | advanceUntilIdle()
179 |
180 | taskListViewModel.openTaskDetail(tasks.first())
181 | advanceUntilIdle()
182 |
183 | // Then
184 | taskListViewModel.singleEvent.test {
185 | expectMostRecentItem() shouldBe TaskListEvent.OpenTaskDetail(taskId = tasks.first().id)
186 | }
187 | }
188 |
189 | private fun giveTaskList(): List {
190 | val tasks = listOf(Task(id = "1", content = "Task 1"), Task(id = "2", content = "Task 2"))
191 | every { getTaskListUseCase() } returns flowOf(tasks)
192 | return tasks
193 | }
194 |
195 | private fun createTaskListViewModel() = TaskListViewModel(
196 | dispatcherProvider = dispatcherProvider,
197 | createTaskUseCase = createTaskUseCase,
198 | getTaskListUseCase = getTaskListUseCase,
199 | setFirstRunUseCase = setFirstRunUseCase,
200 | isFirstRunUseCase = isFirstRunUseCase,
201 | )
202 | }
--------------------------------------------------------------------------------