feat: revert the spine/toc nav order check to a WARNING (#1056)

rdeltour · web-flow · commit 1f6a882720f6 · 2019-07-17T17:14:15.000+02:00
* feat: revert the spine/toc nav order check to a WARNING As agreed on the 2019-07-11 EPUB CG call: https://www.w3.org/2019/07/11-epub3cg-minutes.html - changes the behavior introduced in #999 - adds an INFO message about NAV_011 being subject to change Fixes #1036
diff --git a/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java b/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java
@@ -34,6 +34,8 @@ private void initialize()
     {
       return;
     }
+    // Info
+    severities.put(MessageId.INF_001, Severity.INFO);
 
     // Accessibility
     severities.put(MessageId.ACC_001, Severity.USAGE);
@@ -154,7 +156,7 @@ private void initialize()
     severities.put(MessageId.NAV_008, Severity.USAGE);
     severities.put(MessageId.NAV_009, Severity.ERROR);
     severities.put(MessageId.NAV_010, Severity.ERROR);
-    severities.put(MessageId.NAV_011, Severity.ERROR);
+    severities.put(MessageId.NAV_011, Severity.WARNING);
 
     // NCX
     severities.put(MessageId.NCX_001, Severity.ERROR);
diff --git a/src/main/java/com/adobe/epubcheck/messages/MessageId.java b/src/main/java/com/adobe/epubcheck/messages/MessageId.java
@@ -28,6 +28,9 @@
 
 public enum MessageId implements Comparable<MessageId>
 {
+  // General info messages
+  INF_001("INF-001"),
+  
   // Messages relating to accessibility
   ACC_001("ACC-001"),
   ACC_002("ACC-002"),
diff --git a/src/main/java/com/adobe/epubcheck/opf/XRefChecker.java b/src/main/java/com/adobe/epubcheck/opf/XRefChecker.java
@@ -548,6 +548,8 @@ private void checkReadingOrder(Queue<Reference> references, int lastSpinePositio
       report.message(MessageId.NAV_011,
           EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber),
           (ref.type == Type.NAV_TOC_LINK) ? "toc" : "page-list", ref.value, orderContext);
+      report.message(MessageId.INF_001,
+          EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber), "ERROR", "https://github.com/w3c/publ-epub-revision/issues/1283");
       lastSpinePosition = targetSpinePosition;
       lastAnchorPosition = -1;
     }
@@ -570,6 +572,8 @@ private void checkReadingOrder(Queue<Reference> references, int lastSpinePositio
         report.message(MessageId.NAV_011,
             EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber),
             (ref.type == Type.NAV_TOC_LINK) ? "toc" : "page-list", ref.value, orderContext);
+        report.message(MessageId.INF_001,
+            EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber), "ERROR", "https://github.com/w3c/publ-epub-revision/issues/1283");
       }
       lastAnchorPosition = targetAnchorPosition;
     }
diff --git a/src/main/resources/com/adobe/epubcheck/messages/MessageBundle.properties b/src/main/resources/com/adobe/epubcheck/messages/MessageBundle.properties
@@ -1,5 +1,8 @@
 # This is the default MessageBundle.properties file
 
+#Info
+INF_001=The previous rule is under review and may change to an '%1$s' in a future release. See the discussion at %2$s
+
 #Accessibility
 ACC_001='img' or 'area' HTML element has no 'alt' attribute.
 ACC_002='input' HTML element is not referenced by a corresponding label element.
diff --git a/src/test/java/com/adobe/epubcheck/api/Epub30CheckExpandedTest.java b/src/test/java/com/adobe/epubcheck/api/Epub30CheckExpandedTest.java
@@ -213,15 +213,17 @@ public void testValidateNav_TocInReadingOrder()
   public void testValidateNav_TocWrongOrderInSpine()
   {
     // test that toc nav links MUST be in spine order 
-    expectedErrors.add(MessageId.NAV_011);
+    expectedWarnings.add(MessageId.NAV_011);
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-toc-unordered-spine");
   }
 
   @Test
   public void testValidateNav_TocWrongOrderOfFragments()
   {
     // test that toc nav links MUST be in document order
-    expectedErrors.addAll(Collections.nCopies(2, MessageId.NAV_011));
+    expectedWarnings.addAll(Collections.nCopies(2, MessageId.NAV_011));
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-toc-unordered-fragments");
   }
   
