Merge pull request #400 from moremoban/dev

release 0.8.1

Author: chfw

.moban.cd/changelog.yml

@@ -1,6 +1,13 @@
 name: moban
 organisation: moremoban
 releases:
+  - changes:
+      - action: Fixed
+        details:
+          - "`#399`: content processor should be called only once"
+          - "content processor shall pass on options to content processors"
+    date: 04.09.2020
+    version: 0.8.1
   - changes:
       - action: Removed
         details:

.moban.cd/moban.yml

@@ -4,9 +4,9 @@ organisation: moremoban
 author: chfw
 contact: [email protected]
 license: MIT
-version: 0.8.0
-current_version: 0.8.0
-release: 0.8.0
+version: 0.8.1
+current_version: 0.8.1
+release: 0.8.1
 branch: master
 master: index
 command_line_interface: "moban"

.moban.d/moban_readme.jj2

@@ -216,7 +216,7 @@ Given the following template type function, and saved in custom-plugin dir:
 
 
    @ContentProcessor("de-duplicate", "De-duplicating", "De-duplicated")
-   def de_duplicate(content: str) -> str:
+   def de_duplicate(content: str, options: dict) -> str:
        lines = content.split(b'\n')
        new_lines = []
        for line in lines:

.travis.yml

@@ -30,7 +30,7 @@ stages:
   env:
     - MINREQ=0
   stage: moban
-  install: pip install moban>=0.0.4 gitfs2 pypifs moban-jinja2-github
+  install: pip install moban gitfs2 pypifs moban-jinja2-github moban-ansible
   script: make update git-diff-check
 
 jobs:

CHANGELOG.rst

@@ -1,6 +1,15 @@
 Change log
 ================================================================================
 
+0.8.1 - 04.09.2020
+--------------------------------------------------------------------------------
+
+**Fixed**
+
+#. `#399 <https://github.com/moremoban/moban/issues/399>`_: content processor
+   should be called only once
+#. content processor shall pass on options to content processors
+
 0.8.0 - 02.09.2020
 --------------------------------------------------------------------------------
 

Makefile

@@ -21,12 +21,7 @@ lint:
 	yamllint -d "{extends: default, ignore: .moban.cd/changelog.yml}" .
 
 format:
