Merge branch 'robwa/master'

Author: adamghill

django_unicorn/errors.py

@@ -20,3 +20,7 @@ class MissingComponentElement(Exception):
 
 class MissingComponentViewElement(Exception):
     pass
+
+
+class ComponentNotValid(Exception):
+    pass

django_unicorn/templatetags/unicorn.py

@@ -2,10 +2,12 @@
 
 from django import template
 from django.conf import settings
+from django.template.base import FilterExpression
 
 import shortuuid
 
 from django_unicorn.call_method_parser import InvalidKwarg, parse_kwarg
+from django_unicorn.errors import ComponentNotValid
 
 
 register = template.Library()
@@ -42,15 +44,7 @@ def unicorn(parser, token):
             "%r tag requires at least a single argument" % token.contents.split()[0]
         )
 
-    tag_name = contents[0]
-    component_name = contents[1]
-
-    if not (
-        component_name[0] == component_name[-1] and component_name[0] in ('"', "'")
-    ):
-        raise template.TemplateSyntaxError(
-            "%r tag's argument should be in quotes" % tag_name
-        )
+    component_name = parser.compile_filter(contents[1])
 
     kwargs = {}
 
@@ -61,11 +55,11 @@ def unicorn(parser, token):
         except InvalidKwarg:
             pass
 
-    return UnicornNode(component_name[1:-1], kwargs)
+    return UnicornNode(component_name, kwargs)
 
 
 class UnicornNode(template.Node):
-    def __init__(self, component_name: str, kwargs: Dict = {}):
+    def __init__(self, component_name: FilterExpression, kwargs: Dict = {}):
         self.component_name = component_name
         self.kwargs = kwargs
         self.component_key = ""
@@ -107,9 +101,16 @@ def render(self, context):
 
         component_id = None
 
+        try:
+            component_name = self.component_name.resolve(context)
+        except AttributeError:
+            raise ComponentNotValid(
+                f"Component template is not valid: {self.component_name}."
+            )
+
         if self.parent:
             # Child components use the parent for part of the `component_id`
-            component_id = f"{self.parent.component_id}:{self.component_name}"
+            component_id = f"{self.parent.component_id}:{component_name}"
 
             if self.component_key:
                 component_id = f"{component_id}:{self.component_key}"
