rulesenginejs

RulesEngineJS

What is a rules engine?

A rules engine decouples the workflow logic from other components. This is done by defining the rules once, and having components listen for events triggered by a rule. This reduces repeated code in components and makes it easier to update existing rules. Rules engines also reduce repeated code in the rules logic, by allowing rules to be composed and conditioned on other rules.

How does it work?

The rules engine has three parts: facts, rules, and events.

When facts are updated in the rules engine, its rules are evaluated. If a rule passes (resolves or evaluates to true), it triggers any events that has been defined in that rule. Any listeners which are listening for that event will then be triggered.

Why should I use this?

• Supports async rules
• Supports rule priorities
• Supports event listeners
• Supports nested conditions (all, any)
• Supports negative conditions (!)
• Small (9kb minified)
• Efficient (caching, early exit)
• ES5 compatible
• Depends only on jQuery
• Easy to use

If you are developer in need of a lightweight rules engine, this is it.

<script src="rulesengine.min.js"></script>

How do I use it?

1. Define a rules engine.

var RE = new RulesEngine();

1. Add rules.

RE.addRules([
  ['active', function(facts) {
      return facts.status === 1
  }],
  ['approved', function(facts) {
      return facts.status === 2
  }],
  ['not_approved_or_active', null, {
      conditions: {
          all: ['!approved', '!active']
      },
      events: 'is_editable'
  }]
]);

1. Add listeners.

RE.on('is_editable', 'disable_button', function() {
$('.edit-button').removeClass('disabled');
});

1. Update facts.

RE.updateFacts({status: 3});
// is_editable event triggered: edit-button is now enabled

1. Evaluate just a single rule.

RE.evaluate('active', {status: 1})
.done(function() {
  alert('Status is active');
})
.fail(function() {
  alert('Status is not active');
});
// alerts "Status is active"

For more examples, refer to the tests.

What methods are available?

RE.updateFacts(facts) // returns $.Deferred()
RE.addRule(name, evaluator, options)
RE.addRules([[name, evaluator, options], [name, evaluator, options] ...]
RE.deleteRule(name)
RE.addEvent(name)
RE.addEvents([name, name ...])
RE.emit(event)
RE.on(event, name, handler)
RE.run() // returns $.Deferred()

RE.evaluate(facts, event) // returns $.Deferred()
// Evaluates against a set of facts to see if an event is triggered
// Triggers no other events and does not modify state (idempotent)

// ... more methods under the hood ...