내 프로젝트와 Now in Android의 버전 카탈로그 속 프로퍼티명 맞추기

#1 개요

#1-1 WhatㆍWhy

Now in Android  |  Android Developers

Now in Android는 Android 설계 및 개발 권장사항대로 만든 '공식적인 샘플' 앱이다 (소스 코드). 개인 프로젝트를 진행하던 중, 내 프로젝트의 버전 카탈로그 속 프로퍼티명과 Now in Android의 버전 카탈로그 속 프로퍼티명이 다른 경우를 확인했다. 나는 Now in Android의 스타일을 따라갈 것이므로, 프로퍼티명까지 똑같이 맞추면 좋겠다는 생각이 들었다. 그래서 이러한 '불일치'를 출력하는 검증용 코틀린 스크립트를 만들었다.

 

#1-2 tomlj 라이브러리

GitHub - tomlj/tomlj: A Java parser for Tom's Obvious, Minimal Language (TOML).

"tomlj"는 Java(와 Kotlin)에서 사용할 수 있는 TOML 파일 파싱용 라이브러리다. 버전 카탈로그는 TOML 확장자다. 그래서 이 라이브러리가 필요하다 (참고: Maven Repository의 tomlj 라이브러리 페이지).

 

#2 코드

#2-1 스크립트

import org.tomlj.Toml
import org.tomlj.TomlTable
import java.nio.file.Paths

data class TomlElement(
    val propertyName: String,
    val group: String?,
    val name: String?,
    val module: String?,
    val id: String?,
    val versionRef: String?
) {
    val identifier: String? = if (group != null && name != null) {
        "$group:$name"
    } else {
        module ?: id
    }

    fun isStrictlyEqualTo(other: TomlElement): Boolean {
        return propertyName == other.propertyName
                && group == other.group
                && name == other.name
                && module == other.module
                && id == other.id
                && versionRef == other.versionRef
    }

    fun makeTomlLine(): String {
        var tomlLine = "$propertyName = { "
        group?.let { tomlLine += "group = \"${it}\", " }
        name?.let { tomlLine += "name = \"${it}\", " }
        module?.let { tomlLine += "module = \"${it}\", " }
        id?.let { tomlLine += "id = \"${it}\", " }
        versionRef?.let { tomlLine += "version.ref = \"${it}\", " }
        tomlLine = tomlLine.removeSuffix(", ") + " }"

        return tomlLine
    }
}

const val MY_PROJECT_VERSION_CATALOG_PATH = "C:\\prj\\AndroidStudioProjects\\my-project-example\\gradle\\libs.versions.toml"
const val NIA_VERSION_CATALOG_PATH = "C:\\prj\\AndroidStudioProjects\\nowinandroid\\gradle\\libs.versions.toml"

fun main() {
    val myList = getTomlElementList(
        versionCatalogPath = MY_PROJECT_VERSION_CATALOG_PATH
    )?.filter { it.identifier != null }

    val niaList = getTomlElementList(
        versionCatalogPath = NIA_VERSION_CATALOG_PATH
    )?.filter { it.identifier != null }

    var result = ""

    myList?.forEach { myElement ->
        val niaElement = niaList?.find { niaElement ->
            (myElement.identifier == niaElement.identifier) and
                    !myElement.isStrictlyEqualTo(niaElement)
        }

        if (niaElement != null) {
            val tomlLine1 = myElement.makeTomlLine()
            val tomlLine2 = niaElement.makeTomlLine()
            result += " [My] $tomlLine1\n[Nia] $tomlLine2\n\n"
        }
    }

    println(result)
}

fun getTomlElementList(versionCatalogPath: String): List<TomlElement>? {
    val tomlPath = Paths.get(versionCatalogPath)
    val toml = Toml.parse(tomlPath)

    val librariesMap = toml.getTable("libraries")?.toMap() ?: emptyMap()
    val pluginsMap = toml.getTable("plugins")?.toMap() ?: emptyMap()
    val list = (librariesMap + pluginsMap).mapNotNull { (key, value) ->
        val isValueTomlTableType = value is TomlTable // TomlTable 형으로 형변환이 가능한가?
        if (!isValueTomlTableType) {
            return@mapNotNull null
        }

        val group = value.getString("group")
        val name = value.getString("name")
        val module = value.getString("module")
        val id = value.getString("id")
        val versionRef = value.getString("version.ref")

        TomlElement(
            propertyName = key,
            group = group,
            name = name,
            module = module,
            id = id,
            versionRef = versionRef
        )
    }

    return list
}

먼저 build.gradle의 dependencies에 implementation("org.tomlj:tomlj:1.1.0")와 같은 구문을 추가해주어야, import문을 인식해서 위의 코드가 작동한다. 아무튼 MY_PROJECT_VERSION_CATALOG_PATH에 내 프로젝트의 버전 카탈로그 파일 경로를, NIA_VERSION_CATALOG_PATH에 Now in Android 프로젝트의 파일 경로를 적고 실행시키면 된다.

 

