fix #15

Author: mavarazy

README.md

@@ -482,6 +482,22 @@ let engine = new Engine([{
 
 Validation will automatically catch new extension and work as expected.
 
+## Logic on nested objects
+
+Support of nested structures with [selectn](https://github.com/wilmoore/selectn.js), so basically any query you can define in selectn you can use here.
+
+For example if in previous example, age would be a part of person object, we could work with it like this:
+```js
+    let rules = [ { conditions: { "person.age": { range: [ 20, 40 ] } } } ]; 
+```
+
+Also in order to support systems where keys with "." not allowed (for example if you would like to store data in mongo), you can use `$` to separate references:
+ 
+For example, this is the same condition, but instead of `.` it uses `$`:
+```js
+    let rules = [ { conditions: { "person$age": { range: [ 20, 40 ] } } } ]; 
+```
+
 ## Relevant conditional logic
 
 Sometimes you would want to validate `formData` fields one against the other.

src/conditionsMeet.js

@@ -1,7 +1,6 @@
-import { isObject, toError } from "./utils";
+import { isObject, toError, selectRef } from "./utils";
 import checkField from "./checkField";
 import { OR, AND, NOT } from "./constants";
-import selectn from "selectn";
 
 export function toRelCondition(refCondition, formData) {
   if (Array.isArray(refCondition)) {
@@ -12,7 +11,7 @@ export function toRelCondition(refCondition, formData) {
       return agg;
     }, {});
   } else if (typeof refCondition === "string" && refCondition.startsWith("$")) {
-    return selectn(refCondition.substr(1), formData);
+    return selectRef(refCondition.substr(1), formData);
   } else {
     return refCondition;
   }
@@ -34,7 +33,7 @@ export default function conditionsMeet(condition, formData) {
     } else if (ref === NOT) {
       return !conditionsMeet(refCondition, formData);
     } else {
-      let refVal = selectn(ref, formData);
+      let refVal = selectRef(ref, formData);
       if (Array.isArray(refVal)) {
         let condMeatOnce = refVal.some(val =>
           conditionsMeet(refCondition, val)

src/utils.js

@@ -1,3 +1,10 @@
+import selectn from "selectn";
+
+export function selectRef(field, formData) {
+  let ref = field.replace(/\$/g, ".");
+  return selectn(ref, formData);
+}
+
 export function isObject(obj) {
   return typeof obj === "object" && obj !== null;
 }

test/issues/15.test.js

@@ -0,0 +1,37 @@
+import Engine from "../../src";
+
+test("support $ single level of nesting", () => {
+  let rules = [
+    {
+      conditions: {
+        address$zip: { less: 1000 },
+      },
+      event: {
+        type: "match",
+      },
+    },
+  ];
+  let engine = new Engine(rules);
+  return engine.run({ address: { zip: 10 } }).then(events => {
+    expect(events.length).toEqual(1);
+    expect(events[0]).toEqual({ type: "match" });
+  });
+});
+
+test("support $ double level of nesting", () => {
+  let rules = [
+    {
+      conditions: {
+        person$address$zip: { less: 1000 },
+      },
+      event: {
+        type: "match",
+      },
+    },
+  ];
+  let engine = new Engine(rules);
+  return engine.run({ person: { address: { zip: 10 } } }).then(events => {
+    expect(events.length).toEqual(1);
+    expect(events[0]).toEqual({ type: "match" });
+  });
+});

test/utils.test.js

@@ -6,6 +6,7 @@ import {
   extractRefSchema,
   isRefArray,
   toArray,
+  selectRef,
 } from "../src/utils";
 import { testInProd } from "./utils";
 
@@ -93,3 +94,8 @@ test("array transformation", () => {
   expect(toArray("Yes")).toEqual(["Yes"]);
   expect(toArray(["Yes", "No"])).toEqual(["Yes", "No"]);
 });
+
+test("select reference", () => {
+  expect(selectRef("address.zip", { address: { zip: 1000 } })).toEqual(1000);
+  expect(selectRef("address$zip", { address: { zip: 1000 } })).toEqual(1000);
+});