Sourcegen Builder Guide

buildSrc/src/main/java/io/micronaut/guides/feature/SourcegenJava.java

@@ -0,0 +1,49 @@
+package io.micronaut.guides.feature;
+
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.starter.application.ApplicationType;
+import io.micronaut.starter.application.generator.GeneratorContext;
+import io.micronaut.starter.build.RequiresMavenLocal;
+import io.micronaut.starter.build.dependencies.Dependency;
+import io.micronaut.starter.build.dependencies.Scope;
+import io.micronaut.starter.feature.Feature;
+import io.micronaut.starter.options.Language;
+import jakarta.inject.Singleton;
+
+@Singleton
+public class SourcegenJava implements RequiresMavenLocal {
+    public static final String ARTIFACT_ID_SOURCEGEN_ANNOTATIONS = "micronaut-sourcegen-annotations";
+    public static final String ARTIFACT_ID_SOURCEGEN_GENERATOR_JAVA = "micronaut-sourcegen-generator-java";
+    public static final String ARTIFACT_ID_SOURCEGEN_GENERATOR_KOTLIN = "micronaut-sourcegen-generator-kotlin";
+
+    @Override
+    public @NonNull String getName() {
+        return "sourcegen-generator";
+    }
+
+    @Override
+    public boolean supports(ApplicationType applicationType) {
+        return true;
+    }
+
+    @Override
+    public void apply(GeneratorContext generatorContext) {
+        addDependencies(generatorContext);
+    }
+
+    protected void addDependencies(GeneratorContext generatorContext) {
+        generatorContext.addDependency(Dependency.builder()
+                .lookupArtifactId(ARTIFACT_ID_SOURCEGEN_ANNOTATIONS)
+                .scope(Scope.COMPILE));
+        if (generatorContext.getLanguage() == Language.JAVA) {
+            generatorContext.addDependency(Dependency.builder()
+                    .lookupArtifactId(ARTIFACT_ID_SOURCEGEN_GENERATOR_JAVA)
+                    .scope(Scope.ANNOTATION_PROCESSOR));
+        } else if (generatorContext.getLanguage() == Language.KOTLIN) {
+            generatorContext.addDependency(Dependency.builder()
+                    .lookupArtifactId(ARTIFACT_ID_SOURCEGEN_GENERATOR_KOTLIN)
+                    .scope(Scope.ANNOTATION_PROCESSOR));
+        }
+    }
+}
+

buildSrc/src/main/resources/pom.xml

@@ -12,6 +12,21 @@
         </repository>
     </repositories>
     <dependencies>
+        <dependency>
+            <groupId>io.micronaut.sourcegen</groupId>
+            <artifactId>micronaut-sourcegen-annotations</artifactId>
+            <version>1.0.0-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+            <groupId>io.micronaut.sourcegen</groupId>
+            <artifactId>micronaut-sourcegen-generator-java</artifactId>
+            <version>1.0.0-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+            <groupId>io.micronaut.sourcegen</groupId>
+            <artifactId>micronaut-sourcegen-generator-kotlin</artifactId>
+            <version>1.0.0-SNAPSHOT</version>
+        </dependency>
         <dependency>
             <groupId>com.github.librepdf</groupId>
             <artifactId>openpdf</artifactId>

guides/micronaut-sourcegen-builder/java/src/main/java/example/micronaut/Widget.java

@@ -0,0 +1,7 @@
+package example.micronaut;
+
+import io.micronaut.sourcegen.annotations.Builder;
+
+@Builder
+public record Widget(String name, int id) {
+}

guides/micronaut-sourcegen-builder/java/src/test/java/example/micronaut/WidgetTest.java

@@ -0,0 +1,19 @@
+package example.micronaut;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class WidgetTest {
+
+    @Test
+    void widgetBuilder() {
+        Widget testWidget = WidgetBuilder.builder()
+                .name("foo")
+                .id(1)
+                .build();
+        assertEquals("foo", testWidget.name());
+        assertEquals(1, testWidget.id());
+    }
+}

guides/micronaut-sourcegen-builder/kotlin/src/main/kotlin/example/micronaut/Widget.kt

@@ -0,0 +1,6 @@
+package example.micronaut
+
+import io.micronaut.sourcegen.annotations.Builder
+
+@Builder
+data class Widget(val name: String, val id: Int)

guides/micronaut-sourcegen-builder/kotlin/src/test/kotlin/example/micronaut/WidgetTest.kt

@@ -0,0 +1,18 @@
+package example.micronaut
+
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Test
+
+
+class WidgetTest {
+
+    @Test
+    fun widgetBuilder() {
+        val testWidget = WidgetBuilder.builder()
+            .name("foo")
+            .id(1)
+            .build()
+        assertEquals("foo", testWidget.name)
+        assertEquals(1, testWidget.id)
+    }
+}

guides/micronaut-sourcegen-builder/metadata.json

@@ -0,0 +1,16 @@
+{
+  "title": "Micronaut Source generation @Builder",
+  "intro": "Learn how to generate a Builder with Micronaut Sourcegen and the @Builder annotation.",
+  "authors": ["Sergio del Amo"],
+  "tags": [],
+  "categories": ["Beyond the Basics"],
+  "publicationDate": "2024-04-24",
+  "languages": ["java"],
+  "apps": [
+    {
+      "validateLicense": false,
+      "name": "default",
+      "features": ["sourcegen-generator"]
+    }
+  ]
+}