[minor] add Dimensions type

electrovir · Nov 8, 2023 · 390a630 · 390a630
1 parent a344dc7
commit 390a630
Show file tree

Hide file tree

Showing 18 changed files with 495 additions and 676 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "augment-vir",
-    "version": "21.5.1",
+    "version": "21.6.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {

diff --git a/packages/browser-testing/package.json b/packages/browser-testing/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/browser-testing",
-    "version": "21.5.1",
+    "version": "21.6.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -23,8 +23,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^21.5.1",
-        "@augment-vir/testing": "^21.5.1",
+        "@augment-vir/common": "^21.6.0",
+        "@augment-vir/testing": "^21.6.0",
         "@open-wc/testing": "^3.2.2",
         "@types/mocha": "^10.0.3",
         "@web/test-runner-commands": "^0.9.0",

diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/browser",
-    "version": "21.5.1",
+    "version": "21.6.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/browser",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,12 +24,12 @@
         "test:watch": "web-test-runner --color --config configs/web-test-runner.config.mjs --watch"
     },
     "dependencies": {
-        "@augment-vir/common": "^21.5.1",
+        "@augment-vir/common": "^21.6.0",
         "element-vir": "^16.5.2",
         "html-spec-tags": "^1.0.0"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^21.5.1",
+        "@augment-vir/browser-testing": "^21.6.0",
         "@open-wc/testing": "^3.2.2",
         "@types/chai": "^4.3.9",
         "@types/mocha": "^10.0.3",

diff --git a/packages/chai/package.json b/packages/chai/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/chai",
-    "version": "21.5.1",
+    "version": "21.6.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -23,8 +23,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^21.5.1",
-        "@augment-vir/testing": "^21.5.1",
+        "@augment-vir/common": "^21.6.0",
+        "@augment-vir/testing": "^21.6.0",
         "type-fest": "^4.6.0"
     },
     "devDependencies": {

diff --git a/packages/common-tests/package.json b/packages/common-tests/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common-tests",
-    "version": "21.5.1",
+    "version": "21.6.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common-tests",
     "bugs": {
@@ -22,9 +22,9 @@
         "test:types": "tsc --noEmit"
     },
     "devDependencies": {
-        "@augment-vir/chai": "^21.5.1",
-        "@augment-vir/common": "^21.5.1",
-        "@augment-vir/node-js": "^21.5.1",
+        "@augment-vir/chai": "^21.6.0",
+        "@augment-vir/common": "^21.6.0",
+        "@augment-vir/node-js": "^21.6.0",
         "@electrovir/nyc": "^15.1.0-fix0",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
         "@types/chai": "^4.3.9",

diff --git a/packages/common-tests/src/tests/common-number.test.ts b/packages/common-tests/src/tests/common-number.test.ts
@@ -1,38 +1,45 @@
 import {itCases} from '@augment-vir/chai';
-import {addCommasToNumber, clamp, convertIntoNumber, ensureMinAndMax} from '@augment-vir/common';
-import {expect} from 'chai';
+import {
+    Dimensions,
+    addCommasToNumber,
+    clamp,
+    convertIntoNumber,
+    ensureMinAndMax,
+    round,
+    toEnsuredNumber,
+} from '@augment-vir/common';
 import {describe, it} from 'mocha';
 
 describe(clamp.name, () => {
-    it('should successfully clamp downwards', () => {
-        expect(
-            clamp({
-                max: 45,
-                min: 31,
-                value: 150,
-            }),
-        ).to.equal(45);
-    });
-
-    it('should successfully clamp upwards', () => {
-        expect(
-            clamp({
-                max: 45,
-                min: 31,
-                value: 13,
-            }),
-        ).to.equal(31);
-    });
-
-    it("shouldn't change values in the middle", () => {
-        expect(
-            clamp({
-                max: 45,
-                min: 31,
+    itCases(clamp, [
+        {
+            it: 'does not alter a within-range value',
+            input: {
+                max: 50,
+                min: 40,
                 value: 42,
-            }),
-        ).to.equal(42);
-    });
+            },
+            expect: 42,
+        },
+        {
+            it: 'clamps a too high number',
+            input: {
+                max: 50,
+                min: 40,
+                value: 1_000,
+            },
+            expect: 50,
+        },
+        {
+            it: 'clamps a too low number',
+            input: {
+                max: 50,
+                min: 40,
+                value: 20,
+            },
+            expect: 40,
+        },
+    ]);
 });
 
 describe(convertIntoNumber.name, () => {
@@ -183,3 +190,69 @@ describe(ensureMinAndMax.name, () => {
         },
     ]);
 });
+
+describe(toEnsuredNumber.name, () => {
+    itCases(toEnsuredNumber, [
+        {
+            it: 'converts a string to a number',
+            input: '5',
+            expect: 5,
+        },
+        {
+            it: 'errors on invalid number string',
+            input: '5-3',
+            throws: Error,
+        },
+        {
+            it: 'errors on object input',
+            input: {},
+            throws: Error,
+        },
+    ]);
+});
+
+describe(round.name, () => {
+    itCases(round, [
+        {
+            it: 'rounds down with 2 decimals',
+            input: {
+                digits: 2,
+                number: 1.123456,
+            },
+            expect: 1.12,
+        },
+        {
+            it: 'rounds up with 2 decimals',
+            input: {
+                digits: 2,
+                number: 1.125456,
+            },
+            expect: 1.13,
+        },
+        {
+            it: 'rounds up with 3 decimals and a carry',
+            input: {
+                digits: 3,
+                number: 1.129556,
+            },
+            expect: 1.13,
+        },
+        {
+            it: 'rounds up with 0 decimals',
+            input: {
+                digits: 0,
+                number: 1.564123,
+            },
+            expect: 2,
+        },
+    ]);
+});
+
+describe('Dimensions', () => {
+    it('is assignable to from expected object shape', () => {
+        const testDimensions: Dimensions = {
+            width: 0,
+            height: Infinity,
+        };
+    });
+});
diff --git a/packages/common-tests/src/tests/number.test.ts b/packages/common-tests/src/tests/number.test.ts
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "21.5.1",
+    "version": "21.6.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"

diff --git a/packages/common/src/augments/common-number.ts b/packages/common/src/augments/common-number.ts
@@ -32,24 +32,6 @@ export function addCommasToNumber(input: number | string): string {
     ].join('');
 }
 
