fix: getRoughCompassDirection regex used "contains" logic rather than…

… exact matching resulting incorrect results
manuelbieh · May 30, 2023 · 955937b · 955937b
1 parent 44b3557
commit 955937b
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 4 deletions.
diff --git a/src/getRoughCompassDirection.test.js b/src/getRoughCompassDirection.test.js
@@ -0,0 +1,40 @@
+import getRoughCompassDirection from './getRoughCompassDirection';
+
+describe('getRoughCompassDirection', () => {
+    describe('when exact compass direction is Northern', () => {
+        it('returns N', () => {
+            ['NNE', 'NE', 'NNW', 'N'].forEach((exactCompassDirection) => {
+                expect(getRoughCompassDirection(exactCompassDirection)).toEqual(
+                    'N'
+                );
+            });
+        });
+    });
+    describe('when exact compass direction is Eastern', () => {
+        it('returns E', () => {
+            ['ENE', 'E', 'ESE', 'SE'].forEach((exactCompassDirection) => {
+                expect(getRoughCompassDirection(exactCompassDirection)).toEqual(
+                    'E'
+                );
+            });
+        });
+    });
+    describe('when exact compass direction is Southern', () => {
+        it('returns S', () => {
+            ['SSE', 'S', 'SSW', 'SW'].forEach((exactCompassDirection) => {
+                expect(getRoughCompassDirection(exactCompassDirection)).toEqual(
+                    'S'
+                );
+            });
+        });
+    });
+    describe('when exact compass direction is Western', () => {
+        it('returns W', () => {
+            ['WSW', 'W', 'WNW', 'NW'].forEach((exactCompassDirection) => {
+                expect(getRoughCompassDirection(exactCompassDirection)).toEqual(
+                    'W'
+                );
+            });
+        });
+    });
+});
diff --git a/src/getRoughCompassDirection.ts b/src/getRoughCompassDirection.ts
@@ -1,19 +1,19 @@
 // Receives an exact compass direction (like WNW) and spits out a very rough
 // and overly simplified direction (N|E|S|W). Use with caution!
 const getRoughCompassDirection = (exact: string) => {
-    if (/^NNE|NE|NNW|N$/.test(exact)) {
+    if (/^(NNE|NE|NNW|N)$/.test(exact)) {
         return 'N';
     }
 
-    if (/^ENE|E|ESE|SE$/.test(exact)) {
+    if (/^(ENE|E|ESE|SE)$/.test(exact)) {
         return 'E';
     }
 
-    if (/^SSE|S|SSW|SW$/.test(exact)) {
+    if (/^(SSE|S|SSW|SW)$/.test(exact)) {
         return 'S';
     }
 
-    if (/^WSW|W|WNW|NW$/.test(exact)) {
+    if (/^(WSW|W|WNW|NW)$/.test(exact)) {
         return 'W';
     }
 };