feat: Enhance metadata generation with HATEOAS links and simplify structure

Author: jycr

build/main/java/org/greencodeinitiative/tools/exporter/infra/MetadataWriter.java

@@ -23,6 +23,8 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import static jakarta.json.Json.createArrayBuilder;
+import static jakarta.json.Json.createObjectBuilder;
 import static java.lang.System.Logger.Level.DEBUG;
 
 public class MetadataWriter implements Runnable {
@@ -53,18 +55,49 @@ public void run() {
         var rulesMap = new TreeMap<String, JsonObjectBuilder>();
 
         getResourcesToCopy().forEach(rule -> {
-            var rulesByLanguage = rulesMap.computeIfAbsent(rule.ruleKey(), k -> Json.createObjectBuilder());
+            var rulesByLanguage = rulesMap.computeIfAbsent(rule.ruleKey(), k -> createObjectBuilder());
             var resultMetadata = mergeOrCopyJsonMetadata(rule.metadata(), rule.specificMetadata(), rule.getMetadataTargetPath(targetDir));
 
             var htmlDescriptionRelativePath = this.indexFilepath.getParent()
                     .relativize(rule.getHtmlDescriptionTargetPath(targetDir))
                     .toString();
-            var resultMetadataBuilder = Json.createObjectBuilder(resultMetadata);
+
+            var metadataRelativePath = this.indexFilepath.getParent()
+                    .relativize(rule.getMetadataTargetPath(targetDir))
+                    .toString();
+
+            var descriptionLinkJsonObject = createObjectBuilder();
+            descriptionLinkJsonObject.add("rel", "description");
+            descriptionLinkJsonObject.add("title", resultMetadata.get("title"));
+            descriptionLinkJsonObject.add("href", htmlDescriptionRelativePath);
+            descriptionLinkJsonObject.add("hreflang", "en");
+
+            var metadataLinkJsonObject = createObjectBuilder();
+            metadataLinkJsonObject.add("rel", "metadata");
+            metadataLinkJsonObject.add("href", metadataRelativePath);
+
+            var linksJsonArray = createArrayBuilder();
+            linksJsonArray.add(descriptionLinkJsonObject);
+            linksJsonArray.add(metadataLinkJsonObject);
+
+            var resultMetadataBuilder = createObjectBuilder();
             resultMetadataBuilder.add("key", rule.ruleKey());
             resultMetadataBuilder.add("language", rule.language());
-            resultMetadataBuilder.add("severity", resultMetadata.getString("defaultSeverity").toUpperCase(Locale.ENGLISH));
-            resultMetadataBuilder.add("htmlDescription", htmlDescriptionRelativePath);
-            resultMetadataBuilder.add("terms", extractTermsFromHtmlFile(rule.htmlDescription()));
+            resultMetadataBuilder.add("links", linksJsonArray);
+            resultMetadataBuilder.add(
+                    "terms",
+                    createObjectBuilder()
+                            .add("en", extractTermsFromHtmlFile(rule.htmlDescription()))
+            );
+
+            List
+                    .of(
+                            "type",
+                            "status",
+                            "tags",
+                            "defaultSeverity"
+                    )
+                    .forEach(key -> resultMetadataBuilder.add(key, resultMetadata.get(key)));
 
             rulesByLanguage.add(rule.language(), resultMetadataBuilder);
             copyFile(rule.htmlDescription(), rule.getHtmlDescriptionTargetPath(targetDir));
@@ -102,11 +135,11 @@ private void writeIndexFile(TreeMap<String, JsonObjectBuilder> rulesMap) {
         if (indexFilepath == null) {
             return;
         }
-        var rules = Json.createObjectBuilder();
+        var rules = createObjectBuilder();
         rulesMap.forEach(rules::add);
-        var result = Json.createObjectBuilder();
+        var result = createObjectBuilder();
 
-        var specification = Json.createObjectBuilder();
+        var specification = createObjectBuilder();
         this.specificationInfo.forEach(specification::add);
         result.add("specification", specification);