Merge pull request #3 from dabapps/alias-setting

Add optional WRAPWITH_TEMPLATES setting to define wrapper template aliases

Author: j4mie

README.md

@@ -40,7 +40,27 @@ Then, in your main page template:
 </html>
 ```
 
-That's it!
+### Optional: aliasing templates
+
+If you find writing out the full template path every time you use a component too verbose, you can define a dictionary of "aliases" in your Django settings, using the setting name `WRAPWITH_TEMPLATES`. This dictionary can be nested. You can then use a dotted path into this dictionary in your templates.
+
+In your `settings.py`:
+
+```python
+WRAPWITH_TEMPLATES = {
+  "wrappers": {
+    "box": "wrappers/box.html",
+  },
+}
+```
+
+In your template:
+
+```html
+{% wrapwith wrappers.box with bordercol="red" %}
+  <p>this is inside a red box</p>
+{% endwrapwith %}
+```
 
 Tested on Python 3 with all currently supported Django versions.
 

tests/templates/alias.html

@@ -0,0 +1,5 @@
+{% load wrapwith %}
+
+{% wrapwith div %}
+hello!
+{% endwrapwith %}

tests/templates/alias_with_dots.html

@@ -0,0 +1,5 @@
+{% load wrapwith %}
+
+{% wrapwith a.b.c %}
+hello!
+{% endwrapwith %}

tests/tests.py

@@ -1,5 +1,5 @@
 from django.template.loader import render_to_string
-from django.test import TestCase
+from django.test import override_settings, TestCase
 
 
 class WrapWithTestCase(TestCase):
@@ -33,3 +33,13 @@ def test_nested(self):
             something after
         """,
         )
+
+    @override_settings(WRAPWITH_TEMPLATES={"div": "wrappers/div.html"})
+    def test_alias(self):
+        rendered = render_to_string("alias.html")
+        self.assertHTMLEqual(rendered, "<div>hello!</div>")
+
+    @override_settings(WRAPWITH_TEMPLATES={"a": {"b": {"c": "wrappers/div.html"}}})
+    def test_dotted_alias(self):
+        rendered = render_to_string("alias_with_dots.html")
+        self.assertHTMLEqual(rendered, "<div>hello!</div>")

wrapwith/templatetags/wrapwith.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.template import Library
 from django.template.loader_tags import do_include
 
@@ -27,6 +28,21 @@ def resolve(self, context):
         return self.nodelist.render(context)
 
 
+class ResolveWithAliases:
+    """
+    Wraps a FilterExpression and injects the WRAPWITH_TEMPLATES alias
+    dictionary into its context before resolving the variable name.
+    """
+
+    def __init__(self, template):
+        self.template = template
+        self.aliases = getattr(settings, "WRAPWITH_TEMPLATES", {})
+
+    def resolve(self, context):
+        with context.push(self.aliases):
+            return self.template.resolve(context)
+
+
 @register.tag(name="wrapwith")
 def do_wrapwith(parser, token):
     """
@@ -36,5 +52,6 @@ def do_wrapwith(parser, token):
     include_node = do_include(parser, token)
     nodelist = parser.parse(("endwrapwith",))
     parser.delete_first_token()
+    include_node.template = ResolveWithAliases(include_node.template)
     include_node.extra_context["wrapped"] = RenderNodelistVariable(nodelist)
     return include_node