edwh-editorjs 2.0.0b3__tar.gz → 2.0.0b4__tar.gz

{edwh_editorjs-2.0.0b3 → edwh_editorjs-2.0.0b4}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v2.0.0-beta.4 (2024-11-07)
+
+### Feature
+
+* Support (basic) tables, custom editorjs blocks like linkTool via <editorjs> ([`a6dfadf`](https://github.com/educationwarehouse/edwh-editorjs/commit/a6dfadf21ec008fe714704a056b9ffec751d731c))
+
 ## v2.0.0-beta.3 (2024-11-06)
 
 ### Fix

{edwh_editorjs-2.0.0b3 → edwh_editorjs-2.0.0b4}/PKG-INFO

@@ -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/editorjs/__about__.py

@@ -0,0 +1 @@
+__version__ = "2.0.0-beta.4"

{edwh_editorjs-2.0.0b3 → edwh_editorjs-2.0.0b4}/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()

{edwh_editorjs-2.0.0b3 → edwh_editorjs-2.0.0b4}/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.0b4/htmlcov/.gitignore

@@ -0,0 +1,2 @@
+# Created by coverage.py
+*

edwh_editorjs-2.0.0b4/htmlcov/class_index.html

@@ -0,0 +1,259 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Coverage report</title>
+    <link rel="icon" sizes="32x32" href="favicon_32_cb_58284776.png">
+    <link rel="stylesheet" href="style_cb_8e611ae1.css" type="text/css">
+    <script src="coverage_html_cb_6fb7b396.js" defer></script>
+</head>
+<body class="indexfile">
+<header>
+    <div class="content">
+        <h1>Coverage report:
+            <span class="pc_cov">76%</span>
+        </h1>
+        <aside id="help_panel_wrapper">
+            <input id="help_panel_state" type="checkbox">
+            <label for="help_panel_state">
+                <img id="keyboard_icon" src="keybd_closed_cb_ce680311.png" alt="Show/hide keyboard shortcuts">
+            </label>
+            <div id="help_panel">
+                <p class="legend">Shortcuts on this page</p>
+                <div class="keyhelp">
+                    <p>
+                        <kbd>f</kbd>
+                        <kbd>n</kbd>
+                        <kbd>s</kbd>
+                        <kbd>m</kbd>
+                        <kbd>x</kbd>
+                        <kbd>c</kbd>
+                        &nbsp; change column sorting
+                    </p>
+                    <p>
+                        <kbd>[</kbd>
+                        <kbd>]</kbd>
+                        &nbsp; prev/next file
+                    </p>
+                    <p>
+                        <kbd>?</kbd> &nbsp; show/hide this help
+                    </p>
+                </div>
+            </div>
+        </aside>
+        <form id="filter_container">
+            <input id="filter" type="text" value="" placeholder="filter...">
+            <div>
+                <input id="hide100" type="checkbox" >
+                <label for="hide100">hide covered</label>
+            </div>
+        </form>
+        <h2>
+                <a class="button" href="index.html">Files</a>
+                <a class="button" href="function_index.html">Functions</a>
+                <a class="button current">Classes</a>
+        </h2>
+        <p class="text">
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.4">coverage.py v7.6.4</a>,
+            created at 2024-10-31 13:29 +0100
+        </p>
+    </div>
+</header>
+<main id="index">
+    <table class="index" data-sortable>
+        <thead>
+            <tr class="tablehead" title="Click to sort">
+                <th id="file" class="name left" aria-sort="none" data-shortcut="f">File<span class="arrows"></span></th>
+                <th id="region" class="name left" aria-sort="none" data-default-sort-order="ascending" data-shortcut="n">class<span class="arrows"></span></th>
+                <th id="statements" aria-sort="none" data-default-sort-order="descending" data-shortcut="s">statements<span class="arrows"></span></th>
+                <th id="missing" aria-sort="none" data-default-sort-order="descending" data-shortcut="m">missing<span class="arrows"></span></th>
+                <th id="excluded" aria-sort="none" data-default-sort-order="descending" data-shortcut="x">excluded<span class="arrows"></span></th>
+                <th id="coverage" class="right" aria-sort="none" data-shortcut="c">coverage<span class="arrows"></span></th>
+            </tr>
+        </thead>
+        <tbody>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9___init___py.html">pyeditorjs/__init__.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9___init___py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
+                <td>14</td>
+                <td>3</td>
+                <td>0</td>
+                <td class="right" data-ratio="11 14">79%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t42">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t42"><data value='EditorJsBlock'>EditorJsBlock</data></a></td>
+                <td>4</td>
+                <td>3</td>
+                <td>0</td>
+                <td class="right" data-ratio="1 4">25%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t87">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t87"><data value='HeaderBlock'>HeaderBlock</data></a></td>
+                <td>9</td>
+                <td>1</td>
+                <td>0</td>
+                <td class="right" data-ratio="8 9">89%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t120">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t120"><data value='ParagraphBlock'>ParagraphBlock</data></a></td>
+                <td>2</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="2 2">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t134">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t134"><data value='ListBlock'>ListBlock</data></a></td>
+                <td>8</td>
+                <td>1</td>
+                <td>0</td>
+                <td class="right" data-ratio="7 8">88%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t168">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t168"><data value='DelimiterBlock'>DelimiterBlock</data></a></td>
+                <td>1</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="1 1">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t174">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t174"><data value='ImageBlock'>ImageBlock</data></a></td>
+                <td>10</td>
+                <td>1</td>
+                <td>0</td>
+                <td class="right" data-ratio="9 10">90%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t236">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t236"><data value='QuoteBlock'>QuoteBlock</data></a></td>
+                <td>7</td>
+                <td>7</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 7">0%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t253">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t253"><data value='TableBlock'>TableBlock</data></a></td>
+                <td>11</td>
+                <td>11</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 11">0%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t275">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t275"><data value='CodeBlock'>CodeBlock</data></a></td>
+                <td>4</td>
+                <td>4</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 4">0%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t286">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t286"><data value='WarningBlock'>WarningBlock</data></a></td>
+                <td>6</td>
+                <td>6</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 6">0%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t304">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html#t304"><data value='RawBlock'>RawBlock</data></a></td>
+                <td>4</td>
+                <td>4</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 4">0%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html">pyeditorjs/blocks.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_blocks_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
+                <td>80</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="80 80">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html#t8">pyeditorjs/exceptions.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html#t8"><data value='EditorJsException'>EditorJsException</data></a></td>
+                <td>0</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 0">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html#t14">pyeditorjs/exceptions.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html#t14"><data value='EditorJsParseError'>EditorJsParseError</data></a></td>
+                <td>0</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 0">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html#t18">pyeditorjs/exceptions.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html#t18"><data value='EditorJSUnsupportedBlock'>EditorJSUnsupportedBlock</data></a></td>
+                <td>0</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="0 0">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html">pyeditorjs/exceptions.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_exceptions_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
+                <td>4</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="4 4">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_parser_py.html#t10">pyeditorjs/parser.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_parser_py.html#t10"><data value='EditorJsParser'>EditorJsParser</data></a></td>
+                <td>19</td>
+                <td>6</td>
+                <td>0</td>
+                <td class="right" data-ratio="13 19">68%</td>
+            </tr>
+            <tr class="region">
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_parser_py.html">pyeditorjs/parser.py</a></td>
+                <td class="name left"><a href="z_a93c8aeb4b8fa1f9_parser_py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
+                <td>15</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="right" data-ratio="15 15">100%</td>
+            </tr>
+        </tbody>
+        <tfoot>
+            <tr class="total">
+                <td class="name left">Total</td>
+                <td class="name left">&nbsp;</td>
+                <td>198</td>
+                <td>47</td>
+                <td>0</td>
+                <td class="right" data-ratio="151 198">76%</td>
+            </tr>
+        </tfoot>
+    </table>
+    <p id="no_rows">
+        No items found using the specified filter.
+    </p>
+</main>
+<footer>
+    <div class="content">
+        <p>
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.6.4">coverage.py v7.6.4</a>,
+            created at 2024-10-31 13:29 +0100
+        </p>
+    </div>
+    <aside class="hidden">
+        <a id="prevFileLink" class="nav" href=""></a>
+        <a id="nextFileLink" class="nav" href=""></a>
+        <button type="button" class="button_prev_file" data-shortcut="["></button>
+        <button type="button" class="button_next_file" data-shortcut="]"></button>
+        <button type="button" class="button_show_hide_help" data-shortcut="?"></button>
+    </aside>
+</footer>
+</body>
+</html>