Merge pull request #457 from fugerit-org/456-chore-fj-doc-maven-plugin-goal-add---add-base-package-parameter

[fj-doc-maven-plugin] goal add - add base package parameter #456

Author: fugerit79

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 add, new parameter : basePackage (optional) <https://github.com/fugerit-org/fj-doc/issues/456>
 - fj-bom version 2.0.2
 - quarkus-version set to 3.24.0 across all the modules <https://github.com/fugerit-org/fj-doc/issues/454>
 

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

@@ -13,6 +13,8 @@ mvn org.fugerit.java:fj-doc-maven-plugin:add \
 
 ==== Goal 'add' available parameters
 
+[#goal-add-parameters]
+
 [cols="4*", options="header"]
 |====================================================================================================================================================================================
 | parameter          | required | default         | description
@@ -30,6 +32,7 @@ mvn org.fugerit.java:fj-doc-maven-plugin:add \
 | addDependencyOnTop | true     | false           | If set to true, added dependencies will be added before existing ones
 | freemarkerVersion  | true     | 2.3.32          | Freemarker compatibility version (max 2.3.33)
 | simpleMpdel          | true     | false            | If set to true, modification to pom.xml will be light, dependencies for addLombok and addJunit will be ignored. addVerifyPlugin param will be ignored.
+| basePackage          | false     |             | If set given base package is used, otherwise base java package will be derived from groupId and artifactiId.
 |====================================================================================================================================================================================
 
 [#available-extensions]

fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/maven/MojoAdd.java

@@ -56,6 +56,9 @@ public class MojoAdd extends AbstractMojo {
     @Parameter(property = "simpleModel", defaultValue = "false", required = true)
     protected boolean simpleModel;
 
+    @Parameter(property = "basePackage", required = false)
+    protected String basePackage;
+
     protected String groupIdOverride;
 
     protected String artifactIdOverride;
@@ -78,6 +81,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         context.setGroupIdOverride( this.groupIdOverride );
         context.setArtifactIdOverride( this.artifactIdOverride );
         context.setSimpleModel( this.simpleModel );
+        context.setBasePackage( this.basePackage );
         this.getLog().info( String.format( "add execute() context : %s", context ) );
         AddVenusFacade.addToProject( context );
     }

fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/maven/MojoInit.java

@@ -63,6 +63,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 context.setFlavourVersion( this.flavourVersion );
                 context.setVersion( VersionCheck.findVersion( this.version ) );
                 context.setExtensions( this.extensions );
+                context.setBasePackage( this.basePackage );
                 this.getLog().info( String.format( "flavour context : %s", context ) );
                 String actualVersion = FlavourFacade.initProject( context );
                 if ( FlavourFacade.FLAVOUR_DIRECT.equals( actualVersion ) ) {

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

@@ -2,6 +2,7 @@
 
 import lombok.*;
 import lombok.extern.slf4j.Slf4j;
+import org.fugerit.java.core.lang.helpers.StringUtils;
 
 import java.io.File;
 import java.util.List;
@@ -44,6 +45,9 @@ public class FlavourContext {
     @Getter @Setter
     private String extensions;
 
+    @Getter @Setter
+    private String basePackage;
+
     private String toClassName( String base, String splitString ) {
         StringBuilder buf = new StringBuilder();
         String[] split = base.split( splitString );
@@ -70,4 +74,8 @@ public boolean isFreeMarkerNativeAvailable() {
         return VersionCheck.isMajorThan( this.getVersion(), VenusContext.VERSION_NA_FREEMARKER_NATIVE );
     }
 
+    public String getEvaluateBasePackage() {
+        return StringUtils.valueWithDefault( this.getBasePackage(), VenusContext.toPackage( this.getGroupId(), this.getArtifactId() ) );
+    }
+
 }

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

@@ -97,6 +97,13 @@ public static String toResourcePathFmConfigXml( String artifactId ) {
     @Getter @Setter
     private boolean simpleModel;
 
+    @Getter @Setter
+    private String basePackage;
+
+    public static String toPackage( String groupId, String artifactId) {
+        return toArtificatIdForFolder( groupId )+"."+toArtificatIdForName( artifactId );
+    }
+
     public void setExcludeXmlApis( boolean excludeXmlApis ) {
         if ( excludeXmlApis ) {
             this.setAddExclusions( "xml-apis:xml-apis" );
@@ -143,7 +150,7 @@ public String getResourcePathFmConfigXml() {
     }
 
     public String getDocConfigPackage() {
-        return this.getGroupIdForName()+"."+this.getArtificatIdForName();
+        return StringUtils.valueWithDefault( this.getBasePackage(), toPackage( this.getGroupId(), this.getArtificatIdForName() ) );
     }
 
     public String getTemplateSubPath() {

fj-doc-maven-plugin/src/main/resources/config/template/flavour/flavour-macro.ftl

@@ -1,6 +1,6 @@
-<#macro toProjectPackageFolder context>${context.groupId?replace(".","/")}/${context.artifactId?replace("-","")}</#macro>
+<#macro toProjectPackageFolder context>${context.evaluateBasePackage?replace(".","/")}</#macro>
 
-<#macro toProjectPackage context>${context.groupId}.${context.artifactId?replace("-","")}</#macro>
+<#macro toProjectPackage context>${context.evaluateBasePackage}</#macro>
 
 <#macro createDocumentProcess context exceptionType>
     // creates the doc helper

fj-doc-maven-plugin/src/test/java/test/org/fugerit/java/doc/project/facade/TestInit.java

@@ -56,6 +56,9 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                 this.addJunit5 = true;
                 this.addLombok = true;
                 this.flavour = currentFlavour;
+                if ( FlavourFacade.FLAVOUR_QUARKUS_3.equals( currentFlavour ) ) {
+                    this.basePackage = "org.fugerit.java.basepack";
+                }
                 super.execute();
             }
         };