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
use std::collections::HashMap;
use crate::{
builtin::{
filter::{self, FilterFn},
function::{self, FunctionFn},
},
engine::Engine,
};
/// A custom engine builder
///
/// Allows to build an [`Engine`] with custom filters, functions or the evaluation keyword.
///
/// [`Engine`]: struct.Engine.html
pub struct EngineBuilder {
functions: HashMap<String, FunctionFn>,
filters: HashMap<String, FilterFn>,
eval_keyword: Option<String>,
}
impl Default for EngineBuilder {
/// Creates new [`EngineBuilder`] with default filters, functions and the evaluation keyword
///
/// [`EngineBuilder`]: struct.EngineBuilder.html
fn default() -> EngineBuilder {
EngineBuilder::new()
.filter("upper", filter::upper)
.filter("lower", filter::lower)
.filter("time", filter::time)
.filter("date", filter::date)
.filter("datetime", filter::datetime)
.filter("trim", filter::trim)
.filter("slugify", filter::slugify)
.function("uuidv4", function::uuidv4)
.function("now", function::now)
}
}
impl EngineBuilder {
/// Creates new, empty, [`EngineBuilder`]
///
/// No filters and functions are registered.
///
/// [`EngineBuilder`]: struct.EngineBuilder.html
fn new() -> EngineBuilder {
EngineBuilder {
functions: HashMap::new(),
filters: HashMap::new(),
eval_keyword: None,
}
}
/// Registers custom filter
///
/// If a filter with the name already exists, it will be overwritten.
///
/// Visit [`FilterFn`] to learn more about filters.
///
/// # Arguments
///
/// * `name` - Custom filter name
/// * `filter` - Custom filter function
///
/// # Examples
///
/// ```rust
/// use balena_temen::{
/// ast::Identifier,
/// Engine, EngineBuilder, Context, Value,
/// error::*
/// };
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// fn text_filter(input: &Value, args: &HashMap<String, Value>, _: &mut Context) -> Result<Value> {
/// let input = input.as_str()
/// .ok_or_else(|| {
/// Error::with_message("invalid input type")
/// .context("expected", "string")
/// .context("value", input.to_string())
/// })?;
///
/// let trim = args.get("trim")
/// .unwrap_or_else(|| &Value::Bool(false));
/// let trim = trim
/// .as_bool()
/// .ok_or_else(|| {
/// Error::with_message("invalid argument type")
/// .context("argument", "trim")
/// .context("expected", "boolean")
/// .context("value", trim.to_string())
/// })?;
///
/// let upper = args.get("upper")
/// .unwrap_or_else(|| &Value::Bool(false));
/// let upper = upper
/// .as_bool()
/// .ok_or_else(|| {
/// Error::with_message("invalid argument type")
/// .context("argument", "upper")
/// .context("expected", "boolean")
/// .context("value", trim.to_string())
/// })?;
///
/// let result = match (trim, upper) {
/// (false, false) => input.to_string(),
/// (true, false) => input.trim().to_string(),
/// (false, true) => input.to_uppercase(),
/// (true, true) => input.trim().to_uppercase(),
/// };
///
/// Ok(Value::String(result))
/// };
///
/// let engine: Engine = EngineBuilder::default()
/// .filter("text", text_filter)
/// .into();
/// let mut ctx = Context::default();
/// let position = Identifier::default();
/// let data = Value::Null;
///
/// assert_eq!(
/// engine.eval("` abc ` | text", &position, &data, &mut ctx).unwrap(),
/// json!(" abc ")
/// );
/// assert_eq!(
/// engine.eval("` abc ` | text(trim=true)", &position, &data, &mut ctx).unwrap(),
/// json!("abc")
/// );
/// assert_eq!(
/// engine.eval("` abc ` | text(trim=true, upper=true)", &position, &data, &mut ctx).unwrap(),
/// json!("ABC")
/// );
/// ```
///
/// [`FilterFn`]: type.FilterFn.html
pub fn filter<S>(self, name: S, filter: FilterFn) -> EngineBuilder
where
S: Into<String>,
{
let mut filters = self.filters;
filters.insert(name.into(), filter);
EngineBuilder {
functions: self.functions,
filters,
eval_keyword: self.eval_keyword,
}
}
/// Registers custom function
///
/// If a function with the name already exists, it will be overwritten.
///
/// Visit [`FunctionFn`] to learn more about functions.
///
/// # Arguments
///
/// * `name` - Custom function name
/// * `function` - Custom function function
///
/// # Examples
///
/// ```rust
/// use balena_temen::{
/// ast::Identifier,
/// Engine, EngineBuilder, Context, Value,
/// error::*
/// };
/// use serde_json::json;
/// use std::collections::HashMap;
///
/// fn echo_function(args: &HashMap<String, Value>, _: &mut Context) -> Result<Value> {
/// let value = match args.get("value") {
/// Some(x) => {
/// x.as_str().ok_or_else(|| {
/// Error::with_message("invalid argument type")
/// .context("expect", "string")
/// .context("value", x.to_string())
/// })?
/// },
/// None => "echo"
/// };
///
/// Ok(Value::String(value.to_string()))
/// };
///
/// let engine: Engine = EngineBuilder::default()
/// .function("echo", echo_function)
/// .into();
/// let mut ctx = Context::default();
/// let position = Identifier::default();
/// let data = Value::Null;
///
/// assert_eq!(
/// engine.eval("echo()", &position, &data, &mut ctx).unwrap(),
/// json!("echo")
/// );
/// assert_eq!(
/// engine.eval("echo(value=`Hallo`)", &position, &data, &mut ctx).unwrap(),
/// json!("Hallo")
/// );
/// assert!(
/// engine.eval("echo(value=1)", &position, &data, &mut ctx).is_err()
/// );
/// ```
///
/// [`FunctionFn`]: type.FunctionFn.html
pub fn function<S>(self, name: S, function: FunctionFn) -> EngineBuilder
where
S: Into<String>,
{
let mut functions = self.functions;
functions.insert(name.into(), function);
EngineBuilder {
functions,
filters: self.filters,
eval_keyword: self.eval_keyword,
}
}
/// Registers custom evaluation keyword
///
/// Defaults to `$$eval` if no keyword is registered.
///
/// # Arguments
///
/// * `keyword` - An evaluation keyword
///
/// # Examples
///
// TODO Add example
pub fn eval_keyword<S>(self, keyword: S) -> EngineBuilder
where
S: Into<String>,
{
EngineBuilder {
functions: self.functions,
filters: self.filters,
eval_keyword: Some(keyword.into()),
}
}
}
impl From<EngineBuilder> for Engine {
fn from(builder: EngineBuilder) -> Engine {
Engine {
functions: builder.functions,
filters: builder.filters,
eval_keyword: builder.eval_keyword.unwrap_or_else(|| "$$eval".into()),
}
}
}