1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
use crate::context::Context;
use crate::error::RenderError;
use crate::registry::Registry;
use crate::render::{Decorator, RenderContext};
pub use self::inline::INLINE_DECORATOR;
pub type DecoratorResult = Result<(), RenderError>;
/// Decorator Definition
///
/// Implement this trait to define your own decorators. Currently decorator
/// shares same definition with helper.
///
/// In handlebars, it is recommended to use decorator to change context data and update helper
/// definition.
/// ## Updating context data
///
/// In decorator, you can change some context data you are about to render.
///
/// ```
/// use handlebars::*;
///
/// fn update_data<'reg: 'rc, 'rc>(_: &Decorator, _: &Handlebars, ctx: &Context, rc: &mut RenderContext)
/// -> Result<(), RenderError> {
/// // modify json object
/// let mut new_ctx = ctx.clone();
/// {
/// let mut data = new_ctx.data_mut();
/// if let Some(ref mut m) = data.as_object_mut() {
/// m.insert("hello".to_string(), to_json("world"));
/// }
/// }
/// rc.set_context(new_ctx);
/// Ok(())
/// }
///
/// ```
///
/// ## Define local helper
///
/// You can override behavior of a helper from position of decorator to the end of template.
///
/// ```
/// use handlebars::*;
///
/// fn override_helper(_: &Decorator, _: &Handlebars, _: &Context, rc: &mut RenderContext)
/// -> Result<(), RenderError> {
/// let new_helper = |h: &Helper, _: &Handlebars, _: &Context, rc: &mut RenderContext, out: &mut dyn Output|
/// -> Result<(), RenderError> {
/// // your helper logic
/// Ok(())
/// };
/// rc.register_local_helper("distance", Box::new(new_helper));
/// Ok(())
/// }
/// ```
///
pub trait DecoratorDef {
fn call<'reg: 'rc, 'rc>(
&'reg self,
d: &Decorator<'reg, 'rc>,
r: &'reg Registry<'reg>,
ctx: &'rc Context,
rc: &mut RenderContext<'reg, 'rc>,
) -> DecoratorResult;
}
/// Implement DecoratorDef for bare function so we can use function as decorator
impl<
F: for<'reg, 'rc> Fn(
&Decorator<'reg, 'rc>,
&'reg Registry<'reg>,
&'rc Context,
&mut RenderContext<'reg, 'rc>,
) -> DecoratorResult,
> DecoratorDef for F
{
fn call<'reg: 'rc, 'rc>(
&'reg self,
d: &Decorator<'reg, 'rc>,
reg: &'reg Registry<'reg>,
ctx: &'rc Context,
rc: &mut RenderContext<'reg, 'rc>,
) -> DecoratorResult {
(*self)(d, reg, ctx, rc)
}
}
mod inline;
#[cfg(test)]
mod test {
use crate::context::Context;
use crate::error::RenderError;
use crate::json::value::{as_string, to_json};
use crate::output::Output;
use crate::registry::Registry;
use crate::render::{Decorator, Helper, RenderContext};
#[test]
fn test_register_decorator() {
let mut handlebars = Registry::new();
handlebars
.register_template_string("t0", "{{*foo}}".to_string())
.unwrap();
let data = json!({
"hello": "world"
});
assert!(handlebars.render("t0", &data).is_err());
handlebars.register_decorator(
"foo",
Box::new(
|_: &Decorator<'_, '_>,
_: &Registry<'_>,
_: &Context,
_: &mut RenderContext<'_, '_>|
-> Result<(), RenderError> { Ok(()) },
),
);
assert_eq!(handlebars.render("t0", &data).ok().unwrap(), "".to_string());
}
// updating context data disabled for now
#[test]
fn test_update_data_with_decorator() {
let mut handlebars = Registry::new();
handlebars
.register_template_string("t0", "{{hello}}{{*foo}}{{hello}}".to_string())
.unwrap();
let data = json!({
"hello": "world"
});
handlebars.register_decorator(
"foo",
Box::new(
|_: &Decorator<'_, '_>,
_: &Registry<'_>,
ctx: &Context,
rc: &mut RenderContext<'_, '_>|
-> Result<(), RenderError> {
// modify json object
let mut new_ctx = ctx.clone();
{
let data = new_ctx.data_mut();
if let Some(ref mut m) = data.as_object_mut().as_mut() {
m.insert("hello".to_string(), to_json("war"));
}
}
rc.set_context(new_ctx);
Ok(())
},
),
);
assert_eq!(
handlebars.render("t0", &data).ok().unwrap(),
"worldwar".to_string()
);
let data2 = 0;
handlebars.register_decorator(
"bar",
Box::new(
|d: &Decorator<'_, '_>,
_: &Registry<'_>,
_: &Context,
rc: &mut RenderContext<'_, '_>|
-> Result<(), RenderError> {
// modify value
let v = d
.param(0)
.and_then(|v| Context::wraps(v.value()).ok())
.unwrap_or(Context::null());
rc.set_context(v);
Ok(())
},
),
);
handlebars
.register_template_string("t1", "{{this}}{{*bar 1}}{{this}}".to_string())
.unwrap();
assert_eq!(
handlebars.render("t1", &data2).ok().unwrap(),
"01".to_string()
);
handlebars
.register_template_string(
"t2",
"{{this}}{{*bar \"string_literal\"}}{{this}}".to_string(),
)
.unwrap();
assert_eq!(
handlebars.render("t2", &data2).ok().unwrap(),
"0string_literal".to_string()
);
handlebars
.register_template_string("t3", "{{this}}{{*bar}}{{this}}".to_string())
.unwrap();
assert_eq!(
handlebars.render("t3", &data2).ok().unwrap(),
"0".to_string()
);
}
#[test]
fn test_local_helper_with_decorator() {
let mut handlebars = Registry::new();
handlebars
.register_template_string(
"t0",
"{{distance 4.5}},{{*foo \"miles\"}}{{distance 10.1}},{{*bar}}{{distance 3.4}}"
.to_string(),
)
.unwrap();
handlebars.register_helper(
"distance",
Box::new(
|h: &Helper<'_, '_>,
_: &Registry<'_>,
_: &Context,
_: &mut RenderContext<'_, '_>,
out: &mut dyn Output|
-> Result<(), RenderError> {
write!(
out,
"{}m",
h.param(0)
.as_ref()
.map(|v| v.value())
.unwrap_or(&to_json(0))
)?;
Ok(())
},
),
);
handlebars.register_decorator(
"foo",
Box::new(
|d: &Decorator<'_, '_>,
_: &Registry<'_>,
_: &Context,
rc: &mut RenderContext<'_, '_>|
-> Result<(), RenderError> {
let new_unit = d
.param(0)
.as_ref()
.and_then(|v| as_string(v.value()))
.unwrap_or("")
.to_owned();
let new_helper = move |h: &Helper<'_, '_>,
_: &Registry<'_>,
_: &Context,
_: &mut RenderContext<'_, '_>,
out: &mut dyn Output|
-> Result<(), RenderError> {
write!(
out,
"{}{}",
h.param(0)
.as_ref()
.map(|v| v.value())
.unwrap_or(&to_json(0)),
new_unit
)?;
Ok(())
};
rc.register_local_helper("distance", Box::new(new_helper));
Ok(())
},
),
);
handlebars.register_decorator(
"bar",
Box::new(
|_: &Decorator<'_, '_>,
_: &Registry<'_>,
_: &Context,
rc: &mut RenderContext<'_, '_>|
-> Result<(), RenderError> {
rc.unregister_local_helper("distance");
Ok(())
},
),
);
assert_eq!(
handlebars.render("t0", &0).ok().unwrap(),
"4.5m,10.1miles,3.4m".to_owned()
);
}
}