All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.codehaus.mojo.versions.DependencyUpdatesXmlRenderer Maven / Gradle / Ivy
package org.codehaus.mojo.versions;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Collection;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.model.Dependency;
import org.apache.maven.reporting.MavenReportException;
import org.codehaus.mojo.versions.api.ArtifactVersions;
import org.codehaus.mojo.versions.api.UpdateScope;
import org.codehaus.mojo.versions.utils.DependencyComparator;
/**
* XML renderer for DependencyUpdatesReport creates an xml file in target directory and writes report about available
* dependency/dependency management updates.
*
* @author Illia Dubinin
* @since 2.4
*/
public class DependencyUpdatesXmlRenderer
{
private static final String GROUP_ID = "groupId";
private static final String ARTIFACT_ID = "artifactId";
private static final String SCOPE = "scope";
private static final String CLASSIFIER = "classifier";
private static final String TYPE = "type";
private static final String CURRENT_VERSION = "currentVersion";
private static final String NEXT_VERSION = "nextVersion";
private static final String STATUS = "status";
private static final String OPEN_TAG = "<";
private static final String CLOSE_TAG = ">";
private static final String OPEN_CLOSING_TAG = " dependencyUpdates;
private Map dependencyManagementUpdates;
private String outputFileName;
public DependencyUpdatesXmlRenderer( Map dependencyUpdates,
Map dependencyManagementUpdates,
String outputFileName )
{
this.dependencyUpdates = dependencyUpdates;
this.dependencyManagementUpdates = dependencyManagementUpdates;
this.outputFileName = outputFileName;
}
/**
* Makes report file with given name in target directory.
*
* @throws MavenReportException if something went wrong
*/
public void render()
throws MavenReportException
{
StringBuilder sb = new StringBuilder();
sb.append( "" ).append( NL );
Map allUpdates =
new TreeMap( new DependencyComparator() );
allUpdates.putAll( dependencyManagementUpdates );
allUpdates.putAll( dependencyUpdates );
sb.append( getSummaryBlock( allUpdates.values() ) );
sb.append( getDependencyInfoBlock( dependencyManagementUpdates, "dependencyManagements",
"dependencyManagement" ) );
sb.append( getDependencyInfoBlock( dependencyUpdates, "dependencies", "dependency" ) );
sb.append( " " ).append( NL );
PrintWriter pw;
try
{
pw = new PrintWriter( outputFileName, "UTF8" );
pw.print( sb.toString() );
pw.close();
}
catch ( IOException e )
{
throw new MavenReportException( "Cannot create xml report.", e );
}
}
/**
* Method wraps value in xml tag. In ex: to wrap foo in tag bar you have to pass foo as value and bar as tag. As a
* result you will get: foo
*
* @param value - string to wrap
* @param tag - name of tag
* @return value wrapped in xml tag
*/
public static String wrapElement( String value, String tag )
{
return OPEN_TAG + tag + CLOSE_TAG + value + OPEN_CLOSING_TAG + tag + CLOSE_TAG;
}
/**
* Returns summary of dependency analysis result in xml format: current version, next available, next incremental,
* next minor and next major versions.
*
* @param allUpdates all dependencies versions
* @return summary in xml format
*/
public static String getSummaryBlock( Collection allUpdates )
{
int numInc = 0;
int numMin = 0;
int numMaj = 0;
int numAny = 0;
int numCur = 0;
for ( ArtifactVersions details : allUpdates )
{
if ( details.getOldestUpdate( UpdateScope.SUBINCREMENTAL ) != null )
{
numAny++;
}
else if ( details.getOldestUpdate( UpdateScope.INCREMENTAL ) != null )
{
numInc++;
}
else if ( details.getOldestUpdate( UpdateScope.MINOR ) != null )
{
numMin++;
}
else if ( details.getOldestUpdate( UpdateScope.MAJOR ) != null )
{
numMaj++;
}
else
{
numCur++;
}
}
String result = "\t%n" + "\t\t%d %n"
+ "\t\t%d %n"
+ "\t\t%d %n"
+ "\t\t%d %n" + "\t\t%d %n"
+ "\t %n";
return String.format( result, numCur, numAny, numInc, numMin, numMaj );
}
/**
* Returns xml report for current dependency state with following info: current version, next available version,
* next incremental/minor/major if available and status ('incremental available', 'minor available', 'major
* available' or 'no new available')
*
* @param versions version info for dependency
* @return xml reports about current possible updates.
*/
public static String getVersionsBlocks( ArtifactVersions versions )
{
StringBuilder sBuilder = new StringBuilder();
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( versions.getCurrentVersion().toString(),
CURRENT_VERSION ) ).append( NL );
ArtifactVersion nextVersion = versions.getOldestUpdate( UpdateScope.ANY );
if ( nextVersion != null )
{
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( nextVersion.toString(),
NEXT_VERSION ) ).append( NL );
String incrementalsBlock = getVersionsInScopeBlock( versions, UpdateScope.INCREMENTAL );
sBuilder.append( incrementalsBlock );
String minorsBlock = getVersionsInScopeBlock( versions, UpdateScope.MINOR );
sBuilder.append( minorsBlock );
String majorsBlock = getVersionsInScopeBlock( versions, UpdateScope.MAJOR );
sBuilder.append( majorsBlock );
String status = null;
if ( incrementalsBlock.length() > 0 )
{
status = "incremental available";
}
else if ( minorsBlock.length() > 0 )
{
status = "minor available";
}
else if ( majorsBlock.length() > 0 )
{
status = "major available";
}
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( status, STATUS ) ).append( NL );
}
else
{
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( "no new available",
STATUS ) ).append( NL );
}
return sBuilder.toString();
}
private static String getDependencyInfoBlock( Map dependencyUpdates, String blockName,
String subblockName )
{
StringBuilder sBuilder = new StringBuilder();
sBuilder.append( TAB ).append( OPEN_TAG ).append( blockName ).append( CLOSE_TAG ).append( NL );
for ( Entry entry : dependencyUpdates.entrySet() )
{
sBuilder.append( TAB ).append( TAB ).append( OPEN_TAG ).append( subblockName ).append( CLOSE_TAG ).append( NL );
Dependency dep = entry.getKey();
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( dep.getGroupId(),
GROUP_ID ) ).append( NL );
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( dep.getArtifactId(),
ARTIFACT_ID ) ).append( NL );
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( dep.getScope(),
SCOPE ) ).append( NL );
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( dep.getClassifier(),
CLASSIFIER ) ).append( NL );
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( wrapElement( dep.getType(),
TYPE ) ).append( NL );
sBuilder.append( getVersionsBlocks( entry.getValue() ) );
sBuilder.append( TAB ).append( TAB ).append( OPEN_CLOSING_TAG ).append( subblockName ).append( CLOSE_TAG ).append( NL );
}
sBuilder.append( TAB ).append( OPEN_CLOSING_TAG ).append( blockName ).append( CLOSE_TAG ).append( NL );
return sBuilder.toString();
}
private static String getVersionsInScopeBlock( ArtifactVersions av, UpdateScope scope )
{
String versionsTag = scope.toString().toLowerCase() + "s";
StringBuilder sBuilder = new StringBuilder();
ArtifactVersion nextVersion = av.getOldestUpdate( scope );
if ( nextVersion != null )
{
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( OPEN_TAG ).append( versionsTag ).append( CLOSE_TAG ).append( NL );
ArtifactVersion[] versions = av.getAllUpdates( scope );
for ( ArtifactVersion version : versions )
{
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( TAB ).append( wrapElement( version.toString(),
scope.toString().toLowerCase() ) ).append( NL );
}
sBuilder.append( TAB ).append( TAB ).append( TAB ).append( OPEN_CLOSING_TAG ).append( versionsTag ).append( CLOSE_TAG ).append( NL );
}
return sBuilder.toString();
}
}
