paths: Let it handle paths as JSON keys

#3

Author: jarofgreen

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+
+- Can handle deep JSON paths
+
 ## [0.1.0] - 2020-04-06
 
 ### Changed

docs/examples.rst

@@ -7,15 +7,15 @@ Examples
 
 A guide of:
 
-+-------------------------------------+------------------------------------------+
-| Pet                                 |  SPREADSHEETFORM:SINGLE:pet              |
-+-------------------------------------+------------------------------------------+
-| Toys:                               |                                          |
-+-------------------------------------+------------------------------------------+
-| Title                               |  Does it squeak?                         |
-+-------------------------------------+------------------------------------------+
-| SPREADSHEETFORM:DOWN:toys:title     |  SPREADSHEETFORM:DOWN:toys:squeak        |
-+-------------------------------------+------------------------------------------+
++----------------------------------------+------------------------------------------+
+| Pet                                    |  SPREADSHEETFORM:SINGLE:pet              |
++----------------------------------------+------------------------------------------+
+| Toys:                                  |                                          |
++----------------------------------------+------------------------------------------+
+| Title                                  |  Does it squeak?                         |
++----------------------------------------+------------------------------------------+
+| SPREADSHEETFORM:DOWN:likes/toys:title  |  SPREADSHEETFORM:DOWN:likes/toys:squeak  |
++----------------------------------------+------------------------------------------+
 
 And a spreadsheet of:
 
@@ -37,8 +37,10 @@ Will map to the data:
 
     {
         "pet": "Dog",
-        "toys": [
-            {"title": "Plastic bone", "squeak": "Oh Yes"},
-            {"title": "Tennis Ball", "squeak": "No"},
-        ]
+        "likes": {
+            "toys": [
+                {"title": "Plastic bone", "squeak": "Oh Yes"},
+                {"title": "Tennis Ball", "squeak": "No"}
+            ]
+        }
     }

docs/guideform/down.rst

@@ -28,7 +28,7 @@ The order of the rows and the order of the items in the JSON list will be the sa
 
 The `itemkey` is the JSON key that the data will appear in in each dictionary.
 
-Note the `listkey` and `itemkey` must be a single key and can not contain paths yet; eg "pet" is acceptable, "pet/title" is not.
+See :doc:`JSON Key for information on how to structure those<jsonkey>`.
 
 Example
 -------

docs/guideform/index.rst

@@ -10,3 +10,4 @@ You then put special values in certain cells to indicate that these cells should
 
    single.rst
    down.rst
+   jsonkey.rst

docs/guideform/jsonkey.rst

@@ -0,0 +1,18 @@
+JSON Keys
+=========
+
+In the guideform, you can set JSON Keys at various points.
+
+These set the point in the data that values will be read or written to.
+
+These can be single keys:
+
+Eg:
+
+* `pet`
+
+These can also be several keys split by a slash. In this case, it will traverse down several dictionaries.
+
+Eg:
+
+* `pet/kind`

docs/guideform/single.rst

@@ -13,7 +13,7 @@ To do this, in your cell put
     SPREADSHEETFORM:SINGLE:jsonkey
 
 
-Note the `jsonkey` must be a single key and can not contain paths yet; eg "pet" is acceptable, "pet/title" is not.
+See :doc:`JSON Key for information on how to structure those<jsonkey>`.
 
 Example
 -------

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup
 
-install_requires = ["openpyxl>=3.0"]
+install_requires = ["openpyxl>=3.0", "jsonpointer"]
 
 setup(
     name="spreadsheetforms",

spreadsheetforms/api.py

@@ -2,6 +2,8 @@
 
 import openpyxl
 
+from .util import json_append_deep_value, json_get_deep_value, json_set_deep_value
+
 
 def _is_content_a_guide_field(content):
     return content and content.startswith("SPREADSHEETFORM:")
@@ -73,31 +75,29 @@ def get_data_from_form(guide_filename, in_filename):
 
         # Step 2: Process single configs (easy ones)
         for single_config in single_configs.values():
-            # TODO this only does top level paths - we should add so it can do paths with several levels
-            data[single_config["path"]] = in_workbook[worksheet.title][
-                single_config["coordinate"]
-            ].value
+            json_set_deep_value(
+                data,
+                single_config["path"],
+                in_workbook[worksheet.title][single_config["coordinate"]].value,
+            )
 
         # Step 3: Process Down Configs
         for down_config in down_configs.values():
             start_row = down_config[0]["row"]
             max_row = in_workbook[worksheet.title].max_row + 1
-            # TODO this only does top level paths - we should add so it can do paths with several levels
-            data[down_config[0]["list_path"]] = []
+            json_set_deep_value(data, down_config[0]["list_path"], [])
             for row in range(start_row, max_row + 1):
                 item = {}
                 found_anything = False
                 for this_down_config in down_config:
-                    # TODO this only does top level paths - we should add so it can do paths with several levels
                     cell = in_workbook[worksheet.title][
                         this_down_config["column_letter"] + str(row)
                     ]
-                    item[this_down_config["item_path"]] = cell.value
-                    if item[this_down_config["item_path"]]:
+                    json_set_deep_value(item, this_down_config["item_path"], cell.value)
+                    if json_get_deep_value(item, this_down_config["item_path"]):
                         found_anything = True
                 if found_anything:
-                    # TODO this only does top level paths - we should add so it can do paths with several levels
-                    data[down_config[0]["list_path"]].append(item)
+                    json_append_deep_value(data, down_config[0]["list_path"], item)
 
     return data
 
@@ -113,27 +113,28 @@ def put_data_in_form(guide_filename, data, out_filename):
 
         # Step 2: Process single configs (easy ones)
         for single_config in single_configs.values():
-            # TODO this only does top level paths - we should add so it can do paths with several levels
-            worksheet[single_config["coordinate"]] = data.get(single_config["path"])
+            worksheet[single_config["coordinate"]] = json_get_deep_value(
+                data, single_config["path"]
+            )
 
         # Step 3: Process Down Configs
         for down_config in down_configs.values():
-            datas_to_insert = data.get(down_config[0]["list_path"], [])
+            datas_to_insert = json_get_deep_value(data, down_config[0]["list_path"])
             if isinstance(datas_to_insert, list):
                 if len(datas_to_insert) == 0:
                     # we still want to remove the special values from the output spreadsheet
                     for this_down_config in down_config:
-                        # TODO this only does top level paths - we should add so it can do paths with several levels
                         worksheet[this_down_config["coordinate"]] = ""
                 else:
                     extra_row = 0
                     for data_to_insert in datas_to_insert:
                         for this_down_config in down_config:
-                            # TODO this only does top level paths - we should add so it can do paths with several levels
                             worksheet[
                                 this_down_config["column_letter"]
                                 + str(this_down_config["row"] + extra_row)
-                            ] = data_to_insert.get(this_down_config["item_path"])
+                            ] = json_get_deep_value(
+                                data_to_insert, this_down_config["item_path"]
+                            )
                         extra_row += 1
 
     workbook.save(out_filename)

