Rename rule.event => rule.ruleEvent for event-emitter-2 compatibility

Author: Cache Hamm

src/engine.js

@@ -40,13 +40,14 @@ class Engine extends EventEmitter {
    */
   addRule (properties) {
     if (!properties) throw new Error('Engine: addRule() requires options')
-    if (!Object.prototype.hasOwnProperty.call(properties, 'conditions')) throw new Error('Engine: addRule() argument requires "conditions" property')
-    if (!Object.prototype.hasOwnProperty.call(properties, 'event')) throw new Error('Engine: addRule() argument requires "event" property')
 
     let rule
     if (properties instanceof Rule) {
       rule = properties
     } else {
+      if (!Object.prototype.hasOwnProperty.call(properties, 'event')) throw new Error('Engine: addRule() argument requires "event" property')
+      if (!Object.prototype.hasOwnProperty.call(properties, 'conditions')) throw new Error('Engine: addRule() argument requires "conditions" property')
+
       rule = new Rule(properties)
     }
     rule.setEngine(this)
@@ -191,13 +192,13 @@ class Engine extends EventEmitter {
       return rule.evaluate(almanac).then((ruleResult) => {
         debug(`engine::run ruleResult:${ruleResult.result}`)
         if (ruleResult.result) {
-          almanac.factValue('success-events', { event: rule.event })
+          almanac.factValue('success-events', { event: ruleResult.event })
           return Promise.all([
-            this.emitAsync('success', rule.event, almanac, ruleResult),
-            this.emitAsync(rule.event.type, rule.event.params, almanac, ruleResult)
+            this.emitAsync('success', ruleResult.event, almanac, ruleResult),
+            this.emitAsync(ruleResult.event.type, ruleResult.event.params, almanac, ruleResult)
           ])
         } else {
-          return this.emitAsync('failure', rule.event, almanac, ruleResult)
+          return this.emitAsync('failure', ruleResult.event, almanac, ruleResult)
         }
       })
     }))

src/rule.js

@@ -86,10 +86,10 @@ class Rule extends EventEmitter {
   setEvent (event) {
     if (!event) throw new Error('Rule: setEvent() requires event object')
     if (!Object.prototype.hasOwnProperty.call(event, 'type')) throw new Error('Rule: setEvent() requires event object with "type" property')
-    this.event = {
+    this.ruleEvent = {
       type: event.type
     }
-    if (event.params) this.event.params = event.params
+    if (event.params) this.ruleEvent.params = event.params
     return this
   }
 
@@ -107,7 +107,7 @@ class Rule extends EventEmitter {
     const props = {
       conditions: this.conditions.toJSON(false),
       priority: this.priority,
-      event: this.event,
+      event: this.ruleEvent,
       name: this.name
     }
     if (stringify) {
@@ -148,7 +148,7 @@ class Rule extends EventEmitter {
    * @return {Promise(RuleResult)} rule evaluation result
    */
   evaluate (almanac) {
-    const ruleResult = new RuleResult(this.conditions, this.event, this.priority, this.name)
+    const ruleResult = new RuleResult(this.conditions, this.ruleEvent, this.priority, this.name)
 
     /**
      * Evaluates the rule conditions

test/engine-failure.test.js

@@ -32,7 +32,7 @@ describe('Engine: failure', () => {
     const failureSpy = sandbox.spy()
     engine.on('failure', failureSpy)
     await engine.run()
-    expect(failureSpy).to.have.been.calledWith(engine.rules[0].event)
+    expect(failureSpy).to.have.been.calledWith(engine.rules[0].ruleEvent)
   })
 
   it('does not emit when a rule passes', async () => {

test/rule.test.js

@@ -29,7 +29,7 @@ describe('Rule', () => {
       const rule = new Rule(opts)
       expect(rule.priority).to.eql(opts.priority)
       expect(rule.conditions).to.eql(opts.conditions)
-      expect(rule.event).to.eql(opts.event)
+      expect(rule.ruleEvent).to.eql(opts.event)
       expect(rule.name).to.eql(opts.name)
     })
 
@@ -51,7 +51,7 @@ describe('Rule', () => {
       const rule = new Rule(json)
       expect(rule.priority).to.eql(opts.priority)
       expect(rule.conditions).to.eql(opts.conditions)
-      expect(rule.event).to.eql(opts.event)
+      expect(rule.ruleEvent).to.eql(opts.event)
       expect(rule.name).to.eql(opts.name)
     })
   })
@@ -287,7 +287,7 @@ describe('Rule', () => {
       const hydratedRule = new Rule(jsonString)
       expect(hydratedRule.conditions).to.eql(rule.conditions)
       expect(hydratedRule.priority).to.eql(rule.priority)
-      expect(hydratedRule.event).to.eql(rule.event)
+      expect(hydratedRule.ruleEvent).to.eql(rule.ruleEvent)
       expect(hydratedRule.name).to.eql(rule.name)
     })
 
@@ -298,7 +298,7 @@ describe('Rule', () => {
       const hydratedRule = new Rule(json)
       expect(hydratedRule.conditions).to.eql(rule.conditions)
       expect(hydratedRule.priority).to.eql(rule.priority)
-      expect(hydratedRule.event).to.eql(rule.event)
+      expect(hydratedRule.ruleEvent).to.eql(rule.ruleEvent)
       expect(hydratedRule.name).to.eql(rule.name)
     })
   })