Merge pull request #369 from OpenDataServices/use-referring-title-if-available

use-titles: Use $ref'erring title if available

Author: James (ODSC)

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Fixed
+
+- use-titles: Use $ref'erring title if available https://github.com/OpenDataServices/flatten-tool/pull/368 
+
 ## [0.15.2] - 2020-10-29
 
 ### Fixed

examples/titles-ref/flatten/cmd.txt

@@ -0,0 +1 @@
+$ flatten-tool flatten --root-list-path=weather --main-sheet-name=weather --use-titles --schema=examples/titles-ref/schema.json examples/titles-ref/flatten/data.json -f csv -o examples/titles-ref/flatten/actual

examples/titles-ref/flatten/data.json

@@ -0,0 +1,14 @@
+{
+  "weather": [
+    {
+      "id": "monday",
+      "rain": "tons and tons",
+      "thunder": "none"
+    },
+    {
+      "id": "tuesday",
+      "rain": "dry as a bone",
+      "thunder": "loud as fireworks night"
+    }
+  ]
+}

examples/titles-ref/flatten/expected/weather.csv

@@ -0,0 +1,3 @@
+Identifier,Was it soggy?,Was it noisy?
+monday,tons and tons,none
+tuesday,dry as a bone,loud as fireworks night

examples/titles-ref/schema.json

@@ -0,0 +1,24 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "definitions": {
+        "Value": {
+            "type": "string",
+            "title": "A lowly string"
+        }
+    },
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "title": "Identifier"
+        },
+        "rain": {
+            "$ref": "#/definitions/Value",
+            "title": "Was it soggy?"
+        },
+        "thunder": {
+            "$ref": "#/definitions/Value",
+            "title": "Was it noisy?"
+        }
+    }
+}

examples/titles-ref/unflatten/cmd.txt

@@ -0,0 +1 @@
+$ flatten-tool unflatten -f csv --root-list-path=weather --convert-titles --schema=examples/titles-ref/schema.json examples/titles-ref/unflatten/data

examples/titles-ref/unflatten/data/weather.csv

@@ -0,0 +1,3 @@
+Identifier,Was it soggy?,Was it noisy?
+1st,tons and tons,none
+2nd,dry as a bone,loud as fireworks night

examples/titles-ref/unflatten/expected.json

@@ -0,0 +1,14 @@
+{
+    "weather": [
+        {
+            "id": "1st",
+            "rain": "tons and tons",
+            "thunder": "none"
+        },
+        {
+            "id": "2nd",
+            "rain": "dry as a bone",
+            "thunder": "loud as fireworks night"
+        }
+    ]
+}

flattentool/schema.py

@@ -245,7 +245,13 @@ def parse_schema_dict(
 
                 property_type_set = get_property_type_set(property_schema_dict)
 
-                title = property_schema_dict.get("title")
+                if (
+                    hasattr(property_schema_dict, "__reference__")
+                    and "title" in property_schema_dict.__reference__
+                ):
+                    title = property_schema_dict.__reference__["title"]
+                else:
+                    title = property_schema_dict.get("title")
                 if title:
                     title_lookup[title] = TitleLookup()
                     title_lookup[title].property_name = property_name

flattentool/tests/test_docs.py

@@ -133,7 +133,7 @@ def test_example_in_doc(root, filename):
 
 
 def test_expected_number_of_examples_in_docs_data():
-    assert len(examples_in_docs_data) == 57
+    assert len(examples_in_docs_data) == 59
 
 
 def _simplify_warnings(lines):