Merge branch 'main' into feature/unit-html-renderer

.vscode/settings.json

@@ -1,7 +1,14 @@
 {
     "python.testing.pytestArgs": [
-        "."
+        ".",
+        "-vv"
     ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "[python]": {
+        "editor.codeActionsOnSave": {
+            "source.fixAll.ruff": "explicit",
+            "source.organizeImports.ruff": "explicit"
+        }
+    }
 }

renderer/fifty_ohm_html_renderer.py

@@ -1,9 +1,12 @@
+import textwrap
+
 from mistletoe import HtmlRenderer
 
 from .comment import Comment
-from .unit import Unit
 from .quote import Quote
-
+from .tag import Tag
+from .underline import Underline
+from .unit import Unit
 
 units = {
     "A": "A",
@@ -38,8 +41,11 @@ no_space_units = ["°", "%"]
 
 
 class FiftyOhmHtmlRenderer(HtmlRenderer):
+    margin_anchor_id = 0
+    margin_id = 0
+
     def __init__(self):
-        super().__init__(Comment, Unit, Quote)
+        super().__init__(Comment, Unit, Quote, Underline, Tag)
 
     def render_comment():
         return None
@@ -57,3 +63,54 @@ class FiftyOhmHtmlRenderer(HtmlRenderer):
             return f"{token.value}{unit}"
         else:
             return f"{token.value} {unit}"
+
+    def render_thematic_break(self, token):
+        self.margin_anchor_id += 1
+        return f'<a id="margin_{self.margin_anchor_id}"></a>'
+
+    @staticmethod
+    def render_tag_helper(type, content, margin_id, margin_anchor_id):
+        """This function is used to render the different types of tags. It is
+        used in the HtmlRenderer class and also in the test class"""
+        return textwrap.dedent(f"""\
+            <div class="margin {type}" id="margin_for_{margin_id}">
+                {content}
+            </div>
+            <a id="margin_orig_{margin_id}"></a>
+            <script>
+            (() => {{
+                function moveFunc() {{
+                    const targetEl = document.getElementById(
+                        window.innerWidth > 800 ? "margin_{margin_anchor_id}" : "margin_orig_{margin_id}"
+                    );
+                    targetEl.parentNode.insertBefore(
+                        document.getElementById("margin_for_{margin_id}"),
+                        targetEl
+                    );
+                }}
+                addEventListener("resize", moveFunc);
+                moveFunc();
+            }})();
+            </script>
+        """)
+
+    def render_tag(self, token):
+        if token.tagtype == "latexonly":
+            return ""
+        elif token.tagtype == "webonly":
+            return self.render_inner(token)
+
+        self.margin_id += 1
+
+        if token.tagtype == "webmargin":
+            type = "margin"
+        elif token.tagtype == "webtip":
+            type = "tipp"
+        elif token.tagtype == "webindepth":
+            type = "indepth"
+        else:
+            type = token.tagtype
+
+        return self.render_tag_helper(
+            type, self.render_inner(token), self.margin_id, self.margin_anchor_id
+        )

renderer/tag.py

@@ -0,0 +1,27 @@
+import re
+
+from mistletoe.block_token import BlockToken, tokenize
+
+
+class Tag(BlockToken):
+
+    @staticmethod
+    def start(line):
+        return re.match(r"^\s*<[^>]+>", line)
+
+    @classmethod
+    def read(cls, lines):
+        child_lines = []
+        first_line = next(lines)
+
+        tagtype = re.match(r"^\s*<([^>]+)>", first_line).group(1)
+
+        for line in lines:
+            if line.startswith(f"</{tagtype}>"):
+                break
+            else :
+                child_lines.append(line)
+        return tagtype, tokenize(child_lines)
+
+    def __init__(self, match):
+        self.tagtype, self.children = match

test/test_tag.py

@@ -0,0 +1,41 @@
+import mistletoe
+
+from renderer.fifty_ohm_html_renderer import FiftyOhmHtmlRenderer
+
+def test_thematic_break_html() :
+    assertions = {
+        "---" : '<a id="margin_1"></a>\n',
+        "---\n---" : '<a id="margin_1"></a>\n<a id="margin_2"></a>\n',
+    }
+
+    for assertion in assertions:
+        assert mistletoe.markdown(assertion, FiftyOhmHtmlRenderer) == assertions[assertion]
+
+def test_tag_html() :
+
+    assertions = {
+        "<margin>\nFoo\n</margin>" : FiftyOhmHtmlRenderer.render_tag_helper("margin","<p>Foo</p>",1,0)+'\n',
+        "<indepth>\nFoo\n</indepth>" : FiftyOhmHtmlRenderer.render_tag_helper("indepth","<p>Foo</p>",1,0)+'\n',
+        "<webmargin>\nFoo\n</webmargin>" : FiftyOhmHtmlRenderer.render_tag_helper("margin","<p>Foo</p>",1,0)+'\n',
+        "<tipp>\nFoo\n</tipp>" : FiftyOhmHtmlRenderer.render_tag_helper("tipp","<p>Foo</p>",1,0)+'\n',
+        "<webtipp>\nFoo\n</webtipp>" : FiftyOhmHtmlRenderer.render_tag_helper("webtipp","<p>Foo</p>",1,0)+'\n',
+        "<webindepth>\nFoo\n</webindepth>" : FiftyOhmHtmlRenderer.render_tag_helper("indepth","<p>Foo</p>",1,0)+'\n',
+        "<unit>\nFoo\n</unit>" : FiftyOhmHtmlRenderer.render_tag_helper("unit","<p>Foo</p>",1,0)+'\n',
+        "<danger>\nFoo\n</danger>" : FiftyOhmHtmlRenderer.render_tag_helper("danger","<p>Foo</p>",1,0)+'\n',
+        "<webonly>\nFoo\n</webonly>" : '<p>Foo</p>\n',
+        "<latexonly>\nFoo\n</latexonly>" : "",
+    }
+
+    for assertion in assertions:
+        assert mistletoe.markdown(assertion, FiftyOhmHtmlRenderer) == assertions[assertion]
+
+def test_thematic_break_and_tag_html() :
+
+    assertions = {
+        "---\n<margin>\nFoo\n</margin>" : '<a id="margin_1"></a>\n'+FiftyOhmHtmlRenderer.render_tag_helper("margin","<p>Foo</p>",1,1)+'\n',
+        "---\n<margin>\nFoo\n</margin>\n<margin>\nFoo\n</margin>" : '<a id="margin_1"></a>\n'+FiftyOhmHtmlRenderer.render_tag_helper("margin","<p>Foo</p>",1,1)+'\n'+FiftyOhmHtmlRenderer.render_tag_helper("margin","<p>Foo</p>",2,1)+'\n',
+        "---\n<margin>\nFoo\n</margin>\n---\n<margin>\nFoo\n</margin>" : '<a id="margin_1"></a>\n'+FiftyOhmHtmlRenderer.render_tag_helper("margin","<p>Foo</p>",1,1)+'\n<a id="margin_2"></a>\n'+FiftyOhmHtmlRenderer.render_tag_helper("margin","<p>Foo</p>",2,2)+'\n',
+    }
+
+    for assertion in assertions:
+        assert mistletoe.markdown(assertion, FiftyOhmHtmlRenderer) == assertions[assertion]