refactor(unique): move to helpers (#1298)

3 files changed, 186 insertions, 81 deletions

diff --git a/test/__snapshots__/helpers.spec.ts.snap b/test/__snapshots__/helpers.spec.ts.snap
index c79f19c8..0fa011fa 100644
--- a/test/__snapshots__/helpers.spec.ts.snap
+++ b/test/__snapshots__/helpers.spec.ts.snap
@@ -98,6 +98,14 @@ exports[`helpers > 42 > slugify > noArgs 1`] = `""`;
 
 exports[`helpers > 42 > slugify > some string 1`] = `"hello-world"`;
 
+exports[`helpers > 42 > unique > with () => number 1`] = `37454`;
+
+exports[`helpers > 42 > unique > with () => number and args 1`] = `19`;
+
+exports[`helpers > 42 > unique > with customMethod 1`] = `"Test-188"`;
+
+exports[`helpers > 42 > unique > with customMethod and args 1`] = `"prefix-1-Test-188"`;
+
 exports[`helpers > 42 > uniqueArray > with array 1`] = `
 [
   "H",
@@ -212,6 +220,14 @@ exports[`helpers > 1211 > slugify > noArgs 1`] = `""`;
 
 exports[`helpers > 1211 > slugify > some string 1`] = `"hello-world"`;
 
+exports[`helpers > 1211 > unique > with () => number 1`] = `92852`;
+
+exports[`helpers > 1211 > unique > with () => number and args 1`] = `47`;
+
+exports[`helpers > 1211 > unique > with customMethod 1`] = `"Test-465"`;
+
+exports[`helpers > 1211 > unique > with customMethod and args 1`] = `"prefix-1-Test-465"`;
+
 exports[`helpers > 1211 > uniqueArray > with array 1`] = `
 [
   "W",
@@ -316,6 +332,14 @@ exports[`helpers > 1337 > slugify > noArgs 1`] = `""`;
 
 exports[`helpers > 1337 > slugify > some string 1`] = `"hello-world"`;
 
+exports[`helpers > 1337 > unique > with () => number 1`] = `26202`;
+
+exports[`helpers > 1337 > unique > with () => number and args 1`] = `13`;
+
+exports[`helpers > 1337 > unique > with customMethod 1`] = `"Test-132"`;
+
+exports[`helpers > 1337 > unique > with customMethod and args 1`] = `"prefix-1-Test-132"`;
+
 exports[`helpers > 1337 > uniqueArray > with array 1`] = `
 [
   "o",
diff --git a/test/helpers.spec.ts b/test/helpers.spec.ts
index 61d742a7..ce8fb733 100644
--- a/test/helpers.spec.ts
+++ b/test/helpers.spec.ts
@@ -5,6 +5,13 @@ import { seededTests } from './support/seededRuns';
 
 const NON_SEEDED_BASED_RUN = 5;
 
+function customUniqueMethod(prefix: string = ''): string {
+  const element = faker.helpers.arrayElement(
+    Array.from({ length: 500 }, (_, index) => `Test-${index + 1}`)
+  );
+  return `${prefix}${element}`;
+}
+
 describe('helpers', () => {
   afterEach(() => {
     faker.locale = 'en';
@@ -93,6 +100,13 @@ describe('helpers', () => {
         'my string: {{datatype.string}}'
       );
     });
+
+    t.describe('unique', (t) => {
+      t.it('with customMethod', customUniqueMethod)
+        .it('with customMethod and args', customUniqueMethod, ['prefix-1-'])
+        .it('with () => number', faker.datatype.number)
+        .it('with () => number and args', faker.datatype.number, [50]);
+    });
   });
 
   describe(`random seeded tests for seed ${faker.seed()}`, () => {
@@ -608,6 +622,151 @@ describe('helpers', () => {
           delete (faker.random as any).special;
         });
       });
+
+      describe('unique()', () => {
+        it('should be possible to call a function with no arguments and return a result', () => {
+          const result = faker.helpers.unique(faker.internet.email);
+          expect(result).toBeTypeOf('string');
+        });
+
+        it('should be possible to call a function with arguments and return a result', () => {
+          const result = faker.helpers.unique(faker.internet.email, [
+            'fName',
+            'lName',
+            'domain',
+          ]); // third argument is provider, or domain for email
+          expect(result).toMatch(/\@domain/);
+        });
+
+        it('should be possible to limit unique call by maxTime in ms', () => {
+          expect(() => {
+            faker.helpers.unique(faker.internet.protocol, [], {
+              maxTime: 1,
+              maxRetries: 9999,
+              exclude: ['https', 'http'],
+            });
+          }).toThrowError(
+            new FakerError(`Exceeded maxTime: 1 for uniqueness check.
+
+May not be able to generate any more unique values with current settings.
+Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`)
+          );
+        });
+
+        it('should be possible to limit unique call by maxRetries', () => {
+          expect(() => {
+            faker.helpers.unique(faker.internet.protocol, [], {
+              maxTime: 5000,
+              maxRetries: 5,
+              exclude: ['https', 'http'],
+            });
+          }).toThrowError(
+            new FakerError(`Exceeded maxRetries: 5 for uniqueness check.
+
+May not be able to generate any more unique values with current settings.
+Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`)
+          );
+        });
+
+        it('should throw a FakerError instance on error', () => {
+          expect(() => {
+            faker.helpers.unique(faker.internet.protocol, [], {
+              maxTime: 5000,
+              maxRetries: 5,
+              exclude: ['https', 'http'],
+            });
+          }).toThrowError(
+            new FakerError(`Exceeded maxRetries: 5 for uniqueness check.
+
+May not be able to generate any more unique values with current settings.
+Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`)
+          );
+        });
+      });
     }
+
+    // This test can be only executed once, because the unique function has a global state.
+    // See: https://github.com/faker-js/faker/issues/371
+    describe('global unique()', () => {
+      it('should be possible to exclude results as array', () => {
+        const internetProtocol = () =>
+          faker.helpers.arrayElement(['https', 'http']);
+        const result = faker.helpers.unique(internetProtocol, [], {
+          exclude: ['https'],
+        });
+        expect(result).toBe('http');
+      });
+
+      it('no conflict', () => {
+        let i = 0;
+        const method = () => `no conflict: ${i++}`;
+        expect(faker.helpers.unique(method)).toBe('no conflict: 0');
+        expect(faker.helpers.unique(method)).toBe('no conflict: 1');
+      });
+
+      it('with conflict', () => {
+        const method = () => 'with conflict: 0';
+        expect(faker.helpers.unique(method)).toBe('with conflict: 0');
+        expect(() =>
+          faker.helpers.unique(method, [], {
+            maxRetries: 1,
+          })
+        ).toThrowError(
+          new FakerError(`Exceeded maxRetries: 1 for uniqueness check.
+
+May not be able to generate any more unique values with current settings.
+Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`)
+        );
+      });
+
+      it('should not mutate most of the input option properties', () => {
+        const method = () => 'options-mutate-test';
+
+        const startTime = new Date().getTime();
+        const maxTime = 49;
+        const maxRetries = 49;
+        const currentIterations = 0;
+        const exclude = [];
+        const compare = (obj, key) => (obj[key] === undefined ? -1 : 0);
+
+        const options = {
+          startTime,
+          maxTime,
+          maxRetries,
+          currentIterations,
+          exclude,
+          compare,
+        };
+
+        faker.helpers.unique(method, [], options);
+
+        expect(options.startTime).toBe(startTime);
+        expect(options.maxTime).toBe(maxTime);
+        expect(options.maxRetries).toBe(maxRetries);
+        // `options.currentIterations` is incremented in the `faker.helpers.unique` function.
+        expect(options.exclude).toBe(exclude);
+        expect(options.compare).toBe(compare);
+      });
+
+      it('should be possible to pass a user-specific store', () => {
+        const store = {};
+
+        const method = () => 'with conflict: 0';
+
+        expect(faker.helpers.unique(method, [], { store })).toBe(
+          'with conflict: 0'
+        );
+        expect(store).toEqual({ 'with conflict: 0': 'with conflict: 0' });
+
+        expect(() => faker.helpers.unique(method, [], { store })).toThrow();
+
+        delete store['with conflict: 0'];
+
+        expect(faker.helpers.unique(method, [], { store })).toBe(
+          'with conflict: 0'
+        );
+        expect(store).toEqual({ 'with conflict: 0': 'with conflict: 0' });
+      });
+    });
   });
 });
diff --git a/test/unique.spec.ts b/test/unique.spec.ts
index 9644cd67..e603939d 100644
--- a/test/unique.spec.ts
+++ b/test/unique.spec.ts
@@ -86,7 +86,7 @@ describe('unique', () => {
             new FakerError(`Exceeded maxTime: 1 for uniqueness check.
 
 May not be able to generate any more unique values with current settings.
-Try adjusting maxTime or maxRetries parameters for faker.unique().`)
+Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`)
           );
         });
 
