markdown-to-confluence 0.4.4__py3-none-any.whl → 0.4.6__py3-none-any.whl

md2conf/scanner.py

@@ -15,6 +15,8 @@ import yaml
 from strong_typing.core import JsonType
 from strong_typing.serialization import DeserializerOptions, json_to_object
 
+from .mermaid import MermaidConfigProperties
+
 T = TypeVar("T")
 
 
@@ -155,3 +157,47 @@ class Scanner:
             properties=properties,
             text=text,
         )
+
+
+@dataclass
+class MermaidProperties:
+    """
+    An object that holds the front-matter properties structure for Mermaid diagrams.
+
+    :param title: The title of the diagram.
+    :param config: Configuration options for rendering.
+    """
+
+    title: Optional[str] = None
+    config: Optional[MermaidConfigProperties] = None
+
+
+class MermaidScanner:
+    """
+    Extracts properties from the JSON/YAML front-matter of a Mermaid diagram.
+    """
+
+    def read(self, content: str) -> MermaidProperties:
+        """
+        Extracts rendering preferences from a Mermaid front-matter content.
+
+        ```
+        ---
+        title: Tiny flow diagram
+        config:
+            scale: 1
+        ---
+        flowchart LR
+            A[Component A] --> B[Component B]
+            B --> C[Component C]
+        ```
+        """
+
+        properties, text = extract_frontmatter_properties(content)
+        if properties is not None:
+            front_matter = _json_to_object(MermaidProperties, properties)
+            config = front_matter.config or MermaidConfigProperties()
+
+            return MermaidProperties(title=front_matter.title, config=config)
+
+        return MermaidProperties()

md2conf/text.py

@@ -0,0 +1,54 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
+
+def wrap_text(text: str, line_length: int = 160) -> str:
+    """
+    Wraps text by replacing individual whitespace characters with a linefeed such that lines in the output honor the specified line length.
+
+    :param text: Input text, optionally with existing UNIX line endings.
+    :param line_length: Desired line length.
+    :returns: Wrapped output text. Long words that exceed the specified line length are not broken.
+    """
+
+    if line_length < 1:
+        raise ValueError("expected: line_length > 0")
+
+    input = text.encode("utf-8")
+    output = bytearray(len(input))
+    pos = 0
+    length = len(input)
+
+    while pos < length:
+        end = min(pos + line_length, length)
+
+        # find any linefeed already in input
+        left = pos
+        while left < end and input[left] != 0x0A:
+            left += 1
+        if left != end:
+            output[pos : left + 1] = input[pos : left + 1]
+            pos = left + 1  # include linefeed
+            continue
+
+        # find the nearest whitespace before end of line
+        right = end
+        while right > pos and input[right - 1] not in b"\t\v\f\r ":
+            right -= 1
+
+        if right == pos or end == length:
+            # no whitespace found or at end of input; copy the rest
+            output[pos:end] = input[pos:end]
+            pos = end
+        else:
+            # replace the whitespace with a newline
+            output[pos : right - 1] = input[pos : right - 1]
+            output[right - 1] = 0x0A  # linefeed '\n'
+            pos = right  # skip the whitespace (already replaced)
+
+    return output.decode("utf-8")

md2conf/xml.py

