feat: 🔥 Combine uniqueComparer and comparisonKeys into config

✅ Closes: #220 feat: 🔥 Combine uniqueComparer and comparisonKeys into config ✅ Closes: #220
ngneat · May 10, 2022 · 2331772 · 2331772
1 parent dbddca3
commit 2331772
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 25 deletions.
diff --git a/packages/falso/src/lib/address.ts b/packages/falso/src/lib/address.ts
@@ -69,7 +69,7 @@ export function randAddress<Options extends AddressOptions = never>(
     return address;
   };
 
-  return fake(factory, options, checkUnique);
+  return fake(factory, options, { uniqueComparer: checkUnique });
 }
 
 const checkUnique: (address: Address, addresses: Address[]) => boolean = (

diff --git a/packages/falso/src/lib/between-date.ts b/packages/falso/src/lib/between-date.ts
@@ -44,5 +44,5 @@ export function randBetweenDate<Options extends BetweenOptions = never>(
     );
   };
 
-  return fake(generator, options, dateIsUnique);
+  return fake(generator, options, { uniqueComparer: dateIsUnique });
 }
diff --git a/packages/falso/src/lib/core/core.ts b/packages/falso/src/lib/core/core.ts
@@ -6,6 +6,15 @@ export interface FakeOptions {
   priority?: 'length' | 'unique';
 }
 
+export interface FakeConfig<T> {
+  uniqueComparer: (
+    item: T,
+    items: T[],
+    comparisonKeys?: string[]
+  ) => boolean | ((item: T, items: T[]) => boolean);
+  comparisonKeys?: string[];
+}
+
 type Return<T, O extends FakeOptions> = [O] extends [never]
   ? T
   : O['length'] extends number
@@ -15,8 +24,9 @@ type Return<T, O extends FakeOptions> = [O] extends [never]
 export function fake<T, Options extends FakeOptions>(
   data: T[] | (() => T),
   options?: Options,
-  uniqueComparer: (item: T, items: T[]) => boolean = primitiveValueIsUnique,
-  comparisonKeys?: string[]
+  config: FakeConfig<T> = {
+    uniqueComparer: primitiveValueIsUnique,
+  }
 ): Return<T, Options> {
   if (options?.length === 0) {
     return [] as any;
@@ -26,17 +36,12 @@ export function fake<T, Options extends FakeOptions>(
     return fakeFromArray(data, options) as any;
   }
 
-  return fakeFromFunction(data, uniqueComparer, comparisonKeys, options) as any;
+  return fakeFromFunction(data, config, options) as any;
 }
 
 export function fakeFromFunction<T, Options extends FakeOptions>(
   data: () => T,
-  isItemADuplicateFunction: (
-    item: T,
-    items: T[],
-    comparisonKeys?: string[]
-  ) => boolean,
-  comparisonKeys?: string[],
+  config: FakeConfig<T>,
   options?: Options
 ): T | T[] {
   if (!options?.length) {
@@ -57,7 +62,7 @@ export function fakeFromFunction<T, Options extends FakeOptions>(
   while (items.length < options.length && attempts < maxAttempts) {
     const item = data();
 
-    if (!isItemADuplicateFunction(item, items, comparisonKeys)) {
+    if (!config.uniqueComparer(item, items, config.comparisonKeys)) {
       items.push(item);
     }
 

diff --git a/packages/falso/src/lib/credit-card.ts b/packages/falso/src/lib/credit-card.ts
@@ -86,7 +86,7 @@ export function randCreditCard<Options extends CreditCardOptions = never>(
     };
   };
 
-  return fake(factory, options, checkUnique);
+  return fake(factory, options, { uniqueComparer: checkUnique });
 }
 
 const checkUnique: (card: CreditCard, cards: CreditCard[]) => boolean = (

diff --git a/packages/falso/src/lib/flight-details.ts b/packages/falso/src/lib/flight-details.ts
@@ -76,7 +76,7 @@ export function randFlightDetails<Options extends FlightDetailsOptions = never>(
     };
   };
 
-  return fake(factory, options, checkUnique);
+  return fake(factory, options, { uniqueComparer: checkUnique });
 }
 
 const checkUnique: (

diff --git a/packages/falso/src/lib/future-date.ts b/packages/falso/src/lib/future-date.ts
@@ -42,5 +42,5 @@ export function randFutureDate<Options extends FutureOptions = never>(
   const to = new Date(from.getTime() + yearsInMilliseconds);
   const factory: () => Date = () => randBetweenDate({ from, to });
 
-  return fake(factory, options, dateIsUnique);
+  return fake(factory, options, { uniqueComparer: dateIsUnique });
 }
diff --git a/packages/falso/src/lib/json.ts b/packages/falso/src/lib/json.ts
@@ -96,7 +96,7 @@ export function randJSON<Options extends RandomJSONOptions = never>(
     return generatedObject;
   };
 
-  return fake(factory, options, checkUnique);
+  return fake(factory, options, { uniqueComparer: checkUnique });
 }
 
 const checkUnique: (item: object, items: object[]) => boolean = (

diff --git a/packages/falso/src/lib/nearby-gpscoordinate.ts b/packages/falso/src/lib/nearby-gpscoordinate.ts
@@ -23,7 +23,9 @@ import { randLongitude } from './longitude';
 export function randNearbyGPSCoordinate<Options extends FakeOptions = never>(
   options?: Options
 ) {
-  return fake(() => [randLatitude(), randLongitude()], options, checkUnique);
+  return fake(() => [randLatitude(), randLongitude()], options, {
+    uniqueComparer: checkUnique,
+  });
 }
 
 const checkUnique: (coordinate: number[], coordinates: number[][]) => boolean =

diff --git a/packages/falso/src/lib/past-date.ts b/packages/falso/src/lib/past-date.ts
@@ -41,5 +41,7 @@ export function randPastDate<Options extends PastOptions = never>(
   const to = new Date();
   const from = new Date(to.getTime() - yearsInMilliseconds);
 
-  return fake(() => randBetweenDate({ from, to }), options, dateIsUnique);
+  return fake(() => randBetweenDate({ from, to }), options, {
+    uniqueComparer: dateIsUnique,
+  });
 }
diff --git a/packages/falso/src/lib/post.ts b/packages/falso/src/lib/post.ts
@@ -50,5 +50,5 @@ export function randPost<Options extends FakeOptions = never>(
     return post;
   };
 
-  return fake(factory, options, objectWithIdIsUnique);
+  return fake(factory, options, { uniqueComparer: objectWithIdIsUnique });
 }
diff --git a/packages/falso/src/lib/product.ts b/packages/falso/src/lib/product.ts
@@ -53,5 +53,5 @@ export function randProduct<Options extends FakeOptions = never>(
     },
   });
 
-  return fake(factory, options, objectWithIdIsUnique);
+  return fake(factory, options, { uniqueComparer: objectWithIdIsUnique });
 }
diff --git a/packages/falso/src/lib/recent-date.ts b/packages/falso/src/lib/recent-date.ts
@@ -41,5 +41,7 @@ export function randRecentDate<Options extends RecentOptions = never>(
   const to = new Date();
   const from = new Date(to.getTime() - daysInMilliseconds);
 
-  return fake(() => randBetweenDate({ from, to }), options, dateIsUnique);
+  return fake(() => randBetweenDate({ from, to }), options, {
+    uniqueComparer: dateIsUnique,
+  });
 }
diff --git a/packages/falso/src/lib/soon-date.ts b/packages/falso/src/lib/soon-date.ts
@@ -40,5 +40,7 @@ export function randSoonDate<Options extends SoonOptions = never>(
   const daysInMilliseconds = days * 24 * 60 * 60 * 1000;
   const from = new Date();
   const to = new Date(from.getTime() + daysInMilliseconds);
-  return fake(() => randBetweenDate({ from, to }), options, dateIsUnique);
+  return fake(() => randBetweenDate({ from, to }), options, {
+    uniqueComparer: dateIsUnique,
+  });
 }
diff --git a/packages/falso/src/lib/superhero.ts b/packages/falso/src/lib/superhero.ts
@@ -55,5 +55,5 @@ export function randSuperhero<Options extends SuperheroOptions = never>(
     };
   };
 
-  return fake(factory, options, objectWithIdIsUnique);
+  return fake(factory, options, { uniqueComparer: objectWithIdIsUnique });
 }
diff --git a/packages/falso/src/lib/todo.ts b/packages/falso/src/lib/todo.ts
@@ -37,5 +37,5 @@ export function randTodo<Options extends FakeOptions = never>(
     completed: randBoolean(),
   });
 
-  return fake(factory, options, objectWithIdIsUnique);
+  return fake(factory, options, { uniqueComparer: objectWithIdIsUnique });
 }
diff --git a/packages/falso/src/lib/user.ts b/packages/falso/src/lib/user.ts
@@ -63,5 +63,5 @@ export function randUser<Options extends FakeOptions = never>(
     return user;
   };
 
-  return fake(factory, options, objectWithIdIsUnique);
+  return fake(factory, options, { uniqueComparer: objectWithIdIsUnique });
 }