org.neo4j.build.plugins.docs.DocsAssembler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docs-maven-plugin Show documentation
Show all versions of docs-maven-plugin Show documentation
Tool to filter and package documentation files,
including executing a documentation-generating test
and then install the assembled docs in the local repo.
/**
* Copyright (c) 2011-2012 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see NON_FILTERED_FILE_EXTENSIONS;
private final Log log;
private final List sourceDirectories;
private final boolean filter;
private final MavenProject project;
private final MavenProjectHelper projectHelper;
private final MavenResourcesFiltering resourceFiltering;
private final MavenSession session;
static
{
// these are always non-filtered anyhow:
// jpg, jpeg, gif, bmp, png
// as defined in
// org.apache.maven.shared.filtering.DefaultMavenResourcesFiltering
NON_FILTERED_FILE_EXTENSIONS = Arrays.asList( "tiff",
"tif", "pdf", "zip", "gz" );
}
public DocsAssembler( final List sourceDirectories,
final boolean filter, final Log log, MavenSession session,
final MavenProject project, final MavenProjectHelper projectHelper,
MavenResourcesFiltering resourceFiltering )
{
this.sourceDirectories = sourceDirectories;
this.filter = filter;
this.project = project;
this.log = log;
this.projectHelper = projectHelper;
this.resourceFiltering = resourceFiltering;
this.session = session;
}
public File doAssembly() throws MojoExecutionException
{
log.info( "Filtering is: " + (filter ? "on" : "off") );
List dirs = getDirectories( sourceDirectories );
if ( dirs.size() == 0 )
{
log.warn( "There are no docs to assemble." );
return null;
}
File destinationFile;
if ( filter )
{
File target = new File( new File( project.getBuild()
.getDirectory() ), "filtered-docs" );
try
{
FileUtils.cleanDirectory( target );
}
catch ( IOException e )
{
log.error( e );
throw new MojoExecutionException(
"Could not remove old filtered files.", e );
}
filterResources( dirs, target );
destinationFile = createArchive( Collections.singletonList( target ) );
}
else
{
destinationFile = createArchive( dirs );
}
projectHelper.attachArtifact( project, TYPE, CLASSIFIER, destinationFile );
return destinationFile;
}
private File createArchive( final List directories )
throws MojoExecutionException
{
log.info( "Creating docs archive." );
final String filename = project.getArtifactId() + "-"
+ project.getVersion() + "-" + CLASSIFIER + "."
+ TYPE;
File targetDirectory = new File( project.getBuild()
.getDirectory() );
if ( !targetDirectory.exists() && !targetDirectory.mkdir() )
{
throw new MojoExecutionException(
"Could not create: " + targetDirectory.getAbsolutePath() );
}
final File destFile = new File( project.getBuild()
.getDirectory(), filename );
if ( destFile.exists() && !destFile.delete() )
{
throw new MojoExecutionException( "Could not delete: "
+ destFile.getAbsolutePath() );
}
Archiver archiver = new JarArchiver();
archiver.setDestFile( destFile );
try
{
for ( File dir : directories )
{
DefaultFileSet fileSet = new DefaultFileSet();
fileSet.setDirectory( dir );
archiver.addFileSet( fileSet );
}
archiver.createArchive();
}
catch ( ArchiverException e )
{
log.error( e );
throw new MojoExecutionException( "Error building archive.", e );
}
catch ( IOException e )
{
log.error( e );
throw new MojoExecutionException( "Error building archive.", e );
}
return destFile;
}
private void filterResources( final List directories, File targetDir )
{
log.info( "Filter target: " + targetDir );
int baseDirLength = project.getBasedir()
.getAbsolutePath()
.length() + 1;
List resources = new ArrayList();
for ( File dir : directories )
{
Resource resource = new Resource();
resource.setDirectory( dir.getAbsolutePath()
.substring( baseDirLength ) );
resource.setFiltering( true );
log.info( "Adding source directory: " + dir );
resources.add( resource );
}
MavenResourcesExecution resourcesExecution = new MavenResourcesExecution(
resources, targetDir, project, "UTF-8",
Collections.emptyList(), NON_FILTERED_FILE_EXTENSIONS, session );
resourcesExecution.setResourcesBaseDirectory( project.getBasedir() );
resourcesExecution.addFilterWrapper( new FileUtils.FilterWrapper()
{
@Override
public Reader getReader( final Reader reader )
{
return reader;
}
} );
try
{
resourceFiltering.filterResources( resourcesExecution );
}
catch ( MavenFilteringException e )
{
log.error( e );
}
}
private List getDirectories( final List sourceDirectories )
throws MojoExecutionException
{
List directories = new ArrayList();
if ( sourceDirectories == null )
{
log.info( "No directories configured, using defaults." );
// add default directories
// ./src/docs and ./target/docs
addDirectory( new File( new File( project.getBasedir(), "src" ),
DOCS_DIRNAME ), directories );
addDirectory( new File( project.getBuild()
.getDirectory(), DOCS_DIRNAME ), directories );
}
else
{
for ( String dir : sourceDirectories )
{
addDirectory( new File( dir ), directories );
}
}
return directories;
}
private void addDirectory( final File dir, final List directories )
throws MojoExecutionException
{
if ( !dir.exists() )
{
log.info( "Skipping, does not exist: " + dir );
return;
}
if ( dir.listFiles().length == 0 )
{
log.info( "Skipping, is empty: " + dir );
return;
}
if ( !dir.isDirectory() )
{
throw new MojoExecutionException( "Not a directory: "
+ dir.getAbsolutePath() );
}
if ( !dir.canRead() )
{
throw new MojoExecutionException( "Can not read directory: "
+ dir.getAbsolutePath() );
}
directories.add( dir );
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy