edwh-editorjs 2.0.0b3__py3-none-any.whl → 2.0.0b4__py3-none-any.whl

editorjs/__about__.py

@@ -1 +1 @@
-__version__ = "2.0.0-beta.3"
+__version__ = "2.0.0-beta.4"

editorjs/blocks.py

@@ -5,6 +5,7 @@ mdast to editorjs
 import abc
 import re
 import typing as t
+from html.parser import HTMLParser
 
 from .exceptions import TODO
 from .types import EditorChildData, MDChildNode
@@ -56,7 +57,7 @@ def process_styled_content(item: MDChildNode, strict: bool = True) -> str:
         "strongEmphasis": "<b><i>{value}</i></b>",
         "link": '<a href="{url}">{value}</a>',
         "inlineCode": '<code class="inline-code">{value}</code>',
-        # todo: <mark>
+        # todo: <mark>, linktool
     }
 
     if _type in BLOCKS:
@@ -138,16 +139,52 @@ class ParagraphBlock(EditorJSBlock):
         result = []
         current_text = ""
 
-        for child in node.get("children"):
+        skip = 0
+        nodes = node.get("children", [])
+
+        for idx, child in enumerate(nodes):
+            if skip:
+                skip -= 1
+                continue
+
             _type = child.get("type")
-            if _type == "image":
+
+            # deal with custom types
+            if _type == "html" and child.get("value", "").startswith("<editorjs"):
+                # special type, e.g. <editorjs type="linkTool" href=...>...</editorjs>
+
+                if child.get("value", "").endswith("/>"):
+                    # self-closing
+                    result.append(EditorJSCustom.to_json(node))
+                    continue
+                else:
+                    # <editorjs>something</editorjs> = 3 children
+                    result.extend(
+                        EditorJSCustom.to_json({"children": nodes[idx : idx + 2]})
+                    )
+
+                    skip = 2
+                    continue
+
+            elif _type == "image":
                 if current_text:
                     result.append({"data": {"text": current_text}, "type": "paragraph"})
                     current_text = ""
 
                 result.extend(ImageBlock.to_json(child))
             else:
-                current_text += cls.to_text(child)
+                child_text = cls.to_text(child)
+                _child_text = child_text.strip()
+                if _child_text.startswith("|") and _child_text.endswith("|"):
+                    # note: this just supports text-only tables.
+                    # tables with more complex elements break into multiple children.
+                    # and mdast DOES support converting into a Table/TableCell structure
+                    # via the GFM exttension
+                    # but their default mdast->md converter does NOT implement these functionalities.
+                    result.extend(TableBlock.to_json(child))
+                    continue
+
+                current_text += child_text
 
         # final text after image:
         if current_text:
@@ -380,3 +417,149 @@ class QuoteBlock(EditorJSBlock):
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
         return default_to_text(node)
