add a version comparator function

Sergey-Volkonskiy · Aug 25, 2020 · 839a7cd · 839a7cd
1 parent 8f1f011
commit 839a7cd
Show file tree

Hide file tree

Showing 4 changed files with 139 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -6,5 +6,6 @@ export * from './getVersionUpgrade';
 export * from './diffTokenLists';
 export * from './minVersionBump';
 export * from './nextVersion';
+export * from './versionComparator';
 
 export { schema };
diff --git a/src/isVersionUpdate.ts b/src/isVersionUpdate.ts
@@ -1,9 +1,9 @@
-import { getVersionUpgrade, VersionUpgrade } from './getVersionUpgrade';
+import { versionComparator } from './versionComparator';
 import { Version } from './types';
 
 /**
  * Returns true if versionB is an update over versionA
  */
 export function isVersionUpdate(base: Version, update: Version): boolean {
-  return getVersionUpgrade(base, update) !== VersionUpgrade.NONE;
+  return versionComparator(base, update) < 0;
 }
diff --git a/src/versionComparator.ts b/src/versionComparator.ts
@@ -0,0 +1,28 @@
+import { Version } from 'types';
+
+/**
+ * Comparator function that allows sorting version from lowest to highest
+ * @param versionA version A to compare
+ * @param versionB version B to compare
+ * @returns -1 if versionA comes before versionB, 0 if versionA is equal to version B, and 1 if version A comes after version B
+ */
+export function versionComparator(
+  versionA: Version,
+  versionB: Version
+): -1 | 0 | 1 {
+  if (versionA.major < versionB.major) {
+    return -1;
+  } else if (versionA.major > versionB.major) {
+    return 1;
+  } else if (versionA.minor < versionB.minor) {
+    return -1;
+  } else if (versionA.minor > versionB.minor) {
+    return 1;
+  } else if (versionA.patch < versionB.patch) {
+    return -1;
+  } else if (versionA.patch > versionB.patch) {
+    return 1;
+  } else {
+    return 0;
+  }
+}
diff --git a/test/versionComparator.test.ts b/test/versionComparator.test.ts
@@ -0,0 +1,108 @@
+import { versionComparator } from '../src';
+
+describe('#versionComparator', () => {
+  it('major version', () => {
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 0 },
+        { major: 2, minor: 0, patch: 0 }
+      )
+    ).toEqual(-1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 0 },
+        { major: 1, minor: 0, patch: 0 }
+      )
+    ).toEqual(0);
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 0 },
+        { major: 0, minor: 0, patch: 0 }
+      )
+    ).toEqual(1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 1, patch: 0 },
+        { major: 2, minor: 0, patch: 0 }
+      )
+    ).toEqual(-1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 2 },
+        { major: 1, minor: 0, patch: 1 }
+      )
+    ).toEqual(1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 2 },
+        { major: 1, minor: 0, patch: 2 }
+      )
+    ).toEqual(0);
+  });
+
+  it('minor version', () => {
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 0 },
+        { major: 1, minor: 1, patch: 0 }
+      )
+    ).toEqual(-1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 0 },
+        { major: 1, minor: 0, patch: 0 }
+      )
+    ).toEqual(0);
+    expect(
+      versionComparator(
+        { major: 1, minor: 1, patch: 0 },
+        { major: 1, minor: 0, patch: 0 }
+      )
+    ).toEqual(1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 1, patch: 1 },
+        { major: 1, minor: 2, patch: 0 }
+      )
+    ).toEqual(-1);
+  });
+
+  it('patch version', () => {
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 0 },
+        { major: 1, minor: 1, patch: 0 }
+      )
+    ).toEqual(-1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 0, patch: 0 },
+        { major: 1, minor: 0, patch: 0 }
+      )
+    ).toEqual(0);
+    expect(
+      versionComparator(
+        { major: 1, minor: 1, patch: 0 },
+        { major: 1, minor: 0, patch: 0 }
+      )
+    ).toEqual(1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 1, patch: 1 },
+        { major: 1, minor: 2, patch: 0 }
+      )
+    ).toEqual(-1);
+    expect(
+      versionComparator(
+        { major: 1, minor: 1, patch: 1 },
+        { major: 2, minor: 1, patch: 1 }
+      )
+    ).toEqual(-1);
+    expect(
+      versionComparator(
+        { major: 2, minor: 1, patch: 1 },
+        { major: 2, minor: 1, patch: 2 }
+      )
+    ).toEqual(-1);
+  });
+});