manyfest 1.0.2 → 1.0.3

package/source/Manyfest.js

@@ -3,6 +3,7 @@
 * @author <steven@velozo.com>
 */
 let libSimpleLog = require('./Manyfest-LogToConsole.js');
+let libObjectAddressResolver = require('./Manyfest-ObjectAddressResolver.js');
 
 /**
 * Manyfest object address-based descriptions and manipulations.
@@ -11,15 +12,31 @@ let libSimpleLog = require('./Manyfest-LogToConsole.js');
 */
 class Manyfest
 {
-	constructor(pManifest, pInfoLog, pErrorLog)
+	constructor(pManifest, pInfoLog, pErrorLog, pOptions)
 	{
 		// Wire in logging
 		this.logInfo = (typeof(pInfoLog) === 'function') ? pInfoLog : libSimpleLog;
 		this.logError = (typeof(pErrorLog) === 'function') ? pErrorLog : libSimpleLog;
 
+		// Create an object address resolver and map in the functions
+		this.objectAddressResolver = new libObjectAddressResolver(this.logInfo, this.logError);
+
 		this.options = (
 			{
-				strict: false
+				strict: false,
+				defaultValues: 
+					{
+						"String": "",
+						"Number": 0,
+						"Float": 0.0,
+						"Integer": 0,
+						"Boolean": false,
+						"Binary": 0,
+						"DateTime": 0,
+						"Array": [],
+						"Object": {},
+						"Null": null
+					}
 			});
 
 		this.scope = undefined;
@@ -72,12 +89,12 @@ class Manyfest
 			}
 			else
 			{
-				this.logError(`(${this.scope}) Error loading scope from manifest; expecting a string but property was type ${typeof(pManifest.Scope)}.`);
+				this.logError(`(${this.scope}) Error loading scope from manifest; expecting a string but property was type ${typeof(pManifest.Scope)}.`, pManifest);
 			}
 		}
 		else
 		{
-			this.logError(`(${this.scope}) Error loading scope from manifest object.  Property "Scope" does not exist in the root of the object.`);
+			this.logError(`(${this.scope}) Error loading scope from manifest object.  Property "Scope" does not exist in the root of the object.`, pManifest);
 		}
 
 		if (pManifest.hasOwnProperty('Descriptors'))
@@ -92,12 +109,12 @@ class Manyfest
 			}
 			else
 			{
-				this.logError(`(${this.scope}) Error loading description object from manifest object.  Expecting an object in 'Manifest.Descriptors' but the property was type ${typeof(pManifest.Description)}.`);
+				this.logError(`(${this.scope}) Error loading description object from manifest object.  Expecting an object in 'Manifest.Descriptors' but the property was type ${typeof(pManifest.Descriptors)}.`, pManifest);
 			}
 		}
 		else
 		{
-			this.logError(`(${this.scope}) Error loading object description from manifest object.  Property "Descriptors" does not exist in the root of the object.`);
+			this.logError(`(${this.scope}) Error loading object description from manifest object.  Property "Descriptors" does not exist in the root of the Manifest object.`, pManifest);
 		}
 	}
 
@@ -175,201 +192,45 @@ class Manyfest
 	/*************************************************************************
 	 * Beginning of Object Manipulation (read & write) Functions
 	 */
-	// Get the value of an element by its hash
-	getValueByHash (pObject, pHash)
+	// Check if an element exists by its hash
+	checkAddressExistsByHash (pObject, pHash)
 	{
 		if (this.elementHashes.hasOwnProperty(pHash))
 		{
-			return this.getValueAtAddress(pObject, this.elementHashes[pHash]);
+			return this.checkAddressExists(pObject, this.elementHashes[pHash]);
 		}
 		else
 		{
-			this.logError(`(${this.scope}) Error in getValueByHash; the Hash ${pHash} doesn't exist in the schema.`);
+			this.logError(`(${this.scope}) Error in checkAddressExistsByHash; the Hash ${pHash} doesn't exist in the schema.`);
 			return undefined;
 		}
 	}
 
+	// Check if an element exists at an address
+	checkAddressExists (pObject, pAddress)
+	{
+		return this.objectAddressResolver.checkAddressExists(pObject, pAddress);
+	}
+
 
