Merge pull request #35 from ResearchObject/publisher-string

Handle case where `publisher` is a string rather than an entity
ResearchObject · Aug 23, 2024 · 0d6d133 · 0d6d133
2 parents a1bfdf4 + 82ff8e4
commit 0d6d133
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 19 deletions.
diff --git a/docs/all-mappings.md b/docs/all-mappings.md
@@ -75,7 +75,8 @@ Note that RO-Crate and DataCite each contain features that the other does not ha
 
 ## Mapping of publisher
 
-- maps `publisher.name` to `metadata.publisher`
+- if `publisher` is a string, maps `publisher` to `metadata.publisher`
+- if `publisher` is an object, maps `publisher.name` to `metadata.publisher`
 - if no publisher exists, the value is `:unkn`
 
 ## Mapping of identifier

diff --git a/src/rocrate_inveniordm/mapping/mapping.json b/src/rocrate_inveniordm/mapping/mapping.json
@@ -306,7 +306,12 @@
 
         "publisher_mapping": {
             "mappings": {
-                "publisher_mapping_1": {
+                "publisher_mapping_direct": {
+                    "from": "publisher",
+                    "to": "metadata.publisher",
+                    "onlyIf": "?string"
+                },
+                "publisher_mapping_name": {
                     "from": "$publisher.name",
                     "to": "metadata.publisher"
                 }

diff --git a/test/data/datacite-out-utf-8-csv-crate.json b/test/data/datacite-out-utf-8-csv-crate.json
@@ -56,8 +56,8 @@
         ],
         "title": "Demo Crate",
         "publication_date": "2024-03-08",
-        "description": "a demo crate for Galaxy training",
-        "publisher": ":unkn",
+        "description": "a demo crate for testing",
+        "publisher": "Test Organization",
         "rights": [
             {
                 "title": {

diff --git a/test/data/utf-8-csv-crate/ro-crate-metadata.json b/test/data/utf-8-csv-crate/ro-crate-metadata.json
@@ -18,9 +18,9 @@
                 "LearningResource"
             ],
             "name": "Demo Crate",
-            "description": "a demo crate for Galaxy training",
+            "description": "a demo crate for testing",
             "datePublished": "2024-03-08",
-            "publisher": "https://ror.org/0abcdef00",
+            "publisher": "Test Organization",
             "license": {
                 "@id": "https://spdx.org/licenses/CC-BY-NC-SA-4.0.html",
                 "@type": "CreativeWork",

diff --git a/test/unit/test_publisher.py b/test/unit/test_publisher.py
@@ -22,33 +22,42 @@
 }
 
 
-@pytest.mark.xfail(
-    reason="known bug - https://github.com/ResearchObject/ro-crate-inveniordm/issues/1"
-)
-def test_publisher_string():
-    rc = load_template_rc()
+@pytest.fixture(scope="module", autouse=True)
+def rc():
+    """Creates template RO-Crate metadata."""
+    return load_template_rc()
+
+
+@pytest.fixture(scope="module", autouse=True)
+def dc():
+    """Creates template DataCite metadata."""
+    return setup_dc()
+
+
+def test_publisher_string(rc, dc):
+    # Arrange
     rc, _ = set_field_in_template_rde("publisher", publisher_string, rc)
-    rule_name = "publisher_mapping_1"
+    rule_name = "publisher_mapping_direct"
     rule = get_single_mapping("publisher", rule_name)
     paths = get_mapping_paths(rc, {rule_name: rule})
-    dc = setup_dc()
 
+    # Act
     dc, _ = apply_mapping(rule, paths, rc, dc)
 
-    print(dc)
+    # Assert
     assert dc["metadata"]["publisher"] == publisher_string
 
 
-def test_publisher_entity():
-    rc = load_template_rc()
+def test_publisher_entity(rc, dc):
+    # Arrange
     rc = add_entity_to_template(publisher_entity, rc)
     rc, _ = set_field_in_template_rde("publisher", {"@id": publisher_entity["@id"]}, rc)
-    dc = setup_dc()
-    rule_name = "publisher_mapping_1"
+    rule_name = "publisher_mapping_name"
     rule = get_single_mapping("publisher", rule_name)
     paths = get_mapping_paths(rc, {rule_name: rule})
 
+    # Act
     dc, _ = apply_mapping(rule, paths, rc, dc)
 
-    print(dc)
+    # Assert
     assert dc["metadata"]["publisher"] == publisher_entity["name"]