org.fugerit.java.doc.project.facade.BasicVenusFacade Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fj-doc-maven-plugin Show documentation
Show all versions of fj-doc-maven-plugin Show documentation
Maven plugin to add Fugerit Venus Doc to a mavne project (fj-doc:generate)
package org.fugerit.java.doc.project.facade;
import lombok.extern.slf4j.Slf4j;
import org.apache.maven.model.*;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
import org.fugerit.java.core.cfg.ConfigRuntimeException;
import org.fugerit.java.core.io.FileIO;
import org.fugerit.java.core.io.helper.HelperIOException;
import org.fugerit.java.core.lang.helpers.StringUtils;
import org.maxxq.maven.dependency.ModelIO;
import java.io.*;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
@Slf4j
public class BasicVenusFacade {
protected BasicVenusFacade() {}
protected static final String GROUP_ID = "org.fugerit.java";
protected static final String KEY_VERSION = "fj-doc-version";
private static void addOrOverwrite( List deps, Dependency d ) {
Iterator it = deps.iterator();
while ( it.hasNext() ) {
Dependency dep = it.next();
if ( ( dep.getGroupId()+":"+dep.getArtifactId() ).equals( d.getGroupId()+":"+d.getArtifactId() ) ) {
it.remove();
}
}
deps.add( d );
}
private static void addCurrentModule( VenusContext context, String currentModule, List dependencies) {
Dependency d = new Dependency();
d.setArtifactId( currentModule );
d.setGroupId( GROUP_ID );
if (StringUtils.isNotEmpty( context.getAddExclusions() ) ) {
for ( String current : context.getAddExclusions().split( "," ) ) {
String[] parts = current.split( ":" );
Exclusion e = new Exclusion();
e.setGroupId( parts[0] );
e.setArtifactId( parts[1] );
d.getExclusions().add( e );
}
}
addOrOverwrite( dependencies, d );
}
private static Model readModel(ModelIO modelIO, File pomFile ) throws IOException {
try (InputStream pomStream = new FileInputStream( pomFile ) ) {
return modelIO.getModelFromInputStream( pomStream );
}
}
protected static void addErrorAndLog( String message, VenusContext context ) {
log.warn( message );
context.getErrors().add( message );
}
protected static Dependency createDependency( String groupId, String artifactId, String version, String scope ) {
Dependency dependency = new Dependency();
dependency.setGroupId( groupId );
dependency.setArtifactId( artifactId );
dependency.setVersion( version );
dependency.setScope( scope );
return dependency;
}
protected static void addJunit5( Model model, VenusContext context ) throws IOException {
if ( context.isAddJunit5() ) {
Dependency junit5 = createDependency( "org.junit.jupiter", "junit-jupiter", null, "test" );
addOrOverwrite( model.getDependencies(), junit5 );
} else {
log.debug( "skip addJunit5" );
}
}
protected static void addLombok( Model model, VenusContext context ) throws IOException {
if ( context.isAddLombok() ) {
Dependency lombok = createDependency( "org.projectlombok", "lombok", null, "provided" );
addOrOverwrite( model.getDependencies(), lombok );
Dependency slf4jSimple = createDependency( "org.slf4j", "slf4j-simple", null, "test" );
addOrOverwrite( model.getDependencies(), slf4jSimple );
} else {
log.debug( "skip addLombok" );
}
}
protected static void addExtensionList( File pomFile, VenusContext context ) throws IOException {
ModelIO modelIO = new ModelIO();
Model model = readModel( modelIO, pomFile );
// add pom data
context.setMavenModel( model );
if ( model.getDependencyManagement() == null ) {
model.setDependencyManagement( new DependencyManagement() );
}
DependencyManagement dm = model.getDependencyManagement();
Properties props = model.getProperties();
props.setProperty( KEY_VERSION, context.getVersion() );
Dependency fjDocBom = new Dependency();
fjDocBom.setArtifactId( "fj-doc" );
fjDocBom.setGroupId( GROUP_ID );
fjDocBom.setVersion( "${"+KEY_VERSION+"}" );
fjDocBom.setType( "pom" );
fjDocBom.setScope( "import" );
addOrOverwrite( dm.getDependencies(), fjDocBom );
log.info( "start dependencies size : {}, version : {}", model.getDependencies().size(), context.getVersion() );
// check if dependencies are already present
model.getDependencies().forEach( d -> checkDependencies( context.isForce(), d ) );
// configure dependencies
List moduleList = ModuleFacade.toModuleListOptimizedOrder( context.getExtensions() );
log.info( "moduleList : {}", moduleList );
for ( String currentModule : moduleList ) {
String moduleName = ModuleFacade.toModuleName( currentModule );
log.info( "Adding module : {}", moduleName );
// no need to check if module is supported , ModuleFacade.toModuleList() already does it
addCurrentModule( context, moduleName, model.getDependencies() );
context.getModules().add( moduleName );
}
// set fj-doc modules on top?
if ( context.isAddDependencyOnTop() ) {
model.getDependencies().sort( ( d1, d2 ) -> {
String artifact1 = d1.getArtifactId();
String artifact2 = d2.getArtifactId();
// if both are Venus modules, order is preserved
if ( artifact1.startsWith( ModuleFacade.MODULE_PREFIX ) && artifact2.startsWith( ModuleFacade.MODULE_PREFIX ) ) {
return 0;
// if the first dependency is a Venus module, it goes first
} else if ( artifact1.startsWith( ModuleFacade.MODULE_PREFIX ) ) {
return -1;
// otherwise it goes after, order preserved
} else {
return 1;
}
} );
}
// addJunit5 parameter
addJunit5( model, context );
// addLombok parameter
addLombok( model, context );
log.info( "end dependencies size : {}", model.getDependencies().size() );
addPlugin( context, model );
try (OutputStream pomStream = new FileOutputStream( pomFile ) ) {
modelIO.writeModelToStream( model, pomStream );
}
}
private static final String CONST_IMPLEMENTATION = "implementation";
protected static void addExtensionGradleKtsList( File gradleFile, VenusContext context ) throws IOException {
// note, this will currently only work for very simple build.gradle.kts files
String gradleFileContent = FileIO.readString( gradleFile );
String valVersion = String.format( "val fjDocVersion = \"%s\"\n\ndependencies", context.getVersion() );
gradleFileContent = gradleFileContent.replaceFirst( "dependencies", valVersion );
List moduleListGradle = ModuleFacade.toModuleListOptimizedOrder( context.getExtensions() );
Collections.reverse( moduleListGradle );
log.info( "moduleListGradle : {}", moduleListGradle );
for ( String currentModule : moduleListGradle ) {
String moduleNameGradle = ModuleFacade.toModuleName( currentModule );
String currentImplementation = String.format( "implementation\\(\"org.fugerit.java:%s:\\$fjDocVersion\"\\)%n implementation", moduleNameGradle );
log.info( "Adding module to gradle file : {}, substitution : {}", moduleNameGradle, currentImplementation );
gradleFileContent = gradleFileContent.replaceFirst( CONST_IMPLEMENTATION, currentImplementation );
context.getModules().add( moduleNameGradle );
}
if (context.isAddLombok() ) {
String lombokVersion = "1.18.36";
gradleFileContent = gradleFileContent.replaceFirst( CONST_IMPLEMENTATION, String.format( "compileOnly\\(\"org.projectlombok:lombok:%s\"\\)%n %s", lombokVersion, CONST_IMPLEMENTATION ) );
gradleFileContent = gradleFileContent.replaceFirst( CONST_IMPLEMENTATION, String.format( "annotationProcessor\\(\"org.projectlombok:lombok:%s\"\\)%n %s", lombokVersion, CONST_IMPLEMENTATION ) );
gradleFileContent = gradleFileContent.replaceFirst( CONST_IMPLEMENTATION, String.format( "testCompileOnly\\(\"org.projectlombok:lombok:%s\"\\)%n %s", lombokVersion, CONST_IMPLEMENTATION ) );
gradleFileContent = gradleFileContent.replaceFirst( CONST_IMPLEMENTATION, String.format( "testAnnotationProcessor\\(\"org.projectlombok:lombok:%s\"\\)%n %s", lombokVersion, CONST_IMPLEMENTATION ) );
}
FileIO.writeString( gradleFileContent, gradleFile );
}
private static void addPlugin( VenusContext context, Model model ) throws IOException {
// addVerifyPlugin?
if ( context.isAddVerifyPlugin() ) {
if ( context.isVerifyPluginNotAvailable() ) {
log.warn( "addVerifyPlugin skipped, version {} has been selected, minimum required version is : {}", context.getVersion(), VenusContext.VERSION_NA_VERIFY_PLUGIN );
} else {
log.info( "addVerifyPlugin true, version {} has been selected, minimum required version is : {}", context.getVersion(), VenusContext.VERSION_NA_VERIFY_PLUGIN );
Build build = model.getBuild();
if ( build == null ) {
build = new Build();
model.setBuild( build );
}
List plugins = model.getBuild().getPlugins();
Plugin plugin = new Plugin();
plugin.setGroupId( GROUP_ID );
plugin.setArtifactId( "fj-doc-maven-plugin" );
plugin.setVersion( "${"+KEY_VERSION+"}" );
PluginExecution execution = new PluginExecution();
execution.setId( "freemarker-verify" );
execution.setPhase( "compile" );
execution.addGoal( "verify" );
plugin.getExecutions().add( execution );
String xml = "\n" +
" ${project.basedir}/src/main/resources/"+context.getArtificatIdForFolder()+"/template \n" +
" true \n" +
" true \n" +
" ${project.build.directory}/freemarker-syntax-verify-report \n" +
" ";
HelperIOException.apply( () -> {
try ( StringReader sr = new StringReader( xml ) ) {
Xpp3Dom dom = Xpp3DomBuilder.build( sr );
plugin.setConfiguration( dom );
}
});
plugins.add( plugin );
}
} else {
log.info( "addVerifyPlugin : false" );
}
}
public static void checkDependencies( boolean force, Dependency d ) {
if ( d.getGroupId().equals( GROUP_ID ) && d.getArtifactId().startsWith( "fj-doc") ) {
log.warn( "fj-doc dependency found : {}", d );
if ( !force ) {
throw new ConfigRuntimeException( "Fugerit Venus Doc already configured" );
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy