roborean-documents-markdown 0.1.2__tar.gz

roborean_documents_markdown-0.1.2/.gitignore

@@ -0,0 +1,27 @@
+venv/
+venv-qt5/
+venv-qt6/
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/
+*.tsbuildinfo
+node_modules/
+.pnpm-store/
+.DS_Store
+.idea/
+.vscode/*.local
+playground/
+.e2e-ai/
+**/test-results/
+**/playwright-report/
+research/
+.roborean/
+.roborean-sql-artifacts/
+*.db

roborean_documents_markdown-0.1.2/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [Unreleased]
+
+### Added
+
+- `roborean.markdown` driver emitting CommonMark from flow operations.
+
+### Changed
+
+### Fixed
+
+
+- Lower inter-package dependency pins to `>=0.1.1` to match lockstep
+  release versions.
+- Normalize template newlines to LF for portable CommonMark output.

roborean_documents_markdown-0.1.2/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: roborean-documents-markdown
+Version: 0.1.2
+Summary: Markdown document driver for Roborean
+Project-URL: Homepage, https://github.com/TNick/roborean
+Project-URL: Repository, https://github.com/TNick/roborean
+License-Expression: MIT
+Requires-Python: >=3.11
+Requires-Dist: roborean-documents-base>=0.1.1
+Requires-Dist: roborean-spec>=0.1.1

roborean_documents_markdown-0.1.2/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "roborean-documents-markdown"
+version = "0.1.2"
+description = "Markdown document driver for Roborean"
+requires-python = ">=3.11"
+license = "MIT"
+dependencies = [
+  "roborean-documents-base>=0.1.1",
+  "roborean-spec>=0.1.1",
+]
+
+[project.entry-points."roborean.document_drivers"]
+"roborean.markdown" = "roborean_documents_markdown.driver:create_driver"
+
+
+[project.urls]
+Homepage = "https://github.com/TNick/roborean"
+Repository = "https://github.com/TNick/roborean"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/roborean_documents_markdown"]

roborean_documents_markdown-0.1.2/src/roborean_documents_markdown/driver.py

@@ -0,0 +1,156 @@
+"""Markdown / CommonMark document driver."""
+
+from dataclasses import dataclass, field
+from datetime import UTC, datetime
+from typing import Any, Mapping
+
+from roborean_documents_base.capabilities import assert_op_allowed
+from roborean_spec import (
+    DocumentDriverManifest,
+    DocumentOperation,
+    DocumentPreview,
+    TemplateManifest,
+)
+
+
+@dataclass
+class MarkdownSession:
+    """AST buffer for Markdown generation."""
+
+    document_id: str
+    driver_id: str
+    nodes: list[dict[str, Any]] = field(default_factory=list)
+    ops_applied: list[dict[str, Any]] = field(default_factory=list)
+    template_prefix: str = ""
+
+
+def render_commonmark(nodes: list[dict[str, Any]], prefix: str = "") -> str:
+    """Render a minimal node list to CommonMark."""
+    parts: list[str] = []
+    if prefix:
+        parts.append(prefix.rstrip("\n"))
+    for node in nodes:
+        kind = node["kind"]
+        if kind == "heading":
+            parts.append("#" * int(node["level"]) + " " + node["text"])
+        elif kind == "paragraph":
+            parts.append(node["text"])
+        elif kind == "table":
+            rows = node["rows"]
+            if not rows:
+                continue
+            header = rows[0]
+            parts.append("| " + " | ".join(header) + " |")
+            parts.append("| " + " | ".join("---" for _ in header) + " |")
+            for row in rows[1:]:
+                parts.append("| " + " | ".join(row) + " |")
+    body = "\n\n".join(parts).rstrip() + "\n"
+    return body
+
+
+class MarkdownDocumentDriver:
+    """CommonMark driver using flow operations."""
+
+    driver_id = "roborean.markdown"
+    manifest = DocumentDriverManifest(
+        driverId="roborean.markdown",
+        version="0.3.0",
+        irFamily="flow",
+        capabilities=[
+            "set_metadata",
+            "replace_named_value",
+            "flow.insert_paragraph",
+            "flow.insert_heading",
+            "flow.replace_table_rows",
+            "plain.append_text",
+            "finalize",
+        ],
+        supportsPreview=True,
+        supportsBrowserExecution=True,
+        supportsDiff=True,
+        requiresBackend=False,
+        templateMediaTypes=["text/markdown"],
+    )
+
+    def __init__(self) -> None:
+        """Initialize empty template state."""
+        self._template = ""
+        self._manifest: TemplateManifest | None = None
+
+    def load_template(self, template_ref, *, store, manifest) -> None:
+        """Load Markdown template prefix."""
+        text = store.load_bytes(template_ref).decode("utf-8")
+        self._template = text.replace("\r\n", "\n")
+        self._manifest = manifest
+
+    def begin_session(
+        self, workspace, metadata: Mapping[str, Any]
+    ) -> MarkdownSession:
+        """Start a Markdown session."""
+        return MarkdownSession(
+            document_id=str(metadata.get("documentId", "")),
+            driver_id=self.driver_id,
+            template_prefix=self._template,
+        )
+
+    def apply_operation(
+        self, session: MarkdownSession, op: DocumentOperation
+    ) -> None:
+        """Apply one flow/plain operation."""
+        assert_op_allowed(self.manifest, op)
+        data = op.model_dump(mode="python", by_alias=True)
+        session.ops_applied.append(op.model_dump(mode="json", by_alias=True))
+        if op.op == "flow.insert_heading":
+            session.nodes.append(
+                {
+                    "kind": "heading",
+                    "level": data["level"],
+                    "text": data["text"],
+                }
+            )
+        elif op.op == "flow.insert_paragraph":
+            text = "".join(run["text"] for run in data["runs"])
+            session.nodes.append({"kind": "paragraph", "text": text})
+        elif op.op == "flow.replace_table_rows":
+            session.nodes.append(
+                {"kind": "table", "table": data["table"], "rows": data["rows"]}
+            )
+        elif op.op == "plain.append_text":
+            session.nodes.append({"kind": "paragraph", "text": data["text"]})
+        elif op.op == "replace_named_value":
+            value = data["value"]
+            if isinstance(value, dict) and "value" in value:
+                rendered = str(value["value"])
+            else:
+                rendered = str(value)
+            session.template_prefix = session.template_prefix.replace(
+                "{{" + str(data["name"]) + "}}", rendered
+            )
+
+    def finalize(self, session: MarkdownSession) -> None:
+        """No-op finalize."""
+        return
+
+    def serialize(self, session: MarkdownSession) -> bytes:
+        """Return CommonMark UTF-8 bytes."""
+        body = render_commonmark(session.nodes, session.template_prefix)
+        return body.encode("utf-8")
+
+    def preview(self, session: MarkdownSession) -> DocumentPreview:
+        """Identity preview of CommonMark text."""
+        return DocumentPreview(
+            documentId=session.document_id,
+            mode="text",
+            body=self.serialize(session).decode("utf-8"),
+            warnings=[],
+            generatedAt=datetime.now(UTC).isoformat(),
+            renderer={
+                "package": "roborean-documents-markdown",
+                "version": "0.3.0",
+            },
+        )
+
+
+def create_driver() -> MarkdownDocumentDriver:
+    """Entry-point factory."""
+    return MarkdownDocumentDriver()