v0.8.0a3: Fixes & backwards compatibility

- Allow undefined variables in templates & preprocessor by default.
  Define config file settings & CLI flags to change this.
- Allow --bypass_errors to skip over duplicate YAML keys.

Author: mDuo13

dactyl/cli.py

@@ -76,6 +76,12 @@ def __init__(self, utility):
                                 help="Don't automatically add a cover / index file.")
             parser.add_argument("--skip_preprocessor", action="store_true", default=False,
                                 help="Don't pre-process Jinja syntax in markdown files")
+            parser.add_argument("--template_strict_undefined", action="store_true",
+                                help="Raise an error on undefined variables in "+
+                                "template syntax.")
+            parser.add_argument("--pp_strict_undefined", action="store_true",
+                                help="Raise an error on undefined variables in "+
+                                "preprocessor syntax.")
             parser.add_argument("--title", type=str, help="Override target display "+\
                                 "name. Useful when passing multiple args to --pages.")
             parser.add_argument("--vars", type=str, help="A YAML or JSON file with vars "+

dactyl/config.py

@@ -27,6 +27,8 @@ def __init__(self, cli_args):
             exit(0)
 
         self.bypass_errors = cli_args.bypass_errors
+        if self.bypass_errors:
+            yaml.allow_duplicate_keys = True
 
         # Start with the default config, then overwrite later
         self.config = yaml.load(resource_stream(__name__, "default-config.yml"))
@@ -183,6 +185,11 @@ def load_build_options(self):
 
         self.config["skip_preprocessor"] = self.cli_args.skip_preprocessor
 
+        if self.cli_args.template_strict_undefined:
+            self.config["template_allow_undefined"] = False
+        if self.cli_args.pp_strict_undefined:
+            self.config["preprocessor_allow_undefined"] = False
+
     def html_filename_from(self, page):
         """Take a page definition and choose a reasonable HTML filename for it."""
         if "md" in page:

dactyl/dactyl_build.py

@@ -318,7 +318,11 @@ def preprocess_markdown(page, target=None, categories=[], page_filters=[],
                 md = f.read()
 
     else:
-        pp_env = setup_pp_env(page, page_filters=page_filters, bypass_errors=bypass_errors)
+        if config["preprocessor_allow_undefined"] == False and not bypass_errors:
+            strict_undefined = True
+        else:
+            strict_undefined = False
+        pp_env = setup_pp_env(page, page_filters=page_filters, strict_undefined=strict_undefined)
         md_raw = pp_env.get_template(page["md"])
         md = md_raw.render(
             currentpage=page,
@@ -435,12 +439,12 @@ def get_page_where(page=None):
         return False, config["content_path"]
 
 
-def setup_pp_env(page=None, page_filters=[], no_loader=False, bypass_errors=False):
+def setup_pp_env(page=None, page_filters=[], no_loader=False, strict_undefined=False):
     remote, path = get_page_where(page)
-    if bypass_errors:
-        preferred_undefined = jinja2.Undefined
-    else:
+    if strict_undefined:
         preferred_undefined = jinja2.StrictUndefined
+    else:
+        preferred_undefined = jinja2.Undefined
     if remote:
         logger.debug("Using remote template loader for page %s" % page)
         pp_env = jinja2.Environment(undefined=preferred_undefined,
@@ -473,29 +477,35 @@ def undefined_or_ne(a,b):
     return pp_env
 
 
-def setup_html_env(bypass_errors=False):
-    if bypass_errors:
-        preferred_undefined = jinja2.Undefined
-    else:
+def setup_html_env(strict_undefined=False):
+    if strict_undefined:
         preferred_undefined = jinja2.StrictUndefined
+    else:
+        preferred_undefined = jinja2.Undefined
     if "template_path" in config:
         env = jinja2.Environment(undefined=preferred_undefined,
                 loader=jinja2.FileSystemLoader(config["template_path"]))
-        # add custom "defined_and_" tests
-        def defined_and_equalto(a,b):
-            return env.tests["defined"](a) and env.tests["equalto"](a, b)
-        env.tests["defined_and_equalto"] = defined_and_equalto
-        def undefined_or_ne(a,b):
-            return env.tests["undefined"](a) or env.tests["ne"](a, b)
-        env.tests["undefined_or_ne"] = undefined_or_ne
     else:
         env = setup_fallback_env()
+
+    # Customize env: add custom tests, lstrip & trim blocks
+    def defined_and_equalto(a,b):
+        return env.tests["defined"](a) and env.tests["equalto"](a, b)
+    env.tests["defined_and_equalto"] = defined_and_equalto
+    def undefined_or_ne(a,b):
+        return env.tests["undefined"](a) or env.tests["ne"](a, b)
+    env.tests["undefined_or_ne"] = undefined_or_ne
+
     env.lstrip_blocks = True
     env.trim_blocks = True
     return env
 
 
 def setup_fallback_env():
+    """
+    Set up a Jinja env to load templates from the package. These templates
+    assume that we're not using StrictUndefined.
+    """
     env = jinja2.Environment(loader=jinja2.PackageLoader(__name__))
     env.lstrip_blocks = True
     env.trim_blocks = True
@@ -669,7 +679,11 @@ def render_es_json(currentpage, es_template, pages=[], target=None, categories=[
         "bypass_errors": bypass_errors,
     }
 
-    es_env = setup_pp_env(no_loader=True, bypass_errors=bypass_errors)
+    if config["preprocessor_allow_undefined"] == False and not bypass_errors:
+        strict_undefined = True
+    else:
+        strict_undefined = False
+    es_env = setup_pp_env(no_loader=True, strict_undefined=strict_undefined)
 
     def render_es_field(value, context):
         if type(value) == str: # jinja-render strings
@@ -741,8 +755,12 @@ def render_pages(target=None, mode="html", bypass_errors=False,
         # Note: this doesn't delete the old index
 
     if mode == "pdf" or mode == "html":
+        if config["template_allow_undefined"] == False and not bypass_errors:
+            strict_undefined = True
+        else:
+            strict_undefined = False
         # Insert generated HTML into templates using this Jinja environment
-        env = setup_html_env(bypass_errors=bypass_errors)
+        env = setup_html_env(strict_undefined=strict_undefined)
         fallback_env = setup_fallback_env()
     if mode == "pdf":
         out_path = temp_files_path or temp_dir()

dactyl/default-config.yml

@@ -43,6 +43,12 @@ prince_executable: prince
 ## If this is true, parses the files as Markdown without Jinja syntax
 skip_preprocessor: false
 
+## Set these to false to raise an error referring to a
+## field that doesn't exist, such as {{ foo }} or {% if foo %}
+## These settings are ignored when running with --bypass_errors.
+template_allow_undefined: true
+preprocessor_allow_undefined: true
+
 ## By default, generates HTML paths from md paths by replacing / with -
 ## Set this to false to make default HTML paths mirror the folder structure of
 ## the input md files.

dactyl/version.py

@@ -1 +1 @@
-__version__ = '0.8.0a2'
+__version__ = '0.8.0a3'

examples/plainlanguage_phrases.yaml

@@ -50,7 +50,6 @@ it is essential: must, need to
 it is requested: please, we request, I request
 limited number: limits
 not later than: by, before
-not later than: by
 pertaining to: about, of, on
 prior to: before
 provided that: if