flavour extra config yml #333

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] flavour extra configurations <https://github.com/fugerit-org/fj-doc/issues/333>
 - release notes integration <https://github.com/fugerit-org/fj-doc/issues/331>
 - quarkus-version set to 3.19.4 across all the modules
 

fj-doc-guide/src/main/docs/asciidoc/chapters/02_2_maven_plugin_init.adoc

@@ -29,9 +29,12 @@ Project folder will be `./${artifactId}/`.
 NOTE: it is possible to set any property from 'add' goal, except 'projectFolder' which is set to `./${artifactId}`.
 
 [#flavour-list]
+===== Flavours list
+
 [cols="25,20,55", options="header"]
 |====================================================================================================================================
 | flavour      | model | description
+| vanilla       | maven | Vanilla java, with maven packaging
 | quarkus-3        | maven | Based on link:https://quarkus.io/[Quarkus 3], with maven packaging (yaml)
 | quarkus-3-gradle | gradle | Based on link:https://quarkus.io/[Quarkus 3], with gradle packaging (yaml)
 | quarkus-3-gradle-kts | gradle-kts | Based on link:https://quarkus.io/[Quarkus 3], with gradle kotlin packaging (yaml)
@@ -41,3 +44,156 @@ NOTE: it is possible to set any property from 'add' goal, except 'projectFolder'
 | springboot-3        | maven | Based on link:https://spring.io/projects/spring-boot[Sping Boot 3], with maven packaging
 | openliberty        | maven | Based on link:https://openliberty.io/[Open Liberty], with maven packaging
 |====================================================================================================================================
+
+[#flavour-extra-config]
+===== Specific flavour configuration
+
+[#flavour-vanilla]
+====== Vanilla
+
+Vanilla flavour accepts all configuration options.
+
+[#flavour-quarkus-3]
+====== Quarkus 3
+
+Quarkus 3 flavour has the following specific configurations
+
+_Configuration_ : *YAML*
+
+_Java Packaging_ : *Maven*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+
+[#flavour-quarkus-2]
+====== Quarkus 2
+
+Quarkus 2 flavour has the following specific configurations
+
+_Configuration_ : *YAML*
+
+_Java Packaging_ : *Maven*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _11+_      | this flavour does not support java lower than 11
+|====================================================================================================================================
+
+[#flavour-quarkus-3-gradle]
+====== Quarkus 3 Gradle
+
+Quarkus 3 Gradle flavour has the following specific configurations
+
+_Configuration_ : *YAML*
+
+_Java Packaging_ : *Gradle*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+
+[#flavour-quarkus-3-gradle-kts]
+====== Quarkus 3 Gradle KTS
+
+Quarkus 3 Gradle KTS flavour has the following specific configurations
+
+_Configuration_ : *YAML*
+
+_Java Packaging_ : *Gradle with Kotlin DSL*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+
+[#flavour-quarkus-3-properties]
+====== Quarkus 3 Properties
+
+Quarkus 3 properties flavour has the following specific configurations
+
+_Configuration_ : *properties*
+
+_Java Packaging_ : *Maven*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+
+[#flavour-micronaut-4]
+====== Micronaut 4
+
+Micronaut 4 flavour has the following specific configurations
+
+_Configuration_ : *YAML*
+
+_Java Packaging_ : *Maven*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+
+[#flavour-micronaut-4]
+====== Micronaut 4
+
+Micronaut 4 flavour has the following specific configurations
+
+_Configuration_ : *YAML*
+
+_Java Packaging_ : *Maven*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+
+[#flavour-openliberty-properties]
+====== Open Liberty
+
+Open Liberty flavour has the following specific configurations
+
+_Configuration_ : *properties*
+
+_Java Packaging_ : *Maven*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+
+[#flavour-springboot-3]
+====== Spring Boot 3
+
+Spring Boot 3 flavour has the following specific configurations
+
+_Configuration_ : *YAML*
+
+_Java Packaging_ : *Maven*
+
+[cols="3*", options="header"]
+|====================================================================================================================================
+| parameter      | accepted value | note
+| addLombok      | _true_     | currently only generation with lombok is supported
+| javaRelease    | _17+_      | this flavour does not support java lower than 17
+|====================================================================================================================================
+

fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourFacade.java

@@ -9,11 +9,17 @@
 import org.fugerit.java.core.io.StreamIO;
 import org.fugerit.java.core.lang.helpers.ClassHelper;
 import org.fugerit.java.core.lang.helpers.StringUtils;
+import org.fugerit.java.core.lang.helpers.reflect.MethodHelper;
 import org.fugerit.java.core.util.PropsIO;
 import org.fugerit.java.doc.project.facade.flavour.FlavourConfig;
 import org.fugerit.java.doc.project.facade.flavour.ProcessEntry;
+import org.fugerit.java.doc.project.facade.flavour.extra.FlavourExtraConfig;
+import org.fugerit.java.doc.project.facade.flavour.extra.FlavourExtraConfigFacade;
+import org.fugerit.java.doc.project.facade.flavour.extra.ParamConfig;
 
 import java.io.*;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
 import java.util.*;
 
 @Slf4j
@@ -78,6 +84,7 @@ public static void checkFlavour( FlavourContext context, String actualFlavour )
         }
         log.info( "checkFlavour {} done", actualFlavour );
         checkFlavourVersion( context, actualFlavour );
+        checkFlavourExtraConfig( context, actualFlavour );
     }
 
     public static void checkFlavourVersion( FlavourContext context, String actualFlavour ) {
@@ -91,6 +98,53 @@ public static void checkFlavourVersion( FlavourContext context, String actualFla
         }
     }
 
+    public static void checkFlavourExtraConfig( FlavourContext context, String actualFlavour ) {
+        FlavourExtraConfig flavourExtraConfig = SafeFunction.get( () -> {
+            String flavourConfigPath = String.format( "config/flavour-extra-config/%s-config.yml", actualFlavour );
+            log.info( "flavourConfigPath : {}", flavourConfigPath );
+            try (InputStream is = ClassHelper.loadFromDefaultClassLoader( flavourConfigPath ) ) {
+                return FlavourExtraConfigFacade.readConfigBlankDefault( is );
+            }
+        });
+        checkFlavourExtraConfig( context, actualFlavour , flavourExtraConfig );
+    }
+
+    public static void checkFlavourExtraConfigParam( String fieldName, ParamConfig paramConfig, String actualFlavour, Object value  ) {
+        log.debug( "fieldName : {}, value : {}", fieldName, value );
+        if ( value != null && paramConfig.getAcceptOnly() != null && !paramConfig.getAcceptOnly().contains( value.toString() ) ) {
+            log.debug( "accept only list : {} -> {}", fieldName, paramConfig.getAcceptOnly() );
+            String message = String.format( "Value '%s' not valid for flavour '%s' and param '%s', refer to flavour documentation.", value, actualFlavour, fieldName );
+            log.warn( message );
+            throw new ConfigRuntimeException( message );
+        }
+    }
+
+    public static void checkFlavourExtraConfig( FlavourContext context, String actualFlavour, FlavourExtraConfig flavourExtraConfig ) {
+        SafeFunction.applyIfNotNull( flavourExtraConfig.getParamConfig(), () -> {
+            Field[] fields = FlavourContext.class.getDeclaredFields();
+            for (Field field : fields) {
+                String fieldName = field.getName();
+                ParamConfig paramConfig = flavourExtraConfig.getParamConfig().get( fieldName );
+                if ( paramConfig != null ) {
+                    Object value = readField( context, field, fieldName );
+                    checkFlavourExtraConfigParam( fieldName, paramConfig, actualFlavour, value );
+                }
+            }
+        } );
+    }
+
+    public static Object readField( FlavourContext context, Field field, String fieldName ) {
+        return SafeFunction.getSilent( () -> {
+                    if (field.getType().getSimpleName().equalsIgnoreCase("boolean")) {
+                        String methodName = String.format("is%s", MethodHelper.getUpFirstForProperty(fieldName));
+                        return MethodHelper.invoke(context, methodName, MethodHelper.NO_PARAM_TYPES, MethodHelper.NO_PARAM_VALUES);
+                    } else {
+                        return MethodHelper.invokeGetter(context, fieldName);
+                    }
+                }
+        );
+    }
+
     private static void initFlavour( FlavourContext context, String actualFlavour ) throws IOException, TemplateException {
         // copy all resources
         String listFilePath = String.format( "config/flavour/%s-copy.txt", actualFlavour );

fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/flavour/extra/FlavourExtraConfig.java

@@ -0,0 +1,13 @@
+package org.fugerit.java.doc.project.facade.flavour.extra;
+
+import lombok.Getter;
+import lombok.Setter;
+
+import java.util.Map;
+
+public class FlavourExtraConfig {
+
+    @Getter @Setter
+    private Map<String, ParamConfig> paramConfig;
+
+}

fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/flavour/extra/FlavourExtraConfigFacade.java

@@ -0,0 +1,33 @@
+package org.fugerit.java.doc.project.facade.flavour.extra;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import org.fugerit.java.core.function.SafeFunction;
+
+import java.io.InputStream;
+
+public class FlavourExtraConfigFacade {
+
+    private static final ObjectMapper MAPPER = new ObjectMapper( new YAMLFactory() );
+
+    private FlavourExtraConfigFacade() {}
+
+    public static FlavourExtraConfig readConfigWithDefault(InputStream is, FlavourExtraConfig defaultConfig) {
+        return SafeFunction.get( () -> {
+            if ( is != null ) {
+                return MAPPER.readValue( is, FlavourExtraConfig.class );
+            } else {
+                return defaultConfig;
+            }
+        } );
+    }
+
+    public static FlavourExtraConfig readConfigBlankDefault(InputStream is) {
+        return readConfigWithDefault( is, new FlavourExtraConfig() );
+    }
+
+    public static FlavourExtraConfig readConfig(InputStream is) {
+        return readConfigWithDefault( is, null );
+    }
+
+}

fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/flavour/extra/ParamConfig.java

@@ -0,0 +1,13 @@
+package org.fugerit.java.doc.project.facade.flavour.extra;
+
+import lombok.Getter;
+import lombok.Setter;
+
+import java.util.List;
+
+public class ParamConfig {
+
+    @Getter @Setter
+    private List<String> acceptOnly;
+
+}

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/micronaut-4-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/openliberty-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/quarkus-2-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/quarkus-3-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/quarkus-3-gradle-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/quarkus-3-gradle-kts-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/quarkus-3-properties-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true

fj-doc-maven-plugin/src/main/resources/config/flavour-extra-config/springboot-3-config.yml

@@ -0,0 +1,5 @@
+---
+paramConfig:
+  addLombok:
+    acceptOnly:
+      - true