Merge pull request #67 from ZenWave360/feature/avro-schema-generator

Feature/avro schema generator

Author: ivangsa

.github/workflows/main.yml

@@ -39,6 +39,7 @@ jobs:
           generate-summary: true
           jacoco-csv-file: >
             ./plugins/asyncapi-spring-cloud-streams3/target/site/jacoco/jacoco.csv
+            ./plugins/avro-schema-compiler/target/site/jacoco/jacoco.csv
             ./plugins/java-to-jdl/target/site/jacoco/jacoco.csv
             ./plugins/java-to-asyncapi/target/site/jacoco/jacoco.csv
             ./plugins/backend-application-default/target/site/jacoco/jacoco.csv

.github/workflows/publish-maven-central.yml

@@ -51,6 +51,7 @@ jobs:
           generate-summary: true
           jacoco-csv-file: >
             ./plugins/asyncapi-spring-cloud-streams3/target/site/jacoco/jacoco.csv
+            ./plugins/avro-schema-compiler/target/site/jacoco/jacoco.csv
             ./plugins/java-to-jdl/target/site/jacoco/jacoco.csv
             ./plugins/java-to-asyncapi/target/site/jacoco/jacoco.csv
             ./plugins/backend-application-default/target/site/jacoco/jacoco.csv

.github/workflows/publish-maven-snapshots.yml

@@ -44,6 +44,7 @@ jobs:
           generate-summary: true
           jacoco-csv-file: >
             ./plugins/asyncapi-spring-cloud-streams3/target/site/jacoco/jacoco.csv
+            ./plugins/avro-schema-compiler/target/site/jacoco/jacoco.csv
             ./plugins/java-to-jdl/target/site/jacoco/jacoco.csv
             ./plugins/java-to-asyncapi/target/site/jacoco/jacoco.csv
             ./plugins/backend-application-default/target/site/jacoco/jacoco.csv

plugins/avro-schema-compiler/README.md

@@ -0,0 +1,5 @@
+# Avro Schema Generator
+> 👉 ZenWave360 Helps You Create Software Easy to Understand
+
+[![Maven Central](https://img.shields.io/maven-central/v/io.zenwave360.sdk/zenwave-sdk.svg?label=Maven%20Central&logo=apachemaven)](https://search.maven.org/artifact/io.zenwave360.sdk/zenwave-sdk)
+[![GitHub](https://img.shields.io/github/license/ZenWave360/zenwave-sdk)](https://github.com/ZenWave360/zenwave-sdk/blob/main/LICENSE)

plugins/avro-schema-compiler/pom.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.zenwave360.sdk</groupId>
+        <artifactId>plugins-parent</artifactId>
+        <version>2.1.0-SNAPSHOT</version>
+    </parent>
+    <name>${project.groupId}:${project.artifactId}</name>
+    <groupId>io.zenwave360.sdk.plugins</groupId>
+    <artifactId>avro-schema-compiler</artifactId>
+    <packaging>jar</packaging>
+
+    <properties>
+        <avro-compiler.version>1.12.0</avro-compiler.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.avro</groupId>
+            <artifactId>avro-compiler</artifactId>
+            <version>${avro-compiler.version}</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+</project>

plugins/avro-schema-compiler/src/main/java/io/zenwave360/sdk/plugins/AvroCompilerProperties.java

@@ -0,0 +1,59 @@
+package io.zenwave360.sdk.plugins;
+
+import io.zenwave360.sdk.doc.DocumentedOption;
+import org.apache.avro.Conversion;
+import org.apache.avro.LogicalTypes;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+public class AvroCompilerProperties {
+
+    @DocumentedOption(description = "Avro schema file or folder containing avro schemas")
+    public File sourceDirectory;
+
+    @DocumentedOption(description = "Avro schema files or folders containing avro schemas")
+    public List<String> imports;
+
+    @DocumentedOption(description = "A set of Ant-like inclusion patterns used to select files from the source tree that are to be processed. By default, the pattern **\\/*.avsc is used to include all avro schema files.")
+    public List<String> includes = List.of("**/*.avsc");
+
+    @DocumentedOption(description = "A set of Ant-like exclusion patterns used to prevent certain files from being processed. By default, this set is empty such that no files are excluded.")
+    public List<String> excludes;
+
+    public String templateDirectory = "/org/apache/avro/compiler/specific/templates/java/classic/";
+    public String stringType = "CharSequence";
+    public String fieldVisibility = "PRIVATE";
+    public boolean createOptionalGetters = false;
+    public boolean gettersReturnOptional = false;
+    public boolean optionalGettersForNullableFieldsOnly = false;
+    public boolean createSetters = true;
+    public boolean createNullSafeAnnotations = false;
+    public String nullSafeAnnotationNullable = "org.jetbrains.annotations.Nullable";
+    public String nullSafeAnnotationNotNull = "org.jetbrains.annotations.NotNull";
+    public boolean enableDecimalLogicalType = false;
+    public String outputCharacterEncoding = "UTF-8";
+    public List<String> velocityToolsClassesNames = new ArrayList<>();
+    public String recordSpecificClass = "org.apache.avro.specific.SpecificRecordBase";
+    public String errorSpecificClass = "org.apache.avro.specific.SpecificExceptionBase";
+
+    @DocumentedOption(description = "Custom Logical Type Factories")
+    public List<Class<? extends LogicalTypes.LogicalTypeFactory>> customLogicalTypeFactories;
+
+    @DocumentedOption(description = "Custom Conversions")
+    public List<Class<? extends Conversion<?>>> customConversions;
+
+    public List<Object> instantiateAdditionalVelocityTools() {
+        final List<Object> velocityTools = new ArrayList<>(velocityToolsClassesNames.size());
+        for (String velocityToolClassName : velocityToolsClassesNames) {
+            try {
+                Class<?> klass = Class.forName(velocityToolClassName);
+                velocityTools.add(klass.getDeclaredConstructor().newInstance());
+            } catch (Exception e) {
+                throw new RuntimeException(e);
+            }
+        }
+        return velocityTools;
+    }
+}