-	cleanWrapCharacters (pCharacter, pString)
+	// Get the value of an element by its hash
+	getValueByHash (pObject, pHash)
 	{
-		if (pString.startsWith(pCharacter) && pString.endsWith(pCharacter))
+		if (this.elementHashes.hasOwnProperty(pHash))
 		{
-			return pString.substring(1, pString.length - 1);
+			return this.getValueAtAddress(pObject, this.elementHashes[pHash]);
 		}
 		else
 		{
-			return pString;
+			this.logError(`(${this.scope}) Error in getValueByHash; the Hash ${pHash} doesn't exist in the schema.`);
+			return undefined;
 		}
 	}
 
 	// Get the value of an element at an address
 	getValueAtAddress (pObject, pAddress)
 	{
-		// Make sure pObject is an object
-		if (!typeof(pObject) === 'object') return undefined;
-		// Make sure pAddress is a string
-		if (!typeof(pAddress) === 'string') return undefined;
-
-		// TODO: Make this work for things like SomeRootObject.Metadata["Some.People.Use.Bad.Object.Property.Names"]
-		let tmpSeparatorIndex = pAddress.indexOf('.');
-
-		// This is the terminal address string (no more dots so the RECUSION ENDS IN HERE somehow)
-		if (tmpSeparatorIndex === -1)
-		{
-			// Check if it's a boxed property
-			let tmpBracketStartIndex = pAddress.indexOf('[');
-			let tmpBracketStopIndex = pAddress.indexOf(']');
-			// Boxed elements look like this:
-			// 		MyValues[10]
-			// 		MyValues['Name']
-			// 		MyValues["Age"]
-			// 		MyValues[`Cost`]
-			//
-			// When we are passed SomeObject["Name"] this code below recurses as if it were SomeObject.Name
-			// The requirements to detect a boxed element are:
-			//    1) The start bracket is after character 0
-			if ((tmpBracketStartIndex > 0) 
-			//    2) The end bracket has something between them
-				&& (tmpBracketStopIndex > tmpBracketStartIndex) 
-			//    3) There is data 
-				&& (tmpBracketStopIndex - tmpBracketStartIndex > 0))
-			{
-				// The "Name" of the Object contained too the left of the bracket
-				let tmpBoxedPropertyName = pAddress.substring(0, tmpBracketStartIndex).trim();
-
-				// If the subproperty doesn't test as a proper Object, none of the rest of this is possible.
-				// This is a rare case where Arrays testing as Objects is useful
-				if (typeof(pObject[tmpBoxedPropertyName]) !== 'object')
-				{
-					return undefined;
-				}
-
-				// The "Reference" to the property within it, either an array element or object property
-				let tmpBoxedPropertyReference = pAddress.substring(tmpBracketStartIndex+1, tmpBracketStopIndex).trim();
-				// Attempt to parse the reference as a number, which will be used as an array element
-				let tmpBoxedPropertyNumber = parseInt(tmpBoxedPropertyReference, 10);
-
-				// Guard: If the referrant is a number and the boxed property is not an array, or vice versa, return undefined.
-				//        This seems confusing to me at first read, so explaination:
-				//        Is the Boxed Object an Array?  TRUE
-				//        And is the Reference inside the boxed Object not a number? TRUE
-				//        -->  So when these are in agreement, it's an impossible access state
-				if (Array.isArray(pObject[tmpBoxedPropertyName]) == isNaN(tmpBoxedPropertyNumber))
-				{
-					return undefined;
-				}
-
-				//    4) If the middle part is *only* a number (no single, double or backtick quotes) it is an array element,
-				//       otherwise we will try to treat it as a dynamic object property.
-				if (isNaN(tmpBoxedPropertyNumber))
-				{
-					// This isn't a number ... let's treat it as a dynamic object property.
-					// We would expect the property to be wrapped in some kind of quotes so strip them
-					tmpBoxedPropertyReference = this.cleanWrapCharacters('"', tmpBoxedPropertyReference);
-					tmpBoxedPropertyReference = this.cleanWrapCharacters('`', tmpBoxedPropertyReference);
-					tmpBoxedPropertyReference = this.cleanWrapCharacters("'", tmpBoxedPropertyReference);
-
-					// Return the value in the property
-					return pObject[tmpBoxedPropertyName][tmpBoxedPropertyReference];
-				}
-				else
-				{
-					return pObject[tmpBoxedPropertyName][tmpBoxedPropertyNumber];
-				}
-			}
-			else
-			{
-				// Now is the point in recursion to return the value in the address
-				return pObject[pAddress];
-			}
-		}
-		else
-		{
-			let tmpSubObjectName = pAddress.substring(0, tmpSeparatorIndex);
-			let tmpNewAddress = pAddress.substring(tmpSeparatorIndex+1);
-
-			// Test if the tmpNewAddress is an array or object
-			// Check if it's a boxed property
-			let tmpBracketStartIndex = tmpSubObjectName.indexOf('[');
-			let tmpBracketStopIndex = tmpSubObjectName.indexOf(']');
-			// Boxed elements look like this:
-			// 		MyValues[42]
-			// 		MyValues['Color']
-			// 		MyValues["Weight"]
-			// 		MyValues[`Diameter`]
-			//
-			// When we are passed SomeObject["Name"] this code below recurses as if it were SomeObject.Name
-			// The requirements to detect a boxed element are:
-			//    1) The start bracket is after character 0
-			if ((tmpBracketStartIndex > 0) 
-			//    2) The end bracket has something between them
-				&& (tmpBracketStopIndex > tmpBracketStartIndex) 
-			//    3) There is data 
-				&& (tmpBracketStopIndex - tmpBracketStartIndex > 0))
-			{
-				let tmpBoxedPropertyName = tmpSubObjectName.substring(0, tmpBracketStartIndex).trim();
-
-				let tmpBoxedPropertyReference = tmpSubObjectName.substring(tmpBracketStartIndex+1, tmpBracketStopIndex).trim();
-
-				let tmpBoxedPropertyNumber = parseInt(tmpBoxedPropertyReference, 10);
-
-				// Guard: If the referrant is a number and the boxed property is not an array, or vice versa, return undefined.
-				//        This seems confusing to me at first read, so explaination:
-				//        Is the Boxed Object an Array?  TRUE
-				//        And is the Reference inside the boxed Object not a number? TRUE
-				//        -->  So when these are in agreement, it's an impossible access state
-				// This could be a failure in the recursion chain because they passed something like this in:
-				//    StudentData.Sections.Algebra.Students[1].Tardy
-				//       BUT
-				//         StudentData.Sections.Algebra.Students[1] is an object, so the .Tardy is not possible to access
-				// This could be a failure in the recursion chain because they passed something like this in:
-				//    StudentData.Sections.Algebra.Students["JaneDoe"].Grade
-				//       BUT
-				//         StudentData.Sections.Algebra.Students["JaneDoe"] is an array, so the .Grade is not possible to access
-				// TODO: Should this be an error or something?  Should we keep a log of failures like this?
-				if (Array.isArray(pObject[tmpBoxedPropertyName]) == isNaN(tmpBoxedPropertyNumber))
-				{
-					return undefined;
-				}
-
-				//This is a bracketed value
-				//    4) If the middle part is *only* a number (no single, double or backtick quotes) it is an array element,
-				//       otherwise we will try to reat it as a dynamic object property.
-				if (isNaN(tmpBoxedPropertyNumber))
-				{
-					// This isn't a number ... let's treat it as a dynanmic object property.
-					tmpBoxedPropertyReference = this.cleanWrapCharacters('"', tmpBoxedPropertyReference);
-					tmpBoxedPropertyReference = this.cleanWrapCharacters('`', tmpBoxedPropertyReference);
-					tmpBoxedPropertyReference = this.cleanWrapCharacters("'", tmpBoxedPropertyReference);
-
-					// Recurse directly into the subobject
-					return this.getValueAtAddress(pObject[tmpBoxedPropertyName][tmpBoxedPropertyReference], tmpNewAddress);
-				}
-				else
-				{
-					// We parsed a valid number out of the boxed property name, so recurse into the array
-					return this.getValueAtAddress(pObject[tmpBoxedPropertyName][tmpBoxedPropertyNumber], tmpNewAddress);
-				}
-			}
-
-			// If there is an object property already named for the sub object, but it isn't an object
-			// then the system can't set the value in there.  Error and abort!
-			if (pObject.hasOwnProperty(tmpSubObjectName) && typeof(pObject[tmpSubObjectName]) !== 'object')
-			{
-				return undefined;
-			}
-			else if (pObject.hasOwnProperty(tmpSubObjectName))
-			{
-				// If there is already a subobject pass that to the recursive thingy
-				return this.getValueAtAddress(pObject[tmpSubObjectName], tmpNewAddress);
-			}
-			else
-			{
-				// Create a subobject and then pass that
-				pObject[tmpSubObjectName] = {};
-				return this.getValueAtAddress(pObject[tmpSubObjectName], tmpNewAddress);
-			}
-		}
+		return this.objectAddressResolver.getValueAtAddress(pObject, pAddress);
 	}
 
 	// Set the value of an element by its hash
