Merge pull request #35 from CacheControl/rule-results

Rule results

Author: Cache Hamm

CHANGELOG.md

@@ -1,3 +1,17 @@
+2.0.0-beta2 / 2017-04-10
+==================
+  * Fix fact path object checking to work with objects that have prototypes (lodash isObjectLike instead of isPlainObject)
+
+2.0.0-beta1 / 2017-04-09
+==================
+
+  * Add rule results
+  * Document fact .path ability to parse properties containing dots
+  * Bump dependencies
+  * BREAKING CHANGES
+    * `engine.on('failure', (rule, almanac))` is now `engine.on('failure', (event, almanac, ruleResult))`
+    * `engine.on(eventType, (eventParams, engine))` is now `engine.on(eventType, (eventParams, almanac, ruleResult))`
+
 1.5.1 / 2017-03-19
 ==================
 

dist/almanac.js

@@ -23,14 +23,15 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 var debug = require('debug')('json-rules-engine');
 var verbose = require('debug')('json-rules-engine-verbose');
 var selectn = require('selectn');
-var isPlainObject = require('lodash.isplainobject');
+var isObjectLike = require('lodash.isobjectlike');
 var warn = require('debug')('json-rules-engine:warn');
 
 /**
  * Fact results lookup
  * Triggers fact computations and saves the results
  * A new almanac is used for every engine run()
  */
+
 var Almanac = function () {
   function Almanac(factMap) {
     var runtimeFacts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -166,7 +167,7 @@ var Almanac = function () {
 
               case 15:
                 if (path) {
-                  if (isPlainObject(factValue) || Array.isArray(factValue)) {
+                  if (isObjectLike(factValue)) {
                     factValue = selectn(path)(factValue);
                     debug('condition::evaluate extracting object property ' + path + ', received: ' + factValue);
                   } else {

dist/condition.js

@@ -10,14 +10,14 @@ function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, a
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-var params = require('params');
 var debug = require('debug')('json-rules-engine');
-var isPlainObject = require('lodash.isplainobject');
+var isObjectLike = require('lodash.isobjectlike');
 
 var Condition = function () {
   function Condition(properties) {
     _classCallCheck(this, Condition);
 
+    if (!properties) throw new Error('Condition: constructor options required');
     var booleanOperator = Condition.booleanOperator(properties);
     Object.assign(this, properties);
     if (booleanOperator) {
@@ -32,7 +32,10 @@ var Condition = function () {
         return new Condition(c);
       });
     } else {
-      properties = params(properties).require(['fact', 'operator', 'value']);
+      if (!properties.hasOwnProperty('fact')) throw new Error('Condition: constructor "fact" property required');
+      if (!properties.hasOwnProperty('operator')) throw new Error('Condition: constructor "operator" property required');
+      if (!properties.hasOwnProperty('value')) throw new Error('Condition: constructor "value" property required');
+
       // a non-boolean condition does not have a priority by default. this allows
       // priority to be dictated by the fact definition
       if (properties.hasOwnProperty('priority')) {
@@ -94,7 +97,7 @@ var Condition = function () {
               case 0:
                 value = this.value;
 
-                if (!(isPlainObject(value) && value.hasOwnProperty('fact'))) {
+                if (!(isObjectLike(value) && value.hasOwnProperty('fact'))) {
                   _context.next = 5;
                   break;
                 }
@@ -137,7 +140,7 @@ var Condition = function () {
     key: 'evaluate',
     value: function () {
       var _ref2 = _asyncToGenerator(regeneratorRuntime.mark(function _callee2(almanac, operatorMap) {
-        var op, rightHandSideValue, leftHandSideValue, evaluationResult;
+        var op, rightHandSideValue, leftHandSideValue, result;
         return regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) {
             switch (_context2.prev = _context2.next) {
@@ -186,10 +189,10 @@ var Condition = function () {
 
               case 14:
                 leftHandSideValue = _context2.sent;
-                evaluationResult = op.evaluate(leftHandSideValue, rightHandSideValue);
+                result = op.evaluate(leftHandSideValue, rightHandSideValue);
 
-                debug('condition::evaluate <' + leftHandSideValue + ' ' + this.operator + ' ' + rightHandSideValue + '?> (' + evaluationResult + ')');
-                return _context2.abrupt('return', evaluationResult);
+                debug('condition::evaluate <' + leftHandSideValue + ' ' + this.operator + ' ' + rightHandSideValue + '?> (' + result + ')');
+                return _context2.abrupt('return', { result: result, leftHandSideValue: leftHandSideValue, rightHandSideValue: rightHandSideValue, operator: this.operator });
 
               case 18:
               case 'end':

dist/engine.js

@@ -7,10 +7,6 @@ exports.FINISHED = exports.RUNNING = exports.READY = undefined;
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
 
-var _params = require('params');
-
-var _params2 = _interopRequireDefault(_params);
-
 var _fact = require('./fact');
 
 var _fact2 = _interopRequireDefault(_fact);
@@ -94,7 +90,9 @@ var Engine = function (_EventEmitter) {
   _createClass(Engine, [{
     key: 'addRule',
     value: function addRule(properties) {
-      (0, _params2.default)(properties).require(['conditions', 'event']);
+      if (!properties) throw new Error('Engine: addRule() requires options');
+      if (!properties.hasOwnProperty('conditions')) throw new Error('Engine: addRule() argument requires "conditions" property');
+      if (!properties.hasOwnProperty('event')) throw new Error('Engine: addRule() argument requires "event" property');
 
       var rule = void 0;
       if (properties instanceof _rule2.default) {
@@ -224,14 +222,15 @@ var Engine = function (_EventEmitter) {
                     debug('engine::run status:' + _this2.status + '; skipping remaining rules');
                     return;
                   }
-                  return rule.evaluate(almanac).then(function (rulePasses) {
-                    debug('engine::run ruleResult:' + rulePasses);
-                    if (rulePasses) {
-                      _this2.emit('success', rule.event, almanac);
-                      _this2.emit(rule.event.type, rule.event.params, _this2);
+                  return rule.evaluate(almanac).then(function (ruleResult) {
+                    debug('engine::run ruleResult:' + ruleResult.result);
+                    if (ruleResult.result) {
+                      _this2.emit('success', rule.event, almanac, ruleResult);
+                      _this2.emit(rule.event.type, rule.event.params, almanac, ruleResult);
                       almanac.factValue('success-events', { event: rule.event });
+                    } else {
+                      _this2.emit('failure', rule.event, almanac, ruleResult);
                     }
-                    if (!rulePasses) _this2.emit('failure', rule, almanac);
                   });
                 })));