You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2008/07/22 02:59:28 UTC
svn commit: r678607 - in /maven/plugins/trunk/maven-changes-plugin/src:
it/report-changes-system/ it/report-changes-system/src/changes/
main/java/org/apache/maven/plugin/changes/
Author: olamy
Date: Mon Jul 21 17:59:28 2008
New Revision: 678607
URL: http://svn.apache.org/viewvc?rev=678607&view=rev
Log:
[MCHANGES-112] Add more than one link template
Added:
maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/
- copied from r678219, maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-generation/
Modified:
maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/pom.xml
maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/src/changes/changes.xml
maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/verify.bsh
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/Action.java
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesXML.java
Modified: maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/pom.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/pom.xml?rev=678607&r1=678219&r2=678607&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/pom.xml (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/pom.xml Mon Jul 21 17:59:28 2008
@@ -48,6 +48,9 @@
<version>@pom.version@</version>
<configuration>
<issueLinkTemplate>myjira/browse/%ISSUE%</issueLinkTemplate>
+ <issueLinkTemplatePerSystem>
+ <qc>http://localhost/%ISSUE%</qc>
+ </issueLinkTemplatePerSystem>
</configuration>
<reportSets>
<reportSet>
Modified: maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/src/changes/changes.xml?rev=678607&r1=678219&r2=678607&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/src/changes/changes.xml (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/src/changes/changes.xml Mon Jul 21 17:59:28 2008
@@ -30,6 +30,9 @@
<action dev="me" type="fix" issue="MCHANGES-88">
Enable retrieving component-specific issues.
</action>
+ <action dev="me" type="fix" issue="1212" system="qc">
+ Enable retrieving component-specific issues.
+ </action>
<action dev="jruiz" type="remove" due-to="others" due-to-email="users@users.com">
The element type " link " must be terminated by the matching end-tag.
Deleted the erroneous code.
Modified: maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/verify.bsh
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/verify.bsh?rev=678607&r1=678219&r2=678607&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/verify.bsh (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/it/report-changes-system/verify.bsh Mon Jul 21 17:59:28 2008
@@ -49,6 +49,12 @@
System.err.println( "changes-report.html doesn't contains jira issue link" );
return false;
}
+ indexOf = reportContent.indexOf( " <a href=\"http://localhost/1212\" class=\"externalLink\">1212</a>" );
+ if ( indexOf < 0)
+ {
+ System.err.println( "changes-report.html doesn't contains qc issue link" );
+ return false;
+ }
}
catch( Throwable e )
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/Action.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/Action.java?rev=678607&r1=678606&r2=678607&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/Action.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/Action.java Mon Jul 21 17:59:28 2008
@@ -38,6 +38,8 @@
private String type;
+ private String system;
+
public Action()
{
}
@@ -101,4 +103,14 @@
{
return type;
}
+
+ public String getSystem()
+ {
+ return system;
+ }
+
+ public void setSystem( String system )
+ {
+ this.system = system;
+ }
}
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java?rev=678607&r1=678606&r2=678607&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesMojo.java Mon Jul 21 17:59:28 2008
@@ -19,15 +19,16 @@
* under the License.
*/
-import org.apache.maven.reporting.MavenReportException;
-import org.codehaus.plexus.util.FileUtils;
-
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.Locale;
+import java.util.Map;
import java.util.ResourceBundle;
+import org.apache.maven.reporting.MavenReportException;
+import org.codehaus.plexus.util.FileUtils;
+
/**
* Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.
*
@@ -57,8 +58,24 @@
*
* @parameter expression="${changes.issueLinkTemplate}" default-value="%URL%/ViewIssue.jspa?key=%ISSUE%"
* @since 2.0-beta-2
+ * @deprecated now use issueLinkTemplatePerSystem : this one will be with system default
*/
private String issueLinkTemplate;
+
+ /**
+ * Template strings per System that is used to discover the URL to use to display an issue report.
+ * There are 2 template tokens you can use. <code>%URL%</code>: this is computed by getting the
+ * <code><issueManagement>/<url></code> value from the POM, and removing the last '/'
+ * and everything that comes after it. <code>%ISSUE%</code>: this is the issue number.
+ * <p>
+ * <strong>Note:</strong>The deprecated issueLinkTemplate will used with system called default
+ * <code>link_template</code>.
+ * </p>
+ *
+ * @parameter
+ * @since 2.1
+ */
+ private Map issueLinkTemplatePerSystem;
/**
* @parameter default-value="${project.issueManagement.url}"
@@ -101,8 +118,9 @@
throws MavenReportException
{
ChangesReportGenerator report = new ChangesReportGenerator( xmlPath, getLog() );
-
+ report.setIssueLinksPerSystem( issueLinkTemplatePerSystem );
report.setIssueLink( issueLinkTemplate );
+
report.setUrl( url );
if ( !report.canGenerateIssueLinks() )
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java?rev=678607&r1=678606&r2=678607&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesReportGenerator.java Mon Jul 21 17:59:28 2008
@@ -19,15 +19,17 @@
* under the License.
*/
+import java.io.File;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.ResourceBundle;
+
import org.apache.commons.lang.StringUtils;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.HtmlTools;
import org.apache.maven.plugin.logging.Log;
-import java.io.File;
-import java.util.List;
-import java.util.ResourceBundle;
-
/**
* Generates a changes report.
*
@@ -45,30 +47,44 @@
* The token in {@link #issueLink} denoting the issue ID.
*/
private static final String ISSUE_TOKEN = "%ISSUE%";
+
+ private static final String DEFAULT_ISSUE_SYSTEM_KEY = "default";
private ChangesXML report;
- private String issueLink;
-
private String url;
+
+ private Map issueLinksPerSystem;
public ChangesReportGenerator()
{
+ issueLinksPerSystem = new HashMap();
}
public ChangesReportGenerator( File xmlPath, Log log )
{
+ this();
report = new ChangesXML( xmlPath, log );
}
+ /**
+ * @deprecated
+ */
public void setIssueLink( String issueLink )
{
- this.issueLink = issueLink;
+ if ( this.issueLinksPerSystem == null )
+ {
+ this.issueLinksPerSystem = new HashMap();
+ }
+ this.issueLinksPerSystem.put( DEFAULT_ISSUE_SYSTEM_KEY, issueLink );
}
+ /**
+ * @deprecated
+ */
public String getIssueLink()
{
- return issueLink;
+ return (String) issueLinksPerSystem.get( DEFAULT_ISSUE_SYSTEM_KEY );
}
public void setUrl( String url )
@@ -80,18 +96,46 @@
{
return url;
}
+
+ public Map getIssueLinksPerSystem()
+ {
+ return issueLinksPerSystem;
+ }
+
+ public void setIssueLinksPerSystem( Map issueLinksPerSystem )
+ {
+ if ( this.issueLinksPerSystem != null && issueLinksPerSystem == null )
+ {
+ return;
+ }
+ this.issueLinksPerSystem = issueLinksPerSystem;
+ }
/**
* Checks whether links to the issues can be generated.
*
* @return <code>true</code> if issue links can be generated, <code>false</code> otherwise.
*/
- public boolean canGenerateIssueLinks()
+ public boolean canGenerateIssueLinks(String system)
{
- return !StringUtils.isBlank( getIssueLink() )
- && ( !StringUtils.isBlank( getUrl() ) || getIssueLink().indexOf( URL_TOKEN ) < 0 );
+ if ( !this.issueLinksPerSystem.containsKey( system ) )
+ {
+ return false;
+ }
+ String issueLink = (String) this.issueLinksPerSystem.get( system );
+ return !StringUtils.isBlank( issueLink )
+ && ( !StringUtils.isBlank( getUrl() ) || issueLink.indexOf( URL_TOKEN ) < 0 );
}
+ public boolean canGenerateIssueLinks()
+ {
+ if (this.issueLinksPerSystem == null || this.issueLinksPerSystem.isEmpty() )
+ {
+ return false;
+ }
+ return this.issueLinksPerSystem.containsKey( DEFAULT_ISSUE_SYSTEM_KEY );
+ }
+
public void doGenerateEmptyReport( ResourceBundle bundle, Sink sink, String message )
{
sinkBeginReport( sink, bundle );
@@ -142,14 +186,16 @@
{
sink.text( " " + bundle.getString( "report.changes.text.fixes" ) + " " );
- if ( !canGenerateIssueLinks() )
+ String system = action.getSystem();
+ system = StringUtils.isEmpty( system ) ? DEFAULT_ISSUE_SYSTEM_KEY : system;
+ if ( !canGenerateIssueLinks( system ) )
{
sink.text( action.getIssue() );
}
else
{
- sink.link( parseIssueLink( action.getIssue() ) );
+ sink.link( parseIssueLink( action.getIssue(), system ) );
sink.text( action.getIssue() );
@@ -254,11 +300,11 @@
}
}
- private String parseIssueLink( String issue )
+ private String parseIssueLink( String issue, String system )
{
String parseLink;
-
- parseLink = this.issueLink.replaceFirst( ISSUE_TOKEN, issue );
+ String issueLink = (String) this.issueLinksPerSystem.get( system );
+ parseLink = issueLink.replaceFirst( ISSUE_TOKEN, issue );
if ( parseLink.indexOf( URL_TOKEN ) >= 0 )
{
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesXML.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesXML.java?rev=678607&r1=678606&r2=678607&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesXML.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/ChangesXML.java Mon Jul 21 17:59:28 2008
@@ -187,6 +187,8 @@
action.setType( attrs.getValue( "type" ) );
action.setIssue( attrs.getValue( "issue" ) );
+
+ action.setSystem( attrs.getValue( "system" ) );
}
currentName = qName;