Improve OSS licenses screen

[fumiya-kume]

Issue

• close [Android] Add title for the license screen #938

Overview (Required)

• Add OssLicenseScreen to list up the libraries
• Add OssLicenseDetailScreen to show the license contents
• Parsing the generated contents from the Google's licenses plugin.

TODO

• Replace Screen title handling
• Remove Licenses position from the domain model
• Refactoring library grouping logic
• Align naming rule for the license/library
• Add implementation for navigation up
• Improve Card expand state handling
• Support Large screen devices

Links

Screenshot (Optional if screenshot test is present or unrelated to UI)

Before	After

Movie (Optional)

Before	After
	licensescreen.mp4

[github-actions]

Test Results

218 tests   218 ✔️  8m 39s ⏱️
  13 suites      0 💤
  13 files        0 ❌

Results for commit ecd9b9f.

♻️ This comment has been updated with latest results.

[takahirom]

Could you put sources to appropriate modules?
I think
UI will be feature/about,
Repository's implementation and api will be core/data,
This(License) will be core/model.

[fumiya-kume]

That's make sense.

OssLicenseRepositoryImpl is still in the app module since limitation of Google's license plugin.
Except that, placing to appropriate modules. 🙇

[takahirom]

We are using Default〜 prefix for the concrete class 🙏

[takahirom]

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
    }
}

[github-actions]

Hi @fumiya-kume! Codes seem to be unformatted. To resolve this issue, please run ./gradlew detekt --auto-correct and fix the results of ./gradlew lintDebug.. Thank you for your contribution.

[takahirom]

Could you add a screenshot test for this screen? This is because all other screens have one, and this PR causes our test coverage to shrink. 🙇

[github-actions]

Snapshot diff report

File name	Image
OssLicenseDetailScre enTest.checkLaunchSh ot_compare.png
OssLicenseScreenTest .checkLaunchShot_com pare.png

[takahirom]

What problem are you experiencing with compareRoborazziDevDebug? 👀