quackage 1.0.13 → 1.0.14

package/.quackage-templates.json

@@ -5,8 +5,8 @@
         "Description": "A template set for pictunittest ...",
         "Files": [
             {
-                "Hash": "testPicttestjs",
-                "Path": "test/Pict__test.js",
+                "Hash": "testPictQUACKAGEPROJECTNAMECAPtestjs",
+                "Path": "test/Pict_QUACKAGEPROJECTNAMECAP_test.js",
                 "Content": "/*\n\tUnit tests for LIBRARYNAMEHERE Basic\n*/\n\nconst _Package = require(`../package.json`);\n\n// This is temporary, but enables unit tests\nconst libBrowserEnv = require('browser-env')\nlibBrowserEnv();\n\nconst Chai = require('chai');\nconst Expect = Chai.expect;\n\nconst libPict = require('pict');\n\nconst configureTestPict = (pPict) =>\n{\n\tlet tmpPict = (typeof(pPict) == 'undefined') ? new libPict() : pPict;\n\ttmpPict.TestData = (\n\t\t{\n\t\t\tReads: [],\n\t\t\tAssignments: [],\n\t\t\tAppends: [],\n\t\t\tGets: []\n\t\t});\n\ttmpPict.ContentAssignment.customReadFunction = (pAddress, pContentType) =>\n\t{\n\t\ttmpPict.TestData.Reads.push(pAddress);\n\t\ttmpPict.log.info(`Mocking a read of type ${pContentType} from Address: ${pAddress}`);\n\t\treturn '';\n\t}\n\ttmpPict.ContentAssignment.customGetElementFunction = (pAddress) =>\n\t{\n\t\ttmpPict.TestData.Gets.push(pAddress);\n\t\ttmpPict.log.info(`Mocking a get of Address: ${pAddress}`);\n\t\treturn '';\n\t}\n\ttmpPict.ContentAssignment.customAppendElementFunction = (pAddress, pContent) =>\n\t{\n\t\ttmpPict.TestData.Appends.push(pAddress);\n\t\ttmpPict.log.info(`Mocking an append of Address: ${pAddress}`, {Content: pContent});\n\t\treturn '';\n\t}\n\ttmpPict.ContentAssignment.customAssignFunction = (pAddress, pContent) =>\n\t{\n\t\ttmpPict.TestData.Assignments.push(pAddress);\n\t\ttmpPict.log.info(`Mocking an assignment of Address: ${pAddress}`, {Content: pContent});\n\t\treturn '';\n\t}\n\n\treturn tmpPict;\n}\n\nconst libPictExtension = require(`../${_Package.main}`);\n\nsuite\n(\n\t`Basic ${_Package.name}v${_Package.version} tests`,\n\t() =>\n\t{\n\t\tsetup(() => { });\n\n\t\tsuite\n\t\t\t(\n\t\t\t\t'Basic Basic Tests',\n\t\t\t\t() =>\n\t\t\t\t{\n\t\t\t\t\ttest(\n\t\t\t\t\t\t\t'Constructor properly crafts an object',\n\t\t\t\t\t\t\t(fDone) =>\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tlet _Pict = configureTestPict();\n\t\t\t\t\t\t\t\tlet _PictExtension = _Pict.addView({}, 'Pict-Test-{~RandomNumberString:4,9000~}',  libPictExtension);\n\t\t\t\t\t\t\t\tExpect(_PictExtension).to.be.an('object');\n\t\t\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t);\n\t}\n);"
             }
         ]
