feat: move to helpers

faker-js · Apr 26, 2022 · 349136c · 349136c
1 parent f3dab67
commit 349136c
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 56 deletions.
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -691,4 +691,27 @@ export class Helpers {
       account: this.faker.finance.account(),
     };
   }
+
+  /**
+   * Returns the result of the callback if the probability check was successful, otherwise `undefined`.
+   *
+   * @param callback The callback to that will be invoked if the probability check was successful.
+   * @param options The options to use. Defaults to `{}`.
+   * @param options.probability The probability (`[0.00, 1.00]`) of the callback being invoked. Defaults to `0.5`.
+   *
+   * @example
+   * faker.random.maybe(() => 'Hello World!') // 'Hello World!'
+   * faker.random.maybe(() => 'Hello World!', { probability: 0.1 }) // undefined
+   * faker.random.maybe(() => 'Hello World!', { probability: 0.9 }) // 'Hello World!'
+   */
+  maybe<T>(
+    callback: () => T,
+    options: { probability?: number } = {}
+  ): T | undefined {
+    const { probability = 0.5 } = options;
+    if (this.faker.datatype.float({ min: 0, max: 1 }) < probability) {
+      return callback();
+    }
+    return undefined;
+  }
 }
diff --git a/src/random.ts b/src/random.ts
@@ -608,27 +608,4 @@ export class Random {
 
     return this.faker.datatype.hexadecimal(count);
   }
-
-  /**
-   * Returns the result of the callback if the probability check was successful, otherwise `undefined`.
-   *
-   * @param callback The callback to that will be invoked if the probability check was successful.
-   * @param options The options to use. Defaults to `{}`.
-   * @param options.probability The probability (`[0.00, 1.00]`) of the callback being invoked. Defaults to `0.5`.
-   *
-   * @example
-   * faker.random.maybe(() => 'Hello World!') // 'Hello World!'
-   * faker.random.maybe(() => 'Hello World!', { probability: 0.1 }) // undefined
-   * faker.random.maybe(() => 'Hello World!', { probability: 0.9 }) // 'Hello World!'
-   */
-  maybe<T>(
-    callback: () => T,
-    options: { probability?: number } = {}
-  ): T | undefined {
-    const { probability = 0.5 } = options;
-    if (this.faker.datatype.float({ min: 0, max: 1 }) < probability) {
-      return callback();
-    }
-    return undefined;
-  }
 }
diff --git a/test/all_functional.spec.ts b/test/all_functional.spec.ts
@@ -34,9 +34,6 @@ const BROKEN_LOCALE_METHODS = {
     prefix: ['az', 'id_ID', 'ru'],
     suffix: ['az', 'it', 'mk', 'pt_PT', 'ru'],
   },
-  random: {
-    maybe: [...Object.keys(faker.locales)],
-  },
 };
 
 function isWorkingLocaleForMethod(
@@ -107,12 +104,6 @@ describe('faker.fake functional tests', () => {
       Object.keys(modules).forEach((module) => {
         describe(module, () => {
           modules[module].forEach((meth) => {
-            // Skip `faker.random.maybe()` because the first param is a callback and not supported by `fake`
-            if (module === 'random' && meth === 'maybe') {
-              it.skip('maybe()');
-              return;
-            }
-
             it(`${meth}()`, () => {
               faker.locale = locale;
               // TODO ST-DDT 2022-03-28: Use random seed once there are no more failures

diff --git a/test/helpers.spec.ts b/test/helpers.spec.ts
@@ -786,6 +786,7 @@ describe('helpers', () => {
           expect(card).toBeTypeOf('object');
         });
       });
+
       describe('userCard()', () => {
         it('returns an object', () => {
           const card = faker.helpers.userCard();
@@ -806,6 +807,30 @@ describe('helpers', () => {
         });
       });
 
+      describe('maybe', () => {
+        it('should always return the callback result when probability is 1', () => {
+          const actual = faker.helpers.maybe(() => 'foo', { probability: 1 });
+
+          expect(actual).toBe('foo');
+        });
+
+        it('should never return the callback result when probability is 0', () => {
+          const actual = faker.helpers.maybe(() => expect.fail(), {
+            probability: 0,
+          });
+
+          expect(actual).toBeUndefined();
+        });
+
+        it('should not mutate the input object', () => {
+          const input = Object.freeze({
+            probability: 0.4,
+          });
+
+          expect(() => faker.helpers.maybe(() => 'foo', input)).not.toThrow();
+        });
+      });
+
       describe('deprecation warnings', () => {
         it.each([['randomize', 'random.arrayElement']])(
           'should warn user that function helpers.%s is deprecated',
@@ -823,6 +848,7 @@ describe('helpers', () => {
       });
     }
   });
+
   describe('deprecation warnings', () => {
     it.each(['createCard', 'contextualCard', 'userCard'])(
       'should warn user that function random.%s is deprecated',

diff --git a/test/random.spec.ts b/test/random.spec.ts
@@ -483,30 +483,6 @@ describe('random', () => {
         });
       });
 
-      describe('maybe', () => {
-        it('should always return the callback result when probability is 1', () => {
-          const actual = faker.random.maybe(() => 'foo', { probability: 1 });
-
-          expect(actual).toBe('foo');
-        });
-
-        it('should never return the callback result when probability is 0', () => {
-          const actual = faker.random.maybe(() => expect.fail(), {
-            probability: 0,
-          });
-
-          expect(actual).toBeUndefined();
-        });
-
-        it('should not mutate the input object', () => {
-          const input = Object.freeze({
-            probability: 0.4,
-          });
-
-          expect(() => faker.random.maybe(() => 'foo', input)).not.toThrow();
-        });
-      });
-
       describe('deprecation warnings', () => {
         it.each([
           ['number', 'datatype.number'],