@@ -386,79 +247,13 @@ class Manyfest
 		}
 	}
 
+
 	// Set the value of an element at an address
 	setValueAtAddress (pObject, pAddress, pValue)
 	{
-		// Make sure pObject is an object
-		if (!typeof(pObject) === 'object') return false;
-		// Make sure pAddress is a string
-		if (!typeof(pAddress) === 'string') return false;
-
-		let tmpSeparatorIndex = pAddress.indexOf('.');
-
-		if (tmpSeparatorIndex === -1)
-		{
-			// Now is the time to set the value in the object
-			pObject[pAddress] = pValue;
-			return true;
-		}
-		else
-		{
-			let tmpSubObjectName = pAddress.substring(0, tmpSeparatorIndex);
-			let tmpNewAddress = pAddress.substring(tmpSeparatorIndex+1);
-
-			// If there is an object property already named for the sub object, but it isn't an object
-			// then the system can't set the value in there.  Error and abort!
-			if (pObject.hasOwnProperty(tmpSubObjectName) && typeof(pObject[tmpSubObjectName]) !== 'object')
-			{
-				if (!pObject.hasOwnProperty('__ERROR'))
-					pObject['__ERROR'] = {};
-				// Put it in an error object so data isn't lost
-				pObject['__ERROR'][pAddress] = pValue;
-				return false;
-			}
-			else if (pObject.hasOwnProperty(tmpSubObjectName))
-			{
-				// If there is already a subobject pass that to the recursive thingy
-				return this.setValueAtAddress(pObject[tmpSubObjectName], tmpNewAddress, pValue);
-			}
-			else
-			{
-				// Create a subobject and then pass that
-				pObject[tmpSubObjectName] = {};
-				return this.setValueAtAddress(pObject[tmpSubObjectName], tmpNewAddress, pValue);
-			}
-		}
-	}
-
-	setValueAtAddressInContainer(pRecordObject, pFormContainerAddress, pFormContainerIndex, pFormValueAddress, pFormValue)
-	{
-		// First see if there *is* a container object
-		let tmpContainerObject = this.getValueAtAddress(pRecordObject, pFormContainerAddress);
-
-		if (typeof(pFormContainerAddress) !== 'string') return false;
-
-		let tmpFormContainerIndex = parseInt(pFormContainerIndex, 10);
-		if (isNaN(tmpFormContainerIndex)) return false;
-
-		if ((typeof(tmpContainerObject) !== 'object') || (!Array.isArray(tmpContainerObject)))
-		{
-			// Check if there is a value here and we want to store it in the "__OverwrittenData" thing
-			tmpContainerObject = [];
-			this.setValueAtAddress(pRecordObject, pFormContainerAddress, tmpContainerObject);
-		}
-
-		for (let i = 0; (tmpContainerObject.length + i) <= (tmpFormContainerIndex+1); i++)
-		{
-			// Add objects to this container until it has enough
-			tmpContainerObject.push({});
-		}
-
-		// Now set the value *in* the container object
-		return this.setValueAtAddress(tmpContainerObject[tmpFormContainerIndex], pFormValueAddress, pFormValue);
+		return this.objectAddressResolver.setValueAtAddress(pObject, pAddress, pValue);
 	}
 
