Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add @Singular + Switch statement/expression, arrays, better API #113

Merged
merged 4 commits into from
Jul 5, 2024
Merged

Add @Singular + Switch statement/expression, arrays, better API #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce08932
Add `@Singular` + Switch statement/expression, arrays, better API
dstepanov Jul 3, 2024
08859a0
Add `Singulars` from Lombok
dstepanov Jul 5, 2024
eb090b9
Sonar
dstepanov Jul 5, 2024
9d5d6bb
Refactor
dstepanov Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions sourcegen-annotations/src/main/java/io/micronaut/sourcegen/annotations/Singular.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright 2017-2021 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.sourcegen.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
* The annotation to be used with {@link Builder} or {@link SuperBuilder} on a property to create
* a single element method for filling a collection. The final collection is immutable by default.
* The name of the singular method is extracted from the property name converting plural name to a singular,
* in a case it's not possible to recognize the singular name it's required to provide it in the value attribute.
* The only supported collections are:
* - {@link java.lang.Iterable}
* - {@link java.util.Collection}
* - {@link java.util.List}
* - {@link java.util.Set}
* - {@link java.util.SortedSet}
* - {@link java.util.Map}
* - {@link java.util.SortedMap}
*
* @author Denis Stepanov
* @since 1.2
*/
@Documented
@Retention(RUNTIME)
@Target({FIELD, PARAMETER})
public @interface Singular {

/**
* @return The name of the singular method. If the collection doesn't end with "s" the name is required.
*/
String value() default "";

}
256 changes: 202 additions & 54 deletions sourcegen-generator-java/src/main/java/io/micronaut/sourcegen/JavaPoetSourceGenerator.java
View file
Open in desktop

Large diffs are not rendered by default.

