✨ moban file inheritance (#346)

* ✨ allow .moban.yaml to inherit(overrides operator) any other yaml files

* 🔬 unit test the new feature

* 📚 🔬 update use case documentation and provide regression test suite

* 👕 make yamllint happy

* 🔥 remove debug print

* 📰 add missing moban file

.moban.cd/changelog.yml

@@ -2,7 +2,13 @@ name: moban
 organisation: moremoban
 releases:
   - changes:
-      - action: Updated
+      - action: Added
+        details:
+          - "support moban file inheritance. one base moban file and child repos can inherit and override"
+    date: tbd
+    version: 0.6.6
+  - changes:
+      - action: Added
         details:
           - "`#335`: support intermediate targets in moban file"
     date: 13.10.2019

CHANGELOG.rst

@@ -1,10 +1,18 @@
 Change log
 ================================================================================
 
+0.6.6 - tbd
+--------------------------------------------------------------------------------
+
+**Added**
+
+#. support moban file inheritance. one base moban file and child repos can
+   inherit and override
+
 0.6.5 - 13.10.2019
 --------------------------------------------------------------------------------
 
-**Updated**
+**Added**
 
 #. `#335 <https://github.com/moremoban/moban/issues/335>`_: support intermediate
    targets in moban file

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
+

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>`_
 

docs/level-23-inherit-organisational-moban-file/.moban.yml

@@ -0,0 +1,3 @@
+overrides: parent.moban.yaml
+targets:
+  - output_a: template_a.jj2

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.

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

docs/level-23-inherit-organisational-moban-file/parent.moban.yaml

@@ -0,0 +1,4 @@
+configuration:
+  configuration: data.yaml
+targets:
+  - output_b: template_b.jj2

docs/level-23-inherit-organisational-moban-file/template_a.jj2

@@ -0,0 +1 @@
+{{template_a}}

docs/level-23-inherit-organisational-moban-file/template_b.jj2

@@ -0,0 +1 @@
+{{template_b}}

moban/core/data_loader.py

@@ -1,6 +1,7 @@
 from collections import OrderedDict
 
 from lml.plugin import PluginManager
+from ruamel.yaml.comments import CommentedSeq
 
 from moban import constants
 from moban.externals import file_system
@@ -31,7 +32,7 @@ def load_data(base_dir, file_name):
     data = LOADER.get_data(abs_file_path)
     if data is not None:
         parent_data = OrderedDict()
-        if base_dir and constants.LABEL_OVERRIDES in data:
+        if constants.LABEL_OVERRIDES in data:
             overrides = data.pop(constants.LABEL_OVERRIDES)
             if not isinstance(overrides, list):
                 overrides = [overrides]
@@ -69,6 +70,12 @@ def merge(left, right):
                 left[key] = value
             else:
                 left[key] = merge(left[key], value)
+    else:
+        both_list_alike = (
+            isinstance(left, CommentedSeq) and isinstance(right, CommentedSeq)
+        ) or (isinstance(left, list) and isinstance(right, list))
+        if both_list_alike:
+            left.extend(right)
     return left
 
 

moban/main.py

@@ -173,7 +173,6 @@ def handle_moban_file(moban_file, options):
     act upon default moban file
     """
     moban_file_configurations = data_loader.load_data(None, moban_file)
-    print(moban_file_configurations)
     if moban_file_configurations is None:
         raise exceptions.MobanfileGrammarException(
             constants.ERROR_INVALID_MOBAN_FILE % moban_file

tests/data_loaders/test_merge_dict.py

@@ -1,4 +1,7 @@
-from moban.data_loaders.manager import merge
+from nose.tools import eq_
+from ruamel.yaml import YAML
+
+from moban.core.data_loader import merge
 
 
 def test_simple_union():
@@ -34,3 +37,30 @@ def test_three_level_conflict():
     default = {"L1": {"L2": {"L3": "Hi"}}}
     merged = merge(user, default)
     assert merged == {"L1": {"L2": {"L3": "World"}}}
+
+
+def test_merge_value_as_list():
+    user = {"L1": ["a", "b"]}
+    default = {"L1": ["c", "d"]}
+    merged = merge(user, default)
+    assert merged == {"L1": ["a", "b", "c", "d"]}
+
+
+def test_merge_value_as_list_in_yaml():
+    yaml = YAML(typ="rt")
+    user = yaml.load(
+        """
+L1:
+  - a
+  - b
+"""
+    )
+    default = yaml.load(
+        """
+L1:
+  - c
+  - d
+"""
+    )
+    merged = merge(user, default)
+    eq_(merged, {"L1": ["a", "b", "c", "d"]})

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"