fix: empty tables (#15)

* fix: empty tables

* test: add unit test

Author: very-doge-wow

writer/doc_writer.py

@@ -47,7 +47,7 @@ def write(output: str, doc: dict, template: str) -> str:
 {{ stella.values }}
 
 *Automatic helm documentation generated using [very-doge-wow/stella](https://github.com/very-doge-wow/stella).*
-        """
+"""
 
     keywords = [
         "{{ stella.name }}",
@@ -64,20 +64,23 @@ def write(output: str, doc: dict, template: str) -> str:
 
     # transform dicts to md tables
     translated = doc
-    for key in doc:
-        if type(doc[key]) == list:
+    for key in translated:
+        if type(translated[key]) == list:
             logging.debug(f"converting list of dicts {key} to md")
 
-            if len(doc[key]) > 0:
+            if len(translated[key]) > 0:
                 md = translate_list_of_dicts_to_md(doc[key])
                 translated[key] = md
+            else:
+                md = f"*No {get_name_from_keyword(key)} found.*"
+                translated[key] = md
 
     result = ""
     for line in template_content.split("\n"):
         for keyword in keywords:
             if keyword in line:
                 line = line.replace(keyword, str(
-                    doc[keyword.replace("{", "").replace("}", "").strip().replace("stella.", "")]))
+                    translated[get_name_from_keyword(keyword)]))
         result += line + "\n"
 
     logging.debug("writing output to file")
@@ -128,3 +131,8 @@ def translate_list_of_dicts_to_md(list_of_dicts: list) -> str:
                         md += f"| {value.rstrip()} "
         md += "|\n"
     return md
+
+
+def get_name_from_keyword(keyword: str) -> str:
+    result = keyword.replace("{", "").replace("}", "").strip().replace("stella.", "")
+    return result

writer/doc_writer_test.py

@@ -286,5 +286,92 @@ def test_writer_keywords_default_template():
 
 
 *Automatic helm documentation generated using [very-doge-wow/stella](https://github.com/very-doge-wow/stella).*
-        
-"""
+
+"""
+
+
+def test_writer_empty():
+    doc = {
+        "type": "application",
+        "version": "1.0",
+        "appVersion": "1.1",
+        "apiVersion": "1.2",
+        "name": "unittest",
+        "description": "simple templating test",
+        "dependencies": [],
+        "templates": [],
+        "objects": [
+            {
+                "kind": "Ingress",
+                "from Template": "template.yaml"
+            }
+        ],
+        "values": [
+            {
+                "name": "ReplicaCount",
+                "description": "how many replicas to deploy",
+                "default": "1",
+                "example": "replicaCount: 2"
+            }
+        ]
+    }
+
+    result = doc_writer.write("test/output.md", doc, "")
+    assert result == """
+# unittest
+![Version: 1.0](https://img.shields.io/badge/Version-1.0-informational?style=flat-square) ![Version: 1.1](https://img.shields.io/badge/appVersion-1.1-informational?style=flat-square) ![Version: 1.2](https://img.shields.io/badge/apiVersion-1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) 
+
+## Description
+simple templating test
+
+## Dependencies
+This chart depends on the following subcharts.
+
+*No dependencies found.*
+
+## Templates
+The following templates will be deployed.
+
+*No templates found.*
+
+### Objects
+The aforementioned templates will deploy the following objects.
+
+| Kind | From template |
+|---|---| 
+| Ingress | template.yaml |
+
+
+## Values
+The following values can/will be used for deployments.
+
+| Name | Description | Default | Example |
+|---|---|---|---| 
+| ReplicaCount | how many replicas to deploy | <pre>1</pre> | <pre>replicaCount: 2</pre> |
+
+
+*Automatic helm documentation generated using [very-doge-wow/stella](https://github.com/very-doge-wow/stella).*
+
+"""
+
+
+def test_get_name_from_keyword():
+    keywords = [
+        "{{ stella.lol }}",
+        "{{ stella.banana }}",
+        "",
+        "{{stella.rofl}}",
+        "{{pear}}"
+    ]
+
+    results = [
+        "lol",
+        "banana",
+        "",
+        "rofl",
+        "pear"
+    ]
+
+    for index, keyword in enumerate(keywords):
+        result = doc_writer.get_name_from_keyword(keyword)
+        assert results[index] == result