Improve OSS licenses screen #1018
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| package io.github.droidkaigi.confsched2023.license | ||
|
|
||
| import android.content.Context | ||
| import io.github.droidkaigi.confsched2023.R.raw | ||
| import io.github.droidkaigi.confsched2023.model.License | ||
| import io.github.droidkaigi.confsched2023.model.OssLicenseRepository | ||
| import kotlinx.collections.immutable.PersistentList | ||
| import kotlinx.collections.immutable.persistentListOf | ||
| import kotlinx.collections.immutable.toPersistentList | ||
| import kotlinx.coroutines.flow.Flow | ||
| import kotlinx.coroutines.flow.MutableStateFlow | ||
| import okio.BufferedSource | ||
| import okio.buffer | ||
| import okio.source | ||
| import javax.inject.Inject | ||
|
|
||
| class OssLicenseRepositoryImpl @Inject constructor( | ||
|
There was a problem hiding this comment. How about moving the logic to DefaultOssLicenseDataSource to simplify the app's implementation? I think this is similar to an API, since both handle data parsing. Therefore, I suggest transferring the code to DefaultOssLicenseDataSource. class DefaultOssLicenseDataSource @Inject constructor(
private val context: Context,
) : OssLicenseDataSource {
override suspend fun licenseFlow(): OssLicense {
return withContext(context = Dispatchers.IO) {
val details = readLicensesFile().toRowList()
val metadata = readLicensesMetaFile().toRowList().parseToLibraryItem(
details = details,
)
val groupList = metadata.distinctBy { it.name }.groupByCategory()
.map {
OssLicenseGroup(
title = it.key,
licenses = it.value,
)
}.toPersistentList()
OssLicense(groupList)
}
}
private fun List<License>.groupByCategory(): Map<String, List<License>> {
val categoryList = listOf(
"Android Support",
"Android Datastore",
"Android ",
"Compose UI",
"Compose Material3",
"Compose ",
"AndroidX lifecycle",
"AndroidX ",
"Kotlin",
"Dagger",
"Firebase",
"Ktorfit",
"okhttp",
"ktor",
)
return groupBy { license ->
categoryList.firstOrNull {
license.name.startsWith(
prefix = it,
ignoreCase = true,
)
} ?: "etc"
}
}
private fun readLicensesMetaFile(): BufferedSource {
return context.resources.openRawResource(raw.third_party_license_metadata)
.source()
.buffer()
}
private fun readLicensesFile(): BufferedSource {
return context.resources.openRawResource(raw.third_party_licenses)
.source()
.buffer()
}
private fun List<String>.parseToLibraryItem(details: List<String>): List<License> {
return mapIndexed { index, value ->
val (position, name) = value.split(' ', limit = 2)
val (offset, length) = position.split(':').map { it.toInt() }
val id = name.replace(' ', '-')
License(
name = name,
id = id,
offset = offset,
length = length,
detail = details[index],
)
}
}
private fun BufferedSource.toRowList(): List<String> {
val list: MutableList<String> = mutableListOf()
while (true) {
val line = readUtf8Line() ?: break
list.add(line)
}
return list
}
} |
||
| private val context: Context, | ||
| ) : OssLicenseRepository { | ||
|
|
||
| private val licenseMetaStateFlow = | ||
| MutableStateFlow<PersistentList<License>>(persistentListOf()) | ||
|
|
||
| private val licenseDetailStateFlow = MutableStateFlow<List<String>>(emptyList()) | ||
|
|
||
| override fun licenseMetaData(): Flow<PersistentList<License>> { | ||
| licenseMetaStateFlow.value = readLicensesMetaFile() | ||
| .toRowList() | ||
| .parseToLibraryItem() | ||
| .toPersistentList() | ||
| return licenseMetaStateFlow | ||
| } | ||
|
|
||
| override fun licenseDetailData(): Flow<List<String>> { | ||
| licenseDetailStateFlow.value = readLicensesFile() | ||
| .toRowList() | ||
| return licenseDetailStateFlow | ||
| } | ||
|
|
||
| private fun readLicensesMetaFile(): BufferedSource { | ||
| return context.resources.openRawResource(raw.third_party_license_metadata) | ||
| .source() | ||
| .buffer() | ||
| } | ||
|
|
||
| private fun readLicensesFile(): BufferedSource { | ||
| return context.resources.openRawResource(raw.third_party_licenses) | ||
| .source() | ||
| .buffer() | ||
| } | ||
|
|
||
| private fun List<String>.parseToLibraryItem(): List<License> { | ||
| return map { | ||
| val (position, name) = it.split(' ', limit = 2) | ||
| val (offset, length) = position.split(':').map { it.toInt() } | ||
| val id = name.replace(' ', '-') | ||
| License(id = id, name = name, offset = offset, length = length) | ||
| } | ||
| } | ||
|
|
||
| private fun BufferedSource.toRowList(): List<String> { | ||
| val list: MutableList<String> = mutableListOf() | ||
| while (true) { | ||
| val line = readUtf8Line() ?: break | ||
| list.add(line) | ||
| } | ||
| return list | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package io.github.droidkaigi.confsched2023.model | ||
|
|
||
| import kotlinx.collections.immutable.PersistentList | ||
| import kotlinx.collections.immutable.persistentListOf | ||
|
|
||
| data class License( | ||
| val id: String, | ||
| val name: String, | ||
| val offset: Int, | ||
| val length: Int, | ||
| val detail: String = "", | ||
| ) | ||
|
|
||
| data class OssLicenseGroup( | ||
| val title: String, | ||
| val licenses: List<License>, | ||
| val expand: Boolean = false, | ||
| ) | ||
|
|
||
| data class OssLicense( | ||
| val groupList: PersistentList<OssLicenseGroup> = persistentListOf(), | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| package io.github.droidkaigi.confsched2023.model | ||
|
|
||
| import kotlinx.collections.immutable.PersistentList | ||
| import kotlinx.coroutines.flow.Flow | ||
|
|
||
| public interface OssLicenseRepository { | ||
| public fun licenseMetaData(): Flow<PersistentList<License>> | ||
|
|
||
| public fun licenseDetailData(): Flow<List<String>> | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package io.github.droidkaigi.confsched2023.about | ||
|
|
||
| import androidx.compose.foundation.layout.Box | ||
| import androidx.compose.foundation.layout.Column | ||
| import androidx.compose.foundation.layout.padding | ||
| import androidx.compose.foundation.rememberScrollState | ||
| import androidx.compose.foundation.verticalScroll | ||
| import androidx.compose.material.icons.Icons | ||
| import androidx.compose.material.icons.filled.ArrowBack | ||
| import androidx.compose.material3.ExperimentalMaterial3Api | ||
| import androidx.compose.material3.Icon | ||
| import androidx.compose.material3.IconButton | ||
| import androidx.compose.material3.MaterialTheme | ||
| import androidx.compose.material3.Scaffold | ||
| import androidx.compose.material3.Text | ||
| import androidx.compose.material3.TopAppBar | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.collectAsState | ||
| import androidx.compose.runtime.getValue | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.unit.dp | ||
| import androidx.hilt.navigation.compose.hiltViewModel | ||
| import androidx.navigation.NavController | ||
| import androidx.navigation.NavGraphBuilder | ||
| import androidx.navigation.compose.composable | ||
| import io.github.droidkaigi.confsched2023.model.License | ||
|
|
||
| const val ossLicenseDetailScreenRouteNameArgument = "name" | ||
| const val ossLicenseDetailScreenRoute = "osslicense" | ||
| fun NavGraphBuilder.ossLicenseDetailScreen(onUpClick: () -> Unit) { | ||
| composable("$ossLicenseDetailScreenRoute/{$ossLicenseDetailScreenRouteNameArgument}") { | ||
| OssLicenseDetailScreen( | ||
| onUpClick = onUpClick, | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| fun NavController.navigateOssLicenseDetailScreen( | ||
| license: License, | ||
| ) { | ||
| navigate("$ossLicenseDetailScreenRoute/${license.id}") | ||
| } | ||
|
|
||
| data class OssLicenseDetailScreenUiState( | ||
| val ossLicense: License? = null, | ||
| ) | ||
|
|
||
| @OptIn(ExperimentalMaterial3Api::class) | ||
| @Composable | ||
| fun OssLicenseDetailScreen( | ||
| modifier: Modifier = Modifier, | ||
| viewModel: OssLicenseDetailViewModel = hiltViewModel<OssLicenseDetailViewModel>(), | ||
| onUpClick: () -> Unit, | ||
| ) { | ||
| val uiState by viewModel.uiState.collectAsState() | ||
|
|
||
| Scaffold( | ||
| modifier = modifier, | ||
| topBar = { | ||
| TopAppBar( | ||
| title = { | ||
| Text(text = "OSS ライセンス") | ||
| }, | ||
| navigationIcon = { | ||
| IconButton(onClick = { onUpClick() }) { | ||
| Icon( | ||
| imageVector = Icons.Default.ArrowBack, | ||
| contentDescription = "back button", | ||
| ) | ||
| } | ||
| }, | ||
| ) | ||
| }, | ||
| ) { paddingValues -> | ||
| Box(modifier = Modifier.padding(paddingValues)) { | ||
| Column( | ||
| modifier = Modifier | ||
| .verticalScroll(rememberScrollState()) | ||
| .padding(horizontal = 8.dp), | ||
| ) { | ||
| uiState.ossLicense?.run { | ||
| Text( | ||
| text = this.detail, | ||
| style = MaterialTheme.typography.bodyMedium, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are using Default〜 prefix for the concrete class 🙏