Initial work for ignoring comments.

Author: adamghill

src/dj_angles/replacers/__init__.py

@@ -1,4 +1,5 @@
 import logging
+import re
 
 from dj_angles.replacers.attributes import replace_attributes
 from dj_angles.replacers.tags import replace_tags
@@ -18,6 +19,22 @@ def convert_template(html: str, *, origin=None) -> str:
         The converted template HTML string.
     """
 
+    # 0. Mask comments
+    comments = []
+
+    def mask_match(match):
+        comments.append(match.group(0))
+        return f"__DJ_ANGLES_COMMENT_{len(comments) - 1}__"
+
+    # Django single line comments {# ... #}
+    html = re.sub(r"\{#.*?#\}", mask_match, html, flags=re.DOTALL)
+
+    # Django block comments {% comment %}...{% endcomment %}
+    html = re.sub(r"\{%\s*comment\s*%\}.*?\{%\s*endcomment\s*%\}", mask_match, html, flags=re.DOTALL | re.IGNORECASE)
+
+    # Custom dj-comment Tags <dj-comment>...</dj-comment>
+    html = re.sub(r"<dj-comment>.*?</dj-comment>", mask_match, html, flags=re.DOTALL | re.IGNORECASE)
+
     # 1. Replace attributes, e.g. `<div dj-if="condition">`
     html = replace_attributes(html)
 
@@ -27,4 +44,8 @@ def convert_template(html: str, *, origin=None) -> str:
     # 3. Replace tags, e.g. `<dj-include />`
     html = replace_tags(html, origin=origin)
 
+    # 4. Unmask comments
+    for i, comment in enumerate(comments):
+        html = html.replace(f"__DJ_ANGLES_COMMENT_{i}__", comment)
+
     return html

tests/dj_angles/replacers/test_comments.py

@@ -0,0 +1,40 @@
+from dj_angles.replacers import convert_template
+
+
+def test_commented_out_tag_is_ignored():
+    template = """
+{% comment %}
+<dj-include 'fake-partial.html' />
+{% endcomment %}
+"""
+    # If ignored, it should remain as <dj-include ...> inside the comment
+    # If processed, it will become {% include ... %}
+
+    # We expect it to NOT be processed if the goal is to ignore comments.
+    # But currently we want to see what happens.
+
+    actual = convert_template(template)
+
+    # Let's see what we get. I suspect it currently converts it.
+    print(f"\nACTUAL:\n{actual}")
+
+    # If we want it to be ignored, this assertion should pass:
+    assert "<dj-include 'fake-partial.html' />" in actual
+
+
+def test_single_line_comment_ignored():
+    template = "{# <dj-include 'fake-partial.html' /> #}"
+    actual = convert_template(template)
+    print(f"\nACTUAL SINGLE LINE:\n{actual}")
+    assert "<dj-include 'fake-partial.html' />" in actual
+
+
+def test_custom_dj_comment_ignored():
+    template = """
+<dj-comment>
+<dj-include 'fake-partial.html' />
+</dj-comment>
+"""
+    actual = convert_template(template)
+    print(f"\nACTUAL DJ-COMMENT:\n{actual}")
+    assert "<dj-include 'fake-partial.html' />" in actual