@@ -87,6 +87,8 @@ def is_xml_equal(
     """
     Compare two XML documents for equivalence, ignoring leading/trailing whitespace differences and attribute definition order.
 
+    Elements may be excluded, in which case they compare equal to any element of the same type that has the same tail text.
+
     :param tree1: XML document as an element tree.
     :param tree2: XML document as an element tree.
     :param skip_attributes: Attributes to exclude, in `{namespace}name` notation.
@@ -101,3 +103,38 @@ def element_to_text(node: ET._Element) -> str:
     "Returns all text contained in an element as a concatenated string."
 
     return "".join(node.itertext()).strip()
+
+
+def unwrap_substitute(name: str, root: ET._Element) -> None:
+    """
+    Substitutes all occurrences of an element with its contents.
+
+    :param name: Element tag name to find and replace.
+    :param root: Top-most element at which to start.
+    """
+
+    for node in root.iterdescendants(name):
+        if node.text:
+            # append first piece of text in this element at the end of previous sibling, or text contained by parent
+            if (prev_node := node.getprevious()) is not None:
+                prev_node.tail = (prev_node.tail or "") + node.text
+            elif (parent_node := node.getparent()) is not None:  # always true except for root
+                parent_node.text = (parent_node.text or "") + node.text
+            else:
+                raise NotImplementedError("must always have a previous sibling or a parent")
+        if node.tail:
+            if len(node) > 0:
+                # append text immediately following the closing tag of this element to the last child element of this element
+                last_node = node[-1]
+                last_node.tail = (last_node.tail or "") + node.tail
+            else:  # node has no child elements, only text
+                if (prev_node := node.getprevious()) is not None:
+                    prev_node.tail = (prev_node.tail or "") + node.tail
+                elif (parent_node := node.getparent()) is not None:  # always true except for root
+                    parent_node.text = (parent_node.text or "") + node.tail
+                else:
+                    raise NotImplementedError("must always have a previous sibling or a parent")
+        for child in node.iterchildren(reversed=True):
+            node.addnext(child)
+        if (parent_node := node.getparent()) is not None:  # always true except for root
+            parent_node.remove(node)

markdown_to_confluence-0.4.4.dist-info/RECORD

@@ -1,31 +0,0 @@
-markdown_to_confluence-0.4.4.dist-info/licenses/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
-md2conf/__init__.py,sha256=nfPrvkkECt_Szpol9kTkli5cL-tFqFzn8JefKlCyb3s,402
-md2conf/__main__.py,sha256=RImfFrO2m9C5iebmBrHKlLjosy_A8AY4O7PK9CmiWSw,11120
-md2conf/api.py,sha256=-UrtFi3pFOVMsYj7VTgCqHIBinHsSLUucmGSeureEaE,37253
-md2conf/application.py,sha256=MBV4Lg6s40Q0Z4SK7W9cSo-k2A-ckmu8wosuwo_2XWM,8301
-md2conf/collection.py,sha256=EobgMRJgkYloWlY03NZJ52MRC_SGLpTVCHkltDbQyt0,837
-md2conf/converter.py,sha256=WNfxGEacibINQYCZXszaMoUvJIP4Rq8IDMjz5RSH0IY,51162
-md2conf/csf.py,sha256=tEbl3e5UQmbRSQK3lQqmpADoy638tlJihutqJoWhumA,4374
-md2conf/domain.py,sha256=tA9V0vb5Vo9Nt0eQvwAFARaM9TX88LBVQ73nVvdcaqA,1851
-md2conf/drawio.py,sha256=P_t7Wp7Tg9XkZM2ZchWCWWEdBaU1KgZ_YX9ZlkZo4Dk,8293
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/extra.py,sha256=VuMxuOnnC2Qwy6y52ukIxsaYhrZArRqMmRHRE4QZl8g,687
-md2conf/local.py,sha256=mUe2QBHhdZesygmYq5kXyGyl_ZmfUECgxDxylQwTa7g,3732
-md2conf/markdown.py,sha256=z9sVTA_Hcn551DZgdO7Nbod-IZ-43B4eJLklrYQ2KYI,3141
-md2conf/matcher.py,sha256=m5rZjYZSjhKfdeKS8JdPq7cG861Mc6rVZBkrIOZTHGE,6916
-md2conf/mermaid.py,sha256=f0x7ISj-41ZMh4zTAFPhIWwr94SDcsVZUc1NWqmH_G4,2508
-md2conf/metadata.py,sha256=LzZM-oPNnzCULmLhF516tPlV5zZBknccwMHt8Nan-xg,1007
-md2conf/processor.py,sha256=z2d2KMPEYWaxflOtH2UTwrjzpPU8TtLSEUvor85ez1Q,9732
-md2conf/properties.py,sha256=RC1jY_TKVbOv2bJxXn27Fj4fNWzyoNUQt6ltgUyVQAQ,3987
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-md2conf/scanner.py,sha256=Cyvjab8tBvKgubttQvNagS8nailuTvFBqUGoiX5MNp8,5351
-md2conf/toc.py,sha256=hpqqDbFgNJg5-ul8qWjOglI3Am0sbwR-TLwGN5G9Qo0,2447
-md2conf/uri.py,sha256=KbLBdRFtZTQTZd8b4j0LtE8Pb68Ly0WkemF4iW-EAB4,1158
-md2conf/xml.py,sha256=ERkGLuJgVFrOkzsMLd1RHU5SGFfFSxxNFZAeKrfdtRs,3454
-markdown_to_confluence-0.4.4.dist-info/METADATA,sha256=Ql8vwKX6wtZNtUVoT0z35HgiFQcW-fFWsWFUMLkNErw,32306
-markdown_to_confluence-0.4.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-markdown_to_confluence-0.4.4.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.4.4.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.4.4.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.4.4.dist-info/RECORD,,