Regras de negócio como texto com NEWMACRO()

Total.js 5 · total5@0.0.19 macrosrulesscripting Executada com o Total.js 5

NEWMACRO(text, [nocompile], [isasync]) transforma algumas linhas de uma pequena linguagem numa função function(model, helpers). Destina-se a regras que mudam mais vezes do que o código: um desconto, um preço, uma verificação de permissões, uma validação que alguém que não escreve JavaScript mantém num ficheiro ou numa base de dados.

A linguagem, tal como foi verificada:

IF condition, ELSE IF condition, ELSE e FI (o fim da condição) funcionam como numa regra baseada em texto. As condições usam >, <, >=, <=, = e AND / OR.
RETURN value termina a macro com um valor. YES e NO (também TRUE, FALSE, OK) são booleanos, o texto entre aspas é texto e os números são números.
Uma palavra é uma propriedade do modelo, escrita em minúsculas: age lê model.age, e total = price * qty escreve model.total.
NAME(arguments) chama um helper, a função com esse nome (em minúsculas) no objeto helpers que passa; dentro dela this é o modelo. Com isasync em true a macro é uma função async e espera pelos helpers.
#name é uma variável temporária da execução: #temp = num + 1 e RETURN #temp.
Use nomes de várias letras: uma propriedade ou variável de uma letra não foi reconhecida nas verificações.

NEWMACRO() compila o texto com new Function, pelo que uma macro é código: compile apenas texto que escreveu ou que uma pessoa de confiança mantém, nunca texto enviado por um visitante. Com nocompile em true devolve o JavaScript que gera em vez da função, o que é útil para ver o que uma regra faz.

controllers/rules.js

const helpers = {
	percent: function(value, rate) {
		return value * rate / 100;
	}
};

const age = NEWMACRO("IF age >= 18\n\tRETURN 'adult'\nELSE\n\tRETURN 'minor'\nFI");

const level = NEWMACRO("IF points > 100\n\tRETURN 'gold'\nELSE IF points > 50\n\tRETURN 'silver'\nELSE\n\tRETURN 'bronze'\nFI");

const access = NEWMACRO("IF active AND score >= 5\n\tRETURN yes\nFI\nRETURN no");

const total = NEWMACRO("total = price * qty\nIF qty >= 10\n\ttotal = total - PERCENT(total, 10)\nFI\nRETURN total");

const temporary = NEWMACRO("#next = count + 1\nRETURN #next");

const slow = NEWMACRO("RETURN LOOKUP(code)", false, true);

exports.install = function() {
	ROUTE('POST /rules/', rules);
	ROUTE('GET /source/', source);
};

async function rules($) {
	const model = $.body;
	$.json({
		age: age(model, helpers),
		level: level(model, helpers),
		access: access(model, helpers),
		total: total(model, helpers),
		model_total: model.total,
		temporary: temporary(model, helpers),
		slow: await slow(model, { lookup: async code => 'found ' + code })
	});
}

function source($) {
	$.plain(NEWMACRO("IF points > 100\n\tRETURN 'gold'\nFI", true));
}