mkdocs2confluence 0.17.1__tar.gz → 0.17.2__tar.gz

{mkdocs2confluence-0.17.1/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.17.1
+Version: 0.17.2
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later

{mkdocs2confluence-0.17.1 → mkdocs2confluence-0.17.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.17.1"
+version = "0.17.2"
 description = "Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more"
 readme = "README.md"
 license = { text = "GPL-3.0-or-later" }

{mkdocs2confluence-0.17.1 → mkdocs2confluence-0.17.2/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.17.1
+Version: 0.17.2
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later

{mkdocs2confluence-0.17.1 → mkdocs2confluence-0.17.2}/src/mkdocs_to_confluence/transforms/plantuml.py

@@ -1,8 +1,13 @@
 """PlantUML diagram rendering transform.
 
-Walks the IR tree, finds :class:`PlantUMLDiagram` nodes, renders each to PNG
+Walks the IR tree, finds :class:`PlantUMLDiagram` nodes, renders each to SVG
 via the Kroki rendering service, caches results locally, and returns updated
-nodes with ``attachment_name`` set plus a list of PNG paths to upload.
+nodes with ``attachment_name`` set plus a list of SVG paths to upload.
+
+SVG (vector) output is used rather than PNG because PlantUML caps raster output
+at ``PLANTUML_LIMIT_SIZE`` pixels (default 4096) per dimension, which causes
+large diagrams to fail rendering.  SVG is not subject to that limit, scales
+crisply, and is supported by Confluence attachments.
 
 The cache lives at ``~/.cache/mk2conf/plantuml/`` and is keyed by the SHA-256
 of the PlantUML source so unchanged diagrams are never re-fetched.
@@ -25,7 +30,6 @@ from typing import cast
 from mkdocs_to_confluence.ir.nodes import IRNode, PlantUMLDiagram
 from mkdocs_to_confluence.transforms._kroki import (
     _CACHE_LOCK,
-    _MIN_PNG_BYTES,
     _RETRY_ATTEMPTS,
     _RETRY_BACKOFF,
     _RETRYABLE_HTTP,
@@ -37,16 +41,16 @@ from mkdocs_to_confluence.transforms._kroki import (
 _CACHE_DIR = Path.home() / ".cache" / "mk2conf" / "plantuml"
 
 
-def _kroki_png(source: str, kroki_url: str) -> bytes:
-    """Fetch a PNG rendering of *source* from the Kroki service (POST)."""
-    url = f"{kroki_url.rstrip('/')}/plantuml/png"
+def _kroki_svg(source: str, kroki_url: str) -> bytes:
+    """Fetch an SVG rendering of *source* from the Kroki service (POST)."""
+    url = f"{kroki_url.rstrip('/')}/plantuml/svg"
     body = source.encode("utf-8")
     req = urllib.request.Request(
         url,
         data=body,
         headers={
             "Content-Type": "text/plain",
-            "Accept": "image/png",
+            "Accept": "image/svg+xml",
             "User-Agent": "mk2conf/1.0",
         },
         method="POST",
@@ -55,9 +59,15 @@ def _kroki_png(source: str, kroki_url: str) -> bytes:
         return cast(bytes, resp.read())
 
 
+def _looks_like_svg(data: bytes) -> bool:
+    """Heuristic: does *data* look like a valid SVG document?"""
+    head = data[:512].lstrip()
+    return head.startswith(b"<?xml") or head.startswith(b"<svg") or b"<svg" in head
+
+
 def _cache_path(source: str) -> Path:
     digest = hashlib.sha256(source.encode()).hexdigest()
-    return _CACHE_DIR / f"plantuml_{digest}.png"
+    return _CACHE_DIR / f"plantuml_{digest}.svg"
 
 
 def _warn(msg: str) -> None:
@@ -87,11 +97,11 @@ def _render_one(source: str, kroki_url: str, *, quiet: bool = False) -> Path | N
         try:
             if not quiet:
                 print(f"        rendering  plantuml diagram via Kroki ({kroki_url})")
-            png = _kroki_png(source, kroki_url)
-            if len(png) < _MIN_PNG_BYTES:
-                raise ValueError(f"Kroki returned {len(png)} bytes (expected a valid PNG)")
+            svg = _kroki_svg(source, kroki_url)
+            if not _looks_like_svg(svg):
+                raise ValueError(f"Kroki returned {len(svg)} bytes (expected a valid SVG)")
             with _CACHE_LOCK:
-                path.write_bytes(png)
+                path.write_bytes(svg)
             return path
         except urllib.error.HTTPError as exc:
             if exc.code in _RETRYABLE_HTTP:
@@ -116,11 +126,11 @@ def render_plantuml_diagrams(
     *,
     quiet: bool = False,
 ) -> tuple[tuple[IRNode, ...], list[Path]]:
-    """Render all :class:`PlantUMLDiagram` nodes to PNG via Kroki.
+    """Render all :class:`PlantUMLDiagram` nodes to SVG via Kroki.
 
     Diagrams are rendered concurrently (up to ``_MAX_WORKERS`` threads).
     Returns the updated IR node tuple (with ``attachment_name`` set on each
-    successfully rendered diagram) and a list of PNG :class:`Path` objects to
+    successfully rendered diagram) and a list of SVG :class:`Path` objects to
     upload as page attachments.
 
     Diagrams that fail to render are left unchanged (code-block fallback).

{mkdocs2confluence-0.17.1 → mkdocs2confluence-0.17.2}/tests/test_plantuml.py

@@ -12,7 +12,7 @@ from mkdocs_to_confluence.transforms.plantuml import (
 )
 
 _SAMPLE_SOURCE = "@startuml\nAlice -> Bob: Hello\n@enduml\n"
-_FAKE_PNG = b"\x89PNG\r\n\x1a\n" + b"\x00" * 100  # fake PNG > _MIN_PNG_BYTES (67)
+_FAKE_SVG = b'<?xml version="1.0"?><svg xmlns="http://www.w3.org/2000/svg"></svg>'
 
 
 # ── Parser ────────────────────────────────────────────────────────────────────
@@ -60,10 +60,10 @@ def test_emit_plantuml_fallback_code_block():
 
 def test_emit_plantuml_attachment_image():
     """With attachment_name set the emitter produces an ac:image."""
-    node = PlantUMLDiagram(source=_SAMPLE_SOURCE, attachment_name="plantuml_abc123.png")
+    node = PlantUMLDiagram(source=_SAMPLE_SOURCE, attachment_name="plantuml_abc123.svg")
     result = emit((node,))
     assert '<ac:image ac:align="center">' in result
-    assert 'ri:filename="plantuml_abc123.png"' in result
+    assert 'ri:filename="plantuml_abc123.svg"' in result
     assert "code" not in result
 
 
@@ -76,7 +76,7 @@ def test_render_uses_cache_on_second_call(tmp_path):
 
     with (
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
-        patch("mkdocs_to_confluence.transforms.plantuml._kroki_png", return_value=_FAKE_PNG) as mock_fetch,
+        patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg", return_value=_FAKE_SVG) as mock_fetch,
     ):
         render_plantuml_diagrams((node,))
         render_plantuml_diagrams((node,))
@@ -89,12 +89,12 @@ def test_render_sets_attachment_name(tmp_path):
 
     with (
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
-        patch("mkdocs_to_confluence.transforms.plantuml._kroki_png", return_value=_FAKE_PNG),
+        patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg", return_value=_FAKE_SVG),
     ):
         updated_nodes, attachments = render_plantuml_diagrams((node,))
 
     assert len(attachments) == 1
-    assert attachments[0].suffix == ".png"
+    assert attachments[0].suffix == ".svg"
     rendered = updated_nodes[0]
     assert isinstance(rendered, PlantUMLDiagram)
     assert rendered.attachment_name == attachments[0].name
@@ -107,7 +107,7 @@ def test_render_deduplicates_identical_diagrams(tmp_path):
 
     with (
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
-        patch("mkdocs_to_confluence.transforms.plantuml._kroki_png", return_value=_FAKE_PNG),
+        patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg", return_value=_FAKE_SVG),
     ):
         _, attachments = render_plantuml_diagrams((node_a, node_b))
 
@@ -124,7 +124,7 @@ def test_render_fallback_on_network_error(tmp_path, capsys):
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
         patch("mkdocs_to_confluence.transforms.plantuml.time.sleep"),
         patch(
-            "mkdocs_to_confluence.transforms.plantuml._kroki_png",
+            "mkdocs_to_confluence.transforms.plantuml._kroki_svg",
             side_effect=urllib.error.URLError("timed out"),
         ),
     ):
@@ -146,7 +146,7 @@ def test_render_fallback_on_http_error(tmp_path, capsys):
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
         patch("mkdocs_to_confluence.transforms.plantuml.time.sleep"),
         patch(
-            "mkdocs_to_confluence.transforms.plantuml._kroki_png",
+            "mkdocs_to_confluence.transforms.plantuml._kroki_svg",
             side_effect=urllib.error.HTTPError(
                 url=None, code=503, msg="Service Unavailable", hdrs=None, fp=None  # type: ignore[arg-type]
             ),
@@ -167,7 +167,7 @@ def test_render_fallback_on_empty_response(tmp_path, capsys):
     with (
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
         patch(
-            "mkdocs_to_confluence.transforms.plantuml._kroki_png",
+            "mkdocs_to_confluence.transforms.plantuml._kroki_svg",
             return_value=b"",
         ),
     ):
@@ -186,11 +186,11 @@ def test_render_uses_custom_kroki_url(tmp_path):
 
     def fake_fetch(source: str, kroki_url: str) -> bytes:
         captured.append(kroki_url)
-        return _FAKE_PNG
+        return _FAKE_SVG
 
     with (
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
-        patch("mkdocs_to_confluence.transforms.plantuml._kroki_png", side_effect=fake_fetch),
+        patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg", side_effect=fake_fetch),
     ):
         render_plantuml_diagrams((node,), kroki_url="https://internal.kroki")
 
@@ -201,7 +201,7 @@ def test_render_plantuml_none_skips(tmp_path):
     """Nodes with attachment_name already set are left untouched."""
     node = PlantUMLDiagram(source=_SAMPLE_SOURCE, attachment_name="already_set.png")
 
-    with patch("mkdocs_to_confluence.transforms.plantuml._kroki_png") as mock_fetch:
+    with patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg") as mock_fetch:
         updated_nodes, attachments = render_plantuml_diagrams((node,))
 
     mock_fetch.assert_not_called()
@@ -215,7 +215,7 @@ def test_render_multiple_diagrams_concurrently(tmp_path):
     nodes = tuple(PlantUMLDiagram(source=s) for s in sources)
 
     with patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path), \
-         patch("mkdocs_to_confluence.transforms.plantuml._kroki_png", return_value=_FAKE_PNG):
+         patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg", return_value=_FAKE_SVG):
         updated, attachments = render_plantuml_diagrams(nodes)
 
     assert len(attachments) == 4
@@ -230,7 +230,7 @@ def test_render_retries_on_503_then_succeeds(tmp_path):
 
     from mkdocs_to_confluence.transforms.plantuml import _render_one
 
-    calls = [urllib.error.HTTPError("url", 503, "Service Unavailable", {}, None), _FAKE_PNG]
+    calls = [urllib.error.HTTPError("url", 503, "Service Unavailable", {}, None), _FAKE_SVG]
 
     def fake_kroki(source: str, url: str) -> bytes:
         result = calls.pop(0)
@@ -240,7 +240,7 @@ def test_render_retries_on_503_then_succeeds(tmp_path):
 
     with patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path), \
          patch("mkdocs_to_confluence.transforms.plantuml.time.sleep") as mock_sleep, \
-         patch("mkdocs_to_confluence.transforms.plantuml._kroki_png", side_effect=fake_kroki):
+         patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg", side_effect=fake_kroki):
         result = _render_one(_SAMPLE_SOURCE, "https://kroki.io")
 
     assert result is not None
@@ -256,7 +256,7 @@ def test_render_no_mermaid_ink_fallback(tmp_path):
 
     with patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path), \
          patch("mkdocs_to_confluence.transforms.plantuml.time.sleep"), \
-         patch("mkdocs_to_confluence.transforms.plantuml._kroki_png",
+         patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg",
                side_effect=urllib.error.HTTPError("url", 504, "Gateway Timeout", {}, None)):
         result = _render_one(_SAMPLE_SOURCE, "https://kroki.io")
 
@@ -269,7 +269,7 @@ def test_render_quiet_suppresses_stdout(tmp_path, capsys):
 
     with (
         patch("mkdocs_to_confluence.transforms.plantuml._CACHE_DIR", tmp_path),
-        patch("mkdocs_to_confluence.transforms.plantuml._kroki_png", return_value=_FAKE_PNG),
+        patch("mkdocs_to_confluence.transforms.plantuml._kroki_svg", return_value=_FAKE_SVG),
     ):
         render_plantuml_diagrams((node,), quiet=True)