mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-12-09 22:11:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: TagFormatter - Allow users to customize component template tags (#572)

Browse source 
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Juro Oravec 2024-08-18 16:58:56 +02:00 • committed by GitHub
parent b89c09aa5f
commit 71d8679e8d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 1593 additions and 474 deletions
Download patch file Download diff file Expand all files Collapse all files

51
tests/test_registry.py
View file

@ -1,12 +1,21 @@
import unittest
from django.template import Library
from django.test import override_settings
from django_components import AlreadyRegistered, Component, ComponentRegistry, NotRegistered, register, registry
from django_components import (
AlreadyRegistered,
Component,
ComponentRegistry,
NotRegistered,
TagProtectedError,
register,
registry,
)
from .django_test_setup import setup_test_config
setup_test_config()
setup_test_config({"autodiscover": False})
class MockComponent(Component):
@ -69,7 +78,7 @@ class ComponentRegistryTest(unittest.TestCase):
def test_unregisters_only_unused_tags(self):
self.assertDictEqual(self.registry._tags, {})
# NOTE: We preserve the default component tags
self.assertIn("component", self.registry.library.tags)
self.assertNotIn("component", self.registry.library.tags)
# Register two components that use the same tag
self.registry.register(name="testcomponent", component=MockComponent)
@ -78,7 +87,6 @@ class ComponentRegistryTest(unittest.TestCase):
self.assertDictEqual(
self.registry._tags,
{
"#component": {"testcomponent", "testcomponent2"},
"component": {"testcomponent", "testcomponent2"},
},
)
@ -91,7 +99,6 @@ class ComponentRegistryTest(unittest.TestCase):
self.assertDictEqual(
self.registry._tags,
{
"#component": {"testcomponent2"},
"component": {"testcomponent2"},
},
)
@ -102,7 +109,7 @@ class ComponentRegistryTest(unittest.TestCase):
self.registry.unregister(name="testcomponent2")
self.assertDictEqual(self.registry._tags, {})
self.assertIn("component", self.registry.library.tags)
self.assertNotIn("component", self.registry.library.tags)
def test_prevent_registering_different_components_with_the_same_name(self):
self.registry.register(name="testcomponent", component=MockComponent)
@ -124,3 +131,35 @@ class ComponentRegistryTest(unittest.TestCase):
def test_raises_on_failed_unregister(self):
with self.assertRaises(NotRegistered):
self.registry.unregister(name="testcomponent")
class ProtectedTagsTest(unittest.TestCase):
def setUp(self):
super().setUp()
self.registry = ComponentRegistry()
# NOTE: Use the `component_shorthand_formatter` formatter, so the components
# are registered under that tag
@override_settings(COMPONENTS={"tag_formatter": "django_components.component_shorthand_formatter"})
def test_raises_on_overriding_our_tags(self):
for tag in [
"component_dependencies",
"component_css_dependencies",
"component_js_dependencies",
"fill",
"html_attrs",
"provide",
"slot",
]:
with self.assertRaises(TagProtectedError):
@register(tag)
class TestComponent(Component):
pass
@register("sth_else")
class TestComponent2(Component):
pass
# Cleanup
registry.unregister("sth_else")