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

Improve multi-lingual and gradle plugin support of json schema generator #115

Merged
merged 5 commits into from
Jan 13, 2025
Merged

Improve multi-lingual and gradle plugin support of json schema generator #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
13d5d63
move all ann.s to aggregator with full names
elifKurtay Dec 24, 2024
9059141
Merge branch 'micronaut-projects:1.3.x' into kotlin-generation-from-s…
elifKurtay Dec 24, 2024
02e3b7c
Merge branch 'micronaut-projects:1.3.x' into kotlin-generation-from-s…
elifKurtay Jan 6, 2025
6e316da
adjustments for gradle plugin
elifKurtay Jan 10, 2025
aadcfc1
Merge branch 'micronaut-projects:1.3.x' into kotlin-generation-from-s…
elifKurtay Jan 13, 2025
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
10 changes: 8 additions & 2 deletions buildSrc/src/main/groovy/io/micronaut/build/internal/generator/BeanGeneratorTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,14 @@ public abstract class BeanGeneratorTask extends DefaultTask {

@Internal
public Provider<Directory> getGeneratedSourcesDirectory() {
String lang = getLanguage().get();
return lang.equalsIgnoreCase("JAVA") ? getOutputDirectory().dir("java/main") : getOutputDirectory().dir("kotlin/main");
String lang = getLanguage().get().toUpperCase();
var langPath = switch (lang) {
case "JAVA" -> "java/main";
case "KOTLIN" -> "kotlin/main";
case "GROOVY" -> "groovy/main";
default -> "main";
};
return getOutputDirectory().dir(langPath);
}

@Inject
Expand Down
3 changes: 1 addition & 2 deletions json-schema-generator/src/main/java/io/micronaut/jsonschema/generator/GeneratorMain.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
package io.micronaut.jsonschema.generator;

import io.micronaut.core.annotation.Internal;
import io.micronaut.inject.visitor.VisitorContext;
import io.micronaut.jsonschema.generator.loaders.UrlLoader;
import io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig;

Expand Down Expand Up @@ -64,7 +63,7 @@ public static void main(String[] args) throws IOException {
if (!args[2].isBlank()) {
inputFolder = Paths.get(args[2]);
}
var lang = VisitorContext.Language.valueOf(args[3].toUpperCase());
var lang = args[3].toUpperCase();
Path outputPath = Paths.get(args[4]);
String outputPackageName = args[5];
String outputFileName = args[6];
Expand Down
62 changes: 17 additions & 45 deletions json-schema-generator/src/main/java/io/micronaut/jsonschema/generator/SourceGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@
*/
package io.micronaut.jsonschema.generator;

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonValue;
import io.micronaut.core.annotation.Internal;
import io.micronaut.inject.processing.ProcessingException;
import io.micronaut.inject.visitor.VisitorContext;
Expand All @@ -30,7 +23,6 @@
import io.micronaut.jsonschema.generator.utils.GeneratorContext;
import io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig;
import io.micronaut.jsonschema.model.Schema;
import io.micronaut.serde.annotation.Serdeable;
import io.micronaut.sourcegen.generator.SourceGenerators;
import io.micronaut.sourcegen.model.*;

Expand All @@ -52,9 +44,8 @@
import java.util.stream.Stream;

import static io.micronaut.core.util.StringUtils.capitalize;
import static io.micronaut.jsonschema.generator.loaders.FileProcessor.getFileName;
import static io.micronaut.jsonschema.generator.loaders.FileProcessor.getJsonSchema;
import static io.micronaut.jsonschema.generator.loaders.FileProcessor.getOutputFile;
import static io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator.*;
import static io.micronaut.jsonschema.generator.loaders.FileProcessor.*;
import static io.micronaut.jsonschema.generator.aggregator.TypeAggregator.*;
import static io.micronaut.jsonschema.model.Schema.DEF_SCHEMA_REF_PREFIX;

Expand Down Expand Up @@ -85,13 +76,13 @@ private enum ObjectType { CLASS, RECORD, INTERFACE, ENUM }
* is thrown.
* </p>
*
* @param language The {@link VisitorContext.Language} representing the target programming language
* @param lang The String representing the target programming language
* for which the source generator is to be created. This argument cannot be {@code null}.
* @throws RuntimeException if no matching source generator is found for the provided language.
* The exception message will indicate the language for which no generator was found.
*/
public SourceGenerator(VisitorContext.Language language) {
this(language, new GeneratorContext());
public SourceGenerator(String lang) {
this(VisitorContext.Language.valueOf(lang.toUpperCase()), new GeneratorContext());
}

/**
Expand Down Expand Up @@ -312,7 +303,7 @@ private File generateFromSchema(Schema jsonSchema, Path outputPath, String packa
public EnumDef buildEnum(Schema jsonSchema, String builderClassName) {
EnumDef.EnumDefBuilder enumBuilder = EnumDef.builder(builderClassName)
.addModifiers(Modifier.PUBLIC)
.addAnnotation(Serdeable.class);
.addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));
boolean isComplexEnum = false;
LinkedHashMap<ExpressionDef.Constant, ExpressionDef> cases = new LinkedHashMap<>();
LinkedHashMap<String, Object> enumValues = new LinkedHashMap<>();
Expand Down Expand Up @@ -367,13 +358,13 @@ public EnumDef buildEnum(Schema jsonSchema, String builderClassName) {
.addAllFieldsConstructor(Modifier.PRIVATE)
.addMethod(MethodDef.builder("getValue")
.addModifiers(Modifier.PUBLIC)
.addAnnotation(JsonValue.class)
.addAnnotation(ClassTypeDef.of(JSON_VALUE_ANN))
.returns(valueTypeDef)
.build((aThis, parameters) ->
aThis.field("value", valueTypeDef).returning()))
.addMethod(MethodDef.builder("statusOf")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.addAnnotation(JsonCreator.class)
.addAnnotation(ClassTypeDef.of(JSON_CREATOR_ANN))
.returns(TypeDef.THIS)
.addParameter("value", valueTypeDef)
.build((aThis, parameters) ->
Expand All @@ -387,7 +378,7 @@ public EnumDef buildEnum(Schema jsonSchema, String builderClassName) {
private RecordDef buildRecord(Schema jsonSchema, String builderClassName) {
RecordDef.RecordDefBuilder objectBuilder = RecordDef.builder(builderClassName)
.addModifiers(Modifier.PUBLIC)
.addAnnotation(Serdeable.class);
.addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));

addFields(jsonSchema, objectBuilder);
return objectBuilder.build();
Expand All @@ -396,7 +387,7 @@ private RecordDef buildRecord(Schema jsonSchema, String builderClassName) {
private ClassDef buildClass(Schema jsonSchema, String builderClassName) {
ClassDef.ClassDefBuilder objectBuilder = ClassDef.builder(builderClassName)
.addModifiers(Modifier.PUBLIC)
.addAnnotation(Serdeable.class);
.addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));

if (context.hasDefinition(inputFileName + "/superClass")) {
var superClass = context.getDefinitionType(inputFileName + "/superClass");
Expand All @@ -412,11 +403,7 @@ private ClassDef buildClass(Schema jsonSchema, String builderClassName) {
addFields(jsonSchema, objectBuilder);

if (!discriminatorProperty.isBlank()) {
AnnotationDef jsonTypeInfo = AnnotationDef.builder(JsonTypeInfo.class)
.addMember("use", JsonTypeInfo.Id.NAME)
.addMember("property", discriminatorProperty)
.build();
objectBuilder.addAnnotation(jsonTypeInfo);
objectBuilder.addAnnotation(getJsonTypeInfoAnn(discriminatorProperty));

Map<String, Schema> properties = jsonSchema.getProperties();
if (properties.containsKey(discriminatorProperty)) {
Expand All @@ -434,16 +421,12 @@ private ClassDef buildClass(Schema jsonSchema, String builderClassName) {
private InterfaceDef buildInterface(Schema jsonSchema, String builderClassName) {
InterfaceDef.InterfaceDefBuilder objectBuilder = InterfaceDef.builder(builderClassName)
.addModifiers(Modifier.PUBLIC)
.addAnnotation(Serdeable.class);
.addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));
if (jsonSchema.hasDiscriminator()) {
// top level interface
addDiscriminatorAnnotations(jsonSchema, objectBuilder);
if (!discriminatorProperty.isBlank()) {
AnnotationDef jsonTypeInfo = AnnotationDef.builder(JsonTypeInfo.class)
.addMember("use", JsonTypeInfo.Id.NAME)
.addMember("property", discriminatorProperty)
.build();
objectBuilder.addAnnotation(jsonTypeInfo);
objectBuilder.addAnnotation(getJsonTypeInfoAnn(discriminatorProperty));
}
}
return objectBuilder.build();
Expand Down Expand Up @@ -489,7 +472,7 @@ private void addAdditionalField(Schema jsonSchema, ObjectDefBuilder builder) {
builder.addMethod(MethodDef.builder("getUnknownFields")
.addModifiers(Modifier.PUBLIC)
.returns(type)
.addAnnotation(JsonAnyGetter.class)
.addAnnotation(ClassTypeDef.of(JSON_ANY_GETTER_ANN))
.build((aThis, parameters) -> {
if (builder instanceof ClassDef.ClassDefBuilder) {
return aThis.field("unknownFields", type).returning();
Expand All @@ -499,7 +482,7 @@ private void addAdditionalField(Schema jsonSchema, ObjectDefBuilder builder) {
builder.addMethod(MethodDef.builder("setUnknownFields")
.addModifiers(Modifier.PUBLIC)
.returns(TypeDef.VOID)
.addAnnotation(JsonAnySetter.class)
.addAnnotation(ClassTypeDef.of(JSON_ANY_SETTER_ANN))
.addParameter("name", TypeDef.STRING)
.addParameter("value", mapType)
.build((aThis, parameters) -> {
Expand All @@ -520,8 +503,7 @@ private void addField(ObjectDefBuilder objectBuilder, String propertyName, Schem
String name = getPropertyName(propertyName);
PropertyDef.PropertyDefBuilder propertyDef = PropertyDef.builder(name);
if (!name.equals(propertyName)) {
AnnotationDef annotationDef = AnnotationDef.builder(JsonProperty.class).addMember("value", propertyName).build();
propertyDef.addAnnotation(annotationDef);
propertyDef.addAnnotation(getJsonPropertyAnn(propertyName));
}

TypeDef propertyType = getPropertyType(objectBuilder, schema, name);
Expand Down Expand Up @@ -575,17 +557,7 @@ private void addDiscriminatorAnnotations(Schema jsonSchema, ObjectDefBuilder obj
}
var discriminator = jsonSchema.getDiscriminator();
discriminatorProperty = discriminator.propertyName();

List<AnnotationDef> subTypeList = discriminator.mapping().entrySet()
.stream()
.map(entry -> AnnotationDef
.builder(JsonSubTypes.Type.class)
.addMember("value", context.getDefinitionType(inputFileName + entry.getValue()))
.addMember("name", entry.getKey())
.build())
.toList();
AnnotationDef jsonSubTypes = AnnotationDef.builder(JsonSubTypes.class).addMember("value", subTypeList).build();
objectBuilder.addAnnotation(jsonSubTypes);
objectBuilder.addAnnotation(getJsonSubTypesAnn(discriminator.mapping(), context));
}

private String getJavadoc(String description) {
Expand Down
49 changes: 48 additions & 1 deletion ...tor/src/main/java/io/micronaut/jsonschema/generator/aggregator/AnnotationsAggregator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,40 @@
*/
package io.micronaut.jsonschema.generator.aggregator;

import com.fasterxml.jackson.annotation.JsonTypeInfo;
import io.micronaut.core.annotation.Internal;
import io.micronaut.inject.visitor.VisitorContext;
import io.micronaut.jsonschema.generator.SourceGenerator;
import io.micronaut.jsonschema.generator.utils.GeneratorContext;
import io.micronaut.jsonschema.model.Schema;
import io.micronaut.sourcegen.model.AnnotationDef;
import io.micronaut.sourcegen.model.ClassTypeDef;
import io.micronaut.sourcegen.model.TypeDef;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import static io.micronaut.jsonschema.generator.SourceGenerator.getInputFileName;

/**
* An aggregator for adding annotation information from json schema.
*
* @author Elif Kurtay
* @since 1.2
* @since 1.3
*/
@Internal
public class AnnotationsAggregator {
public static final String SERDEABLE_ANN = "io.micronaut.serde.annotation.Serdeable";
private static final String JACKSON_VALIDATION_PREFIX = "com.fasterxml.jackson.annotation.";
public static final String JSON_ANY_GETTER_ANN = JACKSON_VALIDATION_PREFIX + "JsonAnyGetter";
public static final String JSON_ANY_SETTER_ANN = JACKSON_VALIDATION_PREFIX + "JsonAnySetter";
public static final String JSON_CREATOR_ANN = JACKSON_VALIDATION_PREFIX + "JsonCreator";
public static final String JSON_VALUE_ANN = JACKSON_VALIDATION_PREFIX + "JsonValue";
private static final String JSON_PROPERTY_ANN = JACKSON_VALIDATION_PREFIX + "JsonProperty";
private static final String JSON_SUB_TYPES_ANN = JACKSON_VALIDATION_PREFIX + "JsonSubTypes";
private static final String JSON_SUB_TYPES_TYPE_ANN = JSON_SUB_TYPES_ANN + ".Type";
private static final String JSON_TYPE_INFO_ANN = JACKSON_VALIDATION_PREFIX + "JsonTypeInfo";

private static final String NULLABLE_ANN = "jakarta.annotation.Nullable";
private static final String JAKARTA_VALIDATION_PREFIX = "jakarta.validation.constraints.";
Expand All @@ -48,6 +65,33 @@ public class AnnotationsAggregator {
private static final int EXCLUSIVE_DELTA_INT = 1;
private static final double EXCLUSIVE_DELTA_DOUBLE = 0.001;

public static AnnotationDef getJsonTypeInfoAnn(String propertyName) {
return AnnotationDef.builder(ClassTypeDef.of(JSON_TYPE_INFO_ANN))
.addMember("use", JsonTypeInfo.Id.NAME)
.addMember("property", propertyName)
.build();
}

public static AnnotationDef getJsonPropertyAnn(String propertyName) {
return AnnotationDef.builder(ClassTypeDef.of(JSON_PROPERTY_ANN))
.addMember("value", propertyName)
.build();
}

public static AnnotationDef getJsonSubTypesAnn(Map<String, String> mapping, GeneratorContext context) {
List<AnnotationDef> subTypeList = mapping.entrySet()
.stream()
.map(entry -> AnnotationDef
.builder(ClassTypeDef.of(JSON_SUB_TYPES_TYPE_ANN))
.addMember("value", context.getDefinitionType(getInputFileName() + entry.getValue()))
.addMember("name", entry.getKey())
.build())
.toList();
return AnnotationDef.builder(ClassTypeDef.of(JSON_SUB_TYPES_ANN))
.addMember("value", subTypeList)
.build();
}

public static List<AnnotationDef> getAnnotations(Schema schema, TypeDef propertyType, boolean required) {
List<AnnotationDef> annotations = new ArrayList<>();
boolean isFloat = propertyType.equals(TypeDef.Primitive.FLOAT) || propertyType.equals(ClassTypeDef.of(Float.class));
Expand Down Expand Up @@ -109,6 +153,9 @@ public static List<AnnotationDef> getAnnotations(Schema schema, TypeDef property
}
if (schema.getPattern() != null && propertyType.equals(TypeDef.STRING)) {
var value = schema.getPattern();
if (SourceGenerator.getLanguage().equals(VisitorContext.Language.GROOVY)) {
value = value.replaceAll("\\$", "");
}
annotations.add(AnnotationDef
.builder(ClassTypeDef.of(PATTERN_ANN))
.addMember("regexp", value).build());
Expand Down
Loading
Loading