mirror of
https://github.com/django-components/django-components.git
synced 2025-08-04 06:18:17 +00:00
280 lines
14 KiB
Python
280 lines
14 KiB
Python
from django.template import Context, Template
|
|
|
|
from .django_test_setup import * # NOQA
|
|
|
|
from django_components import component
|
|
|
|
from .testutils import Django30CompatibleSimpleTestCase as SimpleTestCase
|
|
|
|
|
|
class SimpleComponent(component.Component):
|
|
template_name = "simple_template.html"
|
|
|
|
def get_context(self, variable=None):
|
|
return {"variable": variable} if variable is not None else {}
|
|
|
|
@staticmethod
|
|
def expected_output(variable_value):
|
|
return 'Variable: < strong > {} < / strong >'.format(variable_value)
|
|
|
|
|
|
class ParentComponent(component.Component):
|
|
template_name = "parent_template.html"
|
|
|
|
def get_context(self):
|
|
return {
|
|
"shadowing_variable": 'NOT SHADOWED'
|
|
}
|
|
|
|
|
|
class ParentComponentWithArgs(component.Component):
|
|
template_name = "parent_with_args_template.html"
|
|
|
|
def get_context(self, parent_value):
|
|
return {"inner_parent_value": parent_value}
|
|
|
|
|
|
class VariableDisplay(component.Component):
|
|
template_name = "variable_display.html"
|
|
|
|
def get_context(self, shadowing_variable=None, new_variable=None):
|
|
context = {}
|
|
if shadowing_variable is not None:
|
|
context['shadowing_variable'] = shadowing_variable
|
|
if new_variable is not None:
|
|
context['unique_variable'] = new_variable
|
|
return context
|
|
|
|
|
|
class IncrementerComponent(component.Component):
|
|
template_name = "incrementer.html"
|
|
|
|
def get_context(self, value=0):
|
|
value = int(value)
|
|
if hasattr(self, 'call_count'):
|
|
self.call_count += 1
|
|
else:
|
|
self.call_count = 1
|
|
return {
|
|
"value": value + 1,
|
|
"calls": self.call_count
|
|
}
|
|
|
|
|
|
|
|
class OuterContextComponent(component.Component):
|
|
template_name = "simple_template.html"
|
|
|
|
def get_context(self):
|
|
return self.outer_context
|
|
|
|
|
|
component.registry.register(name='parent_component', component=ParentComponent)
|
|
component.registry.register(name='parent_with_args', component=ParentComponentWithArgs)
|
|
component.registry.register(name='variable_display', component=VariableDisplay)
|
|
component.registry.register(name='incrementer', component=IncrementerComponent)
|
|
component.registry.register(name='simple_component', component=SimpleComponent)
|
|
component.registry.register(name='outer_context_component', component=OuterContextComponent)
|
|
|
|
|
|
class ContextTests(SimpleTestCase):
|
|
def test_nested_component_context_shadows_parent_with_unfilled_slots_and_component_tag(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component 'parent_component' %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Shadowing variable = override</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Shadowing variable = slot_default_override</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_instances_have_unique_context_with_unfilled_slots_and_component_tag(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component name='parent_component' %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Uniquely named variable = unique_val</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Uniquely named variable = slot_default_unique</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_context_shadows_parent_with_unfilled_slots_and_component_block_tag(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_component' %}{% endcomponent_block %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Shadowing variable = override</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Shadowing variable = slot_default_override</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_instances_have_unique_context_with_unfilled_slots_and_component_block_tag(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_component' %}{% endcomponent_block %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Uniquely named variable = unique_val</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Uniquely named variable = slot_default_unique</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_context_shadows_parent_with_filled_slots(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_component' %}"
|
|
"{% slot 'content' %}{% component name='variable_display' "
|
|
"shadowing_variable='shadow_from_slot' new_variable='unique_from_slot' %}{% endslot %}"
|
|
"{% endcomponent_block %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Shadowing variable = override</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Shadowing variable = shadow_from_slot</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_instances_have_unique_context_with_filled_slots(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_component' %}"
|
|
"{% slot 'content' %}{% component name='variable_display' "
|
|
"shadowing_variable='shadow_from_slot' new_variable='unique_from_slot' %}{% endslot %}"
|
|
"{% endcomponent_block %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Uniquely named variable = unique_val</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Uniquely named variable = unique_from_slot</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_context_shadows_outer_context_with_unfilled_slots_and_component_tag(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component name='parent_component' %}")
|
|
rendered = template.render(Context({'shadowing_variable': 'NOT SHADOWED'}))
|
|
|
|
self.assertIn('<h1>Shadowing variable = override</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Shadowing variable = slot_default_override</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_context_shadows_outer_context_with_unfilled_slots_and_component_block_tag(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_component' %}{% endcomponent_block %}")
|
|
rendered = template.render(Context({'shadowing_variable': 'NOT SHADOWED'}))
|
|
|
|
self.assertIn('<h1>Shadowing variable = override</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Shadowing variable = slot_default_override</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
def test_nested_component_context_shadows_outer_context_with_filled_slots(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_component' %}"
|
|
"{% slot 'content' %}{% component name='variable_display' "
|
|
"shadowing_variable='shadow_from_slot' new_variable='unique_from_slot' %}{% endslot %}"
|
|
"{% endcomponent_block %}")
|
|
rendered = template.render(Context({'shadowing_variable': 'NOT SHADOWED'}))
|
|
|
|
self.assertIn('<h1>Shadowing variable = override</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Shadowing variable = shadow_from_slot</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
|
|
class ParentArgsTests(SimpleTestCase):
|
|
def test_parent_args_can_be_drawn_from_context(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_with_args' parent_value=parent_value %}"
|
|
"{% endcomponent_block %}")
|
|
rendered = template.render(Context({'parent_value': 'passed_in'}))
|
|
|
|
self.assertIn('<h1>Shadowing variable = passed_in</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Uniquely named variable = passed_in</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
def test_parent_args_available_outside_slots(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_with_args' parent_value='passed_in' %}{%endcomponent_block %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Shadowing variable = passed_in</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Uniquely named variable = passed_in</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
def test_parent_args_available_in_slots(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'parent_with_args' parent_value='passed_in' %}"
|
|
"{% slot 'content' %}{% component name='variable_display' "
|
|
"shadowing_variable='value_from_slot' new_variable=inner_parent_value %}{% endslot %}"
|
|
"{%endcomponent_block %}")
|
|
rendered = template.render(Context())
|
|
|
|
self.assertIn('<h1>Shadowing variable = value_from_slot</h1>', rendered, rendered)
|
|
self.assertIn('<h1>Uniquely named variable = passed_in</h1>', rendered, rendered)
|
|
self.assertNotIn('<h1>Shadowing variable = NOT SHADOWED</h1>', rendered, rendered)
|
|
|
|
|
|
class ContextCalledOnceTests(SimpleTestCase):
|
|
def test_one_context_call_with_simple_component(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component name='incrementer' %}")
|
|
rendered = template.render(Context()).strip()
|
|
|
|
self.assertEqual(rendered, '<p class="incrementer">value=1;calls=1</p>', rendered)
|
|
|
|
def test_one_context_call_with_simple_component_and_arg(self):
|
|
template = Template("{% load component_tags %}{% component name='incrementer' value='2' %}")
|
|
rendered = template.render(Context()).strip()
|
|
|
|
self.assertEqual(rendered, '<p class="incrementer">value=3;calls=1</p>', rendered)
|
|
|
|
def test_one_context_call_with_component_block(self):
|
|
template = Template("{% load component_tags %}"
|
|
"{% component_block 'incrementer' %}{% endcomponent_block %}")
|
|
rendered = template.render(Context()).strip()
|
|
|
|
self.assertEqual(rendered, '<p class="incrementer">value=1;calls=1</p>', rendered)
|
|
|
|
def test_one_context_call_with_component_block_and_arg(self):
|
|
template = Template("{% load component_tags %}"
|
|
"{% component_block 'incrementer' value='3' %}{% endcomponent_block %}")
|
|
rendered = template.render(Context()).strip()
|
|
|
|
self.assertEqual(rendered, '<p class="incrementer">value=4;calls=1</p>', rendered)
|
|
|
|
def test_one_context_call_with_slot(self):
|
|
template = Template("{% load component_tags %}"
|
|
"{% component_block 'incrementer' %}{% slot 'content' %}"
|
|
"<p>slot</p>{% endslot %}{% endcomponent_block %}")
|
|
rendered = template.render(Context()).strip()
|
|
|
|
self.assertEqual(rendered, '<p class="incrementer">value=1;calls=1</p>\n<p>slot</p>', rendered)
|
|
|
|
def test_one_context_call_with_slot_and_arg(self):
|
|
template = Template("{% load component_tags %}"
|
|
"{% component_block 'incrementer' value='3' %}{% slot 'content' %}"
|
|
"<p>slot</p>{% endslot %}{% endcomponent_block %}")
|
|
rendered = template.render(Context()).strip()
|
|
|
|
self.assertEqual(rendered, '<p class="incrementer">value=4;calls=1</p>\n<p>slot</p>', rendered)
|
|
|
|
|
|
class ComponentsCanAccessOuterContext(SimpleTestCase):
|
|
def test_simple_component_can_use_outer_context(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component 'simple_component' %}")
|
|
rendered = template.render(Context({'variable': 'outer_value'})).strip()
|
|
self.assertIn('outer_value', rendered, rendered)
|
|
|
|
|
|
class IsolatedContextTests(SimpleTestCase):
|
|
def test_simple_component_can_pass_outer_context_in_args(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component 'simple_component' variable only %}")
|
|
rendered = template.render(Context({'variable': 'outer_value'})).strip()
|
|
self.assertIn('outer_value', rendered, rendered)
|
|
|
|
def test_simple_component_cannot_use_outer_context(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component 'simple_component' only %}")
|
|
rendered = template.render(Context({'variable': 'outer_value'})).strip()
|
|
self.assertNotIn('outer_value', rendered, rendered)
|
|
|
|
|
|
class OuterContextPropertyTests(SimpleTestCase):
|
|
def test_outer_context_property_with_component(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component 'outer_context_component' only %}")
|
|
rendered = template.render(Context({'variable': 'outer_value'})).strip()
|
|
self.assertIn('outer_value', rendered, rendered)
|
|
|
|
def test_outer_context_property_with_component_block(self):
|
|
template = Template("{% load component_tags %}{% component_dependencies %}"
|
|
"{% component_block 'outer_context_component' only %}{% endcomponent_block %}")
|
|
rendered = template.render(Context({'variable': 'outer_value'})).strip()
|
|
self.assertIn('outer_value', rendered, rendered)
|