report verbosity

mojohaus · Nov 26, 2022 · d1cebdb · d1cebdb
1 parent d05e5cf
commit d1cebdb
Show file tree

Hide file tree

Showing 12 changed files with 86 additions and 10 deletions.
diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/api/AbstractVersionDetails.java b/versions-common/src/main/java/org/codehaus/mojo/versions/api/AbstractVersionDetails.java
@@ -176,6 +176,14 @@ public final void setIncludeSnapshots( boolean includeSnapshots )
         }
     }
 
+    public void setVerbose( boolean verbose )
+    {
+        synchronized ( currentVersionLock )
+        {
+            this.verboseDetail = verbose;
+        }
+    }
+
     @Override
     public final ArtifactVersion[] getVersions()
     {

diff --git a/versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/AbstractVersionsReport.java b/versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/AbstractVersionsReport.java
@@ -140,6 +140,12 @@ public abstract class AbstractVersionsReport<T>
     @Parameter( property = "allowSnapshots", defaultValue = "false" )
     protected boolean allowSnapshots;
 
+    @Parameter( property = "verboseSummary", defaultValue = "true" )
+    protected boolean verboseSummary = true;
+
+    @Parameter( property = "verboseDetail", defaultValue = "true" )
+    protected boolean verboseDetail = true;
+
     /**
      * Our versions helper.
      */
@@ -290,6 +296,7 @@ protected ArtifactVersion findLatestVersion( Artifact artifact, VersionRange ver
         {
             final ArtifactVersions artifactVersions =
                 getHelper().lookupArtifactVersions( artifact, usePluginRepositories );
+            artifactVersions.setVerbose( verboseDetail );
             return artifactVersions.getNewestVersion( versionRange, includeSnapshots );
         }
         catch ( VersionRetrievalException e )

diff --git a/...ns-maven-plugin/src/main/java/org/codehaus/mojo/versions/DependencyUpdatesReportMojo.java b/...ns-maven-plugin/src/main/java/org/codehaus/mojo/versions/DependencyUpdatesReportMojo.java
@@ -230,7 +230,8 @@ && getProject().getOriginalModel().getDependencyManagement().getDependencies() !
             {
                 if ( "html".equals( format ) )
                 {
-                    rendererFactory.createReportRenderer( getOutputName(), sink, locale, model ).render();
+                    rendererFactory.createReportRenderer( getOutputName(), sink, locale, model,
+                                                            verboseSummary, verboseDetail ).render();
                 }
                 else if ( "xml".equals( format ) )
                 {

diff --git a/versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/ParentUpdatesReportMojo.java b/versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/ParentUpdatesReportMojo.java
@@ -114,7 +114,7 @@ protected void doGenerateReport( Locale locale, Sink sink ) throws MavenReportEx
                                     .withScope( artifactVersions.getArtifact().getScope() )
                                     .withType( artifactVersions.getArtifact().getType() )
                                     .withClassifier( artifactVersions.getArtifact().getClassifier() )
-                                    .build(), artifactVersions ) )
+                                    .build(), artifactVersions ), verboseSummary, verboseDetail )
                     .render();
         }
         catch ( VersionRetrievalException e )