-export function clamp(
-    /**
-     * This uses a destructured object so that consumers cannot get confused as to which input is
-     * which (which would be easy to do since they're all of the same type).
-     */
-    {
-        value,
-        min,
-        max,
-    }: {
-        value: number;
-        min: number;
-        max: number;
-    },
-): number {
-    return Math.max(Math.min(value, max), min);
-}
-
 export function convertIntoNumber(input: unknown): number {
     if (typeof input === 'number') {
         return input;
@@ -78,3 +60,44 @@ export function ensureMinAndMax({min, max}: {min: number; max: number}): {
         return {min, max};
     }
 }
+
+export function toEnsuredNumber(input: any): number {
+    const numeric = Number(input);
+
+    if (isNaN(numeric)) {
+        throw new Error(`Cannot convert given input to a number: ${input}`);
+    } else {
+        return numeric;
+    }
+}
+/**
+ * If the given value is outside the given min/max bounds, instead of clamping the number (as the
+ * `clamp` function does), this function wraps the value around to the next bound.
+ *
+ * @example
+ *     wrapNumber({min: 0, max: 100, value: 101}) == 0;
+ */
+export function wrapNumber({max, min, value}: {value: number; max: number; min: number}): number {
+    if (value > max) {
+        return min;
+    } else if (value < min) {
+        return max;
+    }
+
+    return value;
+}
+
+export function round(inputs: {number: number; digits: number}): number {
+    const digitFactor = Math.pow(10, inputs.digits);
+    const multiplied = inputs.number * digitFactor;
+
+    return Number((Math.round(multiplied) / digitFactor).toFixed(inputs.digits));
+}
+
+/** Clamp's the given value to within the min and max bounds, inclusive. */
+export function clamp({value, min, max}: {value: number; min: number; max: number}) {
+    return Math.min(Math.max(value, min), max);
+}
+
+/** Standard box dimensions. */
+export type Dimensions = {width: number; height: number};