-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide option to hide the merged interface
Until now it was required to add the merged interface as super type, e.g. ``` @component @MergeComponent(AppScope::class) interface AppComponent : AppComponentMerged ``` With the new mechanism the `@Component` annotation and the super type can be omitted. In this case we will generate the final kotlin-inject component under the hood. This removes boilerplate and brings us closer to the original Anvil design. Further, this will help with #20 in KMP scenarios where generated code cannot be access from common code. Fixes #8
- Loading branch information
Showing
9 changed files
with
649 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
187 changes: 187 additions & 0 deletions
187
...e/amazon/lastmile/kotlin/inject/anvil/processor/GenerateKotlinInjectComponentProcessor.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| @file:OptIn(KspExperimental::class) | ||
|
|
||
| package software.amazon.lastmile.kotlin.inject.anvil.processor | ||
|
|
||
| import com.google.devtools.ksp.KspExperimental | ||
| import com.google.devtools.ksp.isAnnotationPresent | ||
| import com.google.devtools.ksp.processing.CodeGenerator | ||
| import com.google.devtools.ksp.processing.KSPLogger | ||
| import com.google.devtools.ksp.processing.Resolver | ||
| import com.google.devtools.ksp.processing.SymbolProcessor | ||
| import com.google.devtools.ksp.symbol.ClassKind | ||
| import com.google.devtools.ksp.symbol.KSAnnotated | ||
| import com.google.devtools.ksp.symbol.KSClassDeclaration | ||
| import com.squareup.kotlinpoet.ClassName | ||
| import com.squareup.kotlinpoet.FileSpec | ||
| import com.squareup.kotlinpoet.FunSpec | ||
| import com.squareup.kotlinpoet.KModifier.ABSTRACT | ||
| import com.squareup.kotlinpoet.ParameterSpec | ||
| import com.squareup.kotlinpoet.ParameterizedTypeName.Companion.parameterizedBy | ||
| import com.squareup.kotlinpoet.TypeSpec | ||
| import com.squareup.kotlinpoet.asTypeName | ||
| import com.squareup.kotlinpoet.ksp.addOriginatingKSFile | ||
| import com.squareup.kotlinpoet.ksp.toAnnotationSpec | ||
| import com.squareup.kotlinpoet.ksp.toClassName | ||
| import com.squareup.kotlinpoet.ksp.toTypeName | ||
| import com.squareup.kotlinpoet.ksp.writeTo | ||
| import me.tatarka.inject.annotations.Component | ||
| import software.amazon.lastmile.kotlin.inject.anvil.ContextAware | ||
| import software.amazon.lastmile.kotlin.inject.anvil.MergeComponent | ||
| import software.amazon.lastmile.kotlin.inject.anvil.addOriginAnnotation | ||
| import kotlin.reflect.KClass | ||
|
|
||
| /** | ||
| * Generates the final kotlin-inject component when [MergeComponent] is found without the | ||
| * [Component] annotation, e.g. | ||
| * ``` | ||
| * package software.amazon.test | ||
| * | ||
| * @MergeComponent(AppScope::class) | ||
| * @SingleIn(AppScope::class) | ||
| * interface TestComponent | ||
| * ``` | ||
| * Will generate: | ||
| * ``` | ||
| * package software.amazon.test | ||
| * | ||
| * @MergeComponent(AppScope::class) | ||
| * @Component | ||
| * @SingleIn(AppScope::class) | ||
| * interface KotlinInjectTestComponent : KotlinInjectTestComponentMerged | ||
| * ``` | ||
| * | ||
| * Parameters are supported as well, e.g. | ||
| * ``` | ||
| * package software.amazon.test | ||
| * | ||
| * @MergeComponent(AppScope::class) | ||
| * @SingleIn(AppScope::class) | ||
| * abstract class TestComponent( | ||
| * @get:Provides val string: String, | ||
| * ) | ||
| * ``` | ||
| * Will generate: | ||
| * ``` | ||
| * package software.amazon.test | ||
| * | ||
| * @MergeComponent(AppScope::class) | ||
| * @Component | ||
| * @SingleIn(AppScope::class) | ||
| * abstract class KotlinInjectTestComponent(string: String) : KotlinInjectTestComponentMerged(string) | ||
| * ``` | ||
| * | ||
| * This processor will also add a function to make instantiating the generated component easier. | ||
| * The function delegates the call to the final kotlin-inject component. For the example above | ||
| * the following function would be generated: | ||
| * ``` | ||
| * fun KClass<TestComponent>.create(string: String): TestComponent { | ||
| * return KotlinInjectTestComponent::class.create(string) | ||
| * } | ||
| * ``` | ||
| */ | ||
| internal class GenerateKotlinInjectComponentProcessor( | ||
| private val codeGenerator: CodeGenerator, | ||
| override val logger: KSPLogger, | ||
| ) : SymbolProcessor, ContextAware { | ||
|
|
||
| private val processedComponents = mutableSetOf<String>() | ||
|
|
||
| @Suppress("ReturnCount") | ||
| override fun process(resolver: Resolver): List<KSAnnotated> { | ||
| resolver | ||
| .getSymbolsWithAnnotation(MergeComponent::class) | ||
| .filterIsInstance<KSClassDeclaration>() | ||
| .filter { it.requireQualifiedName() !in processedComponents } | ||
| .filter { !it.isAnnotationPresent(Component::class) } | ||
| .onEach { | ||
| checkIsPublic(it) | ||
| checkHasScope(it) | ||
| } | ||
| .forEach { | ||
| generateKotlinInjectComponent(it) | ||
|
|
||
| processedComponents += it.requireQualifiedName() | ||
| } | ||
|
|
||
| return emptyList() | ||
| } | ||
|
|
||
| @Suppress("LongMethod") | ||
| private fun generateKotlinInjectComponent(clazz: KSClassDeclaration) { | ||
| val className = ClassName( | ||
| packageName = clazz.packageName.asString(), | ||
| simpleNames = listOf("KotlinInject${clazz.innerClassNames()}"), | ||
| ) | ||
|
|
||
| val isInterface = clazz.classKind == ClassKind.INTERFACE | ||
| val parameters = clazz.primaryConstructor?.parameters ?: emptyList() | ||
| val parametersAsSpec = parameters.map { | ||
| ParameterSpec | ||
| .builder( | ||
| name = it.requireName(), | ||
| type = it.type.toTypeName(), | ||
| ) | ||
| .build() | ||
| } | ||
|
|
||
| val classBuilder = if (isInterface) { | ||
| TypeSpec | ||
| .interfaceBuilder(className) | ||
| .addSuperinterface(clazz.toClassName()) | ||
| } else { | ||
| TypeSpec | ||
| .classBuilder(className) | ||
| .addModifiers(ABSTRACT) | ||
| .superclass(clazz.toClassName()) | ||
| .apply { | ||
| if (parameters.isNotEmpty()) { | ||
| primaryConstructor( | ||
| FunSpec.constructorBuilder() | ||
| .addParameters(parametersAsSpec) | ||
| .build(), | ||
| ) | ||
| addSuperclassConstructorParameter( | ||
| parameters.joinToString { it.requireName() }, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| val fileSpec = FileSpec.builder(className) | ||
| .addType( | ||
| classBuilder | ||
| .addOriginatingKSFile(clazz.requireContainingFile()) | ||
| .addOriginAnnotation(clazz) | ||
| .addAnnotation(Component::class) | ||
| .addAnnotation(clazz.findAnnotation(MergeComponent::class).toAnnotationSpec()) | ||
| .apply { | ||
| clazz.annotations | ||
| .filter { it.isKotlinInjectScopeAnnotation() } | ||
| .singleOrNull() | ||
| ?.toAnnotationSpec() | ||
| ?.let { addAnnotation(it) } | ||
| } | ||
| .addSuperinterface( | ||
| className.peerClass("KotlinInject${clazz.mergedClassName}"), | ||
| ) | ||
| .build(), | ||
| ) | ||
| .addFunction( | ||
| FunSpec | ||
| .builder("create") | ||
| .receiver( | ||
| KClass::class.asTypeName().parameterizedBy(clazz.toClassName()), | ||
| ) | ||
| .addParameters(parametersAsSpec) | ||
| .returns(clazz.toClassName()) | ||
| .addStatement( | ||
| "return %T::class.create(${parametersAsSpec.joinToString { it.name }})", | ||
| className, | ||
| ) | ||
| .build(), | ||
| ) | ||
| .build() | ||
|
|
||
| fileSpec.writeTo(codeGenerator, aggregating = false) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.