Merge pull request #127 from mithunsatheesh/8.0.0

8.0.0

README.md

@@ -36,11 +36,11 @@ A rule will consist of a condition and its corresponding consequence. You can fi
 
 ``` js
 {
-    "condition" : function(R) {
-        R.when(this.transactionTotal < 500);
+    "condition" : (R, fact) => {
+        R.when(fact.transactionTotal < 500);
     },
-    "consequence" : function(R) {
-        this.result = false;
+    "consequence" : (R, fact) => {
+        fact.result = false;
         R.stop();
     }
 }
@@ -56,32 +56,33 @@ Facts are those input json values on which the rule engine applies its rule to o
 
 A sample Fact may look like
 
-	{
-	  "name":"user4",
-	  "application":"MOB2",
-	  "transactionTotal":400,
-	  "cardType":"Credit Card",
-    }
+``` json
+{
+    "name":"user4",
+    "application":"MOB2",
+    "transactionTotal":400,
+    "cardType":"Credit Card",
+}
+````
 
 ###### 3. Using the Rule Engine
 
 The example below shows how to use the rule engine to apply a sample rule on a specific fact. Rules can be fed into the rule engine as Array of rules or as an individual rule object.
 
 ``` js
-var RuleEngine = require("node-rules");
+import RuleEngine from "node-rules";
 
 /* Creating Rule Engine instance */
-var R = new RuleEngine();
+const R = new RuleEngine();
 
 /* Add a rule */
-var rule = {
-    "condition": function(R) {
-        console.log(this);
-        R.when(this.transactionTotal < 500);
+const rule = {
+    "condition": (R, fact) => {
+        R.when(fact.transactionTotal < 500);
     },
-    "consequence": function(R) {
-        this.result = false;
-        this.reason = "The transaction was blocked as it was less than 500";
+    "consequence": (R, fact) => {
+        fact.result = false;
+        fact.reason = "The transaction was blocked as it was less than 500";
         R.stop();
     }
 };
@@ -90,20 +91,22 @@ var rule = {
 R.register(rule);
 
 /* Add a Fact with less than 500 as transaction, and this should be blocked */
-var fact = {
+let fact = {
     "name": "user4",
     "application": "MOB2",
     "transactionTotal": 400,
     "cardType": "Credit Card"
 };
 
 /* Check if the engine blocks it! */
-R.execute(fact, function (data) {
-    if (data.result) {
+R.execute(fact, (data) => {
+
+    if (data.result !== false) {
         console.log("Valid transaction");
     } else {
         console.log("Blocked Reason:" + data.reason);
     }
+
 });
 ```
 

__tests__/index.js

