Adds name to Rule and RuleResult

Author: Matt Copenhaver

src/rule-result.js

@@ -3,10 +3,11 @@
 import deepClone from 'clone'
 
 export default class RuleResult {
- constructor (conditions, event, priority) {
+ constructor (conditions, event, priority, name) {
  this.conditions = deepClone(conditions)
  this.event = deepClone(event)
  this.priority = deepClone(priority)
+ this.name = deepClone(name)
  this.result = null
  }
 
@@ -19,6 +20,7 @@ export default class RuleResult {
  conditions: this.conditions.toJSON(false),
  event: this.event,
  priority: this.priority,
+ name: this.name,
  result: this.result
  }
  if (stringify) {

src/rule.js

@@ -14,6 +14,7 @@ class Rule extends EventEmitter {
  * @param {string} options.event.type - name of event to emit
  * @param {string} options.event.params - parameters to pass to the event listener
  * @param {Object} options.conditions - conditions to evaluate when processing this rule
+ * @param {string} options.name - identifier for a particular rule, particularly valuable in RuleResult output
  * @return {Rule} instance
  */
  constructor (options) {
@@ -30,6 +31,9 @@ class Rule extends EventEmitter {
  if (options && options.onFailure) {
  this.on('failure', options.onFailure)
  }
+ if (options && options.name) {
+ this.setName(options.name)
+ }
 
  let priority = (options && options.priority) || 1
  this.setPriority(priority)
@@ -49,6 +53,18 @@ class Rule extends EventEmitter {
  return this
  }
 
+ /**
+ * Sets the name of the rule
+ * @param {string} name - only non-empty strings are allowed
+ */
+ setName (name) {
+ if (!name || typeof name !== 'string') {
+ throw new Error('Rule "name" must be either undefined or a non-empty string')
+ }
+ this.name = name
+ return this
+ }
+
  /**
  * Sets the conditions to run when evaluating the rule.
  * @param {object} conditions - conditions, root element must be a boolean operator
@@ -91,7 +107,8 @@ class Rule extends EventEmitter {
  let props = {
  conditions: this.conditions.toJSON(false),
  priority: this.priority,
- event: this.event
+ event: this.event,
+ name: this.name
  }
  if (stringify) {
  return JSON.stringify(props)
@@ -131,7 +148,7 @@ class Rule extends EventEmitter {
  * @return {Promise(RuleResult)} rule evaluation result
  */
  evaluate (almanac) {
- let ruleResult = new RuleResult(this.conditions, this.event, this.priority)
+ let ruleResult = new RuleResult(this.conditions, this.event, this.priority, this.name)
 
  /**
  * Evaluates the rule conditions

test/rule.test.js

@@ -12,7 +12,7 @@ describe('Rule', () => {
  })
 
  describe('constructor()', () => {
- it('can be initialized with priority, conditions, and event', () => {
+ it('can be initialized with priority, conditions, event, and name', () => {
  let condition = {
  all: [ Object.assign({}, conditionBase) ]
  }
@@ -23,12 +23,14 @@ describe('Rule', () => {
  conditions: condition,
  event: {
  type: 'awesome'
- }
+ },
+ name: 'testName'
  }
  let 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.name).to.eql(opts.name)
  })
 
  it('it can be initialized with a json string', () => {
@@ -42,13 +44,15 @@ describe('Rule', () => {
  conditions: condition,
  event: {
  type: 'awesome'
- }
+ },
+ name: 'testName'
  }
  let json = JSON.stringify(opts)
  let 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.name).to.eql(opts.name)
  })
  })
 
@@ -115,6 +119,25 @@ describe('Rule', () => {
  })
  })
 
+ describe('setName', () => {
+ it('defaults to undefined', () => {
+ expect(rule.name).to.equal(undefined)
+ })
+
+ it('allows the name to be set', () => {
+ rule.setName('Test Name')
+ expect(rule.name).to.equal('Test Name')
+ })
+
+ it('errors if name is an empty string', () => {
+ expect(rule.setName.bind(null, '')).to.throw(/Rule "name" must be either undefined or a non-empty string/)
+ })
+
+ it('errors if name is not a string', () => {
+ expect(rule.setName.bind(null, 3)).to.throw(/Rule "name" must be either undefined or a non-empty string/)
+ })
+ })
+
  describe('priotizeConditions()', () => {
  let conditions = [{
  fact: 'age',
@@ -185,30 +208,34 @@ describe('Rule', () => {
  path: '.id'
  }]
  }
+ let name = 'testName'
  let rule
  beforeEach(() => {
  rule = new Rule()
  rule.setConditions(conditions)
  rule.setPriority(priority)
  rule.setEvent(event)
+ rule.setName(name)
  })
 
  it('serializes itself', () => {
  let json = rule.toJSON(false)
- expect(Object.keys(json).length).to.equal(3)
+ expect(Object.keys(json).length).to.equal(4)
  expect(json.conditions).to.eql(conditions)
  expect(json.priority).to.eql(priority)
  expect(json.event).to.eql(event)
+ expect(json.name).to.eql(name)
  })
 
  it('serializes itself as json', () => {
  let jsonString = rule.toJSON()
  expect(jsonString).to.be.a('string')
  let json = JSON.parse(jsonString)
- expect(Object.keys(json).length).to.equal(3)
+ expect(Object.keys(json).length).to.equal(4)
  expect(json.conditions).to.eql(conditions)
  expect(json.priority).to.eql(priority)
  expect(json.event).to.eql(event)
+ expect(json.name).to.eql(name)
  })
 
  it('rehydrates itself using a JSON string', () => {
@@ -218,6 +245,7 @@ describe('Rule', () => {
  expect(hydratedRule.conditions).to.eql(rule.conditions)
  expect(hydratedRule.priority).to.eql(rule.priority)
  expect(hydratedRule.event).to.eql(rule.event)
+ expect(hydratedRule.name).to.eql(rule.name)
  })
 
  it('rehydrates itself using an object from JSON.parse()', () => {
@@ -228,6 +256,8 @@ describe('Rule', () => {
  expect(hydratedRule.conditions).to.eql(rule.conditions)
  expect(hydratedRule.priority).to.eql(rule.priority)
  expect(hydratedRule.event).to.eql(rule.event)
+ expect(hydratedRule.name).to.eql(rule.name)
  })
  })
 })
+