describe("Zotero.Utilities", function() { describe("cleanAuthor", function() { it('should parse author names', function() { for(let useComma of [false, true]) { for(let first_expected of [["First", "First"], ["First Middle", "First Middle"], ["F. R. S.", "F. R. S."], ["F.R.S.", "F. R. S."], ["F R S", "F. R. S."], ["FRS", "F. R. S."]]) { let [first, expected] = first_expected; let str = useComma ? "Last, "+first : first+" Last"; let author = Zotero.Utilities.cleanAuthor(str, "author", useComma); assert.equal(author.firstName, expected); assert.equal(author.lastName, "Last"); } } }); it('should not parse words starting with symbols as last name', function() { let author = Zotero.Utilities.cleanAuthor('First Middle Last [CountryName]', false); assert.equal(author.firstName, 'First Middle'); // Brackets at the beginning and end of a string get removed for strings // such as [First Last] -> Last, First. // The current output is not ideal, but better than "[CountryName, First Middle Last" assert.equal(author.lastName, 'Last [CountryName'); }); it('should parse names starting with unicode characters correctly', function() { let author = Zotero.Utilities.cleanAuthor('Ąžuolas Žolynas', false); assert.equal(author.firstName, 'Ąžuolas'); assert.equal(author.lastName, 'Žolynas'); }) }); describe("#cleanDOI()", function () { var cleanDOI = Zotero.Utilities.cleanDOI; var doi = '10.1088/1748-9326/11/4/048002'; var shortDOI = '10/aabbe'; it("should parse a DOI", function () { assert.equal(cleanDOI(`${doi}`), doi); }); it("should parse a short DOI", function () { assert.equal(cleanDOI(`${shortDOI}`), shortDOI); }); it("should parse a DOI at the end of a sentence", function () { assert.equal(cleanDOI(`Foo bar ${doi}. Foo bar`), doi); }); // FIXME it.skip("should parse a DOI in parentheses", function () { assert.equal(cleanDOI(`Foo bar (${doi}) foo bar`), doi); }); // FIXME it.skip("should parse a DOI in brackets", function () { assert.equal(cleanDOI(`Foo bar [${doi}] foo bar`), doi); }); }); describe("#cleanISBN()", function() { let cleanISBN = Zotero.Utilities.cleanISBN; it("should return false for non-ISBN string", function() { assert.isFalse(cleanISBN(''), 'returned false for empty string'); assert.isFalse(cleanISBN('Random String 123'), 'returned false for non-ISBN string'); assert.isFalse(cleanISBN('1234X67890'), 'returned false for ISBN10-looking string with X in the middle'); assert.isFalse(cleanISBN('987123456789X'), 'returned false for ISBN13-looking string with X as check-digit'); }); it("should return false for invalid ISBN string", function() { assert.isFalse(cleanISBN('1234567890'), 'returned false for invalid ISBN10'); assert.isFalse(cleanISBN('9871234567890'), 'returned false for invalid ISBN13'); }); it("should return valid ISBN string given clean, valid ISBN string", function() { assert.equal(cleanISBN('123456789X'), '123456789X', 'passed through valid ISBN10'); assert.equal(cleanISBN('123456789x'), '123456789X', 'passed through valid ISBN10 with lower case input'); assert.equal(cleanISBN('9781234567897'), '9781234567897', 'passed through valid ISBN13'); assert.equal(cleanISBN('9791843123391'), '9791843123391', 'passed through valid ISBN13 in 979 range'); }); it("should strip off internal characters in ISBN string", function() { let ignoredChars = '\x2D\xAD\u2010\u2011\u2012\u2013\u2014\u2015\u2043\u2212' // Dashes + ' \xA0\r\n\t\x0B\x0C\u1680\u2000\u2001\u2002\u2003\u2004\u2005' // Spaces + '\u2006\u2007\u2008\u2009\u200A\u2028\u2029\u202F\u205F\u3000\uFEFF'; for (let i=0; iISBN:978-1 234\xA056789 - 7(print)\nISBN-10:123\x2D456789X (print)'), '9781234567897'); }); it("should not validate check digit when dontValidate is set", function() { assert.equal(cleanISBN('9781234567890', true), '9781234567890', 'plain ISBN13 with wrong check digit'); assert.equal(cleanISBN('1234567890', true), '1234567890', 'plain ISBN10 with wrong check digit'); assert.equal(cleanISBN('1234567890 9781234567897', true), '1234567890', 'returned first ISBN10 (invalid) in the list with valid and invalid ISBNs'); assert.equal(cleanISBN('9781234567890 123456789X', true), '9781234567890', 'returned first ISBN13 (invalid) in the list with valid and invalid ISBNs'); }); it("should not pass non-ISBN strings if dontValidate is set", function() { assert.isFalse(cleanISBN('', true), 'returned false for empty string'); assert.isFalse(cleanISBN('Random String 123', true), 'returned false for non-ISBN string'); assert.isFalse(cleanISBN('1234X67890', true), 'returned false for ISBN10-looking string with X in the middle'); assert.isFalse(cleanISBN('123456789Y', true), 'returned false for ISBN10-looking string with Y as check digit'); assert.isFalse(cleanISBN('987123456789X', true), 'returned false for ISBN13-looking string with X as check-digit'); assert.isFalse(cleanISBN('1239781234567897', true), 'did not ignore number prefix'); assert.isFalse(cleanISBN('9781234567897123', true), 'did not ignore number suffix'); assert.isFalse(cleanISBN('1239781234567897123', true), 'did not ignore surrounding numbers'); }); }); describe("toISBN13", function() { let toISBN13 = Zotero.Utilities.toISBN13; it("should throw on invalid ISBN", function() { let errorMsg = 'ISBN not found in "', invalidStrings = ['', 'random string', '1234567890123']; for (let i=0; iISSN:1234\xA0-\t5679(print)\neISSN (electronic):0028-0836'), '1234-5679'); }); }); describe("itemToCSLJSON", function() { it("should accept Zotero.Item and Zotero export item format", Zotero.Promise.coroutine(function* () { let data = yield populateDBWithSampleData(loadSampleData('journalArticle')); let item = yield Zotero.Items.getAsync(data.journalArticle.id); let fromZoteroItem; try { fromZoteroItem = Zotero.Utilities.itemToCSLJSON(item); } catch(e) { assert.fail(e, null, 'accepts Zotero Item'); } assert.isObject(fromZoteroItem, 'converts Zotero Item to object'); assert.isNotNull(fromZoteroItem, 'converts Zotero Item to non-null object'); let fromExportItem; try { fromExportItem = Zotero.Utilities.itemToCSLJSON( Zotero.Utilities.Internal.itemToExportFormat(item) ); } catch(e) { assert.fail(e, null, 'accepts Zotero export item'); } assert.isObject(fromExportItem, 'converts Zotero export item to object'); assert.isNotNull(fromExportItem, 'converts Zotero export item to non-null object'); assert.deepEqual(fromZoteroItem, fromExportItem, 'conversion from Zotero Item and from export item are the same'); })); it("should convert standalone notes to expected format", Zotero.Promise.coroutine(function* () { let note = new Zotero.Item('note'); note.setNote('Some note longer than 50 characters, which will become the title.'); yield note.saveTx(); let cslJSONNote = Zotero.Utilities.itemToCSLJSON(note); assert.equal(cslJSONNote.type, 'article', 'note is exported as "article"'); assert.equal(cslJSONNote.title, note.getNoteTitle(), 'note title is set to Zotero pseudo-title'); })); it("should convert standalone attachments to expected format", Zotero.Promise.coroutine(function* () { let file = getTestDataDirectory(); file.append("empty.pdf"); let attachment = yield Zotero.Attachments.importFromFile({"file":file}); attachment.setField('title', 'Empty'); attachment.setField('accessDate', '2001-02-03 12:13:14'); attachment.setField('url', 'http://example.com'); attachment.setNote('Note'); yield attachment.saveTx(); let cslJSONAttachment = Zotero.Utilities.itemToCSLJSON(attachment); assert.equal(cslJSONAttachment.type, 'article', 'attachment is exported as "article"'); assert.equal(cslJSONAttachment.title, 'Empty', 'attachment title is correct'); assert.deepEqual(cslJSONAttachment.accessed, {"date-parts":[["2001",2,3]]}, 'attachment access date is mapped correctly'); })); it("should refuse to convert unexpected item types", Zotero.Promise.coroutine(function* () { let data = yield populateDBWithSampleData(loadSampleData('journalArticle')); let item = yield Zotero.Items.getAsync(data.journalArticle.id); let exportFormat = Zotero.Utilities.Internal.itemToExportFormat(item); exportFormat.itemType = 'foo'; assert.throws(Zotero.Utilities.itemToCSLJSON.bind(Zotero.Utilities, exportFormat), /^Unexpected Zotero Item type ".*"$/, 'throws an error when trying to map invalid item types'); })); it("should parse particles in creator names", function* () { let creators = [ { // No particles firstName: 'John', lastName: 'Smith', creatorType: 'author', expect: { given: 'John', family: 'Smith' } }, { // dropping and non-dropping firstName: 'Jean de', lastName: 'la Fontaine', creatorType: 'author', expect: { given: 'Jean', "dropping-particle": 'de', "non-dropping-particle": 'la', family: 'Fontaine' } }, { // only non-dropping firstName: 'Vincent', lastName: 'van Gogh', creatorType: 'author', expect: { given: 'Vincent', "non-dropping-particle": 'van', family: 'Gogh' } }, { // only dropping firstName: 'Alexander von', lastName: 'Humboldt', creatorType: 'author', expect: { given: 'Alexander', "dropping-particle": 'von', family: 'Humboldt' } }, { // institutional author lastName: 'Jean de la Fontaine', creatorType: 'author', fieldMode: 1, expect: { literal: 'Jean de la Fontaine' } }, { // protected last name firstName: 'Jean de', lastName: '"la Fontaine"', creatorType: 'author', expect: { given: 'Jean de', family: 'la Fontaine' } } ]; let data = yield populateDBWithSampleData({ item: { itemType: 'journalArticle', creators: creators } }); let item = Zotero.Items.get(data.item.id); let cslCreators = Zotero.Utilities.itemToCSLJSON(item).author; assert.deepEqual(cslCreators[0], creators[0].expect, 'simple name is not parsed'); assert.deepEqual(cslCreators[1], creators[1].expect, 'name with dropping and non-dropping particles is parsed'); assert.deepEqual(cslCreators[2], creators[2].expect, 'name with only non-dropping particle is parsed'); assert.deepEqual(cslCreators[3], creators[3].expect, 'name with only dropping particle is parsed'); assert.deepEqual(cslCreators[4], creators[4].expect, 'institutional author is not parsed'); assert.deepEqual(cslCreators[5], creators[5].expect, 'protected last name prevents parsing'); }); }); describe("itemFromCSLJSON", function () { it("should stably perform itemToCSLJSON -> itemFromCSLJSON -> itemToCSLJSON", function* () { this.timeout(10000); let data = loadSampleData('citeProcJSExport'); for (let i in data) { let json = data[i]; let item = new Zotero.Item(); Zotero.Utilities.itemFromCSLJSON(item, json); yield item.saveTx(); let newJSON = Zotero.Utilities.itemToCSLJSON(item); delete newJSON.id; delete json.id; assert.deepEqual(newJSON, json, i + ' export -> import -> export is stable'); } }); it("should import exported standalone note", function* () { let note = new Zotero.Item('note'); note.setNote('Some note longer than 50 characters, which will become the title.'); yield note.saveTx(); let jsonNote = Zotero.Utilities.itemToCSLJSON(note); let item = new Zotero.Item(); Zotero.Utilities.itemFromCSLJSON(item, jsonNote); assert.equal(item.getField('title'), jsonNote.title, 'title imported correctly'); }); it("should import exported standalone attachment", function* () { let attachment = yield importFileAttachment("empty.pdf"); attachment.setField('title', 'Empty'); attachment.setField('accessDate', '2001-02-03 12:13:14'); attachment.setField('url', 'http://example.com'); attachment.setNote('Note'); yield attachment.saveTx(); let jsonAttachment = Zotero.Utilities.itemToCSLJSON(attachment); let item = new Zotero.Item(); Zotero.Utilities.itemFromCSLJSON(item, jsonAttachment); assert.equal(item.getField('title'), jsonAttachment.title, 'title imported correctly'); }); // For Zotero.Item created in translation sandbox in connectors it("should not depend on Zotero.Item existing", function* () { let item = new Zotero.Item; var Item = Zotero.Item; delete Zotero.Item; assert.throws(() => "" instanceof Zotero.Item); let data = loadSampleData('citeProcJSExport'); assert.doesNotThrow(Zotero.Utilities.itemFromCSLJSON.bind(Zotero.Utilities, item, Object.values(data)[0])); Zotero.Item = Item; assert.doesNotThrow(() => "" instanceof Zotero.Item); }) }); describe("#ellipsize()", function () { describe("with wordBoundary", function () { it("should truncate at word boundary", function* () { assert.equal(Zotero.Utilities.ellipsize("abc def ghi", 3, true), "abc…"); }); it("should trim whitespace after word boundary", function* () { assert.equal(Zotero.Utilities.ellipsize("abc def ghi", 4, true), "abc…"); }); it("should trim characters after word boundary", function () { assert.equal(Zotero.Utilities.ellipsize("abc def ghi", 5, true), "abc…"); }); it("should truncate in the middle of a word", function () { assert.equal(Zotero.Utilities.ellipsize("abcdefghi", 6, true), "abcdef…"); }); it("should truncate at word boundary with previous space within radius", function () { assert.equal(Zotero.Utilities.ellipsize("abc def ghi", 7, true), "abc def…"); }); it("should return string as is if shorter than length", function () { assert.equal(Zotero.Utilities.ellipsize("abcdefg", 8, true), "abcdefg"); }); it("should return string as is if equal to length", function () { assert.equal(Zotero.Utilities.ellipsize("abcdefgh", 8, true), "abcdefgh"); }); }); }); });