📚 🔬 update use case documentation and provide regression test suite

moremoban · chfw · Nov 9, 2019 · Nov 8, 2019 · Nov 8, 2019 · Nov 8, 2019
commit e60ff611441e77f9efbb1714b88874f107ce63a0
diff --git a/docs/README.rst b/docs/README.rst
@@ -25,6 +25,7 @@ This section covers the use cases for moban. Please check them out individually.
 #. `Template files in a zip or tar`_
 #. `Template copying from a zip to a zip`_
 #. `Intermeidate targets`_
+#. `Mobanfile inheritance`_
 
 .. _Jinja2 command line: level-1-jinja2-cli
 .. _Template inheritance: level-2-template-inheritance
@@ -48,3 +49,5 @@ This section covers the use cases for moban. Please check them out individually.
 .. _Template files in a zip or tar: level-20-templates-configs-in-zip-or-tar
 .. _Template copying from a zip to a zip: level-21-copy-templates-into-an-alien-file-system
 .. _Intermeidate targets: level-22-intermediate-targets
+.. _Mobanfile inheritance: level-23-inherit-organisational-moban-file
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -37,6 +37,8 @@ examples folder.
    level-20-templates-configs-in-zip-or-tar/README.rst
    level-21-copy-templates-into-an-alien-file-system/README.rst
    level-22-intermediate-targets/README.rst
+   level-23-inherit-organisational-moban-file/README.rst
+
 
 For more complex use case, please look at `its usage in pyexcel project <http://pyexcel.readthedocs.io/en/latest/guide.html>`_
 

diff --git a/docs/level-23-inherit-organisational-moban-file/README.rst b/docs/level-23-inherit-organisational-moban-file/README.rst
@@ -0,0 +1,10 @@
+Level 23: moban file inheritance
+================================================================================
+
+It is a bit tedious to repeat a few common configuration in moban file. Why not
+create a parent moban file? Then allow child project to deviate from.
+
+The answer is to use 'overrides' in `.moban.yaml`, so called moban file.
+
+`overrides` could over ride any data file format in any location in theory. And
+it support override a specific key set.
diff --git a/docs/level-23-inherit-organisational-moban-file/data.yaml b/docs/level-23-inherit-organisational-moban-file/data.yaml
@@ -0,0 +1,2 @@
+template_a: I am template a
+template_b: I am template b
diff --git a/docs/level-23-inherit-organisational-moban-file/parent.moban.yaml b/docs/level-23-inherit-organisational-moban-file/parent.moban.yaml
@@ -0,0 +1,4 @@
+configuration:
+  configuration: data.yaml
+targets:
+  - output_b: template_b.jj2
diff --git a/docs/level-23-inherit-organisational-moban-file/template_a.jj2 b/docs/level-23-inherit-organisational-moban-file/template_a.jj2
@@ -0,0 +1 @@
+{{template_a}}
diff --git a/docs/level-23-inherit-organisational-moban-file/template_b.jj2 b/docs/level-23-inherit-organisational-moban-file/template_b.jj2
@@ -0,0 +1 @@
+{{template_b}}
diff --git a/tests/test_docs.py b/tests/test_docs.py
@@ -317,6 +317,14 @@ def test_level_22_intermediate_targets(self):
         folder = "level-22-intermediate-targets"
         self.run_moban(["moban"], folder, [("final", expected)])
 
+    def test_level_23_inherit_parent_moban_file(self):
+        folder = "level-23-inherit-organisational-moban-file"
+        self.run_moban(
+            ["moban"],
+            folder,
+            [("output_a", "I am template a"), ("output_b", "I am template b")],
+        )
+
     def test_misc_1(self):
         expected = "test file\n"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		template_a: I am template a
		template_b: I am template b