mkdocs2confluence 0.9.0__tar.gz → 0.9.2__tar.gz

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.9.0
+Version: 0.9.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.9.0 → mkdocs2confluence-0.9.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.9.0"
+version = "0.9.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" }
@@ -73,6 +73,7 @@ select = ["E", "F", "I"]
 
 [tool.mypy]
 strict = true
+extra_checks = true
 python_version = "3.12"
 
 [[tool.mypy.overrides]]

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/src/mkdocs2confluence.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.9.0
+Version: 0.9.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.9.0 → mkdocs2confluence-0.9.2}/src/mkdocs_to_confluence/cli.py

@@ -359,7 +359,7 @@ def _cmd_preview(args: argparse.Namespace) -> None:
             for node in pages:
                 html_name = page_link_map.get(node.title, f"{Path(node.docs_path or node.title).stem}.html")
                 try:
-                    xhtml, _a, _l, _s = compile_page(node, config, link_map, quiet=args.quiet)
+                    xhtml, _a, _l, _s, _vm = compile_page(node, config, link_map, quiet=args.quiet)
                 except PageLoadError as exc:
                     print(f"  warning: skipping '{node.title}': {exc}", file=sys.stderr)
                     continue
@@ -417,7 +417,7 @@ def _cmd_preview(args: argparse.Namespace) -> None:
 
         def _build_page() -> None:
             try:
-                xhtml, _a, _l, _s = compile_page(page_node, config, link_map, quiet=True)
+                xhtml, _a, _l, _s, _vm = compile_page(page_node, config, link_map, quiet=True)
             except PageLoadError as exc:
                 print(f"  warning: {exc}", file=sys.stderr)
                 return
@@ -441,7 +441,7 @@ def _cmd_preview(args: argparse.Namespace) -> None:
         return
 
     try:
-        xhtml, _attachments, _labels, _status = compile_page(page_node, config, link_map, quiet=args.quiet)
+        xhtml, _attachments, _labels, _status, _vm = compile_page(page_node, config, link_map, quiet=args.quiet)
     except PageLoadError as exc:
         print(f"error: {exc}", file=sys.stderr)
         sys.exit(1)
@@ -656,7 +656,7 @@ def _cmd_pdf(args: argparse.Namespace) -> None:
     chapters: list[tuple[str, str]] = []
     for node in pages:
         try:
-            xhtml, _a, _l, _s = compile_page(node, config, link_map, quiet=args.quiet)
+            xhtml, _a, _l, _s, _vm = compile_page(node, config, link_map, quiet=args.quiet)
         except PageLoadError as exc:
             print(f"  warning: skipping '{node.title}': {exc}", file=sys.stderr)
             continue

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/src/mkdocs_to_confluence/emitter/xhtml.py

@@ -251,19 +251,38 @@ def _emit_front_matter(node: FrontMatter) -> str:
     return "".join(parts)
 
 
+def _xml_safe(text: str) -> str:
+    """HTML-escape *text* and encode non-ASCII as XML numeric character references.
+
+    Confluence storage format is XML; raw non-ASCII bytes (e.g. UTF-8 encoded ·)
+    can be misinterpreted as Latin-1 by some Confluence versions, producing artefacts
+    like ``·``.  Encoding everything outside ASCII as ``&#NNN;`` entities is safe
+    for all Confluence deployments.
+    """
+    return html.escape(text).encode("ascii", "xmlcharrefreplace").decode()
+
+
 def _emit_source_footer(node: SourceFooter) -> str:
-    """Emit a 'Page source' panel macro with edit/history links and last-commit info."""
+    """Emit a borderless panel macro with edit/history links and last-commit info."""
     edit_href = html.escape(node.edit_url)
     links = f'<a href="{edit_href}">Edit this page</a>'
     if node.history_url:
         hist_href = html.escape(node.history_url)
-        links += f' \u00b7 <a href="{hist_href}">View history</a>'
+        links += f' &#xB7; <a href="{hist_href}">View history</a>'
     body = f"<p>{links}</p>\n"
