www

commit 1535839eb77d49bc6256e35f70ada3635ecfc677
parent e34c9e04e8dcd457066f5f7c3760035ba68a27ff
Author: Dan Stillman <dstillman@zotero.org>
Date:   Thu, 22 Sep 2016 00:43:20 -0400

Merge pull request #1096 from adomasven/fix/tag-translation-breakage

Fix nested translators that rely on child translator tags
Diffstat:
M
chrome/content/zotero/xpcom/translation/translate.js
 | 
21
+++++++++++++--------
M
test/content/support.js
 | 
7
++++---
M
test/tests/translateTest.js
 | 
43
+++++++++++++++++++++++++++++++++++++++++++

3 files changed, 60 insertions(+), 11 deletions(-)
diff --git a/chrome/content/zotero/xpcom/translation/translate.js b/chrome/content/zotero/xpcom/translation/translate.js
@@ -127,8 +127,10 @@ Zotero.Translate.Sandbox = {
 				}
 			}
 
-			// Canonicalize tags
-			if(item.tags) item.tags = translate._cleanTags(item.tags);
+			// If we're not in a child translator, canonicalize tags
+			if (!translate._parentTranslator) {
+				if(item.tags) item.tags = translate._cleanTags(item.tags);
+			}
 			
 			// if we're not supposed to save the item or we're in a child translator,
 			// just return the item array
@@ -158,8 +160,10 @@ Zotero.Translate.Sandbox = {
 						delete attachment.document;
 					}
 
-					// Canonicalize tags
-					if(attachment.tags !== undefined) attachment.tags = translate._cleanTags(attachment.tags);
+					// If we're not in a child translator, canonicalize tags
+					if (!translate._parentTranslator) {
+						if(attachment.tags !== undefined) attachment.tags = translate._cleanTags(attachment.tags);
+					}
 				}
 			}
 
@@ -169,13 +173,14 @@ Zotero.Translate.Sandbox = {
 					var note = notes[j];
 					if(!note) {
 						notes.splice(j--, 1);
-					} else if(typeof(note) == "object") {
-						// Canonicalize tags
-						if(note.tags !== undefined) note.tags = translate._cleanTags(note.tags);
-					} else {
+					} else if(typeof(note) != "object") {
 						// Convert to object
 						notes[j] = {"note":note.toString()}
 					}
+					// If we're not in a child translator, canonicalize tags
+					if (!translate._parentTranslator) {
+						if(note.tags !== undefined) note.tags = translate._cleanTags(note.tags);
+					}
 				}
 			}
 
diff --git a/test/content/support.js b/test/content/support.js
@@ -757,10 +757,10 @@ var generateTranslatorExportData = Zotero.Promise.coroutine(function* generateTr
 /**
  * Build a dummy translator that can be passed to Zotero.Translate
  */
-function buildDummyTranslator(translatorType, code) {
+function buildDummyTranslator(translatorType, code, translatorID="dummy-translator") {
 	let info = {
-		"translatorID":"dummy-translator",
-		"translatorType":1, // import
+		"translatorID":translatorID,
+		"translatorType":translatorType,
 		"label":"Dummy Translator",
 		"creator":"Simon Kornblith",
 		"target":"",
@@ -771,6 +771,7 @@ function buildDummyTranslator(translatorType, code) {
 	};
 	let translator = new Zotero.Translator(info);
 	translator.code = code;
+	translator.getCode = function() {return Promise.resolve(code)};
 	return translator;
 }
 
diff --git a/test/tests/translateTest.js b/test/tests/translateTest.js
@@ -551,6 +551,49 @@ describe("Zotero.Translate", function() {
 			assert.equal(pdf.attachmentLinkMode, Zotero.Attachments.LINK_MODE_IMPORTED_URL);
 			checkTestTags(pdf, true);
 		});
+		
+		it('should not convert tags to canonical form in child translators', function* () {
+			var childTranslator = buildDummyTranslator(1, 
+				`function detectWeb() {}
+				function doImport() {
+					var item = new Zotero.Item;
+					item.itemType = "book";
+					item.title = "The Definitive Guide of Owls";
+					item.tags = ['owl', 'tag'];
+					item.complete();
+				}`, 'child-dummy-translator'
+			);
+			sinon.stub(Zotero.Translators, 'get').withArgs('child-dummy-translator').returns(childTranslator);
+			
+			var parentTranslator = buildDummyTranslator(1,
+				`function detectWeb() {}
+				function doImport() {
+					var translator = Zotero.loadTranslator("import");
+					translator.setTranslator('child-dummy-translator');
+					translator.setHandler('itemDone', Zotero.childItemDone);
+					translator.translate();
+				}`
+			);
+			
+			function childItemDone(obj, item) {
+				// Non-canonical tags after child translator is done
+				assert.deepEqual(['owl', 'tag'], item.tags);
+				item.complete();
+			}
+			
+			var translate = new Zotero.Translate.Import();
+			translate.setTranslator(parentTranslator);
+			translate.setString("");
+			yield translate._loadTranslator(parentTranslator);
+			translate._sandboxManager.importObject({childItemDone});
+			
+			var items = yield translate.translate();
+			
+			// Canonicalized tags after parent translator
+			assert.deepEqual([{tag: 'owl'}, {tag: 'tag'}], items[0].getTags());
+			
+			Zotero.Translators.get.restore();
+		});
 	});
 });