-
 	// Validate the consistency of an object against the schema
 	validate(pObject)
 	{
@@ -475,7 +270,13 @@ class Manyfest
 			tmpValidationData.Errors.push(`Expected passed in object to be type object but was passed in ${typeof(pObject)}`);
 		}
 
-		// Now enumerate through the values and check for anomalies
+		let addValidationError = (pAddress, pErrorMessage) =>
+		{
+			tmpValidationData.Error = true;
+			tmpValidationData.Errors.push(`Element at address "${pAddress}" ${pErrorMessage}.`);
+		};
+
+		// Now enumerate through the values and check for anomalies based on the schema
 		for (let i = 0; i < this.elementAddresses.length; i++)
 		{
 			let tmpDescriptor = this.getDescriptor(this.elementAddresses[i]);
@@ -483,18 +284,144 @@ class Manyfest
 
 			if (typeof(tmpValue) == 'undefined')
 			{
+				// This will technically mean that `Object.Some.Value = undefined` will end up showing as "missing"
+				// TODO: Do we want to do a different message based on if the property exists but is undefined?
 				tmpValidationData.MissingElements.push(tmpDescriptor.Address);
-
 				if (tmpDescriptor.Required || this.options.strict)
 				{
-					tmpValidationData.Error = true;
-					tmpValidationData.Errors.push(`Element at address '${tmpDescriptor.Address}' is flagged Required but is not present.`);
+					addValidationError(tmpDescriptor.Address, 'is flagged REQUIRED but is not set in the object');
+				}
+			}
+
+			// Now see if there is a data type specified for this element
+			if (tmpDescriptor.DataType)
+			{
+				let tmpElementType = typeof(tmpValue);
+				switch(tmpDescriptor.DataType.toString().trim().toLowerCase())
+				{
+					case 'string':
+						if (tmpElementType != 'string')
+						{
+							addValidationError(tmpDescriptor.Address, `has a DataType ${tmpDescriptor.DataType} but is of the type ${tmpElementType}`);
+						}
+						break;
+
+					case 'number':
+						if (tmpElementType != 'number')
+						{
+							addValidationError(tmpDescriptor.Address, `has a DataType ${tmpDescriptor.DataType} but is of the type ${tmpElementType}`);
+						}
+						break;
+
+					case 'integer':
+						if (tmpElementType != 'number')
+						{
+							addValidationError(tmpDescriptor.Address, `has a DataType ${tmpDescriptor.DataType} but is of the type ${tmpElementType}`);
+						}
+						else
+						{
+							let tmpValueString = tmpValue.toString();
+							if (tmpValueString.indexOf('.') > -1)
+							{
+								// TODO: Is this an error?
+								addValidationError(tmpDescriptor.Address, `has a DataType ${tmpDescriptor.DataType} but has a decimal point in the number.`);
+							}
+						}
+						break;
+
+					case 'float':
+						if (tmpElementType != 'number')
+						{
+							addValidationError(tmpDescriptor.Address, `has a DataType ${tmpDescriptor.DataType} but is of the type ${tmpElementType}`);
+						}
+						break;
+
+					case 'DateTime':
+						let tmpValueDate = new Date(tmpValue);
+						if (tmpValueDate.toString() == 'Invalid Date')
+						{
+							addValidationError(tmpDescriptor.Address, `has a DataType ${tmpDescriptor.DataType} but is not parsable as a Date by Javascript`);
+						}
+	
+					default:
+						// Check if this is a string, in the default case
+						// Note this is only when a DataType is specified and it is an unrecognized data type.
+						if (tmpElementType != 'string')
+						{
+							addValidationError(tmpDescriptor.Address, `has a DataType ${tmpDescriptor.DataType} (which auto-converted to String because it was unrecognized) but is of the type ${tmpElementType}`);
+						}
+						break;
 				}
 			}
 		}
 
 		return tmpValidationData;
 	}