@@ -236,15 +238,17 @@ public void testValidateNav_PageListInReadingOrder()
   public void testValidateNav_PageListWrongOrderInSpine()
   {
     // test that page-list nav links MUST be in spine order 
-    expectedErrors.add(MessageId.NAV_011);
+    expectedWarnings.add(MessageId.NAV_011);
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-page-list-unordered-spine");
   }
   
   @Test
   public void testValidateNav_PageListWrongOrderOfFragments()
   {
     // test that page-list nav links MUST be in document order
-    expectedErrors.add(MessageId.NAV_011);
+    expectedWarnings.add(MessageId.NAV_011);
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-page-list-unordered-fragments");
   }
 

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,9 @@`
`28`	`28`
`29`	`29`	`public enum MessageId implements Comparable<MessageId>`
`30`	`30`	`{`
	`31`	`+ // General info messages`
	`32`	`+ INF_001("INF-001"),`
	`33`	`+`
`31`	`34`	`// Messages relating to accessibility`
`32`	`35`	`ACC_001("ACC-001"),`
`33`	`36`	`ACC_002("ACC-002"),`
Original file line number	Diff line number	Diff line change
`@@ -548,6 +548,8 @@ private void checkReadingOrder(Queue<Reference> references, int lastSpinePositio`
`548`	`548`	`report.message(MessageId.NAV_011,`
`549`	`549`	`EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber),`
`550`	`550`	`(ref.type == Type.NAV_TOC_LINK) ? "toc" : "page-list", ref.value, orderContext);`
	`551`	`+ report.message(MessageId.INF_001,`
	`552`	`+ EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber), "ERROR", "https://github.com/w3c/publ-epub-revision/issues/1283");`
`551`	`553`	`lastSpinePosition = targetSpinePosition;`
`552`	`554`	`lastAnchorPosition = -1;`
`553`	`555`	`}`
`@@ -570,6 +572,8 @@ private void checkReadingOrder(Queue<Reference> references, int lastSpinePositio`
`570`	`572`	`report.message(MessageId.NAV_011,`
`571`	`573`	`EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber),`
`572`	`574`	`(ref.type == Type.NAV_TOC_LINK) ? "toc" : "page-list", ref.value, orderContext);`
	`575`	`+ report.message(MessageId.INF_001,`
	`576`	`+ EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber), "ERROR", "https://github.com/w3c/publ-epub-revision/issues/1283");`
`573`	`577`	`}`
`574`	`578`	`lastAnchorPosition = targetAnchorPosition;`
`575`	`579`	`}`
Original file line number	Diff line number	Diff line change
`@@ -213,15 +213,17 @@ public void testValidateNav_TocInReadingOrder()`
`213`	`213`	`public void testValidateNav_TocWrongOrderInSpine()`
`214`	`214`	`{`
`215`	`215`	`// test that toc nav links MUST be in spine order`
`216`		`- expectedErrors.add(MessageId.NAV_011);`
	`216`	`+ expectedWarnings.add(MessageId.NAV_011);`
	`217`	`+ expectedInfos.add(MessageId.INF_001);`
`217`	`218`	`testValidateDocument("invalid/nav-toc-unordered-spine");`
`218`	`219`	`}`
`219`	`220`
`220`	`221`	`@Test`
`221`	`222`	`public void testValidateNav_TocWrongOrderOfFragments()`
`222`	`223`	`{`
`223`	`224`	`// test that toc nav links MUST be in document order`
`224`		`- expectedErrors.addAll(Collections.nCopies(2, MessageId.NAV_011));`
	`225`	`+ expectedWarnings.addAll(Collections.nCopies(2, MessageId.NAV_011));`
	`226`	`+ expectedInfos.add(MessageId.INF_001);`
`225`	`227`	`testValidateDocument("invalid/nav-toc-unordered-fragments");`
`226`	`228`	`}`
`227`	`229`
`@@ -236,15 +238,17 @@ public void testValidateNav_PageListInReadingOrder()`
`236`	`238`	`public void testValidateNav_PageListWrongOrderInSpine()`
`237`	`239`	`{`
`238`	`240`	`// test that page-list nav links MUST be in spine order`
`239`		`- expectedErrors.add(MessageId.NAV_011);`
	`241`	`+ expectedWarnings.add(MessageId.NAV_011);`
	`242`	`+ expectedInfos.add(MessageId.INF_001);`
`240`	`243`	`testValidateDocument("invalid/nav-page-list-unordered-spine");`
`241`	`244`	`}`
`242`	`245`
`243`	`246`	`@Test`
`244`	`247`	`public void testValidateNav_PageListWrongOrderOfFragments()`
`245`	`248`	`{`
`246`	`249`	`// test that page-list nav links MUST be in document order`
`247`		`- expectedErrors.add(MessageId.NAV_011);`
	`250`	`+ expectedWarnings.add(MessageId.NAV_011);`
	`251`	`+ expectedInfos.add(MessageId.INF_001);`
`248`	`252`	`testValidateDocument("invalid/nav-page-list-unordered-fragments");`
`249`	`253`	`}`
`250`	`254`