release 0.3.10

.moban.cd/changelog.yml

@@ -1,6 +1,18 @@
 name: moban
 organisation: moremoban
 releases:
+- changes:
+  - action: Added
+    details:
+    - "`#174`: Store git cache in XDG_CACHE_DIR"
+    - "`#107`: Add -v to show current moban version"
+    - "`#164`: support additional data formats"
+  - action: Updated
+    details:
+    - "`#178`: UnboundLocalError: local variable 'target' referenced before assignment"
+    - "`#169`: uses GitPython instead of barebone git commands"
+  date: 3.2.2019 
+  version: 0.3.10
 - changes:
   - action: Updated
     details:

.moban.cd/moban.yml

@@ -3,9 +3,9 @@ organisation: moremoban
 author: C. W.
 contact: wangc_2011@hotmail.com
 license: MIT
-version: 0.3.9
-current_version: 0.3.9
-release: 0.3.9
+version: 0.3.10
+current_version: 0.3.10
+release: 0.3.10
 branch: master
 command_line_interface: "moban"
 entry_point: "moban.main:main"
@@ -15,9 +15,12 @@ keywords:
   - jinja2
   - moban
 dependencies:
-  - ruamel.yaml
+  - ruamel.yaml==0.15.87
   - jinja2>=2.7.1
-  - lml>=0.0.7
+  - lml>=0.0.9
+  - appdirs==1.4.3
   - crayons
+  - GitPython==2.1.11
+  - git-url-parse
 description: Yet another jinja2 cli command for static text generation
 scm_host: github.com

.moban.d/travis.yml

@@ -6,6 +6,5 @@ python:
   - 3.7-dev
   - 3.6
   - 3.5
-  - 3.4
   - 2.7
 {%endblock%}

.travis.yml

@@ -7,7 +7,6 @@ python:
   - 3.7-dev
   - 3.6
   - 3.5
-  - 3.4
   - 2.7
 before_install:
   - if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi

CHANGELOG.rst

@@ -1,6 +1,27 @@
 Change log
 ================================================================================
 
+0.3.10 - 3.2.2019
+--------------------------------------------------------------------------------
+
+Added
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. `#174 <https://github.com/moremoban/moban/issues/174>`_: Store git cache in
+   XDG_CACHE_DIR
+#. `#107 <https://github.com/moremoban/moban/issues/107>`_: Add -v to show
+   current moban version
+#. `#164 <https://github.com/moremoban/moban/issues/164>`_: support additional
+   data formats
+
+Updated
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. `#178 <https://github.com/moremoban/moban/issues/178>`_: UnboundLocalError:
+   local variable 'target' referenced before assignment
+#. `#169 <https://github.com/moremoban/moban/issues/169>`_: uses GitPython
+   instead of barebone git commands
+
 0.3.9 - 18-1-2019
 --------------------------------------------------------------------------------
 

CONTRIBUTORS.rst

@@ -3,6 +3,7 @@ Contributors
 
 In alphabetical order:
 
+* `Ayan Banerjee <https://github.com/ayan-b>`_
 * `Charlie Liu <https://github.com/CLiu13>`_
 * `John Vandenberg <https://github.com/jayvdb>`_
 * `Joshua Chung <https://github.com/seeeturtle>`_

README.rst

@@ -137,7 +137,7 @@ Exit codes
 --------------------------------------------------------------------------------
 By default:
 
-- 0 : no changes
+- 0 : no error
 - 1 : error occured
 
 With `--exit-code`:

docs/README.rst

@@ -14,6 +14,9 @@ This section covers the use cases for moban. Please check them out individually.
 #. `Use pypi package as a moban dependency`_
 #. `Use git repository as a moban dependency`_
 #. `Use handlebars template with moban`_
+#. `Use template engine extensions`_
+#. `Any data overrides any data`_
+#. `Custom data loader`_
 
 .. _Jinja2 command line: level-1-jinja2-cli
 .. _Template inheritance: level-2-template-inheritance
