Merge pull request #372 from OpenDataServices/185-dep-fields

185 dep fields

Author: James (ODSC)

.gitignore

@@ -18,6 +18,10 @@ examples/create-template/deprecated-yes/actual
 examples/create-template/deprecated-yes/actual.*
 examples/create-template/deprecated-no/actual
 examples/create-template/deprecated-no/actual.*
+examples/create-template/deprecated-yes-ref/actual
+examples/create-template/deprecated-yes-ref/actual.*
+examples/create-template/deprecated-no-ref/actual
+examples/create-template/deprecated-no-ref/actual.*
 examples/create-template/refs/actual
 examples/create-template/refs/actual.*
 examples/create-template/truncation-length/actual
@@ -50,4 +54,8 @@ examples/receipt/source-map/actual
 examples/receipt/source-map/actual.*
 examples/bods/unflatten/actual
 examples/bods/unflatten/actual.*
+examples/titles-ref/flatten/actual
+examples/titles-ref/flatten/actual.*
+examples/titles-ref/unflatten/actual
+examples/titles-ref/unflatten/actual.*
 .~lock*

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixed
 
 - use-titles: Use $ref'erring title if available https://github.com/OpenDataServices/flatten-tool/pull/368 
+- create-template --no-deprecated-fields: Did not work if deprecated element at same level as a $ref https://github.com/OpenDataServices/flatten-tool/issues/185#issuecomment-719587348
 
 ## [0.15.2] - 2020-10-29
 

examples/create-template/deprecated-no-ref/cmd.txt

@@ -0,0 +1 @@
+$ flatten-tool create-template --no-deprecated-fields  --use-titles --main-sheet-name=interviewee --schema=examples/create-template/deprecated-ref.schema -f csv -o examples/create-template/deprecated-no-ref/actual

examples/create-template/deprecated-no-ref/expected/interviewee.csv

@@ -0,0 +1 @@
+Identifier,Name

examples/create-template/deprecated-ref.schema

@@ -0,0 +1,33 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "definitions": {
+        "Pet": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "title": "Pet name"
+                }
+            }
+        }
+    },
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "title": "Identifier"
+        },
+        "name": {
+            "type": "string",
+            "title": "Name"
+        },
+        "pet": {
+            "type": "string",
+            "title": "Pet",
+            "$ref": "#/definitions/Pet",
+            "deprecated": {
+                "description": "So yeah, H.R. told us that asking people in job interviews if they have pets is super illegal. Better stop that."
+            }
+        }
+    }
+}

examples/create-template/deprecated-yes-ref/cmd.txt

@@ -0,0 +1 @@
+$ flatten-tool create-template  --use-titles --main-sheet-name=interviewee --schema=examples/create-template/deprecated-ref.schema -f csv -o examples/create-template/deprecated-yes-ref/actual

examples/create-template/deprecated-yes-ref/expected/interviewee.csv

@@ -0,0 +1 @@
+Identifier,Name,Pet:Pet name

flattentool/schema.py

@@ -243,6 +243,13 @@ def parse_schema_dict(
                 ):
                     continue
 
+                if (
+                    self.exclude_deprecated_fields
+                    and hasattr(property_schema_dict, "__reference__")
+                    and property_schema_dict.__reference__.get("deprecated")
+                ):
+                    continue
+
                 property_type_set = get_property_type_set(property_schema_dict)
 
                 if (

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) == 59
+    assert len(examples_in_docs_data) == 61
 
 
 def _simplify_warnings(lines):