+
+
+@block("table")
+class TableBlock(EditorJSBlock):
+
+    @classmethod
+    def to_markdown(cls, data: EditorChildData) -> str:
+        """
+        | Script | Interpreter | User | System |   |
+        |--------|-------------|------|--------|---|
+        |        |             |      |        |   |
+        |        |             |      |        |   |
+        |        |             |      |        |   |
+        """
+
+        table = ""
+        rows = data.get("content", [])
+
+        # Add an empty header row if no headings are provided
+        if not data.get("withHeadings", False) and rows:
+            table += "| " + " | ".join([""] * len(rows[0])) + " |\n"
+            table += "|" + " - |" * len(rows[0]) + "\n"
+
+        # Populate rows
+        for idx, tr in enumerate(rows):
+            table += "| " + " | ".join(tr) + " |\n"
+
+            # Add separator if headings are enabled and it's the first row
+            if not idx and data.get("withHeadings", False):
+                table += "|" + " - |" * len(tr) + "\n"
+
+        return f"\n{table}\n"
+
+    @classmethod
+    def to_json(cls, node: MDChildNode) -> list[dict]:
+        # content":[["Yeah","Okay"],["<i>1</i>","<code class=\"inline-code\">2</code>"]]}}]
+        table = []
+        with_headings = False
+
+        # first row is headings or empty. If not empty, withHeadings is True
+        # second row must be ignored
+        for idx, row in enumerate(node.get("value", "").strip().split("\n")):
+            tr = [_.strip() for _ in row.split("|")[1:-1]]
+            if not idx:
+                # first
+                if any(tr):
+                    with_headings = True
+                    table.append(tr)
+
+            elif idx == 1:
+                continue
+            else:
+                table.append(tr)
+
+        return [
+            {
+                "type": "table",
+                "content": table,
+                "withHeadings": with_headings,
+            }
+        ]
+
+    @classmethod
+    def to_text(cls, node: MDChildNode) -> str:
+        raise TODO(node)
+
+
+@block("linkTool")
+class LinkBlock(EditorJSBlock):
+    @classmethod
+    def to_markdown(cls, data: EditorChildData) -> str:
+        link = data.get("link", "")
+        meta = data.get("meta", {})
+        title = meta.get("title", "")
+        description = meta.get("description", "")
+        image = meta.get("image", {}).get("url", "")
+        return f"""<editorjs type="linkTool" href="{link}" title="{title}" image="{image}">{description}</editorjs>"""
+
+    @classmethod
+    def to_json(cls, node: MDChildNode) -> list[dict]:
+        return [
+            {
+                "type": "linkTool",
+                "data": {
+                    "link": node.get("href", ""),
+                    "meta": {
+                        "title": node.get("title", ""),
+                        "description": node.get("body", ""),
+                        "image": {
+                            "url": node.get("image", ""),
+                        },
+                    },
+                },
+            }
+        ]
+
+    @classmethod
+    def to_text(cls, node: MDChildNode) -> str:
+        return ""
+
+
+class AttributeParser(HTMLParser):
+    def __init__(self):
+        super().__init__()
+        self.attributes = {}
+        self.data = None
+
+    def handle_starttag(self, tag, attrs):
+        # Collect attributes when the tag is encountered
+        self.attributes = dict(attrs)
+
+    def handle_data(self, data):
+        self.data = data
+
+
+class EditorJSCustom(EditorJSBlock):
+    """
+    Special type of block to deal with custom attributes
+    """
+
+    @classmethod
+    def parse_html(cls, html: str):
+        parser = AttributeParser()
+        parser.feed(html)
+
+        return parser.attributes, parser.data
+
+    @classmethod
+    def to_markdown(cls, data: EditorChildData) -> str:
+        raise TODO()
+
+    @classmethod
+    def to_json(cls, node: MDChildNode) -> list[dict]:
+        html = "".join(_["value"] for _ in node.get("children", []))
+        attrs, body = cls.parse_html(html)
+        _type = attrs.get("type", "")
+        attrs.setdefault("body", body)  # only if there is no such attribute yet
+
+        if not (handler := BLOCKS.get(_type)):
+            raise ValueError(f"Unknown custom type {_type}")
+
+        return handler.to_json(attrs)
+
+    @classmethod
+    def to_text(cls, node: MDChildNode) -> str:
+        raise TODO()

editorjs/core.py

@@ -18,7 +18,11 @@ class EditorJS:
     # internal representation is mdast, because we can convert to other types
     _mdast: MDRootNode
 
-    def __init__(self, _mdast: str | dict, extras: list = ("task_list", "fenced-code-blocks")):
+    def __init__(
+        self,
+        _mdast: str | dict,
+        extras: list = ("task_list", "fenced-code-blocks", "tables"),
+    ):
         if not isinstance(_mdast, str | dict):
             raise TypeError("Only `str` or `dict` is supported!")
 
@@ -26,7 +30,7 @@ class EditorJS:
             MDRootNode, json.loads(_mdast) if isinstance(_mdast, str) else _mdast
         )
 
