Revert "chore: revert changes to do them in separate PR"

This reverts commit 56c7a95.

Author: Shinigami92

src/faker.ts

@@ -1,6 +1,7 @@
 import type { LocaleDefinition } from './definitions';
 import { FakerError } from './errors/faker-error';
-import { MersenneModule } from './internal/mersenne/mersenne';
+import type { Mersenne } from './internal/mersenne/mersenne';
+import mersenne from './internal/mersenne/mersenne';
 import type { KnownLocale } from './locales';
 import { AddressModule } from './modules/address';
 import { AnimalModule } from './modules/animal';
@@ -75,7 +76,7 @@ export class Faker {
   readonly definitions: LocaleDefinition = this.initDefinitions();
 
   /** @internal */
-  private readonly _mersenne: MersenneModule = new MersenneModule();
+  private readonly _mersenne: Mersenne = mersenne();
 
   readonly random: RandomModule = new RandomModule(this);
 
@@ -239,11 +240,7 @@ export class Faker {
   seed(
     seed: number | number[] = Math.ceil(Math.random() * Number.MAX_SAFE_INTEGER)
   ): number | number[] {
-    if (Array.isArray(seed) && seed.length) {
-      this._mersenne.seed_array(seed);
-    } else if (!Array.isArray(seed) && !isNaN(seed)) {
-      this._mersenne.seed(seed);
-    }
+    this._mersenne.seed(seed);
 
     return seed;
   }

src/internal/mersenne/mersenne.ts

@@ -1,81 +1,64 @@
 import { FakerError } from '../../errors/faker-error';
-import Gen from './twister';
+import Twister from './twister';
 
 /**
- * Module to generate seed based random numbers.
+ * Generate seed based random numbers.
  *
  * @internal
  */
-export class MersenneModule {
-  private gen = new Gen();
-
-  constructor() {
-    this.gen.initGenrand(Math.ceil(Math.random() * Number.MAX_SAFE_INTEGER));
-
-    // Bind `this` so namespaced is working correctly
-    for (const name of Object.getOwnPropertyNames(MersenneModule.prototype)) {
-      if (name === 'constructor' || typeof this[name] !== 'function') {
-        continue;
-      }
-      this[name] = this[name].bind(this);
-    }
-  }
-
+export interface Mersenne {
   /**
    * Generates a random number between `[min, max)`.
    *
    * @param max The maximum number. Defaults to `32768`.
    * @param min The minimum number. Defaults to `0`.
-   *
-   * @example
-   * faker.mersenne.rand() // 15515
-   * faker.mersenne.rand(1000, 500) // 578
-   *
-   * @since 5.5.0
    */
-  rand(max = 32768, min = 0): number {
-    if (min > max) {
-      const temp = min;
-      min = max;
-      max = temp;
-    }
-
-    return Math.floor(this.gen.genrandReal2() * (max - min) + min);
-  }
+  next(max?: number, min?: number): number;
 
   /**
    * Sets the seed to use.
    *
-   * @param S The seed to use.
-   * @throws If the seed is not a `number`.
-   *
-   * @since 5.5.0
+   * @param seed The seed to use.
+   * @throws If the seed is not a `number` or `number[]`.
    */
-  seed(S: number): void {
-    if (typeof S !== 'number') {
-      throw new FakerError(
-        `seed(S) must take numeric argument; is ${typeof S}`
-      );
-    }
+  seed(seed: number | number[]): void;
+}
 
-    this.gen.initGenrand(S);
-  }
+/**
+ * Generate seed based random numbers.
+ *
+ * @internal
+ */
+export default function mersenne(): Mersenne {
+  const twister = new Twister();
+
+  twister.initGenrand(Math.ceil(Math.random() * Number.MAX_SAFE_INTEGER));
+
+  return {
+    next(max = 32768, min = 0): number {
+      if (min > max) {
+        const temp = min;
+        min = max;
+        max = temp;
+      }
+
+      return Math.floor(twister.genrandReal2() * (max - min) + min);
+    },
+
+    seed(seed: number | number[]): void {
+      if (typeof seed === 'number') {
+        twister.initGenrand(seed);
+        return;
+      }
+
+      if (Array.isArray(seed)) {
+        twister.initByArray(seed, seed.length);
+        return;
+      }
 
-  /**
-   * Sets the seed to use.
-   *
-   * @param A The seed to use.
-   * @throws If the seed is not a `number[]`.
-   *
-   * @since 5.5.0
-   */
-  seed_array(A: number[]): void {
-    if (typeof A !== 'object') {
       throw new FakerError(
-        `seed_array(A) must take array of numbers; is ${typeof A}`
+        `seed must take numeric argument(s); is ${typeof seed}`
       );
-    }
-
-    this.gen.initByArray(A, A.length);
-  }
+    },
+  };
 }

src/modules/datatype/index.ts

@@ -1,5 +1,6 @@
 import type { Faker } from '../..';
 import { FakerError } from '../../errors/faker-error';
+import type { Mersenne } from '../../internal/mersenne/mersenne';
 
 /**
  * Module to generate various primitive values and data types.
@@ -59,7 +60,7 @@ export class DatatypeModule {
       this.faker._mersenne;
 
     const randomNumber = Math.floor(
-      mersenne.rand(max / precision + 1, min / precision)
+      mersenne.next(max / precision + 1, min / precision)
     );
 
     // Workaround problem in float point arithmetics for e.g. 6681493 / 0.01

test/__snapshots__/mersenne.spec.ts.snap

@@ -1,49 +1,49 @@
 // Vitest Snapshot v1
 
-exports[`mersenne twister > seed: [42,1,2] > rand() 1`] = `28056`;
+exports[`mersenne twister > seed: [42,1,2] > next() 1`] = `28056`;
 
-exports[`mersenne twister > seed: [42,1,2] > should return deterministic values for rand(100, 0) 1`] = `85`;
+exports[`mersenne twister > seed: [42,1,2] > should return deterministic values for next(100, 0) 1`] = `85`;
 
-exports[`mersenne twister > seed: [42,1,2] > should return deterministic values for rand(100, undefined) 1`] = `85`;
+exports[`mersenne twister > seed: [42,1,2] > should return deterministic values for next(100, undefined) 1`] = `85`;
 
-exports[`mersenne twister > seed: [42,1,2] > should return deterministic values for rand(undefined, 0) 1`] = `28056`;
+exports[`mersenne twister > seed: [42,1,2] > should return deterministic values for next(undefined, 0) 1`] = `28056`;
 
-exports[`mersenne twister > seed: [1211,1,2] > rand() 1`] = `29217`;
+exports[`mersenne twister > seed: [1211,1,2] > next() 1`] = `29217`;
 
-exports[`mersenne twister > seed: [1211,1,2] > should return deterministic values for rand(100, 0) 1`] = `89`;
+exports[`mersenne twister > seed: [1211,1,2] > should return deterministic values for next(100, 0) 1`] = `89`;
 
-exports[`mersenne twister > seed: [1211,1,2] > should return deterministic values for rand(100, undefined) 1`] = `89`;
+exports[`mersenne twister > seed: [1211,1,2] > should return deterministic values for next(100, undefined) 1`] = `89`;
 
-exports[`mersenne twister > seed: [1211,1,2] > should return deterministic values for rand(undefined, 0) 1`] = `29217`;
+exports[`mersenne twister > seed: [1211,1,2] > should return deterministic values for next(undefined, 0) 1`] = `29217`;
 
-exports[`mersenne twister > seed: [1337,1,2] > rand() 1`] = `5895`;
+exports[`mersenne twister > seed: [1337,1,2] > next() 1`] = `5895`;
 
-exports[`mersenne twister > seed: [1337,1,2] > should return deterministic values for rand(100, 0) 1`] = `17`;
+exports[`mersenne twister > seed: [1337,1,2] > should return deterministic values for next(100, 0) 1`] = `17`;
 
-exports[`mersenne twister > seed: [1337,1,2] > should return deterministic values for rand(100, undefined) 1`] = `17`;
+exports[`mersenne twister > seed: [1337,1,2] > should return deterministic values for next(100, undefined) 1`] = `17`;
 
-exports[`mersenne twister > seed: [1337,1,2] > should return deterministic values for rand(undefined, 0) 1`] = `5895`;
+exports[`mersenne twister > seed: [1337,1,2] > should return deterministic values for next(undefined, 0) 1`] = `5895`;
 
-exports[`mersenne twister > seed: 42 > rand() 1`] = `12272`;
+exports[`mersenne twister > seed: 42 > next() 1`] = `12272`;
 
-exports[`mersenne twister > seed: 42 > should return deterministic values for rand(100, 0) 1`] = `37`;
+exports[`mersenne twister > seed: 42 > should return deterministic values for next(100, 0) 1`] = `37`;
 
-exports[`mersenne twister > seed: 42 > should return deterministic values for rand(100, undefined) 1`] = `37`;
+exports[`mersenne twister > seed: 42 > should return deterministic values for next(100, undefined) 1`] = `37`;
 
-exports[`mersenne twister > seed: 42 > should return deterministic values for rand(undefined, 0) 1`] = `12272`;
+exports[`mersenne twister > seed: 42 > should return deterministic values for next(undefined, 0) 1`] = `12272`;
 
-exports[`mersenne twister > seed: 1211 > rand() 1`] = `30425`;
+exports[`mersenne twister > seed: 1211 > next() 1`] = `30425`;
 
-exports[`mersenne twister > seed: 1211 > should return deterministic values for rand(100, 0) 1`] = `92`;
+exports[`mersenne twister > seed: 1211 > should return deterministic values for next(100, 0) 1`] = `92`;
 
-exports[`mersenne twister > seed: 1211 > should return deterministic values for rand(100, undefined) 1`] = `92`;
+exports[`mersenne twister > seed: 1211 > should return deterministic values for next(100, undefined) 1`] = `92`;
 
-exports[`mersenne twister > seed: 1211 > should return deterministic values for rand(undefined, 0) 1`] = `30425`;
+exports[`mersenne twister > seed: 1211 > should return deterministic values for next(undefined, 0) 1`] = `30425`;
 
-exports[`mersenne twister > seed: 1337 > rand() 1`] = `8586`;
+exports[`mersenne twister > seed: 1337 > next() 1`] = `8586`;
 
-exports[`mersenne twister > seed: 1337 > should return deterministic values for rand(100, 0) 1`] = `26`;
+exports[`mersenne twister > seed: 1337 > should return deterministic values for next(100, 0) 1`] = `26`;
 
-exports[`mersenne twister > seed: 1337 > should return deterministic values for rand(100, undefined) 1`] = `26`;
+exports[`mersenne twister > seed: 1337 > should return deterministic values for next(100, undefined) 1`] = `26`;
 
-exports[`mersenne twister > seed: 1337 > should return deterministic values for rand(undefined, 0) 1`] = `8586`;
+exports[`mersenne twister > seed: 1337 > should return deterministic values for next(undefined, 0) 1`] = `8586`;

test/mersenne.spec.ts

@@ -1,6 +1,7 @@
 import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
 import { FakerError } from '../src/errors/faker-error';
-import { MersenneModule } from '../src/internal/mersenne/mersenne';
+import type { Mersenne } from '../src/internal/mersenne/mersenne';
+import mersenneFn from '../src/internal/mersenne/mersenne';
 import { seededRuns } from './support/seededRuns';
 
 const minMaxTestCases = [
@@ -9,25 +10,21 @@ const minMaxTestCases = [
   { max: 100, min: undefined },
 ];
 
-const functionNames = ['rand'];
+const functionNames = ['next'];
 
 const NON_SEEDED_BASED_RUN = 25;
 
 describe('mersenne twister', () => {
-  let mersenne: MersenneModule;
+  let mersenne: Mersenne;
 
   beforeEach(() => {
-    mersenne = new MersenneModule();
+    mersenne = mersenneFn();
   });
 
   for (const seed of [...seededRuns, [42, 1, 2], [1337, 1, 2], [1211, 1, 2]]) {
     describe(`seed: ${JSON.stringify(seed)}`, () => {
       beforeEach(() => {
-        if (Array.isArray(seed)) {
-          mersenne.seed_array(seed);
-        } else {
-          mersenne.seed(seed);
-        }
+        mersenne.seed(seed);
       });
 
       for (const functionName of functionNames) {
@@ -39,15 +36,15 @@ describe('mersenne twister', () => {
       }
 
       for (const { min, max } of minMaxTestCases) {
-        it(`should return deterministic values for rand(${max}, ${min})`, () => {
-          const actual = mersenne.rand(max, min);
+        it(`should return deterministic values for next(${max}, ${min})`, () => {
+          const actual = mersenne.next(max, min);
 
           expect(actual).toMatchSnapshot();
         });
       }
 
-      it.todo(`should return 0 for rand(1)`, () => {
-        const actual = mersenne.rand(1);
+      it.todo(`should return 0 for next(1)`, () => {
+        const actual = mersenne.next(1);
 
         expect(actual).toEqual(0);
       });
@@ -66,22 +63,18 @@ describe('mersenne twister', () => {
   for (const seed of seeds) {
     describe(`random seeded tests ${JSON.stringify(seed)}`, () => {
       beforeAll(() => {
-        if (Array.isArray(seed)) {
-          mersenne.seed_array(seed);
-        } else {
-          mersenne.seed(seed);
-        }
+        mersenne.seed(seed);
       });
 
       for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) {
-        describe('rand', () => {
+        describe('next', () => {
           it('should return a random number without given min / max arguments', () => {
-            const randomNumber = mersenne.rand();
+            const randomNumber = mersenne.next();
             expect(randomNumber).toBeTypeOf('number');
           });
 
           it('should return random number from interval [min, max)', () => {
-            const actual = mersenne.rand(0, 2);
+            const actual = mersenne.next(0, 2);
 
             expect(actual).toBeGreaterThanOrEqual(0);
             expect(actual).toBeLessThan(2);
@@ -98,18 +91,18 @@ describe('mersenne twister', () => {
         'abc'
       )
     ).toThrowError(
-      new FakerError('seed(S) must take numeric argument; is string')
+      new FakerError('seed must take numeric argument(s); is string')
     );
   });
 
   it('should throw an error when attempting to seed() a non-integer', () => {
     expect(() =>
-      mersenne.seed_array(
+      mersenne.seed(
         // @ts-expect-error: non-integer error
         'abc'
       )
     ).toThrowError(
-      new FakerError('seed_array(A) must take array of numbers; is string')
+      new FakerError('seed must take numeric argument(s); is string')
     );
   });
 });