patch: add skipWhen for forward compatibility

README.md

@@ -62,7 +62,7 @@ Vest tries to remediate this by separating validation logic from feature logic s
 ## Example code ([Run in sandbox](https://codesandbox.io/s/vest-react-tutorial-finished-ztt8t?file=/src/validate.js))
 
 ```js
-import { create, only, test, enforce, warn } from 'vest';
+import { create, only, test, enforce, warn, skipWhen } from 'vest';
 
 export default create('user_form', (data = {}, currentField) => {
   only(currentField);
@@ -88,11 +88,11 @@ export default create('user_form', (data = {}, currentField) => {
     enforce(data.password).matches(/[0-9]/);
   });
 
-  if (data.password) {
+  skipWhen(!data.password, () => {
     test('confirm_password', 'Passwords do not match', () => {
       enforce(data.confirm_password).equals(data.password);
     });
-  }
+  });
 
   test('email', 'Email Address is not valid', () => {
     enforce(data.email).isEmail();

packages/vest/README.md

@@ -62,7 +62,7 @@ Vest tries to remediate this by separating validation logic from feature logic s
 ## Example code ([Run in sandbox](https://codesandbox.io/s/vest-react-tutorial-finished-ztt8t?file=/src/validate.js))
 
 ```js
-import { create, only, test, enforce, warn } from 'vest';
+import { create, only, test, enforce, warn, skipWhen } from 'vest';
 
 export default create('user_form', (data = {}, currentField) => {
   only(currentField);
@@ -88,11 +88,11 @@ export default create('user_form', (data = {}, currentField) => {
     enforce(data.password).matches(/[0-9]/);
   });
 
-  if (data.password) {
+  skipWhen(!data.password, () => {
     test('confirm_password', 'Passwords do not match', () => {
       enforce(data.confirm_password).equals(data.password);
     });
-  }
+  });
 
   test('email', 'Email Address is not valid', () => {
     enforce(data.email).isEmail();

packages/vest/docs/README.md

@@ -62,7 +62,7 @@ Vest tries to remediate this by separating validation logic from feature logic s
 ## Example code ([Run in sandbox](https://codesandbox.io/s/vest-react-tutorial-finished-ztt8t?file=/src/validate.js))
 
 ```js
-import { create, only, test, enforce, warn } from 'vest';
+import { create, only, test, enforce, warn, skipWhen } from 'vest';
 
 export default create('user_form', (data = {}, currentField) => {
   only(currentField);
@@ -88,11 +88,11 @@ export default create('user_form', (data = {}, currentField) => {
     enforce(data.password).matches(/[0-9]/);
   });
 
-  if (data.password) {
+  skipWhen(!data.password, () => {
     test('confirm_password', 'Passwords do not match', () => {
       enforce(data.confirm_password).equals(data.password);
     });
-  }
+  });
 
   test('email', 'Email Address is not valid', () => {
     enforce(data.email).isEmail();

packages/vest/docs/cross_field_validations.md

@@ -36,44 +36,44 @@ export default create('form_name', (data = {}) => {
 });
 ```
 
-## if/else for conditionally skipping fields
+## skipWhen for conditionally skipping fields
 
-If your field depends on a different field's existence or a different simple condition, you could use a basic if/else statement.
+If your field depends on a different field's existence or a different simple condition, you could use skipWhen.
 In the following example I only validate `confirm` if password is not empty:
 
 DEMO: https://codesandbox.io/s/demo-forked-z2ur9?file=/src/validate.js
 
 ```js
-import { create, test, enforce } from 'vest';
+import { create, test, enforce, skipWhen } from 'vest';
 export default create('user_form', (data = {}) => {
   test('password', 'Password is required', () => {
     enforce(data.password).isNotEmpty();
   });
-  if (data.password) {
+  skipWhen(!data.password, () => {
     test('confirm', 'Passwords do not match', () => {
       enforce(data.confirm).equals(data.password);
     });
-  }
+  });
 });
 ```
 
-## if/else for conditionally skipping field based on a previous result
+## skipWhen for conditionally skipping field based on a previous result
 
 Sometimes you might want to run a certain validation based on the validation result of a previously run test, for example - only test for password strength if password DOESN'T have Errors. You could access the intermediate validation result and use it mid-run.
 
 This requires using the function created from create():
 
 ```js
-import { create, test, enforce } from 'vest';
+import { create, test, enforce, skipWhen } from 'vest';
 const suite = create('user_form', (data = {}) => {
   test('password', 'Password is required', () => {
     enforce(data.password).isNotEmpty();
   });
-  if (!suite.get().hasErrors('password')) {
+  skipWhen(suite.get().hasErrors('password'), () => {
     test('password', 'Password is weak', () => {
       enforce(data.password).longerThan(8);
     });
-  }
+  });
 });
 export default suite;
 ```

packages/vest/docs/exclusion.md

@@ -55,24 +55,24 @@ const validationResult = suite(formData);
 
 ## Conditionally excluding portions of the suite
 
-In some cases we might need to skip a test or a group based on a given condition, for example - based on the intermediate state of the currently running suite. To allow this, can use an if statement.
+In some cases we might need to skip a test or a group based on a given condition, for example - based on the intermediate state of the currently running suite. To allow this, can use `skipWhen`.
 
 In the following example we're skipping the server side verification of the username if the username is invalid to begin with:
 
 ```js
-import { create, test, enforce } from 'vest';
+import { create, test, enforce, skipWhen } from 'vest';
 
 const suite = create('user_form', (data = {}) => {
   test('username', 'Username is required', () => {
     enforce(data.username).isNotEmpty();
   });
 
-  if (!suite.get().hasErrors('username')) {
+  skipWhen(suite.get().hasErrors('username'), () => {
     test('username', 'Username already exists', () => {
       // this is an example for a server call
       return doesUserExist(data.username);
     });
-  }
+  });
 });
 export default suite;
 ```

packages/vest/docs/migration.md

@@ -72,9 +72,9 @@ const suite = vest.create('user_form', () => {
 
 ```js
 const suite = create('user_form', () => {
-  if (suite.get().hasErrors('username')) {
+  skipWhen(suite.get().hasErrors('username'), () => {
     /* ... */
-  }
+  });
 });
 ```
 

packages/vest/docs/utilities.md

@@ -81,7 +81,7 @@ This can be useful when running async validations on the server, or when you do
 `promisify()` accepts a validation suite declaration, and returns a function that when called, returns a Promise.
 
 ```js
-import { create, test } from 'vest';
+import { create, test, skipWhen } from 'vest';
 import promisify from 'vest/promisify';
 
 const suite = promisify(
@@ -94,12 +94,12 @@ const suite = promisify(
 );
 
 suite(data).then(res => {
-  if (res.hasErrors('email')) {
+  skipWhen(res.hasErrors('email'), () => {
     /* ... */
-  }
+  });
 
-  if (res.hasErrors('username')) {
+  skipWhen(res.hasErrors('username'), () => {
     /* ... */
-  }
+  });
 });
 ```

packages/vest/src/__tests__/__snapshots__/infra.test.js.snap

@@ -178,6 +178,7 @@ Object {
   "only": [Function],
   "optional": [Function],
   "skip": [Function],
+  "skipWhen": [Function],
   "test": [Function],
   "warn": [Function],
 }

packages/vest/src/__tests__/integration.stateful-tests.test.js

@@ -33,7 +33,7 @@ describe('Stateful behavior', () => {
 });
 
 describe('more complex', () => {
-  const { test, enforce, create } = vest;
+  const { test, enforce, create, skipWhen } = vest;
 
   const data = {};
 
@@ -104,11 +104,11 @@ describe('more complex', () => {
       enforce(data.password).isNotEmpty();
     });
 
-    if (!suite.get().hasErrors('password')) {
+    skipWhen(suite.get().hasErrors('password'), () => {
       test('confirm', 'passwords do not match', () => {
         enforce(data.confirm).equals(data.password);
       });
-    }
+    });
   });
 });
 

packages/vest/src/hooks/hooks.js

@@ -1,4 +1,5 @@
 export { only, skip } from 'exclusive';
+export { default as skipWhen } from 'skipWhen'
 export { default as warn } from 'warn';
 export { default as group } from 'group';
 export { default as optional } from 'optionalTests';

packages/vest/src/hooks/skipWhen.js

@@ -0,0 +1,15 @@
+import isFunction from 'isFunction';
+import { isFalsy } from 'isTruthy';
+import optionalFunctionValue from 'optionalFunctionValue';
+
+// This function by itself doesn't do much, and is only a wrapper around
+// an if statement. The reason for it is to support version 4 api in version 3
+// so that someone reading the latest docs can still run the code.
+
+export default function skipWhen(conditional, callback) {
+  if (isFalsy(optionalFunctionValue(conditional))) {
+    if (isFunction(callback)) {
+      callback();
+    }
+  }
+}

packages/vest/src/vest.js

@@ -1,6 +1,6 @@
 import create from 'createSuite';
 import enforce from 'enforce';
-import { only, skip, warn, group, optional } from 'hooks';
+import { only, skip, warn, group, optional, skipWhen } from 'hooks';
 import test from 'test';
 
 const VERSION = __LIB_VERSION__;
@@ -13,6 +13,7 @@ export default {
   only,
   optional,
   skip,
+  skipWhen,
   test,
   warn,
 };

packages/vest/src/vest.mjs.js

@@ -1,6 +1,6 @@
 import create from 'createSuite';
 import enforce from 'enforce';
-import { only, skip, warn, group, optional } from 'hooks';
+import { only, skip, warn, group, optional, skipWhen } from 'hooks';
 import test from 'test';
 
 const VERSION = __LIB_VERSION__;
@@ -13,8 +13,20 @@ export default {
   only,
   optional,
   skip,
+  skipWhen,
   test,
   warn,
 };
 
-export { VERSION, create, enforce, group, only, optional, skip, test, warn };
+export {
+  VERSION,
+  create,
+  enforce,
+  group,
+  only,
+  optional,
+  skip,
+  skipWhen,
+  test,
+  warn,
+};