edwh-editorjs 2.1.1__tar.gz → 2.2.1__tar.gz

{edwh_editorjs-2.1.1 → edwh_editorjs-2.2.1}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## v2.2.1 (2024-11-26)
+
+### Fix
+
+* Quick fix to prevent unlimited spaces being added by mdast ([`a196a22`](https://github.com/educationwarehouse/edwh-editorjs/commit/a196a221b623f7d4808aec64ef455197bdcfacaf))
+
+## v2.2.0 (2024-11-26)
+
+### Feature
+
+* Support the alignment tune plugin ([`652cb58`](https://github.com/educationwarehouse/edwh-editorjs/commit/652cb58920b35fbb36c56d665e52e69a40811258))
+
 ## v2.1.1 (2024-11-26)
 
 ### Fix

{edwh_editorjs-2.1.1 → edwh_editorjs-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.1.1
+Version: 2.2.1
 Summary: EditorJS.py
 Project-URL: Homepage, https://github.com/educationwarehouse/edwh-EditorJS
 Author-email: SKevo <skevo.cw@gmail.com>, Robin van der Noord <robin.vdn@educationwarehouse.nl>

edwh_editorjs-2.2.1/editorjs/__about__.py

@@ -0,0 +1 @@
+__version__ = "2.2.1"

{edwh_editorjs-2.1.1 → edwh_editorjs-2.2.1}/editorjs/blocks.py

@@ -93,10 +93,25 @@ class HeadingBlock(EditorJSBlock):
     def to_markdown(cls, data: EditorChildData) -> str:
         level = data.get("level", 1)
         text = data.get("text", "")
+        tunes = data.get("tunes", {})
 
         if not (1 <= level <= 6):
             raise ValueError("Header level must be between 1 and 6.")
 
+        if (
+            tunes.get("alignmentTune")
+            and (alignment := tunes["alignmentTune"].get("alignment"))
+            and (alignment != "left")
+        ):
+            # can't just return regular HTML because then it will turn into a raw block
+            return AlignmentBlock.to_markdown(
+                {
+                    "text": text,
+                    "tag": f"h{level}",
+                    "alignment": alignment,
+                }
+            )
+
         return f"{'#' * level} {text}\n"
 
     @classmethod
@@ -143,6 +158,21 @@ class ParagraphBlock(EditorJSBlock):
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         text = data.get("text", "")
+        tunes = data.get("tunes", {})
+
+        if (
+            tunes.get("alignmentTune")
+            and (alignment := tunes["alignmentTune"].get("alignment"))
+            and (alignment != "left")
+        ):
+            return AlignmentBlock.to_markdown(
+                {
+                    "text": text,
+                    "tag": "p",
+                    "alignment": alignment,
+                }
+            )
+
         return f"{text}\n\n"
 
     @classmethod
@@ -617,6 +647,49 @@ class AttachmentBlock(EditorJSBlock):
         """
 
 
+@block("alignment")
+class AlignmentBlock(EditorJSBlock):
+    @classmethod
+    def to_markdown(cls, data: EditorChildData) -> str:
+        tag = data["tag"]
+        alignment = data["alignment"]
+        content = data["text"]
+
+        return f"<editorjs type='alignment' tag='{tag}' alignment='{alignment}'>{content}</editorjs>\n\n"
+
+    @classmethod
+    def to_json(cls, node: MDChildNode) -> list[dict]:
+        # only paragraph and headers can be aligned
+        tag: str = node["tag"]
+        text: str = node["body"]
+        alignment = node["alignment"]
+        data = {"text": text}
+
+        if tag == "p":
+            _type = "paragraph"
+        elif tag.startswith("h"):
+            _type = "header"
+            data["level"] = int(tag.removeprefix("h"))
+        else:
+            # doesn't support alignment
+            raise TODO(f"Unsupported tag for alignment: {tag}")
+
+        return [
+            {
+                "type": _type,
+                "data": data,
+                "tunes": {"alignmentTune": {"alignment": alignment}},
+            }
+        ]
+
+    @classmethod
+    def to_text(cls, node: MDChildNode) -> str:
+        tag = node["tag"]
+        body = node["body"]
+        alignment = node["alignment"]
+        return f"<{tag} style='text-align: {alignment}'>{body}</{tag}>"
+
+
 class AttributeParser(HTMLParser):
     def __init__(self):
         super().__init__()

{edwh_editorjs-2.1.1 → edwh_editorjs-2.2.1}/editorjs/core.py

@@ -43,7 +43,11 @@ class EditorJS:
             if not (block := BLOCKS.get(_type)):
                 raise TypeError(f"Unsupported block type `{_type}`")
 
-            markdown_items.append(block.to_markdown(child.get("data", {})))
+            data = child.get("data", {})
+            # forward any 'tunes' via data:
+            data["tunes"] = data.get("tunes") or child.get("tunes") or {}
+
+            markdown_items.append(block.to_markdown(data))
 
         markdown = "".join(markdown_items)
         return cls.from_markdown(markdown)
@@ -88,7 +92,9 @@ class EditorJS:
         # idk why this happens:
         md = md.replace(r"\[ ]", "[ ]")
         md = md.replace(r"\[x]", "[x]")
-        return md
+        return md.replace(
+            "  <", " <"
+        )  # replace double space (added by mdast) with single one
 
     def to_mdast(self) -> str:
         """

{edwh_editorjs-2.1.1 → edwh_editorjs-2.2.1}/tests/test_core.py

@@ -135,12 +135,27 @@ def test_raw_html():
     e = EditorJS.from_json(raw_html_json)
     blocks = json.loads(e.to_json())
 
-    print(blocks)
-
     assert blocks["blocks"][0]["type"] == "paragraph", blocks["blocks"][0]["type"]
     assert blocks["blocks"][1]["type"] == "raw", blocks["blocks"][1]["type"]
     assert blocks["blocks"][2]["type"] == "paragraph", blocks["blocks"][2]["type"]
 
+    raw_html_json = r"""[{"id":"xGbqrb40Uz","type":"raw","data":{"html":"<marquee><kaas>mannetje</kaas></marquee>"}}]"""
+
+    e = EditorJS.from_json(raw_html_json)
+
+    print(e.to_mdast(), e.to_markdown())
+    e = EditorJS.from_markdown(e.to_markdown())
+    print(e.to_mdast(), e.to_markdown())
+
+    e = EditorJS.from_markdown(e.to_markdown())
+    e = EditorJS.from_markdown(e.to_markdown())
+    e = EditorJS.from_markdown(e.to_markdown())
+    e = EditorJS.from_markdown(e.to_markdown())
+    e = EditorJS.from_markdown(e.to_markdown())
+
+    print(e.to_markdown())
+    assert "     " not in e.to_markdown(), "added too many whitespaces"
+
 
 def test_code():
     e = EditorJS.from_markdown(textwrap.dedent("""
@@ -179,3 +194,19 @@ def test_code():
     assert blocks["blocks"][0]["type"] == "paragraph", blocks["blocks"][0]["type"]
     assert blocks["blocks"][1]["type"] == "code", blocks["blocks"][1]["type"]
     assert blocks["blocks"][2]["type"] == "paragraph", blocks["blocks"][2]["type"]
+
+
+def test_alignment():
+    json_blocks = r"""[{"id":"7pEj7OVRiI","type":"header","data":{"text":"Right","level":2},"tunes":{"alignmentTune":{"alignment":"right"}}},{"id":"BxL_tpq3AD","type":"paragraph","data":{"text":"right"},"tunes":{"alignmentTune":{"alignment":"right"}}},{"id":"KOh0mMtNQf","type":"header","data":{"text":"Center","level":2},"tunes":{"alignmentTune":{"alignment":"center"}}},{"id":"AegxKSR6Oa","type":"paragraph","data":{"text":"center"},"tunes":{"alignmentTune":{"alignment":"center"}}},{"id":"xJK82ujRe5","type":"header","data":{"text":"Left","level":3},"tunes":{"alignmentTune":{"alignment":"left"}}},{"id":"bwwQwKdZf0","type":"paragraph","data":{"text":"left"},"tunes":{"alignmentTune":{"alignment":"left"}}}]"""
+
+    e = EditorJS.from_json(json_blocks)
+
+    print(e.to_markdown())
+    print(e.to_html())
+
+    blocks = json.loads(e.to_json())
+
+    assert blocks["blocks"][0]["tunes"]
+
+    print(e.to_json())
+

edwh_editorjs-2.1.1/editorjs/__about__.py

@@ -1 +0,0 @@
-__version__ = "2.1.1"