-    if node.last_commit:
-        body += f"<p><em>Last commit: {html.escape(node.last_commit)}</em></p>\n"
+    if node.commit_sha or node.commit_summary:
+        if node.commit_sha and node.commit_url:
+            sha_href = html.escape(node.commit_url)
+            sha_part = f'<a href="{sha_href}">{html.escape(node.commit_sha)}</a>'
+        elif node.commit_sha:
+            sha_part = html.escape(node.commit_sha)
+        else:
+            sha_part = ""
+        summary_part = _xml_safe(node.commit_summary) if node.commit_summary else ""
+        detail = " &#xB7; ".join(p for p in [sha_part, summary_part] if p)
+        body += f"<p><strong>Last commit:</strong> {detail}</p>\n"
     return (
         '<ac:structured-macro ac:name="panel">\n'
-        '  <ac:parameter ac:name="title">Page source</ac:parameter>\n'
         '  <ac:parameter ac:name="borderStyle">solid</ac:parameter>\n'
         "  <ac:rich-text-body>\n"
         f"    {body}"

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/src/mkdocs_to_confluence/ir/nodes.py

@@ -435,17 +435,23 @@ class SourceFooter(IRNode):
     Emitted as a Confluence ``panel`` macro at the bottom of the page.
 
     Attributes:
-        edit_url:     URL to edit the source file (e.g. GitHub edit link).
-        history_url:  URL to the file's commit history.  ``None`` when it
-                      cannot be derived from ``edit_url``.
-        last_commit:  Human-readable last-commit summary from ``git log``,
-                      e.g. ``"abc1234 · Fix typo · Jane · 2 days ago"``.
-                      ``None`` when git is unavailable or the file is untracked.
+        edit_url:        URL to edit the source file (e.g. GitHub edit link).
+        history_url:     URL to the file's commit history.  ``None`` when it
+                         cannot be derived from ``edit_url``.
+        commit_sha:      Short commit hash (e.g. ``"abc1234"``).  ``None`` when
+                         git is unavailable or the file is untracked.
+        commit_url:      URL to the specific commit on the VCS host.  ``None``
+                         when the URL cannot be derived.
+        commit_summary:  Commit message, author, and relative date, e.g.
+                         ``"Fix typo · Jane · 2 days ago"``.  ``None`` when git
+                         is unavailable or the file is untracked.
     """
 
     edit_url: str
     history_url: str | None = None
-    last_commit: str | None = None
+    commit_sha: str | None = None
+    commit_url: str | None = None
+    commit_summary: str | None = None
 
 
 @dataclass(frozen=True)

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/src/mkdocs_to_confluence/publisher/client.py

@@ -255,6 +255,7 @@ class ConfluenceClient:
         version: int,
         *,
         parent_id: str | None = None,
+        version_message: str | None = None,
     ) -> dict[str, Any]:
         """Update an existing page to a new version and return the page dict.
 
@@ -273,7 +274,7 @@ class ConfluenceClient:
             },
             "version": {
                 "number": version,
-                "message": "Updated by mk2conf",
+                "message": version_message or "Published by mk2conf",
                 "minorEdit": True,
             },
         }

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/src/mkdocs_to_confluence/publisher/pipeline.py

@@ -24,7 +24,7 @@ from typing import TYPE_CHECKING, Literal
 import yaml
 
 from mkdocs_to_confluence.emitter.xhtml import emit
-from mkdocs_to_confluence.ir.nodes import FrontMatter
+from mkdocs_to_confluence.ir.nodes import FrontMatter, SourceFooter
 from mkdocs_to_confluence.loader.config import ConfluenceConfig, MkDocsConfig
 from mkdocs_to_confluence.loader.nav import NavNode
 from mkdocs_to_confluence.loader.page import PageLoadError, load_page
@@ -75,6 +75,7 @@ class PageAction:
     attachments: list[Path] = field(default_factory=list)
     labels: tuple[str, ...] = field(default_factory=tuple)
     confluence_status: str | None = None
+    version_message: str | None = None  # git commit message for Confluence version history
     is_folder: bool = False        # True when this action creates a Confluence folder
     parent_is_folder: bool = False  # True when the parent content is a folder
     # Set after execution:
