Remarkup support

Author: An Nguyen

src/main/java/io/nthienan/phdiff/comment/RemarkupUtils.java

@@ -0,0 +1,105 @@
+package io.nthienan.phdiff.comment;
+
+import org.apache.commons.lang.StringUtils;
+import org.sonar.api.CoreProperties;
+import org.sonar.api.batch.BatchSide;
+import org.sonar.api.batch.InstantiationStrategy;
+import org.sonar.api.batch.rule.Severity;
+import org.sonar.api.config.Settings;
+
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+
+/**
+ * Support Remarkup format <br\>
+ * References: {@code https://secure.phabricator.com/book/phabricator/article/remarkup}
+ *
+ * @author nthienan
+ */
+@BatchSide
+@InstantiationStrategy(InstantiationStrategy.PER_BATCH)
+public class RemarkupUtils {
+
+    private final String ruleUrlPrefix;
+    private final String projectKey;
+
+    public static String bold(String str) {
+        return String.format("**%s**", str);
+    }
+
+    public static String italics(String str) {
+        return String.format("//%s//", str);
+    }
+
+    public static String code(String str) {
+        return String.format("`%s`", str);
+    }
+
+    public static String icon(String icon, String color) {
+        String colorStr = "";
+        if (StringUtils.isNotBlank(color)) {
+            colorStr = "color=" + color;
+        }
+        return String.format("{icon %s %s}", icon, colorStr);
+    }
+
+    public static String link(String url, String title) {
+        if (StringUtils.isNotBlank(title)) {
+            return String.format("[[%s|%s]]", encodeForUrl(url), title);
+        }
+        return encodeForUrl(url);
+    }
+
+    public static String encodeForUrl(String url) {
+        try {
+            return URLEncoder.encode(url, "UTF-8");
+        } catch (UnsupportedEncodingException e) {
+            throw new IllegalStateException("Encoding not supported", e);
+        }
+    }
+
+    public RemarkupUtils(Settings settings) {
+        // If server base URL was not configured in SQ server then is is better to take URL configured on batch side
+        String baseUrl = settings.hasKey(CoreProperties.SERVER_BASE_URL) ? settings.getString(CoreProperties.SERVER_BASE_URL) : settings.getString("sonar.host.url");
+        this.projectKey = settings.getString(CoreProperties.PROJECT_KEY_PROPERTY);
+        if (!baseUrl.endsWith("/")) {
+            baseUrl += "/";
+        }
+        this.ruleUrlPrefix = baseUrl;
+    }
+
+    public String icon(Severity severity) {
+        String result;
+        switch (severity) {
+            case BLOCKER:
+                result = icon("bug", "red");
+                break;
+            case CRITICAL:
+                result = icon("arrow-circle-up", "red");
+                break;
+            case MINOR:
+                result = icon("info-circle", "green");
+                break;
+            case INFO:
+                result = icon("chevron-circle-down", "green");
+                break;
+            default:
+                // Major
+                result = icon("chevron-circle-up", "red");
+        }
+        return result;
+    }
+
+    public String source(String componentKey, int line) {
+        return String.format("%s - %s", italics(String.valueOf(line)), code(componentKey.replace(projectKey, "")));
+    }
+
+    public String message(String message) {
+        return message;
+    }
+
+    public String rule(String ruleKey) {
+        return link(String.format("%s/coding_rules#rule_key=%s", this.ruleUrlPrefix, ruleKey), "View rule");
+    }
+
+}