+
+	// Returns a default value, or, the default value for the data type (which is overridable with configuration)
+	getDefaultValue(pDescriptor)
+	{
+		if (pDescriptor.hasOwnProperty('Default'))
+		{
+			return pDescriptor.Default;
+		}
+		else
+		{
+			// Default to a null if it doesn't have a type specified.
+			// This will ensure a placeholder is created but isn't misinterpreted.
+			let tmpDataType = (pDescriptor.hasOwnProperty('DataType')) ? pDescriptor.DataType : 'String';
+			if (this.options.defaultValues.hasOwnProperty(tmpDataType))
+			{
+				return this.options.defaultValues[tmpDataType];
+			}
+			else
+			{
+				// give up and return null
+				return null;
+			}
+		}
+	}
+
+	// Enumerate through the schema and populate default values if they don't exist.
+	populateDefaults(pObject, pOverwriteProperties)
+	{
+		return this.populateObject(pObject, pOverwriteProperties,
+			// This just sets up a simple filter to see if there is a default set.
+			(pDescriptor) =>
+			{
+				return pDescriptor.hasOwnProperty('Default');
+			});
+	}
+
+	// Forcefully populate all values even if they don't have defaults.
+	// Based on type, this can do unexpected things.
+	populateObject(pObject, pOverwriteProperties, fFilter)
+	{
+		// Automatically create an object if one isn't passed in.
+		let tmpObject = (typeof(pObject) === 'object') ? pObject : {};
+		// Default to *NOT OVERWRITING* properties
+		let tmpOverwriteProperties = (typeof(pOverwriteProperties) == 'undefined') ? false : pOverwriteProperties;
+		// This is a filter function, which is passed the schema and allows complex filtering of population
+		// The default filter function just returns true, populating everything.
+		let tmpFilterFunction = (typeof(fFilter) == 'function') ? fFilter : (pDescriptor) => { return true; };
+
+		this.elementAddresses.forEach(
+			(pAddress) =>
+			{
+				let tmpDescriptor = this.getDescriptor(pAddress);
+				// Check the filter function to see if this is an address we want to set the value for.
+				if (tmpFilterFunction(tmpDescriptor))
+				{
+					// If we are overwriting properties OR the property does not exist
+					if (tmpOverwriteProperties || !this.checkAddressExists(tmpObject, pAddress))
+					{
+						this.setValueAtAddress(tmpObject, pAddress, this.getDefaultValue(tmpDescriptor));
+					}
+				}
+			});
+
+		return tmpObject;
+	}
 };
 
 module.exports = Manyfest;

