Merge pull request #142 from octue/dcmi-changes

thclark · web-flow · commit 4af6766a2ebc · 2026-01-07T11:04:03.000Z
DCMI changes - update to use term_name, and use full range of available terms.
diff --git a/lenses/lenses.py b/lenses/lenses.py
@@ -121,6 +121,25 @@ def _remove_dimension(arr, dim):
         return arr
 
 
+def _convert_dcmi_term_to_term_name(doc):
+    """Convert document.metadata entries from 'term' (capitalized label) to 'term_name' (lowercase name).
+
+    Old format: {"term": "Identifier", "value": "..."}
+    New format: {"term_name": "identifier", "value": "..."}
+    """
+
+    if "document" not in doc or "metadata" not in doc["document"]:
+        return doc
+
+    for entry in doc["document"]["metadata"]:
+        if "term" in entry:
+            # Convert capitalized label to lowercase name
+            term_value = entry.pop("term")
+            entry["term_name"] = term_value.lower()
+
+    return doc
+
+
 def alpha_3_to_alpha_4(doc):
     """Convert documents compliant with alpha-3 to documents compliant with alpha-4"""
 
@@ -130,6 +149,7 @@ def alpha_3_to_alpha_4(doc):
         _move_available_hub_heights_to_restricted,
         _rename_dimension_to_axis,
         _collapse_singleton_dimensions,
+        _convert_dcmi_term_to_term_name,
     ]
     for lens in lenses:
         doc = lens(doc)
diff --git a/power-curve-schema/examples/generic-120-3-with-extra-parameters.json b/power-curve-schema/examples/generic-120-3-with-extra-parameters.json
@@ -2,16 +2,20 @@
   "document": {
     "metadata": [
       {
-        "term": "Identifier",
+        "term_name": "identifier",
         "value": "126b9e41-722f-49ab-9586-b55188adf420"
       },
       {
-        "term": "Format",
+        "term_name": "format",
         "value": "IEC61400-16-1"
       },
       {
-        "term": "Source",
+        "term_name": "source",
         "value": "Doc 12345 - Rev 01"
+      },
+      {
+        "term_name": "type",
+        "value": "Dataset"
       }
     ]
   },
diff --git a/power-curve-schema/examples/generic-120-3.json b/power-curve-schema/examples/generic-120-3.json
@@ -2,16 +2,20 @@
   "document": {
     "metadata": [
       {
-        "term": "Identifier",
+        "term_name": "identifier",
         "value": "126b9e41-722f-49ab-9586-b55188adf420"
       },
       {
-        "term": "Format",
+        "term_name": "format",
         "value": "IEC61400-16-1"
       },
       {
-        "term": "Source",
+        "term_name": "source",
         "value": "Doc 12345 - Rev 01"
+      },
+      {
+        "term_name": "type",
+        "value": "Dataset"
       }
     ]
   },
diff --git a/power-curve-schema/examples/generic-274-20.json b/power-curve-schema/examples/generic-274-20.json
@@ -2,16 +2,20 @@
   "document": {
     "metadata": [
       {
-        "term": "Identifier",
+        "term_name": "identifier",
         "value": "6d3ff892-8763-4448-aab9-ab8454bf6ec5"
       },
       {
-        "term": "Format",
+        "term_name": "format",
         "value": "IEC61400-16-1"
       },
       {
-        "term": "Source",
+        "term_name": "source",
         "value": "Doc 56789 - Rev 01"
+      },
+      {
+        "term_name": "type",
+        "value": "Dataset"
       }
     ]
   },
