add functional when

Author: ealush

jsconfig.json

@@ -23,11 +23,15 @@ function isArrayOf(value, ruleChains) {
   }
 
   for (let i = 0; i < plainValue.length; i++) {
-    // Set result per each item in the array|
+    // Set result per each item in the array
     result.setChild(
       i,
       runCompoundChain(
-        EnforceContext.wrap(plainValue[i]).setFailFast(value.failFast),
+        new EnforceContext({
+          value: plainValue[i],
+          obj: plainValue,
+          key: i,
+        }).setFailFast(value.failFast),
         ruleChains,
         { mode: MODE_ANY }
       )

packages/n4s/src/compounds/isArrayOf.js

@@ -1,5 +1,67 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`Rule with "when" Should skip all excluded array items 1`] = `
+RuleResult {
+  "children": Object {
+    "items": RuleResult {
+      "children": Object {
+        "0": RuleResult {
+          "children": Object {
+            "checked": RuleResult {
+              "failed": false,
+              "hasErrors": false,
+              "hasWarnings": false,
+              "warn": false,
+            },
+          },
+          "failed": false,
+          "hasErrors": false,
+          "hasWarnings": false,
+          "when": false,
+        },
+        "3": RuleResult {
+          "children": Object {
+            "checked": RuleResult {
+              "failed": false,
+              "hasErrors": false,
+              "hasWarnings": false,
+              "warn": false,
+            },
+          },
+          "failed": false,
+          "hasErrors": false,
+          "hasWarnings": false,
+          "when": false,
+        },
+      },
+      "failed": false,
+      "hasErrors": false,
+      "hasWarnings": false,
+      "isArray": true,
+    },
+  },
+  "failed": false,
+  "hasErrors": false,
+  "hasWarnings": false,
+}
+`;
+
+exports[`Rule with "when" Should skip excluded object items 1`] = `
+RuleResult {
+  "children": Object {
+    "example1": RuleResult {
+      "failed": false,
+      "hasErrors": false,
+      "hasWarnings": false,
+      "warn": false,
+    },
+  },
+  "failed": false,
+  "hasErrors": false,
+  "hasWarnings": false,
+}
+`;
+
 exports[`Rule with a message Should add message to result 1`] = `
 RuleResult {
   "children": Object {

packages/n4s/src/meta/__tests__/__snapshots__/ruleMeta.test.js.snap

@@ -1,3 +1,4 @@
+import RuleResult from 'RuleResult';
 import enforce from 'enforce';
 
 describe('Rule with a message', () => {
@@ -62,3 +63,91 @@ describe('Rule with a warning', () => {
     expect(res).toMatchSnapshot();
   });
 });
+
+describe('Rule with "when"', () => {
+  it('Should skip all excluded array items', () => {
+    const Schema = enforce.shape({
+      items: enforce.isArrayOf(
+        enforce.shape({ checked: enforce.isBoolean() }).when(value => {
+          return value.checked;
+        })
+      ),
+    });
+
+    const res = Schema.run({
+      items: [
+        { checked: true },
+        { checked: false },
+        { checked: false },
+        { checked: true },
+      ],
+    });
+
+    expect(res.children.items.children[0]).toBeInstanceOf(RuleResult);
+    expect(res.children.items.children[1]).toBeUndefined();
+    expect(res.children.items.children[2]).toBeUndefined();
+    expect(res.children.items.children[3]).toBeInstanceOf(RuleResult);
+
+    expect(res).toMatchSnapshot();
+  });
+
+  it('Should skip excluded object items', () => {
+    const Schema = enforce.shape({
+      example: enforce.isString().when(() => false),
+      example1: enforce.isString(),
+    });
+
+    const res = Schema.run({
+      example: 'something',
+      example1: 'something',
+    });
+
+    expect(res.children.example).toBeUndefined();
+    expect(res.children.example1).toBeInstanceOf(RuleResult);
+
+    expect(res).toMatchSnapshot();
+  });
+  it('Should pass each item the value, key and parent', () => {
+    const whenItems = jest.fn();
+    const whenName = jest.fn();
+    const Schema = enforce.shape({
+      name: enforce
+        .shape({
+          first: enforce.isString(),
+        })
+        .when(whenName),
+      items: enforce.isArrayOf(
+        enforce.shape({ checked: enforce.isBoolean() }).when(whenItems)
+      ),
+    });
+
+    const data = {
+      name: {
+        first: 'example',
+      },
+      items: [
+        { checked: true },
+        { checked: false },
+        { checked: false },
+        { checked: true },
+      ],
+    };
+
+    const res = Schema.run(data);
+
+    expect(whenName).toHaveBeenCalledWith(data.name, 'name', data);
+
+    expect(whenItems.mock.calls[0][0]).toBe(data.items[0]);
+    expect(whenItems.mock.calls[1][0]).toBe(data.items[1]);
+    expect(whenItems.mock.calls[2][0]).toBe(data.items[2]);
+    expect(whenItems.mock.calls[3][0]).toBe(data.items[3]);
+    expect(whenItems.mock.calls[0][1]).toBe(0); // key
+    expect(whenItems.mock.calls[1][1]).toBe(1); // key
+    expect(whenItems.mock.calls[2][1]).toBe(2); // key
+    expect(whenItems.mock.calls[3][1]).toBe(3); // key
+    expect(whenItems.mock.calls[0][2]).toBe(data.items); // parent
+    expect(whenItems.mock.calls[1][2]).toBe(data.items); // parent
+    expect(whenItems.mock.calls[2][2]).toBe(data.items); // parent
+    expect(whenItems.mock.calls[3][2]).toBe(data.items); // parent
+  });
+});

packages/n4s/src/meta/__tests__/ruleMeta.test.js

@@ -1,4 +1,6 @@
+
 import message from 'ruleMessage';
 import warn from 'ruleWarn';
+import when from 'ruleWhen';
 
-export default { warn, message };
+export default { warn, message, when };

packages/n4s/src/meta/ruleMeta.js

@@ -0,0 +1,13 @@
+import EnforceContext from 'EnforceContext';
+import optionalFunctionValue from 'optionalFunctionValue';
+
+export default function when(value, condition, bail) {
+  const shouldBail = !optionalFunctionValue(
+    condition,
+    [EnforceContext.unwrap(value)].concat(
+      EnforceContext.is(value) ? [value.key, value.obj] : []
+    )
+  );
+
+  return bail(shouldBail);
+}

packages/n4s/src/meta/ruleWhen.js

@@ -2,6 +2,7 @@ import hasOwnProperty from 'hasOwnProperty';
 
 import { isBoolean } from 'isBoolean';
 import { isEmpty } from 'isEmpty';
+import { isNull } from 'isNull';
 import { isUndefined } from 'isUndefined';
 import { HAS_WARNINGS, HAS_ERRORS } from 'sharedKeys';
 
@@ -65,6 +66,10 @@ RuleResult.prototype.setFailed = function (failed) {
  * @param {RuleResult} child
  */
 RuleResult.prototype.setChild = function (key, child) {
+  if (isNull(child)) {
+    return null;
+  }
+
   const isWarning =
     this[HAS_WARNINGS] || child[HAS_WARNINGS] || child.warn || this.warn;
   this.setAttribute(HAS_WARNINGS, (isWarning && child.failed) || false);
@@ -96,6 +101,10 @@ RuleResult.prototype.getChild = function (key) {
  * @param {Boolean|RuleResult} newRes
  */
 RuleResult.prototype.extend = function (newRes) {
+  if (isNull(newRes)) {
+    return this;
+  }
+
   const res = RuleResult.is(newRes)
     ? newRes
     : new RuleResult().setAttribute('warn', !!this.warn).setFailed(!newRes);

packages/n4s/src/runtime/RuleResult.js

@@ -30,8 +30,8 @@ export default function bindLazyRule(ruleName) {
 
       // Add a meta function
       if (ruleMeta[rule.name] === rule) {
-        meta.push((value, ruleResult) => {
-          ruleResult.setAttribute(rule.name, rule(value, args[0]));
+        meta.push((value, ruleResult, bail) => {
+          ruleResult.setAttribute(rule.name, rule(value, args[0], bail));
         });
       } else {
         // Register a rule
@@ -57,11 +57,17 @@ export default function bindLazyRule(ruleName) {
       returnvalue[RUN_RULE] = value => {
         const result = new RuleResult(true);
 
+        let bailed = false;
+
         // Run meta chains
         meta.forEach(fn => {
-          fn(value, result);
+          fn(value, result, shouldBail => (bailed = shouldBail));
         });
 
+        if (bailed) {
+          return null;
+        }
+
         // Iterate over all the registered rules
         // This runs the function that's inside `addFn`
         for (const fn of registeredRules) {

packages/n4s/src/runtime/bindLazyRule.js

@@ -1,6 +1,7 @@
 import RuleResult from 'RuleResult';
 import { MODE_ALL, MODE_ONE, MODE_ANY } from 'enforceKeywords';
 import { isEmpty } from 'isEmpty';
+import { isNull } from 'isNull';
 import { runLazyRule } from 'runLazyRules';
 
 /**
@@ -24,6 +25,10 @@ export default function runCompoundChain(value, rules, options) {
     // Inner result for each iteration
     const currentResult = runLazyRule(chain, value);
 
+    if (isNull(currentResult)) {
+      return null;
+    }
+
     const pass = currentResult.pass;
 
     if (pass) {