Merge pull request #9 from qavajs/satisfy

added `to satisfy` validation to verify user-defined expectation provided as predicate

Author: AlexGalichenko

CHANGELOG.md

@@ -10,6 +10,20 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :pencil: - chore
 :microscope: - experimental
 
+## [2.2.0]
+- :rocket: added `to satisfy` validation to verify user-defined expectation provided as predicate
+```Gherkin
+Then I expect '$value' to satisfy '$either(1, 2)'
+```
+where `$either` is a function
+```typescript
+function either(...expected) {
+    return function (actual) {
+        return expected.includes(actual)
+    }
+}
+```
+
 ## [2.1.1]
 - :beetle: replaced .as to Cypress.log in page object logging
 

lib/types.js

@@ -34,7 +34,7 @@ defineParameterType({
 
 defineParameterType({
     name: 'validation',
-    regexp: /((?:is |do |does |to )?(not |to not )?(?:to )?(?:be )?(equal|strictly equal|deeply equal|have member|match|contain|above|below|greater than|less than|have type)(?:s|es)?)/,
+    regexp: /((?:is |do |does |to )?(not |to not )?(?:to )?(?:be )?(softly )?(equal|strictly equal|deeply equal|have member|match|contain|above|below|greater than|less than|have type|have property|match schema|include members|satisfy|case insensitive equal)(?:s|es| to)?)/,
     useForSnippets: false,
     transformer: getValidation
 });

lib/valueExpect.js

@@ -10,6 +10,30 @@ chai.Assertion.addMethod('notStrictEqual', function (ER) {
     );
 });
 
+chai.Assertion.addMethod('caseInsensitiveEqual', function (ER) {
+    const obj = this._obj;
+
+    this.assert(
+        obj.toLowerCase() === ER.toLowerCase(),
+        'expected #{this} to equal #{exp}',
+        'expected #{this} to not equal #{exp}',
+        ER,
+        obj
+    );
+});
+
+chai.Assertion.addMethod('satisfy', function (predicate) {
+    const actual = this._obj;
+
+    this.assert(
+        predicate(actual),
+        'expected #{this} to satisfy #{exp}',
+        'expected #{this} to not satisfy #{exp}',
+        predicate.toString(),
+        actual
+    );
+});
+
 export const validations = {
     EQUAL: 'equal',
     DEEPLY_EQUAL: 'deeply equal',
@@ -23,7 +47,9 @@ export const validations = {
     LESS: 'less than',
     HAVE_TYPE: 'have type',
     INCLUDE_MEMBERS: 'include member',
-    HAVE_PROPERTY: 'have property'
+    HAVE_PROPERTY: 'have property',
+    CASE_INSENSITIVE_EQUAL: 'case insensitive equal',
+    SATISFY: 'satisfy'
 };
 
 const isClause = '(?:is |do |does |to )?';
@@ -50,6 +76,8 @@ const validationFns = {
     [validations.HAVE_TYPE]: (expectClause, ER) => expectClause.a(ER),
     [validations.INCLUDE_MEMBERS]: (expectClause, ER) => expectClause.include.members(ER),
     [validations.HAVE_PROPERTY]: (expectClause, ER) => expectClause.have.property(ER),
+    [validations.CASE_INSENSITIVE_EQUAL]: (expectClause, ER) => expectClause.caseInsensitiveEqual(ER),
+    [validations.SATISFY]: (expectClause, ER) => expectClause.satisfy(ER),
 };
 
 /**