maciejhirsz / ramhorns

Fast Mustache template engine implementation in pure Rust.
https://crates.io/crates/ramhorns
Mozilla Public License 2.0
297 stars 29 forks source link

How to use ramhorns with serde_json::Value? #44

Open thesurlydev opened 3 years ago

thesurlydev commented 3 years ago

I'd like to be able to use ramhorns with arbitrary data supplied via JSON. From what I can tell, serde_json::Value fits the requirement for doing this but ramhorns uses a derive trait which won't work with serde_json::Value because it's an enum.

Is there a workaround or an easier way to accomplish using arbitrary data with ramhorns that doesn't require using the ramhorns::Content trait?

maciejhirsz commented 3 years ago

Ramhorns supports HashMaps and BTreeMaps so you can construct arbitrary dynamic structures that way. To work with serde_json::Value directly the Content trait would need to be implemented for it, we could add it to the ramhorns crate via a feature with optional serde_json dependency.

This should be a good first issue if anyone wants to drop a PR, I might not have time to tackle this within the next week or two.

thesurlydev commented 3 years ago

I will try implementing Content trait for serde_json::Value

thesurlydev commented 3 years ago

If serde_json is to be an optional dependency, then how shall I organize the added support for serde_json::Value? I'm somewhat new to Rust, so providing as much detail as possible would be appreciated.

maciejhirsz commented 3 years ago

Just put the impl for serde_json::Value in a separate module, like serde.rs. In lib.rs do a conditional import:

#[cfg(feature = "json")]
mod serde;

Adding serde_json as optional feature in Cargo.toml:

[dependencies]
# ...all the other deps
serde_json = { version = "1.0", optional = true }

[features]
default = []

# Implements `Content` for `serde_json::Value`
json = ["serde_json"]

That way enabling the json feature will build Ramhorns with serde_json and the module that contains the trait impl.

eeyun commented 3 years ago

I think I might be hitting this as well.

But to make sure - there is no alternative means of using arbitary json (even if say, converted to some string type) with a template and ramhorns today, correct? I've been unsuccessful anyways.

If that is the case then I'm a huge :+1: on this feature request and I would be curious to know if there has been any progress on the feature!

maciejhirsz commented 3 years ago

@eeyun don't think there has been, happy to accept a PR.

eeyun commented 3 years ago

Cool I just wanted to make sure. It would be a great feature. I may try to get something together for it but a bit underwater currently. Thanks for maintaining the project either way!