@nexus-ioc/testing 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Aleksandr Melnik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,62 @@
+![npm](https://img.shields.io/npm/v/nexus-ioc)
+![license](https://img.shields.io/npm/l/nexus-ioc)
+![build](https://img.shields.io/github/actions/workflow/status/Isqanderm/ioc/build.yml)
+
+Test library for Nexus IoC
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [License](#license)
+- [Author](#author)
+- [Contributing](#contributing)
+- [Acknowledgements](#acknowledgements)
+- [Wiki](#wiki)
+
+## Installation
+
+```bash
+npm install nexus-ioc-testing
+```
+
+## Quick Start
+
+```typescript
+import { Injectable } from 'nexus-ioc';
+import { Test } from 'nexus-ioc-testing';
+
+describe('AppModule', () => {
+  it('should create instance', async () => {
+    @Injectable()
+    class AppService {}
+
+    const appModule = await Test.createModule({
+      providers: [AppService],
+    }).compile();
+
+    const appService = await appModule.get<AppService>(AppService);
+    expect(appService).toBeInstanceOf(AppService);
+  });
+});
+```
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Author
+
+Isqanderm (Aleksandr Melnik) - [LinkedIn](www.linkedin.com/in/isqander-melnik)
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## Acknowledgements
+
+Special thanks to the developers of Angular and NestJS for the inspiration.
+
+## Wiki
+
+For more detailed documentation, please visit the [Wiki](https://github.com/Isqanderm/ioc/wiki/Testing).

package/dist/core/hash-testing-util.d.ts

@@ -0,0 +1,6 @@
+import type { HashUtilInterface } from "nexus-ioc/dist/interfaces";
+export declare class HashTestingUtil implements HashUtilInterface {
+    hashString(value: string): Promise<string>;
+    hashObject(value: object): Promise<string>;
+    randomStringGenerator(): string;
+}

package/dist/core/hash-testing-util.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HashTestingUtil = void 0;
+const random_string_generator_util_1 = require("nexus-ioc/dist/utils/random-string-generator.util");
+class HashTestingUtil {
+    async hashString(value) {
+        let index = 0;
+        return new Array(64)
+            .fill(null)
+            .map(() => {
+            index++;
+            if (index >= value.length) {
+                index = 0;
+            }
+            return value.charAt(index);
+        })
+            .join("");
+    }
+    async hashObject(value) {
+        return "";
+    }
+    randomStringGenerator() {
+        return (0, random_string_generator_util_1.randomStringGenerator)();
+    }
+}
+exports.HashTestingUtil = HashTestingUtil;
+//# sourceMappingURL=hash-testing-util.js.map

package/dist/core/hash-testing-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-testing-util.js","sourceRoot":"","sources":["../../src/core/hash-testing-util.ts"],"names":[],"mappings":";;;AACA,oGAA0F;AAE1F,MAAa,eAAe;IAC3B,KAAK,CAAC,UAAU,CAAC,KAAa;QAC7B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,KAAK,CAAC,EAAE,CAAC;aAClB,IAAI,CAAC,IAAI,CAAC;aACV,GAAG,CAAC,GAAG,EAAE;YACT,KAAK,EAAE,CAAC;YAER,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC3B,KAAK,GAAG,CAAC,CAAC;YACX,CAAC;YAED,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAa;QAC7B,OAAO,EAAE,CAAC;IACX,CAAC;IAED,qBAAqB;QACpB,OAAO,IAAA,oDAAqB,GAAE,CAAC;IAChC,CAAC;CACD;AAxBD,0CAwBC"}

package/dist/core/testing-container.d.ts

@@ -0,0 +1,25 @@
+import { type DynamicModule, type GraphError, type InjectionToken, type Module, type ModuleContainerInterface, type ModuleMetadata, type ScannerPluginInterface } from "nexus-ioc";
+import type { ModuleTestingContainerInterface } from "../interfaces";
+export declare class Test<T extends ModuleMetadata = ModuleMetadata> implements ModuleTestingContainerInterface<T> {
+    private readonly metatype;
+    private readonly scannerPlugins;
+    private readonly hashTestingUtil;
+    private readonly container;
+    private readonly moduleTestingCreator;
+    private _moduleContainer;
+    private _moduleDecorator;
+    private _module;
+    private containerCompiled;
+    private constructor();
+    static createModule<M extends ModuleMetadata = ModuleMetadata>(metatype: M): Test<M>;
+    addModule(metatype: Module | DynamicModule): Promise<ModuleContainerInterface>;
+    getModule(metatype: Module): Promise<ModuleContainerInterface | undefined>;
+    replaceModule(metatypeToReplace: Module, newMetatype: Module): Promise<ModuleContainerInterface>;
+    get<T>(token: InjectionToken): Promise<T | undefined>;
+    compile(): Promise<ModuleContainerInterface>;
+    get module(): Module | null;
+    get moduleContainer(): ModuleContainerInterface | null;
+    addScannerPlugin(scanner: ScannerPluginInterface | ScannerPluginInterface[]): this;
+    setModuleDecorator(decorator: (metadata: T) => ClassDecorator): this;
+    get errors(): GraphError[];
+}

package/dist/core/testing-container.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Test = void 0;
+const nexus_ioc_1 = require("nexus-ioc");
+const container_1 = require("nexus-ioc/dist/core/modules/container");
+const container_not_compiled_error_1 = require("nexus-ioc/dist/errors/container-not-compiled.error");
+const hash_testing_util_1 = require("./hash-testing-util");
+const testing_creator_1 = require("./testing-creator");
+class Test {
+    constructor(metatype) {
+        this.metatype = metatype;
+        this.scannerPlugins = [];
+        this.hashTestingUtil = new hash_testing_util_1.HashTestingUtil();
+        this.container = new container_1.Container(this.hashTestingUtil);
+        this.moduleTestingCreator = new testing_creator_1.TestingCreator();
+        this._moduleContainer = null;
+        this._moduleDecorator = nexus_ioc_1.NsModule;
+        this._module = null;
+        this.containerCompiled = false;
+    }
+    static createModule(metatype) {
+        return new Test(metatype);
+    }
+    async addModule(metatype) {
+        return this.container.addModule(metatype);
+    }
+    async getModule(metatype) {
+        return this.container.getModule(metatype);
+    }
+    async replaceModule(metatypeToReplace, newMetatype) {
+        return this.container.replaceModule(metatypeToReplace, newMetatype);
+    }
+    get(token) {
+        if (!this.containerCompiled) {
+            throw new container_not_compiled_error_1.ContainerNotCompiledError();
+        }
+        return this.container.get(token);
+    }
+    async compile() {
+        this._module = this.moduleTestingCreator.create(this.metatype, this._moduleDecorator);
+        this._moduleContainer = await this.container.addModule(this._module);
+        await this.container.run(this._moduleContainer.metatype);
+        this.containerCompiled = true;
+        for (const scannerPlugin of this.scannerPlugins) {
+            await scannerPlugin.scan(this.container.graph);
+        }
+        return this._moduleContainer;
+    }
+    get module() {
+        if (!this.containerCompiled) {
+            throw new container_not_compiled_error_1.ContainerNotCompiledError();
+        }
+        return this._module;
+    }
+    get moduleContainer() {
+        if (!this.containerCompiled) {
+            throw new container_not_compiled_error_1.ContainerNotCompiledError();
+        }
+        return this._moduleContainer;
+    }
+    addScannerPlugin(scanner) {
+        const plugins = Array.isArray(scanner) ? scanner : [scanner];
+        this.scannerPlugins.push(...plugins);
+        return this;
+    }
+    setModuleDecorator(decorator) {
+        this._moduleDecorator = decorator;
+        return this;
+    }
+    get errors() {
+        if (!this.containerCompiled) {
+            throw new container_not_compiled_error_1.ContainerNotCompiledError();
+        }
+        return this._moduleContainer?.errors;
+    }
+}
+exports.Test = Test;
+//# sourceMappingURL=testing-container.js.map

package/dist/core/testing-container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing-container.js","sourceRoot":"","sources":["../../src/core/testing-container.ts"],"names":[],"mappings":";;;AAAA,yCASmB;AACnB,qEAAkE;AAClE,qGAA+F;AAE/F,2DAAsD;AACtD,uDAAmD;AAEnD,MAAa,IAAI;IAahB,YAAqC,QAAW;QAAX,aAAQ,GAAR,QAAQ,CAAG;QAV/B,mBAAc,GAA6B,EAAE,CAAC;QAC9C,oBAAe,GAAG,IAAI,mCAAe,EAAE,CAAC;QACxC,cAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAChD,yBAAoB,GAAG,IAAI,gCAAc,EAAK,CAAC;QACxD,qBAAgB,GAAoC,IAAI,CAAC;QACzD,qBAAgB,GACvB,oBAAe,CAAC;QACT,YAAO,GAAkB,IAAI,CAAC;QAC9B,sBAAiB,GAAG,KAAK,CAAC;IAEiB,CAAC;IAE7C,MAAM,CAAC,YAAY,CACzB,QAAW;QAEX,OAAO,IAAI,IAAI,CAAI,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,SAAS,CACrB,QAAgC;QAEhC,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,SAAS,CACrB,QAAgB;QAEhB,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,aAAa,CACzB,iBAAyB,EACzB,WAAmB;QAEnB,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IACrE,CAAC;IAEM,GAAG,CAAI,KAAqB;QAClC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,MAAM,IAAI,wDAAyB,EAAE,CAAC;QACvC,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAI,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,OAAO;QACnB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAC9C,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,gBAAgB,CACrB,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAErE,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAkB,CAAC,CAAC;QAEnE,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAE9B,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACjD,MAAM,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAED,IAAW,MAAM;QAChB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,MAAM,IAAI,wDAAyB,EAAE,CAAC;QACvC,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,IAAW,eAAe;QACzB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,MAAM,IAAI,wDAAyB,EAAE,CAAC;QACvC,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAED,gBAAgB,CACf,OAA0D;QAE1D,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,kBAAkB,CAAC,SAA0C;QACnE,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAW,MAAM;QAChB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,MAAM,IAAI,wDAAyB,EAAE,CAAC;QACvC,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,EAAE,MAAsB,CAAC;IACtD,CAAC;CACD;AAtGD,oBAsGC"}

package/dist/core/testing-creator.d.ts

@@ -0,0 +1,4 @@
+import type { ModuleMetadata, Type } from "nexus-ioc";
+export declare class TestingCreator<T extends ModuleMetadata> {
+    create(metatype: T, moduleDecorator: (metadata: T) => ClassDecorator): Type<unknown>;
+}

package/dist/core/testing-creator.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestingCreator = void 0;
+class TestingCreator {
+    create(metatype, moduleDecorator) {
+        const module = class {
+        };
+        moduleDecorator(metatype)(module);
+        return module;
+    }
+}
+exports.TestingCreator = TestingCreator;
+//# sourceMappingURL=testing-creator.js.map

package/dist/core/testing-creator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing-creator.js","sourceRoot":"","sources":["../../src/core/testing-creator.ts"],"names":[],"mappings":";;;AAEA,MAAa,cAAc;IAC1B,MAAM,CACL,QAAW,EACX,eAAgD;QAEhD,MAAM,MAAM,GAAG;SAAQ,CAAC;QAExB,eAAe,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;QAElC,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AAXD,wCAWC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { Test } from "./core/testing-container";
+export * from "./interfaces";

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Test = void 0;
+const tslib_1 = require("tslib");
+var testing_container_1 = require("./core/testing-container");
+Object.defineProperty(exports, "Test", { enumerable: true, get: function () { return testing_container_1.Test; } });
+tslib_1.__exportStar(require("./interfaces"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,8DAAgD;AAAvC,yGAAA,IAAI,OAAA;AACb,uDAA6B"}

package/dist/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./module-testing-container.interface";

package/dist/interfaces/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./module-testing-container.interface"), exports);
+//# sourceMappingURL=index.js.map

package/dist/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,+EAAqD"}

package/dist/interfaces/module-testing-container.interface.d.ts

@@ -0,0 +1,5 @@
+import type { ContainerBaseInterface, ModuleContainerInterface, ModuleMetadata, ModulePluginInterface } from "nexus-ioc";
+export interface ModuleTestingContainerInterface<T extends ModuleMetadata> extends ContainerBaseInterface, ModulePluginInterface {
+    setModuleDecorator(decorator: <M extends ModuleMetadata = ModuleMetadata>(metadata: M) => ClassDecorator): this;
+    compile(): Promise<ModuleContainerInterface>;
+}

package/dist/interfaces/module-testing-container.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=module-testing-container.interface.js.map

package/dist/interfaces/module-testing-container.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-testing-container.interface.js","sourceRoot":"","sources":["../../src/interfaces/module-testing-container.interface.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@nexus-ioc/testing",
+  "version": "0.4.0",
+  "description": "Testing helpers for Nexus IoC library",
+  "author": "IsqanderM <aleksandr.melnik.personal@gmail.com>",
+  "homepage": "https://github.com/Isqanderm/ioc#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Isqanderm/ioc.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Isqanderm/ioc/issues"
+  },
+  "directories": {
+    "lib": "src",
+    "test": "__test__"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "peerDependencies": {
+    "reflect-metadata": "^0.1.12 || ^0.2.0",
+    "@nexus-ioc/core": "^0.4.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.5.4",
+    "jest": "^29.7.0",
+    "reflect-metadata": "^0.1.12 || ^0.2.0",
+    "sinon": "^18.0.0",
+    "ts-jest": "^29.1.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.3"
+  },
+  "dependencies": {
+    "tslib": "^2.7.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "echo 0",
+    "clean": "rm -rf ./dist && rm tsconfig.tsbuildinfo",
+    "test:watch": "jest --watch",
+    "code:format": "npx @biomejs/biome format --write",
+    "code:lint": "npx @biomejs/biome lint --write",
+    "code:check": "npx @biomejs/biome check",
+    "code:check:ci": "npx @biomejs/biome ci",
+    "code:check:apply": "npx @biomejs/biome check --write",
+    "test:ready": "echo 0"
+  }
+}