@@ -26,3 +29,6 @@ This section covers the use cases for moban. Please check them out individually.
 .. _Use pypi package as a moban dependency: level-9-moban-dependency-as-pypi-package
 .. _Use git repository as a moban dependency: level-10-moban-dependency-as-git-repo
 .. _Use handlebars template with moban: level-11-use-handlebars
+.. _Use template engine extensions: level-12-use-template-engine-extensions
+.. _Any data overrides any data: level-13-any-data-override-any-data
+.. _Custom data loader: level-14-custom-data-loader

docs/conf.py

@@ -28,9 +28,9 @@
 author = u'C. W.'
 
 # The short X.Y version
-version = u'0.3.9'
+version = u'0.3.10'
 # The full version, including alpha/beta/rc tags
-release = u'0.3.9'
+release = u'0.3.10'
 
 
 # -- General configuration ---------------------------------------------------

docs/level-10-moban-dependency-as-git-repo/README.rst

@@ -35,5 +35,6 @@ The alternative syntax is::
        - type: git
          url: https://github.com/your-git-url
          submodule: true
+         branch: your_choice_or_default_branch_if_not_specified
     ...
 

docs/level-13-any-data-override-any-data/.moban.cd/parent.json

@@ -0,0 +1,4 @@
+{
+    "nihao": "shijie from parent.json",
+    "hello": "shijie from parent.json"
+}

docs/level-13-any-data-override-any-data/.moban.cd/parent.yaml

@@ -0,0 +1,2 @@
+nihao: shijie from parent.yaml
+hello: shijie

docs/level-13-any-data-override-any-data/.moban.td/base.jj2

@@ -0,0 +1,9 @@
+{%block header %}
+{%endblock%}
+
+{{hello}}
+
+{{nihao}}
+
+{%block footer %}
+{%endblock%}

docs/level-13-any-data-override-any-data/README.rst

@@ -0,0 +1,52 @@
+Level 13: any data override any data
+================================================================================
+
+It's thought that why shall we constrain ourselves on yaml file format. Along
+the development path, json file format was added. What about other file formats?
+
+By default yaml, json is supported. Due to the new capability `overrides` key
+word can override any supported data format::
+
+    overrides: data.base.json
+    ....
+
+or simple use `.json` data instead of `.yaml` data.
+
+Evaluation
+--------------------------------------------------------------------------------
+
+Please change directory to `docs/level-13-any-data-override-any-data` directory.
+
+In this example, `child.yaml` overrides `.moban.cd/parent.json`, here is the
+command to launch it:
+
+.. code-block:: bash
+
+    moban -c child.yaml -t a.template
+
+'moban.output' is the generated file::
+
+    ========header============
+
+    world from child.yaml
+
+    shijie from parent.json
+
+    ========footer============
+
+
+And we can try `child.json`, which you can guess, overrides `.moban.cd/parent.yaml`
+
+.. code-block:: bash
+
+    moban -c child.json -t a.template
+
+'moban.output' is the generated file::
+
+   ========header============
+
+   world from child.json
+
+   shijie from parent.yml
+
+   ========footer============

docs/level-13-any-data-override-any-data/a.template

@@ -0,0 +1,9 @@
+{%extends 'base.jj2' %}
+
+{%block header %}
+========header============
+{%endblock%}
+
+{%block footer %}
+========footer============
+{%endblock%}

docs/level-13-any-data-override-any-data/child.json

@@ -0,0 +1,4 @@
+{
+    "overrides": "parent.yaml",
+    "hello": "world from child.json"
+}

docs/level-13-any-data-override-any-data/child.yaml

@@ -0,0 +1,2 @@
+overrides: parent.json
+hello: world from child.yaml

docs/level-14-custom-data-loader/.moban.cd/parent.custom

@@ -0,0 +1,2 @@
+hello,nihao
+world from parent.cusom,shijie from parent.custom

docs/level-14-custom-data-loader/.moban.cd/parent.json

@@ -0,0 +1,4 @@
+{
+    "nihao": "shijie from parent.json",
+    "hello": "shijie from parent.json"
+}