spreadsheetforms/util.py

@@ -0,0 +1,42 @@
+from jsonpointer import JsonPointerException, resolve_pointer
+
+
+def json_set_deep_value(data, key, value):
+    key_bits = key.split("/")
+
+    # Have to navigate to right bit of structure, creating dicts as we go
+    if len(key_bits) > 1:
+        for idx in range(0, len(key_bits) - 1):
+
+            key_bit = key_bits[idx]
+            if key_bit not in data:
+                data[key_bit] = {}
+
+            data = data[key_bit]
+
+    # Finally, set value
+    data[key_bits[-1]] = value
+
+
+def json_append_deep_value(data, key, value):
+    key_bits = key.split("/")
+
+    # Have to navigate to right bit of structure, creating dicts as we go
+    if len(key_bits) > 1:
+        for idx in range(0, len(key_bits) - 1):
+
+            key_bit = key_bits[idx]
+            if key_bit not in data:
+                data[key_bit] = {}
+
+            data = data[key_bit]
+
+    # Finally, append value
+    data[key_bits[-1]].append(value)
+
+
+def json_get_deep_value(data, key):
+    try:
+        return resolve_pointer(data, "/" + key)
+    except JsonPointerException:
+        return None

tests/data/pet1-deep.xlsx

@@ -23,3 +23,28 @@ def test_1():
             {"title": "Marble", "squeak": "No"},
         ],
     } == data
+
+
+def test_deep():
+
+    data = get_data_from_form(
+        os.path.join(TEST_DATA_DIR, "pet1-deep.xlsx"),
+        os.path.join(TEST_DATA_DIR, "cat1.xlsx"),
+    )
+
+    assert {
+        "emits": {"noise": "Miaow Miaow Purr Purr Hiss"},
+        "pet": {"kind": "Cat"},
+        "likes": {
+            "toys": [
+                {
+                    "human-concerns": {"title": "Bit of string"},
+                    "pet-concerns": {"squeak": "No"},
+                },
+                {
+                    "human-concerns": {"title": "Marble"},
+                    "pet-concerns": {"squeak": "No"},
+                },
+            ]
+        },
+    } == data

tests/test_get_data_from_form.py

@@ -33,3 +33,36 @@ def test_1():
     assert "Oh Yes" == workbook["Toys"]["B7"].value
     assert "Tennis Ball" == workbook["Toys"]["A8"].value
     assert "No" == workbook["Toys"]["B8"].value
+
+
+def test_deep():
+
+    outfile = os.path.join(TEST_DATA_OUT_DIR, "put_data_in_form_1_deep.xlsx")
+
+    data = {
+        "emits": {"noise": "Woof Woof"},
+        "pet": {"kind": "Dog"},
+        "likes": {
+            "toys": [
+                {
+                    "human-concerns": {"title": "Plastic bone"},
+                    "pet-concerns": {"squeak": "Oh Yes"},
+                },
+                {
+                    "human-concerns": {"title": "Tennis Ball"},
+                    "pet-concerns": {"squeak": "No"},
+                },
+            ]
+        },
+    }
+
+    put_data_in_form(os.path.join(TEST_DATA_DIR, "pet1-deep.xlsx"), data, outfile)
+
+    workbook = openpyxl.load_workbook(outfile, read_only=True)
+
+    assert "Dog" == workbook["Info"]["B5"].value
+    assert "Woof Woof" == workbook["Info"]["B6"].value
+    assert "Plastic bone" == workbook["Toys"]["A7"].value
+    assert "Oh Yes" == workbook["Toys"]["B7"].value
+    assert "Tennis Ball" == workbook["Toys"]["A8"].value
+    assert "No" == workbook["Toys"]["B8"].value

tests/test_put_data_in_form.py

@@ -0,0 +1,22 @@
+from spreadsheetforms.util import json_set_deep_value
+
+
+def test_1():
+    data = {}
+    json_set_deep_value(data, "cat", "cool")
+    assert data == {"cat": "cool"}
+
+
+def test_2():
+    data = {}
+    json_set_deep_value(data, "cat/name", "Bob")
+    assert data == {"cat": {"name": "Bob"}}
+
+
+def test_3():
+    data = {}
+    json_set_deep_value(data, "cat/name/official", "Mr Bob The Magnificent")
+    json_set_deep_value(data, "cat/name/informal", "Bob")
+    assert data == {
+        "cat": {"name": {"informal": "Bob", "official": "Mr Bob The Magnificent"}}
+    }