pict-section-form 1.0.10 → 1.0.13

package/source/{Pict-Section-Form-View.js → views/Pict-View-DynamicForm.js}

@@ -1,13 +1,14 @@
 const libPictViewClass = require('pict-view');
 
-const libInformary = require('./Pict-Service-Informary.js');
-const libFormsTemplateProvider = require('./Pict-Section-Form-Provider-Templates.js');
+const libInformary = require('../providers/Pict-Provider-Informary.js');
+const libDynamicSolver = require('../providers/Pict-Provider-DynamicSolver.js');
+const libFormsTemplateProvider = require('../providers/Pict-Provider-DynamicTemplates.js');
 
-class PictSectionFormView extends libPictViewClass
+class PictViewDynamicForm extends libPictViewClass
 {
 	constructor(pFable, pOptions, pServiceHash)
 	{
-		let tmpOptions = Object.assign({}, require('./Pict-Section-Form-View-DefaultConfiguration.json'), pOptions);
+		let tmpOptions = Object.assign({}, require('./Pict-View-DynamicForm-DefaultConfiguration.json'), pOptions);
 
 		if (!tmpOptions.Manifests)
 		{
@@ -35,14 +36,6 @@ class PictSectionFormView extends libPictViewClass
 		{
 			tmpOptions.SectionTemplateHash = `Pict-Form-Template-${tmpOptions.Hash}`;
 		}
-		if (!tmpOptions.SectionTabularRowVirtualTemplateHash)
-		{
-			tmpOptions.SectionTabularRowVirtualTemplateHash = `Pict-Form-Template-TabularRow-Virtual-${tmpOptions.Hash}`;
-		}
-		if (!tmpOptions.SectionTabularRowTemplateHash)
-		{
-			tmpOptions.SectionTabularRowTemplateHash = `Pict-Form-Template-TabularRow-${tmpOptions.Hash}`;
-		}
 
 		if (tmpOptions.Renderables.length < 1)
 		{
@@ -63,6 +56,20 @@ class PictSectionFormView extends libPictViewClass
 		// Initialize the section manifest -- instantiated to live only the lifecycle of this view
 		this.sectionManifest = this.fable.instantiateServiceProviderWithoutRegistration('Manifest', this.options.Manifests.Section);
 
+		// Shift solvers to an array of tasks
+		this.sectionSolvers = [];
+		// Pull in solvers
+		if (('Solvers' in this.options) && Array.isArray(this.options.Solvers))
+		{
+			for (let i = 0; i < this.options.Solvers.length; i++)
+			{
+				if (typeof(this.options.Solvers[i]) === 'string')
+				{
+					this.sectionSolvers.push(this.options.Solvers[i]);
+				}
+			}
+		}
+
 		if (!this.pict.providers.PictFormSectionDefaultTemplateProvider)
 		{
 			let tmpDefaultTemplateProvider = this.pict.addProvider('PictFormSectionDefaultTemplateProvider', libFormsTemplateProvider.default_configuration, libFormsTemplateProvider);
@@ -73,6 +80,11 @@ class PictSectionFormView extends libPictViewClass
 			let tmpInformary = this.pict.addProvider('Informary', libInformary.default_configuration, libInformary);
 			tmpInformary.initialize();
 		}
+		if (!this.pict.providers.DynamicSolver)
+		{
+			let tmpDynamicSolver = this.pict.addProvider('DynamicSolver', libDynamicSolver.default_configuration, libDynamicSolver);
+			tmpDynamicSolver.initialize();
+		}
 		// This is for if we decide to abstract metatemplates into a separate provider for code simplification
 		// if (!this.pict.providers.PictFormSectionMetatemplateGenerator)
 		// {
@@ -115,6 +127,16 @@ class PictSectionFormView extends libPictViewClass
 		this.initializeFormGroups();
 	}
 
+	addSolver(pSolveFunctionString)
+	{
+		return (
+			{
+				"Type": "SingleSolve",
+				"Priority": 0,
+				"SolveFunction": pSolveFunctionString
+			});
+	}
+
 	renderToPrimary()
 	{
 		// Render to the primary view that the 
@@ -212,25 +234,7 @@ class PictSectionFormView extends libPictViewClass
 
 	onSolve()
 	{
-		if (this.options.AutoMarshalDataOnSolve)
-		{
-			this.marshalFromView();
-		}
-
-		if (Array.isArray(this.options.Solvers))
-		{
-			for (let i = 0; i < this.options.Solvers.length; i++)
-			{
-				// TODO: Precompile the solvers (it's super easy)
-				this.log.trace(`Dynamic View [${this.UUID}]::[${this.Hash}] solving equation ${i} [${this.options.Solvers[i]}]`);
-
-				let tmpResultsObject = {};
-
-				let tmpSolutionValue = this.fable.ExpressionParser.solve(this.options.Solvers[i], this.getMarshalDestinationObject(), tmpResultsObject, this.sectionManifest, this.getMarshalDestinationObject());
-
-				this.log.trace(`[${this.options.Solvers[i]}] result was ${tmpSolutionValue}`);
-			}
-		}
+		this.pict.providers.DynamicSolver.solveViews([this.Hash]);
 
 		if (this.options.AutoMarshalDataOnSolve)
 		{
@@ -532,7 +536,7 @@ class PictSectionFormView extends libPictViewClass
 			return tmpBeginTemplate + tmpAddressTemplate + tmpEndTemplate;
 		}
 	
-		// There wasn't some k ind of catastrophic failure -- the above templates should always be loaded.
+		// There was some kind of catastrophic failure -- the above templates should always be loaded.
 		this.log.error(`PICT Form [${this.UUID}]::[${this.Hash}] catastrophic error generating tabular metatemplate: missing input template for Data Type ${pDataType} and Input Type ${pInputType}, Data Address ${pViewDataAddress} and Record Subaddress ${pRecordSubAddress}}.`)
 		return '';
 	}
@@ -559,6 +563,10 @@ class PictSectionFormView extends libPictViewClass
 			// Add this to the group object for metatemplating
 			tmpGroup.GroupIndex = i;
 
+			tmpGroup.SectionTabularRowVirtualTemplateHash = `Pict-Form-Template-TabularRow-Virtual-${this.options.Hash}-G${tmpGroup.GroupIndex}`;
+			tmpGroup.SectionTabularRowTemplateHash = `Pict-Form-Template-TabularRow-${this.options.Hash}-G${tmpGroup.GroupIndex}`;
+
+
 			// Group layouts are customizable
 			// The three basic group layouts:
 			// 1. Record (default) - Render the whole address as a singleton record
@@ -612,7 +620,7 @@ class PictSectionFormView extends libPictViewClass
 
 		
 							tmpTemplateSetRecordRowTemplate += this.getMetatemplateTemplateReference(`-TabularTemplate-Cell-Prefix`, `getTabularRecordInput("${i}","${k}")`);
-							let tmpInputType = ('PictForm' in tmpInput) ? tmpInput.PictForm.InputType : 'Default';
+							let tmpInputType = (('PictForm' in tmpInput) && tmpInput.PictForm.InputType) ? tmpInput.PictForm.InputType : 'Default';
 							tmpTemplateSetRecordRowTemplate += this.getTabularInputMetatemplateTemplateReference(tmpInput.DataType, tmpInputType, `getTabularRecordInput("${i}","${k}")`, k);
 							tmpTemplateSetRecordRowTemplate += this.getMetatemplateTemplateReference(`-TabularTemplate-Cell-Postfix`, `getTabularRecordInput("${i}","${k}")`);
 						}
@@ -625,16 +633,16 @@ class PictSectionFormView extends libPictViewClass
 					// TODO: Consider making this function available in manyfest in some fashion it seems dope.
 					let tmpTemplateSetVirtualRowTemplate = '';
 					tmpTemplateSetVirtualRowTemplate += this.getMetatemplateTemplateReferenceRaw(`-TabularTemplate-Row-ExtraPrefix`, `Record`);
-					tmpTemplateSetVirtualRowTemplate += `\n\n{~T:${this.options.SectionTabularRowTemplateHash}:Record~}\n`;
+					tmpTemplateSetVirtualRowTemplate += `\n\n{~T:${tmpGroup.SectionTabularRowTemplateHash}:Record~}\n`;
 					tmpTemplateSetVirtualRowTemplate += this.getMetatemplateTemplateReferenceRaw(`-TabularTemplate-Row-ExtraPostfix`, `Record`);
 
 					// This is a custom template expression
-					tmpTemplate += `\n\n{~MTVS:${this.options.SectionTabularRowVirtualTemplateHash}:${tmpGroup.GroupIndex}:${this.getMarshalDestinationAddress()}.${tmpGroup.RecordSetAddress}~}\n`;
+					tmpTemplate += `\n\n{~MTVS:${tmpGroup.SectionTabularRowVirtualTemplateHash}:${tmpGroup.GroupIndex}:${this.getMarshalDestinationAddress()}.${tmpGroup.RecordSetAddress}~}\n`;
 
 					tmpTemplate += this.getMetatemplateTemplateReference(`-TabularTemplate-Group-Postfix`, `getGroup("${i}")`);
 					// Add the TemplateSetTemplate
-					this.pict.TemplateProvider.addTemplate(this.options.SectionTabularRowVirtualTemplateHash, tmpTemplateSetVirtualRowTemplate);
-					this.pict.TemplateProvider.addTemplate(this.options.SectionTabularRowTemplateHash, tmpTemplateSetRecordRowTemplate);
+					this.pict.TemplateProvider.addTemplate(tmpGroup.SectionTabularRowVirtualTemplateHash, tmpTemplateSetVirtualRowTemplate);
+					this.pict.TemplateProvider.addTemplate(tmpGroup.SectionTabularRowTemplateHash, tmpTemplateSetRecordRowTemplate);
 					break;
 				case 'Record':
 				default:
@@ -736,6 +744,18 @@ class PictSectionFormView extends libPictViewClass
 		}
 	}
 
+	getTabularRecordSet(pGroupIndex)
+	{
+		// The neat thing about how the tabular groups work is that we can make it clever about whether it's an object or an array.
+		let tmpGroup = this.getGroup(pGroupIndex);
+		if (!tmpGroup)
+		{
+			this.log.warn(`PICT View Metatemplate Helper getTabularRecordSet ${pGroupIndex} was not a valid group.`);
+			return false;
+		}
+		return this.sectionManifest.getValueByHash(this.getMarshalDestinationObject(), tmpGroup.RecordSetAddress);
+	}
+
 	getGroup(pGroupIndex)
 	{
 		if (isNaN(pGroupIndex))
@@ -776,6 +796,97 @@ class PictSectionFormView extends libPictViewClass
 		}
 	}
 
