1.0.13

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@pushrocks/smartexpect",
-  "version": "1.0.8",
+  "version": "1.0.13",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@pushrocks/smartexpect",
-      "version": "1.0.8",
+      "version": "1.0.13",
       "license": "MIT",
       "dependencies": {
         "@pushrocks/smartdelay": "^2.0.13",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartexpect",
-  "version": "1.0.8",
+  "version": "1.0.13",
   "private": false,
   "description": "manage expectations in code",
   "main": "dist_ts/index.js",

test/test.ts

@@ -36,4 +36,12 @@ tap.test('should be greater than', async () => {
   smartexpect.expect(4).toBeLessThan(5);
 })
 
+tap.test('should correctly determine toContain', async () => {
+  const hello = {
+    socool: 'yes'
+  };
+  const testArray = [hello];
+  smartexpect.expect(testArray).toContain(hello);
+})
+
 tap.start();

ts/smartexpect.classes.assertion.ts

@@ -5,6 +5,7 @@ export type TExecutionType = 'sync' | 'async';
 export class Assertion {
   executionMode: TExecutionType;
   baseReference: any;
+  propertyDrillDown: string[] = [];
   private notSetting = false;
   private timeoutSetting = 0;
   constructor(baseReferenceArg: any, executionModeArg: TExecutionType) {
@@ -12,6 +13,14 @@ export class Assertion {
     this.executionMode = executionModeArg;
   }
 
+  private getObjectToTestReference() {
+    let returnObjectToTestReference = this.baseReference;
+    for (const property of this.propertyDrillDown) {
+      returnObjectToTestReference = returnObjectToTestReference[property];
+    }
+    return returnObjectToTestReference;
+  }
+
   public get not() {
     this.notSetting = true;
     return this;
@@ -29,7 +38,7 @@ export class Assertion {
       } else {
         let isOk = false;
         try {
-          runDirectOrNegated(checkFunction())
+          runDirectOrNegated(checkFunction());
         } catch (e) {
           isOk = true;
         }
@@ -37,7 +46,7 @@ export class Assertion {
           throw new Error('Negated assertion is not ok!');
         }
       }
-    }
+    };
 
     if (this.executionMode === 'async') {
       const done = plugins.smartpromise.defer();
@@ -47,14 +56,14 @@ export class Assertion {
         if (this.timeoutSetting) {
           plugins.smartdelay.delayFor(this.timeoutSetting).then(() => {
             if (done.status === 'pending') {
-              done.reject(new Error(`${this.baseReference} timed out at ${this.timeoutSetting}!`))
+              done.reject(new Error(`${this.baseReference} timed out at ${this.timeoutSetting}!`));
             }
           });
         }
-        this.baseReference.then(promiseResultArg => {
+        this.baseReference.then((promiseResultArg) => {
           this.baseReference = promiseResultArg;
           done.resolve(runDirectOrNegated(checkFunction));
-        })
+        });
       }
       return done.promise;
     } else {
@@ -64,9 +73,10 @@ export class Assertion {
 
   public toBeTypeofString() {
     return this.runCheck(() => {
-      if (typeof this.baseReference !== 'string') {
+      if (typeof this.getObjectToTestReference() !== 'string') {
         throw new Error(
-          `Assertion failed: ${this.baseReference} is not of type string, but typeof ${typeof this.baseReference}`
+          `Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
+            .baseReference}`
         );
       }
     });
@@ -74,9 +84,10 @@ export class Assertion {
 
   public toBeTypeofNumber() {
     return this.runCheck(() => {
-      if (typeof this.baseReference !== 'number') {
+      if (typeof this.getObjectToTestReference() !== 'number') {
         throw new Error(
-          `Assertion failed: ${this.baseReference} is not of type string, but typeof ${typeof this.baseReference}`
+          `Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
+            .baseReference}`
         );
       }
     });
@@ -84,9 +95,10 @@ export class Assertion {
 
   public toBeTypeofBoolean() {
     return this.runCheck(() => {
-      if (typeof this.baseReference !== 'boolean') {
+      if (typeof this.getObjectToTestReference() !== 'boolean') {
         throw new Error(
-          `Assertion failed: ${this.baseReference} is not of type string, but typeof ${typeof this.baseReference}`
+          `Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
+            .baseReference}`
         );
       }
     });
@@ -94,64 +106,131 @@ export class Assertion {
 
   public toEqual(comparisonObject: any) {
     return this.runCheck(() => {
-      const result = plugins.fastDeepEqual(this.baseReference, comparisonObject);
+      const result = plugins.fastDeepEqual(this.getObjectToTestReference(), comparisonObject);
       if (!result) {
-        throw new Error(`${this.baseReference} does not equal ${comparisonObject}`);
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`);
       }
     });
   }
 
   public toBeTrue() {
     return this.runCheck(() => {
-      const result = typeof this.baseReference === 'boolean' && this.baseReference === true;
+      const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === true;
       if (!result) {
-        throw new Error(`${this.baseReference} is not true or not of type boolean`);
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not true or not of type boolean`);
       }
     });
   }
 
   public toBeFalse() {
     return this.runCheck(() => {
-      const result = typeof this.baseReference === 'boolean' && this.baseReference === false;
+      const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === false;
       if (!result) {
-        throw new Error(`${this.baseReference} is not false or not of type boolean`);
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not false or not of type boolean`);
       }
     });
   }
 
   public toBeInstanceOf(classArg: any) {
     return this.runCheck(() => {
-      const result = this.baseReference instanceof classArg;
+      const result = this.getObjectToTestReference() instanceof classArg;
       if (!result) {
-        throw new Error(`${this.baseReference} is not an instance of ${classArg}`);
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not an instance of ${classArg}`);
       }
     });
   }
 
   public toHaveProperty(propertyArg: string) {
     return this.runCheck(() => {
-      const result = !!this.baseReference[propertyArg];
+      const result = !!this.getObjectToTestReference()[propertyArg];
       if (!result) {
-        throw new Error(`${this.baseReference} does not have property ${propertyArg}`);
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not have property ${propertyArg}`);
       }
     });
   }
 
   public toBeGreaterThan(numberArg: number) {
     return this.runCheck(() => {
-      const result = this.baseReference > numberArg;
+      const result = this.getObjectToTestReference() > numberArg;
       if (!result) {
-        throw new Error(`${this.baseReference} is not greater than ${numberArg}`);
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than ${numberArg}`);
       }
     });
   }
 
   public toBeLessThan(numberArg: number) {
     return this.runCheck(() => {
-      const result = this.baseReference < numberArg;
+      const result = this.getObjectToTestReference() < numberArg;
       if (!result) {
-        throw new Error(`${this.baseReference} is not less than ${numberArg}`);
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not less than ${numberArg}`);
       }
     });
   }
+
+  public toBeNull() {
+    return this.runCheck(() => {
+      const result = this.getObjectToTestReference() === null;
+      if (!result) {
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null`);
+      }
+    });
+  }
+
+  public toBeUndefined() {
+    return this.runCheck(() => {
+      const result = this.getObjectToTestReference() === undefined;
+      if (!result) {
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not undefined`);
+      }
+    });
+  }
+
+  public toBeNullOrUndefined() {
+    return this.runCheck(() => {
+      const result = this.getObjectToTestReference() === null || this.getObjectToTestReference() === undefined;
+      if (!result) {
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null or undefined`);
+      }
+    });
+  }
+
+  public toContain(itemArg: any) {
+    return this.runCheck(() => {
+      const result =
+        this.getObjectToTestReference() instanceof Array &&
+        this.getObjectToTestReference().includes(itemArg);
+      if (!result) {
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`);
+      }
+    });
+  }
+
+  public toStartWith(itemArg: any) {
+    return this.runCheck(() => {
+      const testObject = this.getObjectToTestReference();
+      const result =
+        typeof testObject === 'string' &&
+        testObject.startsWith(itemArg);
+      if (!result) {
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`);
+      }
+    });
+  }
+
+  public toEndWith(itemArg: any) {
+    return this.runCheck(() => {
+      const testObject = this.getObjectToTestReference();
+      const result =
+        typeof testObject === 'string' &&
+        testObject.endsWith(itemArg);
+      if (!result) {
+        throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`);
+      }
+    });
+  }
+
+  public property(propertyNameArg: string) {
+    this.propertyDrillDown.push(propertyNameArg);
+    return this;
+  }
 }