import re import pytest from django.template import Context, Template, TemplateSyntaxError from django.utils.safestring import SafeString, mark_safe from pytest_django.asserts import assertHTMLEqual from django_components import Component, register, types from django_components.attributes import append_attributes, attributes_to_string from django_components.testing import djc_test from .testutils import PARAMETRIZE_CONTEXT_BEHAVIOR, setup_test_config setup_test_config({"autodiscover": False}) @djc_test class TestAttributesToString: def test_simple_attribute(self): assert attributes_to_string({"foo": "bar"}) == 'foo="bar"' def test_multiple_attributes(self): assert attributes_to_string({"class": "foo", "style": "color: red;"}) == 'class="foo" style="color: red;"' def test_escapes_special_characters(self): assert attributes_to_string({"x-on:click": "bar", "@click": "'baz'"}) == 'x-on:click="bar" @click="'baz'"' # noqa: E501 def test_does_not_escape_special_characters_if_safe_string(self): assert attributes_to_string({"foo": mark_safe("'bar'")}) == "foo=\"'bar'\"" def test_result_is_safe_string(self): result = attributes_to_string({"foo": mark_safe("'bar'")}) assert isinstance(result, SafeString) def test_attribute_with_no_value(self): assert attributes_to_string({"required": None}) == "" def test_attribute_with_false_value(self): assert attributes_to_string({"required": False}) == "" def test_attribute_with_true_value(self): assert attributes_to_string({"required": True}) == "required" @djc_test class TestAppendAttributes: def test_single_dict(self): assert append_attributes(("foo", "bar")) == {"foo": "bar"} def test_appends_dicts(self): assert append_attributes(("class", "foo"), ("id", "bar"), ("class", "baz")) == {"class": "foo baz", "id": "bar"} # noqa: E501 @djc_test class TestHtmlAttrs: 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 @djc_test(parametrize=PARAMETRIZE_CONTEXT_BEHAVIOR) def test_tag_positional_args(self, components_settings): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" # 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"})) assertHTMLEqual( rendered, """
content
""", # noqa: E501 ) assert "override-me" not in rendered def test_tag_raises_on_extra_positional_args(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" # 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 pytest.raises( TypeError, match=re.escape("Invalid parameters for tag 'html_attrs': takes 2 positional argument(s) but more were given"), # noqa: E501 ): 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 %}
content
""" # 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"})) assertHTMLEqual( rendered, """
content
""", # noqa: E501 ) assert "override-me" not in rendered def test_tag_kwargs_2(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" # 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"})) assertHTMLEqual( rendered, """
content
""", # noqa: E501 ) assert "override-me" not in rendered def test_tag_spread(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" # 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"})) assertHTMLEqual( rendered, """
content
""", # noqa: E501 ) assert "override-me" not in rendered def test_tag_aggregate_args(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" # 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. assertHTMLEqual( rendered, """
content
""", # noqa: E501 ) assert "override-me" not in 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` # # 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 %}
content
""" # noqa: E501 def get_context_data(self, *args, attrs): return {"attrs": attrs} template = Template(self.template_str) with pytest.raises( TypeError, match=re.escape("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 %}
content
""" # noqa: E501 def get_context_data(self, *args, attrs): return {"attrs": attrs} template = Template(self.template_str) with pytest.raises( TemplateSyntaxError, match=re.escape("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 %}
content
""" # 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"})) assertHTMLEqual( rendered, """
content
""", ) def test_tag_no_defaults(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" # 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"})) assertHTMLEqual( rendered, """
content
""", # noqa: E501 ) assert "override-me" not in rendered def test_tag_no_attrs_no_defaults(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" # 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"})) assertHTMLEqual( rendered, """
content
""", ) assert "override-me" not in rendered def test_tag_empty(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" 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"})) assertHTMLEqual( rendered, """
content
""", ) assert "override-me" not in rendered def test_tag_null_attrs_and_defaults(self): @register("test") class AttrsComponent(Component): template: types.django_html = """ {% load component_tags %}
content
""" 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"})) assertHTMLEqual( rendered, """
content
""", ) assert "override-me" not in rendered