-        self._md = markdown2.Markdown(extras=extras)  # todo: striketrough, table, ?
+        self._md = markdown2.Markdown(extras=extras)  # todo: striketrough, ?
 
     @classmethod
     def from_json(cls, data: str | dict) -> Self:
@@ -98,6 +102,7 @@ class EditorJS:
         Export HTML string
         """
         md = self.to_markdown()
+        # todo: deal with custom elements like linktool
         return self._md.convert(md)
 
     def __repr__(self):

{edwh_editorjs-2.0.0b3.dist-info → edwh_editorjs-2.0.0b4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.0.0b3
+Version: 2.0.0b4
 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.0.0b4.dist-info/RECORD

@@ -0,0 +1,11 @@
+editorjs/__about__.py,sha256=nNwsxbhqslw4VX_3DwOL0FdYImal5yO3Y3Co_qiJaQk,29
+editorjs/__init__.py,sha256=-OHUf7ZXfkbdFB1r85eIjpHRfql-GCNUCKuBEdEt2Rc,58
+editorjs/blocks.py,sha256=g9gP09aIc63gRU7kbI7by1cJyvPFm69JxYn_43xblpM,17230
+editorjs/core.py,sha256=RiJYbQk6ladkOuTM7Gj7nrmHO_ud6qQg31dhTxMn6bI,3354
+editorjs/exceptions.py,sha256=TyfHvk2Z5RbKxTDK7lrjgwAgVgInXIuDW63eO5jzVFw,106
+editorjs/helpers.py,sha256=q861o5liNibMTp-Ozay17taF7CTNsRe901lYhhxdwHg,73
+editorjs/types.py,sha256=W7IZWMWgzJaQulybIt0Gx5N63rVj4mEy73VJWo4VAQA,1029
+edwh_editorjs-2.0.0b4.dist-info/METADATA,sha256=x9NF5PqOaUK-5YaAMrqABybTV0SmX4LsRAq2rotleOo,1009
+edwh_editorjs-2.0.0b4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+edwh_editorjs-2.0.0b4.dist-info/licenses/LICENSE,sha256=zzllbk0pvnmgzk31iq8Zkg0GkA8vVx_Zc3OHjVlTjxo,1101
+edwh_editorjs-2.0.0b4.dist-info/RECORD,,

edwh_editorjs-2.0.0b3.dist-info/RECORD

@@ -1,11 +0,0 @@
-editorjs/__about__.py,sha256=TTjbddHImhhMSF_k6S9WFgA-Fcil370fw4WeR8a-eBk,29
-editorjs/__init__.py,sha256=-OHUf7ZXfkbdFB1r85eIjpHRfql-GCNUCKuBEdEt2Rc,58
-editorjs/blocks.py,sha256=WTtzsflkbhkZhjYQ6vZ_6Frl66ZU9uUbWwnX4mGzu4c,11341
-editorjs/core.py,sha256=_mr-WJ2QgB2drgBLnPM38DAPTaxZba--H_EWiQcAZMY,3264
-editorjs/exceptions.py,sha256=TyfHvk2Z5RbKxTDK7lrjgwAgVgInXIuDW63eO5jzVFw,106
-editorjs/helpers.py,sha256=q861o5liNibMTp-Ozay17taF7CTNsRe901lYhhxdwHg,73
-editorjs/types.py,sha256=W7IZWMWgzJaQulybIt0Gx5N63rVj4mEy73VJWo4VAQA,1029
-edwh_editorjs-2.0.0b3.dist-info/METADATA,sha256=QeUtRWqC6v8mGhkm16JoFJ78KhFW0mSEhxHifKTmYjI,1009
-edwh_editorjs-2.0.0b3.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-edwh_editorjs-2.0.0b3.dist-info/licenses/LICENSE,sha256=zzllbk0pvnmgzk31iq8Zkg0GkA8vVx_Zc3OHjVlTjxo,1101
-edwh_editorjs-2.0.0b3.dist-info/RECORD,,