move normalize_whitespace from fixture to utils (#155)

Author: joshuadavidthomas

tests/conftest.py

@@ -2,7 +2,6 @@
 
 import contextlib
 import logging
-import re
 from dataclasses import dataclass
 from pathlib import Path
 from typing import TYPE_CHECKING
@@ -243,28 +242,6 @@ def example_template(templates_dir):
     )
 
 
-@pytest.fixture
-def normalize_whitespace():
-    def func(text: str) -> str:
-        """Normalize whitespace in rendered template output"""
-        # multiple whitespace characters
-        text = re.sub(r"\s+", " ", text)
-        # after opening tag, including when there are attributes
-        text = re.sub(r"<(\w+)(\s+[^>]*)?\s*>", r"<\1\2>", text)
-        # before closing tag
-        text = re.sub(r"\s+>", ">", text)
-        # after opening tag and before closing tag
-        text = re.sub(r">\s+<", "><", text)
-        # immediately after opening tag (including attributes) or before closing tag
-        text = re.sub(r"(<\w+(?:\s+[^>]*)?>)\s+|\s+(<\/\w+>)", r"\1\2", text)
-        # between tags and text content
-        text = re.sub(r">\s+([^<])", r">\1", text)
-        text = re.sub(r"([^>])\s+<", r"\1<", text)
-        return text.strip()
-
-    return func
-
-
 @pytest.fixture(autouse=True)
 def registry():
     from django_bird.components import components

tests/templatetags/test_bird.py

@@ -20,6 +20,7 @@
 from django_bird.templatetags.tags.bird import do_bird
 from tests.utils import TestComponent
 from tests.utils import TestComponentCase
+from tests.utils import normalize_whitespace
 
 
 class TestTagParsing:
@@ -153,9 +154,7 @@ def test_attrs_do_bird(self, params, expected_attrs):
         ],
         ids=lambda x: x.description,
     )