+	setDynamicTableRowIndex(pGroupIndex, pRowIndex, pNewRowIndex)
+	{
+		let tmpGroup = this.getGroup(pGroupIndex);
+
+		if (tmpGroup)
+		{
+			let tmpDestinationObject = this.sectionManifest.getValueByHash(this.getMarshalDestinationObject(), tmpGroup.RecordSetAddress);
+
+			if (Array.isArray(tmpDestinationObject))
+			{
+				let tmpRowIndex = parseInt(pRowIndex, 10);
+				let tmpNewRowIndex = parseInt(pNewRowIndex, 10);
+				if ((tmpDestinationObject.length <= tmpRowIndex) || (tmpRowIndex < 0))
+				{
+					this.pict.log.error(`Dynamic View [${this.UUID}]::[${this.Hash}] Group ${tmpGroup.Hash} attempting to move row [${pRowIndex}] to [${pNewRowIndex}] but the index is out of bounds.`);
+					return false;
+				}
+				let tmpElementToBeMoved = tmpDestinationObject.splice(tmpRowIndex, 1);
+				tmpDestinationObject.splice(tmpNewRowIndex, 0, tmpElementToBeMoved[0]);
+				this.render();
+				this.marshalToView();
+			}
+			else if (typeof(tmpDestinationObject) === 'object')
+			{
+				this.pict.log.error(`Dynamic View [${this.UUID}]::[${this.Hash}] Group ${tmpGroup.Hash} attempting to move row [${pRowIndex}] to [${pNewRowIndex}] but it's an object not an array; order isn't controllable.`);
+			}
+		}
+	}
+
+	moveDynamicTableRowDown(pGroupIndex, pRowIndex)
+	{
+		let tmpGroup = this.getGroup(pGroupIndex);
+
+		if (tmpGroup)
+		{
+			let tmpDestinationObject = this.sectionManifest.getValueByHash(this.getMarshalDestinationObject(), tmpGroup.RecordSetAddress);
+
+			if (Array.isArray(tmpDestinationObject))
+			{
+				let tmpRowIndex = parseInt(pRowIndex, 10);
+				if (tmpDestinationObject.length <= tmpRowIndex)
+				{
+					this.pict.log.error(`Dynamic View [${this.UUID}]::[${this.Hash}] Group ${tmpGroup.Hash} attempting to move row [${pRowIndex}] down but it's already at the bottom.`);
+					return false;
+				}
+				let tmpElementToBeMoved = tmpDestinationObject.splice(tmpRowIndex, 1);
+				tmpDestinationObject.splice(tmpRowIndex + 1, 0, tmpElementToBeMoved[0]);
+				this.render();
+				this.marshalToView();
+			}
+			else if (typeof(tmpDestinationObject) === 'object')
+			{
+				this.pict.log.error(`Dynamic View [${this.UUID}]::[${this.Hash}] Group ${tmpGroup.Hash} attempting to move row [${pRowIndex}] but it's an object not an array; order isn't controllable.`);
+			}
+		}
+	}
+
+	moveDynamicTableRowUp(pGroupIndex, pRowIndex)
+	{
+		let tmpGroup = this.getGroup(pGroupIndex);
+
+		if (tmpGroup)
+		{
+			let tmpDestinationObject = this.sectionManifest.getValueByHash(this.getMarshalDestinationObject(), tmpGroup.RecordSetAddress);
+
+			if (Array.isArray(tmpDestinationObject))
+			{
+				let tmpRowIndex = parseInt(pRowIndex, 10);
+				if (tmpRowIndex == 0)
+				{
+					this.pict.log.error(`Dynamic View [${this.UUID}]::[${this.Hash}] Group ${tmpGroup.Hash} attempting to move row [${pRowIndex}] up but it's already at the top.`);
+					return false;
+				}
+				if (tmpDestinationObject.length <= tmpRowIndex)
+				{
+					this.pict.log.error(`Dynamic View [${this.UUID}]::[${this.Hash}] Group ${tmpGroup.Hash} attempting to move row [${pRowIndex}] but the index is out of bounds.`);
+					return false;
+				}
+				let tmpElementToBeMoved = tmpDestinationObject.splice(tmpRowIndex, 1);
+				tmpDestinationObject.splice(tmpRowIndex - 1, 0, tmpElementToBeMoved[0]);
+				this.render();
+				this.marshalToView();
+			}
+			else if (typeof(tmpDestinationObject) === 'object')
+			{
+				this.pict.log.error(`Dynamic View [${this.UUID}]::[${this.Hash}] Group ${tmpGroup.Hash} attempting to move row [${pRowIndex}] but it's an object not an array; order isn't controllable.`);
+			}
+		}
+	}
+
+
 	deleteDynamicTableRow(pGroupIndex, pRowIndex)
 	{
 		let tmpGroup = this.getGroup(pGroupIndex);
@@ -870,4 +981,4 @@ class PictSectionFormView extends libPictViewClass
 	}
 }
 