@@ -49,8 +49,8 @@
         "Description": "A template set for unittest ...",
         "Files": [
             {
-                "Hash": "testBasetestjs",
-                "Path": "test/Base_test.js",
+                "Hash": "testQUACKAGEPROJECTNAMECAPBasictestjs",
+                "Path": "test/QUACKAGEPROJECTNAMECAP-Basic_test.js",
                 "Content": "/*\n\tUnit tests for {~PascalCaseIdentifier:AppData.Package.name~} {~Data:Record.Scope~}\n*/\n\nconst Chai = require('chai');\nconst Expect = Chai.expect;\n\nconst lib{~PascalCaseIdentifier:AppData.Package.name~} = require(`../{~Data:AppData.Package.main~}`);\n\nsuite\n(\n\t'{~PascalCaseIdentifier:AppData.Package.name~} {~Data:Record.Scope~}',\n\t() =>\n\t{\n\t\tsetup(() => { });\n\n\t\tsuite\n\t\t\t(\n\t\t\t\t'Basic {~Data:Record.Scope~} Tests',\n\t\t\t\t() =>\n\t\t\t\t{\n\t\t\t\t\ttest(\n\t\t\t\t\t\t\t'Object Instantiation # {~RandomNumberString:1,9~}',\n\t\t\t\t\t\t\t(fDone) =>\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tlet _{~PascalCaseIdentifier:AppData.Package.name~} = new lib{~PascalCaseIdentifier:AppData.Package.name~}();\n\t\t\t\t\t\t\t\tExpect(_{~PascalCaseIdentifier:AppData.Package.name~}).to.be.an('object');\n\t\t\t\t\t\t\t\treturn fDone();\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t);\n\t}\n);"
             }
         ]

package/.vscode/launch.json

@@ -12,7 +12,7 @@
                 "<node_internals>/**"
             ],
             "program": "${workspaceFolder}/source/Quackage.js",
-            "args":["buildtemplates", "./templates"]
+            "args":["lint", "./templates"]
         }
     ]
 }

package/debug/Clean.sh

@@ -0,0 +1,5 @@
+##!/bin/bash
+
+echo "Deleting quackage test environment..."
+
+rm -rf ./testenv

package/debug/Env.sh

@@ -0,0 +1,8 @@
+##!/bin/bash
+
+echo "Creating quackage test environment..."
+
+mkdir testenv
+cp ../test/packagefiles/clean-debug-package.json testenv/package.json
+cd testenv
+npm install

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quackage",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "Building.  Testing.  Quacking.",
   "main": "source/Quackage.js",
   "scripts": {
@@ -63,7 +63,7 @@
     "mocha": "10.2.0",
     "npm-check-updates": "^16.10.12",
     "nyc": "^15.1.0",
-    "pict": "^1.0.81",
+    "pict": "^1.0.88",
     "vinyl-buffer": "^1.0.1",
     "vinyl-source-stream": "^2.0.0"
   }

package/source/commands/Quackage-Command-Boilerplate.js

@@ -13,9 +13,9 @@ class QuackageCommandBoilerplate extends libCommandLineCommand
 
 		this.options.CommandArguments.push({ Name: '<fileset>', Description: 'The boilerplate fileset to generate.' });
 
-		this.options.CommandOptions.push({ Name: '-s, --scope', Description: 'A "scope" for the template.', Default: 'Scope' });
-		this.options.CommandOptions.push({ Name: '-f, --force', Description: 'Force overwrite anything in the package.json; use at your own quacking peril' });
-		this.options.CommandOptions.push({ Name: '-c, --content', Description: 'An extra content string.', Default: '' });
+		this.options.CommandOptions.push({ Name: '-s, --scope [scope]', Description: 'A "scope" for the template (used for things like unit tests)', Default: 'BoilerplateScope' });
+		this.options.CommandOptions.push({ Name: '-d, --description [description]', Description: 'An extra content string used as a description', Default: '' });
+		this.options.CommandOptions.push({ Name: '-o, --outputfolder [output_folder]', Description: 'Where to write the .quackage-templates.json file', Default: '' });
 
 		this.options.Aliases.push('boil');
 		this.options.Aliases.push('bp');
@@ -38,7 +38,7 @@ class QuackageCommandBoilerplate extends libCommandLineCommand
 		let tmpCWDFilesetPath = `${this.fable.AppData.CWD}/.quackage-templates.json`;
 		let tmpHomeFilesetPath = `${libOS.homedir()}/.quackage-templates.json`;
 
