Extends API to return rule info and matched rule chain

[pdapel]

This PR adds two simple features.

The first feature is lifted from the un-merged suggestions by @escape-llc at #39. Namely, adding a rule() method to the API inside .execute(), so that rule information can be accessed inside the consequence, like so:

"consequence": function(R) {
    this.result = true;
    this.ruleName = R.rule().name;
    this.ruleID = R.rule().id;
    R.stop();
}

The second feature is something I needed for my implementation, namely the list of matched rules in matched order. In my case, the rules are defined by others, and when they get unexpected/undesirable results through the rule engine, this helps them understand how the rules got processed. The list of matched rules is an array named .matchPath, attached to the callback results from .execute(). The array values are the matched rule's .id property, or .name property, or active rule index position, in that order of preference.

I included some simple tests and appended them to the existing describe block for .execute()

• lib/node-rules.js:
  • adds rule() to .execute API to access rule().name, rule().id, etc
  • adds var matchPath array to hold the chain of matched rule references (by id, or by name, or by active rule index)
  • decorates returned session in final callback with .matchPath
• test/index.js:
  • adds test to .execute block: "should provide access to rule definitions via rule()"
  • adds test to .execute block: "should include the matched rule path"

[kevdowney]

Can we get this merged? We could use this in our project. Thanks.

[kevdowney]

Can you bump the versioning?

[psingh4]

We pulled the latest from the master. this change is very helpful! thanks!

[escape-llc]

very welcomed!

Date: Mon, 13 Jun 2016 11:25:58 -0700
From: [email protected]
To: [email protected]
CC: [email protected]; [email protected]
Subject: Re: [mithunsatheesh/node-rules] Extends API to return rule info and matched rule chain (#47)

We pulled the latest from the master. this change is very helpful! thanks!

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

[sandy-adi]

@mithunsatheesh I think these changes have not been published to npm. Could you please do it, it would be very helpful.

[mithunsatheesh]

Done! Sorry for the delay

[sandy-adi]

Thank you @mithunsatheesh @pdapel and @escape-llc