Moved config to properties

shockpkg · Oct 11, 2023 · 2edba08 · 2edba08
1 parent c3a964a
commit 2edba08
Show file tree

Hide file tree

Showing 9 changed files with 162 additions and 137 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,9 @@ const projector = new ProjectorWindows('projector-windows/application.exe');
 // Required skeleton.
 projector.skeleton = 'skeleton.zip';
 
+// File to create config file with.
+projector.configFile = 'config.ini';
+
 // Optional custom icon.
 projector.iconFile = 'icon.ico';
 
@@ -73,7 +76,7 @@ projector.nestXtrasConfiguration = true;
 // Optionally fix Shockwave 3D Xtra InstalledDisplayDrivers reading.
 projector.patchShockwave3dInstalledDisplayDriversSize = true;
 
-await projector.withFile('config.ini');
+await projector.write();
 ```
 
 ### Mac App
@@ -86,6 +89,9 @@ const projector = new ProjectorMacApp('projector-macapp/application.app');
 // Required skeleton.
 projector.skeleton = 'skeleton.zip';
 
+// File to create config file with.
+projector.configFile = 'config.ini';
+
 // Optional custom icon.
 projector.iconFile = 'icon.icns';
 
@@ -124,7 +130,7 @@ projector.nestXtrasContents = true;
 // Optionally use Intel-only skeleton.
 // projector.intel = true;
 
-await projector.withFile('config.ini');
+await projector.write();
 ```
 
 ## Bundle
@@ -139,7 +145,10 @@ const bundle = new BundleWindows('bundle-windows/application.exe');
 // Use projector property to set options.
 bundle.projector.skeleton = 'skeleton.zip';
 