-module.exports = PictSectionFormView;
+module.exports = PictViewDynamicForm;

package/source/{Pict-Form-Metacontroller.js → views/Pict-View-Form-Metacontroller.js}

@@ -1,6 +1,11 @@
 const libPictViewClass = require('pict-view');
+const libDynamicSolver = require('../providers/Pict-Provider-DynamicSolver.js');
 
-const libFormsTemplateProvider = require('./Pict-Section-Form-Provider-Templates.js');
+const libFormsTemplateProvider = require('../providers/Pict-Provider-DynamicTemplates.js');
+
+// TODO: Create an internalized list of views for this to manage, separate from the pict.views object
+// TODO: Manage view lifecycle internally, including destruction
+// Why?  This allows us to dynamically add and remove sections without having to reload the application.
 
 // "What dependency injection in javascript?"
 //  -- Ned
@@ -15,9 +20,12 @@ class PictFormMetacontroller extends libPictViewClass
 
 		if (!this.pict.providers.PictFormSectionDefaultTemplateProvider)
 		{
-			let tmpDefaultTemplateProvider = this.pict.addProvider('PictFormSectionDefaultTemplateProvider', libFormsTemplateProvider.default_configuration, libFormsTemplateProvider);
-			tmpDefaultTemplateProvider.initialize();
-			this.pict.addTemplate(require(`./Pict-Template-MetacontrollerValueSetWithGroup.js`));
+			this.pict.addProvider('PictFormSectionDefaultTemplateProvider', {}, libFormsTemplateProvider);
+		}
+		if (!this.pict.providers.DynamicSolver)
+		{
+			let tmpDynamicSolver = this.pict.addProvider('DynamicSolver', libDynamicSolver.default_configuration, libDynamicSolver);
+			tmpDynamicSolver.initialize();
 		}
 
 		this.viewMarshalDestination = 'AppData';
