1.0.20

.gitea/workflows/gitzone_ci_default.yaml

@@ -0,0 +1,104 @@
+name: CI Pipeline
+
+on: push
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+jobs:
+
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: $
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install pnpm and npmci
+      run: |
+        pnpm install -g pnpm
+        pnpm install -g @shipzone/npmci
+
+    - name: Run npm prepare
+      run: npmci npm prepare
+
+    - name: Audit production dependencies
+      run: |
+        npmci command npm config set registry https://registry.npmjs.org
+        npmci command pnpm audit --audit-level=high --prod
+
+    - name: Audit development dependencies
+      run: |
+        npmci command npm config set registry https://registry.npmjs.org
+        npmci command pnpm audit --audit-level=high --dev
+
+  test:
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: $
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Test stable
+      run: |
+        npmci node install stable
+        npmci npm install
+        npmci npm test
+
+    - name: Test build
+      run: |
+        npmci node install stable
+        npmci npm install
+        npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: $
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Release
+      run: |
+        npmci node install stable
+        npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: $
+    continue-on-error: true
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Code quality
+      run: |
+        npmci command npm install -g typescript
+        npmci npm prepare
+        npmci npm install
+
+    - name: Trigger
+      run: npmci trigger
+
+    - name: Build docs and upload artifacts
+      run: |
+        npmci node install stable
+        npmci npm install
+        npmci command npm run buildDocs
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: public
+        path: public
+        retention-days: 7

.gitlab-ci.yml

@@ -1,128 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-before_script:
-  - npm install -g @shipzone/npmci
-
-# ====================
-# security stage
-# ====================
-auditProductionDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --production --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
-  tags:
-    - docker
-  allow_failure: true
-
-auditDevDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
-  tags:
-    - docker
-  allow_failure: true
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - npmci command npm install -g typescript
-    - npmci npm prepare
-    - npmci npm install
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install stable 
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run buildDocs
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

npmextra.json

@@ -3,10 +3,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartexpect",
       "description": "manage expectations in code",
-      "npmPackagename": "@pushrocks/smartexpect",
+      "npmPackagename": "@push.rocks/smartexpect",
       "license": "MIT",
       "projectDomain": "push.rocks"
     }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@pushrocks/smartexpect",
+  "name": "@push.rocks/smartexpect",
-  "version": "1.0.15",
+  "version": "1.0.20",
   "private": false,
   "description": "manage expectations in code",
   "main": "dist_ts/index.js",
@@ -16,16 +16,14 @@
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.66",
     "@gitzone/tsbundle": "^2.0.8",