-await bundle.withFile('config.ini', async b => {
+// File to create config file with.
+bundle.projector.configFile = 'config.ini';
+
+await bundle.write(async b => {
 	// Add resources in callback.
 	await b.copyResource('movie.dir', 'movie.dir');
 });
@@ -155,7 +164,10 @@ const bundle = new BundleMacApp('bundle-macapp/application.app');
 // Use projector property to set options.
 bundle.projector.skeleton = 'skeleton.zip';
 
-await bundle.withFile('config.ini', async b => {
+// File to create config file with.
+bundle.projector.configFile = 'config.ini';
+
+await bundle.write(async b => {
 	// Add resources in callback.
 	await b.copyResource('movie.dir', 'movie.dir');
 });

diff --git a/src/bundle.test.ts b/src/bundle.test.ts
@@ -64,7 +64,8 @@ void describe('bundle', () => {
 
 			const b = new BundleDummy(dest);
 			b.projector.skeleton = fixtureFile('dummy.zip');
-			await b.withFile(fixtureFile('config.ini.crlf.bin'));
+			b.projector.configFile = fixtureFile('config.ini.crlf.bin');
+			await b.write();
 		});
 
 		void it('resources', async () => {
@@ -109,7 +110,8 @@ void describe('bundle', () => {
 
 			const b = new BundleDummy(dest);
 			b.projector.skeleton = fixtureFile('dummy.zip');
-			await b.withFile(fixtureFile('config.ini.crlf.bin'), async p => {
+			b.projector.configFile = fixtureFile('config.ini.crlf.bin');
+			await b.write(async p => {
 				await p.copyResource('resources0', resources);
 
 				await p.copyResource('resources1', resources, {
@@ -252,7 +254,8 @@ void describe('bundle', () => {
 
 			const b = new BundleDummy(dest);
 			b.projector.skeleton = fixtureFile('dummy.zip');
-			await b.withFile(fixtureFile('config.ini.crlf.bin'), async p => {
+			b.projector.configFile = fixtureFile('config.ini.crlf.bin');
+			await b.write(async p => {
 				await p.createResourceFile('d/b.txt', 'beta');
 
 				// Merge contents at root of resources.

diff --git a/src/bundle.ts b/src/bundle.ts
@@ -3,7 +3,6 @@ import {
 	chmod,
 	lstat,
 	mkdir,
-	readFile,
 	readlink,
 	stat,
 	symlink,
@@ -133,28 +132,16 @@ export abstract class Bundle {
 	}
 
 	/**
-	 * Open output with file.
-	 *
-	 * @param configFile Config file.
+	 * Open output.
 	 */
-	public async openFile(configFile: string | null) {
-		const configData = configFile ? await readFile(configFile) : null;
-		await this.openData(configData);
-	}
-
-	/**
-	 * Open output with data.
-	 *
-	 * @param configData Config data.
-	 */
-	public async openData(configData: Readonly<Buffer> | null) {
+	public async open() {
 		if (this._isOpen) {
 			throw new Error('Already open');
 		}
 		await this._checkOutput();
 
 		this._closeQueue.clear();
-		await this._openData(configData);
+		await this._open();
 
 		this._isOpen = true;
 	}
@@ -175,34 +162,14 @@ export abstract class Bundle {
 	}
 
 	/**
-	 * Write out projector with player and file.
+	 * Write out the bundle.
 	 * Has a callback to write out the resources.
 	 *
-	 * @param configFile Config file.
 	 * @param func Async function.
 	 * @returns Return value of the async function.
 	 */
-	public async withFile<T>(
-		configFile: string | null,
-		func: ((self: this) => Promise<T>) | null = null
-	) {
-		const configData = configFile ? await readFile(configFile) : null;
-		return this.withData(configData, func);
-	}
-
-	/**
-	 * Write out projector with player and data.
-	 * Has a callback to write out the resources.
-	 *
-	 * @param configData Config data.
-	 * @param func Async function.
-	 * @returns Return value of the async function.
-	 */
-	public async withData<T>(
-		configData: Readonly<Buffer> | null,
-		func: ((self: this) => Promise<T>) | null = null
-	) {
-		await this.openData(configData);
+	public async write<T>(func: ((self: this) => Promise<T>) | null = null) {
+		await this.open();
 		try {
 			return func ? await func.call(this, this) : null;
 		} finally {
@@ -580,12 +547,10 @@ export abstract class Bundle {
 	}
 
 	/**
-	 * Open output with data.
-	 *
-	 * @param configData Config data.
+	 * Open output.
 	 */
-	protected async _openData(configData: Readonly<Buffer> | null) {
-		await this.projector.withData(configData);
+	protected async _open() {
+		await this.projector.write();
 	}
 
 	/**

diff --git a/src/bundle/mac/app.test.ts b/src/bundle/mac/app.test.ts
@@ -27,15 +27,13 @@ void describe('bundle/mac/app', () => {
 
 					const b = new BundleMacApp(dest);
 					b.projector.skeleton = await getSkeleton();
-					await b.withFile(
-						fixtureFile('config.ini.lf.bin'),
-						async b => {
-							await b.copyResource(
-								'movie.dir',
-								fixtureFile('dir7.dir')
-							);
-						}
-					);
+					b.projector.configFile = fixtureFile('config.ini.lf.bin');
+					await b.write(async b => {
+						await b.copyResource(
+							'movie.dir',
+							fixtureFile('dir7.dir')
+						);
+					});
 				});
 
 				void it('complex', async () => {
@@ -45,6 +43,7 @@ void describe('bundle/mac/app', () => {
 					const b = new BundleMacApp(dest);
 					const p = b.projector;
 					p.skeleton = await getSkeleton();
+					p.configFile = fixtureFile('config.ini.lf.bin');
 					p.lingoFile = fixtureFile('lingo.ini.lf.bin');
 					p.splashImageFile = fixtureFile('splash.pict');
 					p.iconFile = fixtureFile('icon.icns');
@@ -57,15 +56,12 @@ void describe('bundle/mac/app', () => {
 						// eslint-disable-next-line @typescript-eslint/naming-convention
 						'': null
 					};
-					await b.withFile(
-						fixtureFile('config.ini.lf.bin'),
-						async b => {
-							await b.copyResource(
-								'movie.dir',
-								fixtureFile('dir7.dir')
-							);
-						}
-					);
+					await b.write(async b => {
+						await b.copyResource(
+							'movie.dir',
+							fixtureFile('dir7.dir')
+						);
+					});
 				});
 			});
 		}

diff --git a/src/bundle/windows.test.ts b/src/bundle/windows.test.ts
@@ -31,15 +31,13 @@ void describe('bundle/windows', () => {
 
 					const b = new BundleWindows(dest);
 					b.projector.skeleton = await getSkeleton();
-					await b.withFile(
-						fixtureFile('config.ini.crlf.bin'),
-						async b => {
-							await b.copyResource(
-								'movie.dir',
-								fixtureFile('dir7.dir')
-							);
-						}
-					);
+					b.projector.configFile = fixtureFile('config.ini.crlf.bin');
+					await b.write(async b => {
+						await b.copyResource(
+							'movie.dir',
+							fixtureFile('dir7.dir')
+						);
+					});
 				});
 
 				void it('complex', async () => {
@@ -49,6 +47,7 @@ void describe('bundle/windows', () => {
 					const b = new BundleWindows(dest);
 					const p = b.projector;
 					p.skeleton = await getSkeleton();
+					b.projector.configFile = fixtureFile('config.ini.crlf.bin');
 					p.lingoFile = fixtureFile('lingo.ini.crlf.bin');
 					p.splashImageFile = fixtureFile('splash.bmp');
 					p.nestXtrasConfiguration = true;
@@ -60,15 +59,12 @@ void describe('bundle/windows', () => {
 						patchShockwave3dInstalledDisplayDriversSize;
 					p.iconFile = fixtureFile('icon.ico');
 					p.versionStrings = versionStrings;
-					await b.withFile(
-						fixtureFile('config.ini.crlf.bin'),
-						async b => {
-							await b.copyResource(
-								'movie.dir',
-								fixtureFile('dir7.dir')
-							);
-						}
-					);
+					await b.write(async b => {
+						await b.copyResource(
+							'movie.dir',
+							fixtureFile('dir7.dir')
+						);
+					});
 				});
 			});
 		}

diff --git a/src/projector.test.ts b/src/projector.test.ts
@@ -15,7 +15,8 @@ void describe('projector', () => {
 
 			const p = new ProjectorDummy(dest);
 			p.skeleton = 'dummy';
-			await p.withFile(fixtureFile('config.ini.crlf.bin'));
+			p.configFile = fixtureFile('config.ini.crlf.bin');
+			await p.write();
 
 			await copyFile(fixtureFile('dir7.dir'), pathJoin(dir, 'movie.dir'));
 		});
@@ -26,8 +27,9 @@ void describe('projector', () => {
 
 			const p = new ProjectorDummy(dest);
 			p.skeleton = 'dummy';
+			p.configFile = fixtureFile('config.ini.crlf.bin');
 			p.lingoFile = fixtureFile('lingo.ini.crlf.bin');
-			await p.withFile(fixtureFile('config.ini.crlf.bin'));
+			await p.write();
 
 			await copyFile(fixtureFile('dir7.dir'), pathJoin(dir, 'movie.dir'));
 		});
@@ -38,8 +40,9 @@ void describe('projector', () => {
 
 			const p = new ProjectorDummy(dest);
 			p.skeleton = 'dummy';
+			p.configFile = fixtureFile('config.ini.crlf.bin');
 			p.splashImageFile = fixtureFile('splash.bmp');
-			await p.withFile(fixtureFile('config.ini.crlf.bin'));
+			await p.write();
 
 			await copyFile(fixtureFile('dir7.dir'), pathJoin(dir, 'movie.dir'));
 		});
@@ -50,9 +53,10 @@ void describe('projector', () => {
 
 			const p = new ProjectorDummy(dest);
 			p.skeleton = 'dummy';
+			p.configFile = fixtureFile('config.ini.crlf.bin');
 			p.lingoFile = fixtureFile('lingo.ini.crlf.bin');
 			p.splashImageFile = fixtureFile('splash.bmp');
-			await p.withFile(fixtureFile('config.ini.crlf.bin'));
+			await p.write();
 
 			await copyFile(fixtureFile('dir7.dir'), pathJoin(dir, 'movie.dir'));
 		});