refactor(location): nearbyGPSCoordinate options (#1682)

Co-authored-by: ST-DDT <[email protected]>

2 files changed, 142 insertions, 5 deletions

diff --git a/test/__snapshots__/location.spec.ts.snap b/test/__snapshots__/location.spec.ts.snap
index ffe73ffd..5f67809a 100644
--- a/test/__snapshots__/location.spec.ts.snap
+++ b/test/__snapshots__/location.spec.ts.snap
@@ -46,6 +46,48 @@ exports[`location > 42 > nearbyGPSCoordinate > noArgs 1`] = `
 ]
 `;
 
+exports[`location > 42 > nearbyGPSCoordinate > only isMetric 1`] = `
+[
+  -22.5828,
+  106.7555,
+]
+`;
+
+exports[`location > 42 > nearbyGPSCoordinate > only radius 1`] = `
+[
+  -22.5828,
+  106.7555,
+]
+`;
+
+exports[`location > 42 > nearbyGPSCoordinate > with origin and isMetric 1`] = `
+[
+  37.05058762889859,
+  -13.05029562250138,
+]
+`;
+
+exports[`location > 42 > nearbyGPSCoordinate > with origin and radius 1`] = `
+[
+  37.122112668351875,
+  -13.121407798779614,
+]
+`;
+
+exports[`location > 42 > nearbyGPSCoordinate > with origin, radius and isMetric 1`] = `
+[
+  37.075875092904894,
+  -13.075437119965613,
+]
+`;
+
+exports[`location > 42 > nearbyGPSCoordinate > with radius and isMetric 1`] = `
+[
+  -22.5828,
+  106.7555,
+]
+`;
+
 exports[`location > 42 > ordinalDirection > noArgs 1`] = `"Northwest"`;
 
 exports[`location > 42 > ordinalDirection > with abbr = false 1`] = `"Northwest"`;
@@ -124,6 +166,48 @@ exports[`location > 1211 > nearbyGPSCoordinate > noArgs 1`] = `
 ]
 `;
 
+exports[`location > 1211 > nearbyGPSCoordinate > only isMetric 1`] = `
+[
+  77.1337,
+  -14.7545,
+]
+`;
+
+exports[`location > 1211 > nearbyGPSCoordinate > only radius 1`] = `
+[
+  77.1337,
+  -14.7545,
+]
+`;
+
+exports[`location > 1211 > nearbyGPSCoordinate > with origin and isMetric 1`] = `
+[
+  36.98215379643012,
+  -12.962972893442156,
+]
+`;
+
+exports[`location > 1211 > nearbyGPSCoordinate > with origin and radius 1`] = `
+[
+  36.95691638741659,
+  -12.910610595257708,
+]
+`;
+
+exports[`location > 1211 > nearbyGPSCoordinate > with origin, radius and isMetric 1`] = `
+[
+  36.97323069464518,
+  -12.944459340163235,
+]
+`;
+
+exports[`location > 1211 > nearbyGPSCoordinate > with radius and isMetric 1`] = `
+[
+  77.1337,
+  -14.7545,
+]
+`;
+
 exports[`location > 1211 > ordinalDirection > noArgs 1`] = `"Southwest"`;
 
 exports[`location > 1211 > ordinalDirection > with abbr = false 1`] = `"Southwest"`;
@@ -202,6 +286,48 @@ exports[`location > 1337 > nearbyGPSCoordinate > noArgs 1`] = `
 ]
 `;
 
+exports[`location > 1337 > nearbyGPSCoordinate > only isMetric 1`] = `
+[
+  -42.8356,
+  21.7907,
+]
+`;
+
+exports[`location > 1337 > nearbyGPSCoordinate > only radius 1`] = `
+[
+  -42.8356,
+  21.7907,
+]
+`;
+
+exports[`location > 1337 > nearbyGPSCoordinate > with origin and isMetric 1`] = `
+[
+  37.05004958398222,
+  -13.003788641630877,
+]
+`;
+
+exports[`location > 1337 > nearbyGPSCoordinate > with origin and radius 1`] = `
+[
+  37.12082442834317,
+  -13.009146139144832,
+]
+`;
+
+exports[`location > 1337 > nearbyGPSCoordinate > with origin, radius and isMetric 1`] = `
+[
+  37.07507884069983,
+  -13.00568330041608,
+]
+`;
+
+exports[`location > 1337 > nearbyGPSCoordinate > with radius and isMetric 1`] = `
+[
+  -42.8356,
+  21.7907,
+]
+`;
+
 exports[`location > 1337 > ordinalDirection > noArgs 1`] = `"Northwest"`;
 
 exports[`location > 1337 > ordinalDirection > with abbr = false 1`] = `"Northwest"`;
diff --git a/test/location.spec.ts b/test/location.spec.ts
index 567ec148..3a7d958d 100644
--- a/test/location.spec.ts
+++ b/test/location.spec.ts
@@ -72,7 +72,18 @@ describe('location', () => {
     });
 
     t.describe('nearbyGPSCoordinate', (t) => {
-      t.it('noArgs').it('near origin', [0, 0]);
+      t.it('noArgs')
+        .it('near origin', { origin: [0, 0] })
+        .it('with origin and radius', { origin: [37, -13], radius: 15 })
+        .it('with origin, radius and isMetric', {
+          origin: [37, -13],
+          radius: 15,
+          isMetric: true,
+        })
+        .it('with origin and isMetric', { origin: [37, -13], isMetric: true })
+        .it('with radius and isMetric', { radius: 15, isMetric: true })
+        .it('only radius', { radius: 12 })
+        .it('only isMetric', { isMetric: true });
     });
     t.it('state').it('stateAbbr');
 
@@ -286,11 +297,11 @@ describe('location', () => {
               const latitude1 = +faker.location.latitude();
               const longitude1 = +faker.location.longitude();
 
-              const coordinate = faker.location.nearbyGPSCoordinate(
-                [latitude1, longitude1],
+              const coordinate = faker.location.nearbyGPSCoordinate({
+                origin: [latitude1, longitude1],
                 radius,
-                isMetric
-              );
+                isMetric,
+              });
 
               expect(coordinate.length).toBe(2);
               expect(coordinate[0]).toBeTypeOf('number');