@@ -101,7 +101,7 @@ Try adjusting maxTime or maxRetries parameters for faker.unique().`)
             new FakerError(`Exceeded maxRetries: 5 for uniqueness check.
 
 May not be able to generate any more unique values with current settings.
-Try adjusting maxTime or maxRetries parameters for faker.unique().`)
+Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`)
           );
         });
 
@@ -116,88 +116,10 @@ Try adjusting maxTime or maxRetries parameters for faker.unique().`)
             new FakerError(`Exceeded maxRetries: 5 for uniqueness check.
 
 May not be able to generate any more unique values with current settings.
-Try adjusting maxTime or maxRetries parameters for faker.unique().`)
+Try adjusting maxTime or maxRetries parameters for faker.helpers.unique().`)
           );
         });
       });
     }
   });
-
-  // This test can be only executed once, because the unique function has a global state.
-  // See: https://github.com/faker-js/faker/issues/371
-  it('should be possible to exclude results as array', () => {
-    const internetProtocol = () =>
-      faker.helpers.arrayElement(['https', 'http']);
-    const result = faker.unique(internetProtocol, [], {
-      exclude: ['https'],
-    });
-    expect(result).toBe('http');
-  });
-
-  it('no conflict', () => {
-    let i = 0;
-    const method = () => `no conflict: ${i++}`;
-    expect(faker.unique(method)).toBe('no conflict: 0');
-    expect(faker.unique(method)).toBe('no conflict: 1');
-  });
-
-  it('with conflict', () => {
-    const method = () => 'with conflict: 0';
-    expect(faker.unique(method)).toBe('with conflict: 0');
-    expect(() =>
-      faker.unique(method, [], {
-        maxRetries: 1,
-      })
-    ).toThrowError(
-      new FakerError(`Exceeded maxRetries: 1 for uniqueness check.
-
-May not be able to generate any more unique values with current settings.
-Try adjusting maxTime or maxRetries parameters for faker.unique().`)
-    );
-  });
-
-  it('should not mutate most of the input option properties', () => {
-    const method = () => 'options-mutate-test';
-
-    const startTime = new Date().getTime();
-    const maxTime = 49;
-    const maxRetries = 49;
-    const currentIterations = 0;
-    const exclude = [];
-    const compare = (obj, key) => (obj[key] === undefined ? -1 : 0);
-
-    const options = {
-      startTime,
-      maxTime,
-      maxRetries,
-      currentIterations,
-      exclude,
-      compare,
-    };
-
-    faker.unique(method, [], options);
-
-    expect(options.startTime).toBe(startTime);
-    expect(options.maxTime).toBe(maxTime);
-    expect(options.maxRetries).toBe(maxRetries);
-    // `options.currentIterations` is incremented in the `faker.unique` function.
-    expect(options.exclude).toBe(exclude);
-    expect(options.compare).toBe(compare);
-  });
-
-  it('should be possible to pass a user-specific store', () => {
-    const store = {};
-
-    const method = () => 'with conflict: 0';
-
-    expect(faker.unique(method, [], { store })).toBe('with conflict: 0');
-    expect(store).toEqual({ 'with conflict: 0': 'with conflict: 0' });
-
-    expect(() => faker.unique(method, [], { store })).toThrow();
-
-    delete store['with conflict: 0'];
-
-    expect(faker.unique(method, [], { store })).toBe('with conflict: 0');
-    expect(store).toEqual({ 'with conflict: 0': 'with conflict: 0' });
-  });
 });