diff --git a/versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/PluginUpdatesReportMojo.java b/versions-maven-plugin/src/main/java/org/codehaus/mojo/versions/PluginUpdatesReportMojo.java
@@ -175,7 +175,8 @@ protected void doGenerateReport( Locale locale, Sink sink ) throws MavenReportEx
             {
                 if ( "html".equals( format ) )
                 {
-                    rendererFactory.createReportRenderer( getOutputName(), getSink(), locale, model ).render();
+                    rendererFactory.createReportRenderer( getOutputName(), getSink(), locale, model,
+                                                            verboseSummary, verboseDetail ).render();
                 }
                 else if ( "xml".equals( format ) )
                 {

diff --git a/...ions-maven-plugin/src/main/java/org/codehaus/mojo/versions/PropertyUpdatesReportMojo.java b/...ions-maven-plugin/src/main/java/org/codehaus/mojo/versions/PropertyUpdatesReportMojo.java
@@ -162,7 +162,8 @@ protected void doGenerateReport( Locale locale, Sink sink )
         {
             if ( "html".equals( format ) )
             {
-                rendererFactory.createReportRenderer( getOutputName(), getSink(), locale, model ).render();
+                rendererFactory.createReportRenderer( getOutputName(), getSink(), locale, model,
+                                                        verboseSummary, verboseDetail ).render();
             }
             else if ( "xml".equals( format ) )
             {

diff --git a/...in/src/main/java/org/codehaus/mojo/versions/reporting/AbstractVersionsReportRenderer.java b/...in/src/main/java/org/codehaus/mojo/versions/reporting/AbstractVersionsReportRenderer.java
@@ -71,6 +71,20 @@ public abstract class AbstractVersionsReportRenderer<T> extends VersionsReportRe
     protected final SinkEventAttributes headerAttributes
             = new SinkEventAttributeSet( SinkEventAttributes.WIDTH, "30%" );
 
+    protected boolean verboseSummary = true;
+
+    protected boolean verboseDetail = true;
+
+    public void setVerboseSummary( boolean verboseSummary )
+    {
+        this.verboseSummary = verboseSummary;
+    }
+
+    public void setVerboseDetail( boolean verboseDetail )
+    {
+        this.verboseDetail = verboseDetail;
+    }
+
     protected AbstractVersionsReportRenderer( I18N i18n, Sink sink, Locale locale, String bundleName, T model )
     {
         super( sink, i18n, locale, bundleName );
@@ -234,6 +248,10 @@ protected void renderSummaryTableRow( Dependency artifact, ArtifactVersions deta
         details.setCurrentVersion( artifact.getVersion() );
         ArtifactVersion[] allUpdates = allUpdatesCache.get( details, empty() );
         boolean upToDate = allUpdates == null || allUpdates.length == 0;
+        if ( upToDate && !verboseSummary )
+        {
+            return;
+        }
 
         sink.tableRow();
 
@@ -268,6 +286,10 @@ protected void renderDependencyDetailTable( Dependency artifact, ArtifactVersion
     {
         ArtifactVersion[] allUpdates = allUpdatesCache.get( details, empty() );
         boolean upToDate = allUpdates == null || allUpdates.length == 0;
+        if ( upToDate && !verboseDetail )
+        {
+            return;
+        }
 
         sink.table();
         sink.tableRows( new int[] { Sink.JUSTIFY_RIGHT, Sink.JUSTIFY_LEFT }, false );

diff --git a/...n/src/main/java/org/codehaus/mojo/versions/reporting/DependencyUpdatesReportRenderer.java b/...n/src/main/java/org/codehaus/mojo/versions/reporting/DependencyUpdatesReportRenderer.java
@@ -21,8 +21,10 @@
 
 import java.util.Locale;
 import java.util.Map;
+import java.util.Optional;
 
 import org.apache.maven.artifact.ArtifactUtils;
+import org.apache.maven.artifact.versioning.ArtifactVersion;
 import org.apache.maven.doxia.sink.Sink;
 import org.apache.maven.model.Dependency;
 import org.codehaus.mojo.versions.api.ArtifactVersions;
@@ -91,6 +93,13 @@ protected OverviewStats computeOverviewStats()
 
     protected void renderDependencyDetail( Dependency artifact, ArtifactVersions details )
     {
+        ArtifactVersion[] allUpdates = allUpdatesCache.get( details, Optional.empty() );
+        boolean upToDate = allUpdates == null || allUpdates.length == 0;
+        if ( upToDate && !verboseDetail )
+        {
+            return;
+        }
+
         sink.section2();
         sink.sectionTitle2();
         sink.text( ArtifactUtils.versionlessKey( artifact.getGroupId(), artifact.getArtifactId() ) );

diff --git a/...lugin/src/main/java/org/codehaus/mojo/versions/reporting/PluginUpdatesReportRenderer.java b/...lugin/src/main/java/org/codehaus/mojo/versions/reporting/PluginUpdatesReportRenderer.java
@@ -143,6 +143,10 @@ protected <T extends OverviewStats> void renderOverviewTableRow( T stats )
     protected void renderSummaryTableRow( Dependency artifact, PluginUpdatesDetails details )
     {
         boolean upToDate = !details.isUpdateAvailable();
+        if ( upToDate && !verboseSummary )
+        {
+            return;
+        }
 
         sink.tableRow();
 
@@ -193,6 +197,10 @@ private void renderPluginDetailTable( PluginUpdatesDetails details )
         // warning: using caches here might break plugin report
         ArtifactVersion[] allUpdates = details.getAllUpdates( empty() );
         boolean upToDate = allUpdates == null || allUpdates.length == 0;
+        if ( upToDate && !verboseDetail )
+        {
+            return;
+        }
 
         sink.table();
         sink.tableRows( new int[] { Sink.JUSTIFY_RIGHT, Sink.JUSTIFY_LEFT }, false );

diff --git a/...gin/src/main/java/org/codehaus/mojo/versions/reporting/PropertyUpdatesReportRenderer.java b/...gin/src/main/java/org/codehaus/mojo/versions/reporting/PropertyUpdatesReportRenderer.java
@@ -106,6 +106,10 @@ private void renderPropertySummaryTableRow( Property property, PropertyVersions
     {
         ArtifactVersion[] allUpdates = allUpdatesCache.get( details, empty() );
         boolean upToDate = allUpdates == null || allUpdates.length == 0;
+        if ( upToDate && !verboseSummary )
+        {
+            return;
+        }
 
         sink.tableRow();
 
@@ -123,6 +127,10 @@ protected void renderPropertyDetailTable( Property property, PropertyVersions de
     {
         ArtifactVersion[] allUpdates = allUpdatesCache.get( details, empty() );
         boolean upToDate = allUpdates == null || allUpdates.length == 0;
+        if ( upToDate && !verboseDetail )
+        {
+            return;
+        }
 
         sink.table();
         sink.tableRows( new int[] { Sink.JUSTIFY_RIGHT, Sink.JUSTIFY_LEFT }, false );

diff --git a/...aven-plugin/src/main/java/org/codehaus/mojo/versions/reporting/ReportRendererFactory.java b/...aven-plugin/src/main/java/org/codehaus/mojo/versions/reporting/ReportRendererFactory.java
@@ -38,9 +38,12 @@ public interface ReportRendererFactory
      * @param sink sink to use for rendering
      * @param locale locale to use for rendering
      * @param model data to render
+     * @param verboseSummary <code>false</code> if up to date rows should be filtered out of report table.
+     * @param verboseDetail <code>false</code> if up to date rows should be filtered out of report table.
      * @return new report renderer
      * @throws IllegalArgumentException thrown if the report with the given name could not be found
      */
-    <T extends ReportRenderer, U> T createReportRenderer( String reportName, Sink sink, Locale locale, U model )
+    <T extends ReportRenderer, U> T createReportRenderer( String reportName, Sink sink, Locale locale, U model,
+                                                          boolean verboseSummary, boolean verboseDetail )
             throws IllegalArgumentException;
 }
diff --git a/...-plugin/src/main/java/org/codehaus/mojo/versions/reporting/ReportRendererFactoryImpl.java b/...-plugin/src/main/java/org/codehaus/mojo/versions/reporting/ReportRendererFactoryImpl.java
@@ -57,29 +57,37 @@ public ReportRendererFactoryImpl( I18N i18N )
      */
     @Override
     @SuppressWarnings( "unchecked" )
-    public <T extends ReportRenderer, U> T createReportRenderer( String reportName, Sink sink, Locale locale, U model )
+    public <T extends ReportRenderer, U> T createReportRenderer( String reportName, Sink sink, Locale locale, U model,
+                                                                 boolean verboseSummary, boolean verboseDetail )
             throws IllegalArgumentException
     {
+        AbstractVersionsReportRenderer renderer = null ;
         if ( DEPENDENCY_UPDATES_REPORT.equals( reportName ) )
         {
-            return (T) new DependencyUpdatesReportRenderer<>( i18N, sink, locale, reportName,
+            renderer = new DependencyUpdatesReportRenderer<>( i18N, sink, locale, reportName,
                     (DependencyUpdatesModel) model );
         }
         if ( PLUGIN_UPDATES_REPORT.equals( reportName ) )
         {
-            return (T) new PluginUpdatesReportRenderer( i18N, sink, locale, reportName,
+            renderer = new PluginUpdatesReportRenderer( i18N, sink, locale, reportName,
                     (PluginUpdatesModel) model );
         }
         if ( PROPERTY_UPDATES_REPORT.equals( reportName ) )
         {
-            return (T) new PropertyUpdatesReportRenderer( i18N, sink, locale, reportName,
+            renderer = new PropertyUpdatesReportRenderer( i18N, sink, locale, reportName,
                     (PropertyUpdatesModel) model );
         }
         if ( PARENT_UPDATES_REPORT.equals( reportName ) )
         {
-            return (T) new ParentUpdatesReportRenderer( i18N, sink, locale, reportName,
+            renderer = new ParentUpdatesReportRenderer( i18N, sink, locale, reportName,
                     (ParentUpdatesModel) model );
         }
+        if ( renderer != null )
+        {
+            renderer.setVerboseSummary( verboseSummary );
+            renderer.setVerboseDetail( verboseDetail );
+            return (T) renderer;
+        }
         throw new IllegalArgumentException( "Invalid report name: " + reportName );
     }
 }