package/test/Manyfest_Object_CheckExistence_tests.js

@@ -0,0 +1,70 @@
+/**
+* Unit tests for Meadow
+*
+* @license     MIT
+*
+* @author      Steven Velozo <steven@velozo.com>
+*/
+
+var Chai = require("chai");
+var Expect = Chai.expect;
+
+let libManyfest = require('../source/Manyfest.js');
+
+let _SampleDataArchiveOrgFrankenberry = require('./Data-Archive-org-Frankenberry.json');
+
+suite
+(
+	'Manyfest Object Check Element Existence',
+	function()
+	{
+		setup (()=> {} );
+
+		suite
+		(
+			'Basic Check Existence',
+			()=>
+			{
+				test
+				(
+					'It should be easy to check if an element exists by address.',
+					(fTestComplete)=>
+					{
+						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
+						// Property not in schema:
+						let tmpTitleExists = _Manyfest.checkAddressExists(_SampleDataArchiveOrgFrankenberry, 'metadata.title');
+						Expect(tmpTitleExists)
+							.to.equal(true);
+						fTestComplete();
+					}
+				);
+				test
+				(
+					'If an element does not exist, checkAddressExists should return false.',
+					(fTestComplete)=>
+					{
+						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
+						// Property not in schema:
+						let tmpTitleExists = _Manyfest.checkAddressExists(_SampleDataArchiveOrgFrankenberry, 'metadata.someStrangeProperty');
+						Expect(tmpTitleExists)
+							.to.equal(false);
+						fTestComplete();
+					}
+				);
+				test
+				(
+					'It should be trivial to access subproperties with a schema by hash.',
+					(fTestComplete)=>
+					{
+						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
+						// Property not schema, accessed by hash:
+						let tmpCreator = _Manyfest.checkAddressExistsByHash(_SampleDataArchiveOrgFrankenberry, 'Creator');
+						Expect(tmpCreator)
+							.to.equal(true);
+						fTestComplete();
+					}
+				);
+			}
+		);
+	}
+);