-	isort $(find moban -name "*.py"|xargs echo) $(find tests -name "*.py"|xargs echo)
-	git diff
-	black -l 79 moban
-	git diff
-	black -l 79 tests
-	git diff
+	bash format.sh
 
 uml:
 	plantuml -tsvg -o ./images/ docs/*.uml

README.rst

@@ -340,7 +340,7 @@ Given the following template type function, and saved in custom-plugin dir:
    
    
    @ContentProcessor("de-duplicate", "De-duplicating", "De-duplicated")
-   def de_duplicate(content: str) -> str:
+   def de_duplicate(content: str, options: dict) -> str:
        lines = content.split(b'\n')
        new_lines = []
        for line in lines:

docs/conf.py

@@ -25,9 +25,9 @@
 copyright = '2017-2020 Onni Software Ltd.'
 author = 'chfw'
 # The short X.Y version
-version = '0.8.0'
+version = '0.8.1'
 # The full version, including alpha/beta/rc tags
-release = '0.8.0'
+release = '0.8.1'
 
 # -- General configuration ---------------------------------------------------
 

format.sh

@@ -0,0 +1,3 @@
+isort $(find moban -name "*.py"|xargs echo) $(find tests -name "*.py"|xargs echo)
+black -l 79 moban
+black -l 79 tests

moban/__init__.py

@@ -1,4 +1,3 @@
-from moban._version import __version__
-from moban._version import __author__
+from moban._version import __author__, __version__
 
 __all__ = ("__author__", "__version__")

moban/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.8.0"
+__version__ = "0.8.1"
 __author__ = "chfw"

moban/core/content_processor.py

@@ -31,20 +31,19 @@ class CustomEngine(object):
             ACTION_IN_PRESENT_CONTINUOUS_TENSE = continuing_tense
             ACTION_IN_PAST_TENSE = past_tense
 
-            def __init__(self, template_fs, extensions=None):
+            def __init__(self, template_fs, options=None):
                 self.template_fs = template_fs
+                self.options = options
 
             def get_template(self, template_file):
                 content = self.template_fs.readbytes(template_file)
-                ret = a_content_processor_function(content)
-                return ret
+                return content
 
             def get_template_from_string(self, a_string):
-                ret = a_content_processor_function(a_string)
-                return ret
+                return a_string
 
             def apply_template(self, template, *_):
-                ret = a_content_processor_function(template)
+                ret = a_content_processor_function(template, self.options)
                 return ret
 
         super(ContentProcessor, self).__call__(CustomEngine)

moban/plugins/copy.py

@@ -2,7 +2,7 @@
 
 
 @ContentProcessor("copy", "Copying", "Copied")
-def copy(content: str) -> str:
+def copy(content: str, _: dict) -> str:
     """
     Does no templating, works like 'copy'.
 

moban/plugins/delete.py

@@ -17,7 +17,7 @@ class DeleteEngine(object):
     ACTION_IN_PRESENT_CONTINUOUS_TENSE = "Deleting"
     ACTION_IN_PAST_TENSE = "Deleted"
 
-    def __init__(self, template_fs, extensions=None):
+    def __init__(self, template_fs, options=None):
         self.template_fs = template_fs
 
     def get_template(self, template_file):

moban/plugins/jinja2/engine.py

@@ -7,10 +7,10 @@
 from jinja2 import Environment
 from lml.loader import scan_plugins_regex
 from lml.plugin import PluginInfo, PluginManager
-from jinja2_fsloader import FSLoader
 from jinja2.exceptions import TemplateNotFound, TemplateSyntaxError
 
 from moban import constants, exceptions
+from jinja2_fsloader import FSLoader
 from moban.externals import file_system
 
 JINJA2_LIBRARIES = "^moban_jinja2_.+$"

moban/plugins/strip.py

@@ -2,6 +2,6 @@
 
 
 @ContentProcessor("strip", "Stripping", "Stripped")
-def strip(content: str) -> str:
+def strip(content: str, _: dict) -> str:
     """Works like 'copy', but strip empty spaces before and after"""
     return content.strip()

mobanfile

@@ -14,7 +14,6 @@ configuration:
 targets:
   - README.rst: moban_readme.jj2
   - setup.py: moban_setup.py.jj2
-  - moban/__init__.py: __init__.py.jj2
   - moban/_version.py: _version.py.jj2
   - docs/conf.py: conf.py.jj2
   - .travis.yml: moban_travis.yml.jj2
@@ -26,4 +25,4 @@ targets:
   - min_requirements.txt: min_requirements.txt.jj2
   - ".github/workflows/pythonpublish.yml": "pythonpublish.yml"
   - "CONTRIBUTORS.rst": "CONTRIBUTORS.rst.jj2"
-
+  - format.sh: format.sh.jj2

setup.py

@@ -41,7 +41,7 @@
 
 NAME = "moban"
 AUTHOR = "chfw"
-VERSION = "0.8.0"
+VERSION = "0.8.1"
 EMAIL = "[email protected]"
 LICENSE = "MIT"
 ENTRY_POINTS = {
@@ -53,7 +53,7 @@
     "General purpose static text generator"
 )
 URL = "https://github.com/moremoban/moban"
-DOWNLOAD_URL = "%s/archive/0.8.0.tar.gz" % URL
+DOWNLOAD_URL = "%s/archive/0.8.1.tar.gz" % URL
 FILES = ["README.rst", "CONTRIBUTORS.rst", "CHANGELOG.rst"]
 KEYWORDS = [
     "python",
@@ -97,8 +97,8 @@
 }
 # You do not need to read beyond this line
 PUBLISH_COMMAND = "{0} setup.py sdist bdist_wheel upload -r pypi".format(sys.executable)
-GS_COMMAND = ("gs moban v0.8.0 " +
-              "Find 0.8.0 in changelog for more details")
+GS_COMMAND = ("gs moban v0.8.1 " +
+              "Find 0.8.1 in changelog for more details")
 NO_GS_MESSAGE = ("Automatic github release is disabled. " +
                  "Please install gease to enable it.")
 UPLOAD_FAILED_MSG = (

tests/regression_tests/level-7-b-template-engine-plugin/custom-plugin/deduplicate.py

@@ -2,7 +2,7 @@
 
 
 @ContentProcessor("de-duplicate", "De-duplicating", "De-duplicated")
-def de_duplicate(content: str) -> str:
+def de_duplicate(content: str, _: dict) -> str:
     """
     Does no templating, works like 'copy'.
 

tests/requirements.txt

@@ -18,3 +18,4 @@ jinja2-python-version>=1.1.2
 httpfs
 collective.checkdocs
 Pygments
+

tests/test_file_system.py

@@ -268,6 +268,7 @@ def test_mkdir_p():
 @patch("subprocess.check_call")
 def test_pip_install(fake_check_all):
     import sys
+
     from moban.deprecated import pip_install
 
     pip_install(["package1", "package2"])

tests/test_main.py

@@ -30,9 +30,10 @@ def test_handle_moban_file(self):
         main.handle_moban_file(self.moban_file, {})
 
     def test_check_none(self):
-        import moban.main as main
         from ruamel.yaml import YAML
 
+        import moban.main as main
+
         yaml = YAML()
 
         invalid_data = [