Coverage Report - org.apache.maven.plugin.changes.ChangesReportGenerator
 
Classes in this File Line Coverage Branch Coverage Complexity
ChangesReportGenerator
0%
0/157
0%
0/26
1,565
 
 1  
 package org.apache.maven.plugin.changes;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one
 5  
  * or more contributor license agreements.  See the NOTICE file
 6  
  * distributed with this work for additional information
 7  
  * regarding copyright ownership.  The ASF licenses this file
 8  
  * to you under the Apache License, Version 2.0 (the
 9  
  * "License"); you may not use this file except in compliance
 10  
  * with the License.  You may obtain a copy of the License at
 11  
  *
 12  
  *   http://www.apache.org/licenses/LICENSE-2.0
 13  
  *
 14  
  * Unless required by applicable law or agreed to in writing,
 15  
  * software distributed under the License is distributed on an
 16  
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 17  
  * KIND, either express or implied.  See the License for the
 18  
  * specific language governing permissions and limitations
 19  
  * under the License.
 20  
  */
 21  
 
 22  
 import org.apache.commons.lang.StringUtils;
 23  
 import org.apache.maven.doxia.sink.Sink;
 24  
 import org.apache.maven.doxia.util.HtmlTools;
 25  
 import org.apache.maven.plugin.logging.Log;
 26  
 
 27  
 import java.io.File;
 28  
 import java.util.List;
 29  
 import java.util.ResourceBundle;
 30  
 
 31  
 /**
 32  
  * Generates a changes report.
 33  
  *
 34  
  * @version $Id: org.apache.maven.plugin.changes.ChangesReportGenerator.html 816584 2012-05-08 12:33:35Z hboutemy $
 35  
  */
 36  
 public class ChangesReportGenerator
 37  
 {
 38  
     private ChangesXML report;
 39  
 
 40  
     private String issueLink;
 41  
 
 42  
     private String url;
 43  
 
 44  
     public ChangesReportGenerator()
 45  0
     {
 46  0
     }
 47  
 
 48  
     public ChangesReportGenerator( File xmlPath, Log log )
 49  0
     {
 50  0
         report = new ChangesXML( xmlPath, log );
 51  0
     }
 52  
 
 53  
     public void setIssueLink( String issueLink )
 54  
     {
 55  0
         this.issueLink = issueLink;
 56  0
     }
 57  
 
 58  
     public String getIssueLink()
 59  
     {
 60  0
         return issueLink;
 61  
     }
 62  
 
 63  
     public void setUrl( String url )
 64  
     {
 65  0
         this.url = url;
 66  0
     }
 67  
 
 68  
     public String getUrl()
 69  
     {
 70  0
         return url;
 71  
     }
 72  
 
 73  
     public void doGenerateEmptyReport( ResourceBundle bundle, Sink sink, String message )
 74  
     {
 75  0
         sinkBeginReport( sink, bundle );
 76  
 
 77  0
         sink.text( message );
 78  
 
 79  0
         sinkEndReport( sink );
 80  0
     }
 81  
 
 82  
     public void doGenerateReport( ResourceBundle bundle, Sink sink )
 83  
     {
 84  0
         sinkBeginReport( sink, bundle );
 85  
 
 86  0
         constructReleaseHistory( sink, bundle );
 87  
 
 88  0
         constructReleases( sink, bundle );
 89  
 
 90  0
         sinkEndReport( sink );
 91  0
     }
 92  
 
 93  
     private void constructActions( Sink sink, List actionList, ResourceBundle bundle )
 94  
     {
 95  0
         sink.table();
 96  
 
 97  0
         sink.tableRow();
 98  
 
 99  0
         sinkHeader( sink, bundle.getString( "report.changes.label.type" ) );
 100  
 
 101  0
         sinkHeader( sink, bundle.getString( "report.changes.label.changes" ) );
 102  
 
 103  0
         sinkHeader( sink, bundle.getString( "report.changes.label.by" ) );
 104  
 
 105  0
         sink.tableRow_();
 106  
 
 107  0
         for ( int idx = 0; idx < actionList.size(); idx++ )
 108  
         {
 109  0
             Action action = (Action) actionList.get( idx );
 110  
 
 111  0
             sink.tableRow();
 112  
 
 113  0
             sinkShowTypeIcon( sink, action.getType() );
 114  
 
 115  0
             sink.tableCell();
 116  
 
 117  0
             sink.rawText( action.getAction() );
 118  
 
 119  0
             if ( StringUtils.isNotEmpty( action.getIssue() ) )
 120  
             {
 121  0
                 sink.text( " " + bundle.getString( "report.changes.text.fixes" ) + " " );
 122  
 
 123  0
                 if ( StringUtils.isEmpty( url ) )
 124  
                 {
 125  0
                     sink.text( action.getIssue() );
 126  
 
 127  
                 }
 128  
                 else
 129  
                 {
 130  0
                     sink.link( parseIssueLink( action.getIssue() ) );
 131  
 
 132  0
                     sink.text( action.getIssue() );
 133  
 
 134  0
                     sink.link_();
 135  
 
 136  
                 }
 137  0
                 sink.text( "." );
 138  
             }
 139  
 
 140  0
             if ( StringUtils.isNotEmpty( action.getDueTo() ) )
 141  
             {
 142  0
                 sink.text( " " + bundle.getString( "report.changes.text.thanx" ) + " " );
 143  
 
 144  0
                 if ( StringUtils.isNotEmpty( action.getDueToEmail() ) )
 145  
                 {
 146  0
                     sinkLink( sink, action.getDueTo(), "mailto:" + action.getDueToEmail() );
 147  
                 }
 148  
                 else
 149  
                 {
 150  0
                     sink.text( action.getDueTo() );
 151  
                 }
 152  
 
 153  0
                 sink.text( "." );
 154  
             }
 155  
 
 156  0
             sink.tableCell_();
 157  
 
 158  0
             sinkCellLink( sink, action.getDev(), "team-list.html#" + action.getDev() );
 159  
 
 160  0
             sink.tableRow_();
 161  
         }
 162  
 
 163  0
         sink.table_();
 164  0
     }
 165  
 
 166  
     private void constructReleaseHistory( Sink sink, ResourceBundle bundle )
 167  
     {
 168  0
         sinkSectionTitle2Anchor( sink, bundle.getString( "report.changes.label.releasehistory" ), bundle
 169  
             .getString( "report.changes.label.releasehistory" ) );
 170  
 
 171  0
         List releaseList = report.getReleaseList();
 172  
 
 173  0
         sink.table();
 174  
 
 175  0
         sink.tableRow();
 176  
 
 177  0
         sinkHeader( sink, bundle.getString( "report.changes.label.version" ) );
 178  
 
 179  0
         sinkHeader( sink, bundle.getString( "report.changes.label.date" ) );
 180  
 
 181  0
         sinkHeader( sink, bundle.getString( "report.changes.label.description" ) );
 182  
 
 183  0
         sink.tableRow_();
 184  
 
 185  0
         for ( int idx = 0; idx < releaseList.size(); idx++ )
 186  
         {
 187  0
             Release release = (Release) releaseList.get( idx );
 188  
 
 189  0
             sink.tableRow();
 190  
 
 191  0
             sinkCellLink( sink, release.getVersion(), "#" + HtmlTools.encodeId( release.getVersion() ) );
 192  
 
 193  0
             sinkCell( sink, release.getDateRelease() );
 194  
 
 195  0
             sinkCell( sink, release.getDescription() );
 196  
 
 197  0
             sink.tableRow_();
 198  
         }
 199  
 
 200  0
         sink.table_();
 201  
 
 202  0
         sink.lineBreak();
 203  
 
 204  
         // @todo Temporarily commented out until MCHANGES-46 is completely solved
 205  
         //        sink.rawText( bundle.getString( "report.changes.text.rssfeed" ) );
 206  
         //        sink.text( " " );
 207  
         //        sink.link( "changes.rss" );
 208  
         //        sinkFigure( "images/rss.png", sink );
 209  
         //        sink.link_();
 210  
         //
 211  
         //        sink.lineBreak();
 212  
 
 213  0
         sink.lineBreak();
 214  0
     }
 215  
 
 216  
     private void constructReleases( Sink sink, ResourceBundle bundle )
 217  
     {
 218  0
         List releaseList = report.getReleaseList();
 219  
 
 220  0
         for ( int idx = 0; idx < releaseList.size(); idx++ )
 221  
         {
 222  0
             Release release = (Release) releaseList.get( idx );
 223  
 
 224  0
             sinkSectionTitle2Anchor( sink, bundle.getString( "report.changes.label.release" ) + " "
 225  
                 + release.getVersion() + " - " + release.getDateRelease(), HtmlTools.encodeId( release.getVersion() ) );
 226  
 
 227  0
             constructActions( sink, release.getAction(), bundle );
 228  
         }
 229  0
     }
 230  
 
 231  
     private String parseIssueLink( String issue )
 232  
     {
 233  0
         String parseLink = "";
 234  
 
 235  0
         String url = this.url.substring( 0, this.url.lastIndexOf( "/" ) );
 236  
 
 237  0
         parseLink = this.issueLink.replaceFirst( "%ISSUE%", issue );
 238  
 
 239  0
         parseLink = parseLink.replaceFirst( "%URL%", url );
 240  
 
 241  0
         return parseLink;
 242  
     }
 243  
 
 244  
     private void sinkBeginReport( Sink sink, ResourceBundle bundle )
 245  
     {
 246  0
         sink.head();
 247  
 
 248  0
         sink.title();
 249  0
         sink.text( bundle.getString( "report.changes.header" ) );
 250  0
         sink.title_();
 251  
 
 252  0
         if ( StringUtils.isNotEmpty( report.getAuthor() ) )
 253  
         {
 254  0
             sink.author();
 255  0
             sink.text( report.getAuthor() );
 256  0
             sink.author_();
 257  
         }
 258  
 
 259  0
         sink.head_();
 260  
 
 261  0
         sink.body();
 262  
 
 263  0
         sinkSectionTitle1Anchor( sink, bundle.getString( "report.changes.header" ), bundle
 264  
             .getString( "report.changes.header" ) );
 265  0
     }
 266  
 
 267  
     private void sinkCell( Sink sink, String text )
 268  
     {
 269  0
         sink.tableCell();
 270  
 
 271  0
         sink.text( text );
 272  
 
 273  0
         sink.tableCell_();
 274  0
     }
 275  
 
 276  
     private void sinkCellLink( Sink sink, String text, String link )
 277  
     {
 278  0
         sink.tableCell();
 279  
 
 280  0
         sinkLink( sink, text, link );
 281  
 
 282  0
         sink.tableCell_();
 283  0
     }
 284  
 
 285  
     private void sinkEndReport( Sink sink )
 286  
     {
 287  0
         sink.body_();
 288  
 
 289  0
         sink.flush();
 290  
 
 291  0
         sink.close();
 292  0
     }
 293  
 
 294  
     private void sinkFigure( String image, Sink sink )
 295  
     {
 296  0
         sink.figure();
 297  
 
 298  0
         sink.figureGraphics( image );
 299  
 
 300  0
         sink.figure_();
 301  0
     }
 302  
 
 303  
     private void sinkFigure( String image, Sink sink, String altText )
 304  
     {
 305  0
         sink.figure();
 306  
 
 307  0
         sink.figureGraphics( image );
 308  
 
 309  0
         sink.figureCaption();
 310  
 
 311  0
         sink.text( altText );
 312  
 
 313  0
         sink.figureCaption_();
 314  
 
 315  0
         sink.figure_();
 316  0
     }
 317  
 
 318  
     private void sinkHeader( Sink sink, String header )
 319  
     {
 320  0
         sink.tableHeaderCell();
 321  
 
 322  0
         sink.text( header );
 323  
 
 324  0
         sink.tableHeaderCell_();
 325  0
     }
 326  
 
 327  
     private void sinkLink( Sink sink, String text, String link )
 328  
     {
 329  0
         sink.link( link );
 330  
 
 331  0
         sink.text( text );
 332  
 
 333  0
         sink.link_();
 334  0
     }
 335  
 
 336  
     private void sinkSectionTitle1Anchor( Sink sink, String text, String anchor )
 337  
     {
 338  0
         sink.sectionTitle1();
 339  0
         sink.anchor( anchor );
 340  0
         sink.anchor_();
 341  0
         sink.text( text );
 342  0
         sink.sectionTitle1_();
 343  0
     }
 344  
 
 345  
     private void sinkSectionTitle2Anchor( Sink sink, String text, String anchor )
 346  
     {
 347  0
         sink.sectionTitle2();
 348  0
         sink.anchor( anchor );
 349  0
         sink.anchor_();
 350  0
         sink.text( text );
 351  0
         sink.sectionTitle2_();
 352  0
     }
 353  
 
 354  
     private void sinkShowTypeIcon( Sink sink, String type )
 355  
     {
 356  0
         String image = "";
 357  0
         String altText = "";
 358  
 
 359  0
         if ( type == null )
 360  
         {
 361  0
             image = "images/icon_help_sml.gif";
 362  0
             altText = "?";
 363  
         }
 364  0
         else if ( type.equals( "fix" ) )
 365  
         {
 366  0
             image = "images/fix.gif";
 367  0
             altText = "fix";
 368  
         }
 369  0
         else if ( type.equals( "update" ) )
 370  
         {
 371  0
             image = "images/update.gif";
 372  0
             altText = "update";
 373  
         }
 374  0
         else if ( type.equals( "add" ) )
 375  
         {
 376  0
             image = "images/add.gif";
 377  0
             altText = "add";
 378  
         }
 379  0
         else if ( type.equals( "remove" ) )
 380  
         {
 381  0
             image = "images/remove.gif";
 382  0
             altText = "remove";
 383  
         }
 384  
 
 385  0
         sink.tableCell();
 386  
 
 387  0
         sinkFigure( image, sink, altText );
 388  
 
 389  0
         sink.tableCell_();
 390  0
     }
 391  
 
 392  
 }