Merge branch 'next-major' into promisify-events

Author: Cache Hamm

CHANGELOG.md

@@ -3,6 +3,12 @@
     * Private `rule.event` property renamed. Use `rule.getEvent()` to avoid breaking changes in the future.
     * Engine and Rule events `on('success')`, `on('failure')`, and Rule callbacks `onSuccess` and `onFailure` now honor returned promises; any event handler that returns a promise will be waited upon to resolve before engine execution continues.
 
+#### 5.3.0 / 2020-12-02
+  * Allow facts to have a value of `undefined`
+
+#### 5.2.0 / 2020-11-31
+  * No changes; published to correct an accidental publish of untagged alpha
+
 #### 5.0.4 / 2020-09-26
   * Upgrade dependencies to latest
 

package-lock.json

@@ -11,7 +11,8 @@
     "lint:fix": "standard --fix --env mocha",
     "prepublishOnly": "npm run build",
     "build": "babel --stage 1 -d dist/ src/",
-    "watch": "babel --watch --stage 1 -d dist/ src"
+    "watch": "babel --watch --stage 1 -d dist/ src",
+    "examples": "./test/support/example_runner.sh"
   },
   "repository": {
     "type": "git",

package.json

@@ -26,9 +26,6 @@ class Fact {
     }
 
     if (!this.id) throw new Error('factId required')
-    if (typeof this.value === 'undefined' && typeof this.calculationMethod === 'undefined') {
-      throw new Error('facts must have a value or method')
-    }
 
     this.priority = parseInt(options.priority || 1, 10)
     this.options = Object.assign({}, defaultOptions, options)

src/fact.js

@@ -66,15 +66,14 @@ describe('Condition', () => {
     let condition
     let almanac
     function setup (options, factValue) {
-      if (typeof factValue === 'undefined') factValue = 1
       const properties = Object.assign({}, conditionBase, options)
       condition = new Condition(properties)
       const fact = new Fact(conditionBase.fact, factValue)
       almanac = new Almanac(new Map([[fact.id, fact]]))
     }
 
     context('validations', () => {
-      beforeEach(() => setup())
+      beforeEach(() => setup({}, 1))
       it('throws when missing an almanac', () => {
         return expect(condition.evaluate(undefined, operators)).to.be.rejectedWith('almanac required')
       })
@@ -94,6 +93,18 @@ describe('Condition', () => {
       expect((await condition.evaluate(almanac, operators, 5)).result).to.equal(false)
     })
 
+    it('evaluates "equal" to check for undefined', async () => {
+      condition = new Condition({ fact: 'age', operator: 'equal', value: undefined })
+      let fact = new Fact('age', undefined)
+      almanac = new Almanac(new Map([[fact.id, fact]]))
+
+      expect((await condition.evaluate(almanac, operators)).result).to.equal(true)
+
+      fact = new Fact('age', 1)
+      almanac = new Almanac(new Map([[fact.id, fact]]))
+      expect((await condition.evaluate(almanac, operators)).result).to.equal(false)
+    })
+
     it('evaluates "notEqual"', async () => {
       setup({ operator: 'notEqual' }, 50)
       expect((await condition.evaluate(almanac, operators)).result).to.equal(false)

test/condition.test.js

@@ -2,8 +2,11 @@
 
 import sinon from 'sinon'
 import engineFactory, { Fact, Rule, Operator } from '../src/index'
+import defaultOperators from '../src/engine-default-operators'
 
 describe('Engine', () => {
+  const operatorCount = defaultOperators.length
+
   let engine
   let sandbox
   before(() => {
@@ -31,7 +34,7 @@ describe('Engine', () => {
     it('initializes with the default state', () => {
       expect(engine.status).to.equal('READY')
       expect(engine.rules.length).to.equal(0)
-      expect(engine.operators.size).to.equal(10)
+      expect(engine.operators.size).to.equal(operatorCount)
     })
 
     it('can be initialized with rules', () => {
@@ -119,37 +122,37 @@ describe('Engine', () => {
 
   describe('addOperator()', () => {
     it('adds the operator', () => {
-      expect(engine.operators.size).to.equal(10)
+      expect(engine.operators.size).to.equal(operatorCount)
       engine.addOperator('startsWithLetter', (factValue, jsonValue) => {
         return factValue[0] === jsonValue
       })
-      expect(engine.operators.size).to.equal(11)
+      expect(engine.operators.size).to.equal(operatorCount + 1)
       expect(engine.operators.get('startsWithLetter')).to.exist()
       expect(engine.operators.get('startsWithLetter')).to.be.an.instanceof(Operator)
     })
 
     it('accepts an operator instance', () => {
-      expect(engine.operators.size).to.equal(10)
+      expect(engine.operators.size).to.equal(operatorCount)
       const op = new Operator('my-operator', _ => true)
       engine.addOperator(op)
-      expect(engine.operators.size).to.equal(11)
+      expect(engine.operators.size).to.equal(operatorCount + 1)
       expect(engine.operators.get('my-operator')).to.equal(op)
     })
   })
 
   describe('removeOperator()', () => {
     it('removes the operator', () => {
-      expect(engine.operators.size).to.equal(10)
+      expect(engine.operators.size).to.equal(operatorCount)
       engine.addOperator('startsWithLetter', (factValue, jsonValue) => {
         return factValue[0] === jsonValue
       })
-      expect(engine.operators.size).to.equal(11)
+      expect(engine.operators.size).to.equal(operatorCount + 1)
       engine.removeOperator('startsWithLetter')
-      expect(engine.operators.size).to.equal(10)
+      expect(engine.operators.size).to.equal(operatorCount)
     })
 
     it('can only remove added operators', () => {
-      expect(engine.operators.size).to.equal(10)
+      expect(engine.operators.size).to.equal(operatorCount)
       const isRemoved = engine.removeOperator('nonExisting')
       expect(isRemoved).to.equal(false)
     })

test/engine.test.js

@@ -29,10 +29,6 @@ describe('Fact', () => {
       it('throws if no id provided', () => {
         expect(subject).to.throw(/factId required/)
       })
-
-      it('throws if no definition provided', () => {
-        expect(subject.bind(null, 'factId')).to.throw(/facts must have a value or method/)
-      })
     })
   })
 

test/fact.test.js

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+#
+# npm links the examples directory to the local copy of json-rules-engine
+# and runs all examples. This can be used to test a release candidate version
+# against the examples as an extra compatiblity test
+#
+THIS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+cd $THIS_DIR/../.. # project root
+npm link
+cd $THIS_DIR/../../examples # examples directory
+npm link json-rules-engine
+for i in *.js; do node $i; done;