@@ -55,10 +63,8 @@ class PictFormMetacontroller extends libPictViewClass
 	{
 		// This is safe -- if there is no settings.DefaultFormManifest configuration, it just doesn't do anything
 		this.bootstrapPictFormViewsFromManifest();
-
 		// Generate the metatemplate (the container for each section)
 		this.generateMetatemplate();
-
 		return super.onAfterInitializeAsync(fCallback);
 	}
 
@@ -76,14 +82,7 @@ class PictFormMetacontroller extends libPictViewClass
 
 	onSolve()
 	{
-		let tmpViewList = Object.keys(this.fable.views);
-		for (let i = 0; i < tmpViewList.length; i++)
-		{
-			if (this.fable.views[tmpViewList[i]].isPictSectionForm)
-			{
-				this.fable.views[tmpViewList[i]].marshalFromView();
-			}
-		}
+		this.pict.providers.DynamicSolver.solveViews();
 		return super.onSolve();
 	}
 
@@ -130,6 +129,12 @@ class PictFormMetacontroller extends libPictViewClass
 		}
 	}
 
+	/**
+	 * Regenerates the DyunamicForm section templates based on the provided filter and sort function.
+	 *
+	 * @param {Function} fFormSectionFilter - (optional) The filter function used to determine which views to include in the regeneration.
+	 * @param {Function} fSortFunction - (optional) The sort function used to determine the order of the views in the regeneration.
+	 */
 	regenerateFormSectionTemplates(fFormSectionFilter, fSortFunction)
 	{
 		let tmpViewList = this.filterViews(fFormSectionFilter, fSortFunction);
@@ -141,6 +146,13 @@ class PictFormMetacontroller extends libPictViewClass
 		this.pict.CSSMap.injectCSS();
 	}
 
