Treant.js formatted JSON from parse tree representation (#36)

bisakhmondal · web-flow · commit ff68984f30a5 · 2021-05-09T20:50:02.000+05:30
* Treant Formatted JSON

* debug removed

* new edge case test added

* updates

* codecov

* Stuructural change

* codecov will be handled in seperate PR
diff --git a/src/include/parser/parser.h b/src/include/parser/parser.h
@@ -72,6 +72,20 @@ class Parser {
    */
   static std::string GenerateErrorMessage(const std::string &current_token);
 
+  /**
+   * Supportive function for Parser::FormattedJSON
+   * @param value
+   * @return { text: { name: "value" } }
+   */
+  static json GetTextNode(const std::string & /* value */);
+
+  /**
+   * Utility recursive function for Parser::FormattedJSON
+   * @param body, a json
+   * @returns Treant.js formatted JSON
+   */
+  static json RecRunner(const json & /*main*/, std::string /* key */);
+
  public:
   /**
    * Constructor for initializing stack and other members.
@@ -106,9 +120,18 @@ class Parser {
 
   /**
    * Dumps the parse tree in given path in json format
+   * @param filepath
+   * @param formatted (Default is in Treant.js format else raw if value is set "false")
    * @returns true on success
    */
-  bool WriteParseTree(const std::string &filepath);
+  bool WriteParseTree(const std::string &filepath, bool formatted);
+
+  /**
+   * Takes a json with no array, ideally received from parser::GetParseTree()
+   * Format is given here https://fperucic.github.io/treant-js/
+   * @returns a formatted JSON which acts as a input for Treant.js
+   */
+  [[maybe_unused]] [[nodiscard]] static json FormattedJSON(const json & /* body */);
 
   /* getters and setters*/
   void SetInputString(std::vector<std::string> inps);
diff --git a/src/parser/parser.cpp b/src/parser/parser.cpp
@@ -160,14 +160,41 @@ void Parser::BuildParseTree() {
   }
 }
 
-bool Parser::WriteParseTree(const std::string &filepath) {
+bool Parser::WriteParseTree(const std::string &filepath, bool formatted = true) {
   std::ofstream ofs(filepath);
   if (ofs.is_open()) {
-    ofs << parse_tree_.dump(INDENTATION) << '\n';
+    ofs << (formatted ? FormattedJSON(parse_tree_) : parse_tree_).dump(INDENTATION) << '\n';
     return true;
   }
-
   return false;
 }
 
+json Parser::GetTextNode(const std::string &value) {
+  json j;
+  j["text"]["name"] = value;
+  return j;
+}
+
+json Parser::RecRunner(const json &main, std::string key = "") {
+  if (main.empty()) {
+    return GetTextNode(key);
+  }
+  auto body = main;
+  if (key.empty()) {
+    for (auto it = main.begin(); it != main.end();) {
+      key = it.key();
+      body = it.value();
+      break;
+    }
+  }
+
+  json j = GetTextNode(key);
+  for (auto it = body.begin(); it != body.end(); it++) {
+    j["children"].push_back(RecRunner(it.value(), it.key()));
+  }
+  return j;
+}
+
+json Parser::FormattedJSON(const json &body) { return Parser::RecRunner(body); }
+
 }  // namespace jucc::parser
diff --git a/test/parser/parser_test.cpp b/test/parser/parser_test.cpp
@@ -363,4 +363,40 @@ TEST(parser, Parser4) {
   pars.BuildParseTree();
   auto tree = pars.GetParseTree();
   ASSERT_EQ(tree.dump(), "{\"S\":{\"A\":{\"a\":null},\"B\":{\"b\":null},\"A_1\":{\"a\":null}}}");
+
+  /**
+   * Output
+   * {
+   *    "text": { "name": "S" },
+   *    "children": [ {
+   *        "text": { "name": "A" },
+   *        "children": [
+   *                { "text": { "name": "a" } }
+   *            ] },
+   *        {
+   *        "text": {"name": "B"},
+   *        "children": [
+   *                { "text": {"name": "b"} }
+   *             ] },
+   *         {
+   *         "text": { "name": "A_1" },
+   *         "children": [
+   *                { "text": { "name": "a" }
+   *                } ]
+   *          }
+   *     ]
+   * }
+   */
+  json formatted = Parser::FormattedJSON(tree);
+  ASSERT_EQ(formatted.dump(),
+            "{\"text\":{\"name\":\"S\"},\"children\":[{\"text\":{\"name\":\"A\"},\"children\":[{\"text\":{\"name\":"
+            "\"a\"}}]},{\"text\":{\"name\":\"B\"},\"children\":[{\"text\":{\"name\":\"b\"}}]},{\"text\":{\"name\":\"A_"
+            "1\"},\"children\":[{\"text\":{\"name\":\"a\"}}]}]}");
+}
+
+TEST(parser, parser5) {
+  json j;
+  j["S"] = nullptr;
+  // No children case
+  ASSERT_EQ(Parser::FormattedJSON(j).dump(), "{\"text\":{\"name\":\"S\"}}");
 }
