#251: Merged summary requirements.

Author: redcatbear

doc/spec/design.md

@@ -541,17 +541,17 @@ Needs: impl, utest
 ### Plain Text Report
 
 #### Plain Text Report Summary
-`dsn~reporting.plain-text.summary~2`
+`dsn~reporting.plain-text.summary~3`
 
 The summary in the plain text report includes:
 
 * Result status
 * Total number of specification items
-* Total number of specification items that are defect (if any)
+* Total number of direct and transitive defect specification items (if any)
 
 Covers:
 
-* `req~reporting.plain-text.summary~2`
+* `req~reporting.plain-text.summary~3`
 
 Needs: impl, utest
 
@@ -660,16 +660,6 @@ Covers:
 
 Needs: impl, utest
 
-#### Plain Text Report Summary Line
-`dsn~reporting.plain-text.summary-line~1`
-
-The plain text report summary line renders the number of direct and transitive defects.
-
-Covers:
-
-* `req~reporting.plain-text.summary-line~1`
-
-Needs: impl, utest
 
 ### HTML Report
 
@@ -727,14 +717,14 @@ Covers:
 
 Needs: impl, utest
 
-#### HTML Report Summary Line
-`dsn~reporting.html.summary-line~1`
+#### HTML Report Summary
+`dsn~reporting.html.summary~2`
 
-The HTML report summary line renders the number of direct and transitive defects.
+The HTML report summary renders the status, the number of total items, a progress bar and the number of direct and transitive defects.
 
 Covers:
 
-* `req~reporting.html.summary-line~1`
+* `req~reporting.html.summary~2`
 
 Needs: impl, utest
 

doc/spec/system_requirements.md

@@ -639,7 +639,7 @@ Covers:
 Needs: dsn
 
 ### Reports
-Reports are the main way to find out if a projects requirements are covered properly.
+Reports are the main way to find out if a project's requirements are covered properly.
 
 #### Common Report Functions
 
@@ -666,16 +666,16 @@ Needs: dsn
 The plain text report is the most basic report variant. It serves two main purposes:
 
 1. Input in build chains
-2. Minimal requirement coverage view with the least dependencies. Any text terminal can display the plain text report.
+2. Minimal requirement coverage view with the least dependency. Any text terminal can display the plain text report.
 
 ##### Plain Text Report Summary
-`req~reporting.plain-text.summary~2`
+`req~reporting.plain-text.summary~3`
 
-The summary in the plain text report includes:
+The summary in the plain-text report includes:
 
 * Result status
 * Total number of specification items
-* Total number of defect specification items (if any)
+* Total number of direct and transitive defect specification items (if any)
 
 Covers:
 
@@ -686,7 +686,7 @@ Needs: dsn
 ##### Plain Text Report Specification Item Overview
 `req~reporting.plain-text.specification-item-overview~2`
 
-An item summary consist in the plain text report includes
+An item summary in the plain-text report includes
 
   1. Status
   2. Number of broken incoming links
@@ -761,16 +761,6 @@ Covers:
 
 Needs: dsn
 
-##### Plain Text Report Summary Line
-`req~reporting.plain-text.summary-line~1`
-
-The plain text report summary line distinguishes between direct and transitive defects.
-
-Covers:
-
-* [feat~plain-text-report~1](#plain-text-report)
-
-Needs: dsn
 
 #### HTML Report
 
@@ -830,10 +820,15 @@ Covers:
 
 Needs: dsn
 
-##### HTML Report Summary Line
-`req~reporting.html.summary-line~1`
+##### HTML Report Summary
+`req~reporting.html.summary~2`
+
+The summary in the HTML report includes:
 
-The HTML report summary line distinguishes between direct and transitive defects.
+* Result status
+* Total number of specification items
+* Completion status as a progress bar
+* Total number of direct and transitive defect specification items (if any)
 
 Rationale:
 

reporter/html/src/main/java/org/itsallcode/openfasttrace/report/html/view/html/HtmlTraceSummary.java

@@ -74,7 +74,7 @@ protected void renderCompletionIndicator()
         }
     }
 
-    // [impl->dsn~reporting.html.summary-line~1]
+    // [impl->dsn~reporting.html.summary~2]
     private void renderDefectCount()
     {
         if (!this.trace.hasNoDefects())

reporter/html/src/test/java/org/itsallcode/openfasttrace/report/html/view/html/TestHtmlTraceSummary.java

@@ -35,6 +35,7 @@ public void prepareEachTest()
     }
 
     @Test
+    // [utest->dsn~reporting.html.summary~2]
     void testRenderSummaryOk()
     {
         when(this.traceMock.hasNoDefects()).thenReturn(true);
@@ -54,6 +55,7 @@ private void renderTaceSummaryOnIndentationLevel(final int indentationLevel)
     @ParameterizedTest
     @ValueSource(ints =
     { 0, 1, 50, 99 })
+    // [utest->dsn~reporting.html.summary~2]
     void testRenderPercentagesNotOk(final int value)
     {
         final int maximum = 100;
@@ -78,7 +80,7 @@ void testRenderPercentagesNotOk(final int value)
     }
 
     @Test
-    // [utest->dsn~reporting.html.summary-line~1]
+    // [utest->dsn~reporting.html.summary~2]
     void testRenderTransitiveDefects()
     {
         when(this.traceMock.hasNoDefects()).thenReturn(false);

reporter/plaintext/src/main/java/org/itsallcode/openfasttrace/report/plaintext/PlainTextReport.java

@@ -138,8 +138,7 @@ private String translateItemStatus(final LinkedSpecificationItem item)
         return this.formatter.formatNotOk(NOT_OK);
     }
 
-    // [impl->dsn~reporting.plain-text.summary~2]
-    // [impl->dsn~reporting.plain-text.summary-line~1]
+    // [impl->dsn~reporting.plain-text.summary~3]
     private void renderSummary(final PrintStream report)
     {
         report.print(translateStatus(this.trace.hasNoDefects()));

reporter/plaintext/src/test/java/org/itsallcode/openfasttrace/report/plaintext/TestPlainTextReport.java

@@ -106,7 +106,7 @@ void testReport_LevelMinimal_NotOk()
     }
 
     @Test
-    // [utest->dsn~reporting.plain-text.summary~2]
+    // [utest->dsn~reporting.plain-text.summary~3]
     void testReport_LevelSummary_OK()
     {
         when(this.traceMock.hasNoDefects()).thenReturn(true);
@@ -115,8 +115,7 @@ void testReport_LevelSummary_OK()
     }
 
     @Test
-    // [utest->dsn~reporting.plain-text.summary~2]
-    // [utest->dsn~reporting.plain-text.summary-line~1]
+    // [utest->dsn~reporting.plain-text.summary~3]
     void testReport_LevelSummary_NotOK()
     {
         when(this.traceMock.hasNoDefects()).thenReturn(true);
@@ -165,7 +164,7 @@ void testReport_LevelFailureSummaries_NotOK()
 
     @Test
     // [utest->dsn~reporting.plain-text.transitive-defect~1]
-    // [utest->dsn~reporting.plain-text.summary-line~1]
+    // [utest->dsn~reporting.plain-text.summary~3]
     void testReport_LevelMinimal_TransitiveDefect()
     {
         final LinkedSpecificationItem transitiveDefectMock = mock(LinkedSpecificationItem.class);