Allow escaped json to survive rendering (#5)

* add option to .dump() strings instead of .get<std::string>()

* strip leading and trailing " to preserve expected behavior

* add comments

* update single include

* don't run push CI

* remove R formatting attempting to appease windows compiler

* put push back to match upstream and reduce complexity

Author: jbohanon

include/inja/config.hpp

@@ -80,6 +80,7 @@ struct ParserConfig {
  */
 struct RenderConfig {
   bool throw_at_missing_includes {true};
+  bool escape_strings {};
 };
 
 } // namespace inja

include/inja/environment.hpp

@@ -88,6 +88,11 @@ class Environment {
     lexer_config.notation = notation;
   }
 
+  /// Sets the config for rendering strings raw or escaped
+  void set_escape_strings(bool escape_strings) {
+      render_config.escape_strings = escape_strings;
+  }
+
   /// Sets the element notation syntax
   void set_search_included_templates_in_files(bool search_in_files) {
     parser_config.search_included_templates_in_files = search_in_files;

include/inja/renderer.hpp

@@ -55,7 +55,20 @@ class Renderer : public NodeVisitor {
 
   void print_data(const std::shared_ptr<json> value) {
     if (value->is_string()) {
-      *output_stream << value->get_ref<const json::string_t&>();
+      std::string val;
+      if (config.escape_strings) {
+        // get the value as a dump() to properly escape values
+        val = value->dump();
+
+        // strip the leading and trailing " characters that are added by dump()
+        // if C++20 is adopted, val.starts_with and val.ends_with would clean this up a bit
+        val = val.substr(0,1) == "\"" && val.substr(val.length()-1,1) == "\""
+            ? val.substr(1, val.length()-2)
+            : val;
+      } else {
+        val = value->get_ref<const json::string_t&>();
+      }
+      *output_stream << val;
     } else if (value->is_number_integer()) {
       *output_stream << value->get<const json::number_integer_t>();
     } else if (value->is_null()) {

single_include/inja/inja.hpp

@@ -906,6 +906,7 @@ struct ParserConfig {
  */
 struct RenderConfig {
   bool throw_at_missing_includes {true};
+  bool escape_strings {};
 };
 
 } // namespace inja
@@ -2150,7 +2151,20 @@ class Renderer : public NodeVisitor {
 
   void print_data(const std::shared_ptr<json> value) {
     if (value->is_string()) {
-      *output_stream << value->get_ref<const json::string_t&>();
+      std::string val;
+      if (config.escape_strings) {
+        // get the value as a dump() to properly escape values
+        val = value->dump();
+
+        // strip the leading and trailing " characters that are added by dump()
+        // if C++20 is adopted, val.starts_with and val.ends_with would clean this up a bit
+        val = val.substr(0,1) == "\"" && val.substr(val.length()-1,1) == "\""
+            ? val.substr(1, val.length()-2)
+            : val;
+      } else {
+        val = value->get_ref<const json::string_t&>();
+      }
+      *output_stream << val;
     } else if (value->is_number_integer()) {
       *output_stream << value->get<const json::number_integer_t>();
     } else if (value->is_null()) {
@@ -2803,6 +2817,11 @@ class Environment {
     lexer_config.notation = notation;
   }
 
+  /// Sets the config for rendering strings raw or escaped
+  void set_escape_strings(bool escape_strings) {
+      render_config.escape_strings = escape_strings;
+  }
+
   /// Sets the element notation syntax
   void set_search_included_templates_in_files(bool search_in_files) {
     parser_config.search_included_templates_in_files = search_in_files;

test/test-renderer.cpp

@@ -18,6 +18,7 @@ TEST_CASE("types") {
   data["relatives"]["brother"] = "Chris";
   data["relatives"]["sister"] = "Jenny";
   data["vars"] = {2, 3, 4, 0, -1, -2, -3};
+  data["quoted"] = "\"quoted value\"";
   data["json_pointers"]["example.com"] = "online";
   data["json_pointers"]["and/or"] = "slash";
   data["json_pointers"]["and~or"] = "tilde";
@@ -42,6 +43,11 @@ TEST_CASE("types") {
     CHECK(env.render("{{ @name }}", data) == "@name");
     CHECK(env.render("{{ $name }}", data) == "$name");
 
+    CHECK(env.render("{\"Value\":\"{{ quoted }}\"}", data) == "{\"Value\":\"\"quoted value\"\"}");
+    env.set_escape_strings(true);
+    CHECK(env.render("{\"Value\":\"{{ quoted }}\"}", data) == "{\"Value\":\"\\\"quoted value\\\"\"}");
+    env.set_escape_strings(false);
+
     env.set_element_notation(inja::ElementNotation::Pointer);
     CHECK(env.render("{{ json_pointers/example.com }}", data) == "online");
     CHECK(env.render("{{ json_pointers/and~1or }}", data) == "slash");