manyfest 1.0.4 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "manyfest",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "JSON Object Manifest for Data Description and Parsing",
   "main": "source/Manyfest.js",
   "scripts": {

package/source/Manyfest-SchemaManipulation.js

@@ -107,6 +107,32 @@ class ManyfestSchemaManipulation
 		this.resolveAddressMappings(tmpManyfestSchemaDescriptors, pAddressMapping);
 		return tmpManyfestSchemaDescriptors;
 	}
+
+	mergeAddressMappings(pManyfestSchemaDescriptorsDestination, pManyfestSchemaDescriptorsSource)
+	{
+		if ((typeof(pManyfestSchemaDescriptorsSource) != 'object') || (typeof(pManyfestSchemaDescriptorsDestination) != 'object'))
+		{
+			this.logError(`Attempted to merge two schema descriptors but both were not objects.`);
+			return false;
+		}
+
+		let tmpSource = JSON.parse(JSON.stringify(pManyfestSchemaDescriptorsSource));
+		let tmpNewManyfestSchemaDescriptors = JSON.parse(JSON.stringify(pManyfestSchemaDescriptorsDestination));
+
+		// The first passed-in set of descriptors takes precedence.
+		let tmpDescriptorAddresses = Object.keys(tmpSource);
+
+		tmpDescriptorAddresses.forEach(
+			(pDescriptorAddress) => 
+			{
+				if (!tmpNewManyfestSchemaDescriptors.hasOwnProperty(pDescriptorAddress))
+				{
+					tmpNewManyfestSchemaDescriptors[pDescriptorAddress] = tmpSource[pDescriptorAddress];
+				}
+			});
+		
+		return tmpNewManyfestSchemaDescriptors;
+	}
 }
 
 module.exports = ManyfestSchemaManipulation;

package/source/Manyfest.js

@@ -71,6 +71,19 @@ class Manyfest
 		this.elementDescriptors = {};
 	}
 
+	clone()
+	{
+		// Make a copy of the options in-place
+		let tmpNewOptions = JSON.parse(JSON.stringify(this.options));
+
+		let tmpNewManyfest = new Manyfest(this.getManifest(), this.logInfo, this.logError, tmpNewOptions);
+
+		// Import the hash translations
+		tmpNewManyfest.hashTranslations.addTranslation(this.hashTranslations.translationTable);
+
+		return tmpNewManyfest;
+	}
+
 	// Deserialize a Manifest from a string
 	deserialize(pManifestString)
 	{
@@ -125,6 +138,7 @@ class Manyfest
 	}
 
 	// Serialize the Manifest to a string