-    def test_basic_name_templatetag(
-        self, test_case, templates_dir, normalize_whitespace
-    ):
+    def test_basic_name_templatetag(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(
@@ -165,7 +164,7 @@ def test_basic_name_templatetag(
 
         assert normalize_whitespace(rendered) == test_case.expected
 
-    def test_nested_name_templatetag(self, templates_dir, normalize_whitespace):
+    def test_nested_name_templatetag(self, templates_dir):
         test_case = TestComponentCase(
             description="Nested component name",
             component=TestComponent(
@@ -254,9 +253,7 @@ def test_nested_name_templatetag(self, templates_dir, normalize_whitespace):
         ],
         ids=lambda x: x.description,
     )
-    def test_dynamic_name_template_context_templatetag(
-        self, test_case, templates_dir, normalize_whitespace
-    ):
+    def test_dynamic_name_template_context_templatetag(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(
@@ -266,7 +263,7 @@ def test_dynamic_name_template_context_templatetag(
 
         assert normalize_whitespace(rendered) == test_case.expected
 
-    def test_dynamic_name_with_string(self, templates_dir, normalize_whitespace):
+    def test_dynamic_name_with_string(self, templates_dir):
         button = TestComponent(
             name="button",
             content="""
@@ -299,7 +296,7 @@ def test_nonexistent_name_templatetag(self, templates_dir):
             template.render(Context({}))
 
 
-def test_self_closing_tag(templates_dir, normalize_whitespace):
+def test_self_closing_tag(templates_dir):
     test_case = TestComponentCase(
         component=TestComponent(
             name="image",
@@ -359,7 +356,7 @@ class TestAttributes:
         ],
         ids=lambda x: x.description,
     )
-    def test_basic(self, test_case, templates_dir, normalize_whitespace):
+    def test_basic(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -424,7 +421,7 @@ def test_basic(self, test_case, templates_dir, normalize_whitespace):
         ],
         ids=lambda x: x.description,
     )
-    def test_boolean(self, test_case, templates_dir, normalize_whitespace):
+    def test_boolean(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -493,9 +490,7 @@ def test_boolean(self, test_case, templates_dir, normalize_whitespace):
         ],
         ids=lambda x: x.description,
     )
-    def test_dynamic_template_context(
-        self, test_case, templates_dir, normalize_whitespace
-    ):
+    def test_dynamic_template_context(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -553,9 +548,7 @@ def test_dynamic_template_context(
         ],
         ids=lambda x: x.description,
     )
-    def test_nested_template_context(
-        self, test_case, templates_dir, normalize_whitespace
-    ):
+    def test_nested_template_context(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -625,7 +618,7 @@ def test_nested_template_context(
         ],
         ids=lambda x: x.description,
     )
-    def test_error_handling(self, test_case, templates_dir, normalize_whitespace):
+    def test_error_handling(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -646,7 +639,6 @@ def test_data_bird_attributes(
         expected,
         override_app_settings,
         templates_dir,
-        normalize_whitespace,
     ):
         button = TestComponent(
             name="button",
@@ -729,7 +721,7 @@ class TestProperties:
         ],
         ids=lambda x: x.description,
     )
-    def test_basic(self, test_case, templates_dir, normalize_whitespace):
+    def test_basic(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -805,7 +797,7 @@ def test_basic(self, test_case, templates_dir, normalize_whitespace):
         ],
         ids=lambda x: x.description,
     )
-    def test_dynamic(self, test_case, templates_dir, normalize_whitespace):
+    def test_dynamic(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -874,7 +866,7 @@ def test_dynamic(self, test_case, templates_dir, normalize_whitespace):
         ],
         ids=lambda x: x.description,
     )
-    def test_error_handling(self, test_case, templates_dir, normalize_whitespace):
+    def test_error_handling(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -883,7 +875,7 @@ def test_error_handling(self, test_case, templates_dir, normalize_whitespace):
         assert normalize_whitespace(rendered) == test_case.expected
 
 
-def test_attrs_and_props(templates_dir, normalize_whitespace):
+def test_attrs_and_props(templates_dir):
     test_case = TestComponentCase(
         component=TestComponent(
             name="button",
@@ -969,7 +961,7 @@ class TestSlots:
         ],
         ids=lambda x: x.description,
     )
-    def test_default(self, test_case, templates_dir, normalize_whitespace):
+    def test_default(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -1065,7 +1057,7 @@ def test_default(self, test_case, templates_dir, normalize_whitespace):
         ],
         ids=lambda x: x.description,
     )
-    def test_named(self, test_case, templates_dir, normalize_whitespace):
+    def test_named(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -1159,9 +1151,7 @@ def make_fancy(value):
         ],
         ids=lambda x: x.description,
     )
-    def test_with_outside_templatetag(
-        self, test_case, fancy_filter, templates_dir, normalize_whitespace
-    ):
+    def test_with_outside_templatetag(self, test_case, fancy_filter, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -1170,7 +1160,7 @@ def test_with_outside_templatetag(
         assert normalize_whitespace(rendered) == test_case.expected
 
 
-def test_nested_components_with_loops(templates_dir, normalize_whitespace):
+def test_nested_components_with_loops(templates_dir):
     nav = TestComponent(
         name="nav",
         content="""
@@ -1302,7 +1292,7 @@ def test_nested_components_with_loops(templates_dir, normalize_whitespace):
     ],
     ids=lambda x: x.description,
 )
-def test_parent_context_access(test_case, templates_dir, normalize_whitespace):
+def test_parent_context_access(test_case, templates_dir):
     test_case.component.create(templates_dir)
 
     template = Template(test_case.template_content)
@@ -1394,7 +1384,7 @@ def test_parent_context_access(test_case, templates_dir, normalize_whitespace):
     ],
     ids=lambda x: x.description,
 )
-def test_only_flag(test_case, templates_dir, normalize_whitespace):
+def test_only_flag(test_case, templates_dir):
     test_case.component.create(templates_dir)
 
     template = Template(test_case.template_content)

tests/templatetags/test_slot.py

@@ -8,6 +8,7 @@
 from django_bird.templatetags.tags.slot import parse_slot_name
 from tests.utils import TestComponent
 from tests.utils import TestComponentCase
+from tests.utils import normalize_whitespace
 
 
 @pytest.mark.parametrize(
@@ -44,7 +45,7 @@ class TestTemplateTag:
             '{% bird:slot name="default" %}{% endbird:slot %}',
         ],
     )
-    def test_default_slot(self, component_content, templates_dir, normalize_whitespace):
+    def test_default_slot(self, component_content, templates_dir):
         test_case = TestComponentCase(
             component=TestComponent(
                 name="test",
@@ -61,7 +62,7 @@ def test_default_slot(self, component_content, templates_dir, normalize_whitespa
 
         assert normalize_whitespace(rendered) == test_case.expected
 
-    def test_default_content(self, templates_dir, normalize_whitespace):
+    def test_default_content(self, templates_dir):
         test_case = TestComponentCase(
             component=TestComponent(
                 name="test",
@@ -87,7 +88,7 @@ def test_default_content(self, templates_dir, normalize_whitespace):
 
         assert normalize_whitespace(rendered) == test_case.expected
 
-    def test_default_content_override(self, templates_dir, normalize_whitespace):
+    def test_default_content_override(self, templates_dir):
         test_case = TestComponentCase(
             component=TestComponent(
                 name="test",
@@ -126,7 +127,7 @@ def test_default_content_override(self, templates_dir, normalize_whitespace):
             "{% bird:slot name=named_slot %}{% endbird:slot %}",
         ],
     )
-    def test_named_slot(self, component_content, templates_dir, normalize_whitespace):
+    def test_named_slot(self, component_content, templates_dir):
         test_case = TestComponentCase(
             component=TestComponent(
                 name="test",
@@ -210,7 +211,7 @@ def test_named_slot(self, component_content, templates_dir, normalize_whitespace
         ],
         ids=lambda x: x.description,
     )
-    def test_nested_slots(self, test_case, templates_dir, normalize_whitespace):
+    def test_nested_slots(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)
@@ -254,7 +255,7 @@ def test_nested_slots(self, test_case, templates_dir, normalize_whitespace):
         ],
         ids=lambda x: x.description,
     )
-    def test_template_content(self, test_case, templates_dir, normalize_whitespace):
+    def test_template_content(self, test_case, templates_dir):
         test_case.component.create(templates_dir)
 
         template = Template(test_case.template_content)

tests/test_components.py

@@ -23,6 +23,7 @@
 
 from .utils import TestAsset
 from .utils import TestComponent
+from .utils import normalize_whitespace
 
 
 class TestComponentClass:
@@ -208,7 +209,6 @@ def test_id_sequence(
         expected,
         override_app_settings,
         templates_dir,
-        normalize_whitespace,
     ):
         button = TestComponent(
             name="button", content="<button {{ attrs }}>{{ slot }}</button>"

tests/test_fixtures.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import pytest
 from django.template.loader import get_template
 
 from .utils import TestComponent
@@ -16,21 +15,3 @@ def test_test_component(templates_dir):
 
     assert template
     assert template.render({}) == content
-
-
-@pytest.mark.parametrize(
-    "contents,expected",
-    [
-        ("<button> Click me </button>", "<button>Click me</button>"),
-        ("<button> Click me</button>", "<button>Click me</button>"),
-        ("<button>Click me </button>", "<button>Click me</button>"),
-        ("<button >Click me</button>", "<button>Click me</button>"),
-        (
-            "<button class='btn'> Click me </button>",
-            "<button class='btn'>Click me</button>",
-        ),
-        ("\n<button>\n  Click me\n</button>\n", "<button>Click me</button>"),
-    ],
-)
-def test_normalize_whitespace(contents, expected, normalize_whitespace):
-    assert normalize_whitespace(contents) == expected