docs/level-14-custom-data-loader/.moban.td/base.jj2

@@ -0,0 +1,9 @@
+{%block header %}
+{%endblock%}
+
+{{hello}}
+
+{{nihao}}
+
+{%block footer %}
+{%endblock%}

docs/level-14-custom-data-loader/.moban.yml

@@ -0,0 +1,9 @@
+configuration:
+  plugin_dir:
+    - custom-data-loader
+  template: a.template
+targets:
+  - output: a.output
+    configuration: child.custom
+  - output: b.output
+    configuration: override_custom.yaml

docs/level-14-custom-data-loader/README.rst

@@ -0,0 +1,71 @@
+Level 14: custom data loader
+================================================================================
+
+Continuing from level 13, `moban` since v0.4.0 allows data loader extension.
+Due to the new capability `overrides` key word can override any
+data format::
+
+    overrides: yours.custom
+    ....
+
+or simple use `.custom` data instead of `.yaml` data.
+
+However, you will need to provide a data loader for `.custom` yourselves.
+
+Evaluation
+--------------------------------------------------------------------------------
+
+Please change directory to `docs/level-14-custom-data-loader` directory.
+
+
+In this tutorial, a custom data loader was provided to show case its dataloader
+extension. Here is the mobanfile::
+
+   configuration:
+     plugin_dir:
+       - custom-data-loader
+     template: a.template
+   targets:
+     - output: a.output
+       configuration: child.custom
+     - output: b.output
+       configuration: override_custom.yaml
+
+`custom-data-loader` is a directory where custom.py lives. The protocol is
+that the custom loader register itself to a file extension and return
+a data dictionary confirming mobanfile schema. On call, `moban` will provide
+an absolute file name for your loader to work on.
+
+
+Here is the code to do the registration:
+
+.. code-block:: python
+
+   @PluginInfo(constants.DATA_LOADER_EXTENSION, tags=["custom"])
+
+
+In order to evaluate, you can simply type::
+
+   $ moban
+   $ cat a.output
+   ========header============
+
+   world from child.cusom
+
+   shijie from parent.json
+
+   ========footer============
+   $ cat b.output
+   ========header============
+
+   world from override_custom.yaml
+
+   shijie from parent.custom
+
+   ========footer============
+
+
+.. warning::
+
+   Python 2 dictates the existence of __init__.py in the plugin directory. Otheriwse
+   your plugin won't load

docs/level-14-custom-data-loader/a.template

@@ -0,0 +1,9 @@
+{%extends 'base.jj2' %}
+
+{%block header %}
+========header============
+{%endblock%}
+
+{%block footer %}
+========footer============
+{%endblock%}

docs/level-14-custom-data-loader/b.output

@@ -0,0 +1,7 @@
+========header============
+
+world from override_custom.yaml
+
+shijie from parent.custom
+
+========footer============

docs/level-14-custom-data-loader/child.custom

@@ -0,0 +1,2 @@
+hello,overrides
+world from child.cusom,parent.json

docs/level-14-custom-data-loader/custom-data-loader/custom.py

@@ -0,0 +1,17 @@
+import csv
+
+from lml.plugin import PluginInfo
+
+from moban import constants
+
+
+@PluginInfo(constants.DATA_LOADER_EXTENSION, tags=["custom"])
+def open_custom(file_name):
+    with open(file_name, "r") as data_csv:
+        csvreader = csv.reader(data_csv)
+        rows = []
+        for row in csvreader:
+            rows.append(row)
+
+        data = dict(zip(rows[0], rows[1]))
+        return data

docs/level-14-custom-data-loader/override_custom.yaml

@@ -0,0 +1,2 @@
+overrides: parent.custom
+hello: world from override_custom.yaml

docs/level-3-data-override/README.rst

@@ -21,7 +21,7 @@ command to launch it:
 
     moban -c data.yaml -t a.template
 
-'a.output' is the generated file::
+'moban.output' is the generated file::
 
     ========header============
 

moban/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.3.9"
+__version__ = "0.3.10"
 __author__ = "C. W."