Package code and tests

Author: LuisFerLCC

.eslintrc.js

@@ -69,7 +69,7 @@ module.exports = {
 
 	overrides: [
 		{
-			files: ["./.eslintrc.js", "./karma.conf.js", "./src/**/*.ts"],
+			files: ["./.eslintrc.js", "./karma.conf.js", "./src/**/*.ts", "./scripts/**/*.mjs"],
 
 			env: {
 				es6: true,
@@ -173,7 +173,7 @@ module.exports = {
 		},
 
 		{
-			files: ["./.eslintrc.js", "./karma.conf.js"],
+			files: ["*.js", "./scripts/**/*.mjs"],
 
 			env: {
 				es6: true,

README.md

@@ -8,7 +8,7 @@
 
 [![NPM latest version](https://img.shields.io/npm/v/@float-toolkit/angular?label=version&logo=npm)](https://www.npmjs.com/package/@float-toolkit/angular)
 [![NPM downloads](https://img.shields.io/npm/dt/@float-toolkit/angular?logo=npm)](https://www.npmjs.com/package/@float-toolkit/angular)
-[![Tests status](https://img.shields.io/github/workflow/status/float-toolkit/angular/Test%20with%20Karma?label=tests&logo=angular&logoColor=white)](https://github.com/float-toolkit/angular/actions/workflows/testWithKarma.yml)
+[![Tests status](https://img.shields.io/github/actions/workflow/status/float-toolkit/angular/testWithKarma.yml?branch=master&label=tests&logo=angular&logoColor=white)](https://github.com/float-toolkit/angular/actions/workflows/testWithKarma.yml)
 [![Code coverage with Codecov](https://img.shields.io/codecov/c/github/float-toolkit/angular/tests?logo=codecov&logoColor=white)](https://codecov.io/gh/float-toolkit/angular)
 [![Contributor Covenant Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-5e0d73)](https://github.com/float-toolkit/angular/blob/master/.github/CODE_OF_CONDUCT.md)
 

jsconfig.json

@@ -14,7 +14,7 @@
 		"noEmit": false
 	},
 
-	"include": ["./.eslintrc.js", "./karma.conf.js"],
+	"include": ["./.eslintrc.js", "./karma.conf.js", "./scripts/**/*.mjs", "./package.json"],
 	"exclude": [],
 	"references": []
 }

ng-package.json

@@ -3,6 +3,8 @@
 
 	"dest": "./dist/",
 	"lib": {
-		"entryFile": "./src/public-api.ts"
-	}
+		"entryFile": "./src/index.ts"
+	},
+
+	"allowedNonPeerDependencies": ["@float-toolkit/core"]
 }

package-lock.json

@@ -9,7 +9,7 @@
 		"test:ci": "npm run pretest && ng test --browsers=ChromeCI",
 		"test:watch": "npm run pretest && ng test --watch",
 		"pretest": "npm run format",
-		"format": "prettier --write . && ng lint"
+		"format": "node scripts/versionNumbers.mjs && prettier --write . && ng lint"
 	},
 	"repository": {
 		"type": "git",
@@ -66,6 +66,7 @@
 		"typescript": "~4.8.4"
 	},
 	"dependencies": {
+		"@float-toolkit/core": "^2.0.1",
 		"tslib": "^2.4.1"
 	}
 }

package.json

@@ -0,0 +1,12 @@
+import { writeFileSync } from "fs";
+import { join } from "path";
+import { cwd } from "process";
+
+import PackageJSON from "../package.json" assert { type: "json" };
+
+writeFileSync(
+	join(cwd(), "src/versionNumbers.ts"),
+	`// AUTOGENERATED. DO NOT MODIFY.
+
+export const versionNumbers = ${JSON.stringify(PackageJSON.version.split("."))};`
+);

scripts/versionNumbers.mjs

@@ -0,0 +1,11 @@
+import { defaultOptions } from "../__mocks__/defaultOptions";
+import { ft } from "../setup.spec";
+
+describe("inject FloatToolkit", () => {
+	it("should inject with the default options", () => {
+		expect(ft).toBeDefined();
+
+		expect(ft.defaultPrecision).toBe(10);
+		expect(ft.options).toEqual(defaultOptions);
+	});
+});

src/__tests__/FloatToolkit/inject.spec.ts

@@ -0,0 +1,89 @@
+import { defaultOptions } from "../__mocks__/defaultOptions";
+import { ft } from "../setup.spec";
+import { FloatToolkit } from "../../float-toolkit.service";
+
+describe("FloatToolkit.defaultPrecision", () => {
+	it("should return a valid FloatToolkit.Precision value", () => {
+		expect(ft.defaultPrecision).toBe(10);
+	});
+
+	it("should be assignable to a FloatToolkit.Precision value", () => {
+		expect(() => {
+			ft.defaultPrecision = 5;
+		}).not.toThrowError();
+
+		expect(ft.defaultPrecision).toBe(5);
+	});
+});
+
+describe("FloatToolkit.options", () => {
+	it("should return a valid frozen FloatToolkit.Options object", () => {
+		expect(ft.options).toEqual(defaultOptions);
+		expect(Object.isFrozen(ft.options)).toBeTrue();
+	});
+});
+
+describe("FloatToolkit.setOptions()", () => {
+	let prevOptions: Readonly<FloatToolkit.Options>;
+	let returnedOptions: Readonly<FloatToolkit.Options>;
+
+	beforeEach(() => {
+		prevOptions = ft.options;
+
+		returnedOptions = ft.setOptions({
+			forceUseDefaultPrecision: true,
+		});
+	});
+
+	it("should modify the service's options", () => {
+		expect(returnedOptions).toEqual({ ...prevOptions, forceUseDefaultPrecision: true });
+	});
+
+	it("should return a valid frozen FloatToolkit.Options object", () => {
+		expect(Object.isFrozen(returnedOptions)).toBeTrue();
+	});
+
+	it("should reset the output if instructed", () => {
+		const newOptions: FloatToolkit.Options = {
+			forceUseDefaultPrecision: true,
+		};
+
+		ft.add([1]);
+		expect(ft.output).toBe(1);
+
+		ft.setOptions(newOptions, true);
+		expect(ft.output).toBe(0);
+		expect(ft.options).toEqual({ ...returnedOptions, ...newOptions });
+	});
+});
+
+describe("FloatToolkit.resetOptions()", () => {
+	let returnedOptions: Readonly<FloatToolkit.Options>;
+
+	beforeEach(() => {
+		returnedOptions = ft.resetOptions({
+			forceUseDefaultPrecision: true,
+		});
+	});
+
+	it("should reset and modify the FloatToolkit's options", () => {
+		expect(returnedOptions).toEqual({ ...defaultOptions, forceUseDefaultPrecision: true });
+	});
+
+	it("should return a valid frozen FloatToolkit.Options object", () => {
+		expect(Object.isFrozen(returnedOptions)).toBeTrue();
+	});
+
+	it("should reset the output if instructed", () => {
+		const newOptions: FloatToolkit.Options = {
+			forceUseDefaultPrecision: true,
+		};
+
+		ft.add([1]);
+		expect(ft.output).toBe(1);
+
+		ft.resetOptions(newOptions, true);
+		expect(ft.output).toBe(0);
+		expect(ft.options).toEqual({ ...defaultOptions, ...newOptions });
+	});
+});

src/__tests__/FloatToolkit/options.spec.ts

@@ -0,0 +1,25 @@
+import { ft } from "../setup.spec";
+
+describe("FloatToolkit.output", () => {
+	it("should have an initial value of 0", () => {
+		expect(ft.output).toBe(0);
+	});
+
+	it("should be changed by operation methods", () => {
+		function run(callback: () => void, expectedOutput: number): void {
+			callback();
+			expect(ft.output).toBe(expectedOutput);
+		}
+
+		run(() => ft.round(0.1 + 0.2), 0.3);
+		run(() => ft.add([0.1, 0.2]), 0.3);
+		run(() => ft.subtract([0.8, 0.1, 0.3]), 0.4);
+		run(() => ft.multiply([0.1, 0.9]), 0.09);
+		run(() => ft.divide([0.09, 0.9]), 0.1);
+	});
+
+	it("should be reset to 0 when calling FloatToolkit.resetOutput()", () => {
+		ft.resetOutput();
+		expect(ft.output).toBe(0);
+	});
+});