91 changes: 53 additions & 38 deletions ...egen-generator-kotlin/src/main/kotlin/io/micronaut/sourcegen/KotlinPoetSourceGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ class KotlinPoetSourceGenerator : SourceGenerator {
private fun writeInterface(writer: Writer, interfaceDef: InterfaceDef) {
val interfaceBuilder = TypeSpec.interfaceBuilder(interfaceDef.simpleName)
interfaceBuilder.addModifiers(asKModifiers(interfaceDef.modifiers))
interfaceDef.typeVariables.stream().map { tv: TypeDef.TypeVariable -> this.asTypeVariable(tv) }
interfaceDef.typeVariables.stream().map { tv: TypeDef.TypeVariable -> this.asTypeVariable(tv, interfaceDef) }
.forEach { typeVariable: TypeVariableName -> interfaceBuilder.addTypeVariable(typeVariable) }
interfaceDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef) }
interfaceDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef, interfaceDef) }
.forEach { it: TypeName ->
interfaceBuilder.addSuperinterface(
it
Expand All @@ -122,15 +122,17 @@ class KotlinPoetSourceGenerator : SourceGenerator {
property.modifiers,
property.annotations,
property.javadoc,
null
null,
interfaceDef
)
} else {
buildConstructorProperty(
property.name,
property.type,
property.modifiers,
property.annotations,
property.javadoc
property.javadoc,
interfaceDef
)
}
interfaceBuilder.addProperty(
Expand Down Expand Up @@ -166,9 +168,9 @@ class KotlinPoetSourceGenerator : SourceGenerator {
private fun writeClass(writer: Writer, classDef: ClassDef) {
val classBuilder = TypeSpec.classBuilder(classDef.simpleName)
classBuilder.addModifiers(asKModifiers(classDef.modifiers))
classDef.typeVariables.stream().map { tv: TypeDef.TypeVariable -> this.asTypeVariable(tv) }
classDef.typeVariables.stream().map { tv: TypeDef.TypeVariable -> this.asTypeVariable(tv, classDef) }
.forEach { typeVariable: TypeVariableName -> classBuilder.addTypeVariable(typeVariable) }
classDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef) }
classDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef, classDef) }
.forEach { it: TypeName ->
classBuilder.addSuperinterface(
it
Expand All @@ -189,15 +191,17 @@ class KotlinPoetSourceGenerator : SourceGenerator {
property.modifiers,
property.annotations,
property.javadoc,
null
null,
classDef
)
} else {
propertySpec = buildConstructorProperty(
property.name,
property.type,
property.modifiers,
property.annotations,
property.javadoc
property.javadoc,
classDef
)
notNullProperties.add(property)
}
Expand All @@ -212,7 +216,7 @@ class KotlinPoetSourceGenerator : SourceGenerator {
.map { prop: PropertyDef ->
ParameterSpec.builder(
prop.name,
asType(prop.type)
asType(prop.type, classDef)
).build()
}.toList()
).build()
Expand All @@ -225,11 +229,11 @@ class KotlinPoetSourceGenerator : SourceGenerator {
companionBuilder = TypeSpec.companionObjectBuilder()
}
companionBuilder.addProperty(
buildNullableProperty(field, stripStatic(modifiers), field.javadoc)
buildNullableProperty(field, stripStatic(modifiers), field.javadoc, classDef)
)
} else {
classBuilder.addProperty(
buildNullableProperty(field, modifiers, field.javadoc)
buildNullableProperty(field, modifiers, field.javadoc, classDef)
)
}
}
Expand Down Expand Up @@ -264,9 +268,9 @@ class KotlinPoetSourceGenerator : SourceGenerator {
val classBuilder = TypeSpec.classBuilder(recordDef.simpleName)
classBuilder.addModifiers(KModifier.DATA)
classBuilder.addModifiers(asKModifiers(recordDef.modifiers))
recordDef.typeVariables.stream().map { tv: TypeDef.TypeVariable -> this.asTypeVariable(tv) }
recordDef.typeVariables.stream().map { tv: TypeDef.TypeVariable -> this.asTypeVariable(tv, recordDef) }
.forEach { typeVariable: TypeVariableName -> classBuilder.addTypeVariable(typeVariable) }
recordDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef) }
recordDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef, recordDef) }
.forEach { it: TypeName ->
classBuilder.addSuperinterface(
it,
Expand All @@ -286,7 +290,8 @@ class KotlinPoetSourceGenerator : SourceGenerator {
property.type,
extendModifiers(property.modifiers, Modifier.FINAL),
property.annotations,
property.javadoc
property.javadoc,
recordDef
)
)
}
Expand All @@ -297,7 +302,7 @@ class KotlinPoetSourceGenerator : SourceGenerator {
.map { prop: PropertyDef ->
ParameterSpec.builder(
prop.name,
asType(prop.type)
asType(prop.type, recordDef)
).build()
}.toList()
).build()
Expand Down Expand Up @@ -333,7 +338,7 @@ class KotlinPoetSourceGenerator : SourceGenerator {
private fun writeEnumDef(writer: Writer, enumDef: EnumDef) {
val enumBuilder = TypeSpec.enumBuilder(enumDef.simpleName)
enumBuilder.addModifiers(asKModifiers(enumDef.modifiers))
enumDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef) }
enumDef.superinterfaces.stream().map { typeDef: TypeDef -> this.asType(typeDef, enumDef) }
.forEach { it: TypeName -> enumBuilder.addSuperinterface(it) }
enumDef.javadoc.forEach(Consumer { format: String -> enumBuilder.addKdoc(format) })
enumDef.annotations.stream().map { annotationDef: AnnotationDef -> asAnnotationSpec(annotationDef) }
Expand Down Expand Up @@ -374,11 +379,12 @@ class KotlinPoetSourceGenerator : SourceGenerator {
typeDef: TypeDef,
modifiers: Set<Modifier>,
annotations: List<AnnotationDef>,
docs: List<String>, initializer: ExpressionDef?
docs: List<String>, initializer: ExpressionDef?,
objectDef: ObjectDef?
): PropertySpec {
val propertyBuilder = PropertySpec.builder(
name,
asType(typeDef),
asType(typeDef, objectDef),
asKModifiers(modifiers)
)
docs.forEach(Consumer { format: String -> propertyBuilder.addKdoc(format) })
Expand Down Expand Up @@ -409,11 +415,12 @@ class KotlinPoetSourceGenerator : SourceGenerator {
typeDef: TypeDef,
modifiers: Set<Modifier>,
annotations: List<AnnotationDef>,
docs: List<String>
docs: List<String>,
objectDef: ObjectDef?
): PropertySpec {
val propertyBuilder = PropertySpec.builder(
name,
asType(typeDef),
asType(typeDef, objectDef),
asKModifiers(modifiers)
)
docs.forEach(Consumer { format: String -> propertyBuilder.addKdoc(format) })
Expand All @@ -430,22 +437,23 @@ class KotlinPoetSourceGenerator : SourceGenerator {
.build()
}

private fun buildNullableProperty(field: FieldDef, modifiers: Set<Modifier>, docs: List<String>): PropertySpec {
private fun buildNullableProperty(field: FieldDef, modifiers: Set<Modifier>, docs: List<String>, objectDef: ObjectDef?): PropertySpec {
return buildNullableProperty(
field.name,
field.type,
modifiers,
field.annotations,
docs,
field.initializer.orElse(null)
field.initializer.orElse(null),
objectDef
)
}

private fun buildFunction(objectDef: ObjectDef?, method: MethodDef, modifiers: Set<Modifier>): FunSpec {
var funBuilder = if (method.name == "<init>") {
FunSpec.constructorBuilder()
} else {
FunSpec.builder(method.name).returns(asType(method.returnType))
FunSpec.builder(method.name).returns(asType(method.returnType, objectDef))
}
funBuilder = funBuilder
.addModifiers(asKModifiers(modifiers))
Expand All @@ -454,7 +462,7 @@ class KotlinPoetSourceGenerator : SourceGenerator {
.map { param: ParameterDef ->
ParameterSpec.builder(
param.name,
asType(param.type)
asType(param.type, objectDef)
).build()
}
.toList()
Expand All @@ -472,12 +480,17 @@ class KotlinPoetSourceGenerator : SourceGenerator {
}

@OptIn(KotlinPoetJavaPoetPreview::class)
private fun asType(typeDef: TypeDef): TypeName {
val result: TypeName = if (typeDef is TypeDef.Array) {
asArray(typeDef)
private fun asType(typeDef: TypeDef, objectDef: ObjectDef?): TypeName {
val result: TypeName = if (typeDef == TypeDef.THIS) {
if (objectDef == null) {
throw java.lang.IllegalStateException("This type is used outside of the instance scope!")
}
asType(objectDef.asTypeDef(), null)
} else if (typeDef is TypeDef.Array) {
asArray(typeDef, objectDef)
} else if (typeDef is ClassTypeDef.Parameterized) {
asClassName(typeDef.rawType).parameterizedBy(
typeDef.typeArguments.map { v: TypeDef -> this.asType(v) }
typeDef.typeArguments.map { v: TypeDef -> this.asType(v, objectDef) }
)
} else if (typeDef is TypeDef.Primitive) {
when (typeDef.name) {
Expand All @@ -498,18 +511,20 @@ class KotlinPoetSourceGenerator : SourceGenerator {
if (typeDef.lowerBounds.isNotEmpty()) {
WildcardTypeName.consumerOf(
asType(
typeDef.lowerBounds[0]
typeDef.lowerBounds[0],
objectDef
)
)
} else {
WildcardTypeName.producerOf(
asType(
typeDef.upperBounds[0]
typeDef.upperBounds[0],
objectDef
)
)
}
} else if (typeDef is TypeDef.TypeVariable) {
return asTypeVariable(typeDef)
return asTypeVariable(typeDef, objectDef)
} else {
throw IllegalStateException("Unrecognized type definition $typeDef")
}
Expand All @@ -519,19 +534,19 @@ class KotlinPoetSourceGenerator : SourceGenerator {
return result
}

private fun asArray(classType: TypeDef.Array): TypeName {
private fun asArray(classType: TypeDef.Array, objectDef: ObjectDef?): TypeName {
var newDef = ClassTypeDef.Parameterized(
ClassTypeDef.of("kotlin.Array"), listOf(classType.componentType))
for (i in 2.. classType.dimensions) {
newDef = ClassTypeDef.Parameterized(ClassTypeDef.of("kotlin.Array"), listOf(newDef))
}
return this.asType(newDef)
return this.asType(newDef, objectDef)
}

private fun asTypeVariable(tv: TypeDef.TypeVariable): TypeVariableName {
private fun asTypeVariable(tv: TypeDef.TypeVariable, objectDef: ObjectDef?): TypeVariableName {
return TypeVariableName(
tv.name,
tv.bounds.stream().map { v: TypeDef -> this.asType(v) }.toList()
tv.bounds.stream().map { v: TypeDef -> this.asType(v, objectDef) }.toList()
)
}

Expand Down Expand Up @@ -657,7 +672,7 @@ class KotlinPoetSourceGenerator : SourceGenerator {
)
}
if (expressionDef is ExpressionDef.Convert) {
val expResult = renderVariable(objectDef, methodDef, expressionDef.variable)
val expResult = renderExpression(objectDef, methodDef, expressionDef.expressionDef)
val resultType = expressionDef.type
return ExpResult(
renderWithNotNullAssertion(expResult, resultType),
Expand All @@ -673,7 +688,7 @@ class KotlinPoetSourceGenerator : SourceGenerator {
private fun renderVariable(
objectDef: ObjectDef?,
methodDef: MethodDef,
variableDef: VariableDef
variableDef: ExpressionDef
): ExpResult {
if (variableDef is VariableDef.MethodParameter) {
methodDef.getParameter(variableDef.name) // Check if exists
Expand All @@ -686,7 +701,7 @@ class KotlinPoetSourceGenerator : SourceGenerator {
} else {
throw IllegalStateException("Field access no supported on the object definition: $objectDef")
}
val expResult = renderVariable(objectDef, methodDef, variableDef.instanceVariable)
val expResult = renderVariable(objectDef, methodDef, variableDef.instance)
val builder = expResult.rendered.toBuilder()
if (expResult.type.isNullable) {
builder.add("!!")
Expand Down
Loading
Loading