Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow escaped json to survive rendering #5

Merged
merged 10 commits into from
Jul 21, 2023
Merged

Allow escaped json to survive rendering #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0d15c31
add option to .dump() strings instead of .get<std::string>()
jbohanon Jul 19, 2023
a7972bb
strip leading and trailing " to preserve expected behavior
jbohanon Jul 19, 2023
6bfec7e
add comments
jbohanon Jul 19, 2023
06f201a
update single include
jbohanon Jul 20, 2023
0294efa
don't run push CI
jbohanon Jul 20, 2023
9d55f26
Merge pull request #4 from solo-io/disable-push-ci
jbohanon Jul 20, 2023
93b6d8b
Merge remote-tracking branch 'origin/envoy-gloo' into allow-escaped-j…
jbohanon Jul 20, 2023
72ba73f
remove R formatting attempting to appease windows compiler
jbohanon Jul 20, 2023
7963ad5
put push back to match upstream and reduce complexity
jbohanon Jul 20, 2023
d344759
Merge branch 'envoy-gloo-main' into allow-escaped-json-fork
jbohanon Jul 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions include/inja/config.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ struct ParserConfig {
*/
struct RenderConfig {
bool throw_at_missing_includes {true};
bool escape_strings {};
};

} // namespace inja
Expand Down
5 changes: 5 additions & 0 deletions include/inja/environment.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
15 changes: 14 additions & 1 deletion include/inja/renderer.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Comment on lines +60 to +67
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one last thing i just noticed.. if this is already known to be a string, can we just get the string value instead of dumping as json?

i.e.

// store a string in a JSON value
json j_string = "this is a string";

// retrieve the string value
auto cpp_string = j_string.template get<std::string>();

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

per readme in https://github.com/nlohmann/json

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .get<std::string>() does not escape characters, whereas .dump() does.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah thanks, i misunderstood. lgtm

} 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()) {
Expand Down
21 changes: 20 additions & 1 deletion single_include/inja/inja.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,7 @@ struct ParserConfig {
*/
struct RenderConfig {
bool throw_at_missing_includes {true};
bool escape_strings {};
};

} // namespace inja
Expand Down Expand Up @@ -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()) {
Expand Down Expand Up @@ -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;
Expand Down
6 changes: 6 additions & 0 deletions test/test-renderer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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");
Expand Down