-		let libFilePersistence = this.defaultServices.FilePersistence;
+		let libFilePersistence = this.services.FilePersistence;
 
 		if (libFilePersistence.existsSync(tmpCWDFilesetPath))
 		{
@@ -58,7 +58,7 @@ class QuackageCommandBoilerplate extends libCommandLineCommand
 				{
 					this.log.info(`...Boilerplate fileset loaded from [${tmpCWDFilesetPath}]`);
 					this.log.info(`...Merging boilerplate fileset [${tmpCWDFilesetPath}] with [${pFileset}]`);
-					this.fileSet = this.defaultServices.Utility.extend(this.fileSet, tmpCWDFileset);
+					this.fileSet = this.services.Utility.extend(this.fileSet, tmpCWDFileset);
 				}
 			}
 		}
@@ -81,7 +81,7 @@ class QuackageCommandBoilerplate extends libCommandLineCommand
 				{
 					this.log.info(`...Boilerplate fileset loaded from [${tmpHomeFilesetPath}]`);
 					this.log.info(`...Merging boilerplate fileset [${tmpHomeFilesetPath}] with [${pFileset}]`);
-					this.fileSet = this.defaultServices.Utility.extend(this.fileSet, tmpHomeFileset);
+					this.fileSet = this.services.Utility.extend(this.fileSet, tmpHomeFileset);
 				}
 			}
 		}
@@ -131,7 +131,8 @@ class QuackageCommandBoilerplate extends libCommandLineCommand
 
 			let tmpFileFolder = libPath.dirname(tmpFilePath);
 
