edwh-editorjs 2.0.0b4__tar.gz → 2.0.1__tar.gz

edwh_editorjs-2.0.1/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+<!--next-version-placeholder-->
+
+## v2.0.1 (2024-11-26)
+
+### Fix
+
+* Table block, raw html block ([`849aeee`](https://github.com/educationwarehouse/edwh-editorjs/commit/849aeee9fcafd51cb71416edeb127820ee3fc89f))
+
+## v2.0.0 (2024-11-18)
+
+### Features
+
+* Rebuilt the editor logic based on MDAST for improved extensibility and maintainability ([`28c12f1`](https://github.com/educationwarehouse/edwh-editorjs/commit/28c12f1f74c71a995f9f8097f1b26be45f835ad4))
+* Added support for (basic) tables and custom Editor.js blocks, such as `linkTool` and `<editorjs>` ([`a6dfadf`](https://github.com/educationwarehouse/edwh-editorjs/commit/a6dfadf21ec008fe714704a056b9ffec751d731c))
+* Integrated `markdown2` extras to handle custom `<editorjs>` blocks ([`31d8647`](https://github.com/educationwarehouse/edwh-editorjs/commit/31d8647b7275e245dabf27a99c43d400217705be))
+
+### Fixes
+
+* Corrected behavior for nested lists ([`52a7773`](https://github.com/educationwarehouse/edwh-editorjs/commit/52a7773470dce3eee6a2d17d46b594551ed043a5))
+* Resolved an issue where rendered attachments were incorrectly marked as content-editable ([`58ab562`](https://github.com/educationwarehouse/edwh-editorjs/commit/58ab562daaca233455b3fe66b773af61f1abb0ad))
+
+
+## v1.1.0 (2024-10-31)
+
+### Feature
+
+* Expose _sanitize via EditorJSBlock.sanitize for external usage ([`7daa67c`](https://github.com/educationwarehouse/edwh-editorjs/commit/7daa67c90440510c83b573c22edf377cc2fd801f))
+
+### Documentation
+
+* Added section on defining new custom blocks ([`51d7720`](https://github.com/educationwarehouse/edwh-editorjs/commit/51d77208d4f8156e895de914f41bdeb882a508c0))
+
+## v1.0.1 (2024-10-31)
+
+### Documentation
+
+* Updated README ([`18d0216`](https://github.com/educationwarehouse/edwh-editorjs/commit/18d021629bcb223b89a9731e9ad8c574248f75c7))
+
+## v1.0.0 (2024-10-31)
+
+### Feature
+
+* Implemented more blocks (raw, warning, code, table, quote) ([`fb93bd9`](https://github.com/educationwarehouse/edwh-editorjs/commit/fb93bd959f06fa86bc23c9bfc51a8b7fddfc65f2))
+* Refactor to Registry Pattern so new block can be easily added ([`b06c86d`](https://github.com/educationwarehouse/edwh-editorjs/commit/b06c86da623dd2a2d92f7c48353a1f3208fb5749))

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

@@ -1,11 +1,9 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.0.0b4
+Version: 2.0.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>
-License: MIT
-License-File: LICENSE
 Keywords: bleach,clean,editor,editor.js,html,javascript,json,parser,wysiwyg
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers

edwh_editorjs-2.0.1/editorjs/__about__.py

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

{edwh_editorjs-2.0.0b4 → edwh_editorjs-2.0.1}/editorjs/blocks.py

@@ -6,6 +6,9 @@ import abc
 import re
 import typing as t
 from html.parser import HTMLParser
+from urllib.parse import urlparse
+
+import markdown2
 
 from .exceptions import TODO
 from .types import EditorChildData, MDChildNode
@@ -141,6 +144,7 @@ class ParagraphBlock(EditorJSBlock):
 
         skip = 0
         nodes = node.get("children", [])
+        any_html = False
 
         for idx, child in enumerate(nodes):
             if skip:
@@ -148,6 +152,7 @@ class ParagraphBlock(EditorJSBlock):
                 continue
 
             _type = child.get("type")
+            any_html |= _type == "html"
 
             # deal with custom types
             if _type == "html" and child.get("value", "").startswith("<editorjs"):
@@ -160,7 +165,7 @@ class ParagraphBlock(EditorJSBlock):
                 else:
                     # <editorjs>something</editorjs> = 3 children
                     result.extend(
-                        EditorJSCustom.to_json({"children": nodes[idx : idx + 2]})
+                        EditorJSCustom.to_json({"children": nodes[idx: idx + 2]})
                     )
 
                     skip = 2
@@ -168,8 +173,9 @@ class ParagraphBlock(EditorJSBlock):
 
             elif _type == "image":
                 if current_text:
-                    result.append({"data": {"text": current_text}, "type": "paragraph"})
+                    result.append({"data": {"text": current_text}, "type": "raw" if any_html else "paragraph"})
                     current_text = ""
+                    any_html = False # reset
 
                 result.extend(ImageBlock.to_json(child))
             else:
@@ -188,7 +194,7 @@ class ParagraphBlock(EditorJSBlock):
 
         # final text after image:
         if current_text:
-            result.append({"data": {"text": current_text}, "type": "paragraph"})
+            result.append({"data": {"text": current_text}, "type": "raw" if any_html else "paragraph"})
 
         return result
 
@@ -217,7 +223,7 @@ class ListBlock(EditorJSBlock):
 
             return "\n".join(markdown_items)
 
-        return "\n" + parse_items(items) + "\n"
+        return "\n" + parse_items(items) + "\n\n"
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -311,7 +317,7 @@ class ChecklistBlock(ListBlock):
             char = "x" if item.get("checked", False) else " "
             markdown_items.append(f"- [{char}] {text}")
 
-        return "\n" + "\n".join(markdown_items) + "\n"
+        return "\n" + "\n".join(markdown_items) + "\n\n"
 
 
 @block("thematicBreak", "delimiter")
@@ -419,6 +425,22 @@ class QuoteBlock(EditorJSBlock):
         return default_to_text(node)
 
 
+@block("raw")
+class RawBlock(EditorJSBlock):
+
+    @classmethod
+    def to_markdown(cls, data: EditorChildData) -> str:
+        return data.get("html", "")
+
+    @classmethod
+    def to_json(cls, node: MDChildNode) -> list[dict]:
+        raise TODO(node)
+
+    @classmethod
+    def to_text(cls, node: MDChildNode) -> str:
+        raise TODO(node)
+
+
 @block("table")
 class TableBlock(EditorJSBlock):
 
@@ -474,8 +496,10 @@ class TableBlock(EditorJSBlock):
         return [
             {
                 "type": "table",
-                "content": table,
-                "withHeadings": with_headings,
+                "data": {
+                    "content": table,
+                    "withHeadings": with_headings,
+                }
             }
         ]
 
@@ -515,7 +539,66 @@ class LinkBlock(EditorJSBlock):
 
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
-        return ""
+        url = node.get("href", "")
+        image = node.get("image", "")
+        title = node.get("title", "")
+        body = node.get("body", "")
+        domain = urlparse(url).netloc
+
+        return f"""
+        <div class="link-tool">
+            <a class="link-tool__content link-tool__content--rendered" target="_blank"
+               rel="nofollow noindex noreferrer" href="{url}">
+                <div class="link-tool__image"
+                     style="background-image: url(&quot;{image}&quot;);"></div>
+                <div class="link-tool__title">{title}</div>
+                <p class="link-tool__description">{body}</p>
+                <span class="link-tool__anchor">{domain}</span>
+            </a>
+        </div>
+        """
+
+
+@block("attaches")
+class AttachmentBlock(EditorJSBlock):
+
+    @classmethod
+    def to_markdown(cls, data: EditorChildData) -> str:
+        file = data.get("file", {}).get("url", "")
+        title = data.get("title", "")
+        return f"""<editorjs type="attaches" file="{file}">{title}</editorjs>"""
+
+    @classmethod
+    def to_json(cls, node: MDChildNode) -> list[dict]:
+        return [
+            {
+                "type": "attaches",
+                "data": {
+                    "file": {"url": node.get("file", "")},
+                    "title": node.get("body", ""),
+                },
+            }
+        ]
+
+    @classmethod
+    def to_text(cls, node: MDChildNode) -> str:
+        return f"""
+        <div class="cdx-attaches cdx-attaches--with-file">
+            <div class="cdx-attaches__file-icon">
+                <div class="cdx-attaches__file-icon-background">
+                    <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M13.3236 8.43554L9.49533 12.1908C9.13119 12.5505 8.93118 13.043 8.9393 13.5598C8.94741 14.0767 9.163 14.5757 9.53862 14.947C9.91424 15.3182 10.4191 15.5314 10.9422 15.5397C11.4653 15.5479 11.9637 15.3504 12.3279 14.9908L16.1562 11.2355C16.8845 10.5161 17.2845 9.53123 17.2682 8.4975C17.252 7.46376 16.8208 6.46583 16.0696 5.72324C15.3184 4.98066 14.3086 4.55425 13.2624 4.53782C12.2162 4.52138 11.2193 4.91627 10.4911 5.63562L6.66277 9.39093C5.57035 10.4699 4.97032 11.9473 4.99467 13.4979C5.01903 15.0485 5.66578 16.5454 6.79264 17.6592C7.9195 18.7731 9.43417 19.4127 11.0034 19.4374C12.5727 19.462 14.068 18.8697 15.1604 17.7907L18.9887 14.0354"></path></svg>
+                </div>
+            </div>
+            <div class="cdx-attaches__file-info">
+                <div class="cdx-attaches__title" data-placeholder="File title" data-empty="false">
+                {node.get("body", "")}
+                </div>
+            </div>
+            <a class="cdx-attaches__download-button" href="{node.get('file', '')}" target="_blank" rel="nofollow noindex noreferrer">
+                <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24"><path stroke="currentColor" stroke-linecap="round" stroke-width="2" d="M7 10L11.8586 14.8586C11.9367 14.9367 12.0633 14.9367 12.1414 14.8586L17 10"></path></svg>
+            </a>
+        </div>
+        """
 
 
 class AttributeParser(HTMLParser):
@@ -532,11 +615,14 @@ class AttributeParser(HTMLParser):
         self.data = data
 
 
-class EditorJSCustom(EditorJSBlock):
+class EditorJSCustom(EditorJSBlock, markdown2.Extra):
     """
     Special type of block to deal with custom attributes
     """
 
+    name = "editorjs"
+    order = (), (markdown2.Stage.POSTPROCESS,)
+
     @classmethod
     def parse_html(cls, html: str):
         parser = AttributeParser()
@@ -563,3 +649,27 @@ class EditorJSCustom(EditorJSBlock):
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
         raise TODO()
+
+    # markdown2:
+    re_short = re.compile(r"<editorjs.*?/>")
+    re_long = re.compile(r"<editorjs.*?>.*?</editorjs>")
+
+    def run(self, text: str) -> str:
+        def replace_html(match):
+            attrs, body = self.parse_html(match.group())
+            _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_text(attrs)
+
+        # Substitute using the replacement functions
+        text = self.re_long.sub(replace_html, text)
+        text = self.re_short.sub(replace_html, text)
+
+        return text
+
+
+EditorJSCustom.register()

{edwh_editorjs-2.0.0b4 → edwh_editorjs-2.0.1}/editorjs/core.py

@@ -1,5 +1,4 @@
 import json
-import textwrap
 import typing as t
 
 import markdown2
@@ -7,7 +6,6 @@ import mdast
 from typing_extensions import Self
 
 from .blocks import BLOCKS
-from .exceptions import TODO
 from .helpers import unix_timestamp
 from .types import MDRootNode
 
@@ -21,7 +19,7 @@ class EditorJS:
     def __init__(
         self,
         _mdast: str | dict,
-        extras: list = ("task_list", "fenced-code-blocks", "tables"),
+        extras: list = ("task_list", "fenced-code-blocks", "tables", "editorjs"),
     ):
         if not isinstance(_mdast, str | dict):
             raise TypeError("Only `str` or `dict` is supported!")
@@ -102,7 +100,7 @@ class EditorJS:
         Export HTML string
         """
         md = self.to_markdown()
-        # todo: deal with custom elements like linktool
+        # todo: deal with custom elements like linktool, attaches
         return self._md.convert(md)
 
     def __repr__(self):

{edwh_editorjs-2.0.0b4 → edwh_editorjs-2.0.1}/pyproject.toml

@@ -12,7 +12,7 @@ authors = [
     { name = "SKevo", email = "skevo.cw@gmail.com" },
     { name = "Robin van der Noord", email = "robin.vdn@educationwarehouse.nl" },
 ]
-license = { text = "MIT" }
+license-expression = { text = "MIT" }
 keywords = ["editor.js", "parser", "clean", "bleach", "wysiwyg", "editor", "javascript", "html", "json"]
 classifiers = [
     "Development Status :: 4 - Beta",

{edwh_editorjs-2.0.0b4 → edwh_editorjs-2.0.1}/tests/test_core.py

@@ -1,3 +1,4 @@
+import json
 import textwrap
 
 from editorjs import EditorJS
@@ -89,13 +90,36 @@ def test_linktool():
 TABLE1_JSON = r"""{"time":1730984047714,"blocks":[{"id":"SNXL5vru_a","type":"table","data":{"withHeadings":false,"stretched":false,"content":[["1.1","2.1"],["1.2","2.2"]]}},{"id":"q0IC_sL8P5","type":"paragraph","data":{"text":"<mark class=\"cdx-marker\">marked</mark>"}}],"version":"2.30.6"}"""
 TABLE2_JSON = r"""{"time":1730984305796,"blocks":[{"id":"vBf5hT3jeR","type":"linkTool","data":{"link":"https://fb.me","meta":{"title":"","description":"Meld je aan bij Facebook om te delen en contact te maken met je vrienden, familie en mensen die je kent.","image":{"url":"https://www.facebook.com/images/fb_icon_325x325.png"}}}},{"id":"7bP-0bw1OT","type":"table","data":{"withHeadings":true,"stretched":false,"content":[["Yeah","Okay"],["<i>1</i>","<code class=\"inline-code\">2</code>"]]}}],"version":"2.30.6"}"""
 
+
 def test_table():
-    # e = EditorJS.from_json(TABLE1_JSON)
-    # print(e.to_markdown())
-    # print(e.to_json())
-    # print(e.to_html())
+    e = EditorJS.from_json(TABLE1_JSON)
+    print(e.to_markdown())
+    print(e.to_json())
+    print(e.to_html())
 
     e = EditorJS.from_json(TABLE2_JSON)
     print(e.to_markdown())
     print(e.to_json())
-    print(e.to_html())
+    print(e.to_html())
+
+
+ATTACHMENT_JSON = r"""{"time":1730989152705,"blocks":[{"id":"s3k3WCp1da","type":"header","data":{"text":"Hi","level":2}},{"id":"EehvyuBEKx","type":"paragraph","data":{"text":"<b>Paragraph</b> <i>met</i> <a href=\"http://g.co\">mooie</a> <code class=\"inline-code\">markup </code><mark class=\"cdx-marker\">asdf</mark>"}},{"id":"S1ENjQ6XEw","type":"list","data":{"style":"unordered","items":[{"content":"u","items":[]},{"content":"l","items":[]}]}},{"id":"ezy6f8-7gj","type":"list","data":{"style":"ordered","items":[{"content":"o","items":[]},{"content":"l","items":[]}]}},{"id":"DsHJI0tccS","type":"image","data":{"caption":"streamers","withBorder":false,"withBackground":false,"stretched":false,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/17.txt?hash=3ef2d77e2f4f493651119f65d1657b01de939adb"}}},{"id":"VhvLUtaKcB","type":"quote","data":{"text":"ik ben een streamer","caption":"Frank Lammers","alignment":"left"}},{"id":"yrQLgdrYWC","type":"delimiter","data":{}},{"id":"88cMVCXNZF","type":"table","data":{"withHeadings":true,"stretched":false,"content":[["Tafels","Deuren"],["1 * 1","1"],["2 * 2","4"]]}},{"id":"vlSOey3tKF","type":"code","data":{"code":"if crash: don't"}},{"id":"zPzINXsico","type":"raw","data":{"html":"<marquee>Wheeeee</marquee>"}},{"id":"rbc6buobti","type":"checklist","data":{"items":[{"text":"check","checked":false},{"text":"one","checked":true},{"text":"two","checked":false}]}},{"id":"0JGAjTs_77","type":"linkTool","data":{"link":"https://trialandsuccess.nl","meta":{"title":"Trial and Success","description":"Welkom op de website van Trial and Success! Ik, Robin van der Noord, ontwerp en bouw websites en webapplicaties, helemaal toegespitst op de wensen van de klant. Ook kan ik de hosting en het onderhoud van uw website verzorgen.","image":{"url":"https://trialandsuccess.nl/static/images/og.png"}}}},{"id":"h8Zt0aKD5p","type":"attaches","data":{"file":{"url":"https://py4web.leiden.dockers.local/img/upload/18.txt?hash=f114bad0e27c84eb1f70ba2d6168d2a76b9efca9"},"title":"Attachment, Download nu!"}}],"version":"2.30.6"}"""
+
+
+def test_attachment():
+    e = EditorJS.from_json(ATTACHMENT_JSON)
+    print(e.to_markdown())
+    print(e.to_json())
+    print(e.to_html())
+
+
+def test_raw_html():
+    e = EditorJS.from_markdown(textwrap.dedent("""
+    # Raw  HTML
+    
+    <marquee>This ain't no paragraph</marquee>
+    """))
+
+    blocks = json.loads(e.to_json())
+
+    assert blocks["blocks"][1]["type"] == "raw", blocks["blocks"][1]["type"]

edwh_editorjs-2.0.0b4/CHANGELOG.md

@@ -1,48 +0,0 @@
-# Changelog
-
-<!--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
-
-* Various fixes with nested lists ([`52a7773`](https://github.com/educationwarehouse/edwh-editorjs/commit/52a7773470dce3eee6a2d17d46b594551ed043a5))
-
-## v2.0.0-beta.2 (2024-11-06)
-
-### Feature
-
-* Work in progress to do a rebuild based on mdast ([`28c12f1`](https://github.com/educationwarehouse/edwh-editorjs/commit/28c12f1f74c71a995f9f8097f1b26be45f835ad4))
-
-## v2.0.0-beta.1 (2024-11-06)
-
-
-
-## v1.1.0 (2024-10-31)
-
-### Feature
-
-* Expose _sanitize via EditorJSBlock.sanitize for external usage ([`7daa67c`](https://github.com/educationwarehouse/edwh-editorjs/commit/7daa67c90440510c83b573c22edf377cc2fd801f))
-
-### Documentation
-
-* Added section on defining new custom blocks ([`51d7720`](https://github.com/educationwarehouse/edwh-editorjs/commit/51d77208d4f8156e895de914f41bdeb882a508c0))
-
-## v1.0.1 (2024-10-31)
-
-### Documentation
-
-* Updated README ([`18d0216`](https://github.com/educationwarehouse/edwh-editorjs/commit/18d021629bcb223b89a9731e9ad8c574248f75c7))
-
-## v1.0.0 (2024-10-31)
-
-### Feature
-
-* Implemented more blocks (raw, warning, code, table, quote) ([`fb93bd9`](https://github.com/educationwarehouse/edwh-editorjs/commit/fb93bd959f06fa86bc23c9bfc51a8b7fddfc65f2))
-* Refactor to Registry Pattern so new block can be easily added ([`b06c86d`](https://github.com/educationwarehouse/edwh-editorjs/commit/b06c86da623dd2a2d92f7c48353a1f3208fb5749))

edwh_editorjs-2.0.0b4/LICENSE

@@ -1,22 +0,0 @@
-MIT License
-
-Copyright (c) 2021 SKevo
-Copyright (c) 2024 Education Warehouse
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

edwh_editorjs-2.0.0b4/editorjs/__about__.py

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