mkdocs2confluence 0.7.8__tar.gz → 0.7.9__tar.gz

{mkdocs2confluence-0.7.8/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.7.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.7.8
+Version: 0.7.9
 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.7.8 → mkdocs2confluence-0.7.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.7.8"
+version = "0.7.9"
 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.7.8 → mkdocs2confluence-0.7.9/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.7.8
+Version: 0.7.9
 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.7.8 → mkdocs2confluence-0.7.9}/src/mkdocs_to_confluence/preprocess/icons.py

@@ -1,18 +1,16 @@
 """Icon shortcode preprocessing.
 
 Replaces MkDocs Material / FontAwesome / Octicons / Simple icon shortcodes
-(e.g. ``:material-check-circle:``) with the closest Unicode symbol equivalent,
+(e.g. ``:material-check-circle:``) with the closest Unicode emoji equivalent,
 or strips them silently when no mapping is found.
 
 Strategy: split the icon name on ``-`` and test each part against a small
 keyword→symbol table.  The first matching keyword wins.  This keeps the
 mapping set tiny and maintainable without requiring a full icon inventory.
 
-**BMP-only constraint**: all mapped symbols must lie in the Unicode Basic
-Multilingual Plane (U+0000–U+FFFF, ≤ 3-byte UTF-8).  Supplementary-plane
-emoji (U+10000+, 4-byte UTF-8) are not stored correctly by Confluence
-deployments that use MySQL ``utf8`` (not ``utf8mb4``) and render as ``???``.
-Where no good BMP symbol exists the shortcode is stripped silently (``""``).
+**Unicode range**: Confluence Cloud stores pages as UTF-8 with full Unicode
+support (utf8mb4), so supplementary-plane emoji (U+10000+) are safe.
+Symbols without a clear emoji equivalent are still stripped silently (``""``).
 """
 
 from __future__ import annotations