-			tmpFilePath = tmpFilePath.replace('QUACKAGEPROJECTNAMECAP', this.defaultServices.DataFormat.capitalizeEachWord(this.fable.AppData.Package.name));
+			tmpFilePath = tmpFilePath.replace('QUACKAGEPROJECTNAMECAP', this.services.DataFormat.capitalizeEachWord(this.fable.AppData.Package.name))
+								.replace('QUACKAGESCOPE', tmpScope);
 
 			libFilePersistence.makeFolderRecursive(tmpFileFolder,
 				(pError)=>
@@ -152,7 +153,7 @@ class QuackageCommandBoilerplate extends libCommandLineCommand
 					{
 						// It exists!  Show the user the command to back it up and/or delete it.  Don't generate it.
 						this.log.error(`The requested file [${tmpFilePath}] already exists!`);
-						this.log.info(`To back it up, run: [ mv "${tmpFilePath}" "${tmpFilePath}_QuackageBackup_${this.defaultServices.DataGeneration.randomNumericString(4, 9998)}.bak" ]`);
+						this.log.info(`To back it up, run: [ mv "${tmpFilePath}" "${tmpFilePath}_QuackageBackup_${this.services.DataGeneration.randomNumericString(4, 9998)}.bak" ]`);
 						this.log.info(`To delete it, run:  [ rm "${tmpFilePath}" ]`);
 					}
 					else

package/source/commands/Quackage-Command-BuildQuackageTemplates.js

@@ -0,0 +1,156 @@
+const libCommandLineCommand = require('../services/Pict-Service-CommandLineCommand.js');
+const libOS = require('os');
+const libFS = require('fs');
+const libPath = require('path');
+
+class QuackageCommandBuildTemplates extends libCommandLineCommand
+{
+	constructor(pFable, pManifest, pServiceHash)
+	{
+		super(pFable, pManifest, pServiceHash);
+
+		this.options.CommandKeyword = 'buildquackagetemplates';
+		this.options.Description = 'Generate boilerplate file set templates for each folder in the passed in path';
+
+		this.options.CommandArguments.push({ Name: '<folder>', Description: 'The folder path to build templates for.' });
+		this.options.Comma
+
+		this.options.Aliases.push('bqt');
+
+		this.templateSets = {};
+
+		// Auto add the command on initialization
+		this.addCommand();
+	}
+
+	getTemplateSet(pTemplateSetHash)
+	{
+		if (!this.templateSets.hasOwnProperty(pTemplateSetHash))
+		{
+			this.templateSets[pTemplateSetHash] = (
+				{
+					"Hash": this.services.DataFormat.cleanNonAlphaCharacters(pTemplateSetHash),
+					"Name": this.services.DataFormat.cleanNonAlphaCharacters(this.services.DataFormat.capitalizeEachWord(pTemplateSetHash)),
+					"Description": `A template set for ${pTemplateSetHash} ...`,
+					"Files": []
+				});
+		}
+
+		return this.templateSets[pTemplateSetHash];
+	}
+
+	addTemplateToSet(pTemplateSetHash, pTemplateSetRootPath, pTemplateFilePath, pTemplateFileContent, fCallback)
+	{
+		let tmpTemplateSet = this.getTemplateSet(pTemplateSetHash);
+		let tmpTemplateFilePath = pTemplateFilePath;
+
+		if ((pTemplateSetRootPath.length > 0) && (pTemplateFilePath.length > pTemplateSetRootPath.length))
+		{
+			tmpTemplateFilePath = pTemplateFilePath.substr(pTemplateSetRootPath.length);
+		}
+		tmpTemplateFilePath = tmpTemplateFilePath.substr(1);
+
+		tmpTemplateSet.Files.push(
+			{
+				"Hash": this.services.DataFormat.cleanNonAlphaCharacters(tmpTemplateFilePath),
+				"Path": tmpTemplateFilePath,
+				"Content": pTemplateFileContent
+			});
+
+		return fCallback();
+	}
+
+	generateTemplatesRecursively(pTemplateSet, pTemplateSetRootPath, pPath, fCallback)
+	{
+		libFS.readdir(pPath,
+			(pError, pFiles) =>
+			{
+				this.fable.Utility.eachLimit(pFiles, 1,
+					(pFileName, fEnumerationComplete)=>
+					{
+						let tmpFilePath = libPath.join(pPath, pFileName);
+						let tmpStat = libFS.stat(tmpFilePath,
+							(pFileStatError, pFileStats) =>
+							{
+								if (pFileStatError)
+								{
+									return fEnumerationComplete('File stat error during enumeration:'+pEnumerationError);
+								}
+
+								if (pFileStats && pFileStats.isDirectory())
+								{
+									return this.generateTemplatesRecursively(pTemplateSet, pTemplateSetRootPath, tmpFilePath, fEnumerationComplete);
+								}
+								else
+								{
+									this.log.info(`File [${pFileName}] in [${tmpFilePath}] is being added to template set: ${pTemplateSet}`);
+									let tmpFileContent = libFS.readFileSync(tmpFilePath, 'utf8');
+									return this.addTemplateToSet(pTemplateSet, pTemplateSetRootPath, tmpFilePath, tmpFileContent, fEnumerationComplete);
+								}
+							});
+					},
+					(pEnumerationError) =>
+					{
+						if (pEnumerationError)
+							return fCallback(`Error during bulk catalog of library [${pLibraryName}] folder [${pRelativeFolder}]: ${pEnumerationError}`);
+						return fCallback();
+					});
+			});
+	}
+
+	generateTemplatesFromFolder(pPath, fCallback)
+	{
+		libFS.readdir(pPath,
+			(pError, pFiles) =>
+			{
+				this.fable.Utility.eachLimit(pFiles, 1,
+					(pFileName, fEnumerationComplete)=>
+					{
+						let tmpFilePath = libPath.join(pPath, pFileName);
+						let tmpStat = libFS.stat(tmpFilePath,
+							(pFileStatError, pFileStats) =>
+							{
+								if (pFileStatError)
+								{
+									return fCallback('File stat error during enumeration:'+pEnumerationError);
+								}
+
+								let tmpSetName = this.services.DataFormat.cleanNonAlphaCharacters(pFileName);
+
+								if (pFileStats && pFileStats.isDirectory())
+								{
+									this.log.info(`Root Directory [${tmpFilePath}] being added as its own template set.`);
+									this.generateTemplatesRecursively(tmpSetName, tmpFilePath, tmpFilePath, fEnumerationComplete);
+								}
+								else
+								{
+									this.log.info(`Root File [${tmpFilePath}] being added as its own template set.`);
+									let tmpFileContent = libFS.readFileSync(tmpFilePath, 'utf8');
+									return this.addTemplateToSet(tmpSetName, pPath, tmpFilePath, tmpFileContent, fEnumerationComplete);
+								}
+							});
+					},
+					(pEnumerationError) =>
+					{
+						if (pEnumerationError)
+						{
+							return fCallback(`Error building templates for ${pPath}: ${pEnumerationError}`, pEnumerationError);
+						}
+						libFS.writeFileSync(`${this.fable.AppData.CWD}/.quackage-templates.json`, (JSON.stringify(this.templateSets, null, 4)));
+						return fCallback();
+					});
+			});
+	}
+
+	run(pPath, pOptions, fCallback)
+	{
+		let tmpCallback = (typeof(fCallback) === 'function') ? fCallback : ()=>{};
+		let tmpCWDFolderPath = libPath.resolve(`${this.fable.AppData.CWD}/${pPath}`);
+		// Execute the command
+		this.log.info(`Creating boilerplate template(s) for [${tmpCWDFolderPath}]...`);
+
+		return this.generateTemplatesFromFolder(tmpCWDFolderPath, tmpCallback);
+	};
+}
+
+module.exports = QuackageCommandBuildTemplates;

package/source/commands/Quackage-Command-BuildTemplates.js

@@ -28,8 +28,8 @@ class QuackageCommandBuildTemplates extends libCommandLineCommand
 		{
 			this.templateSets[pTemplateSetHash] = (
 				{
-					"Hash": this.defaultServices.DataFormat.cleanNonAlphaCharacters(pTemplateSetHash),
-					"Name": this.defaultServices.DataFormat.cleanNonAlphaCharacters(this.defaultServices.DataFormat.capitalizeEachWord(pTemplateSetHash)),
+					"Hash": this.services.DataFormat.cleanNonAlphaCharacters(pTemplateSetHash),
+					"Name": this.services.DataFormat.cleanNonAlphaCharacters(this.services.DataFormat.capitalizeEachWord(pTemplateSetHash)),
 					"Description": `A template set for ${pTemplateSetHash} ...`,
 					"Files": []
 				});
@@ -51,7 +51,7 @@ class QuackageCommandBuildTemplates extends libCommandLineCommand
 
 		tmpTemplateSet.Files.push(
 			{
-				"Hash": this.defaultServices.DataFormat.cleanNonAlphaCharacters(tmpTemplateFilePath),
+				"Hash": this.services.DataFormat.cleanNonAlphaCharacters(tmpTemplateFilePath),
 				"Path": tmpTemplateFilePath,
 				"Content": pTemplateFileContent
 			});
@@ -114,7 +114,7 @@ class QuackageCommandBuildTemplates extends libCommandLineCommand
 									return fCallback('File stat error during enumeration:'+pEnumerationError);
 								}
 
-								let tmpSetName = this.defaultServices.DataFormat.cleanNonAlphaCharacters(pFileName);
+								let tmpSetName = this.services.DataFormat.cleanNonAlphaCharacters(pFileName);
 
 								if (pFileStats && pFileStats.isDirectory())
 								{

package/source/services/Pict-Service-CommandLineCommand.js

@@ -27,10 +27,10 @@ class CommandLineCommand extends libPict.ServiceProviderBase
 		if (!this.options.CommandAdded)
 		{
 			// Find the default CommandLineUtility service, or make one if it isn't there yet
-			let tmpCommandLineUtility = this.defaultServices.CommandLineUtility
+			let tmpCommandLineUtility = this.services.CommandLineUtility
 			if (typeof (tmpCommandLineUtility) === 'undefined')
 			{
-				tmpCommandLineUtility = this.defaultServices.ServiceManager.instantiateService('CommandLineUtility');
+				tmpCommandLineUtility = this.fable.ServiceManager.instantiateService('CommandLineUtility');
 			}
 
 			//_Command.command('command_keyword')

package/source/services/Pict-Service-CommandLineUtility.js

@@ -12,7 +12,7 @@ class CommandLineUtility extends libPict.ServiceProviderBase
 {
 	constructor(pFable, pOptions, pServiceHash)
 	{
-		let tmpOptions = Object.assign({}, defaultCommandLineUtilityOptions, pOptions);
+		let tmpOptions = Object.assign({}, JSON.parse(JSON.stringify(defaultCommandLineUtilityOptions)), pOptions);
 
 		super(pFable, tmpOptions, pServiceHash);