edwh-editorjs 2.0.1__tar.gz → 2.1.0__tar.gz

{edwh_editorjs-2.0.1 → edwh_editorjs-2.1.0}/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 <!--next-version-placeholder-->
 
+## v2.1.0 (2024-11-26)
+
+### Feature
+
+* `EditorJS.from_json` now also accepts a (json) list of blocks instead of the full object (dictionary with time, version, blocks) ([`9f24c15`](https://github.com/educationwarehouse/edwh-editorjs/commit/9f24c15983948db96153901e804b9a2b11029f49))
+
+### Fix
+
+* Better separation between raw and paragraph blocks ([`f7620cf`](https://github.com/educationwarehouse/edwh-editorjs/commit/f7620cf6f34a0a9b9a218fb1c78a67a04f15b78e))
+
+## v2.0.2 (2024-11-26)
+
+### Fix
+
+* Raw block pt2 ([`37ee6bc`](https://github.com/educationwarehouse/edwh-editorjs/commit/37ee6bc09dd8f54ca22f2652be1c5920d74779d1))
+
 ## v2.0.1 (2024-11-26)
 
 ### Fix

{edwh_editorjs-2.0.1 → edwh_editorjs-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.0.1
+Version: 2.1.0
 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.1.0/editorjs/__about__.py

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

{edwh_editorjs-2.0.1 → edwh_editorjs-2.1.0}/editorjs/blocks.py

@@ -130,12 +130,20 @@ class HeadingBlock(EditorJSBlock):
         return child.get("value", "")
 
 
+def paragraph_block(text: str):
+    return {"type": "paragraph", "data": {"text": text}}
+
+
+def raw_block(html: str):
+    return {"type": "raw", "data": {"html": html}}
+
+
 @block("paragraph")
 class ParagraphBlock(EditorJSBlock):
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         text = data.get("text", "")
-        return f"{text}\n"
+        return f"{text}\n\n"
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -165,7 +173,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
@@ -173,9 +181,14 @@ class ParagraphBlock(EditorJSBlock):
 
             elif _type == "image":
                 if current_text:
-                    result.append({"data": {"text": current_text}, "type": "raw" if any_html else "paragraph"})
+                    # {"id":"zksvpxQTDD","type":"raw","data":{"html":"<marquee> raw </marquee>"}}
+                    result.append(
+                        raw_block(current_text)
+                        if any_html
+                        else paragraph_block(current_text)
+                    )
                     current_text = ""
-                    any_html = False # reset
+                    any_html = False  # reset
 
                 result.extend(ImageBlock.to_json(child))
             else:
@@ -194,7 +207,9 @@ class ParagraphBlock(EditorJSBlock):
 
         # final text after image:
         if current_text:
-            result.append({"data": {"text": current_text}, "type": "raw" if any_html else "paragraph"})
+            result.append(
+                raw_block(current_text) if any_html else paragraph_block(current_text)
+            )
 
         return result
 
@@ -430,7 +445,8 @@ class RawBlock(EditorJSBlock):
 
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
-        return data.get("html", "")
+        text = data.get("html", "")
+        return f"{text}\n\n"
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -499,7 +515,7 @@ class TableBlock(EditorJSBlock):
                 "data": {
                     "content": table,
                     "withHeadings": with_headings,
-                }
+                },
             }
         ]
 

{edwh_editorjs-2.0.1 → edwh_editorjs-2.1.0}/editorjs/core.py

@@ -31,13 +31,14 @@ class EditorJS:
         self._md = markdown2.Markdown(extras=extras)  # todo: striketrough, ?
 
     @classmethod
-    def from_json(cls, data: str | dict) -> Self:
+    def from_json(cls, data: str | dict | list) -> Self:
         """
         Load from EditorJS JSON Blocks
         """
-        data = data if isinstance(data, dict) else json.loads(data)
+        data = data if isinstance(data, (dict, list)) else json.loads(data)
+        blocks = data["blocks"] if isinstance(data, dict) else data
         markdown_items = []
-        for child in data["blocks"]:
+        for child in blocks:
             _type = child["type"]
             if not (block := BLOCKS.get(_type)):
                 raise TypeError(f"Unsupported block type `{_type}`")

{edwh_editorjs-2.0.1 → edwh_editorjs-2.1.0}/tests/test_core.py

@@ -114,12 +114,68 @@ def test_attachment():
 
 
 def test_raw_html():
+    # e = EditorJS.from_markdown(textwrap.dedent("""
+    # # Raw  HTML
+    #
+    # <marquee>This ain't no paragraph</marquee>
+    #
+    # This is a paragraph
+    # """))
+    #
+    # blocks = json.loads(e.to_json())
+    #
+    # print(blocks)
+    #
+    # assert blocks["blocks"][1]["type"] == "raw", blocks["blocks"][1]["type"]
+    # assert blocks["blocks"][2]["type"] == "paragraph", blocks["blocks"][2]["type"]
+    #
+
+    raw_html_json = r"""{"time":1730989152705,"blocks":[{"id":"DGQwRibbof","type":"paragraph","data":{"text":"The Start"}},{"id":"NrvWoJ2bVI","type":"raw","data":{"html":" <marquee>    <kaas>mannetje    </kaas>    </marquee>Einde!"}},{"id":"DGQwRibbof","type":"paragraph","data":{"text":"The End!"}}],"version":"2.30.6"}"""
+
+    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"]
+
+
+def test_code():
     e = EditorJS.from_markdown(textwrap.dedent("""
-    # Raw  HTML
+    Read code:
     
-    <marquee>This ain't no paragraph</marquee>
+    ```
+    <marquee> code </marquee>
+    ```
+    
+    End of code
     """))
 
     blocks = json.loads(e.to_json())
 
-    assert blocks["blocks"][1]["type"] == "raw", blocks["blocks"][1]["type"]
+    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"]
+
+    # check if it's still the same after export and import:
+
+    e = EditorJS.from_json(blocks)
+
+    blocks = json.loads(e.to_json())
+
+    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"]
+
+    # note: without `time` and `version` boilerplate:
+    blocks_json = r"""[{"id":"DD966BQf_t","type":"paragraph","data":{"text":"Pre"}},{"id":"sjr2JyuC1y","type":"code","data":{"code":"html"}},{"id":"aJN_wgBv7b","type":"paragraph","data":{"text":"Post"}}]"""
+
+    e = EditorJS.from_json(blocks_json)
+
+    blocks = json.loads(e.to_json())
+
+    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"]

edwh_editorjs-2.0.1/editorjs/__about__.py

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