summaryrefslogtreecommitdiff
path: root/buildSrc/src/main/kotlin/Libs.kt
blob: 9567845aa7b8575b9afc5c14189e2000204d49e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
 * MIT License
 *
 * Copyright (c) 2019 atlarge-research
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import org.gradle.api.JavaVersion
import org.gradle.api.Project
import org.gradle.api.artifacts.VersionCatalogsExtension
import org.gradle.kotlin.dsl.getByType
import kotlin.properties.ReadOnlyProperty

/**
 * This class makes the version catalog accessible for the build scripts until Gradle adds support for it.
 *
 * See https://github.com/gradle/gradle/issues/15383
 */
@Suppress("UnstableApiUsage")
public class Libs(project: Project) {
    /**
     * The version catalog of the project.
     */
    private val versionCatalog = project.extensions.getByType(VersionCatalogsExtension::class).named("libs")

    /**
     * A delegate for obtaining configuration values from a [Project] instance.
     */
    private fun lib(name: String? = null): ReadOnlyProperty<Libs, String> =
        ReadOnlyProperty { _, property -> get(name ?: property.name) }

    /**
     * Obtain the version for the specified [dependency][name].
     */
    operator fun get(name: String): String {
        val dep = versionCatalog.findDependency(name).get().get()
        return "${dep.module.group}:${dep.module.name}:${dep.versionConstraint.displayName}"
    }

    companion object {
        /**
         * The JVM version to target.
         */
        val jvmTarget = JavaVersion.VERSION_1_8
    }
}