Skip to content

Commit

Permalink
Rework implementation to support nested classes (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ZacSweers
ZacSweers authored Nov 2, 2021
1 parent 09c66fd commit 42e8ed7
Show file tree
Hide file tree
Showing 9 changed files with 683 additions and 150 deletions.
13 changes: 6 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
AutoValue Kotlin
================

auto-value-kotlin (AVK) is an [AutoValue](https://github.com/google/auto) extension that generates
binary-and-source-compatible, equivalent Kotlin `data` classes. This is intended to help migrations
by doing 95% of the work and just letting the developer come through and clean up the generated file
as-needed.
auto-value-kotlin (AVK) is an [AutoValue](https://github.com/google/auto) extension + processor
that generates binary-and-source-compatible, equivalent Kotlin `data` classes.

The intended use of this project is to ease migration from AutoValue classes to Kotlin data classes
and should be used ad-hoc rather than continuously. The idea is that it does 95% of the work for you
Expand Down Expand Up @@ -38,9 +36,10 @@ kapt {
arg("avkTargets", "ClassOne:ClassTwo")

// Boolean option to ignore nested classes. By default, AVK will error out when it encounters
// a nested AutoValue class as it has no means of safely converting the class since its
// a nested non-AutoValue class as it has no means of safely converting the class since its
// references are always qualified. This option can be set to true to make AVK just skip them
// and emit a warning.
// AVK will automatically convert nested AutoValue and enum classes along the way.
// OPTIONAL. False by default.
arg("avkIgnoreNested", "true")
}
Expand All @@ -50,8 +49,8 @@ kapt {
## Workflow

_Pre-requisites_
* Move any nested AutoValue classes to top-level first (even if just temporarily for the migration).
* You can optionally choose to ignore nested classes or only specific targets per the configuration
* Move any nested non-AutoValue/non-enum classes to top-level first (even if just temporarily for the migration).
* You can optionally choose to ignore nested non-AutoValue classes or only specific targets per the configuration
options detailed in the Installation section above.
* Ensure no classes outside of the original AutoValue class accesses its generated `AutoValue_` class.
* Clean once to clear up any generated file references.
Expand Down
1 change: 1 addition & 0 deletions build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ dependencies {
implementation("com.squareup.moshi:moshi:$moshiVersion")
implementation("com.google.auto.service:auto-service:1.0")
implementation("com.squareup:kotlinpoet:1.10.1")
implementation("com.squareup.okio:okio:3.0.0")
implementation("com.google.auto.value:auto-value:1.8.2")
implementation("com.google.auto.value:auto-value-annotations:1.8.2")
testImplementation("junit:junit:4.13.2")
Expand Down
112 changes: 63 additions & 49 deletions src/main/kotlin/com/slack/auto/value/kotlin/AutoValueKotlinExtension.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@

package com.slack.auto.value.kotlin

import com.google.auto.service.AutoService
import com.google.auto.common.MoreElements
import com.google.auto.common.MoreElements.isAnnotationPresent
import com.google.auto.value.AutoValue
import com.google.auto.value.extension.AutoValueExtension
import com.google.auto.value.extension.AutoValueExtension.BuilderContext
import com.slack.auto.value.kotlin.AvkBuilder.BuilderProperty
Expand All @@ -29,13 +31,17 @@ import com.squareup.kotlinpoet.FunSpec
import com.squareup.kotlinpoet.KModifier
import com.squareup.kotlinpoet.PropertySpec
import com.squareup.kotlinpoet.TypeName
import com.squareup.kotlinpoet.TypeSpec
import com.squareup.kotlinpoet.asClassName
import com.squareup.kotlinpoet.asTypeVariableName
import com.squareup.kotlinpoet.joinToCode
import com.squareup.moshi.Json
import java.util.Locale
import java.util.concurrent.ConcurrentHashMap
import javax.annotation.processing.Messager
import javax.annotation.processing.ProcessingEnvironment
import javax.lang.model.element.Element
import javax.lang.model.element.ElementKind
import javax.lang.model.element.ExecutableElement
import javax.lang.model.element.Modifier
import javax.lang.model.element.NestingKind
Expand All @@ -44,8 +50,7 @@ import javax.lang.model.util.Elements
import javax.lang.model.util.Types
import javax.tools.Diagnostic

@AutoService(AutoValueExtension::class)
public class AutoValueKotlinExtension : AutoValueExtension() {
public class AutoValueKotlinExtension(private val realMessager: Messager) : AutoValueExtension() {

public companion object {
// Options
Expand All @@ -54,6 +59,8 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
public const val OPT_IGNORE_NESTED: String = "avkIgnoreNested"
}

internal val collectedKclassees = ConcurrentHashMap<ClassName, KotlinClass>()
internal val collectedEnums = ConcurrentHashMap<ClassName, TypeSpec>()
private lateinit var elements: Elements
private lateinit var types: Types

Expand All @@ -74,14 +81,7 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
}

private fun FunSpec.Builder.withDocsFrom(e: Element): FunSpec.Builder {
return withDocsFrom(e) { parseDocs() }
}

@Suppress("ReturnCount")
private fun Element.parseDocs(): String? {
val doc = elements.getDocComment(this)?.trim() ?: return null
if (doc.isBlank()) return null
return cleanUpDoc(doc)
return withDocsFrom(e) { parseDocs(elements) }
}

@Suppress("DEPRECATION", "LongMethod", "ComplexMethod", "NestedBlockDepth", "ReturnCount")
Expand All @@ -91,33 +91,36 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
classToExtend: String,
isFinal: Boolean
): String? {
val targetClasses = context.processingEnvironment().options[OPT_TARGETS]
?.splitToSequence(":")
?.toSet()
?: emptySet()
val options = Options(context.processingEnvironment().options)

val ignoreNested =
context.processingEnvironment().options[OPT_IGNORE_NESTED]?.toBoolean() ?: false

if (targetClasses.isNotEmpty() && context.autoValueClass().simpleName.toString() !in targetClasses) {
if (options.targets.isNotEmpty() && context.autoValueClass().simpleName.toString() !in options.targets) {
return null
}

val avClass = context.autoValueClass()

if (avClass.nestingKind != NestingKind.TOP_LEVEL) {
val diagnosticKind = if (ignoreNested) {
Diagnostic.Kind.WARNING
} else {
Diagnostic.Kind.ERROR
val isTopLevel = avClass.nestingKind == NestingKind.TOP_LEVEL
if (!isTopLevel) {
val isParentAv = isAnnotationPresent(
MoreElements.asType(avClass.enclosingElement),
AutoValue::class.java
)
if (!isParentAv) {
val diagnosticKind = if (ignoreNested) {
Diagnostic.Kind.WARNING
} else {
Diagnostic.Kind.ERROR
}
realMessager
.printMessage(
diagnosticKind,
"Cannot convert nested classes to Kotlin safely. Please move this to top-level first.",
avClass
)
}
context.processingEnvironment().messager
.printMessage(
diagnosticKind,
"Cannot convert nested classes to Kotlin safely. Please move this to top-level first.",
avClass
)
return null
}

// Check for non-builder nested classes, which cannot be converted with this
Expand All @@ -128,19 +131,32 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
.orElse(false)
}

if (nonBuilderNestedTypes.isNotEmpty()) {
nonBuilderNestedTypes.forEach {
context.processingEnvironment().messager
val (enums, nonEnums) = nonBuilderNestedTypes.partition { it.kind == ElementKind.ENUM }

val (nestedAvClasses, remainingTypes) = nonEnums.partition { isAnnotationPresent(it, AutoValue::class.java) }

if (remainingTypes.isNotEmpty()) {
remainingTypes.forEach {
realMessager
.printMessage(
Diagnostic.Kind.ERROR,
"Cannot convert nested classes to Kotlin safely. Please move this to top-level first.",
"Cannot convert non-autovalue nested classes to Kotlin safely. Please move this to top-level first.",
it
)
}
return null
}

val classDoc = avClass.parseDocs()
for (enumType in enums) {
val (cn, spec) = EnumConversion.convert(
elements,
realMessager,
enumType
) ?: continue
collectedEnums[cn] = spec
}

val classDoc = avClass.parseDocs(elements)

var redactedClassName: ClassName? = null

Expand Down Expand Up @@ -189,7 +205,7 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
isOverride = isAnOverride,
isRedacted = isRedacted,
visibility = if (Modifier.PUBLIC in method.modifiers) KModifier.PUBLIC else KModifier.INTERNAL,
doc = method.parseDocs()
doc = method.parseDocs(elements)
)
}

Expand Down Expand Up @@ -229,14 +245,13 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
// Note we don't use context.propertyTypes() here because it doesn't contain nullability
// info, which we did capture
val propertyTypes = properties.mapValues { it.value.type }
avkBuilder = AvkBuilder.from(builder, propertyTypes) { parseDocs() }
avkBuilder = AvkBuilder.from(builder, propertyTypes) { parseDocs(elements) }

builderFactories += builder.builderMethods()
builderFactorySpecs += builder.builderMethods()
.map {
FunSpec.copyOf(it)
.withDocsFrom(it)
.addModifiers(avkBuilder.visibility)
.addStatement("TODO(%S)", "Replace this with the implementation from the source class")
.build()
}
Expand Down Expand Up @@ -387,22 +402,19 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
initializer("TODO()")
}

field.parseDocs()?.let { addKdoc(it) }
field.parseDocs(elements)?.let { addKdoc(it) }
}
.build()
}

val superclass = avClass.superclass.asSafeTypeName()
.takeUnless { it == ClassName("java.lang", "Object") }

val srcDir =
context.processingEnvironment().options[OPT_SRC] ?: error("Missing src dir option")

KotlinClass(
val kClass = KotlinClass(
packageName = context.packageName(),
doc = classDoc,
name = avClass.simpleName.toString(),
visibility = if (Modifier.PUBLIC in avClass.modifiers) KModifier.PUBLIC else KModifier.INTERNAL,
visibility = avClass.visibility,
isRedacted = isClassRedacted,
isParcelable = isParcelable,
superClass = superclass,
Expand All @@ -417,8 +429,14 @@ public class AutoValueKotlinExtension : AutoValueExtension() {
remainingMethods = remainingMethods,
classAnnotations = avClass.classAnnotations(),
redactedClassName = redactedClassName,
staticConstants = staticConstants
).writeTo(srcDir, context.processingEnvironment().messager)
staticConstants = staticConstants,
isTopLevel = isTopLevel,
children = nestedAvClasses
.mapTo(LinkedHashSet()) { it.asClassName() }
.plus(collectedEnums.keys)
)

collectedKclassees[context.autoValueClass().asClassName()] = kClass

return null
}
Expand Down Expand Up @@ -464,11 +482,7 @@ private fun AvkBuilder.Companion.from(
return AvkBuilder(
name = builderContext.builderType().simpleName.toString(),
doc = builderContext.builderType().parseDocs(),
visibility = if (Modifier.PUBLIC in builderContext.builderType().modifiers) {
KModifier.PUBLIC
} else {
KModifier.INTERNAL
},
visibility = builderContext.builderType().visibility,
builderProps = props,
buildFun = builderContext.buildMethod()
.map {
Expand Down
Loading

0 comments on commit 42e8ed7

Please sign in to comment.