feat(engines): add MT19937 as the DefaultEngine

Also refactor and reorganize src and test files using UpperCamelCase to support sensible class usage. BREAKING CHANGE: complete refactor with a DefaultEngine
grandom-library · Sep 5, 2023 · 0c742f0 · 0c742f0
1 parent def6f3e
commit 0c742f0
Show file tree

Hide file tree

Showing 26 changed files with 69 additions and 29 deletions.
diff --git a/packages/common/engines/package.json b/packages/common/engines/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@grandom/engines",
   "version": "0.0.0-development",
-  "description": "Random number generator engines for the grandom library.",
+  "description": "Various RNG engines for the grandom library.",
   "author": "Richard King <richrdkng@gmail.com> (www.richrdkng.com)",
   "license": "MIT",
   "main": "index.js",

diff --git a/packages/common/engines/src/crypto/index.ts → ...on/engines/src/CrossCryptoEngine/index.ts b/packages/common/engines/src/crypto/index.ts → ...on/engines/src/CrossCryptoEngine/index.ts
@@ -1,8 +1,8 @@
 import { RandomEngine } from '@grandom/core'
 
-export default class CryptoEngine extends RandomEngine {
+export default class CrossCryptoEngine extends RandomEngine {
   constructor () {
-    super('crypto')
+    super('cross-crypto')
 
     if (this._isBrowserEnvironment()) {
       this._next = this._initBrowserCrypto()

diff --git a/packages/common/engines/src/mt19937/index.ts → ...common/engines/src/MT19937Engine/index.ts b/packages/common/engines/src/mt19937/index.ts → ...common/engines/src/MT19937Engine/index.ts
@@ -1,3 +1,5 @@
+// TODO: implement seed types instead of any (e.g.: string, number, number[], string[], etc.)
+
 import { RandomEngine } from '@grandom/core'
 import MT19937 from '@grandom/mt19937'
 import fnv1a from '@grandom/fnv1a'

diff --git a/packages/common/engines/src/basic/index.ts → ...mon/engines/src/MathRandomEngine/index.ts b/packages/common/engines/src/basic/index.ts → ...mon/engines/src/MathRandomEngine/index.ts
@@ -1,8 +1,8 @@
 import { RandomEngine } from '@grandom/core'
 
-export default class BasicEngine extends RandomEngine {
+export default class MathRandomEngine extends RandomEngine {
   constructor () {
-    super('basic')
+    super('math-random')
   }
 
   _next (): number {

diff --git a/packages/common/engines/src/index.ts b/packages/common/engines/src/index.ts
@@ -1,3 +1,7 @@
-export { default as BasicEngine } from './basic'
-export { default as CryptoEngine } from './crypto'
-export { default as SeededEngine } from './mt19937'
+// common engine shorthands
+export { default as BasicEngine } from './MathRandomEngine'
+export { default as SeededEngine } from './MT19937Engine'
+export { default as CryptoEngine } from './CrossCryptoEngine'
+
+// the default engine is a seedable engine
+export { default as DefaultEngine } from './MT19937Engine'
diff --git a/...n/engines/test/crypto/env.browser.test.ts → ...est/CrossCryptoEngine/env.browser.test.ts b/...n/engines/test/crypto/env.browser.test.ts → ...est/CrossCryptoEngine/env.browser.test.ts
@@ -1,5 +1,5 @@
 import crypto from 'node:crypto'
-import CryptoEngine from '../../src/crypto'
+import CryptoEngine from '../../src/CrossCryptoEngine'
 
 describe('CryptoEngine', () => {
   describe('environments', () => {

diff --git a/...engines/test/crypto/env.no-crypto.test.ts → ...t/CrossCryptoEngine/env.no-crypto.test.ts b/...engines/test/crypto/env.no-crypto.test.ts → ...t/CrossCryptoEngine/env.no-crypto.test.ts
@@ -1,4 +1,4 @@
-import CryptoEngine from '../../src/crypto'
+import CryptoEngine from '../../src/CrossCryptoEngine'
 
 describe('CryptoEngine', () => {
   describe('environments', () => {

diff --git a/...n/engines/test/crypto/next-bigint.test.ts → ...est/CrossCryptoEngine/next-bigint.test.ts b/...n/engines/test/crypto/next-bigint.test.ts → ...est/CrossCryptoEngine/next-bigint.test.ts
@@ -3,7 +3,7 @@ import {
   BigIntStats
 } from '@testyard/stats'
 
-import CryptoEngine from '../../src/crypto'
+import CryptoEngine from '../../src/CrossCryptoEngine'
 
 const HALF_LENGTH = LENGTH / 2
 const engine = new CryptoEngine()

diff --git a/.../engines/test/crypto/next-boolean.test.ts → ...st/CrossCryptoEngine/next-boolean.test.ts b/.../engines/test/crypto/next-boolean.test.ts → ...st/CrossCryptoEngine/next-boolean.test.ts
@@ -3,7 +3,7 @@ import {
   BooleanStats
 } from '@testyard/stats'
 
-import CryptoEngine from '../../src/crypto'
+import CryptoEngine from '../../src/CrossCryptoEngine'
 
 const HALF_LENGTH = LENGTH / 2
 const engine = new CryptoEngine()

diff --git a/...on/engines/test/crypto/next-float.test.ts → ...test/CrossCryptoEngine/next-float.test.ts b/...on/engines/test/crypto/next-float.test.ts → ...test/CrossCryptoEngine/next-float.test.ts
@@ -3,7 +3,7 @@ import {
   FloatStats
 } from '@testyard/stats'
 
-import CryptoEngine from '../../src/crypto'
+import CryptoEngine from '../../src/CrossCryptoEngine'
 
 const HALF_LENGTH = LENGTH / 2
 const engine = new CryptoEngine()

diff --git a/.../engines/test/crypto/next-integer.test.ts → ...st/CrossCryptoEngine/next-integer.test.ts b/.../engines/test/crypto/next-integer.test.ts → ...st/CrossCryptoEngine/next-integer.test.ts
@@ -3,7 +3,7 @@ import {
   IntegerStats
 } from '@testyard/stats'
 
-import CryptoEngine from '../../src/crypto'
+import CryptoEngine from '../../src/CrossCryptoEngine'
 
 const HALF_LENGTH = LENGTH / 2
 const engine = new CryptoEngine()

diff --git a/.../engines/test/mt19937/next-bigint.test.ts → ...es/test/MT19937Engine/next-bigint.test.ts b/.../engines/test/mt19937/next-bigint.test.ts → ...es/test/MT19937Engine/next-bigint.test.ts
@@ -3,7 +3,7 @@ import {
   BigIntStats
 } from '@testyard/stats'
 
-import MT19937Engine from '../../src/mt19937'
+import MT19937Engine from '../../src/MT19937Engine'
 
 const engine = new MT19937Engine()
 

diff --git a/...engines/test/mt19937/next-boolean.test.ts → ...s/test/MT19937Engine/next-boolean.test.ts b/...engines/test/mt19937/next-boolean.test.ts → ...s/test/MT19937Engine/next-boolean.test.ts
@@ -3,7 +3,7 @@ import {
   BooleanStats
 } from '@testyard/stats'
 
-import MT19937Engine from '../../src/mt19937'
+import MT19937Engine from '../../src/MT19937Engine'
 
 const engine = new MT19937Engine()
 

diff --git a/...n/engines/test/mt19937/next-float.test.ts → ...nes/test/MT19937Engine/next-float.test.ts b/...n/engines/test/mt19937/next-float.test.ts → ...nes/test/MT19937Engine/next-float.test.ts
@@ -3,7 +3,7 @@ import {
   FloatStats
 } from '@testyard/stats'
 
-import MT19937Engine from '../../src/mt19937'
+import MT19937Engine from '../../src/MT19937Engine'
 
 const engine = new MT19937Engine()
 

diff --git a/...engines/test/mt19937/next-integer.test.ts → ...s/test/MT19937Engine/next-integer.test.ts b/...engines/test/mt19937/next-integer.test.ts → ...s/test/MT19937Engine/next-integer.test.ts
@@ -3,7 +3,7 @@ import {
   IntegerStats
 } from '@testyard/stats'
 
-import MT19937Engine from '../../src/mt19937'
+import MT19937Engine from '../../src/MT19937Engine'
 
 const engine = new MT19937Engine()
 

diff --git a/.../common/engines/test/mt19937/seed.test.ts → ...n/engines/test/MT19937Engine/seed.test.ts b/.../common/engines/test/mt19937/seed.test.ts → ...n/engines/test/MT19937Engine/seed.test.ts
@@ -1,4 +1,4 @@
-import MT19937Engine from '../../src/mt19937'
+import MT19937Engine from '../../src/MT19937Engine'
 
 describe('MT19937Engine', () => {
   describe('set/get seed', () => {

diff --git a/...on/engines/test/basic/next-bigint.test.ts → ...test/MathRandomEngine/next-bigint.test.ts b/...on/engines/test/basic/next-bigint.test.ts → ...test/MathRandomEngine/next-bigint.test.ts
@@ -3,7 +3,7 @@ import {
   BigIntStats
 } from '@testyard/stats'
 
-import BasicEngine from '../../src/basic'
+import BasicEngine from '../../src/MathRandomEngine'
 
 const engine = new BasicEngine()
 

diff --git a/...n/engines/test/basic/next-boolean.test.ts → ...est/MathRandomEngine/next-boolean.test.ts b/...n/engines/test/basic/next-boolean.test.ts → ...est/MathRandomEngine/next-boolean.test.ts
@@ -3,7 +3,7 @@ import {
   BooleanStats
 } from '@testyard/stats'
 
-import BasicEngine from '../../src/basic'
+import BasicEngine from '../../src/MathRandomEngine'
 
 const engine = new BasicEngine()
 

diff --git a/...mon/engines/test/basic/next-float.test.ts → .../test/MathRandomEngine/next-float.test.ts b/...mon/engines/test/basic/next-float.test.ts → .../test/MathRandomEngine/next-float.test.ts
@@ -3,7 +3,7 @@ import {
   FloatStats
 } from '@testyard/stats'
 
-import BasicEngine from '../../src/basic'
+import BasicEngine from '../../src/MathRandomEngine'
 
 const engine = new BasicEngine()
 

diff --git a/...n/engines/test/basic/next-integer.test.ts → ...est/MathRandomEngine/next-integer.test.ts b/...n/engines/test/basic/next-integer.test.ts → ...est/MathRandomEngine/next-integer.test.ts
@@ -3,7 +3,7 @@ import {
   IntegerStats
 } from '@testyard/stats'
 
-import BasicEngine from '../../src/basic'
+import BasicEngine from '../../src/MathRandomEngine'
 
 const engine = new BasicEngine()
 

diff --git a/packages/common/engines/test/index.test.ts b/packages/common/engines/test/index.test.ts
@@ -0,0 +1,32 @@
+import {
+  BasicEngine,
+  SeededEngine,
+  CryptoEngine,
+  DefaultEngine
+} from '../src'
+
+describe('@grandom/engines', () => {
+  test('basic engine', () => {
+    const engine = new BasicEngine()
+
+    expect(engine.name).toBe('math-random')
+  })
+
+  test('seeded engine', () => {
+    const engine = new SeededEngine()
+
+    expect(engine.name).toBe('mt19937')
+  })
+
+  test('crypto engine', () => {
+    const engine = new CryptoEngine()
+
+    expect(engine.name).toBe('cross-crypto')
+  })
+
+  test('default engine', () => {
+    const engine = new DefaultEngine()
+
+    expect(engine.name).toBe('mt19937')
+  })
+})
diff --git a/packages/common/engines/umd/index.basic.ts b/packages/common/engines/umd/index.basic.ts
@@ -1 +1 @@
-export { default } from '../src/basic'
+export { default } from '../src/MathRandomEngine'
diff --git a/packages/common/engines/umd/index.crypto.ts b/packages/common/engines/umd/index.crypto.ts
@@ -1 +1 @@
-export { default } from '../src/crypto'
+export { default } from '../src/CrossCryptoEngine'
diff --git a/packages/common/engines/umd/index.seeded.ts b/packages/common/engines/umd/index.seeded.ts
@@ -1 +1 @@
-export { default } from '../src/mt19937'
+export { default } from '../src/MT19937Engine'
diff --git a/packages/common/engines/umd/index.ts b/packages/common/engines/umd/index.ts
@@ -1,11 +1,13 @@
 import {
   BasicEngine,
   SeededEngine,
-  CryptoEngine
+  CryptoEngine,
+  DefaultEngine
 } from '../src'
 
 export default {
   BasicEngine,
   SeededEngine,
-  CryptoEngine
+  CryptoEngine,
+  DefaultEngine
 }
diff --git a/packages/common/engines/umd/package.json b/packages/common/engines/umd/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@grandom/engines-umd",
   "version": "0.0.0-development",
-  "description": "Various UMD builds of random number generator engines for the grandom library.",
+  "description": "Various UMD builds of RNG engines for the grandom library.",
   "author": "Richard King <richrdkng@gmail.com> (www.richrdkng.com)",
   "repository": {
     "type": "git",