+	/**
+	 * Generates a meta template for the DynamicForm views managed by this Metacontroller.
+	 *
+	 * @param {Function} fFormSectionFilter - (optional) The filter function to apply on the form section.
+	 * @param {Function} fSortFunction - (optional) The sort function to apply on the form section.
+	 * @returns {void}
+	 */
 	generateMetatemplate(fFormSectionFilter, fSortFunction)
 	{
 		let tmpTemplate = ``;
@@ -167,6 +179,12 @@ class PictFormMetacontroller extends libPictViewClass
 		this.pict.TemplateProvider.addTemplate(this.options.MetaTemplateHash, tmpTemplate);
 	}
 
+	/**
+	 * Retrieves a safe clone of the section definition for a given manyfest section description object.
+	 *
+	 * @param {object} pSectionObject - The section object.
+	 * @returns {object|boolean} - The section definition if successful, otherwise false.
+	 */
 	getSectionDefinition(pSectionObject)
 	{
 		if (typeof(pSectionObject) != 'object')
@@ -210,6 +228,12 @@ class PictFormMetacontroller extends libPictViewClass
 		}
 	}
 
+	/**
+	 * Bootstraps Pict DynamicForm views from a Manyfest description JSON object.
+	 * 
+	 * @param {Object} pManifestDescription - The manifest description object.
+	 * @returns {Array} - An array of section definitions.
+	 */
 	bootstrapPictFormViewsFromManifest(pManifestDescription)
 	{
 		let tmpManifestDescription = (typeof(pManifestDescription) === 'object') ? pManifestDescription : false;
@@ -311,11 +335,16 @@ class PictFormMetacontroller extends libPictViewClass
 			}
 			tmpViewConfiguration.Manifests.Section = tmpManifestDescription;
 			tmpViewConfiguration.AutoMarshalDataOnSolve = this.options.AutoMarshalDataOnSolve;
-			this.fable.addView(tmpViewHash, tmpViewConfiguration, require('./Pict-Section-Form-View.js'));
+			this.fable.addView(tmpViewHash, tmpViewConfiguration, require('./Pict-View-DynamicForm.js'));
 		}
 
 		return tmpSectionList;
 	}
+
+	get isPictMetacontroller()
+	{
+		return true;
+	}
 }
 
 module.exports = PictFormMetacontroller;
@@ -324,6 +353,7 @@ module.exports.default_configuration = (
 	"AutoRender": true,
 
 	"AutoPopulateDefaultObject": true,
+	"AutoSolveBeforeRender": true,
 	"AutoPopulateAfterRender": true,
 
 	"DefaultRenderable": "Pict-Forms-Metacontainer",