-    "@gitzone/tsrun": "^1.2.42",
+    "@gitzone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.74",
+    "@gitzone/tstest": "^1.0.77",
-    "@pushrocks/tapbundle": "^5.0.4",
+    "@push.rocks/tapbundle": "^5.0.12",
-    "@types/node": "^20.3.1",
+    "@types/node": "^20.4.10"
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^3.0.1",
+    "@push.rocks/smartdelay": "^3.0.5",
-    "@pushrocks/smartpromise": "^4.0.2",
+    "@push.rocks/smartpromise": "^4.0.2",
     "fast-deep-equal": "^3.1.3"
   },
   "browserslist": [

readme.md

@@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
 PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartexpect)](https://lossless.cloud)
 PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartexpect)](https://lossless.cloud)
 BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartexpect)](https://lossless.cloud)
-Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,4 +1,4 @@
-import { tap } from '@pushrocks/tapbundle';
+import { tap } from '@push.rocks/tapbundle';
 import * as smartexpect from '../ts/index.js';
 
 tap.test('sync tests', async () => {
@@ -25,7 +25,7 @@ tap.test('should check equality', async () => {
 tap.test('should check for regexp matching', async () => {
   smartexpect.expect('hithere').toMatch(/hi/);
   smartexpect.expect('hithere').not.toMatch(/ho/);
-})
+});
 
 tap.test('should correctly state property presence', async () => {
   const testObject = {

ts/00_commitinfo_data.ts

@@ -2,7 +2,7 @@
  * autocreated commitinfo by @pushrocks/commitinfo
  */
 export const commitinfo = {
-  name: '@pushrocks/smartexpect',
+  name: '@push.rocks/smartexpect',
-  version: '1.0.15',
+  version: '1.0.20',
   description: 'manage expectations in code'
 }

ts/smartexpect.classes.assertion.ts

@@ -184,6 +184,26 @@ export class Assertion {
     });
   }
 
+  public toHaveDeepProperty(properties: string[]) {
+    return this.runCheck(() => {
+      let obj = this.getObjectToTestReference();
+      let currentPath = '';
+
+      for (const property of properties) {
+        if (currentPath) {
+          currentPath += `.${property}`;
+        } else {
+          currentPath = property;
+        }
+
+        if (!obj || !(property in obj)) {
+          throw new Error(`Missing property at path "${currentPath}" in ${this.baseReference}`);
+        }
+        obj = obj[property];
+      }
+    });
+  }
+
   public toBeGreaterThan(numberArg: number) {
     return this.runCheck(() => {
       const result = this.getObjectToTestReference() > numberArg;
@@ -240,6 +260,8 @@ export class Assertion {
     });
   }
 
+  // Array
+
   public toContain(itemArg: any) {
     return this.runCheck(() => {
       const result =
@@ -253,6 +275,47 @@ export class Assertion {
     });
   }
 
+  public toBeEmptyArray() {
+    return this.runCheck(() => {
+      const arrayRef = this.getObjectToTestReference();
+      if (!Array.isArray(arrayRef) || arrayRef.length !== 0) {
+        throw new Error(`Expected ${this.baseReference} to be an empty array, but it was not.`);
+      }
+    });
+  }
+
+  public toContainAll(values: any[]) {
+    return this.runCheck(() => {
+      const arrayRef = this.getObjectToTestReference();
+      if (!Array.isArray(arrayRef)) {
+        throw new Error(`Expected ${this.baseReference} to be an array.`);
+      }
+
+      for (const value of values) {
+        if (!arrayRef.includes(value)) {
+          throw new Error(
+            `Expected ${this.baseReference} to include value "${value}", but it did not.`
+          );
+        }
+      }
+    });
+  }
+
+  public toExclude(value: any) {
+    return this.runCheck(() => {
+      const arrayRef = this.getObjectToTestReference();
+      if (!Array.isArray(arrayRef)) {
+        throw new Error(`Expected ${this.baseReference} to be an array.`);
+      }
+
+      if (arrayRef.includes(value)) {
+        throw new Error(
+          `Expected ${this.baseReference} to exclude value "${value}", but it included it.`
+        );
+      }
+    });
+  }
+
   public toStartWith(itemArg: any) {
     return this.runCheck(() => {
       const testObject = this.getObjectToTestReference();
@@ -277,6 +340,203 @@ export class Assertion {
     });
   }
 
+  // ... previous code ...
+
+  public toBeOneOf(values: any[]) {
+    return this.runCheck(() => {
+      const result = values.includes(this.getObjectToTestReference());
+      if (!result) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not one of ${values}`
+        );
+      }
+    });
+  }
+
+  public toHaveLength(length: number) {
+    return this.runCheck(() => {
+      const obj = this.getObjectToTestReference();
+      if (typeof obj.length !== 'number' || obj.length !== length) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length of ${length}`
+        );
+      }
+    });
+  }
+
+  public toBeCloseTo(value: number, precision = 2) {
+    return this.runCheck(() => {
+      const difference = Math.abs(this.getObjectToTestReference() - value);
+      if (difference > Math.pow(10, -precision) / 2) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not close to ${value} up to ${precision} decimal places`
+        );
+      }
+    });
+  }
+
+  public toThrow(expectedError?: any) {
+    return this.runCheck(() => {
+      let thrown = false;
+      try {
+        this.getObjectToTestReference()();
+      } catch (e) {
+        thrown = true;
+        if (expectedError && !(e instanceof expectedError)) {
+          throw new Error(
+            `Expected function to throw ${expectedError.name}, but it threw ${e.name}`
+          );
+        }
+      }
+      if (!thrown) {
+        throw new Error(`Expected function to throw, but it didn't.`);
+      }
+    });
+  }
+
+  public toBeTruthy() {
+    return this.runCheck(() => {
+      if (!this.getObjectToTestReference()) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not truthy`
+        );
+      }
+    });
+  }
+
+  public toBeFalsy() {
+    return this.runCheck(() => {
+      if (this.getObjectToTestReference()) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not falsy`
+        );
+      }
+    });
+  }
+
+  public toBeGreaterThanOrEqual(numberArg: number) {
+    return this.runCheck(() => {
+      if (this.getObjectToTestReference() <= numberArg) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than or equal to ${numberArg}`
+        );
+      }
+    });
+  }
+
+  public toBeLessThanOrEqual(numberArg: number) {
+    return this.runCheck(() => {
+      if (this.getObjectToTestReference() >= numberArg) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not less than or equal to ${numberArg}`
+        );
+      }
+    });
+  }
+
+  public toMatchObject(objectArg: object) {
+    return this.runCheck(() => {
+      const partialMatch = plugins.fastDeepEqual(this.getObjectToTestReference(), objectArg); // Note: Implement a deep comparison function or use one from a library
+      if (!partialMatch) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} does not match the object ${objectArg}`
+        );
+      }
+    });
+  }
+
+  public toContainEqual(value: any) {
+    return this.runCheck(() => {
+      const arr = this.getObjectToTestReference();
+      const found = arr.some((item: any) => plugins.fastDeepEqual(item, value)); // Assuming fastDeepEqual checks deep equality
+      if (!found) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} does not contain the value ${value}`
+        );
+      }
+    });
+  }
+
+  public toBeArray() {
+    return this.runCheck(() => {
+      if (!Array.isArray(this.getObjectToTestReference())) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not an array`
+        );
+      }
+    });
+  }
+
+  public toInclude(substring: string) {
+    return this.runCheck(() => {
+      if (!this.getObjectToTestReference().includes(substring)) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} does not include the substring ${substring}`
+        );
+      }
+    });
+  }
+
+  public toHaveLengthGreaterThan(length: number) {
+    return this.runCheck(() => {
+      const obj = this.getObjectToTestReference();
+      if (typeof obj.length !== 'number' || obj.length <= length) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length greater than ${length}`
+        );
+      }
+    });
+  }
+
+  public toHaveLengthLessThan(length: number) {
+    return this.runCheck(() => {
+      const obj = this.getObjectToTestReference();
+      if (typeof obj.length !== 'number' || obj.length >= length) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length less than ${length}`
+        );
+      }
+    });
+  }
+
+  public toBeDate() {
+    return this.runCheck(() => {
+      if (!(this.getObjectToTestReference() instanceof Date)) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not a date`
+        );
+      }
+    });
+  }
+
+  public toBeBeforeDate(date: Date) {
+    return this.runCheck(() => {
+      if (!(this.getObjectToTestReference() < date)) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not before ${date}`
+        );
+      }
+    });
+  }
+
+  public toBeAfterDate(date: Date) {
+    return this.runCheck(() => {
+      if (!(this.getObjectToTestReference() > date)) {
+        throw new Error(
+          `${this.baseReference} with drill down ${this.propertyDrillDown} is not after ${date}`
+        );
+      }
+    });
+  }
+
+  public customAssertion(assertionFunction: (value: any) => boolean, errorMessage: string) {
+    return this.runCheck(() => {
+      if (!assertionFunction(this.getObjectToTestReference())) {
+        throw new Error(errorMessage);
+      }
+    });
+  }
+
   public property(propertyNameArg: string) {
     this.propertyDrillDown.push(propertyNameArg);
     return this;

ts/smartexpect.plugins.ts

@@ -1,5 +1,5 @@
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartdelay from '@push.rocks/smartdelay';
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartpromise from '@push.rocks/smartpromise';
 
 export { smartdelay, smartpromise };