-
-
Notifications
You must be signed in to change notification settings - Fork 159
/
MigrateAndroidxTask.kt
290 lines (245 loc) · 12.2 KB
/
MigrateAndroidxTask.kt
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
package com.louiscad.splitties
import org.gradle.api.DefaultTask
import org.gradle.api.GradleException
import org.gradle.api.Project
import org.gradle.api.artifacts.Configuration
import org.gradle.api.artifacts.Dependency
import org.gradle.api.tasks.TaskAction
import java.io.File
import kotlin.reflect.KClass
import kotlin.reflect.KVisibility
import kotlin.reflect.full.memberProperties
import kotlin.reflect.jvm.javaField
import kotlin.reflect.typeOf
open class MigrateAndroidxTask : DefaultTask() {
init {
group = "help"
description = "Migrate package to AndroidX"
}
@TaskAction
fun migratePackages() = with(AndroidxMigrator) {
println()
println("## Searching Android Support Dependencies")
println("$OK Parsing file androidx-artifact-mapping.csv")
val artifacts: List<ArtifactMapping> = readArtifactMappings()
val androidSupportDependencies = findAndroidSupportDependencies(project, artifacts)
println(gradleSyntax(androidSupportDependencies.map { "${it.group}:${it.name}:${it.version}" }, emptyMap()))
println("## Checking that you use compileSdkVersion 28")
val detected = tryDetectCompileSdkVersion(project.rootDir)
val version = detected.mapNotNull { detectVersion(it) }.firstOrNull()
println(
when (version) {
null -> "⚠️ Make sure you are using compileSdkVersion 28. See $MIGRATE_TO_28"
28 -> "$OK You are using compileSdkVersion 28"
else -> throw GradleException("You should migrate first to compileSdkVersion 28. See $MIGRATE_TO_28")
}
)
println()
println("## Migrating classes from support libraries to AndroidX.")
println("$OK Parsing file androidx-class-mapping.csv")
val androidxClassMappings: List<String> = readAndroidxClassMappings()
val moduleDirectories: List<File> = project.subprojects.map { it.projectDir }
println("$OK Modules: ${moduleDirectories.map { it.relativeTo(project.rootDir) }}")
val sourceFiles = sourceFiles(moduleDirectories)
val gradleFiles = gradleFiles(moduleDirectories)
println("$OK Found ${sourceFiles.size} source files that may need migration")
val supportLibsToAndroidXMappings = supportLibsToAndroidXMappings(androidxClassMappings)
val rawSupportLibsToAndroidXPackageMappings =
rawSupportLibsToAndroidXPackageMappings(supportLibsToAndroidXMappings)
val supportLibsToAndroidXStarImportMappings =
supportLibsToAndroidXStarImportMappings(rawSupportLibsToAndroidXPackageMappings)
println("$OK File androidx-class-mapping.csv parsed correctly")
val replaces: List<Pair<String, String>> =
supportLibsToAndroidXMappings + supportLibsToAndroidXStarImportMappings
println("$OK Starting batch migration...")
val editedSourceFilesCount = sourceFiles.count { it.migrateToAndroidX(replaces) }
val editedGradleFilesCount = gradleFiles.count { it.migrateToAndroidX(replaces) }
println(
"\n$OK $editedSourceFilesCount source files (${sourceExtensions.joinToString(",") { it }}) " +
"have been migrated (${sourceFiles.count() - editedSourceFilesCount} didn't need it)."
)
println(
"$OK $editedGradleFilesCount gradle files have been migrated " +
"(${gradleFiles.count() - editedGradleFilesCount} didn't need it)."
)
println()
println("## Detecting Gradle properties")
val hasProperties = PROPERTIES.all { project.hasProperty(it) }
if (hasProperties) {
println("$OK gradle.properties already contains $PROPERTIES")
} else {
val file = project.rootProject.file("gradle.properties")
file.appendText(GRADLE_PROPERTIES)
println("$OK Added ${PROPERTIES} to file gradle.properties")
}
println()
println("## Your turn: use instead those Androidx libraries")
val map = artifacts.associate { it.supportArtifact to it.androidXArtifact }
val splitties = getArtifactNameToSplittiesConstantMapping()
println(gradleSyntax(androidSupportDependencies.mapNotNull { map[it.artifact] }, splitties))
}
}
internal data class ArtifactMapping(
val supportArtifact: String,
val androidXArtifact: String
)
internal object AndroidxMigrator {
const val OK = "✔ \uD83C\uDD97"
val PROPERTIES = listOf("android.useAndroidX", "android.enableJetifier")
val GRADLE_PROPERTIES = PROPERTIES.joinToString(separator = "\n", prefix = "\n", postfix = "\n") { "$it=true" }
val MIGRATE_TO_28 = "https://developer.android.com/about/versions/pie/android-9.0-migration"
val Dependency.artifact: String
get() = "$group:$name"
fun gradleSyntax(artifacts: List<String>, splitties: Map<String, String>): String {
if (artifacts.isEmpty()) {
return "$OK No Android support dependency needs to be migrated"
}
return artifacts.joinToString("\n", prefix = "\n", postfix = "\n") { artifact ->
val configuration = if (artifact.contains("test")) "androidTestImplementation" else "implementation"
if (artifact in splitties) {
"$configuration(${splitties[artifact]})"
} else {
"""$configuration("$artifact")"""
}
}
}
fun readArtifactMappings(): List<ArtifactMapping> {
val lines: List<String> =
this::class.java.getResourceAsStream("/androidx-artifact-mapping.csv").reader().readLines()
return lines
.drop(1)
.filter { it.contains(",") }
.map {
val (old, new) = it.split(",")
ArtifactMapping(old, new)
}
}
fun tryDetectCompileSdkVersion(rootDir: File): List<String> {
return rootDir.walk()
.filter { it.isFile }
.filter { it.name.endsWith(".gradle.kts") || it.name.endsWith(".gradle") }
.flatMap { it.readLines().mapNotNull { containsCompileSdkVersion(it) }.asSequence() }
.toList()
}
/***
* Convert one of those lines to 28 or null
*
* compileSdkVersion 28
* compileSdkVersion(28)
* compileSdkVersion = 28
*/
fun detectVersion(line: String): Int? {
var input = line.trim()
listOf("compileSdkVersion", "(", ")", "=").forEach {
input = input.replace(it, " ")
}
return input.trim().substringAfterLast(" ").toIntOrNull()
}
fun containsCompileSdkVersion(line: String) = when {
line.contains("compileSdkVersion") -> line
else -> null
}
fun readAndroidxClassMappings(): List<String> {
return this::class.java.getResourceAsStream("/androidx-class-mapping.csv").reader().readLines()
}
fun findAndroidSupportDependencies(project: Project, artifacts: List<ArtifactMapping>): List<Dependency> {
val supportArtifacts = artifacts.map(ArtifactMapping::supportArtifact)
val allConfigurations: Set<Configuration> = project.rootProject.allprojects.flatMap {
it.configurations
}.toSet()
return allConfigurations
.flatMap { configuration ->
configuration.allDependencies
.filter { it.artifact in supportArtifacts }
}.distinctBy { it.artifact }
}
val sourceExtensions = listOf("kt", "java", "xml")
val gradleExtension = "gradle"
fun File.findSourceFiles(): List<File> {
val filesWithExtension = listFiles { file: File ->
file.extension in sourceExtensions
}?.asList() ?: emptyList()
val sourceFiles = listFiles { file: File ->
file.isDirectory
}?.flatMap { it.findSourceFiles() } ?: emptyList()
return filesWithExtension + sourceFiles
}
fun sourceFiles(moduleDirectories: List<File>): List<File> = moduleDirectories.map {
File(it, "src")
}.flatMap { it.findSourceFiles() }
fun gradleFiles(moduleDirectories: List<File>): List<File> = moduleDirectories.flatMap {
it.listFiles { file: File ->
file.extension == gradleExtension
}?.asIterable() ?: emptyList()
}
fun supportLibsToAndroidXMappings(androidXClassMapping: List<String>): List<Pair<String, String>> {
return androidXClassMapping.asSequence().drop(1)
.map { line ->
val (supportLibClassName, androidXClassName) = line.split(",").also { check(it.size == 2) }
check(supportLibClassName.isLegalClassName()) { "Illegal entry in csv: $supportLibClassName" }
check(androidXClassName.isLegalClassName()) { "Illegal entry in csv: $androidXClassName" }
supportLibClassName to androidXClassName
}.sortedByDescending { (supportLibClassName, _) -> supportLibClassName }.toList()
}
fun rawSupportLibsToAndroidXPackageMappings(
supportLibsToAndroidXMappings: List<Pair<String, String>>
): List<Pair<String, String>> =
supportLibsToAndroidXMappings.asSequence().map { (supportLibClassName, androidXClassName) ->
supportLibClassName.packageNameFromClassName() to androidXClassName.packageNameFromClassName()
}.distinct().toList()
fun supportLibsToAndroidXStarImportMappings(
rawSupportLibsToAndroidXPackageMappings: List<Pair<String, String>>
): List<Pair<String, String>> =
rawSupportLibsToAndroidXPackageMappings.map { (supportLibPackageName, _/*androidXPackageName*/) ->
val supportLibStarImport = "import $supportLibPackageName.*"
val androidXStarImports = rawSupportLibsToAndroidXPackageMappings.filter { (slpn, _) ->
supportLibPackageName == slpn
}.joinToString("\n") { (_, axpn) -> "import $axpn.*" }
supportLibStarImport to androidXStarImports
}
fun String.simpleNameFromFullyQualified(): String = substring(indexOfFirst { it.isUpperCase() })
fun String.packageNameFromClassName(): String = substring(0, indexOfFirst { it.isUpperCase() } - 1)
fun String.isLegalClassName() = first().isJavaIdentifierStart() && all {
it.isJavaIdentifierPart() || it == '.'
}
val supportedExtensions = sourceExtensions + gradleExtension
fun File.migrateToAndroidX(replaces: List<Pair<String, String>>): Boolean {
check(extension in supportedExtensions)
val sourceCode = readText()
var editedSourceCode = sourceCode
val migratingMsg = "Migrating file \"$name\" … "
print(migratingMsg)
replaces.forEach { (supportLibSnippet, androidXSnippet) ->
editedSourceCode = editedSourceCode.replace(supportLibSnippet, androidXSnippet)
}
return if (editedSourceCode == sourceCode) {
print("\b".repeat(migratingMsg.length))
false
} else {
print("overwriting file… ")
writeText(editedSourceCode)
println(" Done. ✔🆗") // Emojis can be cut off by terminal line breaks, hence the checkmark.
true
}
}
fun getArtifactNameToSplittiesConstantMapping(): Map<String, String> {
return listOf(AndroidX, Google, Kotlin, KotlinX, Splitties, Square, Testing).flatMap { objectInstance ->
(objectInstance::class).getArtifactNameToSplittiesConstantMapping(objectInstance::class.simpleName!!)
}.toMap()
}
@UseExperimental(ExperimentalStdlibApi::class)
private fun KClass<*>.getArtifactNameToSplittiesConstantMapping(prefix: String): List<Pair<String, String>> {
return nestedClasses.filter { it.visibility == KVisibility.PUBLIC }.flatMap { kClass ->
val propertyName = kClass.simpleName!!.let { c -> "${c.first().toLowerCase()}${c.substring(1)}"}
kClass.getArtifactNameToSplittiesConstantMapping("$prefix.$propertyName")
} + this.memberProperties.filter {
it.isConst &&
it.visibility == KVisibility.PUBLIC &&
it.returnType == typeOf<String>()
}.map {
val artifactName = it.javaField!!.get(null).toString().substringBeforeLast(':')
val constantName = "$prefix.${it.name}"
artifactName to constantName
}
}
}