Extension at cli, -e jinja2='jinja2_python_version.PythonVersionExten…

…sion' (#332)

* ✨ support cli option -e, user defined extension. resolves #257

* 🐛 update code

* ✨ support cli extensions. #257

* 💚 updated broken tests

* 🔥 take the test for now

* 👕 update coding style

* 🔬 add test case

* 📚 update change log

* 🔥 do not test -e on python 2 because 3rd party extension does not work on python 2, which is not an issue beyond 2020

* 🐛 check jj2, alias of jinja2 works too

* 👕 code style and variable name update

* 📚 prepare for release

.moban.cd/changelog.yml

@@ -5,7 +5,9 @@ releases:
       - action: Added
         details:
           - "`#322`: Implicit targets with template extensions default to copy"
-    date: tbd
+          - "`#257`: '-e' to load extensions for template engines, i.e. jinja2"
+          - "`#333`: command line template fails with version 0.6.1"
+    date: 15.09.2019
     version: 0.6.2
   - changes:
       - action: Fixed

.moban.cd/moban.yml

@@ -6,7 +6,7 @@ contact: wangc_2011@hotmail.com
 license: MIT
 version: 0.6.2
 current_version: 0.6.2
-release: 0.6.1
+release: 0.6.2
 branch: master
 master: index
 command_line_interface: "moban"

CHANGELOG.rst

@@ -1,14 +1,18 @@
 Change log
 ================================================================================
 
-0.6.2 - tbd
+0.6.2 - 15.09.2019
 --------------------------------------------------------------------------------
 
 Added
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 #. `#322 <https://github.com/moremoban/moban/issues/322>`_: Implicit targets
    with template extensions default to copy
+#. `#257 <https://github.com/moremoban/moban/issues/257>`_: '-e' to load
+   extensions for template engines, i.e. jinja2
+#. `#333 <https://github.com/moremoban/moban/issues/333>`_: command line
+   template fails with version 0.6.1
 
 0.6.1 - 10.09.2019
 --------------------------------------------------------------------------------

docs/conf.py

@@ -27,7 +27,7 @@
 # The short X.Y version
 version = '0.6.2'
 # The full version, including alpha/beta/rc tags
-release = '0.6.1'
+release = '0.6.2'
 
 # -- General configuration ---------------------------------------------------
 

moban/constants.py

@@ -37,7 +37,9 @@
 LABEL_VERSION = "version"
 LABEL_GROUP = "group"
 LABEL_DEFINE = "define"
+LABEL_EXTENSION = "extension"
 CLI_DICT = "user_dict"
+EXTENSION_DICT = "user_extensions"
 
 DEFAULT_CONFIGURATION_DIRNAME = ".%s.cd" % PROGRAM_NAME
 DEFAULT_TEMPLATE_DIRNAME = ".%s.td" % PROGRAM_NAME

moban/core/moban_factory.py

@@ -1,6 +1,7 @@
 import os
 import sys
 import logging
+from collections import defaultdict
 
 from moban import utils, reporter, constants, exceptions, file_system
 from fs.errors import ResourceNotFound
@@ -18,11 +19,24 @@
 class MobanFactory(PluginManager):
     def __init__(self):
         super(MobanFactory, self).__init__(constants.TEMPLATE_ENGINE_EXTENSION)
-        self.extensions = {}
+        self.extensions = defaultdict(set)
         self.options_registry = {}
 
     def register_extensions(self, extensions):
-        self.extensions.update(extensions)
+        for user_template_type in extensions.keys():
+            template_type = self.get_primary_key(user_template_type)
+
+            log.debug(
+                "Registering extensions: {0}={1}".format(
+                    user_template_type, extensions[user_template_type]
+                )
+            )
+            if template_type in self.extensions:
+                self.extensions[template_type] = self.extensions[
+                    user_template_type
+                ].union(extensions[user_template_type])
+            else:
+                self.extensions[template_type] = extensions[user_template_type]
 
     def register_options(self, template_types):
         # need the value of 'template_types'
