refactor(diff): fix #256 replace DiffMode enum

BREAKING CHANGE: replace DiffMode enum w/ type alias - rename DiffMode.ONLY_DISTANCE_LINEAR_ONLY_CHANGES => "minimal" - update diffObject() mode arg to only allow: "full" or "only-distance"
thi-ng · Dec 22, 2020 · cc77c71 · cc77c71
1 parent 5086a33
commit cc77c71
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 24 deletions.
diff --git a/packages/diff/src/api.ts b/packages/diff/src/api.ts
@@ -1,5 +1,11 @@
 import type { IObjectOf } from "@thi.ng/api";
 
+export type DiffMode =
+    | "only-distance"
+    | "only-distance-linear"
+    | "minimal"
+    | "full";
+
 export type DiffKeyMap<T> = IObjectOf<T>;
 
 export interface ArrayDiff<T> {

diff --git a/packages/diff/src/array.ts b/packages/diff/src/array.ts
@@ -1,7 +1,6 @@
 import type { FnU3, Nullable } from "@thi.ng/api";
 import { equiv as _equiv } from "@thi.ng/equiv";
-import type { ArrayDiff, DiffKeyMap, EditLog } from "./api";
-import { DiffMode } from "./constants";
+import type { ArrayDiff, DiffKeyMap, DiffMode, EditLog } from "./api";
 
 let _cachedFP: Nullable<Int32Array>;
 let _cachedPath: Nullable<Int32Array>;
@@ -34,13 +33,13 @@ const simpleDiff = <T>(
     const n = src.length;
     const linear = <EditLog<Number, T>>state.linear;
     state.distance = n;
-    if (mode !== DiffMode.ONLY_DISTANCE) {
+    if (mode !== "only-distance") {
         for (let i = 0, j = 0; i < n; i++, j += 3) {
             linear[j] = logDir;
             linear[j + 1] = i;
             linear[j + 2] = src[i];
         }
-        if (mode === DiffMode.FULL) {
+        if (mode === "full") {
             const _state = <DiffKeyMap<T>>state[key];
             for (let i = 0; i < n; i++) {
                 _state[i] = src[i];
@@ -70,7 +69,7 @@ const simpleDiff = <T>(
 export const diffArray = <T>(
     a: ArrayLike<T> | undefined | null,
     b: ArrayLike<T> | undefined | null,
-    mode = DiffMode.FULL,
+    mode: DiffMode = "full",
     equiv = _equiv
 ) => {
     const state = <ArrayDiff<T>>{
@@ -145,14 +144,14 @@ export const diffArray = <T>(
 
     state.distance = delta + 2 * p;
 
-    if (mode !== DiffMode.ONLY_DISTANCE) {
+    if (mode !== "only-distance") {
         p = path[doff] * 3;
         while (p >= 0) {
             epc.push(p);
             p = pathPos[p + 2] * 3;
         }
 
-        if (mode === DiffMode.FULL) {
+        if (mode === "full") {
             buildFullLog<T>(epc, pathPos, state, _a, _b, reverse);
         } else {
             buildLinearLog<T>(
@@ -162,7 +161,7 @@ export const diffArray = <T>(
                 _a,
                 _b,
                 reverse,
-                mode === DiffMode.ONLY_DISTANCE_LINEAR
+                mode === "only-distance-linear"
             );
         }
     }

diff --git a/packages/diff/src/constants.ts b/packages/diff/src/constants.ts
diff --git a/packages/diff/src/index.ts b/packages/diff/src/index.ts
@@ -1,4 +1,3 @@
 export * from "./api";
 export * from "./array";
-export * from "./constants";
 export * from "./object";
diff --git a/packages/diff/src/object.ts b/packages/diff/src/object.ts
@@ -1,17 +1,16 @@
 import type { IObjectOf, Predicate2 } from "@thi.ng/api";
 import { equiv } from "@thi.ng/equiv";
 import type { ObjectDiff } from "./api";
-import { DiffMode } from "./constants";
 
 export const diffObject = <T>(
     a: IObjectOf<T> | undefined | null,
     b: IObjectOf<T> | undefined | null,
-    mode = DiffMode.FULL,
+    mode: "full" | "only-distance" = "full",
     _equiv: Predicate2<any> = equiv
 ): ObjectDiff<T> =>
     a === b
         ? { distance: 0 }
-        : mode === DiffMode.ONLY_DISTANCE
+        : mode === "only-distance"
         ? diffObjectDist(a, b, _equiv)
         : diffObjectFull(a, b, _equiv);
 

diff --git a/packages/diff/test/array.ts b/packages/diff/test/array.ts
@@ -1,5 +1,5 @@
 import * as assert from "assert";
-import { ArrayDiff, diffArray, DiffMode } from "../src";
+import { ArrayDiff, diffArray } from "../src";
 
 describe("array", function () {
     const state = <ArrayDiff<number>>{
@@ -70,11 +70,7 @@ describe("array", function () {
 
     it("diff insert 2nd last (changes only)", () => {
         assert.deepStrictEqual(
-            diffArray(
-                [1, 2, 3, 4],
-                [1, 2, 3, 5, 4],
-                DiffMode.ONLY_DISTANCE_LINEAR_ONLY_CHANGES
-            ),
+            diffArray([1, 2, 3, 4], [1, 2, 3, 5, 4], "minimal"),
             <ArrayDiff<number>>{
                 distance: 1,
                 adds: {},