@@ -139,7 +140,7 @@ def compile_page(
     link_map: dict[str, str] | None = None,
     *,
     quiet: bool = False,
-) -> tuple[str, list[Path], tuple[str, ...], str | None]:
+) -> tuple[str, list[Path], tuple[str, ...], str | None, str | None]:
     """Run the full compile pipeline for one page.
 
     Returns
@@ -148,7 +149,7 @@ def compile_page(
         ``(xhtml_string, attachment_paths, labels, confluence_status)``
     """
     if node.source_path is None:
-        return "", [], (), None
+        return "", [], (), None, None
 
     raw = load_page(node)
 
@@ -195,17 +196,19 @@ def compile_page(
         footer = build_source_footer(edit_url, abs_path)
         ir_nodes = ir_nodes + (footer,)
 
-    # Extract labels and confluence_status from FrontMatter node.
+    # Extract labels, confluence_status, and version_message from IR nodes.
     labels: tuple[str, ...] = ()
     confluence_status: str | None = None
+    version_message: str | None = None
     for node_item in ir_nodes:
         if isinstance(node_item, FrontMatter):
             labels = node_item.labels
             confluence_status = node_item.confluence_status
-            break
+        if isinstance(node_item, SourceFooter) and node_item.commit_sha and node_item.commit_summary:
+            version_message = f"{node_item.commit_sha}: {node_item.commit_summary}"
 
     xhtml = emit(ir_nodes)
-    return xhtml, attachments, labels, confluence_status
+    return xhtml, attachments, labels, confluence_status, version_message
 
 
 def _xhtml_hash(xhtml: str) -> str:
@@ -279,7 +282,7 @@ def _plan_nodes(
                     if not quiet:
                         print(f"  compiling  '{clean_title}'  (section index)")
                     try:
-                        xhtml, attachments, labels, confluence_status = compile_page(
+                        xhtml, attachments, labels, confluence_status, version_message = compile_page(
                             index_child, config, link_map, quiet=quiet
                         )
                         existing = client.find_page(space_id, clean_title)
@@ -312,6 +315,7 @@ def _plan_nodes(
                             attachments=attachments,
                             labels=labels,
                             confluence_status=confluence_status,
+                            version_message=version_message,
                             page_id=str(existing["id"]) if existing is not None else None,
                             version=(
                                 existing["version"]["number"] if existing is not None else None
@@ -379,7 +383,9 @@ def _plan_nodes(
             if not quiet:
                 print(f"  compiling  '{clean_title}'")
             try:
-                xhtml, attachments, labels, confluence_status = compile_page(node, config, link_map, quiet=quiet)
+                xhtml, attachments, labels, confluence_status, version_message = compile_page(
+                    node, config, link_map, quiet=quiet
+                )
             except (PageLoadError, OSError) as exc:
                 if not quiet:
                     print(f"  skipping   '{clean_title}'  (error: {exc})")
@@ -419,6 +425,7 @@ def _plan_nodes(
                 attachments=attachments,
                 labels=labels,
                 confluence_status=confluence_status,
+                version_message=version_message,
                 page_id=str(existing["id"]) if existing is not None else None,
                 version=(
                     existing["version"]["number"] if existing is not None else None
@@ -588,6 +595,7 @@ def _execute_page_action(
                 action.xhtml or "",
                 action.version + 1,
                 parent_id=action.parent_id,
+                version_message=action.version_message,
             )
             report.updated += 1
         except ConfluenceError as upd_exc:

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/src/mkdocs_to_confluence/transforms/footer.py

@@ -11,6 +11,9 @@ import subprocess
 
 from mkdocs_to_confluence.ir.nodes import SourceFooter
 
+# separator used in git --format to allow reliable splitting
+_GIT_SEP = "\x1f"  # ASCII unit separator — never appears in commit messages
+
 
 def _derive_history_url(edit_url: str) -> str | None:
     """Derive a commit-history URL from a VCS edit URL.
@@ -25,18 +28,34 @@ def _derive_history_url(edit_url: str) -> str | None:
     return None
 
 
-def _last_commit(abs_path: str) -> str | None:
-    """Return a human-readable last-commit summary for *abs_path*.
+def _derive_commit_url(edit_url: str, sha: str) -> str | None:
+    """Derive a direct commit URL from a VCS edit URL and a commit SHA.
 
-    Runs ``git log -1 --format=... --date=relative`` on the file.
+    Supports GitHub (``/edit/``) and GitLab (``/-/edit/``).
+    Returns ``None`` for any other URL shape.
+    """
+    if "/-/edit/" in edit_url:
+        base = edit_url.split("/-/edit/")[0]
+        return f"{base}/-/commit/{sha}"
+    if "/edit/" in edit_url:
+        base = edit_url.split("/edit/")[0]
+        return f"{base}/commit/{sha}"
+    return None
+
+
+def _last_commit_info(abs_path: str) -> tuple[str, str] | None:
+    """Return ``(short_sha, summary)`` for the last commit touching *abs_path*.
+
+    *summary* is ``"message · author · relative_date"``.
     Returns ``None`` when git is unavailable, the path is untracked, or the
     command fails for any reason.
     """
+    sep = _GIT_SEP
     try:
         result = subprocess.run(
             [
                 "git", "log", "-1",
-                "--format=%h \u00b7 %s \u00b7 %an \u00b7 %ad",
+                f"--format=%h{sep}%s{sep}%an{sep}%ad",
                 "--date=relative",
                 "--",
                 abs_path,
@@ -46,7 +65,13 @@ def _last_commit(abs_path: str) -> str | None:
             timeout=5,
         )
         output = result.stdout.strip()
-        return output if output else None
+        if not output:
+            return None
+        parts = output.split(sep, 3)
+        if len(parts) < 4:
+            return None
+        sha, message, author, date = parts
+        return sha, f"{message} \u00b7 {author} \u00b7 {date}"
     except Exception:  # noqa: BLE001
         return None
 
@@ -62,8 +87,19 @@ def build_source_footer(edit_url: str, abs_path: str) -> SourceFooter:
         Absolute filesystem path to the source Markdown file.  Used to
         query ``git log`` for the last-commit summary.
     """
+    commit_info = _last_commit_info(abs_path)
+    if commit_info is not None:
+        sha, summary = commit_info
+        commit_url = _derive_commit_url(edit_url, sha)
+    else:
+        sha = None
+        summary = None
+        commit_url = None
+
     return SourceFooter(
         edit_url=edit_url,
         history_url=_derive_history_url(edit_url),
-        last_commit=_last_commit(abs_path),
+        commit_sha=sha,
+        commit_url=commit_url,
+        commit_summary=summary,
     )

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/tests/test_cli.py

@@ -175,7 +175,7 @@ class TestQuietOutputBehavior:
         yml = _minimal_config(tmp_path)
         (tmp_path / "docs" / "index.md").write_text("# Home\n\nHello.", encoding="utf-8")
 
-        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], (), None))
+        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], (), None, None))
         with patch("mkdocs_to_confluence.cli.compile_page", mock_compile), \
              patch("sys.stdout.isatty", return_value=False):
             flags = ["--quiet"] if quiet else []
@@ -223,7 +223,7 @@ class TestWatchFlag:
         yml = _minimal_config(tmp_path)
         (tmp_path / "docs" / "index.md").write_text("# Home\n", encoding="utf-8")
 
-        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], (), None))
+        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], (), None, None))
         mock_render = MagicMock(return_value="<html>preview</html>")
 
         with patch("mkdocs_to_confluence.cli.compile_page", mock_compile), \

mkdocs2confluence-0.9.2/tests/test_footer.py

@@ -0,0 +1,217 @@
+"""Tests for transforms/footer.py and the SourceFooter emitter."""
+
+from __future__ import annotations
+
+from unittest.mock import patch
+
+from mkdocs_to_confluence.emitter.xhtml import emit
+from mkdocs_to_confluence.ir.nodes import SourceFooter
+from mkdocs_to_confluence.transforms.footer import (
+    _derive_commit_url,
+    _derive_history_url,
+    _last_commit_info,
+    build_source_footer,
+)
+
+# ── _derive_history_url ───────────────────────────────────────────────────────
+
+
+def test_derive_history_url_github():
+    url = "https://github.com/org/repo/edit/main/docs/guide/setup.md"
+    assert _derive_history_url(url) == "https://github.com/org/repo/commits/main/docs/guide/setup.md"
+
+
+def test_derive_history_url_gitlab():
+    url = "https://gitlab.com/org/repo/-/edit/main/docs/guide/setup.md"
+    assert _derive_history_url(url) == "https://gitlab.com/org/repo/-/commits/main/docs/guide/setup.md"
+
+
+def test_derive_history_url_unknown_returns_none():
+    url = "https://bitbucket.org/org/repo/src/main/docs/guide/setup.md"
+    assert _derive_history_url(url) is None
+
+
+def test_derive_history_url_empty_string():
+    assert _derive_history_url("") is None
+
+
+# ── _derive_commit_url ────────────────────────────────────────────────────────
+
+
+def test_derive_commit_url_github():
+    url = "https://github.com/org/repo/edit/main/docs/page.md"
+    assert _derive_commit_url(url, "abc1234") == "https://github.com/org/repo/commit/abc1234"
+
+
+def test_derive_commit_url_gitlab():
+    url = "https://gitlab.com/org/repo/-/edit/main/docs/page.md"
+    assert _derive_commit_url(url, "abc1234") == "https://gitlab.com/org/repo/-/commit/abc1234"
+
+
+def test_derive_commit_url_unknown_returns_none():
+    url = "https://bitbucket.org/org/repo/src/main/docs/page.md"
+    assert _derive_commit_url(url, "abc1234") is None
+
+
+# ── _last_commit_info ─────────────────────────────────────────────────────────
+
+
+def test_last_commit_info_returns_sha_and_summary(tmp_path):
+    fake_file = str(tmp_path / "docs" / "page.md")
+    sep = "\x1f"
+    with patch("mkdocs_to_confluence.transforms.footer.subprocess.run") as mock_run:
+        mock_run.return_value.stdout = f"abc1234{sep}Fix typo{sep}Jane{sep}2 days ago\n"
+        result = _last_commit_info(fake_file)
+    assert result is not None
+    sha, summary = result
+    assert sha == "abc1234"
+    assert "Fix typo" in summary
+    assert "Jane" in summary
+    assert "2 days ago" in summary
+
+
+def test_last_commit_info_returns_none_when_empty(tmp_path):
+    fake_file = str(tmp_path / "docs" / "untracked.md")
+    with patch("mkdocs_to_confluence.transforms.footer.subprocess.run") as mock_run:
+        mock_run.return_value.stdout = ""
+        result = _last_commit_info(fake_file)
+    assert result is None
+
+
+def test_last_commit_info_returns_none_on_exception(tmp_path):
+    fake_file = str(tmp_path / "docs" / "page.md")
+    with patch("mkdocs_to_confluence.transforms.footer.subprocess.run", side_effect=FileNotFoundError):
+        result = _last_commit_info(fake_file)
+    assert result is None
+
+
+# ── build_source_footer ───────────────────────────────────────────────────────
+
+
+def test_build_source_footer_full(tmp_path):
+    edit_url = "https://github.com/org/repo/edit/main/docs/guide.md"
+    abs_path = str(tmp_path / "docs" / "guide.md")
+    with patch("mkdocs_to_confluence.transforms.footer._last_commit_info",
+               return_value=("abc1234", "Fix typo · Jane · 1 day ago")):
+        footer = build_source_footer(edit_url, abs_path)
+    assert footer.edit_url == edit_url
+    assert footer.history_url == "https://github.com/org/repo/commits/main/docs/guide.md"
+    assert footer.commit_sha == "abc1234"
+    assert footer.commit_url == "https://github.com/org/repo/commit/abc1234"
+    assert footer.commit_summary == "Fix typo · Jane · 1 day ago"
+
+
+def test_build_source_footer_no_commit(tmp_path):
+    edit_url = "https://github.com/org/repo/edit/main/docs/guide.md"
+    abs_path = str(tmp_path / "docs" / "guide.md")
+    with patch("mkdocs_to_confluence.transforms.footer._last_commit_info", return_value=None):
+        footer = build_source_footer(edit_url, abs_path)
+    assert footer.commit_sha is None
+    assert footer.commit_url is None
+    assert footer.commit_summary is None
+    assert footer.history_url is not None
+
+
+# ── _emit_source_footer ───────────────────────────────────────────────────────
+
+
+def test_emit_footer_contains_edit_link():
+    footer = SourceFooter(
+        edit_url="https://github.com/org/repo/edit/main/docs/page.md",
+        history_url="https://github.com/org/repo/commits/main/docs/page.md",
+        commit_sha="abc1234",
+        commit_url="https://github.com/org/repo/commit/abc1234",
+        commit_summary="Fix typo · Jane · 2 days ago",
+    )
+    out = emit((footer,))
+    assert "Edit this page" in out
+    assert "View history" in out
+    assert "abc1234" in out
+    assert "Fix typo" in out
+    assert 'ac:name="panel"' in out
+
+
+def test_emit_footer_sha_is_hyperlink():
+    footer = SourceFooter(
+        edit_url="https://github.com/org/repo/edit/main/docs/page.md",
+        history_url=None,
+        commit_sha="abc1234",
+        commit_url="https://github.com/org/repo/commit/abc1234",
+        commit_summary="Fix typo · Jane · today",
+    )
+    out = emit((footer,))
+    assert 'href="https://github.com/org/repo/commit/abc1234"' in out
+    assert ">abc1234<" in out
+
+
+def test_emit_footer_last_commit_bold():
+    footer = SourceFooter(
+        edit_url="https://github.com/org/repo/edit/main/docs/page.md",
+        history_url=None,
+        commit_sha="abc1234",
+        commit_url="https://github.com/org/repo/commit/abc1234",
+        commit_summary="Fix typo · Jane · today",
+    )
+    out = emit((footer,))
+    assert "<strong>Last commit:</strong>" in out
+
+
+def test_emit_footer_no_panel_title():
+    footer = SourceFooter(
+        edit_url="https://github.com/org/repo/edit/main/docs/page.md",
+    )
+    out = emit((footer,))
+    assert 'ac:name="title"' not in out
+
+
+def test_emit_footer_no_history_url():
+    footer = SourceFooter(
+        edit_url="https://example.com/edit/docs/page.md",
+        history_url=None,
+        commit_sha=None,
+        commit_url=None,
+        commit_summary=None,
+    )
+    out = emit((footer,))
+    assert "Edit this page" in out
+    assert "View history" not in out
+    assert "Last commit" not in out
+
+
+def test_emit_footer_escapes_html():
+    footer = SourceFooter(
+        edit_url='https://example.com/edit/path?a=1&b=2',
+        history_url=None,
+        commit_sha=None,
+        commit_url=None,
+        commit_summary='<script>alert(1)</script> · Jane · today',
+    )
+    out = emit((footer,))
+    assert "<script>" not in out
+    assert "&lt;script&gt;" in out
+    assert "a=1&amp;b=2" in out
+
+
+def test_emit_footer_non_ascii_encoded_as_entity():
+    """Non-ASCII characters in commit_summary are encoded as XML numeric entities."""
+    footer = SourceFooter(
+        edit_url="https://github.com/org/repo/edit/main/docs/page.md",
+        history_url=None,
+        commit_sha=None,
+        commit_url=None,
+        commit_summary="Fix caf\u00e9 · \u00c5ngstr\u00f6m · 2 days ago",
+    )
+    out = emit((footer,))
+    assert "caf\u00e9" not in out
+    assert "&#233;" in out or "&#xe9;" in out.lower()
+
+
+def test_emit_footer_separator_is_entity():
+    """The · separator between Edit/View history links is an XML entity, not raw UTF-8."""
+    footer = SourceFooter(
+        edit_url="https://github.com/org/repo/edit/main/docs/page.md",
+        history_url="https://github.com/org/repo/commits/main/docs/page.md",
+    )
+    out = emit((footer,))
+    assert "&#xB7;" in out
+    assert "\u00b7" not in out

{mkdocs2confluence-0.9.0 → mkdocs2confluence-0.9.2}/tests/test_publish_pipeline.py

@@ -53,7 +53,7 @@ def test_compile_page_returns_xhtml(tmp_path: Path) -> None:
 
     node = _page_node("Index", md)
     config = _make_config(docs)
-    xhtml, attachments, labels, _ = compile_page(node, config)
+    xhtml, attachments, labels, _, _ = compile_page(node, config)
 
     assert "<h1>" in xhtml or "Hello" in xhtml
     assert attachments == []
@@ -68,7 +68,7 @@ def test_compile_page_with_ready_false_still_compiles(tmp_path: Path) -> None:
 
     node = _page_node("Draft", md)
     config = _make_config(docs)
-    xhtml, attachments, labels, _ = compile_page(node, config)
+    xhtml, attachments, labels, _, _ = compile_page(node, config)
     # Still compiles fine; plan_publish is the gatekeeper
     assert isinstance(xhtml, str)
 
@@ -78,7 +78,7 @@ def test_compile_page_with_source_path_none_returns_empty(tmp_path: Path) -> Non
     docs.mkdir()
     node = NavNode(title="Missing", docs_path="missing.md", source_path=None, level=0)
     config = _make_config(docs)
-    xhtml, attachments, labels, _ = compile_page(node, config)
+    xhtml, attachments, labels, _, _ = compile_page(node, config)
     assert xhtml == ""
     assert attachments == []
     assert labels == ()
@@ -179,7 +179,7 @@ def test_plan_publish_skips_when_content_unchanged(tmp_path: Path) -> None:
 
     # Compile once to get the real hash
     from mkdocs_to_confluence.publisher.pipeline import compile_page
-    xhtml, _, _, _ = compile_page(node, config)
+    xhtml, _, _, _, _ = compile_page(node, config)
     stored_hash = _xhtml_hash(xhtml)
 
     existing_page = {"id": "77", "version": {"number": 2}}
@@ -1672,7 +1672,7 @@ class TestExecutePublishHelpers:
 
         assert report.updated == 1
         client.update_page.assert_called_once_with(
-            "existing-9", "P", "<p/>", 4, parent_id="ROOT"
+            "existing-9", "P", "<p/>", 4, parent_id="ROOT", version_message=None
         )
         client.create_page.assert_not_called()
 
@@ -2036,7 +2036,7 @@ def test_compile_page_returns_confluence_status(tmp_path: Path) -> None:
 
     node = _page_node("My Page", md)
     config = _make_config(docs)
-    _, _, _, confluence_status = compile_page(node, config)
+    _, _, _, confluence_status, _ = compile_page(node, config)
 
     assert confluence_status == "in-progress"
 
@@ -2060,7 +2060,7 @@ def test_compile_page_returns_confluence_status_with_repo_url(tmp_path: Path) ->
         edit_uri="edit/main/docs/",
         nav=None,
     )
-    _, _, _, confluence_status = compile_page(node, config)
+    _, _, _, confluence_status, _ = compile_page(node, config)
 
     assert confluence_status == "in-progress"
 
@@ -2098,7 +2098,7 @@ def test_plan_publish_sets_confluence_status_on_skip(tmp_path: Path) -> None:
     config = _make_config(docs)
     conf_config = _make_conf_config()
 
-    xhtml, _, _, _ = compile_page(node, config)
+    xhtml, _, _, _, _ = compile_page(node, config)
     stored_hash = _xhtml_hash(xhtml)
 
     existing_page = {"id": "77", "version": {"number": 2}}

mkdocs2confluence-0.9.0/tests/test_footer.py

@@ -1,119 +0,0 @@
-"""Tests for transforms/footer.py and the SourceFooter emitter."""
-
-from __future__ import annotations
-
-from unittest.mock import patch
-
-from mkdocs_to_confluence.emitter.xhtml import emit
-from mkdocs_to_confluence.ir.nodes import SourceFooter
-from mkdocs_to_confluence.transforms.footer import _derive_history_url, _last_commit, build_source_footer
-
-# ── _derive_history_url ───────────────────────────────────────────────────────
-
-
-def test_derive_history_url_github():
-    url = "https://github.com/org/repo/edit/main/docs/guide/setup.md"
-    assert _derive_history_url(url) == "https://github.com/org/repo/commits/main/docs/guide/setup.md"
-
-
-def test_derive_history_url_gitlab():
-    url = "https://gitlab.com/org/repo/-/edit/main/docs/guide/setup.md"
-    assert _derive_history_url(url) == "https://gitlab.com/org/repo/-/commits/main/docs/guide/setup.md"
-
-
-def test_derive_history_url_unknown_returns_none():
-    url = "https://bitbucket.org/org/repo/src/main/docs/guide/setup.md"
-    assert _derive_history_url(url) is None
-
-
-def test_derive_history_url_empty_string():
-    assert _derive_history_url("") is None
-
-
-# ── _last_commit ──────────────────────────────────────────────────────────────
-
-
-def test_last_commit_returns_output(tmp_path):
-    fake_file = str(tmp_path / "docs" / "page.md")
-    with patch("mkdocs_to_confluence.transforms.footer.subprocess.run") as mock_run:
-        mock_run.return_value.stdout = "abc1234 · Fix typo · Jane · 2 days ago\n"
-        result = _last_commit(fake_file)
-    assert result == "abc1234 · Fix typo · Jane · 2 days ago"
-
-
-def test_last_commit_returns_none_when_empty(tmp_path):
-    fake_file = str(tmp_path / "docs" / "untracked.md")
-    with patch("mkdocs_to_confluence.transforms.footer.subprocess.run") as mock_run:
-        mock_run.return_value.stdout = ""
-        result = _last_commit(fake_file)
-    assert result is None
-
-
-def test_last_commit_returns_none_on_exception(tmp_path):
-    fake_file = str(tmp_path / "docs" / "page.md")
-    with patch("mkdocs_to_confluence.transforms.footer.subprocess.run", side_effect=FileNotFoundError):
-        result = _last_commit(fake_file)
-    assert result is None
-
-
-# ── build_source_footer ───────────────────────────────────────────────────────
-
-
-def test_build_source_footer_full(tmp_path):
-    edit_url = "https://github.com/org/repo/edit/main/docs/guide.md"
-    abs_path = str(tmp_path / "docs" / "guide.md")
-    with patch("mkdocs_to_confluence.transforms.footer._last_commit", return_value="abc · msg · Jane · 1 day ago"):
-        footer = build_source_footer(edit_url, abs_path)
-    assert footer.edit_url == edit_url
-    assert footer.history_url == "https://github.com/org/repo/commits/main/docs/guide.md"
-    assert footer.last_commit == "abc · msg · Jane · 1 day ago"
-
-
-def test_build_source_footer_no_commit(tmp_path):
-    edit_url = "https://github.com/org/repo/edit/main/docs/guide.md"
-    abs_path = str(tmp_path / "docs" / "guide.md")
-    with patch("mkdocs_to_confluence.transforms.footer._last_commit", return_value=None):
-        footer = build_source_footer(edit_url, abs_path)
-    assert footer.last_commit is None
-    assert footer.history_url is not None
-
-
-# ── _emit_source_footer ───────────────────────────────────────────────────────
-
-
-def test_emit_footer_contains_edit_link():
-    footer = SourceFooter(
-        edit_url="https://github.com/org/repo/edit/main/docs/page.md",
-        history_url="https://github.com/org/repo/commits/main/docs/page.md",
-        last_commit="abc1234 · Fix typo · Jane · 2 days ago",
-    )
-    out = emit((footer,))
-    assert "Edit this page" in out
-    assert "View history" in out
-    assert "abc1234" in out
-    assert "Fix typo" in out
-    assert 'ac:name="panel"' in out
-
-
-def test_emit_footer_no_history_url():
-    footer = SourceFooter(
-        edit_url="https://example.com/edit/docs/page.md",
-        history_url=None,
-        last_commit=None,
-    )
-    out = emit((footer,))
-    assert "Edit this page" in out
-    assert "View history" not in out
-    assert "Last commit" not in out
-
-
-def test_emit_footer_escapes_html():
-    footer = SourceFooter(
-        edit_url='https://example.com/edit/path?a=1&b=2',
-        history_url=None,
-        last_commit='abc · <script>alert(1)</script> · Jane · today',
-    )
-    out = emit((footer,))
-    assert "<script>" not in out
-    assert "&lt;script&gt;" in out
-    assert "a=1&amp;b=2" in out