@@ -34,6 +48,7 @@ def get_engine(self, template_type, template_dirs, context_dirs):
         template_dirs = utils.verify_the_existence_of_directories(
             template_dirs
         )
+
         if template_type in self.options_registry:
             custom_engine_spec = self.options_registry[template_type]
             engine_cls = self.load_me_now(
@@ -43,7 +58,10 @@ def get_engine(self, template_type, template_dirs, context_dirs):
         else:
             engine_cls = self.load_me_now(template_type)
             engine_extensions = self.extensions.get(template_type)
-            options = dict(extensions=engine_extensions)
+            if engine_extensions:
+                options = dict(extensions=list(engine_extensions))
+            else:
+                options = dict()
         template_fs = file_system.get_multi_fs(template_dirs)
         engine = engine_cls(template_fs, options)
         return MobanEngine(template_fs, context_dirs, engine)

moban/jinja2/engine.py

@@ -2,6 +2,7 @@
 import logging
 from importlib import import_module
 
+import fs.errors
 from moban import constants, file_system
 from jinja2 import Template, Environment
 from lml.loader import scan_plugins_regex
@@ -11,7 +12,7 @@
 from jinja2_fsloader import FSLoader
 
 JINJA2_LIBRARIES = "^moban_jinja2_.+$"
-JINJA2_EXENSIONS = [
+JINJA2_EXTENSIONS = [
     "moban.jinja2.filters.repr",
     "moban.jinja2.filters.github",
     "moban.jinja2.filters.text",
@@ -87,7 +88,6 @@ def __init__(self, template_fs, options=None):
                     # because it is modified here
                     env_params["extensions"] += extensions
                     import_module_of_extension(extensions)
-
             env_params.update(options)
         self.jj2_environment = Environment(**env_params)
         for filter_name, filter_function in FILTERS.get_all():
@@ -117,10 +117,13 @@ def get_template(self, template_file):
         """
         try:
             template = self.jj2_environment.get_template(template_file)
+            return template
         except TemplateNotFound:
-            content = file_system.read_unicode(template_file)
-            return Template(content)
-        return template
+            try:
+                content = file_system.read_unicode(template_file)
+                return self.jj2_environment.from_string(content)
+            except fs.errors.ResourceNotFound:
+                return self.jj2_environment.from_string(template_file)
 
     def get_template_from_string(self, string):
         return Template(string)
@@ -143,7 +146,7 @@ def apply_template(self, template, data, output):
 
 
 def load_jinja2_extensions():
-    scan_plugins_regex(JINJA2_LIBRARIES, "moban", None, JINJA2_EXENSIONS)
+    scan_plugins_regex(JINJA2_LIBRARIES, "moban", None, JINJA2_EXTENSIONS)
 
 
 def is_extension_list_valid(extensions):

moban/main.py

@@ -12,6 +12,7 @@
 import logging
 import argparse
 import logging.config
+from collections import defaultdict
 
 from moban import (
     core,
@@ -37,15 +38,17 @@ def main():
     """
     parser = create_parser()
     options = vars(parser.parse_args())
+    handle_verbose(options[constants.LABEL_VERBOSE])
+    load_engine_factory_and_engines()  # Error: jinja2 if removed
     HASH_STORE.IGNORE_CACHE_FILE = options[constants.LABEL_FORCE]
     options[constants.CLI_DICT] = handle_custom_variables(
         options.pop(constants.LABEL_DEFINE)
     )
+    options[constants.EXTENSION_DICT] = handle_custom_extensions(
+        options.pop(constants.LABEL_EXTENSION)
+    )
     OPTIONS.update(options)
-    handle_verbose(options[constants.LABEL_VERBOSE])
-
     moban_file = options[constants.LABEL_MOBANFILE]
-    load_engine_factory_and_engines()  # Error: jinja2 if removed
     if moban_file is None:
         moban_file = find_default_moban_file()
     if moban_file:
@@ -155,6 +158,12 @@ def create_parser():
         nargs="+",
         help="to take a list of VAR=VALUEs",
     )
+    parser.add_argument(
+        "-e",
+        "--%s" % constants.LABEL_EXTENSION,
+        nargs="+",
+        help="to add an extension to TEMPLATE_TYPE=EXTENSION_NAME",
+    )
     return parser
 
 
@@ -265,6 +274,15 @@ def handle_custom_variables(list_of_definitions):
     return custom_data
 
 
+def handle_custom_extensions(list_of_definitions):
+    user_extensions = defaultdict(set)
+    if list_of_definitions:
+        for definition in list_of_definitions:
+            key, value = definition.split("=")
+            user_extensions[key].add(value)
+    core.ENGINES.register_extensions(user_extensions)
+
+
 def handle_verbose(verbose_level):
     if verbose_level > len(LOG_LEVEL):
         verbose_level = 3

setup.py

@@ -50,7 +50,7 @@
     "Yet another jinja2 cli command for static text generation"
 )
 URL = "https://github.com/moremoban/moban"
-DOWNLOAD_URL = "%s/archive/0.6.1.tar.gz" % URL
+DOWNLOAD_URL = "%s/archive/0.6.2.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.6.1 " +
-              "Find 0.6.1 in changelog for more details")
+GS_COMMAND = ("gs moban v0.6.2 " +
+              "Find 0.6.2 in changelog for more details")
 NO_GS_MESSAGE = ("Automatic github release is disabled. " +
                  "Please install gease to enable it.")
 UPLOAD_FAILED_MSG = (

tests/integration_tests/test_command_line_options.py

@@ -3,6 +3,7 @@
 from shutil import copyfile
 
 from mock import patch
+from nose import SkipTest
 from nose.tools import eq_, raises, assert_raises
 from moban.definitions import TemplateTarget
 
@@ -109,15 +110,6 @@ def tearDown(self):
         os.unlink(self.config_file)
 
 
-@raises(Exception)
-def test_missing_configuration():
-    test_args = ["moban", "-t", "a.jj2"]
-    with patch.object(sys, "argv", test_args):
-        from moban.main import main
-
-        main()
-
-
 class TestNoOptions:
     def setUp(self):
         self.config_file = ".moban.yml"
@@ -476,7 +468,7 @@ def test_git_repo_example(_):
         main()
         with open("test_git_repo_example.py") as f:
             content = f.read()
-            eq_(content, '__version__ = "0.1.1rc3"\n__author__ = "C.W."')
+            eq_(content, '__version__ = "0.1.1rc3"\n__author__ = "C.W."\n')
         os.unlink("test_git_repo_example.py")
 
 
@@ -497,5 +489,38 @@ def test_pypi_pkg_example(_):
         main()
         with open("test_pypi_pkg_example.py") as f:
             content = f.read()
-            eq_(content, '__version__ = "0.1.1rc3"\n__author__ = "C.W."')
+            eq_(content, '__version__ = "0.1.1rc3"\n__author__ = "C.W."\n')
         os.unlink("test_pypi_pkg_example.py")
+
+
+def test_add_extension():
+    if sys.version_info[0] == 2:
+        raise SkipTest("jinja2-python-version does not support python 2")
+    test_commands = [
+        [
+            "moban",
+            "-t",
+            "{{ python_version }}",
+            "-e",
+            "jinja2=jinja2_python_version.PythonVersionExtension",
+        ],
+        [
+            "moban",
+            "-t",
+            "{{ python_version }}",
+            "-e",
+            "jj2=jinja2_python_version.PythonVersionExtension",
+        ],
+    ]
+    for test_args in test_commands:
+        with patch.object(sys, "argv", test_args):
+            from moban.main import main
+
+            main()
+            with open("moban.output") as f:
+                content = f.read()
+                eq_(
+                    content,
+                    "{}.{}".format(sys.version_info[0], sys.version_info[1]),
+                )
+            os.unlink("moban.output")

tests/requirements.txt

@@ -14,3 +14,4 @@ arrow;python_version!="3.4"
 jinja2_time
 pypifs
 gitfs2
+jinja2-python-version