README

Rulesengine

Converts conditional statements into optimised asset rules. This gives the ability to store rules in files or databases.

It is important that rules are correctly validated if the rules can be user defined.

This is because the rules are converted into code to make them fast

This is supported and looked after, if there's and functionality you'd like to see; let me know and I'll look into it.

Installation

Install with Composer:

composer require tankfairies/rulesengine

Performance

These tests were run on an Mac M1 Max with 32GB.

Running 100,000 executions 5 times: -

1 => 1.0200 seconds
2 => 1.0146 seconds
3 => 1.0219 seconds
4 => 1.0226 seconds
5 => 1.0206 seconds

Performance increases once the rule has been built: -

1 => 1.0178 seconds
2 => 1.0135 seconds
3 => 1.0180 seconds
4 => 1.0110 seconds
5 => 1.0097 seconds

On Average that's ~100000 calls per second. Performance testing was done with - tankfairies/benchmark

Usage

Instantiate a new instance of the library:

use Tankfairies\Rulesengine\RulesEngine;

$this->rulesEngine = new RulesEngine('storage/rules');
$rulesEngine->setRule('var == 21');
$result = $rulesEngine->evaluate(['var' => 21]);

The following operators are available to use in rules: -

• AND
• OR
• XOR

The following conditions are available to use in rules: -

• ==
• !-
• <=
• >=
• <
• >
• IN
• !IN

Sample Rules

var == val OR var == 22
['var' => 20, 'val' => 20]

var !IN val
['var' => 20, 'val' => [21, 22, 23]]

var IN val AND var2 == "yes"
['var' => 22, 'val' => [21, 22, 23], 'var2' => 'yes']

var == 100 XOR group IN [123456, 456456]
['var' => '100', 'group' => 12121]

Copyright and license

The tankfairies/rulesengine library is Copyright (c) 2019 Tankfairies (https://tankfairies.com) and licensed for use under the MIT License (MIT).