diff --git a/power-curve-schema/schema.json b/power-curve-schema/schema.json
@@ -538,31 +538,72 @@
       "properties": {
         "metadata": {
           "title": "Dublin-Core Metadata",
-          "description": "Add metadata according to the Dublin Core Metadata Initiative (DCMI) elements/1.1. See https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-3 for detailed information on each element.",
+          "description": "Add metadata according to the Dublin Core Metadata Initiative (DCMI) terms. See https://www.dublincore.org/specifications/dublin-core/dcmi-terms/ for detailed information on each term.",
           "type": "array",
           "items": {
             "type": "object",
-            "required": ["term", "value"],
+            "required": ["term_name", "value"],
             "additionalProperties": false,
             "properties": {
-              "term": {
-                "title": "Term",
-                "description": "The DCMI Element label",
+              "term_name": {
+                "title": "Term Name",
+                "description": "The DCMI Term or Element name (see https://www.dublincore.org/specifications/dublin-core/dcmi-terms/)",
                 "enum": [
-                  "Contributor",
-                  "Coverage",
-                  "Creator",
-                  "Date",
-                  "Description",
-                  "Format",
-                  "Identifier",
-                  "Language",
-                  "Publisher",
-                  "Relation",
-                  "Rights",
-                  "Source",
-                  "Subject",
-                  "Type"
+                  "abstract",
+                  "accessRights",
+                  "accrualMethod",
+                  "accrualPeriodicity",
+                  "accrualPolicy",
+                  "alternative",
+                  "audience",
+                  "available",
+                  "bibliographicCitation",
+                  "conformsTo",
+                  "contributor",
+                  "coverage",
+                  "created",
+                  "creator",
+                  "date",
+                  "dateAccepted",
+                  "dateCopyrighted",
+                  "dateSubmitted",
+                  "description",
+                  "educationLevel",
+                  "extent",
+                  "format",
+                  "hasFormat",
+                  "hasPart",
+                  "hasVersion",
+                  "identifier",
+                  "instructionalMethod",
+                  "isFormatOf",
+                  "isPartOf",
+                  "isReferencedBy",
+                  "isReplacedBy",
+                  "isRequiredBy",
+                  "issued",
+                  "isVersionOf",
+                  "language",
+                  "license",
+                  "mediator",
+                  "medium",
+                  "modified",
+                  "provenance",
+                  "publisher",
+                  "references",
+                  "relation",
+                  "replaces",
+                  "requires",
+                  "rights",
+                  "rightsHolder",
+                  "source",
+                  "spatial",
+                  "subject",
+                  "tableOfContents",
+                  "temporal",
+                  "title",
+                  "type",
+                  "valid"
                 ]
               },
               "value": {
diff --git a/test/test_lenses.py b/test/test_lenses.py
@@ -11,6 +11,7 @@
     _add_power_reference_location,
     _change_shear_coefficient_to_vertical_shear_exponent,
     _collapse_singleton_dimensions,
+    _convert_dcmi_term_to_term_name,
     _move_available_hub_heights_to_restricted,
     _rename_dimension_to_axis,
 )
@@ -218,3 +219,62 @@ def test_collapse_singleton_dimensions_no_singletons(generic_120_3_alpha_3):
     assert mode_after["parameters"][1] == mode_before["parameters"][1]
     assert mode_after["power"] == mode_before["power"]
     assert mode_after["thrust_coefficient"] == mode_before["thrust_coefficient"]
+
+
+def test_convert_dcmi_term_to_term_name(generic_120_3_alpha_3):
+    """Should convert 'term' property to 'term_name' and lowercase the value"""
+    # Verify initial state - fixture has old format
+    metadata = generic_120_3_alpha_3["document"]["metadata"]
+    assert metadata[0]["term"] == "Identifier"
+    assert metadata[1]["term"] == "Format"
+    assert metadata[2]["term"] == "Source"
+
+    transformed = _convert_dcmi_term_to_term_name(generic_120_3_alpha_3)
+
+    metadata = transformed["document"]["metadata"]
+    # Check term was renamed to term_name and lowercased
+    assert "term" not in metadata[0]
+    assert metadata[0]["term_name"] == "identifier"
+    assert metadata[0]["value"] == "126b9e41-722f-49ab-9586-b55188adf420"
+
+    assert "term" not in metadata[1]
+    assert metadata[1]["term_name"] == "format"
+    assert metadata[1]["value"] == "IEC61400-16-1"
+
+    assert "term" not in metadata[2]
+    assert metadata[2]["term_name"] == "source"
+    assert metadata[2]["value"] == "Doc 12345 - Rev 01"
+
+
+def test_convert_dcmi_term_to_term_name_no_op_when_already_converted(generic_120_3_alpha_3):
+    """Should not modify documents that already use term_name"""
+    # Convert to new format first
+    generic_120_3_alpha_3["document"]["metadata"] = [
+        {"term_name": "identifier", "value": "test-id"},
+        {"term_name": "format", "value": "IEC61400-16-1"},
+    ]
+
+    metadata_before = copy.deepcopy(generic_120_3_alpha_3["document"]["metadata"])
+    transformed = _convert_dcmi_term_to_term_name(generic_120_3_alpha_3)
+    metadata_after = transformed["document"]["metadata"]
+
+    # Should be unchanged
+    assert metadata_after == metadata_before
+
+
+def test_convert_dcmi_term_to_term_name_handles_missing_document(generic_120_3_alpha_3):
+    """Should handle documents without a document section gracefully"""
+    del generic_120_3_alpha_3["document"]
+
+    # Should not raise an error
+    transformed = _convert_dcmi_term_to_term_name(generic_120_3_alpha_3)
+    assert "document" not in transformed
+
+
+def test_convert_dcmi_term_to_term_name_handles_missing_metadata(generic_120_3_alpha_3):
+    """Should handle documents without metadata section gracefully"""
+    del generic_120_3_alpha_3["document"]["metadata"]
+
+    # Should not raise an error
+    transformed = _convert_dcmi_term_to_term_name(generic_120_3_alpha_3)
+    assert "metadata" not in transformed["document"]

Original file line number	Diff line number	Diff line change
`@@ -2,16 +2,20 @@`
`2`	`2`	`"document": {`
`3`	`3`	`"metadata": [`
`4`	`4`	`{`
`5`		`- "term": "Identifier",`
	`5`	`+ "term_name": "identifier",`
`6`	`6`	`"value": "126b9e41-722f-49ab-9586-b55188adf420"`
`7`	`7`	`},`
`8`	`8`	`{`
`9`		`- "term": "Format",`
	`9`	`+ "term_name": "format",`
`10`	`10`	`"value": "IEC61400-16-1"`
`11`	`11`	`},`
`12`	`12`	`{`
`13`		`- "term": "Source",`
	`13`	`+ "term_name": "source",`
`14`	`14`	`"value": "Doc 12345 - Rev 01"`
	`15`	`+ },`
	`16`	`+ {`
	`17`	`+ "term_name": "type",`
	`18`	`+ "value": "Dataset"`
`15`	`19`	`}`
`16`	`20`	`]`
`17`	`21`	`},`