Merge 79736b4 into c84eaa4

briandonahue · web-flow · commit c597c8eafff7 · 2023-05-25T16:24:06.000Z
diff --git a/main/build.gradle b/main/build.gradle
@@ -46,6 +46,7 @@ dependencies {
     implementation 'com.univocity:univocity-parsers:2.9.0'
     implementation 'com.google.geometry:s2-geometry:2.0.0'
     implementation 'org.thymeleaf:thymeleaf:3.0.15.RELEASE'
+    implementation 'com.vladsch.flexmark:flexmark-all:0.64.8'
     implementation 'io.github.classgraph:classgraph:4.8.146'
     testImplementation group: 'junit', name: 'junit', version: '4.13'
     testImplementation 'com.google.truth:truth:1.0.1'
diff --git a/main/src/main/java/org/mobilitydata/gtfsvalidator/report/model/NoticeView.java b/main/src/main/java/org/mobilitydata/gtfsvalidator/report/model/NoticeView.java
@@ -1,21 +1,28 @@
 package org.mobilitydata.gtfsvalidator.report.model;
 
 import com.google.gson.JsonObject;
+import com.vladsch.flexmark.html.HtmlRenderer;
+import com.vladsch.flexmark.parser.Parser;
+import com.vladsch.flexmark.util.ast.Document;
 import java.util.ArrayList;
 import java.util.List;
 import org.mobilitydata.gtfsvalidator.notice.Notice;
+import org.mobilitydata.gtfsvalidator.notice.NoticeDocComments;
 import org.mobilitydata.gtfsvalidator.notice.SeverityLevel;
+import org.mobilitydata.gtfsvalidator.notice.schema.NoticeSchemaGenerator;
 
 /** NoticeView is a wrapper class to display a Notice. */
 public class NoticeView {
   private final Notice notice;
   private final JsonObject json;
   private final List<String> fields;
+  private final NoticeDocComments comments;
 
   public NoticeView(Notice notice) {
     this.notice = notice;
     this.json = notice.getContext().getAsJsonObject();
     this.fields = new ArrayList<>(json.keySet());
+    this.comments = NoticeSchemaGenerator.loadComments(notice.getClass());
   }
 
   /**
@@ -55,6 +62,28 @@ public SeverityLevel getSeverityLevel() {
     return notice.getSeverityLevel();
   }
 
+  /**
+   * Returns the description text for the notice.
+   *
+   * @return description text
+   */
+  public String getCommentForField(String field) {
+    return comments.getFieldComment(field);
+  }
+  /**
+   * Returns the description text for the notice.
+   *
+   * @return description text
+   */
+  public String getDescription() {
+    String markdown = this.comments.getDocComment();
+
+    Parser parser = Parser.builder().build();
+    Document document = parser.parse(markdown == null ? "" : markdown);
+    HtmlRenderer renderer = HtmlRenderer.builder().build();
+    return renderer.render(document);
+  }
+
   /**
    * Returns a descriptive type-specific name for this notice class simple name.
    *
diff --git a/main/src/main/resources/report.html b/main/src/main/resources/report.html
