Rename successResults to results

Author: Cache Hamm

README.md

@@ -86,8 +86,8 @@ let facts = {
 // Run the engine to evaluate
 engine
   .run(facts)
-  .then(runResult => {
-    runResult.successResults.map(result => console.log(result.event.params.message))
+  .then(({ results }) => {
+    results.map(result => console.log(result.event.params.message))
   })
 
 /*
@@ -170,10 +170,9 @@ engine.addFact('account-information', function (params, almanac) {
 let facts = { accountId: 'lincoln' }
 engine
   .run(facts)
-  .then((runResult) => {
-    console.log(facts.accountId + ' is a ' + runResult.successResults.map(result => result.event.params.message))
+  .then(({ results }) => {
+    console.log(facts.accountId + ' is a ' + results.map(result => result.event.params.message))
   })
-  .catch(err => console.log(err.stack))
 
 /*
  * OUTPUT:

docs/engine.md

@@ -11,7 +11,7 @@ The Engine stores and executes rules, emits events, and maintains state.
   * [engine.removeRule(Rule instance)](#engineremoverulerule-instance)
   * [engine.addOperator(String operatorName, Function evaluateFunc(factValue, jsonValue))](#engineaddoperatorstring-operatorname-function-evaluatefuncfactvalue-jsonvalue)
   * [engine.removeOperator(String operatorName)](#engineremoveoperatorstring-operatorname)
-  * [engine.run([Object facts], [Object options]) -> Promise ({ events: Events, almanac: Almanac, successResults: [], failureResults: []})](#enginerunobject-facts-object-options---promise--events-events-almanac-almanac-successresults--failureresults-)
+  * [engine.run([Object facts], [Object options]) -> Promise ({ events: Events, almanac: Almanac, results: [], failureResults: []})](#enginerunobject-facts-object-options---promise--events-events-almanac-almanac-successresults--failureresults-)
   * [engine.stop() -> Engine](#enginestop---engine)
     * [engine.on('success', Function(Object event, Almanac almanac, RuleResult ruleResult))](#engineonsuccess-functionobject-event-almanac-almanac-ruleresult-ruleresult)
     * [engine.on('failure', Function(Object event, Almanac almanac, RuleResult ruleResult))](#engineonfailure-functionobject-event-almanac-almanac-ruleresult-ruleresult)
@@ -104,9 +104,6 @@ engine.addRule(rule)
 engine.removeRule(rule)
 ```
 
-
-
-
 ### engine.addOperator(String operatorName, Function evaluateFunc(factValue, jsonValue))
 
 Adds a custom operator to the engine.  For situations that require going beyond the generic, built-in operators (`equal`, `greaterThan`, etc).
@@ -156,7 +153,7 @@ engine.removeOperator('startsWithLetter');
 
 
 
-### engine.run([Object facts], [Object options]) -> Promise ({ events: Events, almanac: Almanac, successResults: [], failureResults: []})
+### engine.run([Object facts], [Object options]) -> Promise ({ events: Events, almanac: Almanac, results: [], failureResults: []})
 
 Runs the rules engine.  Returns a promise which resolves when all rules have been run.
 
@@ -168,12 +165,13 @@ await engine.run()
 await engine.run({ userId: 1 })
 
 // results
-const runResult = await engine.run({ userId: 1 })
+const { results, failureResults, events } = await engine.run({ userId: 1 })
 
 /**
- * runResult.almanac: Almanac instance for the run
- * runResult.successEvents: rule results for successful rules
- * runResult.failureEvents: rule results for failed rules
+ * almanac: Almanac instance for the run
+ * results: rule results for successful rules
+ * failureResults: rule results for failed rules
+ * events: successful events
  */
 ```
 Link to the [Almanac documentation](./almanac.md)

docs/walkthrough.md

@@ -162,8 +162,8 @@ Running an engine executes the rules, and fires off event events for conditions
 engine.run({ userId: 1 });  // any time a rule condition requires 'userId', '1' will be returned
 
 // run() returns a promise
-engine.run({ userId: 4 }).then((results) => {
-  console.log('all rules executed; the following events were triggered: ', results.successResults.map(result => JSON.stringify(result.event)))
+engine.run({ userId: 4 }).then(({ results }) => {
+  console.log('all rules executed; the following events were triggered: ', results.map(result => JSON.stringify(result.event)))
 });
 ```
 Helper methods (for this example)

examples/01-hello-world.js

@@ -12,7 +12,7 @@
 require('colors')
 const { Engine } = require('json-rules-engine')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */
@@ -47,9 +47,9 @@ async function start() {
   const facts = { displayMessage: true }
 
   // engine.run() evaluates the rule using the facts provided
-  const { successResults } = await engine.run(facts)
+  const { results } = await engine.run(facts)
 
-  successResults.map(result => console.log(result.event.params.data.green))
+  results.map(result => console.log(result.event.params.data.green))
 }
 
 start()

examples/02-nested-boolean-logic.js

@@ -12,7 +12,7 @@
 require('colors')
 const { Engine } = require('json-rules-engine')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */
@@ -61,9 +61,9 @@ async function start() {
     gameDuration: 40
   }
 
-  const { successResults } = await engine.run(facts)
+  const { results } = await engine.run(facts)
 
-  successResults.map(result => console.log(result.event.params.message.red))
+  results.map(result => console.log(result.event.params.message.red))
 }
 start()
 /*

examples/03-dynamic-facts.js

@@ -16,7 +16,7 @@ const { Engine } = require('json-rules-engine')
 // example client for making asynchronous requests to an api, database, etc
 const apiClient = require('./support/account-api-client')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */
@@ -70,9 +70,9 @@ async function start() {
 
   // define fact(s) known at runtime
   const facts = { accountId: 'lincoln' }
-  const { successResults } = await engine.run(facts)
+  const { results } = await engine.run(facts)
 
-  console.log(facts.accountId + ' is a ' + successResults.map(result => result.event.params.message))
+  console.log(facts.accountId + ' is a ' + results.map(result => result.event.params.message))
 }
 start()
 

examples/04-fact-dependency.js

@@ -15,7 +15,7 @@ require('colors')
 const { Engine } = require('json-rules-engine')
 const accountClient = require('./support/account-api-client')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */
@@ -108,11 +108,11 @@ async function start() {
   })
 
   // first run, using washington's facts
-  console.log('-- FIRST RUN --');
+  console.log('-- FIRST RUN --')
   facts = { accountId: 'washington' }
   await engine.run(facts)
 
-  console.log('-- SECOND RUN --');
+  console.log('-- SECOND RUN --')
   // second run, using jefferson's facts; facts & evaluation are independent of the first run
   facts = { accountId: 'jefferson' }
   await engine.run(facts)
@@ -138,5 +138,3 @@ start()
  * jefferson did NOT meet conditions for the microsoft-terminated-employees rule.
  * jefferson DID meet conditions for the five-year-tenure rule.
  */
-
-

examples/05-optimizing-runtime-with-fact-priorities.js

@@ -13,7 +13,7 @@ require('colors')
 const { Engine } = require('json-rules-engine')
 const accountClient = require('./support/account-api-client')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */

examples/06-custom-operators.js

@@ -18,7 +18,7 @@
 require('colors')
 const { Engine } = require('json-rules-engine')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */
@@ -88,7 +88,7 @@ async function start() {
    * Each run() of the engine executes on an independent set of facts.  We'll run twice, once per word
    */
 
-   // first run, using 'bacon'
+  // first run, using 'bacon'
   facts = { word: 'bacon' }
   await engine.run(facts)
 

examples/07-rule-chaining.js

@@ -15,7 +15,6 @@ require('colors')
 const { Engine } = require('json-rules-engine')
 const { getAccountInformation } = require('./support/account-api-client')
 
-
 async function start () {
   /**
    * Setup a new engine

examples/08-fact-comparison.js

@@ -12,7 +12,7 @@
 require('colors')
 const { Engine } = require('json-rules-engine')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */

examples/09-rule-results.js

@@ -11,7 +11,7 @@
 require('colors')
 const { Engine } = require('json-rules-engine')
 
-async function start() {
+async function start () {
   /**
    * Setup a new engine
    */

package-lock.json

@@ -234,14 +234,14 @@ class Engine extends EventEmitter {
         return almanac.getSuccessEvents()
       }).then(events => {
         const ruleResults = almanac.getRuleResults()
-        const { successResults, failureResults } = ruleResults.reduce((hash, ruleResult) => {
-          const group = ruleResult.result ? 'successResults' : 'failureResults'
+        const { results, failureResults } = ruleResults.reduce((hash, ruleResult) => {
+          const group = ruleResult.result ? 'results' : 'failureResults'
           hash[group].push(ruleResult)
           return hash
-        }, { successResults: [], failureResults: [] })
+        }, { results: [], failureResults: [] })
 
         resolve({
-          successResults,
+          results,
           failureResults,
           almanac,
 

src/engine.js

@@ -149,8 +149,8 @@ describe('Acceptance', () => {
     const engineResult = await engine.run({ baseIndex: 1 })
 
     // results
-    expect(engineResult.successResults.length).to.equal(2)
-    expect(engineResult.successResults[0]).to.deep.equal({
+    expect(engineResult.results.length).to.equal(2)
+    expect(engineResult.results[0]).to.deep.equal({
       conditions: {
         all: [
           {
@@ -189,7 +189,7 @@ describe('Acceptance', () => {
       priority: 10,
       result: true
     })
-    expect(engineResult.successResults[1]).to.deep.equal({
+    expect(engineResult.results[1]).to.deep.equal({
       conditions: {
         all: [
           {
@@ -242,7 +242,7 @@ describe('Acceptance', () => {
 
     const engineResult = await engine.run({ baseIndex: 1, 'rule-created-fact': '' })
 
-    expect(engineResult.successResults.length).to.equal(0)
+    expect(engineResult.results.length).to.equal(0)
     expect(engineResult.failureResults.length).to.equal(2)
     expect(engineResult.failureResults.every(rr => rr.result === false)).to.be.true()
 

test/acceptance/acceptance.js

@@ -102,11 +102,11 @@ describe('Engine: event', () => {
       })
       engine.on('failure', failureSpy)
 
-      const { successResults, failureResults } = await engine.run()
+      const { results, failureResults } = await engine.run()
 
       expect(failureResults).to.have.lengthOf(0)
-      expect(successResults).to.have.lengthOf(1)
-      assertResult(successResults[0])
+      expect(results).to.have.lengthOf(1)
+      assertResult(results[0])
       expect(failureSpy.callCount).to.equal(0)
       expect(successSpy.callCount).to.equal(1)
     })
@@ -129,11 +129,11 @@ describe('Engine: event', () => {
       })
       engine.on('failure', failureSpy)
 
-      const { successResults, failureResults } = await engine.run()
+      const { results, failureResults } = await engine.run()
 
       expect(failureResults).to.have.lengthOf(0)
-      expect(successResults).to.have.lengthOf(1)
-      assertResult(successResults[0])
+      expect(results).to.have.lengthOf(1)
+      assertResult(results[0])
 
       expect(failureSpy.callCount).to.equal(0)
       expect(successSpy.callCount).to.equal(1)
@@ -160,10 +160,10 @@ describe('Engine: event', () => {
       engine.on('success', successSpy)
       engine.addFact('age', AGE) // age fails
 
-      const { successResults, failureResults } = await engine.run()
+      const { results, failureResults } = await engine.run()
 
       expect(failureResults).to.have.lengthOf(1)
-      expect(successResults).to.have.lengthOf(0)
+      expect(results).to.have.lengthOf(0)
       assertResult(failureResults[0])
 
       expect(failureSpy.callCount).to.equal(1)
@@ -235,11 +235,11 @@ describe('Engine: event', () => {
       })
       engine.on('failure', failureSpy)
 
-      const { successResults, failureResults } = await engine.run()
+      const { results, failureResults } = await engine.run()
 
-      assertResult(successResults[0])
+      assertResult(results[0])
       expect(failureResults).to.have.lengthOf(0)
-      expect(successResults).to.have.lengthOf(1)
+      expect(results).to.have.lengthOf(1)
       expect(failureSpy.callCount).to.equal(0)
       expect(successSpy.callCount).to.equal(1)
     })
@@ -271,11 +271,11 @@ describe('Engine: event', () => {
       engine.addFact('zipCode', ZIP_CODE) // zipCode fails
       engine.addFact('gender', GENDER) // gender fails
 
-      const { successResults, failureResults } = await engine.run()
+      const { results, failureResults } = await engine.run()
 
       assertResult(failureResults[0])
       expect(failureResults).to.have.lengthOf(1)
-      expect(successResults).to.have.lengthOf(0)
+      expect(results).to.have.lengthOf(0)
 
       expect(failureSpy.callCount).to.equal(1)
       expect(successSpy.callCount).to.equal(0)
@@ -325,11 +325,11 @@ describe('Engine: event', () => {
       })
       rule.on('failure', failureSpy)
 
-      const { successResults, failureResults } = await engine.run()
+      const { results, failureResults } = await engine.run()
 
-      assertResult(successResults[0])
+      assertResult(results[0])
       expect(failureResults).to.have.lengthOf(0)
-      expect(successResults).to.have.lengthOf(1)
+      expect(results).to.have.lengthOf(1)
 
       expect(successSpy.callCount).to.equal(1)
       expect(failureSpy.callCount).to.equal(0)
@@ -357,11 +357,11 @@ describe('Engine: event', () => {
       rule.on('success', successSpy)
       // both conditions will fail
       engine.addFact('age', AGE)
-      const { successResults, failureResults } = await engine.run()
+      const { results, failureResults } = await engine.run()
 
       assertResult(failureResults[0])
       expect(failureResults).to.have.lengthOf(1)
-      expect(successResults).to.have.lengthOf(0)
+      expect(results).to.have.lengthOf(0)
       expect(failureSpy.callCount).to.equal(1)
       expect(successSpy.callCount).to.equal(0)
     })