mirror of
https://github.com/django-components/django-components.git
synced 2025-07-08 01:45:00 +00:00
437 lines
15 KiB
Python
437 lines
15 KiB
Python
from django.template import Context, Template, TemplateSyntaxError
|
|
from django.utils.safestring import SafeString, mark_safe
|
|
|
|
from django_components import Component, register, types
|
|
from django_components.attributes import append_attributes, attributes_to_string
|
|
|
|
from .django_test_setup import setup_test_config
|
|
from .testutils import BaseTestCase, parametrize_context_behavior
|
|
|
|
setup_test_config({"autodiscover": False})
|
|
|
|
|
|
class AttributesToStringTest(BaseTestCase):
|
|
def test_simple_attribute(self):
|
|
self.assertEqual(
|
|
attributes_to_string({"foo": "bar"}),
|
|
'foo="bar"',
|
|
)
|
|
|
|
def test_multiple_attributes(self):
|
|
self.assertEqual(
|
|
attributes_to_string({"class": "foo", "style": "color: red;"}),
|
|
'class="foo" style="color: red;"',
|
|
)
|
|
|
|
def test_escapes_special_characters(self):
|
|
self.assertEqual(
|
|
attributes_to_string({"x-on:click": "bar", "@click": "'baz'"}),
|
|
'x-on:click="bar" @click="'baz'"',
|
|
)
|
|
|
|
def test_does_not_escape_special_characters_if_safe_string(self):
|
|
self.assertEqual(
|
|
attributes_to_string({"foo": mark_safe("'bar'")}),
|
|
"foo=\"'bar'\"",
|
|
)
|
|
|
|
def test_result_is_safe_string(self):
|
|
result = attributes_to_string({"foo": mark_safe("'bar'")})
|
|
self.assertTrue(isinstance(result, SafeString))
|
|
|
|
def test_attribute_with_no_value(self):
|
|
self.assertEqual(
|
|
attributes_to_string({"required": None}),
|
|
"",
|
|
)
|
|
|
|
def test_attribute_with_false_value(self):
|
|
self.assertEqual(
|
|
attributes_to_string({"required": False}),
|
|
"",
|
|
)
|
|
|
|
def test_attribute_with_true_value(self):
|
|
self.assertEqual(
|
|
attributes_to_string({"required": True}),
|
|
"required",
|
|
)
|
|
|
|
|
|
class AppendAttributesTest(BaseTestCase):
|
|
def test_single_dict(self):
|
|
self.assertEqual(
|
|
append_attributes(("foo", "bar")),
|
|
{"foo": "bar"},
|
|
)
|
|
|
|
def test_appends_dicts(self):
|
|
self.assertEqual(
|
|
append_attributes(("class", "foo"), ("id", "bar"), ("class", "baz")),
|
|
{"class": "foo baz", "id": "bar"},
|
|
)
|
|
|
|
|
|
class HtmlAttrsTests(BaseTestCase):
|
|
template_str: types.django_html = """
|
|
{% load component_tags %}
|
|
{% component "test" attrs:@click.stop="dispatch('click_event')" attrs:x-data="{hello: 'world'}" attrs:class=class_var %}
|
|
{% endcomponent %}
|
|
""" # noqa: E501
|
|
|
|
@parametrize_context_behavior(["django", "isolated"])
|
|
def test_tag_positional_args(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs attrs defaults class="added_class" class="another-class" data-id=123 %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {
|
|
"attrs": attrs,
|
|
"defaults": {"class": "override-me"},
|
|
}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div @click.stop="dispatch('click_event')" x-data="{hello: 'world'}" class="padding-top-8 added_class another-class" data-djc-id-a1bc3f data-id=123>
|
|
content
|
|
</div>
|
|
""", # noqa: E501
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
def test_tag_raises_on_extra_positional_args(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs attrs defaults class %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {
|
|
"attrs": attrs,
|
|
"defaults": {"class": "override-me"},
|
|
"class": "123 457",
|
|
}
|
|
|
|
template = Template(self.template_str)
|
|
|
|
with self.assertRaisesMessage(
|
|
TypeError, "Invalid parameters for tag 'html_attrs': takes 2 positional argument(s) but more were given"
|
|
):
|
|
template.render(Context({"class_var": "padding-top-8"}))
|
|
|
|
def test_tag_kwargs(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs attrs=attrs defaults=defaults class="added_class" class="another-class" data-id=123 %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {
|
|
"attrs": attrs,
|
|
"defaults": {"class": "override-me"},
|
|
}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div @click.stop="dispatch('click_event')" class="added_class another-class padding-top-8" data-djc-id-a1bc3f data-id="123" x-data="{hello: 'world'}">
|
|
content
|
|
</div>
|
|
""", # noqa: E501
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
def test_tag_kwargs_2(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs class="added_class" class="another-class" data-id=123 defaults=defaults attrs=attrs %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {
|
|
"attrs": attrs,
|
|
"defaults": {"class": "override-me"},
|
|
}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div @click.stop="dispatch('click_event')" x-data="{hello: 'world'}" class="padding-top-8 added_class another-class" data-djc-id-a1bc3f data-id=123>
|
|
content
|
|
</div>
|
|
""", # noqa: E501
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
def test_tag_spread(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs ...props class="another-class" %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {
|
|
"props": {
|
|
"attrs": attrs,
|
|
"defaults": {"class": "override-me"},
|
|
"class": "added_class",
|
|
"data-id": 123,
|
|
},
|
|
}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div @click.stop="dispatch('click_event')" class="added_class another-class padding-top-8" data-djc-id-a1bc3f data-id="123" x-data="{hello: 'world'}">
|
|
content
|
|
</div>
|
|
""", # noqa: E501
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
def test_tag_aggregate_args(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs attrs:class="from_agg_key" attrs:type="submit" defaults:class="override-me" class="added_class" class="another-class" data-id=123 %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {"attrs": attrs}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
|
|
# NOTE: The attrs from self.template_str should be ignored because they are not used.
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div class="added_class another-class from_agg_key" data-djc-id-a1bc3f data-id="123" type="submit">
|
|
content
|
|
</div>
|
|
""", # noqa: E501
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
# Note: Because there's both `attrs:class` and `defaults:class`, the `attrs`,
|
|
# it's as if the template tag call was (ignoring the `class` and `data-id` attrs):
|
|
#
|
|
# `{% html_attrs attrs={"class": ...} defaults={"class": ...} attrs %}>content</div>`
|
|
#
|
|
# Which raises, because `attrs` is passed both as positional and as keyword argument.
|
|
def test_tag_raises_on_aggregate_and_positional_args_for_attrs(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs attrs attrs:class="from_agg_key" defaults:class="override-me" class="added_class" class="another-class" data-id=123 %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {"attrs": attrs}
|
|
|
|
template = Template(self.template_str)
|
|
|
|
with self.assertRaisesMessage(
|
|
TypeError, "Invalid parameters for tag 'html_attrs': got multiple values for argument 'attrs'"
|
|
):
|
|
template.render(Context({"class_var": "padding-top-8"}))
|
|
|
|
def test_tag_raises_on_aggregate_and_positional_args_for_defaults(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs
|
|
defaults=defaults
|
|
attrs:class="from_agg_key"
|
|
defaults:class="override-me"
|
|
class="added_class"
|
|
class="another-class"
|
|
data-id=123
|
|
%}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {"attrs": attrs}
|
|
|
|
template = Template(self.template_str)
|
|
|
|
with self.assertRaisesMessage(
|
|
TemplateSyntaxError,
|
|
"Received argument 'defaults' both as a regular input",
|
|
):
|
|
template.render(Context({"class_var": "padding-top-8"}))
|
|
|
|
def test_tag_no_attrs(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs defaults:class="override-me" class="added_class" class="another-class" data-id=123 %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {"attrs": attrs}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div class="added_class another-class override-me" data-djc-id-a1bc3f data-id=123>
|
|
content
|
|
</div>
|
|
""",
|
|
)
|
|
|
|
def test_tag_no_defaults(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs attrs class="added_class" class="another-class" data-id=123 %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {"attrs": attrs}
|
|
|
|
template_str: types.django_html = """
|
|
{% load component_tags %}
|
|
{% component "test" attrs:@click.stop="dispatch('click_event')" attrs:x-data="{hello: 'world'}" attrs:class=class_var %}
|
|
{% endcomponent %}
|
|
""" # noqa: E501
|
|
template = Template(template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div @click.stop="dispatch('click_event')" x-data="{hello: 'world'}" class="padding-top-8 added_class another-class" data-djc-id-a1bc3f data-id=123>
|
|
content
|
|
</div>
|
|
""", # noqa: E501
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
def test_tag_no_attrs_no_defaults(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs class="added_class" class="another-class" data-id=123 %}>
|
|
content
|
|
</div>
|
|
""" # noqa: E501
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {"attrs": attrs}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div class="added_class another-class" data-djc-id-a1bc3f data-id="123">
|
|
content
|
|
</div>
|
|
""",
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
def test_tag_empty(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs %}>
|
|
content
|
|
</div>
|
|
"""
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {
|
|
"attrs": attrs,
|
|
"defaults": {"class": "override-me"},
|
|
}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div data-djc-id-a1bc3f>
|
|
content
|
|
</div>
|
|
""",
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|
|
|
|
def test_tag_null_attrs_and_defaults(self):
|
|
@register("test")
|
|
class AttrsComponent(Component):
|
|
template: types.django_html = """
|
|
{% load component_tags %}
|
|
<div {% html_attrs attrs defaults %}>
|
|
content
|
|
</div>
|
|
"""
|
|
|
|
def get_context_data(self, *args, attrs):
|
|
return {
|
|
"attrs": None,
|
|
"defaults": None,
|
|
}
|
|
|
|
template = Template(self.template_str)
|
|
rendered = template.render(Context({"class_var": "padding-top-8"}))
|
|
self.assertHTMLEqual(
|
|
rendered,
|
|
"""
|
|
<div data-djc-id-a1bc3f>
|
|
content
|
|
</div>
|
|
""",
|
|
)
|
|
self.assertNotIn("override-me", rendered)
|