@@ -140,7 +141,7 @@ def render(self, context):
 
         view = UnicornView.create(
             component_id=component_id,
-            component_name=self.component_name,
+            component_name=component_name,
             component_key=self.component_key,
             parent=self.parent,
             kwargs=resolved_kwargs,

tests/templatetags/test_unicorn.py

@@ -1,26 +1,26 @@
-from django.template.base import Token, TokenType
+from django.template.base import Parser, Token, TokenType
 
 from django_unicorn.templatetags.unicorn import unicorn
 
 
 def test_unicorn():
     token = Token(TokenType.TEXT, "unicorn 'todo'")
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
 
-    assert unicorn_node.component_name == "todo"
+    assert unicorn_node.component_name.resolve({}) == "todo"
     assert len(unicorn_node.kwargs) == 0
 
 
 def test_unicorn_kwargs():
     token = Token(TokenType.TEXT, "unicorn 'todo' blob='blob'")
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
 
     assert unicorn_node.kwargs == {"blob": "blob"}
 
 
 def test_unicorn_args_and_kwargs():
     # args after the component name get ignored
     token = Token(TokenType.TEXT, "unicorn 'todo' '1' 2 hello='world' test=3 '4'")
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
 
     assert unicorn_node.kwargs == {"hello": "world", "test": 3}

tests/templatetags/test_unicorn_render.py

@@ -1,16 +1,21 @@
 import re
 
 from django.template import Context
-from django.template.base import Token, TokenType
+from django.template.base import Parser, Token, TokenType
 
 import pytest
 
 from django_unicorn.components import UnicornView
+from django_unicorn.errors import ComponentNotValid
 from django_unicorn.templatetags.unicorn import unicorn
 from django_unicorn.utils import generate_checksum
 from example.coffee.models import Flavor
 
 
+class FakeComponent(UnicornView):
+    template_name = "templates/test_component.html"
+
+
 class FakeComponentParent(UnicornView):
     template_name = "templates/test_component_parent.html"
 
@@ -66,7 +71,7 @@ def test_unicorn_render_kwarg():
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' test_kwarg='tested!'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {}
     actual = unicorn_node.render(Context(context))
 
@@ -78,7 +83,7 @@ def test_unicorn_render_context_variable():
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' test_kwarg=test_var.nested",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {"test_var": {"nested": "variable!"}}
     actual = unicorn_node.render(Context(context))
 
@@ -90,7 +95,7 @@ def test_unicorn_render_with_invalid_html():
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargsWithHtmlEntity' test_kwarg=test_var.nested",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {"test_var": {"nested": "variable!"}}
     actual = unicorn_node.render(Context(context))
 
@@ -103,7 +108,7 @@ def test_unicorn_render_parent(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' parent=view",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     view = FakeComponentParent(component_name="test", component_id="asdf")
     context = {"view": view}
     unicorn_node.render(Context(context))
@@ -121,7 +126,7 @@ def test_unicorn_render_parent_with_key(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' parent=view key='blob'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     view = FakeComponentParent(component_name="test", component_id="asdf")
     context = {"view": view}
     unicorn_node.render(Context(context))
@@ -138,7 +143,7 @@ def test_unicorn_render_parent_with_id(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' parent=view id='flob'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     view = FakeComponentParent(component_name="test", component_id="asdf")
     context = {"view": view}
     unicorn_node.render(Context(context))
@@ -155,7 +160,7 @@ def test_unicorn_render_parent_with_pk(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' parent=view pk=99",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     view = FakeComponentParent(component_name="test", component_id="asdf")
     context = {"view": view}
     unicorn_node.render(Context(context))
@@ -172,7 +177,7 @@ def test_unicorn_render_parent_with_model_id(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' parent=view model=model",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     view = FakeComponentParent(component_name="test", component_id="asdf")
 
     # Fake a model that only has an id
@@ -199,7 +204,7 @@ def test_unicorn_render_parent_with_model_pk(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' parent=view model=model",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     view = FakeComponentParent(component_name="test", component_id="asdf")
 
     flavor = Flavor(pk=187)
@@ -218,7 +223,7 @@ def test_unicorn_render_id_use_pk():
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentModel' model_id=model.id",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {"model": {"pk": 123}}
     actual = unicorn_node.render(Context(context))
 
@@ -231,7 +236,7 @@ def test_unicorn_render_component_one_script_tag(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {}
     html = unicorn_node.render(Context(context))
 
@@ -245,7 +250,7 @@ def test_unicorn_render_child_component_no_script_tag(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentKwargs' parent=view",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     view = FakeComponentParent(component_name="test", component_id="asdf")
     context = {"view": view}
     html = unicorn_node.render(Context(context))
@@ -259,7 +264,7 @@ def test_unicorn_render_parent_component_one_script_tag(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentParent'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {}
     html = unicorn_node.render(Context(context))
 
@@ -273,7 +278,7 @@ def test_unicorn_render_calls(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentCalls'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {}
     html = unicorn_node.render(Context(context))
 
@@ -288,7 +293,7 @@ def test_unicorn_render_calls_with_arg(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentCalls2'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {}
     html = unicorn_node.render(Context(context))
 
@@ -303,7 +308,7 @@ def test_unicorn_render_calls_no_mount_call(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentParent'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {}
     html = unicorn_node.render(Context(context))
 
@@ -318,7 +323,7 @@ def test_unicorn_render_hash(settings):
         TokenType.TEXT,
         "unicorn 'tests.templatetags.test_unicorn_render.FakeComponentParent'",
     )
-    unicorn_node = unicorn(None, token)
+    unicorn_node = unicorn(Parser([]), token)
     context = {}
     html = unicorn_node.render(Context(context))
 
@@ -331,3 +336,33 @@ def test_unicorn_render_hash(settings):
     rendered_content = html[:script_idx]
     expected_hash = generate_checksum(rendered_content)
     assert f'"hash":"{expected_hash}"' in html
+
+
+def test_unicorn_render_with_component_name_from_context():
+    token = Token(
+        TokenType.TEXT,
+        "unicorn component_name",
+    )
+    unicorn_node = unicorn(Parser([]), token)
+    context = {"component_name": "tests.templatetags.test_unicorn_render.FakeComponent"}
+    html = unicorn_node.render(Context(context))
+
+    assert '<script type="module"' in html
+    assert len(re.findall('<script type="module"', html)) == 1
+
+
+def test_unicorn_render_with_invalid_component_name_from_context():
+    token = Token(
+        TokenType.TEXT,
+        "unicorn bad_component_name",
+    )
+    unicorn_node = unicorn(Parser([]), token)
+    context = {"component_name": "tests.templatetags.test_unicorn_render.FakeComponent"}
+
+    with pytest.raises(ComponentNotValid) as e:
+        unicorn_node.render(Context(context))
+
+    assert (
+        e.exconly()
+        == "django_unicorn.errors.ComponentNotValid: Component template is not valid: bad_component_name."
+    )