@@ -29,60 +27,57 @@ _ICON_RE = re.compile(
 # Must not overlap with _ICON_RE (those all contain a hyphenated prefix).
 _STANDARD_EMOJI_RE = re.compile(r":([a-z][a-z0-9_]*):")
 
-# Bare emoji shortcode → BMP Unicode symbol (or "" to strip silently).
-# BMP-only where a reasonable equivalent exists; supplementary-plane emoji
-# are excluded to preserve MySQL utf8 Confluence compatibility.
+# Bare emoji shortcode → Unicode symbol (or "" to strip silently).
 _STANDARD_EMOJI_MAP: dict[str, str] = {
     # Alerts / status
     "warning": "⚠",                # U+26A0
-    "rotating_light": "⚠",         # U+26A0  (🚨 U+1F6A8 is supplementary)
+    "rotating_light": "🚨",        # U+1F6A8
     "octagonal_sign": "⛔",         # U+26D4
     "no_entry": "⛔",               # U+26D4
     "no_entry_sign": "⛔",
     "stop_sign": "⛔",
     "information_source": "ℹ",     # U+2139
     # Checkmarks / marks
-    "white_check_mark": "✓",       # U+2713  (✅ supplementary)
+    "white_check_mark": "✓",       # U+2713
     "heavy_check_mark": "✓",       # U+2713
-    "x": "✗",                      # U+2717  (❌ supplementary)
+    "x": "✗",                      # U+2717
     "heavy_multiplication_x": "✗",
     # Objects — tools
-    "wrench": "⚙",                 # U+2699  (🔧 supplementary)
+    "wrench": "🔧",                 # U+1F527
     "gear": "⚙",                   # U+2699
-    "hammer": "",                   # 🔨 supplementary, no BMP equiv — strip
-    "hammer_and_wrench": "",
+    "hammer": "🔨",                 # U+1F528
+    "hammer_and_wrench": "🛠️",     # U+1F6E0
     # Work / business
-    "briefcase": "",                # 💼 supplementary — strip
+    "briefcase": "💼",              # U+1F4BC
     # Nature / miscellaneous
     "star": "★",                   # U+2605
     "star2": "★",
-    "rocket": "",                   # 🚀 supplementary — strip
-    "construction": "",             # 🚧 supplementary — strip
-    "tada": "",
-    "trophy": "",
-    "thinking": "",
-    "smile": "",
-    "laughing": "",
+    "rocket": "🚀",                 # U+1F680
+    "construction": "🚧",           # U+1F6A7
+    "tada": "🎉",                   # U+1F389
+    "trophy": "🏆",                 # U+1F3C6
+    "thinking": "🤔",               # U+1F914
+    "smile": "😄",                  # U+1F604
+    "laughing": "😆",               # U+1F606
     "heart": "♥",                  # U+2665
-    "fire": "",                     # 🔥 supplementary — strip
-    "zap": "",                      # ⚡ U+26A1 BMP
-    "bulb": "",
-    "computer": "",
-    "notebook": "",
-    "memo": "",
-    "clipboard": "",
-    "link": "",
-    "label": "",
-    "bookmark": "",
-    "chart_with_upwards_trend": "",
-    "bar_chart": "",
+    "fire": "🔥",                   # U+1F525
+    "zap": "⚡",                    # U+26A1
+    "bulb": "💡",                   # U+1F4A1
+    "computer": "💻",               # U+1F4BB
+    "notebook": "📓",               # U+1F4D3
+    "memo": "📝",                   # U+1F4DD
+    "clipboard": "📋",              # U+1F4CB
+    "link": "🔗",                   # U+1F517
+    "label": "🏷️",                 # U+1F3F7
+    "bookmark": "🔖",               # U+1F516
+    "chart_with_upwards_trend": "📈",  # U+1F4C8
+    "bar_chart": "📊",              # U+1F4CA
 }
 
 # Keyword → symbol.  Keys must be lowercase single words (icon name segments).
-# ALL values must be BMP characters (U+0000–U+FFFF) or "" (strip silently).
 # Ordered so earlier, more-specific entries take priority where ambiguous.
 _KEYWORD_MAP: dict[str, str | None] = {
-    # Status / validation  (all BMP ✓)
+    # Status / validation
     "check": "✓",       # U+2713
     "done": "✓",
     "complete": "✓",
@@ -103,98 +98,98 @@ _KEYWORD_MAP: dict[str, str | None] = {
     # Navigation / directional
     "arrow": None,          # resolved with next segment — see _resolve()
     "chevron": None,
-    # Security — no good BMP glyph; strip silently
-    "lock": "",
-    "security": "",
-    "shield": "",
-    "unlock": "",
-    "key": "",
+    # Security
+    "lock": "🔒",        # U+1F512
+    "security": "🛡️",   # U+1F6E0
+    "shield": "🛡️",
+    "unlock": "🔓",      # U+1F513
+    "key": "🔑",         # U+1F511
     # Actions
     "download": "↓",    # U+2193
     "upload": "↑",      # U+2191
-    "refresh": "↻",     # U+21BB  (BMP)
+    "refresh": "↻",     # U+21BB
     "sync": "↻",
     "reload": "↻",
-    "search": "",       # no reliable BMP magnifier glyph; strip
-    "magnify": "",
-    "edit": "✎",        # U+270E  (BMP pencil)
+    "search": "🔍",     # U+1F50D
+    "magnify": "🔍",
+    "edit": "✎",        # U+270E
     "pencil": "✎",
     "pen": "✎",
     "copy": "",         # strip
-    "clipboard": "",
-    "trash": "",        # strip
-    "delete": "",
+    "clipboard": "📋",  # U+1F4CB
+    "trash": "🗑️",     # U+1F5D1
+    "delete": "🗑️",
     "add": "+",
     "plus": "+",
-    "minus": "−",       # U+2212 minus sign
-    "link": "",         # strip — no reliable BMP link-chain glyph
-    "chain": "",
+    "minus": "−",       # U+2212
+    "link": "🔗",       # U+1F517
+    "chain": "🔗",
     # Objects / content
-    "star": "★",        # U+2605  (BMP)
+    "star": "★",        # U+2605
     "favorite": "★",
-    "bookmark": "",     # strip
-    "heart": "♥",       # U+2665  (BMP)
-    "fire": "",         # strip
-    "rocket": "",       # strip
-    "launch": "",
-    "home": "",         # strip — ⌂ U+2302 exists but renders poorly
-    "settings": "⚙",   # U+2699  (BMP)
+    "bookmark": "🔖",   # U+1F516
+    "heart": "♥",       # U+2665
+    "fire": "🔥",       # U+1F525
+    "rocket": "🚀",     # U+1F680
+    "launch": "🚀",
+    "home": "🏠",       # U+1F3E0
+    "settings": "⚙",   # U+2699
     "cog": "⚙",
     "gear": "⚙",
-    "wrench": "",       # strip
-    "email": "✉",       # U+2709  (BMP envelope)
+    "wrench": "🔧",     # U+1F527
+    "email": "✉",       # U+2709
     "mail": "✉",
     "envelope": "✉",
-    "phone": "☎",       # U+260E  (BMP telephone)
-    "clock": "",        # strip
-    "time": "",
-    "calendar": "",     # strip
-    "date": "",
-    "folder": "",       # strip
-    "file": "",
-    "document": "",
-    "code": "",         # strip
-    "terminal": "",
-    "database": "",     # strip
-    "cloud": "☁",       # U+2601  (BMP)
-    "globe": "",        # strip
-    "world": "",
-    "earth": "",
-    "chart": "",        # strip
-    "graph": "",
-    "book": "",         # strip
-    "docs": "",
-    "note": "",         # strip
-    "tag": "",          # strip
-    "label": "",
-    "flag": "",         # strip
+    "phone": "☎",       # U+260E
+    "clock": "⏰",      # U+23F0
+    "time": "⏰",
+    "calendar": "📅",   # U+1F4C5
+    "date": "📅",
+    "folder": "📁",     # U+1F4C1
+    "file": "📄",       # U+1F4C4
+    "document": "📄",
+    "code": "💻",       # U+1F4BB
+    "terminal": "💻",
+    "database": "🗄️",  # U+1F5C4
+    "cloud": "☁",       # U+2601
+    "globe": "🌍",      # U+1F30D
+    "world": "🌍",
+    "earth": "🌍",
+    "chart": "📊",      # U+1F4CA
+    "graph": "📊",
+    "book": "📖",       # U+1F4D6
+    "docs": "📖",
+    "note": "",         # strip — ambiguous; not the 📝 emoji
+    "tag": "🏷️",       # U+1F3F7
+    "label": "🏷️",
+    "flag": "🚩",       # U+1F6A9
     "eye": "",          # strip — was wrongly matching grid/view icons
-    "view": "",         # strip — semantically ambiguous (grid-view ≠ eye)
-    "grid": "",         # strip — layout/grid icons have no BMP analogue
-    "user": "",         # strip
-    "account": "",
-    "person": "",
-    "group": "",        # strip
-    "people": "",
-    "team": "",
-    "robot": "",        # strip
-    "bug": "",          # strip
+    "view": "",         # strip — semantically ambiguous
+    "grid": "",         # strip — layout/grid icons have no emoji analogue
+    "user": "👤",       # U+1F464
+    "account": "👤",
+    "person": "👤",
+    "group": "👥",      # U+1F465
+    "people": "👥",
+    "team": "👥",
+    "robot": "🤖",      # U+1F916
+    "bug": "🐛",        # U+1F41B
     "test": "",         # strip
-    "flask": "",
-    "lightbulb": "",    # strip
-    "idea": "",
-    "package": "",      # strip
-    "server": "",
+    "flask": "",        # strip
+    "lightbulb": "💡", # U+1F4A1
+    "idea": "💡",
+    "package": "📦",    # U+1F4E6
+    "server": "🖥️",    # U+1F5A5
     "network": "",      # strip
-    "wifi": "",
+    "wifi": "",         # strip
     "battery": "",      # strip
-    "image": "",        # strip
-    "video": "",
-    "music": "♪",       # U+266A  (BMP)
+    "image": "🖼️",     # U+1F5BC
+    "video": "🎥",      # U+1F3A5
+    "music": "♪",       # U+266A
     "printer": "",      # strip
-    "keyboard": "⌨",   # U+2328  (BMP)
+    "keyboard": "⌨",   # U+2328
     "mouse": "",        # strip
-    "monitor": "",      # strip
+    "monitor": "🖥️",
     # Modifier suffixes — never meaningful on their own; always strip
     "outline": "",
     "variant": "",

{mkdocs2confluence-0.7.8 → mkdocs2confluence-0.7.9}/tests/test_icons.py

@@ -1,8 +1,8 @@
 """Tests for preprocess.icons — icon shortcode stripping/mapping.
 
-All mapped symbols must be BMP characters (U+0000–U+FFFF, ≤ 3-byte UTF-8).
-Supplementary-plane emoji (U+10000+) render as ``???`` in Confluence
-deployments that use MySQL ``utf8`` rather than ``utf8mb4``.
+Confluence Cloud uses utf8mb4 and supports full Unicode including
+supplementary-plane emoji (U+10000+).  Shortcodes with no clear emoji
+equivalent are stripped silently.
 """
 
 from __future__ import annotations
@@ -29,23 +29,20 @@ class TestKnownMappings:
     def test_close_maps_to_cross(self) -> None:
         assert strip_icon_shortcodes(":material-close:") == "✗"
 
-    def test_lock_stripped(self) -> None:
-        # 🔒 is non-BMP (U+1F512); strip silently instead
-        assert strip_icon_shortcodes(":material-lock:") == ""
+    def test_lock_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-lock:") == "🔒"
 
-    def test_shield_stripped(self) -> None:
-        assert strip_icon_shortcodes(":material-shield:") == ""
+    def test_shield_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-shield:") == "🛡️"
 
-    def test_rocket_stripped(self) -> None:
-        # 🚀 is non-BMP (U+1F680); strip silently instead
-        assert strip_icon_shortcodes(":material-rocket-launch:") == ""
+    def test_rocket_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-rocket-launch:") == "🚀"
 
     def test_settings_maps_to_gear(self) -> None:
         assert strip_icon_shortcodes(":material-cog:") == "⚙"
 
-    def test_search_stripped(self) -> None:
-        # 🔍 is non-BMP (U+1F50D); strip silently instead
-        assert strip_icon_shortcodes(":material-magnify:") == ""
+    def test_search_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-magnify:") == "🔍"
 
     def test_refresh_maps_to_arrow(self) -> None:
         assert strip_icon_shortcodes(":material-refresh:") == "↻"
@@ -84,18 +81,17 @@ class TestArrowMappings:
 
 
 class TestBuggedIcons:
-    """Regression tests for icons that previously rendered as ??? in Confluence."""
+    """Regression tests for icons that should not produce wrong output."""
 
-    def test_link_variant_stripped(self) -> None:
-        # Was: 🔗 (U+1F517, non-BMP) → ??  in Confluence
-        assert strip_icon_shortcodes(":material-link-variant:") == ""
+    def test_link_variant_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-link-variant:") == "🔗"
 
     def test_grid_view_outline_stripped(self) -> None:
-        # Was: 👁️ (wrong semantic + non-BMP) → ??? in Confluence
+        # grid/view have no meaningful emoji analogue
         assert strip_icon_shortcodes(":material-grid-view-outline:") == ""
 
-    def test_link_stripped(self) -> None:
-        assert strip_icon_shortcodes(":material-link:") == ""
+    def test_link_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-link:") == "🔗"
 
     def test_view_stripped(self) -> None:
         assert strip_icon_shortcodes(":material-view-dashboard:") == ""
@@ -124,21 +120,26 @@ class TestUnknownIcons:
         assert strip_icon_shortcodes(":fontawesome-brands-github:") == ""
 
 
-class TestBmpSafety:
-    """All mapped values must be BMP-only (≤ U+FFFF, max 3-byte UTF-8)."""
+class TestEmojiMappings:
+    """Supplementary-plane emoji now map to real emoji (Cloud utf8mb4 support)."""
 
-    def test_all_mapped_values_are_bmp(self) -> None:
-        from mkdocs_to_confluence.preprocess.icons import _KEYWORD_MAP
+    def test_fire_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-fire:") == "🔥"
 
-        non_bmp = {
-            kw: val
-            for kw, val in _KEYWORD_MAP.items()
-            if val is not None and any(ord(c) > 0xFFFF for c in val)
-        }
-        assert non_bmp == {}, (
-            f"Non-BMP characters found in _KEYWORD_MAP (will render as ??? "
-            f"in Confluence MySQL utf8): {non_bmp}"
-        )
+    def test_lightbulb_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-lightbulb:") == "💡"
+
+    def test_bug_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-bug:") == "🐛"
+
+    def test_package_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-package:") == "📦"
+
+    def test_account_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-account:") == "👤"
+
+    def test_robot_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":material-robot:") == "🤖"
 
 
 class TestInlineReplacement:
@@ -162,14 +163,14 @@ class TestInlineReplacement:
 class TestStandardEmoji:
     """Tests for bare emoji shortcodes like :rotating_light:."""
 
-    def test_rotating_light_maps_to_warning(self) -> None:
-        assert strip_icon_shortcodes(":rotating_light:") == "⚠"
+    def test_rotating_light_maps_to_siren(self) -> None:
+        assert strip_icon_shortcodes(":rotating_light:") == "🚨"
 
     def test_octagonal_sign_maps_to_no_entry(self) -> None:
         assert strip_icon_shortcodes(":octagonal_sign:") == "⛔"
 
-    def test_wrench_maps_to_gear(self) -> None:
-        assert strip_icon_shortcodes(":wrench:") == "⚙"
+    def test_wrench_maps_to_wrench_emoji(self) -> None:
+        assert strip_icon_shortcodes(":wrench:") == "🔧"
 
     def test_information_source_maps_to_info(self) -> None:
         assert strip_icon_shortcodes(":information_source:") == "ℹ"
@@ -180,8 +181,8 @@ class TestStandardEmoji:
     def test_x_maps_to_cross(self) -> None:
         assert strip_icon_shortcodes(":x:") == "✗"
 
-    def test_briefcase_stripped(self) -> None:
-        assert strip_icon_shortcodes(":briefcase:") == ""
+    def test_briefcase_maps_to_emoji(self) -> None:
+        assert strip_icon_shortcodes(":briefcase:") == "💼"
 
     def test_unknown_shortcode_unchanged(self) -> None:
         assert strip_icon_shortcodes(":unknown_emoji_xyz:") == ":unknown_emoji_xyz:"
@@ -195,11 +196,7 @@ class TestStandardEmoji:
         result = strip_icon_shortcodes(":material-check-circle:")
         assert result == "✓"
 
-    def test_all_standard_emoji_values_are_bmp(self) -> None:
+    def test_all_standard_emoji_values_are_strings(self) -> None:
         from mkdocs_to_confluence.preprocess.icons import _STANDARD_EMOJI_MAP
         for name, symbol in _STANDARD_EMOJI_MAP.items():
-            for ch in symbol:
-                assert ord(ch) <= 0xFFFF, (
-                    f"_STANDARD_EMOJI_MAP[{name!r}] contains supplementary-plane "
-                    f"character U+{ord(ch):04X} — use BMP or empty string"
-                )
+            assert isinstance(symbol, str), f"_STANDARD_EMOJI_MAP[{name!r}] is not a string"