[fj-doc-maven-plugin] goal init, new flavour : springboot-3

fugerit79 · fugerit79 · commit 8f9ea6d0f4f4 · 2024-09-10T23:23:54.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- [fj-doc-maven-plugin] goal init, new flavour : springboot-3
 - [fj-doc-maven-plugin] goal init, Quarkus and Micronaut generation based on freemarker macros.
 
 ### Fixed
diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourFacade.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourFacade.java
@@ -29,7 +29,9 @@ private FlavourFacade() {}
 
     public static final String FLAVOUR_MICRONAUT_4 = "micronaut-4";
 
-    public static final Set<String> SUPPORTED_FLAVOURS = Collections.unmodifiableSet( new HashSet<>( Arrays.asList( FLAVOUR_VANILLA, FLAVOUR_QUARKUS_3, FLAVOUR_QUARKUS_2, FLAVOUR_MICRONAUT_4 ) ) );
+    public static final String FLAVOUR_SPRINGBOOT_3 = "springboot-3";
+
+    public static final Set<String> SUPPORTED_FLAVOURS = Collections.unmodifiableSet( new HashSet<>( Arrays.asList( FLAVOUR_VANILLA, FLAVOUR_QUARKUS_3, FLAVOUR_QUARKUS_2, FLAVOUR_MICRONAUT_4, FLAVOUR_SPRINGBOOT_3 ) ) );
 
     private static final Properties MAP_FLAVOURS = SafeFunction.get( () -> {
         Properties prop = new Properties();
diff --git a/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3-copy.txt b/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3-copy.txt
@@ -0,0 +1 @@
+HELP.md
diff --git a/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3/src/main/java/org/fugerit/java/template/fugerit_springboot3_template/FugeritSpringboot3TemplateApplication.java b/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3/src/main/java/org/fugerit/java/template/fugerit_springboot3_template/FugeritSpringboot3TemplateApplication.java
diff --git a/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3/src/main/resources/application.properties b/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3/src/main/resources/application.properties
diff --git a/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3/src/test/java/org/fugerit/java/template/fugerit_springboot3_template/FugeritSpringboot3TemplateApplicationTests.java b/fj-doc-maven-plugin/src/main/resources/config/flavour/springboot-3/src/test/java/org/fugerit/java/template/fugerit_springboot3_template/FugeritSpringboot3TemplateApplicationTests.java
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/flavour-macro.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/flavour-macro.ftl
@@ -41,4 +41,9 @@
 <#macro createMicronautPath context outputMime outputExtension outputDescription>
     @Get(uri="/example.${outputExtension}", produces="${outputMime}")
     <@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
+</#macro>
+
+<#macro createSpringBootPath context outputMime outputExtension outputDescription>
+    @GetMapping(value = "/example.${outputExtension}", produces = "${outputMime}" )
+    <@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
 </#macro>
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3-fm-yml.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3-fm-yml.ftl
@@ -0,0 +1,20 @@
+<#import 'flavour-macro.ftl' as fhm>
+---
+flavour: springboot-3
+process:
+  - from: flavour/springboot-3/pom.ftl
+    to: ${context.projectFolder}/pom.xml
+  - from: flavour/springboot-3/README.ftl
+    to: ${context.projectFolder}/README.md
+  - from: flavour/springboot-3/gitignore.ftl
+    to: ${context.projectFolder}/.gitignore
+  - from: flavour/springboot-3/SpringbootApplication.ftl
+    to: ${context.projectFolder}/src/main/java/<@fhm.toProjectPackageFolder context=context/>/${context.artifactIdAsClassName}Application.java
+  - from: flavour/springboot-3/DocController.ftl
+    to: ${context.projectFolder}/src/main/java/<@fhm.toProjectPackageFolder context=context/>/DocController.java
+  - from: flavour/springboot-3/SpringbootApplication.ftl
+    to: ${context.projectFolder}/src/main/java/<@fhm.toProjectPackageFolder context=context/>/${context.artifactIdAsClassName}Application.java
+  - from: flavour/springboot-3/SpringbootApplicationTests.ftl
+    to: ${context.projectFolder}/src/test/java/test/<@fhm.toProjectPackageFolder context=context/>/${context.artifactIdAsClassName}ApplicationTests.java
+  - from: flavour/springboot-3/application.ftl
+    to: ${context.projectFolder}/src/main/resources/application.yaml
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/DocController.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/DocController.ftl
@@ -0,0 +1,41 @@
+<#import '../flavour-macro.ftl' as fhm>
+package <@fhm.toProjectPackage context=context/>;
+
+import org.fugerit.java.core.cfg.ConfigRuntimeException;
+import org.fugerit.java.doc.base.config.DocConfig;
+import org.fugerit.java.doc.base.process.DocProcessContext;
+
+import java.io.ByteArrayOutputStream;
+import java.util.Arrays;
+import java.util.List;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import lombok.extern.slf4j.Slf4j;
+
+@RestController
+@RequestMapping("/doc")
+@Slf4j
+public class DocController {
+
+    <@fhm.createDocumentProcess context=context exceptionType='ConfigRuntimeException'/>
+
+    <@fhm.createSpringBootPath context=context outputMime="text/markdown" outputExtension="md" outputDescription="Markdown"/>
+    
+    <@fhm.createSpringBootPath context=context outputMime="text/html" outputExtension="html" outputDescription="HTML"/>
+    
+    <#if context.modules?seq_contains("fj-doc-mod-fop")>
+    <@fhm.createSpringBootPath context=context outputMime="application/pdf" outputExtension="pdf" outputDescription="PDF"/>
+    </#if>
+    
+    <#if context.modules?seq_contains("fj-doc-mod-poi")>
+    <@fhm.createSpringBootPath context=context outputMime="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" outputExtension="xlsx" outputDescription="Excel"/>
+    </#if>
+    
+    <#if context.modules?seq_contains("fj-doc-mod-opencsv")>
+    <@fhm.createSpringBootPath context=context outputMime="text/csv" outputExtension="csv" outputDescription="CSV"/>
+    </#if>
+
+}
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/README.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/README.ftl
@@ -0,0 +1,38 @@
+# ${context.artifactId}
+
+## Quickstart
+
+Requirement :
+- maven 3.9.x
+- java ${context.javaRelease}+
+
+1. Start the app
+
+```shell
+mvn spring-boot:run
+```
+
+2. Try the app
+
+Open the [openapi-explorer](http://localhost:8080/swagger-ui/index.html)
+
+Test available routes (for instance : [/doc/example.md](http://localhost:8080/doc/example.md))
+
+## Projects notes
+
+the project used as template has been created with the
+[springboot initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=3.3.3&packaging=jar&jvmVersion=21&groupId=org.fugerit.java.template&artifactId=fugerit-springboot3-template&name=fugerit-springboot3-template&description=Fugerit%20SpringBoot%20Template&packageName=org.fugerit.java.template.fugerit-springboot3-template&dependencies=web,native,devtools,lombok).
+
+Springdoc openapi dependency has been added :
+
+```xml
+<dependency>
+    <groupId>org.springdoc</groupId>
+    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+    <version>${r"${springdoc-openapi-ui-version}"}</version>
+</dependency>
+```
+
+## Spring Boot documentation
+
+Read the original [HELP.md](HELP.md)
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/SpringbootApplication.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/SpringbootApplication.ftl
@@ -0,0 +1,14 @@
+<#import '../flavour-macro.ftl' as fhm>
+package <@fhm.toProjectPackage context=context/>;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class ${context.artifactIdAsClassName}Application {
+
+	public static void main(String[] args) {
+		SpringApplication.run(${context.artifactIdAsClassName}Application.class, args);
+	}
+
+}
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/SpringbootApplicationTests.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/SpringbootApplicationTests.ftl
@@ -0,0 +1,14 @@
+<#import '../flavour-macro.ftl' as fhm>
+package test.<@fhm.toProjectPackage context=context/>;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class ${context.artifactIdAsClassName}ApplicationTests {
+
+	@Test
+	void contextLoads() {
+	}
+
+}
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/application.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/application.ftl
@@ -0,0 +1,3 @@
+spring:
+  application:
+    name: ${context.artifactId}
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/gitignore.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/gitignore.ftl
diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/pom.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/pom.ftl
@@ -8,9 +8,9 @@
 		<version>3.3.3</version>
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
-	<groupId>org.fugerit.java.template</groupId>
-	<artifactId>fugerit-springboot3-template</artifactId>
-	<version>0.0.1-SNAPSHOT</version>
+	<groupId>${context.groupId}</groupId>
+	<artifactId>${context.artifactId}</artifactId>
+	<version>${context.projectVersion}</version>
 	<name>fugerit-springboot3-template</name>
 	<description>Fugerit SpringBoot Template</description>
 	<url/>
@@ -27,14 +27,21 @@
 		<url/>
 	</scm>
 	<properties>
-		<java.version>21</java.version>
+		<java.version>${context.javaRelease}</java.version>
+		<springdoc-openapi-ui-version>2.6.0</springdoc-openapi-ui-version>
 	</properties>
 	<dependencies>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+			<version>${r"${springdoc-openapi-ui-version}"}</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-devtools</artifactId>
diff --git a/fj-doc-playground-quarkus/src/main/react/src/playground/DocProjectInit.jsx b/fj-doc-playground-quarkus/src/main/react/src/playground/DocProjectInit.jsx
@@ -213,6 +213,7 @@ const DocProjectInit = () => {
 							<MenuItem value={'quarkus-3'}>Quarkus 3 (Recommended quarkus version)</MenuItem>
 							<MenuItem value={'quarkus-2'}>Quarkus 2 (Legacy quarkus version)</MenuItem>
 							<MenuItem value={'micronaut-4'}>Micronaut 4</MenuItem>
+							<MenuItem value={'micronaut-3'}>SpringBoot 3</MenuItem>
 						</Select>
 					</FormControl>
 				</Grid>
