@neurodevs/meta-node 0.5.0 → 0.6.1

package/src/modules/ImplAutomodule.ts

@@ -1,22 +1,33 @@
-import { writeFile } from 'fs/promises'
+import { readFile, writeFile } from 'fs/promises'
 import path from 'path'
 import pathExists from './pathExists'
 
 export default class ImplAutomodule implements Automodule {
     public static Class?: AutomoduleConstructor
     public static pathExists = pathExists
+    public static readFile = readFile
     public static writeFile = writeFile
 
     private testSaveDir: string
     private moduleSaveDir: string
+    private fakeSaveDir: string
     private interfaceName: string
     private implName: string
 
+    private originalIndexFile!: string
+
     protected constructor(options: AutomoduleOptions) {
-        const { testSaveDir, moduleSaveDir, interfaceName, implName } = options
+        const {
+            testSaveDir,
+            moduleSaveDir,
+            fakeSaveDir,
+            interfaceName,
+            implName,
+        } = options
 
         this.testSaveDir = testSaveDir
         this.moduleSaveDir = moduleSaveDir
+        this.fakeSaveDir = fakeSaveDir
         this.interfaceName = interfaceName
         this.implName = implName
     }
@@ -28,16 +39,20 @@ export default class ImplAutomodule implements Automodule {
     public async run() {
         await this.throwIfTestDirDoesNotExist()
         await this.throwIfModuleDirDoesNotExist()
+        await this.throwIfFakeDirDoesNotExist()
 
         await this.createTestFile()
         await this.createModuleFile()
+        await this.createFakeFile()
+
+        await this.updateIndexFileExports()
     }
 
     private async throwIfTestDirDoesNotExist() {
         const testDirExists = await this.pathExists(this.testSaveDir)
 
         if (!testDirExists) {
-            throw new Error(`testSaveDir does not exist: ${this.testSaveDir}!`)
+            this.throw(`testSaveDir does not exist: ${this.testSaveDir}!`)
         }
     }
 
@@ -45,12 +60,22 @@ export default class ImplAutomodule implements Automodule {
         const moduleDirExists = await this.pathExists(this.moduleSaveDir)
 
         if (!moduleDirExists) {
-            throw new Error(
-                `moduleSaveDir does not exist: ${this.moduleSaveDir}!`
-            )
+            this.throw(`moduleSaveDir does not exist: ${this.moduleSaveDir}!`)
+        }
+    }
+
+    private async throwIfFakeDirDoesNotExist() {
+        const fakeDirExists = await this.pathExists(this.fakeSaveDir)
+
+        if (!fakeDirExists) {
+            this.throw(`fakeSaveDir does not exist: ${this.fakeSaveDir}!`)
         }
     }
 
+    private throw(err: string) {
+        throw new Error(err)
+    }
+
     private async createTestFile() {
         await this.writeFile(this.testFileName, this.testFilePattern)
     }
@@ -67,10 +92,33 @@ export default class ImplAutomodule implements Automodule {
         return path.join(this.moduleSaveDir, `${this.implName}.ts`)
     }
 
+    private async createFakeFile() {
+        await this.writeFile(this.fakeFileName, this.fakeFilePattern)
+    }
+
+    private get fakeFileName() {
+        return path.join(this.fakeSaveDir, `Fake${this.interfaceName}.ts`)
+    }
+
+    private async updateIndexFileExports() {
+        this.originalIndexFile = await this.loadOriginalIndexFile()
+        await this.writeFile(this.indexFilePath, this.sortedIndexFile)
+    }
+
+    private async loadOriginalIndexFile() {
+        return await this.readFile(this.indexFilePath, 'utf-8')
+    }
+
+    private readonly indexFilePath = './src/index.ts'
+
     private get pathExists() {
         return ImplAutomodule.pathExists
     }
 
+    private get readFile() {
+        return ImplAutomodule.readFile
+    }
+
     private get writeFile() {
         return ImplAutomodule.writeFile
     }
@@ -118,6 +166,53 @@ export default class ImplAutomodule implements Automodule {
             export type ${this.interfaceName}Constructor = new () => ${this.interfaceName}
         `
     }
+
+    private get fakeFilePattern() {
+        return `
+            import { ${this.interfaceName} } from '../../modules/${this.implName}'
+
+            export default class Fake${this.interfaceName} implements ${this.interfaceName} {
+                public static numCallsToConstructor = 0
+                
+                public constructor() {
+                    Fake${this.interfaceName}.numCallsToConstructor++
+                }
+                
+                public static resetTestDouble() {
+                    Fake${this.interfaceName}.numCallsToConstructor = 0
+                }
+            }
+        `
+    }
+
+    private get indexFilePattern() {
+        return `
+            ${this.originalIndexFile}
+
+            // ${this.interfaceName}
+
+            export { default as ${this.implName} } from './modules/${this.implName}'
+            export * from './modules/${this.implName}'
+
+            export { default as Fake${this.interfaceName} } from './testDoubles/${this.interfaceName}/Fake${this.interfaceName}'
+            export * from './testDoubles/${this.interfaceName}/Fake${this.interfaceName}'
+        `
+    }
+
+    private get sortedIndexFile() {
+        const blocks = this.indexFilePattern
+            .split(/(?=\/\/)/)
+            .map((s) => s.trim())
+            .filter(Boolean)
+
+        blocks.sort((a, b) => {
+            const aKey = a.match(/^\/\/\s*([^\n]*)/)?.[1]?.trim() ?? ''
+            const bKey = b.match(/^\/\/\s*([^\n]*)/)?.[1]?.trim() ?? ''
+            return aKey.localeCompare(bKey)
+        })
+
+        return blocks.join('\n\n')
+    }
 }
 
 export interface Automodule {
@@ -131,6 +226,7 @@ export type AutomoduleConstructor = new (
 export interface AutomoduleOptions {
     testSaveDir: string
     moduleSaveDir: string
+    fakeSaveDir: string
     interfaceName: string
     implName: string
 }

package/src/modules/PackageAutodocumenter.ts

@@ -0,0 +1,13 @@
+export default class PackageAutodocumenter implements Autodocumenter {
+    public static Class?: AutodocumenterConstructor
+
+    protected constructor() {}
+
+    public static Create() {
+        return new (this.Class ?? this)()
+    }
+}
+
+export interface Autodocumenter {}
+
+export type AutodocumenterConstructor = new () => Autodocumenter

package/src/scripts/runAutomodule.ts

@@ -7,8 +7,10 @@ async function main() {
         testSaveDir:
             '/Users/ericthecurious/dev/meta-node/src/__tests__/modules',
         moduleSaveDir: '/Users/ericthecurious/dev/meta-node/src/modules',
-        interfaceName: 'Autocomponent',
-        implName: 'ReactAutocomponent',
+        fakeSaveDir:
+            '/Users/ericthecurious/dev/meta-node/src/testDoubles/Autodocumenter',
+        interfaceName: 'Autodocumenter',
+        implName: 'PackageAutodocumenter',
     })
 
     await instance.run()

package/src/testDoubles/Autodocumenter/FakeAutodocumenter.ts

@@ -0,0 +1,13 @@
+import { Autodocumenter } from '../../modules/PackageAutodocumenter'
+
+export default class FakeAutodocumenter implements Autodocumenter {
+    public static numCallsToConstructor = 0
+
+    public constructor() {
+        FakeAutodocumenter.numCallsToConstructor++
+    }
+
+    public static resetTestDouble() {
+        FakeAutodocumenter.numCallsToConstructor = 0
+    }
+}

package/src/testDoubles/fs/fakeReadFile.ts

@@ -0,0 +1,18 @@
+import { generateId } from '@sprucelabs/test-utils'
+
+export let callsToReadFile: string[] = []
+
+export function resetCallsToReadFile() {
+    callsToReadFile = []
+}
+
+export let fakeReadFileResult = generateId()
+
+export function setFakeReadFileResult(result: string) {
+    fakeReadFileResult = result
+}
+
+export default async function fakeReadFile(file: string) {
+    callsToReadFile.push(file)
+    return fakeReadFileResult
+}

package/src/testDoubles/fs/fakeWriteFile.ts

@@ -1,4 +1,7 @@
-export let callsToWriteFile: { file: string; data: string }[] = []
+export let callsToWriteFile: {
+    file: string
+    data: string
+}[] = []
 
 export function resetCallsToWriteFile() {
     callsToWriteFile = []