Use jsonld.js to normalize documents when importing (#32)

codemeta · Mar 28, 2024 · 858cc4e · 858cc4e
1 parent 83e6919
commit 858cc4e
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 9 deletions.
diff --git a/cypress/integration/basics.js b/cypress/integration/basics.js
@@ -168,6 +168,24 @@ describe('JSON Import', function() {
         cy.get("#selected-licenses").children().eq(1).children().first().should('have.text', 'MIT');
     });
 
+    it('works with expanded document version', function () {
+        cy.get('#codemetaText').then((elem) =>
+            elem.text(JSON.stringify({
+                "http://schema.org/name": [
+                    {
+                        "@value": "My Test Software"
+                    }
+                ],
+                "@type": [
+                    "http://schema.org/SoftwareSourceCode"
+                ]
+            }))
+        );
+        cy.get('#importCodemeta').click();
+
+        cy.get('#name').should('have.value', 'My Test Software');
+    });
+
     it('errors on invalid type', function() {
         cy.get('#codemetaText').then((elem) =>
             elem.text(JSON.stringify({

diff --git a/js/codemeta_generation.js b/js/codemeta_generation.js
@@ -226,7 +226,7 @@ function importShortOrg(fieldName, doc) {
     if (doc !== undefined) {
         // Use @id if set, else use name
         setIfDefined(fieldName, doc["name"]);
-        setIfDefined(fieldName, doc["@id"]);
+        setIfDefined(fieldName, getDocumentId(doc));
     }
 }
 
@@ -238,7 +238,7 @@ function importPersons(prefix, legend, docs) {
     docs.forEach(function (doc, index) {
         var personId = addPerson(prefix, legend);
 
-        setIfDefined(`#${prefix}_${personId}_id`, doc['@id']);
+        setIfDefined(`#${prefix}_${personId}_id`, getDocumentId(doc));
         directPersonCodemetaFields.forEach(function (item, index) {
             setIfDefined(`#${prefix}_${personId}_${item}`, doc[item]);
         });
@@ -247,9 +247,9 @@ function importPersons(prefix, legend, docs) {
     })
 }
 
-function importCodemeta() {
+async function importCodemeta() {
     var inputForm = document.querySelector('#inputForm');
-    var doc = parseAndValidateCodemeta(false);
+    var doc = await parseAndValidateCodemeta(false);
     resetForm();
 
     if (doc['license'] !== undefined) {

diff --git a/js/validation/index.js b/js/validation/index.js
@@ -76,12 +76,12 @@ function validateDocument(doc) {
 }
 
 
-function parseAndValidateCodemeta(showPopup) {
+async function parseAndValidateCodemeta(showPopup) {
     var codemetaText = document.querySelector('#codemetaText').innerText;
-    var doc;
+    let parsed, doc;
 
     try {
-        doc = JSON.parse(codemetaText);
+        parsed = JSON.parse(codemetaText);
     }
     catch (e) {
         setError(`Could not read codemeta document because it is not valid JSON (${e}). Check for missing or extra quote, colon, or bracket characters.`);
@@ -90,7 +90,7 @@ function parseAndValidateCodemeta(showPopup) {
 
     setError("");
 
-    var isValid = validateDocument(doc);
+    var isValid = validateDocument(parsed);
     if (showPopup) {
         if (isValid) {
             alert('Document is valid!')
@@ -100,5 +100,6 @@ function parseAndValidateCodemeta(showPopup) {
         }
     }
 
+    doc = await jsonld.compact(parsed, CODEMETA_CONTEXT_URL);
     return doc;
 }
diff --git a/js/validation/things.js b/js/validation/things.js
@@ -15,6 +15,10 @@ function getDocumentType(doc) {
     return doc["type"] || doc["@type"] || doc["codemeta:type"]
 }
 
+function getDocumentId(doc) {
+    return doc["id"] || doc["@id"];
+}
+
 function isCompactTypeEqual(type, compactedType) {
     // FIXME: are all variants allowed?
     return (type == `${compactedType}`
@@ -64,7 +68,7 @@ function validateThing(parentFieldName, typeFieldValidators, doc) {
 
     var documentType = getDocumentType(doc);
 
-    var id = doc["id"] || doc["@id"];
+    var id = getDocumentId(doc);
     if (id !== undefined && !isUrl(id)) {
         setError(`"${fieldName}" has an invalid URI as id: ${JSON.stringify(id)}"`);
         return false;