@@ -1,4 +1,5 @@
-var RuleEngine = require('../index');
+import RuleEngine from '../';
+
 describe("Rules", function() {
     describe(".init()", function() {
         it("should empty the existing rule array", function() {
@@ -251,10 +252,10 @@ describe("Rules", function() {
 
         it("should support fact as optional second parameter for es6 compatibility", function() {
             var rule = {
-                "condition": function(R, fact) {
+                "condition": (R, fact) => {
                     R.when(fact && (fact.transactionTotal < 500));
                 },
-                "consequence": function(R, fact) {
+                "consequence": (R, fact) => {
                     fact.result = false;
                     R.stop();
                 }

docs/Dynamic-Control.md

@@ -30,24 +30,24 @@ The above `prioritize` call will give priority to Rule with id "one" over all th
 ##### 3. `RuleEngine.register(<rules>)`
 We know that we can pass Rules as parameter into the Rule Engine constructor while we create the Rule Engine object like below.
 
-    var RuleEngine = new RuleEngine(rules);
+    const RuleEngine = new RuleEngine(rules);
 
 Where `rules` can be either an array of rule objects or a single array. But what if we need to add some rules later to the Rule Engine. Register can be used any time to append new rules into the Rule Engine. It can be used like.
 
-    var RuleEngine = new RuleEngine();
+    const RuleEngine = new RuleEngine();
     RuleEngine.register(newrule);
     RuleEngine.register(newrule);
 
 
 ##### 4. `RuleEngine.findRules(<filter>)`
 This function is used to retrieve the Rules which are registered on the Rule engine which matches the filter we pass as its parameter. A sample usage can be like below.
 
-    var rules = RuleEngine.findRules({"id": "one"});
+    const rules = RuleEngine.findRules({"id": "one"});
 
 ##### 5. `RuleEngine.init()`
 This function is used to remove all the rules registered on the Rule Engine. This is mostly used for rule clean up purposes by internal functions. A sample usage can be like below.
 
-    var RuleEngine = new RuleEngine();
+    const RuleEngine = new RuleEngine();
     RuleEngine.register(badrule);
     RuleEngine.init();//removes the bad rule and cleans up
     RuleEngine.register(newrule);

docs/Examples.md

@@ -2,23 +2,23 @@ The example below shows how to use the rule engine to apply a sample rule on a s
 
 ``` js
 //import the package
-var RuleEngine = require('node-rules');
+import RuleEngine from 'node-rules';
 
 //define the rules
-var rules = [{
-	"condition": function(R) {
-		R.when(this && (this.transactionTotal < 500));
+const rules = [{
+	"condition": (R, fact) => {
+		R.when(fact && (fact.transactionTotal < 500));
 	},
-	"consequence": function(R) {
-		this.result = false;
+	"consequence": (R, fact) => {
+		fact.result = false;
 		R.stop();
 	}
 }];
 /*as you can see above we removed the priority 
 and on properties for this example as they are optional.*/ 
 
 //sample fact to run the rules on	
-var fact = {
+let fact = {
     "userIP": "27.3.4.5",
     "name":"user4",
     "application":"MOB2",
@@ -28,10 +28,10 @@ var fact = {
 };
 
 //initialize the rule engine
-var R = new RuleEngine(rules);
+const R = new RuleEngine(rules);
 
 //Now pass the fact on to the rule engine for results
-R.execute(fact,function(result){ 
+R.execute(fact, (result) => { 
 
 	if(result.result) 
 		console.log("\n-----Payment Accepted----\n"); 

docs/Rules.md

@@ -6,21 +6,21 @@ Lets see how a sample rule will look like and then proceed to explain the differ
 		"name": "transaction minimum",
 		"priority": 3,
 		"on" : true,
-		"condition": function(R) {
-			R.when(this.transactionTotal < 500);
+		"condition": (R, fact) => {
+			R.when(fact.transactionTotal < 500);
 		},
-		"consequence": function(R) {
-			this.result = false;
+		"consequence": (R, fact) => {
+			fact.result = false;
 			R.stop();
 		}
 	}
 
 Above is a sample rule which has mandatory as well as optional parameters. You can choose to use which all attributes you need to use while defining your rule. Now lets look into the attributes one by one.
 
 ###### 1. condition
-Condition is a function where the user can do the checks on the fact provided. The fact variable will be available in `this` context of the condition function. Lets see a sample condition below.
+Condition is a function where the user can do the checks on the fact provided. The fact variable will be available in `this` context of the condition function or as second function argument incase you are using arrow functions. Lets see a sample condition below.
 
-	"condition": function(R) {
+	"condition": (R, fact) => {
 		R.when(this.transactionTotal < 500);
 	}
 
@@ -29,12 +29,13 @@ As you can see, the we have to pass an expression on to the `R.when` function wh
 Its mandatory to have this field.
 
 ###### 2. consequence
-The consequence is the part where we define what happens when the condition evaluates to true for a particular fact. Just like in condition, fact variable will be available in `this` context. You may utilize it to add extra result attributes if needed.
+The consequence is the part where we define what happens when the condition evaluates to true for a particular fact. Just like in condition, fact variable will be available in `this` context or as second function argument incase you are using arrow functions. You may utilize it to add extra result attributes if needed.
 
-    "consequence": function(R) {
-		this.result = false;
+    "consequence": (R, fact) {
+		fact.result = false;
 		R.stop();
 	}
+
 In the above example we use an additional parameter `result` to communicate to the code outside the rule engine that the fact has succeeded. Also the Rule API provides a number of functions here to control the flow of the rule engine. They are `R.stop()`, `R.restart()` and `R.next()`. Stop refers to stop processing the rule engine. Restart tells the rule engine to start applying all the rules again to the fact. Next is to instruct the rule engine to continue applying the rest of the rules to the fact before stopping. Check [Flow Control API](https://github.com/mithunsatheesh/node-rules/wiki/Flow-Control-API) in wiki to read more about this.
 
 You can read more about flow control API here.

docs/_Sidebar.md

@@ -4,5 +4,4 @@
 * [Facts](https://github.com/mithunsatheesh/node-rules/wiki/Facts)
 * [Flow Control API](https://github.com/mithunsatheesh/node-rules/wiki/Flow-Control-API)
 * [Dynamic control](https://github.com/mithunsatheesh/node-rules/wiki/Dynamic-Control)
-* [Export/Import Rules](https://github.com/mithunsatheesh/node-rules/wiki/Exporting-and-Importing-Rules)
 * [Examples](https://github.com/mithunsatheesh/node-rules/wiki/Examples)

examples/node.js/1.SimpleRule.js

@@ -1,4 +1,5 @@
-var RuleEngine = require('../../index');
+import RuleEngine from '../../lib/node-rules.js';
+
 /* Sample Rule to block a transaction if its below 500 */
 var rule = {
     "condition": function(R) {

examples/node.js/2.MultipleRules.js

@@ -1,4 +1,5 @@
-var RuleEngine = require('../../index');
+import RuleEngine from '../../lib/node-rules.js';
+
 /* Set of Rules to be applied
 First blocks a transaction if less than 500
 Second blocks a debit card transaction.*/

examples/node.js/3.CascadingRules.js

@@ -1,4 +1,5 @@
-var RuleEngine = require('../../index');
+import RuleEngine from '../../lib/node-rules.js';
+
 /* Here we can see a rule which upon matching its condition,
 does some processing and passes it to other rules for processing */
 var rules = [{

examples/node.js/4.PrioritizedRules.js

@@ -1,4 +1,5 @@
-var RuleEngine = require('../../index');
+import RuleEngine from '../../lib/node-rules.js';
+
 /* Set of Rules to be applied */
 var rules = [{
     "priority": 4,

examples/node.js/5.RecurssionWithRules.js

@@ -1,4 +1,5 @@
-var RuleEngine = require('../../index');
+import RuleEngine from '../../lib/node-rules.js';
+
 /* Sample Rule to block a transaction if its below 500 */
 var rule = {
     "condition": function(R) {