"libraries" 테이블의 프로퍼티명(key값)이 다른 경우 뿐만 아니라, version.ref 에 할당된 문자열이 다른 경우도 감지하게했다. 이 경우는, version.ref 에 할당되는 "versions" 테이블의 프로퍼티명(key값)을 (Now in Android와 똑같게) 수정하기 위함이다.  또 한 쪽에선 라이브러리의 이름을 "group" 및 "name"에 나눠담았는데 다른 쪽에선 "module"에 통째로 담은 경우 그리고 그 반대의 경우도 감지하게 만들었다.

 

#2-2 실행 결과 

 [My] androidx-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" }
[Nia] androidx-compose-ui-test = { group = "androidx.compose.ui", name = "ui-test-junit4" }

 [My] androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
[Nia] androidx-test-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "androidxEspresso" }

 [My] hilt-android = { module = "com.google.dagger:hilt-android", version.ref = "hiltVersion" }
[Nia] hilt-android = { group = "com.google.dagger", name = "hilt-android", version.ref = "hilt" }

 [My] androidx-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" }
[Nia] androidx-compose-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" }

 [My] androidx-material-icons-extended = { module = "androidx.compose.material:material-icons-extended", version.ref = "materialIconsExtended" }
[Nia] androidx-compose-material-iconsExtended = { group = "androidx.compose.material", name = "material-icons-extended" }

 [My] androidx-lifecycle-viewmodel-compose = { module = "androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "lifecycleRuntimeKtx" }
[Nia] androidx-lifecycle-viewModelCompose = { group = "androidx.lifecycle", name = "lifecycle-viewmodel-compose", version.ref = "androidxLifecycle" }

 [My] androidx-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }
[Nia] androidx-compose-ui-testManifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }

 [My] androidx-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling" }
[Nia] androidx-compose-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling" }

 [My] androidx-room-runtime = { module = "androidx.room:room-runtime", version.ref = "roomRuntime" }
[Nia] room-runtime = { group = "androidx.room", name = "room-runtime", version.ref = "room" }

 [My] truth = { module = "com.google.truth:truth", version.ref = "truthVersion" }
[Nia] truth = { group = "com.google.truth", name = "truth", version.ref = "truth" }

 [My] androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" }
[Nia] androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "androidxActivity" }

 [My] androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
[Nia] androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "androidxCore" }

 [My] androidx-room-ktx = { module = "androidx.room:room-ktx", version.ref = "roomRuntime" }
[Nia] room-ktx = { group = "androidx.room", name = "room-ktx", version.ref = "room" }

 [My] androidx-appcompat = { group = "androidx.appcompat", name = "appcompat", version.ref = "appcompat" }
[Nia] androidx-appcompat = { group = "androidx.appcompat", name = "appcompat", version.ref = "androidxAppCompat" }

 [My] androidx-navigation-compose = { module = "androidx.navigation:navigation-compose", version.ref = "navigationRuntimeKtx" }
[Nia] androidx-navigation-compose = { group = "androidx.navigation", name = "navigation-compose", version.ref = "androidxNavigation" }

 [My] androidx-room-compiler = { module = "androidx.room:room-compiler", version.ref = "roomRuntime" }
[Nia] room-compiler = { group = "androidx.room", name = "room-compiler", version.ref = "room" }

 [My] androidx-ui-util = { group = "androidx.compose.ui", name = "ui-util" }
[Nia] androidx-compose-ui-util = { group = "androidx.compose.ui", name = "ui-util" }

 [My] androidx-material3 = { group = "androidx.compose.material3", name = "material3" }
[Nia] androidx-compose-material3 = { group = "androidx.compose.material3", name = "material3" }

 [My] androidx-hilt-navigation-compose = { module = "androidx.hilt:hilt-navigation-compose", version.ref = "hiltNavigationCompose" }
[Nia] androidx-hilt-navigation-compose = { group = "androidx.hilt", name = "hilt-navigation-compose", version.ref = "androidxHiltNavigationCompose" }

 [My] android-library = { id = "com.android.library", version.ref = "agp" }
[Nia] android-library = { id = "com.android.library", version.ref = "androidGradlePlugin" }

 [My] kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
[Nia] compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }

 [My] android-application = { id = "com.android.application", version.ref = "agp" }
[Nia] android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }

 [My] hilt = { id = "com.google.dagger.hilt.android", version.ref = "hiltVersion" }
[Nia] hilt = { id = "com.google.dagger.hilt.android", version.ref = "hilt" }

출력된 내용을 바탕으로 내 프로젝트의 프로퍼티명들을 수정했다. 수정 후 다시 스크립트를 실행시켜봤는데, 당연하겠지만 (다른 점이 없을테니) 아무것도 출력되지 않았다.