Skip to content

Commit edc1a07

Browse files
RBusarowkodiakhq[bot]
RBusarow
authored and
kodiakhq[bot]
committed
automatically add dependencies to build file
1 parent c33dbe8 commit edc1a07

File tree

7 files changed

+184
-63
lines changed

7 files changed

+184
-63
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ but it's necessary for the IDE and Dependabot to do their parsing.
4444
// ./dependency-sync/build.gradle.kts
4545

4646
plugins {
47-
id("com.rickbusarow.gradle-dependency-sync") version "0.10.0"
47+
id("com.rickbusarow.gradle-dependency-sync") version "0.11.0"
4848
}
4949

5050
dependencySync {

‎gradle-dependency-sync-plugin/src/main/kotlin/dependencysync/gradle/DependencySyncPlugin.kt

+6-2
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,17 @@ import org.gradle.api.model.ObjectFactory
2121
import org.gradle.api.provider.Property
2222
import org.gradle.kotlin.dsl.configure
2323
import org.gradle.kotlin.dsl.create
24+
import org.gradle.kotlin.dsl.property
2425
import javax.inject.Inject
2526

2627
@Suppress("UnnecessaryAbstractClass") // for Gradle
27-
public abstract class DependencySyncExtension @Inject constructor(objects: ObjectFactory) {
28+
public abstract class DependencySyncExtension @Inject constructor(
29+
target: Project,
30+
objects: ObjectFactory
31+
) {
2832

2933
public val gradleBuildFile: Property<String> = objects.property(String::class.java)
30-
.convention("./build.gradle.kts")
34+
.convention(target.buildFile.path)
3135

3236
public val typeSafeFile: Property<String> = objects.property(String::class.java)
3337
.convention("./gradle/libs.versions.toml")

‎gradle-dependency-sync-plugin/src/main/kotlin/dependencysync/gradle/DependencySyncTask.kt

+71-58
Original file line numberDiff line numberDiff line change
@@ -9,82 +9,50 @@ import javax.inject.Inject
99

1010
public open class DependencySyncTask @Inject constructor(
1111
@Input
12-
public val settings: DependencySyncExtension
12+
public val settings: DependencySyncExtension
1313
) : DefaultTask() {
1414

15-
@TaskAction
16-
public fun action() {
17-
val gradleBuildFile = File(settings.gradleBuildFile.get())
18-
val tomlFile = File(settings.typeSafeFile.get())
15+
internal companion object {
1916

20-
var buildText = gradleBuildFile.readText()
21-
22-
val versionsBlockReg = """^[\s\S]*\[versions\]([\S\s]*)\[libraries\]""".toRegex()
23-
val librariesBlockReg = """^[\s\S]*\[libraries\]([\S\s]*)\[\S*\]""".toRegex()
2417
val versionReg = """((\S*)\s*=\s*"([^"]*)"\s*)""".toRegex()
18+
2519
val simpleReg = """((\S*)\s*=\s*"([^":]*):([^":]*):([^"]*)")""".toRegex()
2620
val complexReg =
2721
"""((\S*)\s*=\s*\{\s*module\s*=\s*"([^:]*):(\S*)"\s*,\s*version\.ref\s*=\s*"([^"]*)"\s*\}\s*)""".toRegex()
22+
}
2823

29-
val dummyConfig = project.configurations.getByName(DependencySyncPlugin.CONFIGURATION_NAME)
24+
@TaskAction
25+
public fun action() {
26+
val gradleBuildFile = File(settings.gradleBuildFile.get())
27+
val tomlFile = File(settings.typeSafeFile.get())
3028

31-
val buildFileDeps = dummyConfig.dependencies
32-
.filter { it.version != null }
33-
.map { Dep(it.group!!, it.name, it.version!!) }
34-
.groupBy { it.group + it.name }
35-
.values
36-
.map { depsByArtifact -> depsByArtifact.maxByOrNull { it.version }!! }
29+
var buildText = gradleBuildFile.readText()
3730

38-
val thisFileDeps = buildFileDeps
39-
.groupBy { it.group }
40-
.map { (group, lst) ->
41-
group to lst.associateBy { it.name }
42-
}
43-
.toMap()
31+
val dependencySyncConfig = project.configurations
32+
.getByName(DependencySyncPlugin.CONFIGURATION_NAME)
4433

45-
var tomlText = tomlFile.readText()
34+
val parsedBuildFile = ParsedBuildFile.create(dependencySyncConfig)
4635

47-
val versionBlock = versionsBlockReg.find(tomlText)?.destructured?.component1() ?: ""
48-
val librariesBlock = librariesBlockReg.find(tomlText)?.destructured?.component1() ?: ""
36+
val parsedToml = ParsedToml.create(tomlFile)
4937

50-
val tomlVersions = versionReg.findAll(versionBlock)
51-
.map { it.destructured }
52-
.map { (wholeString, name, version) ->
53-
TomlVersion(wholeString, name, version)
54-
}
55-
.associateBy { it.defName }
56-
57-
val complexEntries = complexReg.findAll(librariesBlock)
58-
.toList()
59-
.map { it.destructured }
60-
.map { (line, defName, group, name, versionRef) ->
61-
val versionDef = tomlVersions.getValue(versionRef)
62-
val version = versionDef.version
63-
64-
TomlEntry.Complex(
65-
originalText = line,
66-
defName = defName,
67-
versionDef = versionDef,
68-
dep = Dep(group, name, version)
69-
)
70-
}
38+
var tomlText = parsedToml.text
39+
val tomlLibrariesBlock = parsedToml.librariesBlock
40+
val tomlEntries = parsedToml.entries
7141

72-
val simpleEntries = simpleReg.findAll(librariesBlock)
73-
.map { it.destructured }
74-
.map { (line, defName, group, name, version) ->
75-
TomlEntry.Simple(line, defName, Dep(group, name, version))
76-
}
77-
.toList()
42+
buildText = addMissingBuildFileDeps(tomlEntries, parsedBuildFile, buildText)
43+
44+
val updatedparsedBuildFile = ParsedBuildFile.create(dependencySyncConfig)
7845

79-
val tomlEntries = (complexEntries + simpleEntries).toMutableList()
46+
val buildFileDeps = updatedparsedBuildFile.deps
47+
val groupedBuildFileDeps = updatedparsedBuildFile.groupedDeps
8048

81-
val leftovers = buildFileDeps
49+
val missingFromToml = buildFileDeps
8250
.filterNot { buildFileDep ->
8351
tomlEntries.any { it.dep.group == buildFileDep.group && it.dep.name == buildFileDep.name }
8452
}
8553
.map { it.toSimpleToml() }
8654

87-
tomlEntries.addAll(leftovers)
55+
tomlEntries.addAll(missingFromToml)
8856

8957
val grouped = tomlEntries.groupBy {
9058
it.dep
@@ -107,16 +75,23 @@ public open class DependencySyncTask @Inject constructor(
10775
.sorted()
10876
.joinToString("\n", "\n", "\n")
10977

110-
tomlText = tomlText.replace(librariesBlock, newToml)
78+
tomlText = tomlText.replace(tomlLibrariesBlock, newToml)
11179

11280
tomlEntries
81+
.filterNot {
82+
val tomlDep = it.dep
83+
84+
val ktsDep = groupedBuildFileDeps[tomlDep.group]?.get(tomlDep.name)
85+
86+
ktsDep != null
87+
}
11388
.forEach { entry ->
11489

11590
val tomlDep = entry.dep
11691

117-
val ktsDep = thisFileDeps[tomlDep.group]
92+
val ktsDep = groupedBuildFileDeps.get(tomlDep.group)
11893
?.get(tomlDep.name)
119-
?: throw GradleException("Dependency `$tomlDep` is declared in $tomlFile but not in $gradleBuildFile")
94+
?: return@forEach
12095

12196
if (ktsDep.version != tomlDep.version && entry is TomlEntry.Complex) {
12297
val newer = maxOf(ktsDep.version, tomlDep.version)
@@ -153,4 +128,42 @@ public open class DependencySyncTask @Inject constructor(
153128
gradleBuildFile.writeText(buildText)
154129
tomlFile.writeText(tomlText)
155130
}
131+
132+
private fun addMissingBuildFileDeps(
133+
tomlEntries: MutableList<TomlEntry>,
134+
parsedBuildFile: ParsedBuildFile,
135+
originalBuildText: String
136+
): String {
137+
var buildText = originalBuildText
138+
139+
val groupedBuildFileDeps = parsedBuildFile.groupedDeps
140+
141+
val (missingFromBuildFile, inBuildFile) = tomlEntries
142+
.map { it.dep }
143+
.partition { dep -> groupedBuildFileDeps[dep.group]?.get(dep.name) == null }
144+
145+
val lastBuildDep = inBuildFile.lastOrNull()
146+
?: throw GradleException("Cannot find any `dependencySync` dependencies in build file")
147+
148+
val lastBuildDepRegex = """(.*dependencySync.*['"])$lastBuildDep(['"].*)""".toRegex()
149+
150+
val lastBuildDepResult = buildText.lines()
151+
.asSequence()
152+
.mapNotNull { lastBuildDepRegex.find(it) }
153+
.firstOrNull()
154+
?: throw GradleException(
155+
"Cannot find a dependency declaration for $lastBuildDep, " +
156+
"using the regex ${lastBuildDepRegex.pattern}, in build file"
157+
)
158+
159+
val (prefix, suffix) = lastBuildDepResult.destructured
160+
161+
missingFromBuildFile.forEach { missingDep ->
162+
val new = """$prefix$missingDep$suffix
163+
|$prefix$lastBuildDep$suffix
164+
""".trimMargin()
165+
buildText = buildText.replace(lastBuildDepResult.value, new)
166+
}
167+
return buildText
168+
}
156169
}

‎gradle-dependency-sync-plugin/src/main/kotlin/dependencysync/gradle/ParsedBuildFile.kt

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
package dependencysync.gradle
2+
3+
import org.gradle.api.artifacts.Configuration
4+
5+
internal data class ParsedBuildFile(
6+
val deps: List<Dep>,
7+
val groupedDeps: Map<String, Map<String, Dep>>
8+
) {
9+
internal companion object {
10+
11+
internal fun create(
12+
dependencySyncConfig: Configuration
13+
): ParsedBuildFile {
14+
val buildFileDeps = dependencySyncConfig.dependencies
15+
.filter { it.version != null }
16+
.map { Dep(it.group!!, it.name, it.version!!) }
17+
.groupBy { it.group + it.name }
18+
.values
19+
.map { depsByArtifact -> depsByArtifact.maxByOrNull { it.version }!! }
20+
21+
val groupedBuildFileDeps = buildFileDeps
22+
.groupBy { it.group }
23+
.map { (group, lst) ->
24+
group to lst.associateBy { it.name }
25+
}
26+
.toMap()
27+
return ParsedBuildFile(
28+
deps = buildFileDeps,
29+
groupedDeps = groupedBuildFileDeps
30+
)
31+
}
32+
}
33+
}

‎gradle-dependency-sync-plugin/src/main/kotlin/dependencysync/gradle/ParsedToml.kt

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
package dependencysync.gradle
2+
3+
import dependencysync.gradle.DependencySyncTask.Companion.complexReg
4+
import dependencysync.gradle.DependencySyncTask.Companion.simpleReg
5+
import dependencysync.gradle.DependencySyncTask.Companion.versionReg
6+
import dependencysync.gradle.TomlEntry.Complex
7+
import dependencysync.gradle.TomlEntry.Simple
8+
import java.io.File
9+
10+
internal data class ParsedToml(
11+
val text: String,
12+
val librariesBlock: String,
13+
val versions: Map<String, TomlVersion>,
14+
val complexEntries: List<Complex>,
15+
val simpleEntries: List<Simple>,
16+
val entries: MutableList<TomlEntry>,
17+
18+
) {
19+
internal companion object {
20+
21+
val versionsBlockReg = """^[\s\S]*\[versions\]([\S\s]*)\[libraries\]""".toRegex()
22+
val librariesBlockReg = """^[\s\S]*\[libraries\]([\S\s]*)\[\S*\]""".toRegex()
23+
24+
internal fun create(tomlFile: File): ParsedToml {
25+
val tomlText = tomlFile.readText()
26+
27+
val tomlVersionBlock = versionsBlockReg.find(tomlText)?.destructured?.component1() ?: ""
28+
val tomlLibrariesBlock = librariesBlockReg.find(tomlText)?.destructured?.component1() ?: ""
29+
30+
val tomlVersions = versionReg.findAll(tomlVersionBlock)
31+
.map { it.destructured }
32+
.map { (wholeString, name, version) ->
33+
TomlVersion(wholeString, name, version)
34+
}
35+
.associateBy { it.defName }
36+
37+
val tomlComplexEntries = complexReg.findAll(tomlLibrariesBlock)
38+
.toList()
39+
.map { it.destructured }
40+
.map { (line, defName, group, name, versionRef) ->
41+
val versionDef = tomlVersions.getValue(versionRef)
42+
val version = versionDef.version
43+
44+
TomlEntry.Complex(
45+
originalText = line,
46+
defName = defName,
47+
versionDef = versionDef,
48+
dep = Dep(group, name, version)
49+
)
50+
}
51+
52+
val tomlSimpleEntries = simpleReg.findAll(tomlLibrariesBlock)
53+
.map { it.destructured }
54+
.map { (line, defName, group, name, version) ->
55+
TomlEntry.Simple(line, defName, Dep(group, name, version))
56+
}
57+
.toList()
58+
59+
val tomlEntries = (tomlComplexEntries + tomlSimpleEntries).toMutableList()
60+
61+
return ParsedToml(
62+
text = tomlText,
63+
librariesBlock = tomlLibrariesBlock,
64+
versions = tomlVersions,
65+
complexEntries = tomlComplexEntries,
66+
simpleEntries = tomlSimpleEntries,
67+
entries = tomlEntries
68+
)
69+
}
70+
}
71+
}

‎gradle.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ kotlin.code.style=official
2525
kotlin.caching.enabled=true
2626
kotlin.incremental=true
2727

28-
VERSION=0.10.0
28+
VERSION=0.11.0

‎gradle/libs.versions.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ minSdk = "23"
1919
spotless = "5.10.1"
2020
targetSdk = "30"
2121
taskTree = "1.5"
22-
versionName = "0.10.0"
22+
versionName = "0.11.0"
2323

2424
[libraries]
2525

0 commit comments

Comments
 (0)