+	// TODO: Should this also serialize the translation table?
 	serialize()
 	{
 		return JSON.stringify(this.getManifest());
@@ -132,7 +146,7 @@ class Manyfest
 
 	getManifest()
 	{
-		let tmpManifest = (
+		return (
 			{
 				Scope: this.scope,
 				Descriptors: JSON.parse(JSON.stringify(this.elementDescriptors))
@@ -183,15 +197,7 @@ class Manyfest
 
 	getDescriptorByHash(pHash)
 	{
-		if (this.elementHashes.hasOwnProperty(pHash) || this.hashTranslations.translationTable.hasOwnProperty(pHash))
-		{
-			return this.getDescriptor(this.elementHashes[this.hashTranslations.translate(pHash)]);
-		}
-		else
-		{
-			this.logError(`(${this.scope}) Error in getDescriptorByHash; the Hash ${pHash} doesn't exist in the schema.`);
-			return undefined;
-		}
+		return this.getDescriptor(this.resolveHashAddress(pHash));
 	}
 
 	getDescriptor(pAddress)
@@ -205,15 +211,7 @@ class Manyfest
 	// Check if an element exists by its hash
 	checkAddressExistsByHash (pObject, pHash)
 	{
-		if (this.elementHashes.hasOwnProperty(pHash) || this.hashTranslations.translationTable.hasOwnProperty(pHash))
-		{
-			return this.checkAddressExists(pObject, this.elementHashes[this.hashTranslations.translate(pHash)]);
-		}
-		else
-		{
-			this.logError(`(${this.scope}) Error in checkAddressExistsByHash; the Hash ${pHash} doesn't exist in the schema.`);
-			return undefined;
-		}
+		return this.checkAddressExists(pObject,this.resolveHashAddress(pHash));
 	}
 
 	// Check if an element exists at an address
@@ -222,19 +220,43 @@ class Manyfest
 		return this.objectAddressResolver.checkAddressExists(pObject, pAddress);
 	}
 
-
-	// Get the value of an element by its hash
-	getValueByHash (pObject, pHash)
+	// Turn a hash into an address, factoring in the translation table.
+	resolveHashAddress(pHash)
 	{
-		if (this.elementHashes.hasOwnProperty(pHash) || this.hashTranslations.translationTable.hasOwnProperty(pHash))
+		let tmpAddress = undefined;
+
+		let tmpInElementHashTable = this.elementHashes.hasOwnProperty(pHash);
+		let tmpInTranslationTable = this.hashTranslations.translationTable.hasOwnProperty(pHash);
+
+		// The most straightforward: the hash exists, no translations.
+		if (tmpInElementHashTable && !tmpInTranslationTable)
+		{
+			tmpAddress = this.elementHashes[pHash];
+		}
+		// There is a translation from one hash to another, and, the elementHashes contains the pointer end
+		else if (tmpInTranslationTable && this.elementHashes.hasOwnProperty(this.hashTranslations.translate(pHash)))
 		{
-			return this.getValueAtAddress(pObject, this.elementHashes[this.hashTranslations.translate(pHash)]);
+			tmpAddress = this.elementHashes[this.hashTranslations.translate(pHash)];
 		}
+		// Use the level of indirection only in the Translation Table 
+		else if (tmpInTranslationTable)
+		{
+			tmpAddress = this.hashTranslations.translate(pHash);
+		}
+		// Just treat the hash as an address.
+		// TODO: Discuss this ... it is magic but controversial
 		else
 		{
-			this.logError(`(${this.scope}) Error in getValueByHash; the Hash ${pHash} doesn't exist in the schema.`);
-			return undefined;
+			tmpAddress = pHash;
 		}
+
+		return tmpAddress;
+	}
+
+	// Get the value of an element by its hash
+	getValueByHash (pObject, pHash)
+	{
+		return this.getValueAtAddress(pObject, this.resolveHashAddress(pHash));
 	}
 
 	// Get the value of an element at an address
@@ -246,15 +268,7 @@ class Manyfest
 	// Set the value of an element by its hash
 	setValueByHash(pObject, pHash, pValue)
 	{
-		if (this.elementHashes.hasOwnProperty(pHash) || this.hashTranslations.translationTable.hasOwnProperty(pHash))
-		{
-			return this.setValueAtAddress(pObject, this.elementHashes[this.hashTranslations.translate(pHash)], pValue);
-		}
-		else
-		{
-			this.logError(`(${this.scope}) Error in setValueByHash; the Hash ${pHash} doesn't exist in the schema.  Value ${pValue} will not be written!`);
-			return undefined;
-		}
+		return this.setValueAtAddress(pObject, this.resolveHashAddress(pHash), pValue);
 	}
 
 

package/test/Manyfest_Object_HashTranslation_tests.js

@@ -147,6 +147,22 @@ suite
 					}
 				);
 				test
+				(
+					'Translate to a value not in the hashes, falling back to address.',
+					(fTestComplete)=>
+					{
+						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
+						// Create a translation between "Creator" and "metadata.identifier", which isn't in the manifest in any way 
+						_Manyfest.hashTranslations.addTranslation({"Creator":"metadata.identifier"});
+						// This address is not in the descriptor address list or the hash list
+						Expect(_Manyfest.getValueAtAddress(_SampleDataArchiveOrgFrankenberry, 'metadata.identifier')).to.equal('FrankenberryCountChoculaTevevisionCommercial1971');
+						// But now we've pointed the Creator hash to it!
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator')).to.equal('FrankenberryCountChoculaTevevisionCommercial1971');
+							
+						fTestComplete();
+					}
+				);
+				test
 				(
 					'Add a bogus translation.',
 					(fTestComplete)=>

package/test/Manyfest_Object_SchemaManipulation_tests.js

@@ -84,6 +84,116 @@ suite
 						Expect(tmpNewSchemaDescriptors.CarrotCost.Hash).to.equal('a');
 						Expect(tmpNewSchemaDescriptors.AppleCost.Hash).to.equal('b');
 
+						fTestComplete();
+					}
+				);
+				test
+				(
+					'We should be able to merge properties safely.',
+					(fTestComplete)=>
+					{
+						let tmpSchemaDescriptors = (
+							{
+								"a": { "Hash": "a", "Type": "Number" },
+								"b": { "Hash": "b", "Type": "Number" }
+							});
+						
+						let tmpSchemaDescriptorsToMerge = (
+							{
+								"c": { "Hash": "c" },
+								"d": { "Hash": "d" },
+								"e": { "Hash": "e" },
+								"a": { "Hash": "ARBUCKLE", "Type": "Number" }
+							});
+						
+						Expect(tmpSchemaDescriptors.a.Hash).to.equal('a');
+
+						let _Manyfest = new libManyfest();
+						// Now remap the schema (in-place)
+						let tmpNewSchemaDescriptors = _Manyfest.schemaManipulations.mergeAddressMappings(tmpSchemaDescriptors, tmpSchemaDescriptorsToMerge);
+
+						// The schema should be safe
+						Expect(tmpNewSchemaDescriptors.a.Hash).to.equal('a');
+						// And a new schema should have been created with the alterations
+						Expect(tmpNewSchemaDescriptors.b.Hash).to.equal('b');
+						Expect(tmpNewSchemaDescriptors.c.Hash).to.equal('c');
+
+						fTestComplete();
+					}
+				);
+				test
+				(
+					'Cloning should work.',
+					(fTestComplete)=>
+					{
+						let tmpSchemaDescriptors = (
+							{
+								"a": { "Hash": "a", "Type": "Number" },
+								"b": { "Hash": "b", "Type": "Number" }
+							});
+
+						let tmpTranslationTable = (
+							{
+								"a": "CarrotCost",
+								"b": "AppleCost"
+							});
+						
+						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
+						// Property not schema, accessed by hash:
+						let tmpCreator = _Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator');
+						Expect(tmpCreator).to.equal('General Mills');
+						let _ClonedManyfest = _Manyfest.clone();
+						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator')).to.equal('General Mills');
+	
+						fTestComplete();
+					}
+				);
+				test
+				(
+					'Cloning should take into account translation.',
+					(fTestComplete)=>
+					{
+						let tmpSchemaDescriptors = (
+							{
+								"a": { "Hash": "a", "Type": "Number" },
+								"b": { "Hash": "b", "Type": "Number" }
+							});
+
+						let tmpTranslationTable = (
+							{
+								"a": "CarrotCost",
+								"b": "AppleCost"
+							});
+						
+						let _Manyfest = new libManyfest({ Scope:'Archive.org', Descriptors: {'metadata.creator': {Name:'Creator', Hash:'Creator'}}});
+						// Property not schema, accessed by hash:
+						let tmpCreator = _Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator');
+						Expect(tmpCreator).to.equal('General Mills');
+						// Create a translation between "Creator" and "Director" as well as "Author"
+						_Manyfest.hashTranslations.addTranslation({"Director":"Creator", "Author":"Creator", "Songwriter":"Creator"});
+						Expect(tmpCreator).to.equal('General Mills');
+						// Director should also work
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal('General Mills');
+						// And Author!
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Author')).to.equal('General Mills');
+						// Now remove Director
+						_Manyfest.hashTranslations.clearTranslations();
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Author')).to.equal(undefined);
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal(undefined);
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Songwriter')).to.equal(undefined);
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator')).to.equal('General Mills');
+
+						let _ClonedManyfest = _Manyfest.clone();
+						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Author')).to.equal(undefined);
+						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal(undefined);
+						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Songwriter')).to.equal(undefined);
+						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Creator')).to.equal('General Mills');
+
+						// New translations should not affect the old manyfest
+						_ClonedManyfest.hashTranslations.addTranslation({"Director":"Creator", "Author":"Creator", "Songwriter":"Creator"});
+						Expect(_ClonedManyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal('General Mills');
+						Expect(_Manyfest.getValueByHash(_SampleDataArchiveOrgFrankenberry, 'Director')).to.equal(undefined);
+	
 						fTestComplete();
 					}
 				);